1/*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2007-2011 Robert N. M. Watson 5 * Copyright (c) 2015 Allan Jude <allanjude@freebsd.org> 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 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. 16 * 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 27 * SUCH DAMAGE. 28 * 29 * $FreeBSD: stable/11/usr.bin/procstat/procstat_files.c 341779 2018-12-10 01:39:40Z kib $ 30 */ 31 32#include <sys/param.h> 33#include <sys/capsicum.h> 34#include <sys/socket.h> 35#include <sys/sysctl.h> 36#include <sys/un.h> 37#include <sys/user.h> 38 39#include <netinet/in.h> 40 41#include <arpa/inet.h> 42 43#include <err.h> 44#include <libprocstat.h> 45#include <inttypes.h> 46#include <stdio.h> 47#include <stdlib.h> 48#include <string.h> 49 50#include "procstat.h" 51 52static const char * 53protocol_to_string(int domain, int type, int protocol) 54{ 55 56 switch (domain) { 57 case AF_INET: 58 case AF_INET6: 59 switch (protocol) { 60 case IPPROTO_TCP: 61 return ("TCP"); 62 case IPPROTO_UDP: 63 return ("UDP"); 64 case IPPROTO_ICMP: 65 return ("ICM"); 66 case IPPROTO_RAW: 67 return ("RAW"); 68 case IPPROTO_SCTP: 69 return ("SCT"); 70 case IPPROTO_DIVERT: 71 return ("IPD"); 72 default: 73 return ("IP?"); 74 } 75 76 case AF_LOCAL: 77 switch (type) { 78 case SOCK_STREAM: 79 return ("UDS"); 80 case SOCK_DGRAM: 81 return ("UDD"); 82 default: 83 return ("UD?"); 84 } 85 default: 86 return ("?"); 87 } 88} 89 90static void 91addr_to_string(struct sockaddr_storage *ss, char *buffer, int buflen) 92{ 93 char buffer2[INET6_ADDRSTRLEN]; 94 struct sockaddr_in6 *sin6; 95 struct sockaddr_in *sin; 96 struct sockaddr_un *sun; 97 98 switch (ss->ss_family) { 99 case AF_LOCAL: 100 sun = (struct sockaddr_un *)ss; 101 if (strlen(sun->sun_path) == 0) 102 strlcpy(buffer, "-", buflen); 103 else 104 strlcpy(buffer, sun->sun_path, buflen); 105 break; 106 107 case AF_INET: 108 sin = (struct sockaddr_in *)ss; 109 snprintf(buffer, buflen, "%s:%d", inet_ntoa(sin->sin_addr), 110 ntohs(sin->sin_port)); 111 break; 112 113 case AF_INET6: 114 sin6 = (struct sockaddr_in6 *)ss; 115 if (inet_ntop(AF_INET6, &sin6->sin6_addr, buffer2, 116 sizeof(buffer2)) != NULL) 117 snprintf(buffer, buflen, "%s.%d", buffer2, 118 ntohs(sin6->sin6_port)); 119 else 120 strlcpy(buffer, "-", buflen); 121 break; 122 123 default: 124 strlcpy(buffer, "", buflen); 125 break; 126 } 127} 128 129static struct cap_desc { 130 uint64_t cd_right; 131 const char *cd_desc; 132} cap_desc[] = { 133 /* General file I/O. */ 134 { CAP_READ, "rd" }, 135 { CAP_WRITE, "wr" }, 136 { CAP_SEEK, "se" }, 137 { CAP_MMAP, "mm" }, 138 { CAP_CREATE, "cr" }, 139 { CAP_FEXECVE, "fe" }, 140 { CAP_FSYNC, "fy" }, 141 { CAP_FTRUNCATE, "ft" }, 142 143 /* VFS methods. */ 144 { CAP_FCHDIR, "cd" }, 145 { CAP_FCHFLAGS, "cf" }, 146 { CAP_FCHMOD, "cm" }, 147 { CAP_FCHOWN, "cn" }, 148 { CAP_FCNTL, "fc" }, 149 { CAP_FLOCK, "fl" }, 150 { CAP_FPATHCONF, "fp" }, 151 { CAP_FSCK, "fk" }, 152 { CAP_FSTAT, "fs" }, 153 { CAP_FSTATFS, "sf" }, 154 { CAP_FUTIMES, "fu" }, 155 { CAP_LINKAT_SOURCE, "ls" }, 156 { CAP_LINKAT_TARGET, "lt" }, 157 { CAP_MKDIRAT, "md" }, 158 { CAP_MKFIFOAT, "mf" }, 159 { CAP_MKNODAT, "mn" }, 160 { CAP_RENAMEAT_SOURCE, "rs" }, 161 { CAP_RENAMEAT_TARGET, "rt" }, 162 { CAP_SYMLINKAT, "sl" }, 163 { CAP_UNLINKAT, "un" }, 164 165 /* Lookups - used to constrain *at() calls. */ 166 { CAP_LOOKUP, "lo" }, 167 168 /* Extended attributes. */ 169 { CAP_EXTATTR_GET, "eg" }, 170 { CAP_EXTATTR_SET, "es" }, 171 { CAP_EXTATTR_DELETE, "ed" }, 172 { CAP_EXTATTR_LIST, "el" }, 173 174 /* Access Control Lists. */ 175 { CAP_ACL_GET, "ag" }, 176 { CAP_ACL_SET, "as" }, 177 { CAP_ACL_DELETE, "ad" }, 178 { CAP_ACL_CHECK, "ac" }, 179 180 /* Socket operations. */ 181 { CAP_ACCEPT, "at" }, 182 { CAP_BIND, "bd" }, 183 { CAP_CONNECT, "co" }, 184 { CAP_GETPEERNAME, "pn" }, 185 { CAP_GETSOCKNAME, "sn" }, 186 { CAP_GETSOCKOPT, "gs" }, 187 { CAP_LISTEN, "ln" }, 188 { CAP_PEELOFF, "pf" }, 189 { CAP_SETSOCKOPT, "ss" }, 190 { CAP_SHUTDOWN, "sh" }, 191 192 /* Mandatory Access Control. */ 193 { CAP_MAC_GET, "mg" }, 194 { CAP_MAC_SET, "ms" }, 195 196 /* Methods on semaphores. */ 197 { CAP_SEM_GETVALUE, "sg" }, 198 { CAP_SEM_POST, "sp" }, 199 { CAP_SEM_WAIT, "sw" }, 200 201 /* Event monitoring and posting. */ 202 { CAP_EVENT, "ev" }, 203 { CAP_KQUEUE_EVENT, "ke" }, 204 { CAP_KQUEUE_CHANGE, "kc" }, 205 206 /* Strange and powerful rights that should not be given lightly. */ 207 { CAP_IOCTL, "io" }, 208 { CAP_TTYHOOK, "ty" }, 209 210 /* Process management via process descriptors. */ 211 { CAP_PDGETPID, "pg" }, 212 { CAP_PDWAIT, "pw" }, 213 { CAP_PDKILL, "pk" }, 214 215 /* 216 * Rights that allow to use bindat(2) and connectat(2) syscalls on a 217 * directory descriptor. 218 */ 219 { CAP_BINDAT, "ba" }, 220 { CAP_CONNECTAT, "ca" }, 221 222 /* Aliases and defines that combine multiple rights. */ 223 { CAP_PREAD, "prd" }, 224 { CAP_PWRITE, "pwr" }, 225 226 { CAP_MMAP_R, "mmr" }, 227 { CAP_MMAP_W, "mmw" }, 228 { CAP_MMAP_X, "mmx" }, 229 { CAP_MMAP_RW, "mrw" }, 230 { CAP_MMAP_RX, "mrx" }, 231 { CAP_MMAP_WX, "mwx" }, 232 { CAP_MMAP_RWX, "mma" }, 233 234 { CAP_RECV, "re" }, 235 { CAP_SEND, "sd" }, 236 237 { CAP_SOCK_CLIENT, "scl" }, 238 { CAP_SOCK_SERVER, "ssr" }, 239}; 240static const u_int cap_desc_count = nitems(cap_desc); 241 242static u_int 243width_capability(cap_rights_t *rightsp) 244{ 245 u_int count, i, width; 246 247 count = 0; 248 width = 0; 249 for (i = 0; i < cap_desc_count; i++) { 250 if (cap_rights_is_set(rightsp, cap_desc[i].cd_right)) { 251 width += strlen(cap_desc[i].cd_desc); 252 if (count) 253 width++; 254 count++; 255 } 256 } 257 return (width); 258} 259 260static void 261print_capability(cap_rights_t *rightsp, u_int capwidth) 262{ 263 u_int count, i, width; 264 265 count = 0; 266 width = 0; 267 for (i = width_capability(rightsp); i < capwidth; i++) { 268 if (i != 0) 269 xo_emit(" "); 270 else 271 xo_emit("-"); 272 } 273 xo_open_list("capabilities"); 274 for (i = 0; i < cap_desc_count; i++) { 275 if (cap_rights_is_set(rightsp, cap_desc[i].cd_right)) { 276 xo_emit("{D:/%s}{l:capabilities/%s}", count ? "," : "", 277 cap_desc[i].cd_desc); 278 width += strlen(cap_desc[i].cd_desc); 279 if (count) 280 width++; 281 count++; 282 } 283 } 284 xo_close_list("capabilities"); 285} 286 287void 288procstat_files(struct procstat *procstat, struct kinfo_proc *kipp) 289{ 290 struct sockstat sock; 291 struct filestat_list *head; 292 struct filestat *fst; 293 const char *str; 294 struct vnstat vn; 295 u_int capwidth, width; 296 int error; 297 char src_addr[PATH_MAX]; 298 char dst_addr[PATH_MAX]; 299 300 /* 301 * To print the header in capability mode, we need to know the width 302 * of the widest capability string. Even if we get no processes 303 * back, we will print the header, so we defer aborting due to a lack 304 * of processes until after the header logic. 305 */ 306 capwidth = 0; 307 head = procstat_getfiles(procstat, kipp, 0); 308 if (head != NULL && Cflag) { 309 STAILQ_FOREACH(fst, head, next) { 310 width = width_capability(&fst->fs_cap_rights); 311 if (width > capwidth) 312 capwidth = width; 313 } 314 if (capwidth < strlen("CAPABILITIES")) 315 capwidth = strlen("CAPABILITIES"); 316 } 317 318 if (!hflag) { 319 if (Cflag) 320 xo_emit("{T:/%5s %-16s %5s %1s %-8s %-*s " 321 "%-3s %-12s}\n", "PID", "COMM", "FD", "T", 322 "FLAGS", capwidth, "CAPABILITIES", "PRO", 323 "NAME"); 324 else 325 xo_emit("{T:/%5s %-16s %5s %1s %1s %-8s " 326 "%3s %7s %-3s %-12s}\n", "PID", "COMM", "FD", "T", 327 "V", "FLAGS", "REF", "OFFSET", "PRO", "NAME"); 328 } 329 330 if (head == NULL) 331 return; 332 xo_emit("{ek:process_id/%5d/%d}", kipp->ki_pid); 333 xo_emit("{e:command/%-16s/%s}", kipp->ki_comm); 334 xo_open_list("files"); 335 STAILQ_FOREACH(fst, head, next) { 336 xo_open_instance("files"); 337 xo_emit("{dk:process_id/%5d/%d} ", kipp->ki_pid); 338 xo_emit("{d:command/%-16s/%s} ", kipp->ki_comm); 339 if (fst->fs_uflags & PS_FST_UFLAG_CTTY) 340 xo_emit("{P: }{:fd/%s} ", "ctty"); 341 else if (fst->fs_uflags & PS_FST_UFLAG_CDIR) 342 xo_emit("{P: }{:fd/%s} ", "cwd"); 343 else if (fst->fs_uflags & PS_FST_UFLAG_JAIL) 344 xo_emit("{P: }{:fd/%s} ", "jail"); 345 else if (fst->fs_uflags & PS_FST_UFLAG_RDIR) 346 xo_emit("{P: }{:fd/%s} ", "root"); 347 else if (fst->fs_uflags & PS_FST_UFLAG_TEXT) 348 xo_emit("{P: }{:fd/%s} ", "text"); 349 else if (fst->fs_uflags & PS_FST_UFLAG_TRACE) 350 xo_emit("{:fd/%s} ", "trace"); 351 else 352 xo_emit("{:fd/%5d} ", fst->fs_fd); 353 354 switch (fst->fs_type) { 355 case PS_FST_TYPE_VNODE: 356 str = "v"; 357 xo_emit("{eq:fd_type/vnode}"); 358 break; 359 360 case PS_FST_TYPE_SOCKET: 361 str = "s"; 362 xo_emit("{eq:fd_type/socket}"); 363 break; 364 365 case PS_FST_TYPE_PIPE: 366 str = "p"; 367 xo_emit("{eq:fd_type/pipe}"); 368 break; 369 370 case PS_FST_TYPE_FIFO: 371 str = "f"; 372 xo_emit("{eq:fd_type/fifo}"); 373 break; 374 375 case PS_FST_TYPE_KQUEUE: 376 str = "k"; 377 xo_emit("{eq:fd_type/kqueue}"); 378 break; 379 380 case PS_FST_TYPE_CRYPTO: 381 str = "c"; 382 xo_emit("{eq:fd_type/crypto}"); 383 break; 384 385 case PS_FST_TYPE_MQUEUE: 386 str = "m"; 387 xo_emit("{eq:fd_type/mqueue}"); 388 break; 389 390 case PS_FST_TYPE_SHM: 391 str = "h"; 392 xo_emit("{eq:fd_type/shm}"); 393 break; 394 395 case PS_FST_TYPE_PTS: 396 str = "t"; 397 xo_emit("{eq:fd_type/pts}"); 398 break; 399 400 case PS_FST_TYPE_SEM: 401 str = "e"; 402 xo_emit("{eq:fd_type/sem}"); 403 break; 404 405 case PS_FST_TYPE_PROCDESC: 406 str = "P"; 407 xo_emit("{eq:fd_type/procdesc}"); 408 break; 409 410 case PS_FST_TYPE_DEV: 411 str = "D"; 412 xo_emit("{eq:fd_type/dev}"); 413 break; 414 415 case PS_FST_TYPE_NONE: 416 str = "?"; 417 xo_emit("{eq:fd_type/none}"); 418 break; 419 420 case PS_FST_TYPE_UNKNOWN: 421 default: 422 str = "?"; 423 xo_emit("{eq:fd_type/unknown}"); 424 break; 425 } 426 xo_emit("{d:fd_type/%1s/%s} ", str); 427 if (!Cflag) { 428 str = "-"; 429 if (fst->fs_type == PS_FST_TYPE_VNODE) { 430 error = procstat_get_vnode_info(procstat, fst, 431 &vn, NULL); 432 switch (vn.vn_type) { 433 case PS_FST_VTYPE_VREG: 434 str = "r"; 435 xo_emit("{eq:vode_type/regular}"); 436 break; 437 438 case PS_FST_VTYPE_VDIR: 439 str = "d"; 440 xo_emit("{eq:vode_type/directory}"); 441 break; 442 443 case PS_FST_VTYPE_VBLK: 444 str = "b"; 445 xo_emit("{eq:vode_type/block}"); 446 break; 447 448 case PS_FST_VTYPE_VCHR: 449 str = "c"; 450 xo_emit("{eq:vode_type/character}"); 451 break; 452 453 case PS_FST_VTYPE_VLNK: 454 str = "l"; 455 xo_emit("{eq:vode_type/link}"); 456 break; 457 458 case PS_FST_VTYPE_VSOCK: 459 str = "s"; 460 xo_emit("{eq:vode_type/socket}"); 461 break; 462 463 case PS_FST_VTYPE_VFIFO: 464 str = "f"; 465 xo_emit("{eq:vode_type/fifo}"); 466 break; 467 468 case PS_FST_VTYPE_VBAD: 469 str = "x"; 470 xo_emit("{eq:vode_type/revoked_device}"); 471 break; 472 473 case PS_FST_VTYPE_VNON: 474 str = "?"; 475 xo_emit("{eq:vode_type/non}"); 476 break; 477 478 case PS_FST_VTYPE_UNKNOWN: 479 default: 480 str = "?"; 481 xo_emit("{eq:vode_type/unknown}"); 482 break; 483 } 484 } 485 xo_emit("{d:vnode_type/%1s/%s} ", str); 486 } 487 488 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_READ ? 489 "r" : "-"); 490 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_WRITE ? 491 "w" : "-"); 492 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_APPEND ? 493 "a" : "-"); 494 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_ASYNC ? 495 "s" : "-"); 496 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_SYNC ? 497 "f" : "-"); 498 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_NONBLOCK ? 499 "n" : "-"); 500 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_DIRECT ? 501 "d" : "-"); 502 xo_emit("{d:/%s}", fst->fs_fflags & PS_FST_FFLAG_HASLOCK ? 503 "l" : "-"); 504 xo_emit(" "); 505 xo_open_list("fd_flags"); 506 if (fst->fs_fflags & PS_FST_FFLAG_READ) 507 xo_emit("{elq:fd_flags/read}"); 508 if (fst->fs_fflags & PS_FST_FFLAG_WRITE) 509 xo_emit("{elq:fd_flags/write}"); 510 if (fst->fs_fflags & PS_FST_FFLAG_APPEND) 511 xo_emit("{elq:fd_flags/append}"); 512 if (fst->fs_fflags & PS_FST_FFLAG_ASYNC) 513 xo_emit("{elq:fd_flags/async}"); 514 if (fst->fs_fflags & PS_FST_FFLAG_SYNC) 515 xo_emit("{elq:fd_flags/fsync}"); 516 if (fst->fs_fflags & PS_FST_FFLAG_NONBLOCK) 517 xo_emit("{elq:fd_flags/nonblocking}"); 518 if (fst->fs_fflags & PS_FST_FFLAG_DIRECT) 519 xo_emit("{elq:fd_flags/direct_io}"); 520 if (fst->fs_fflags & PS_FST_FFLAG_HASLOCK) 521 xo_emit("{elq:fd_flags/lock_held}"); 522 xo_close_list("fd_flags"); 523 524 if (!Cflag) { 525 if (fst->fs_ref_count > -1) 526 xo_emit("{:ref_count/%3d/%d} ", 527 fst->fs_ref_count); 528 else 529 xo_emit("{q:ref_count/%3c/%c} ", '-'); 530 if (fst->fs_offset > -1) 531 xo_emit("{:offset/%7jd/%jd} ", 532 (intmax_t)fst->fs_offset); 533 else 534 xo_emit("{q:offset/%7c/%c} ", '-'); 535 } 536 if (Cflag) { 537 print_capability(&fst->fs_cap_rights, capwidth); 538 xo_emit(" "); 539 } 540 switch (fst->fs_type) { 541 case PS_FST_TYPE_SOCKET: 542 error = procstat_get_socket_info(procstat, fst, &sock, 543 NULL); 544 if (error != 0) 545 break; 546 xo_emit("{:protocol/%-3s/%s} ", 547 protocol_to_string(sock.dom_family, 548 sock.type, sock.proto)); 549 /* 550 * While generally we like to print two addresses, 551 * local and peer, for sockets, it turns out to be 552 * more useful to print the first non-nul address for 553 * local sockets, as typically they aren't bound and 554 * connected, and the path strings can get long. 555 */ 556 if (sock.dom_family == AF_LOCAL) { 557 struct sockaddr_un *sun = 558 (struct sockaddr_un *)&sock.sa_local; 559 560 if (sun->sun_path[0] != 0) 561 addr_to_string(&sock.sa_local, 562 src_addr, sizeof(src_addr)); 563 else 564 addr_to_string(&sock.sa_peer, 565 src_addr, sizeof(src_addr)); 566 xo_emit("{:path/%s}", src_addr); 567 } else { 568 addr_to_string(&sock.sa_local, src_addr, 569 sizeof(src_addr)); 570 addr_to_string(&sock.sa_peer, dst_addr, 571 sizeof(dst_addr)); 572 xo_emit("{:path/%s %s}", src_addr, dst_addr); 573 } 574 break; 575 576 default: 577 xo_emit("{:protocol/%-3s/%s} ", "-"); 578 xo_emit("{:path/%-18s/%s}", fst->fs_path != NULL ? 579 fst->fs_path : "-"); 580 } 581 582 xo_emit("\n"); 583 xo_close_instance("files"); 584 } 585 xo_close_list("files"); 586 procstat_freefiles(procstat, head); 587} 588