2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2007-2011 Robert N. M. Watson
5 * Copyright (c) 2015 Allan Jude <allanjude@freebsd.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/param.h>
34 #include <sys/capsicum.h>
35 #include <sys/socket.h>
36 #include <sys/sysctl.h>
40 #include <netinet/in.h>
42 #include <arpa/inet.h>
45 #include <libprocstat.h>
54 protocol_to_string(int domain, int type, int protocol)
93 addr_to_string(struct sockaddr_storage *ss, char *buffer, int buflen)
95 char buffer2[INET6_ADDRSTRLEN];
96 struct sockaddr_in6 *sin6;
97 struct sockaddr_in *sin;
98 struct sockaddr_un *sun;
100 switch (ss->ss_family) {
102 sun = (struct sockaddr_un *)ss;
103 if (strlen(sun->sun_path) == 0)
104 strlcpy(buffer, "-", buflen);
106 strlcpy(buffer, sun->sun_path, buflen);
110 sin = (struct sockaddr_in *)ss;
111 if (sin->sin_addr.s_addr == INADDR_ANY)
112 snprintf(buffer, buflen, "%s:%d", "*",
113 ntohs(sin->sin_port));
114 else if (inet_ntop(AF_INET, &sin->sin_addr, buffer2,
115 sizeof(buffer2)) != NULL)
116 snprintf(buffer, buflen, "%s:%d", buffer2,
117 ntohs(sin->sin_port));
121 sin6 = (struct sockaddr_in6 *)ss;
122 if (inet_ntop(AF_INET6, &sin6->sin6_addr, buffer2,
123 sizeof(buffer2)) != NULL)
124 snprintf(buffer, buflen, "%s.%d", buffer2,
125 ntohs(sin6->sin6_port));
127 strlcpy(buffer, "-", buflen);
131 strlcpy(buffer, "", buflen);
136 static struct cap_desc {
140 /* General file I/O. */
145 { CAP_CREATE, "cr" },
146 { CAP_FEXECVE, "fe" },
148 { CAP_FTRUNCATE, "ft" },
151 { CAP_FCHDIR, "cd" },
152 { CAP_FCHFLAGS, "cf" },
153 { CAP_FCHMOD, "cm" },
154 { CAP_FCHOWN, "cn" },
157 { CAP_FPATHCONF, "fp" },
160 { CAP_FSTATFS, "sf" },
161 { CAP_FUTIMES, "fu" },
162 { CAP_LINKAT_SOURCE, "ls" },
163 { CAP_LINKAT_TARGET, "lt" },
164 { CAP_MKDIRAT, "md" },
165 { CAP_MKFIFOAT, "mf" },
166 { CAP_MKNODAT, "mn" },
167 { CAP_RENAMEAT_SOURCE, "rs" },
168 { CAP_RENAMEAT_TARGET, "rt" },
169 { CAP_SYMLINKAT, "sl" },
170 { CAP_UNLINKAT, "un" },
172 /* Lookups - used to constrain *at() calls. */
173 { CAP_LOOKUP, "lo" },
175 /* Extended attributes. */
176 { CAP_EXTATTR_GET, "eg" },
177 { CAP_EXTATTR_SET, "es" },
178 { CAP_EXTATTR_DELETE, "ed" },
179 { CAP_EXTATTR_LIST, "el" },
181 /* Access Control Lists. */
182 { CAP_ACL_GET, "ag" },
183 { CAP_ACL_SET, "as" },
184 { CAP_ACL_DELETE, "ad" },
185 { CAP_ACL_CHECK, "ac" },
187 /* Socket operations. */
188 { CAP_ACCEPT, "at" },
190 { CAP_CONNECT, "co" },
191 { CAP_GETPEERNAME, "pn" },
192 { CAP_GETSOCKNAME, "sn" },
193 { CAP_GETSOCKOPT, "gs" },
194 { CAP_LISTEN, "ln" },
195 { CAP_PEELOFF, "pf" },
196 { CAP_SETSOCKOPT, "ss" },
197 { CAP_SHUTDOWN, "sh" },
199 /* Mandatory Access Control. */
200 { CAP_MAC_GET, "mg" },
201 { CAP_MAC_SET, "ms" },
203 /* Methods on semaphores. */
204 { CAP_SEM_GETVALUE, "sg" },
205 { CAP_SEM_POST, "sp" },
206 { CAP_SEM_WAIT, "sw" },
208 /* Event monitoring and posting. */
210 { CAP_KQUEUE_EVENT, "ke" },
211 { CAP_KQUEUE_CHANGE, "kc" },
213 /* Strange and powerful rights that should not be given lightly. */
215 { CAP_TTYHOOK, "ty" },
217 /* Process management via process descriptors. */
218 { CAP_PDGETPID, "pg" },
219 { CAP_PDWAIT, "pw" },
220 { CAP_PDKILL, "pk" },
223 * Rights that allow to use bindat(2) and connectat(2) syscalls on a
224 * directory descriptor.
226 { CAP_BINDAT, "ba" },
227 { CAP_CONNECTAT, "ca" },
229 /* Aliases and defines that combine multiple rights. */
230 { CAP_PREAD, "prd" },
231 { CAP_PWRITE, "pwr" },
233 { CAP_MMAP_R, "mmr" },
234 { CAP_MMAP_W, "mmw" },
235 { CAP_MMAP_X, "mmx" },
236 { CAP_MMAP_RW, "mrw" },
237 { CAP_MMAP_RX, "mrx" },
238 { CAP_MMAP_WX, "mwx" },
239 { CAP_MMAP_RWX, "mma" },
244 { CAP_SOCK_CLIENT, "scl" },
245 { CAP_SOCK_SERVER, "ssr" },
247 static const u_int cap_desc_count = nitems(cap_desc);
250 width_capability(cap_rights_t *rightsp)
252 u_int count, i, width;
256 for (i = 0; i < cap_desc_count; i++) {
257 if (cap_rights_is_set(rightsp, cap_desc[i].cd_right)) {
258 width += strlen(cap_desc[i].cd_desc);
268 print_capability(cap_rights_t *rightsp, u_int capwidth)
270 u_int count, i, width;
274 for (i = width_capability(rightsp); i < capwidth; i++) {
280 xo_open_list("capabilities");
281 for (i = 0; i < cap_desc_count; i++) {
282 if (cap_rights_is_set(rightsp, cap_desc[i].cd_right)) {
283 xo_emit("{D:/%s}{l:capabilities/%s}", count ? "," : "",
284 cap_desc[i].cd_desc);
285 width += strlen(cap_desc[i].cd_desc);
291 xo_close_list("capabilities");
295 procstat_files(struct procstat *procstat, struct kinfo_proc *kipp)
297 struct sockstat sock;
298 struct filestat_list *head;
299 struct filestat *fst;
302 u_int capwidth, width;
304 char src_addr[PATH_MAX];
305 char dst_addr[PATH_MAX];
308 * To print the header in capability mode, we need to know the width
309 * of the widest capability string. Even if we get no processes
310 * back, we will print the header, so we defer aborting due to a lack
311 * of processes until after the header logic.
314 head = procstat_getfiles(procstat, kipp, 0);
316 (procstat_opts & PS_OPT_CAPABILITIES) != 0) {
317 STAILQ_FOREACH(fst, head, next) {
318 width = width_capability(&fst->fs_cap_rights);
319 if (width > capwidth)
322 if (capwidth < strlen("CAPABILITIES"))
323 capwidth = strlen("CAPABILITIES");
326 if ((procstat_opts & PS_OPT_NOHEADER) == 0) {
327 if ((procstat_opts & PS_OPT_CAPABILITIES) != 0)
328 xo_emit("{T:/%5s %-16s %5s %1s %-8s %-*s "
329 "%-3s %-12s}\n", "PID", "COMM", "FD", "T",
330 "FLAGS", capwidth, "CAPABILITIES", "PRO",
333 xo_emit("{T:/%5s %-16s %5s %1s %1s %-8s "
334 "%3s %7s %-3s %-12s}\n", "PID", "COMM", "FD", "T",
335 "V", "FLAGS", "REF", "OFFSET", "PRO", "NAME");
340 xo_emit("{ek:process_id/%5d/%d}", kipp->ki_pid);
341 xo_emit("{e:command/%-16s/%s}", kipp->ki_comm);
342 xo_open_list("files");
343 STAILQ_FOREACH(fst, head, next) {
344 xo_open_instance("files");
345 xo_emit("{dk:process_id/%5d/%d} ", kipp->ki_pid);
346 xo_emit("{d:command/%-16s/%s} ", kipp->ki_comm);
347 if (fst->fs_uflags & PS_FST_UFLAG_CTTY)
348 xo_emit("{P: }{:fd/%s} ", "ctty");
349 else if (fst->fs_uflags & PS_FST_UFLAG_CDIR)
350 xo_emit("{P: }{:fd/%s} ", "cwd");
351 else if (fst->fs_uflags & PS_FST_UFLAG_JAIL)
352 xo_emit("{P: }{:fd/%s} ", "jail");
353 else if (fst->fs_uflags & PS_FST_UFLAG_RDIR)
354 xo_emit("{P: }{:fd/%s} ", "root");
355 else if (fst->fs_uflags & PS_FST_UFLAG_TEXT)
356 xo_emit("{P: }{:fd/%s} ", "text");
357 else if (fst->fs_uflags & PS_FST_UFLAG_TRACE)
358 xo_emit("{:fd/%s} ", "trace");
360 xo_emit("{:fd/%5d} ", fst->fs_fd);
362 switch (fst->fs_type) {
363 case PS_FST_TYPE_VNODE:
365 xo_emit("{eq:fd_type/vnode}");
368 case PS_FST_TYPE_SOCKET:
370 xo_emit("{eq:fd_type/socket}");
373 case PS_FST_TYPE_PIPE:
375 xo_emit("{eq:fd_type/pipe}");
378 case PS_FST_TYPE_FIFO:
380 xo_emit("{eq:fd_type/fifo}");
383 case PS_FST_TYPE_KQUEUE:
385 xo_emit("{eq:fd_type/kqueue}");
388 case PS_FST_TYPE_MQUEUE:
390 xo_emit("{eq:fd_type/mqueue}");
393 case PS_FST_TYPE_SHM:
395 xo_emit("{eq:fd_type/shm}");
398 case PS_FST_TYPE_PTS:
400 xo_emit("{eq:fd_type/pts}");
403 case PS_FST_TYPE_SEM:
405 xo_emit("{eq:fd_type/sem}");
408 case PS_FST_TYPE_PROCDESC:
410 xo_emit("{eq:fd_type/procdesc}");
413 case PS_FST_TYPE_DEV:
415 xo_emit("{eq:fd_type/dev}");
418 case PS_FST_TYPE_EVENTFD:
420 xo_emit("{eq:fd_type/eventfd}");
423 case PS_FST_TYPE_NONE:
425 xo_emit("{eq:fd_type/none}");
428 case PS_FST_TYPE_UNKNOWN:
431 xo_emit("{eq:fd_type/unknown}");
434 xo_emit("{d:fd_type/%1s/%s} ", str);
435 if ((procstat_opts & PS_OPT_CAPABILITIES) == 0) {
437 if (fst->fs_type == PS_FST_TYPE_VNODE) {
438 error = procstat_get_vnode_info(procstat, fst,
440 switch (vn.vn_type) {
441 case PS_FST_VTYPE_VREG:
443 xo_emit("{eq:vode_type/regular}");
446 case PS_FST_VTYPE_VDIR:
448 xo_emit("{eq:vode_type/directory}");
451 case PS_FST_VTYPE_VBLK:
453 xo_emit("{eq:vode_type/block}");
456 case PS_FST_VTYPE_VCHR:
458 xo_emit("{eq:vode_type/character}");
461 case PS_FST_VTYPE_VLNK:
463 xo_emit("{eq:vode_type/link}");
466 case PS_FST_VTYPE_VSOCK:
468 xo_emit("{eq:vode_type/socket}");
471 case PS_FST_VTYPE_VFIFO:
473 xo_emit("{eq:vode_type/fifo}");
476 case PS_FST_VTYPE_VBAD:
478 xo_emit("{eq:vode_type/revoked_device}");
481 case PS_FST_VTYPE_VNON:
483 xo_emit("{eq:vode_type/non}");
486 case PS_FST_VTYPE_UNKNOWN:
489 xo_emit("{eq:vode_type/unknown}");
493 xo_emit("{d:vnode_type/%1s/%s} ", str);
496 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_READ ?
498 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_WRITE ?
500 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_APPEND ?
502 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_ASYNC ?
504 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_SYNC ?
506 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_NONBLOCK ?
508 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_DIRECT ?
510 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_HASLOCK ?
513 xo_open_list("fd_flags");
514 if (fst->fs_fflags & PS_FST_FFLAG_READ)
515 xo_emit("{elq:fd_flags/read}");
516 if (fst->fs_fflags & PS_FST_FFLAG_WRITE)
517 xo_emit("{elq:fd_flags/write}");
518 if (fst->fs_fflags & PS_FST_FFLAG_APPEND)
519 xo_emit("{elq:fd_flags/append}");
520 if (fst->fs_fflags & PS_FST_FFLAG_ASYNC)
521 xo_emit("{elq:fd_flags/async}");
522 if (fst->fs_fflags & PS_FST_FFLAG_SYNC)
523 xo_emit("{elq:fd_flags/fsync}");
524 if (fst->fs_fflags & PS_FST_FFLAG_NONBLOCK)
525 xo_emit("{elq:fd_flags/nonblocking}");
526 if (fst->fs_fflags & PS_FST_FFLAG_DIRECT)
527 xo_emit("{elq:fd_flags/direct_io}");
528 if (fst->fs_fflags & PS_FST_FFLAG_HASLOCK)
529 xo_emit("{elq:fd_flags/lock_held}");
530 xo_close_list("fd_flags");
532 if ((procstat_opts & PS_OPT_CAPABILITIES) == 0) {
533 if (fst->fs_ref_count > -1)
534 xo_emit("{:ref_count/%3d/%d} ",
537 xo_emit("{q:ref_count/%3c/%c} ", '-');
538 if (fst->fs_offset > -1)
539 xo_emit("{:offset/%7jd/%jd} ",
540 (intmax_t)fst->fs_offset);
542 xo_emit("{q:offset/%7c/%c} ", '-');
544 if ((procstat_opts & PS_OPT_CAPABILITIES) != 0) {
545 print_capability(&fst->fs_cap_rights, capwidth);
548 switch (fst->fs_type) {
549 case PS_FST_TYPE_SOCKET:
550 error = procstat_get_socket_info(procstat, fst, &sock,
554 xo_emit("{:protocol/%-3s/%s} ",
555 protocol_to_string(sock.dom_family,
556 sock.type, sock.proto));
557 if (sock.proto == IPPROTO_TCP ||
558 sock.proto == IPPROTO_SCTP ||
559 sock.type == SOCK_STREAM) {
560 xo_emit("{:sendq/%u} ", sock.sendq);
561 xo_emit("{:recvq/%u} ", sock.recvq);
564 * While generally we like to print two addresses,
565 * local and peer, for sockets, it turns out to be
566 * more useful to print the first non-nul address for
567 * local sockets, as typically they aren't bound and
568 * connected, and the path strings can get long.
570 if (sock.dom_family == AF_LOCAL) {
571 struct sockaddr_un *sun =
572 (struct sockaddr_un *)&sock.sa_local;
574 if (sun->sun_path[0] != 0)
575 addr_to_string(&sock.sa_local,
576 src_addr, sizeof(src_addr));
578 addr_to_string(&sock.sa_peer,
579 src_addr, sizeof(src_addr));
580 xo_emit("{:path/%s}", src_addr);
582 addr_to_string(&sock.sa_local, src_addr,
584 addr_to_string(&sock.sa_peer, dst_addr,
586 xo_emit("{:path/%s %s}", src_addr, dst_addr);
591 xo_emit("{:protocol/%-3s/%s} ", "-");
592 xo_emit("{:path/%-18s/%s}", fst->fs_path != NULL ?
597 xo_close_instance("files");
599 xo_close_list("files");
600 procstat_freefiles(procstat, head);