1/*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1990, 1993, 1994 5 * The Regents of the University of California. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. Neither the name of the University nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 */ 31 32#if 0 33#ifndef lint 34static char sccsid[] = "@(#)keyword.c 8.5 (Berkeley) 4/2/94"; 35#endif /* not lint */ 36#endif 37#include <sys/cdefs.h> 38__FBSDID("$FreeBSD$"); 39 40#include <sys/param.h> 41#include <sys/time.h> 42#include <sys/resource.h> 43#include <sys/proc.h> 44#include <sys/sysctl.h> 45#include <sys/user.h> 46 47#include <err.h> 48#include <stddef.h> 49#include <stdio.h> 50#include <stdlib.h> 51#include <string.h> 52#include <libxo/xo.h> 53 54#include "ps.h" 55 56static VAR *findvar(char *, int, char **header); 57static int vcmp(const void *, const void *); 58 59/* Compute offset in common structures. */ 60#define KOFF(x) offsetof(struct kinfo_proc, x) 61#define ROFF(x) offsetof(struct rusage, x) 62 63#define LWPFMT "d" 64#define NLWPFMT "d" 65#define UIDFMT "u" 66#define PIDFMT "d" 67 68/* PLEASE KEEP THE TABLE BELOW SORTED ALPHABETICALLY!!! */ 69static VAR var[] = { 70 {"%cpu", "%CPU", NULL, "percent-cpu", 0, pcpu, 0, CHAR, NULL, 0}, 71 {"%mem", "%MEM", NULL, "percent-memory", 0, pmem, 0, CHAR, NULL, 0}, 72 {"acflag", "ACFLG", NULL, "accounting-flag", 0, kvar, KOFF(ki_acflag), 73 USHORT, "x", 0}, 74 {"acflg", "", "acflag", NULL, 0, NULL, 0, CHAR, NULL, 0}, 75 {"args", "COMMAND", NULL, "arguments", COMM|LJUST|USER, arguments, 0, 76 CHAR, NULL, 0}, 77 {"blocked", "", "sigmask", NULL, 0, NULL, 0, CHAR, NULL, 0}, 78 {"caught", "", "sigcatch", NULL, 0, NULL, 0, CHAR, NULL, 0}, 79 {"class", "CLASS", NULL, "login-class", LJUST, loginclass, 0, CHAR, 80 NULL, 0}, 81 {"comm", "COMMAND", NULL, "command", LJUST, ucomm, 0, CHAR, NULL, 0}, 82 {"command", "COMMAND", NULL, "command", COMM|LJUST|USER, command, 0, 83 CHAR, NULL, 0}, 84 {"cow", "COW", NULL, "copy-on-write-faults", 0, kvar, KOFF(ki_cow), 85 UINT, "u", 0}, 86 {"cpu", "C", NULL, "on-cpu", 0, cpunum, 0, CHAR, NULL, 0}, 87 {"cputime", "", "time", NULL, 0, NULL, 0, CHAR, NULL, 0}, 88 {"dsiz", "DSIZ", NULL, "data-size", 0, kvar, KOFF(ki_dsize), PGTOK, 89 "ld", 0}, 90 {"egid", "", "gid", NULL, 0, NULL, 0, CHAR, NULL, 0}, 91 {"egroup", "", "group", NULL, 0, NULL, 0, CHAR, NULL, 0}, 92 {"emul", "EMUL", NULL, "emulation-envirnment", LJUST, emulname, 0, 93 CHAR, NULL, 0}, 94 {"etime", "ELAPSED", NULL, "elapsed-time", USER, elapsed, 0, CHAR, 95 NULL, 0}, 96 {"etimes", "ELAPSED", NULL, "elapsed-times", USER, elapseds, 0, CHAR, 97 NULL, 0}, 98 {"euid", "", "uid", NULL, 0, NULL, 0, CHAR, NULL, 0}, 99 {"f", "F", NULL, "flags", 0, kvar, KOFF(ki_flag), LONG, "lx", 0}, 100 {"f2", "F2", NULL, "flags2", 0, kvar, KOFF(ki_flag2), INT, "08x", 0}, 101 {"fib", "FIB", NULL, "fib", 0, kvar, KOFF(ki_fibnum), INT, "d", 0}, 102 {"flags", "", "f", NULL, 0, NULL, 0, CHAR, NULL, 0}, 103 {"flags2", "", "f2", NULL, 0, NULL, 0, CHAR, NULL, 0}, 104 {"gid", "GID", NULL, "gid", 0, kvar, KOFF(ki_groups), UINT, UIDFMT, 0}, 105 {"group", "GROUP", NULL, "group", LJUST, egroupname, 0, CHAR, NULL, 0}, 106 {"ignored", "", "sigignore", NULL, 0, NULL, 0, CHAR, NULL, 0}, 107 {"inblk", "INBLK", NULL, "read-blocks", USER, rvar, ROFF(ru_inblock), 108 LONG, "ld", 0}, 109 {"inblock", "", "inblk", NULL, 0, NULL, 0, CHAR, NULL, 0}, 110 {"jail", "JAIL", NULL, "jail-name", LJUST, jailname, 0, CHAR, NULL, 0}, 111 {"jid", "JID", NULL, "jail-id", 0, kvar, KOFF(ki_jid), INT, "d", 0}, 112 {"jobc", "JOBC", NULL, "job-control-count", 0, kvar, KOFF(ki_jobc), 113 SHORT, "d", 0}, 114 {"ktrace", "KTRACE", NULL, "ktrace", 0, kvar, KOFF(ki_traceflag), INT, 115 "x", 0}, 116 {"label", "LABEL", NULL, "label", LJUST, label, 0, CHAR, NULL, 0}, 117 {"lim", "LIM", NULL, "memory-limit", 0, maxrss, 0, CHAR, NULL, 0}, 118 {"lockname", "LOCK", NULL, "lock-name", LJUST, lockname, 0, CHAR, NULL, 119 0}, 120 {"login", "LOGIN", NULL, "login-name", LJUST, logname, 0, CHAR, NULL, 121 0}, 122 {"logname", "", "login", NULL, 0, NULL, 0, CHAR, NULL, 0}, 123 {"lstart", "STARTED", NULL, "start-time", LJUST|USER, lstarted, 0, 124 CHAR, NULL, 0}, 125 {"lwp", "LWP", NULL, "thread-id", 0, kvar, KOFF(ki_tid), UINT, 126 LWPFMT, 0}, 127 {"majflt", "MAJFLT", NULL, "major-faults", USER, rvar, ROFF(ru_majflt), 128 LONG, "ld", 0}, 129 {"minflt", "MINFLT", NULL, "minor-faults", USER, rvar, ROFF(ru_minflt), 130 LONG, "ld", 0}, 131 {"msgrcv", "MSGRCV", NULL, "received-messages", USER, rvar, 132 ROFF(ru_msgrcv), LONG, "ld", 0}, 133 {"msgsnd", "MSGSND", NULL, "sent-messages", USER, rvar, 134 ROFF(ru_msgsnd), LONG, "ld", 0}, 135 {"mwchan", "MWCHAN", NULL, "wait-channel", LJUST, mwchan, 0, CHAR, 136 NULL, 0}, 137 {"ni", "", "nice", NULL, 0, NULL, 0, CHAR, NULL, 0}, 138 {"nice", "NI", NULL, "nice", 0, kvar, KOFF(ki_nice), CHAR, "d", 0}, 139 {"nivcsw", "NIVCSW", NULL, "involuntary-context-switches", USER, rvar, 140 ROFF(ru_nivcsw), LONG, "ld", 0}, 141 {"nlwp", "NLWP", NULL, "threads", 0, kvar, KOFF(ki_numthreads), UINT, 142 NLWPFMT, 0}, 143 {"nsignals", "", "nsigs", NULL, 0, NULL, 0, CHAR, NULL, 0}, 144 {"nsigs", "NSIGS", NULL, "signals-taken", USER, rvar, 145 ROFF(ru_nsignals), LONG, "ld", 0}, 146 {"nswap", "NSWAP", NULL, "swaps", USER, rvar, ROFF(ru_nswap), LONG, 147 "ld", 0}, 148 {"nvcsw", "NVCSW", NULL, "voluntary-context-switches", USER, rvar, 149 ROFF(ru_nvcsw), LONG, "ld", 0}, 150 {"nwchan", "NWCHAN", NULL, "wait-channel-address", LJUST, nwchan, 0, 151 CHAR, NULL, 0}, 152 {"oublk", "OUBLK", NULL, "written-blocks", USER, rvar, 153 ROFF(ru_oublock), LONG, "ld", 0}, 154 {"oublock", "", "oublk", NULL, 0, NULL, 0, CHAR, NULL, 0}, 155 {"paddr", "PADDR", NULL, "process-address", 0, kvar, KOFF(ki_paddr), 156 KPTR, "lx", 0}, 157 {"pagein", "PAGEIN", NULL, "pageins", USER, pagein, 0, CHAR, NULL, 0}, 158 {"pcpu", "", "%cpu", NULL, 0, NULL, 0, CHAR, NULL, 0}, 159 {"pending", "", "sig", NULL, 0, NULL, 0, CHAR, NULL, 0}, 160 {"pgid", "PGID", NULL, "process-group", 0, kvar, KOFF(ki_pgid), UINT, 161 PIDFMT, 0}, 162 {"pid", "PID", NULL, "pid", 0, kvar, KOFF(ki_pid), UINT, PIDFMT, 0}, 163 {"pmem", "", "%mem", NULL, 0, NULL, 0, CHAR, NULL, 0}, 164 {"ppid", "PPID", NULL, "ppid", 0, kvar, KOFF(ki_ppid), UINT, PIDFMT, 0}, 165 {"pri", "PRI", NULL, "priority", 0, pri, 0, CHAR, NULL, 0}, 166 {"re", "RE", NULL, "residency-time", INF127, kvar, KOFF(ki_swtime), 167 UINT, "d", 0}, 168 {"rgid", "RGID", NULL, "real-gid", 0, kvar, KOFF(ki_rgid), UINT, 169 UIDFMT, 0}, 170 {"rgroup", "RGROUP", NULL, "real-group", LJUST, rgroupname, 0, CHAR, 171 NULL, 0}, 172 {"rss", "RSS", NULL, "rss", 0, kvar, KOFF(ki_rssize), PGTOK, "ld", 0}, 173 {"rtprio", "RTPRIO", NULL, "realtime-priority", 0, priorityr, 174 KOFF(ki_pri), CHAR, NULL, 0}, 175 {"ruid", "RUID", NULL, "real-uid", 0, kvar, KOFF(ki_ruid), UINT, 176 UIDFMT, 0}, 177 {"ruser", "RUSER", NULL, "real-user", LJUST, runame, 0, CHAR, NULL, 0}, 178 {"sid", "SID", NULL, "sid", 0, kvar, KOFF(ki_sid), UINT, PIDFMT, 0}, 179 {"sig", "PENDING", NULL, "signals-pending", 0, kvar, KOFF(ki_siglist), 180 INT, "x", 0}, 181 {"sigcatch", "CAUGHT", NULL, "signals-caught", 0, kvar, 182 KOFF(ki_sigcatch), UINT, "x", 0}, 183 {"sigignore", "IGNORED", NULL, "signals-ignored", 0, kvar, 184 KOFF(ki_sigignore), UINT, "x", 0}, 185 {"sigmask", "BLOCKED", NULL, "signal-mask", 0, kvar, KOFF(ki_sigmask), 186 UINT, "x", 0}, 187 {"sl", "SL", NULL, "sleep-time", INF127, kvar, KOFF(ki_slptime), UINT, 188 "d", 0}, 189 {"ssiz", "SSIZ", NULL, "stack-size", 0, kvar, KOFF(ki_ssize), PGTOK, 190 "ld", 0}, 191 {"start", "STARTED", NULL, "start-time", LJUST|USER, started, 0, CHAR, 192 NULL, 0}, 193 {"stat", "", "state", NULL, 0, NULL, 0, CHAR, NULL, 0}, 194 {"state", "STAT", NULL, "state", LJUST, state, 0, CHAR, NULL, 0}, 195 {"svgid", "SVGID", NULL, "saved-gid", 0, kvar, KOFF(ki_svgid), UINT, 196 UIDFMT, 0}, 197 {"svuid", "SVUID", NULL, "saved-uid", 0, kvar, KOFF(ki_svuid), UINT, 198 UIDFMT, 0}, 199 {"systime", "SYSTIME", NULL, "system-time", USER, systime, 0, CHAR, 200 NULL, 0}, 201 {"tdaddr", "TDADDR", NULL, "thread-address", 0, kvar, KOFF(ki_tdaddr), 202 KPTR, "lx", 0}, 203 {"tdev", "TDEV", NULL, "terminal-device", 0, tdev, 0, CHAR, NULL, 0}, 204 {"tdnam", "", "tdname", NULL, 0, NULL, 0, CHAR, NULL, 0}, 205 {"tdname", "TDNAME", NULL, "thread-name", LJUST, tdnam, 0, CHAR, 206 NULL, 0}, 207 {"tid", "", "lwp", NULL, 0, NULL, 0, CHAR, NULL, 0}, 208 {"time", "TIME", NULL, "cpu-time", USER, cputime, 0, CHAR, NULL, 0}, 209 {"tpgid", "TPGID", NULL, "terminal-process-gid", 0, kvar, 210 KOFF(ki_tpgid), UINT, PIDFMT, 0}, 211 {"tracer", "TRACER", NULL, "tracer", 0, kvar, KOFF(ki_tracer), UINT, 212 PIDFMT, 0}, 213 {"tsid", "TSID", NULL, "terminal-sid", 0, kvar, KOFF(ki_tsid), UINT, 214 PIDFMT, 0}, 215 {"tsiz", "TSIZ", NULL, "text-size", 0, kvar, KOFF(ki_tsize), PGTOK, 216 "ld", 0}, 217 {"tt", "TT ", NULL, "terminal-name", 0, tname, 0, CHAR, NULL, 0}, 218 {"tty", "TTY", NULL, "tty", LJUST, longtname, 0, CHAR, NULL, 0}, 219 {"ucomm", "UCOMM", NULL, "accounting-name", LJUST, ucomm, 0, CHAR, 220 NULL, 0}, 221 {"uid", "UID", NULL, "uid", 0, kvar, KOFF(ki_uid), UINT, UIDFMT, 0}, 222 {"upr", "UPR", NULL, "user-priority", 0, upr, 0, CHAR, NULL, 0}, 223 {"uprocp", "UPROCP", NULL, "process-address", 0, kvar, KOFF(ki_paddr), 224 KPTR, "lx", 0}, 225 {"user", "USER", NULL, "user", LJUST, uname, 0, CHAR, NULL, 0}, 226 {"usertime", "USERTIME", NULL, "user-time", USER, usertime, 0, CHAR, 227 NULL, 0}, 228 {"usrpri", "", "upr", NULL, 0, NULL, 0, CHAR, NULL, 0}, 229 {"vmaddr", "VMADDR", NULL, "vmspace-address", 0, kvar, KOFF(ki_vmspace), 230 KPTR, "lx", 0}, 231 {"vsize", "", "vsz", NULL, 0, NULL, 0, CHAR, NULL, 0}, 232 {"vsz", "VSZ", NULL, "virtual-size", 0, vsize, 0, CHAR, NULL, 0}, 233 {"wchan", "WCHAN", NULL, "wait-channel", LJUST, wchan, 0, CHAR, NULL, 234 0}, 235 {"xstat", "XSTAT", NULL, "exit-status", 0, kvar, KOFF(ki_xstat), 236 USHORT, "x", 0}, 237 {"", NULL, NULL, NULL, 0, NULL, 0, CHAR, NULL, 0}, 238}; 239 240void 241showkey(void) 242{ 243 VAR *v; 244 int i; 245 const char *p, *sep; 246 247 i = 0; 248 sep = ""; 249 xo_open_list("key"); 250 for (v = var; *(p = v->name); ++v) { 251 int len = strlen(p); 252 if (termwidth && (i += len + 1) > termwidth) { 253 i = len; 254 sep = "\n"; 255 } 256 xo_emit("{P:/%hs}{l:key/%hs}", sep, p); 257 sep = " "; 258 } 259 xo_emit("\n"); 260 xo_close_list("key"); 261 xo_finish(); 262} 263 264void 265parsefmt(const char *p, int user) 266{ 267 char *tempstr, *tempstr1; 268 269#define FMTSEP " \t,\n" 270 tempstr1 = tempstr = strdup(p); 271 while (tempstr && *tempstr) { 272 char *cp, *hp; 273 VAR *v; 274 struct varent *vent; 275 276 /* 277 * If an item contains an equals sign, it specifies a column 278 * header, may contain embedded separator characters and 279 * is always the last item. 280 */ 281 if (tempstr[strcspn(tempstr, "="FMTSEP)] != '=') 282 while ((cp = strsep(&tempstr, FMTSEP)) != NULL && 283 *cp == '\0') 284 /* void */; 285 else { 286 cp = tempstr; 287 tempstr = NULL; 288 } 289 if (cp == NULL || !(v = findvar(cp, user, &hp))) 290 continue; 291 if (!user) { 292 /* 293 * If the user is NOT adding this field manually, 294 * get on with our lives if this VAR is already 295 * represented in the list. 296 */ 297 vent = find_varentry(v); 298 if (vent != NULL) 299 continue; 300 } 301 if ((vent = malloc(sizeof(struct varent))) == NULL) 302 errx(1, "malloc failed"); 303 vent->header = v->header; 304 if (hp) { 305 hp = strdup(hp); 306 if (hp) 307 vent->header = hp; 308 } 309 vent->var = malloc(sizeof(*vent->var)); 310 if (vent->var == NULL) 311 errx(1, "malloc failed"); 312 memcpy(vent->var, v, sizeof(*vent->var)); 313 STAILQ_INSERT_TAIL(&varlist, vent, next_ve); 314 } 315 free(tempstr1); 316 if (STAILQ_EMPTY(&varlist)) { 317 warnx("no valid keywords; valid keywords:"); 318 showkey(); 319 exit(1); 320 } 321} 322 323static VAR * 324findvar(char *p, int user, char **header) 325{ 326 size_t rflen; 327 VAR *v, key; 328 char *hp, *realfmt; 329 330 hp = strchr(p, '='); 331 if (hp) 332 *hp++ = '\0'; 333 334 key.name = p; 335 v = bsearch(&key, var, sizeof(var)/sizeof(VAR) - 1, sizeof(VAR), vcmp); 336 337 if (v && v->alias) { 338 /* 339 * If the user specified an alternate-header for this 340 * (aliased) format-name, then we need to copy that 341 * alternate-header when making the recursive call to 342 * process the alias. 343 */ 344 if (hp == NULL) 345 parsefmt(v->alias, user); 346 else { 347 /* 348 * XXX - This processing will not be correct for 349 * any alias which expands into a list of format 350 * keywords. Presently there are no aliases 351 * which do that. 352 */ 353 rflen = strlen(v->alias) + strlen(hp) + 2; 354 realfmt = malloc(rflen); 355 if (realfmt == NULL) 356 errx(1, "malloc failed"); 357 snprintf(realfmt, rflen, "%s=%s", v->alias, hp); 358 parsefmt(realfmt, user); 359 free(realfmt); 360 } 361 return ((VAR *)NULL); 362 } 363 if (!v) { 364 warnx("%s: keyword not found", p); 365 eval = 1; 366 } 367 if (header) 368 *header = hp; 369 return (v); 370} 371 372static int 373vcmp(const void *a, const void *b) 374{ 375 return (strcmp(((const VAR *)a)->name, ((const VAR *)b)->name)); 376} 377