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
32 #include <sys/param.h>
33 #include <sys/capsicum.h>
34 #include <sys/socket.h>
35 #include <sys/sysctl.h>
39 #include <netinet/in.h>
41 #include <arpa/inet.h>
44 #include <libprocstat.h>
53 protocol_to_string(int domain, int type, int protocol)
91 addr_to_string(struct sockaddr_storage *ss, char *buffer, int buflen)
93 char buffer2[INET6_ADDRSTRLEN];
94 struct sockaddr_in6 *sin6;
95 struct sockaddr_in *sin;
96 struct sockaddr_un *sun;
98 switch (ss->ss_family) {
100 sun = (struct sockaddr_un *)ss;
101 if (strlen(sun->sun_path) == 0)
102 strlcpy(buffer, "-", buflen);
104 strlcpy(buffer, sun->sun_path, buflen);
108 sin = (struct sockaddr_in *)ss;
109 if (sin->sin_addr.s_addr == INADDR_ANY)
110 snprintf(buffer, buflen, "%s:%d", "*",
111 ntohs(sin->sin_port));
112 else if (inet_ntop(AF_INET, &sin->sin_addr, buffer2,
113 sizeof(buffer2)) != NULL)
114 snprintf(buffer, buflen, "%s:%d", buffer2,
115 ntohs(sin->sin_port));
119 sin6 = (struct sockaddr_in6 *)ss;
120 if (inet_ntop(AF_INET6, &sin6->sin6_addr, buffer2,
121 sizeof(buffer2)) != NULL)
122 snprintf(buffer, buflen, "%s.%d", buffer2,
123 ntohs(sin6->sin6_port));
125 strlcpy(buffer, "-", buflen);
129 strlcpy(buffer, "", buflen);
134 static struct cap_desc {
138 /* General file I/O. */
143 { CAP_CREATE, "cr" },
144 { CAP_FEXECVE, "fe" },
146 { CAP_FTRUNCATE, "ft" },
149 { CAP_FCHDIR, "cd" },
150 { CAP_FCHFLAGS, "cf" },
151 { CAP_FCHMOD, "cm" },
152 { CAP_FCHOWN, "cn" },
155 { CAP_FPATHCONF, "fp" },
158 { CAP_FSTATFS, "sf" },
159 { CAP_FUTIMES, "fu" },
160 { CAP_LINKAT_SOURCE, "ls" },
161 { CAP_LINKAT_TARGET, "lt" },
162 { CAP_MKDIRAT, "md" },
163 { CAP_MKFIFOAT, "mf" },
164 { CAP_MKNODAT, "mn" },
165 { CAP_RENAMEAT_SOURCE, "rs" },
166 { CAP_RENAMEAT_TARGET, "rt" },
167 { CAP_SYMLINKAT, "sl" },
168 { CAP_UNLINKAT, "un" },
170 /* Lookups - used to constrain *at() calls. */
171 { CAP_LOOKUP, "lo" },
173 /* Extended attributes. */
174 { CAP_EXTATTR_GET, "eg" },
175 { CAP_EXTATTR_SET, "es" },
176 { CAP_EXTATTR_DELETE, "ed" },
177 { CAP_EXTATTR_LIST, "el" },
179 /* Access Control Lists. */
180 { CAP_ACL_GET, "ag" },
181 { CAP_ACL_SET, "as" },
182 { CAP_ACL_DELETE, "ad" },
183 { CAP_ACL_CHECK, "ac" },
185 /* Socket operations. */
186 { CAP_ACCEPT, "at" },
188 { CAP_CONNECT, "co" },
189 { CAP_GETPEERNAME, "pn" },
190 { CAP_GETSOCKNAME, "sn" },
191 { CAP_GETSOCKOPT, "gs" },
192 { CAP_LISTEN, "ln" },
193 { CAP_PEELOFF, "pf" },
194 { CAP_SETSOCKOPT, "ss" },
195 { CAP_SHUTDOWN, "sh" },
197 /* Mandatory Access Control. */
198 { CAP_MAC_GET, "mg" },
199 { CAP_MAC_SET, "ms" },
201 /* Methods on semaphores. */
202 { CAP_SEM_GETVALUE, "sg" },
203 { CAP_SEM_POST, "sp" },
204 { CAP_SEM_WAIT, "sw" },
206 /* Event monitoring and posting. */
208 { CAP_KQUEUE_EVENT, "ke" },
209 { CAP_KQUEUE_CHANGE, "kc" },
211 /* Strange and powerful rights that should not be given lightly. */
213 { CAP_TTYHOOK, "ty" },
215 /* Process management via process descriptors. */
216 { CAP_PDGETPID, "pg" },
217 { CAP_PDWAIT, "pw" },
218 { CAP_PDKILL, "pk" },
221 * Rights that allow to use bindat(2) and connectat(2) syscalls on a
222 * directory descriptor.
224 { CAP_BINDAT, "ba" },
225 { CAP_CONNECTAT, "ca" },
227 /* Aliases and defines that combine multiple rights. */
228 { CAP_PREAD, "prd" },
229 { CAP_PWRITE, "pwr" },
231 { CAP_MMAP_R, "mmr" },
232 { CAP_MMAP_W, "mmw" },
233 { CAP_MMAP_X, "mmx" },
234 { CAP_MMAP_RW, "mrw" },
235 { CAP_MMAP_RX, "mrx" },
236 { CAP_MMAP_WX, "mwx" },
237 { CAP_MMAP_RWX, "mma" },
242 { CAP_SOCK_CLIENT, "scl" },
243 { CAP_SOCK_SERVER, "ssr" },
245 static const u_int cap_desc_count = nitems(cap_desc);
248 width_capability(cap_rights_t *rightsp)
250 u_int count, i, width;
254 for (i = 0; i < cap_desc_count; i++) {
255 if (cap_rights_is_set(rightsp, cap_desc[i].cd_right)) {
256 width += strlen(cap_desc[i].cd_desc);
266 print_capability(cap_rights_t *rightsp, u_int capwidth)
268 u_int count, i, width;
272 for (i = width_capability(rightsp); i < capwidth; i++) {
278 xo_open_list("capabilities");
279 for (i = 0; i < cap_desc_count; i++) {
280 if (cap_rights_is_set(rightsp, cap_desc[i].cd_right)) {
281 xo_emit("{D:/%s}{l:capabilities/%s}", count ? "," : "",
282 cap_desc[i].cd_desc);
283 width += strlen(cap_desc[i].cd_desc);
289 xo_close_list("capabilities");
293 procstat_files(struct procstat *procstat, struct kinfo_proc *kipp)
295 struct sockstat sock;
296 struct filestat_list *head;
297 struct filestat *fst;
300 u_int capwidth, width;
302 char src_addr[PATH_MAX];
303 char dst_addr[PATH_MAX];
306 * To print the header in capability mode, we need to know the width
307 * of the widest capability string. Even if we get no processes
308 * back, we will print the header, so we defer aborting due to a lack
309 * of processes until after the header logic.
312 head = procstat_getfiles(procstat, kipp, 0);
314 (procstat_opts & PS_OPT_CAPABILITIES) != 0) {
315 STAILQ_FOREACH(fst, head, next) {
316 width = width_capability(&fst->fs_cap_rights);
317 if (width > capwidth)
320 if (capwidth < strlen("CAPABILITIES"))
321 capwidth = strlen("CAPABILITIES");
324 if ((procstat_opts & PS_OPT_NOHEADER) == 0) {
325 if ((procstat_opts & PS_OPT_CAPABILITIES) != 0)
326 xo_emit("{T:/%5s %-16s %5s %1s %-8s %-*s "
327 "%-3s %-12s}\n", "PID", "COMM", "FD", "T",
328 "FLAGS", capwidth, "CAPABILITIES", "PRO",
331 xo_emit("{T:/%5s %-16s %5s %1s %1s %-8s "
332 "%3s %7s %-3s %-12s}\n", "PID", "COMM", "FD", "T",
333 "V", "FLAGS", "REF", "OFFSET", "PRO", "NAME");
338 xo_emit("{ek:process_id/%5d/%d}", kipp->ki_pid);
339 xo_emit("{e:command/%-16s/%s}", kipp->ki_comm);
340 xo_open_list("files");
341 STAILQ_FOREACH(fst, head, next) {
342 xo_open_instance("files");
343 xo_emit("{dk:process_id/%5d/%d} ", kipp->ki_pid);
344 xo_emit("{d:command/%-16s/%s} ", kipp->ki_comm);
345 if (fst->fs_uflags & PS_FST_UFLAG_CTTY)
346 xo_emit("{P: }{:fd/%s} ", "ctty");
347 else if (fst->fs_uflags & PS_FST_UFLAG_CDIR)
348 xo_emit("{P: }{:fd/%s} ", "cwd");
349 else if (fst->fs_uflags & PS_FST_UFLAG_JAIL)
350 xo_emit("{P: }{:fd/%s} ", "jail");
351 else if (fst->fs_uflags & PS_FST_UFLAG_RDIR)
352 xo_emit("{P: }{:fd/%s} ", "root");
353 else if (fst->fs_uflags & PS_FST_UFLAG_TEXT)
354 xo_emit("{P: }{:fd/%s} ", "text");
355 else if (fst->fs_uflags & PS_FST_UFLAG_TRACE)
356 xo_emit("{:fd/%s} ", "trace");
358 xo_emit("{:fd/%5d} ", fst->fs_fd);
360 switch (fst->fs_type) {
361 case PS_FST_TYPE_VNODE:
363 xo_emit("{eq:fd_type/vnode}");
366 case PS_FST_TYPE_SOCKET:
368 xo_emit("{eq:fd_type/socket}");
371 case PS_FST_TYPE_PIPE:
373 xo_emit("{eq:fd_type/pipe}");
376 case PS_FST_TYPE_FIFO:
378 xo_emit("{eq:fd_type/fifo}");
381 case PS_FST_TYPE_KQUEUE:
383 xo_emit("{eq:fd_type/kqueue}");
386 case PS_FST_TYPE_CRYPTO:
388 xo_emit("{eq:fd_type/crypto}");
391 case PS_FST_TYPE_MQUEUE:
393 xo_emit("{eq:fd_type/mqueue}");
396 case PS_FST_TYPE_SHM:
398 xo_emit("{eq:fd_type/shm}");
401 case PS_FST_TYPE_PTS:
403 xo_emit("{eq:fd_type/pts}");
406 case PS_FST_TYPE_SEM:
408 xo_emit("{eq:fd_type/sem}");
411 case PS_FST_TYPE_PROCDESC:
413 xo_emit("{eq:fd_type/procdesc}");
416 case PS_FST_TYPE_DEV:
418 xo_emit("{eq:fd_type/dev}");
421 case PS_FST_TYPE_NONE:
423 xo_emit("{eq:fd_type/none}");
426 case PS_FST_TYPE_UNKNOWN:
429 xo_emit("{eq:fd_type/unknown}");
432 xo_emit("{d:fd_type/%1s/%s} ", str);
433 if ((procstat_opts & PS_OPT_CAPABILITIES) == 0) {
435 if (fst->fs_type == PS_FST_TYPE_VNODE) {
436 error = procstat_get_vnode_info(procstat, fst,
438 switch (vn.vn_type) {
439 case PS_FST_VTYPE_VREG:
441 xo_emit("{eq:vode_type/regular}");
444 case PS_FST_VTYPE_VDIR:
446 xo_emit("{eq:vode_type/directory}");
449 case PS_FST_VTYPE_VBLK:
451 xo_emit("{eq:vode_type/block}");
454 case PS_FST_VTYPE_VCHR:
456 xo_emit("{eq:vode_type/character}");
459 case PS_FST_VTYPE_VLNK:
461 xo_emit("{eq:vode_type/link}");
464 case PS_FST_VTYPE_VSOCK:
466 xo_emit("{eq:vode_type/socket}");
469 case PS_FST_VTYPE_VFIFO:
471 xo_emit("{eq:vode_type/fifo}");
474 case PS_FST_VTYPE_VBAD:
476 xo_emit("{eq:vode_type/revoked_device}");
479 case PS_FST_VTYPE_VNON:
481 xo_emit("{eq:vode_type/non}");
484 case PS_FST_VTYPE_UNKNOWN:
487 xo_emit("{eq:vode_type/unknown}");
491 xo_emit("{d:vnode_type/%1s/%s} ", str);
494 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_READ ?
496 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_WRITE ?
498 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_APPEND ?
500 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_ASYNC ?
502 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_SYNC ?
504 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_NONBLOCK ?
506 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_DIRECT ?
508 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_HASLOCK ?
511 xo_open_list("fd_flags");
512 if (fst->fs_fflags & PS_FST_FFLAG_READ)
513 xo_emit("{elq:fd_flags/read}");
514 if (fst->fs_fflags & PS_FST_FFLAG_WRITE)
515 xo_emit("{elq:fd_flags/write}");
516 if (fst->fs_fflags & PS_FST_FFLAG_APPEND)
517 xo_emit("{elq:fd_flags/append}");
518 if (fst->fs_fflags & PS_FST_FFLAG_ASYNC)
519 xo_emit("{elq:fd_flags/async}");
520 if (fst->fs_fflags & PS_FST_FFLAG_SYNC)
521 xo_emit("{elq:fd_flags/fsync}");
522 if (fst->fs_fflags & PS_FST_FFLAG_NONBLOCK)
523 xo_emit("{elq:fd_flags/nonblocking}");
524 if (fst->fs_fflags & PS_FST_FFLAG_DIRECT)
525 xo_emit("{elq:fd_flags/direct_io}");
526 if (fst->fs_fflags & PS_FST_FFLAG_HASLOCK)
527 xo_emit("{elq:fd_flags/lock_held}");
528 xo_close_list("fd_flags");
530 if ((procstat_opts & PS_OPT_CAPABILITIES) == 0) {
531 if (fst->fs_ref_count > -1)
532 xo_emit("{:ref_count/%3d/%d} ",
535 xo_emit("{q:ref_count/%3c/%c} ", '-');
536 if (fst->fs_offset > -1)
537 xo_emit("{:offset/%7jd/%jd} ",
538 (intmax_t)fst->fs_offset);
540 xo_emit("{q:offset/%7c/%c} ", '-');
542 if ((procstat_opts & PS_OPT_CAPABILITIES) != 0) {
543 print_capability(&fst->fs_cap_rights, capwidth);
546 switch (fst->fs_type) {
547 case PS_FST_TYPE_SOCKET:
548 error = procstat_get_socket_info(procstat, fst, &sock,
552 xo_emit("{:protocol/%-3s/%s} ",
553 protocol_to_string(sock.dom_family,
554 sock.type, sock.proto));
555 if (sock.proto == IPPROTO_TCP ||
556 sock.proto == IPPROTO_SCTP ||
557 sock.type == SOCK_STREAM) {
558 xo_emit("{:sendq/%u} ", sock.sendq);
559 xo_emit("{:recvq/%u} ", sock.recvq);
562 * While generally we like to print two addresses,
563 * local and peer, for sockets, it turns out to be
564 * more useful to print the first non-nul address for
565 * local sockets, as typically they aren't bound and
566 * connected, and the path strings can get long.
568 if (sock.dom_family == AF_LOCAL) {
569 struct sockaddr_un *sun =
570 (struct sockaddr_un *)&sock.sa_local;
572 if (sun->sun_path[0] != 0)
573 addr_to_string(&sock.sa_local,
574 src_addr, sizeof(src_addr));
576 addr_to_string(&sock.sa_peer,
577 src_addr, sizeof(src_addr));
578 xo_emit("{:path/%s}", src_addr);
580 addr_to_string(&sock.sa_local, src_addr,
582 addr_to_string(&sock.sa_peer, dst_addr,
584 xo_emit("{:path/%s %s}", src_addr, dst_addr);
589 xo_emit("{:protocol/%-3s/%s} ", "-");
590 xo_emit("{:path/%-18s/%s}", fst->fs_path != NULL ?
595 xo_close_instance("files");
597 xo_close_list("files");
598 procstat_freefiles(procstat, head);