xref: /freebsd/usr.bin/procstat/procstat_files.c (revision 7d99ab9fd0cc2c1ce2ecef0ed6d0672c2a50b0cb)
1 /*-
2  * Copyright (c) 2007-2011 Robert N. M. Watson
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #include <sys/param.h>
30 #include <sys/capability.h>
31 #include <sys/socket.h>
32 #include <sys/sysctl.h>
33 #include <sys/un.h>
34 #include <sys/user.h>
35 
36 #include <netinet/in.h>
37 
38 #include <arpa/inet.h>
39 
40 #include <err.h>
41 #include <libprocstat.h>
42 #include <inttypes.h>
43 #include <stdio.h>
44 #include <stdlib.h>
45 #include <string.h>
46 
47 #include "procstat.h"
48 
49 static const char *
50 protocol_to_string(int domain, int type, int protocol)
51 {
52 
53 	switch (domain) {
54 	case AF_INET:
55 	case AF_INET6:
56 		switch (protocol) {
57 		case IPPROTO_TCP:
58 			return ("TCP");
59 		case IPPROTO_UDP:
60 			return ("UDP");
61 		case IPPROTO_ICMP:
62 			return ("ICM");
63 		case IPPROTO_RAW:
64 			return ("RAW");
65 		case IPPROTO_SCTP:
66 			return ("SCT");
67 		case IPPROTO_DIVERT:
68 			return ("IPD");
69 		default:
70 			return ("IP?");
71 		}
72 
73 	case AF_LOCAL:
74 		switch (type) {
75 		case SOCK_STREAM:
76 			return ("UDS");
77 		case SOCK_DGRAM:
78 			return ("UDD");
79 		default:
80 			return ("UD?");
81 		}
82 	default:
83 		return ("?");
84 	}
85 }
86 
87 static void
88 addr_to_string(struct sockaddr_storage *ss, char *buffer, int buflen)
89 {
90 	char buffer2[INET6_ADDRSTRLEN];
91 	struct sockaddr_in6 *sin6;
92 	struct sockaddr_in *sin;
93 	struct sockaddr_un *sun;
94 
95 	switch (ss->ss_family) {
96 	case AF_LOCAL:
97 		sun = (struct sockaddr_un *)ss;
98 		if (strlen(sun->sun_path) == 0)
99 			strlcpy(buffer, "-", buflen);
100 		else
101 			strlcpy(buffer, sun->sun_path, buflen);
102 		break;
103 
104 	case AF_INET:
105 		sin = (struct sockaddr_in *)ss;
106 		snprintf(buffer, buflen, "%s:%d", inet_ntoa(sin->sin_addr),
107 		    ntohs(sin->sin_port));
108 		break;
109 
110 	case AF_INET6:
111 		sin6 = (struct sockaddr_in6 *)ss;
112 		if (inet_ntop(AF_INET6, &sin6->sin6_addr, buffer2,
113 		    sizeof(buffer2)) != NULL)
114 			snprintf(buffer, buflen, "%s.%d", buffer2,
115 			    ntohs(sin6->sin6_port));
116 		else
117 			strlcpy(buffer, "-", sizeof(buffer));
118 		break;
119 
120 	default:
121 		strlcpy(buffer, "", buflen);
122 		break;
123 	}
124 }
125 
126 static void
127 print_address(struct sockaddr_storage *ss)
128 {
129 	char addr[PATH_MAX];
130 
131 	addr_to_string(ss, addr, sizeof(addr));
132 	printf("%s", addr);
133 }
134 
135 static struct cap_desc {
136 	cap_rights_t	 cd_right;
137 	const char	*cd_desc;
138 } cap_desc[] = {
139 	/* General file I/O. */
140 	{ CAP_READ,		"rd" },
141 	{ CAP_WRITE,		"wr" },
142 	{ CAP_SEEK,		"se" },
143 	{ CAP_MMAP,		"mm" },
144 	{ CAP_CREATE,		"cr" },
145 	{ CAP_FEXECVE,		"fe" },
146 	{ CAP_FSYNC,		"fy" },
147 	{ CAP_FTRUNCATE,	"ft" },
148 
149 	/* VFS methods. */
150 	{ CAP_FCHDIR,		"cd" },
151 	{ CAP_FCHFLAGS,		"cf" },
152 	{ CAP_FCHMOD,		"cm" },
153 	{ CAP_FCHOWN,		"cn" },
154 	{ CAP_FCNTL,		"fc" },
155 	{ CAP_FLOCK,		"fl" },
156 	{ CAP_FPATHCONF,	"fp" },
157 	{ CAP_FSCK,		"fk" },
158 	{ CAP_FSTAT,		"fs" },
159 	{ CAP_FSTATFS,		"sf" },
160 	{ CAP_FUTIMES,		"fu" },
161 	{ CAP_LINKAT,		"li" },
162 	{ CAP_MKDIRAT,		"md" },
163 	{ CAP_MKFIFOAT,		"mf" },
164 	{ CAP_MKNODAT,		"mn" },
165 	{ CAP_RENAMEAT,		"rn" },
166 	{ CAP_SYMLINKAT,	"sl" },
167 	{ CAP_UNLINKAT,		"un" },
168 
169 	/* Lookups - used to constrain *at() calls. */
170 	{ CAP_LOOKUP,		"lo" },
171 
172 	/* Extended attributes. */
173 	{ CAP_EXTATTR_GET,	"eg" },
174 	{ CAP_EXTATTR_SET,	"es" },
175 	{ CAP_EXTATTR_DELETE,	"ed" },
176 	{ CAP_EXTATTR_LIST,	"el" },
177 
178 	/* Access Control Lists. */
179 	{ CAP_ACL_GET,		"ag" },
180 	{ CAP_ACL_SET,		"as" },
181 	{ CAP_ACL_DELETE,	"ad" },
182 	{ CAP_ACL_CHECK,	"ac" },
183 
184 	/* Socket operations. */
185 	{ CAP_ACCEPT,		"at" },
186 	{ CAP_BIND,		"bd" },
187 	{ CAP_CONNECT,		"co" },
188 	{ CAP_GETPEERNAME,	"pn" },
189 	{ CAP_GETSOCKNAME,	"sn" },
190 	{ CAP_GETSOCKOPT,	"gs" },
191 	{ CAP_LISTEN,		"ln" },
192 	{ CAP_PEELOFF,		"pf" },
193 	{ CAP_SETSOCKOPT,	"ss" },
194 	{ CAP_SHUTDOWN,		"sh" },
195 
196 	/* Mandatory Access Control. */
197 	{ CAP_MAC_GET,		"mg" },
198 	{ CAP_MAC_SET,		"ms" },
199 
200 	/* Methods on semaphores. */
201 	{ CAP_SEM_GETVALUE,	"sg" },
202 	{ CAP_SEM_POST,		"sp" },
203 	{ CAP_SEM_WAIT,		"sw" },
204 
205 	/* Event monitoring and posting. */
206 	{ CAP_POLL_EVENT,	"po" },
207 	{ CAP_POST_EVENT,	"ev" },
208 
209 	/* Strange and powerful rights that should not be given lightly. */
210 	{ CAP_IOCTL,		"io" },
211 	{ CAP_TTYHOOK,		"ty" },
212 
213 	/* Process management via process descriptors. */
214 	{ CAP_PDGETPID,		"pg" },
215 	{ CAP_PDWAIT,		"pw" },
216 	{ CAP_PDKILL,		"pk" },
217 
218 	/*
219 	 * Rights that allow to use bindat(2) and connectat(2) syscalls on a
220 	 * directory descriptor.
221 	 */
222 	{ CAP_BINDAT,		"ba" },
223 	{ CAP_CONNECTAT,	"ca" },
224 
225 	/* Aliases and defines that combine multiple rights. */
226 	{ CAP_PREAD,		"prd" },
227 	{ CAP_PWRITE,		"pwr" },
228 
229 	{ CAP_MMAP_R,		"mmr" },
230 	{ CAP_MMAP_W,		"mmw" },
231 	{ CAP_MMAP_X,		"mmx" },
232 	{ CAP_MMAP_RW,		"mrw" },
233 	{ CAP_MMAP_RX,		"mrx" },
234 	{ CAP_MMAP_WX,		"mwx" },
235 	{ CAP_MMAP_RWX,		"mma" },
236 
237 	{ CAP_RECV,		"re" },
238 	{ CAP_SEND,		"sd" },
239 
240 	{ CAP_SOCK_CLIENT,	"scl" },
241 	{ CAP_SOCK_SERVER,	"ssr" },
242 };
243 static const u_int	cap_desc_count = sizeof(cap_desc) /
244 			    sizeof(cap_desc[0]);
245 
246 static u_int
247 width_capability(cap_rights_t rights)
248 {
249 	u_int count, i, width;
250 
251 	count = 0;
252 	width = 0;
253 	for (i = 0; i < cap_desc_count; i++) {
254 		if ((cap_desc[i].cd_right & ~rights) == 0) {
255 			width += strlen(cap_desc[i].cd_desc);
256 			if (count)
257 				width++;
258 			count++;
259 		}
260 	}
261 	return (width);
262 }
263 
264 static void
265 print_capability(cap_rights_t rights, u_int capwidth)
266 {
267 	u_int count, i, width;
268 
269 	count = 0;
270 	width = 0;
271 	for (i = width_capability(rights); i < capwidth; i++) {
272 		if (rights || i != 0)
273 			printf(" ");
274 		else
275 			printf("-");
276 	}
277 	for (i = 0; i < cap_desc_count; i++) {
278 		if ((cap_desc[i].cd_right & ~rights) == 0) {
279 			printf("%s%s", count ? "," : "", cap_desc[i].cd_desc);
280 			width += strlen(cap_desc[i].cd_desc);
281 			if (count)
282 				width++;
283 			count++;
284 		}
285 	}
286 }
287 
288 void
289 procstat_files(struct procstat *procstat, struct kinfo_proc *kipp)
290 {
291 	struct sockstat sock;
292 	struct filestat_list *head;
293 	struct filestat *fst;
294 	const char *str;
295 	struct vnstat vn;
296 	u_int capwidth, width;
297 	int error;
298 
299 	/*
300 	 * To print the header in capability mode, we need to know the width
301 	 * of the widest capability string.  Even if we get no processes
302 	 * back, we will print the header, so we defer aborting due to a lack
303 	 * of processes until after the header logic.
304 	 */
305 	capwidth = 0;
306 	head = procstat_getfiles(procstat, kipp, 0);
307 	if (head != NULL && Cflag) {
308 		STAILQ_FOREACH(fst, head, next) {
309 			width = width_capability(fst->fs_cap_rights);
310 			if (width > capwidth)
311 				capwidth = width;
312 		}
313 		if (capwidth < strlen("CAPABILITIES"))
314 			capwidth = strlen("CAPABILITIES");
315 	}
316 
317 	if (!hflag) {
318 		if (Cflag)
319 			printf("%5s %-16s %4s %1s %-9s %-*s "
320 			    "%-3s %-12s\n", "PID", "COMM", "FD", "T",
321 			    "FLAGS", capwidth, "CAPABILITIES", "PRO",
322 			    "NAME");
323 		else
324 			printf("%5s %-16s %4s %1s %1s %-9s "
325 			    "%3s %7s %-3s %-12s\n", "PID", "COMM", "FD", "T",
326 			    "V", "FLAGS", "REF", "OFFSET", "PRO", "NAME");
327 	}
328 
329 	if (head == NULL)
330 		return;
331 	STAILQ_FOREACH(fst, head, next) {
332 		printf("%5d ", kipp->ki_pid);
333 		printf("%-16s ", kipp->ki_comm);
334 		if (fst->fs_uflags & PS_FST_UFLAG_CTTY)
335 			printf("ctty ");
336 		else if (fst->fs_uflags & PS_FST_UFLAG_CDIR)
337 			printf(" cwd ");
338 		else if (fst->fs_uflags & PS_FST_UFLAG_JAIL)
339 			printf("jail ");
340 		else if (fst->fs_uflags & PS_FST_UFLAG_RDIR)
341 			printf("root ");
342 		else if (fst->fs_uflags & PS_FST_UFLAG_TEXT)
343 			printf("text ");
344 		else if (fst->fs_uflags & PS_FST_UFLAG_TRACE)
345 			printf("trace ");
346 		else
347 			printf("%4d ", fst->fs_fd);
348 
349 		switch (fst->fs_type) {
350 		case PS_FST_TYPE_VNODE:
351 			str = "v";
352 			break;
353 
354 		case PS_FST_TYPE_SOCKET:
355 			str = "s";
356 			break;
357 
358 		case PS_FST_TYPE_PIPE:
359 			str = "p";
360 			break;
361 
362 		case PS_FST_TYPE_FIFO:
363 			str = "f";
364 			break;
365 
366 		case PS_FST_TYPE_KQUEUE:
367 			str = "k";
368 			break;
369 
370 		case PS_FST_TYPE_CRYPTO:
371 			str = "c";
372 			break;
373 
374 		case PS_FST_TYPE_MQUEUE:
375 			str = "m";
376 			break;
377 
378 		case PS_FST_TYPE_SHM:
379 			str = "h";
380 			break;
381 
382 		case PS_FST_TYPE_PTS:
383 			str = "t";
384 			break;
385 
386 		case PS_FST_TYPE_SEM:
387 			str = "e";
388 			break;
389 
390 		case PS_FST_TYPE_NONE:
391 		case PS_FST_TYPE_UNKNOWN:
392 		default:
393 			str = "?";
394 			break;
395 		}
396 		printf("%1s ", str);
397 		if (!Cflag) {
398 			str = "-";
399 			if (fst->fs_type == PS_FST_TYPE_VNODE) {
400 				error = procstat_get_vnode_info(procstat, fst,
401 				    &vn, NULL);
402 				switch (vn.vn_type) {
403 				case PS_FST_VTYPE_VREG:
404 					str = "r";
405 					break;
406 
407 				case PS_FST_VTYPE_VDIR:
408 					str = "d";
409 					break;
410 
411 				case PS_FST_VTYPE_VBLK:
412 					str = "b";
413 					break;
414 
415 				case PS_FST_VTYPE_VCHR:
416 					str = "c";
417 					break;
418 
419 				case PS_FST_VTYPE_VLNK:
420 					str = "l";
421 					break;
422 
423 				case PS_FST_VTYPE_VSOCK:
424 					str = "s";
425 					break;
426 
427 				case PS_FST_VTYPE_VFIFO:
428 					str = "f";
429 					break;
430 
431 				case PS_FST_VTYPE_VBAD:
432 					str = "x";
433 					break;
434 
435 				case PS_FST_VTYPE_VNON:
436 				case PS_FST_VTYPE_UNKNOWN:
437 				default:
438 					str = "?";
439 					break;
440 				}
441 			}
442 			printf("%1s ", str);
443 		}
444 		printf("%s", fst->fs_fflags & PS_FST_FFLAG_READ ? "r" : "-");
445 		printf("%s", fst->fs_fflags & PS_FST_FFLAG_WRITE ? "w" : "-");
446 		printf("%s", fst->fs_fflags & PS_FST_FFLAG_APPEND ? "a" : "-");
447 		printf("%s", fst->fs_fflags & PS_FST_FFLAG_ASYNC ? "s" : "-");
448 		printf("%s", fst->fs_fflags & PS_FST_FFLAG_SYNC ? "f" : "-");
449 		printf("%s", fst->fs_fflags & PS_FST_FFLAG_NONBLOCK ? "n" : "-");
450 		printf("%s", fst->fs_fflags & PS_FST_FFLAG_DIRECT ? "d" : "-");
451 		printf("%s", fst->fs_fflags & PS_FST_FFLAG_HASLOCK ? "l" : "-");
452 		if (!Cflag) {
453 			if (fst->fs_ref_count > -1)
454 				printf("%3d ", fst->fs_ref_count);
455 			else
456 				printf("%3c ", '-');
457 			if (fst->fs_offset > -1)
458 				printf("%7jd ", (intmax_t)fst->fs_offset);
459 			else
460 				printf("%7c ", '-');
461 		}
462 		if (Cflag) {
463 			print_capability(fst->fs_cap_rights, capwidth);
464 			printf(" ");
465 		}
466 		switch (fst->fs_type) {
467 		case PS_FST_TYPE_SOCKET:
468 			error = procstat_get_socket_info(procstat, fst, &sock, NULL);
469 			if (error != 0)
470 				break;
471 			printf("%-3s ",
472 			    protocol_to_string(sock.dom_family,
473 			    sock.type, sock.proto));
474 			/*
475 			 * While generally we like to print two addresses,
476 			 * local and peer, for sockets, it turns out to be
477 			 * more useful to print the first non-nul address for
478 			 * local sockets, as typically they aren't bound and
479 			 *  connected, and the path strings can get long.
480 			 */
481 			if (sock.dom_family == AF_LOCAL) {
482 				struct sockaddr_un *sun =
483 				    (struct sockaddr_un *)&sock.sa_local;
484 
485 				if (sun->sun_path[0] != 0)
486 					print_address(&sock.sa_local);
487 				else
488 					print_address(&sock.sa_peer);
489 			} else {
490 				print_address(&sock.sa_local);
491 				printf(" ");
492 				print_address(&sock.sa_peer);
493 			}
494 			break;
495 
496 		default:
497 			printf("%-3s ", "-");
498 			printf("%-18s", fst->fs_path != NULL ? fst->fs_path : "-");
499 		}
500 
501 		printf("\n");
502 	}
503 	procstat_freefiles(procstat, head);
504 }
505