2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1990, 1993, 1994
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
34 static char sccsid[] = "@(#)keyword.c 8.5 (Berkeley) 4/2/94";
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
40 #include <sys/param.h>
42 #include <sys/resource.h>
44 #include <sys/sysctl.h>
56 static VAR *findvar(char *, int, char **header);
57 static int vcmp(const void *, const void *);
59 /* Compute offset in common structures. */
60 #define KOFF(x) offsetof(struct kinfo_proc, x)
61 #define ROFF(x) offsetof(struct rusage, x)
68 /* PLEASE KEEP THE TABLE BELOW SORTED ALPHABETICALLY!!! */
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),
74 {"acflg", "", "acflag", NULL, 0, NULL, 0, CHAR, NULL, 0},
75 {"args", "COMMAND", NULL, "arguments", COMM|LJUST|USER, arguments, 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,
81 {"comm", "COMMAND", NULL, "command", LJUST, ucomm, 0, CHAR, NULL, 0},
82 {"command", "COMMAND", NULL, "command", COMM|LJUST|USER, command, 0,
84 {"cow", "COW", NULL, "copy-on-write-faults", 0, kvar, KOFF(ki_cow),
86 {"cpu", "CPU", NULL, "cpu-usage", 0, kvar, KOFF(ki_estcpu), UINT, "d",
88 {"cputime", "", "time", NULL, 0, NULL, 0, CHAR, NULL, 0},
89 {"dsiz", "DSIZ", NULL, "data-size", 0, kvar, KOFF(ki_dsize), PGTOK,
91 {"egid", "", "gid", NULL, 0, NULL, 0, CHAR, NULL, 0},
92 {"egroup", "", "group", NULL, 0, NULL, 0, CHAR, NULL, 0},
93 {"emul", "EMUL", NULL, "emulation-envirnment", LJUST, emulname, 0,
95 {"etime", "ELAPSED", NULL, "elapsed-time", USER, elapsed, 0, CHAR,
97 {"etimes", "ELAPSED", NULL, "elapsed-times", USER, elapseds, 0, CHAR,
99 {"euid", "", "uid", NULL, 0, NULL, 0, CHAR, NULL, 0},
100 {"f", "F", NULL, "flags", 0, kvar, KOFF(ki_flag), LONG, "lx", 0},
101 {"f2", "F2", NULL, "flags2", 0, kvar, KOFF(ki_flag2), INT, "08x", 0},
102 {"fib", "FIB", NULL, "fib", 0, kvar, KOFF(ki_fibnum), INT, "d", 0},
103 {"flags", "", "f", NULL, 0, NULL, 0, CHAR, NULL, 0},
104 {"flags2", "", "f2", NULL, 0, NULL, 0, CHAR, NULL, 0},
105 {"gid", "GID", NULL, "gid", 0, kvar, KOFF(ki_groups), UINT, UIDFMT, 0},
106 {"group", "GROUP", NULL, "group", LJUST, egroupname, 0, CHAR, NULL, 0},
107 {"ignored", "", "sigignore", NULL, 0, NULL, 0, CHAR, NULL, 0},
108 {"inblk", "INBLK", NULL, "read-blocks", USER, rvar, ROFF(ru_inblock),
110 {"inblock", "", "inblk", NULL, 0, NULL, 0, CHAR, NULL, 0},
111 {"jail", "JAIL", NULL, "jail-name", LJUST, jailname, 0, CHAR, NULL, 0},
112 {"jid", "JID", NULL, "jail-id", 0, kvar, KOFF(ki_jid), INT, "d", 0},
113 {"jobc", "JOBC", NULL, "job-control-count", 0, kvar, KOFF(ki_jobc),
115 {"ktrace", "KTRACE", NULL, "ktrace", 0, kvar, KOFF(ki_traceflag), INT,
117 {"label", "LABEL", NULL, "label", LJUST, label, 0, CHAR, NULL, 0},
118 {"lim", "LIM", NULL, "memory-limit", 0, maxrss, 0, CHAR, NULL, 0},
119 {"lockname", "LOCK", NULL, "lock-name", LJUST, lockname, 0, CHAR, NULL,
121 {"login", "LOGIN", NULL, "login-name", LJUST, logname, 0, CHAR, NULL,
123 {"logname", "", "login", NULL, 0, NULL, 0, CHAR, NULL, 0},
124 {"lstart", "STARTED", NULL, "start-time", LJUST|USER, lstarted, 0,
126 {"lwp", "LWP", NULL, "thread-id", 0, kvar, KOFF(ki_tid), UINT,
128 {"majflt", "MAJFLT", NULL, "major-faults", USER, rvar, ROFF(ru_majflt),
130 {"minflt", "MINFLT", NULL, "minor-faults", USER, rvar, ROFF(ru_minflt),
132 {"msgrcv", "MSGRCV", NULL, "received-messages", USER, rvar,
133 ROFF(ru_msgrcv), LONG, "ld", 0},
134 {"msgsnd", "MSGSND", NULL, "sent-messages", USER, rvar,
135 ROFF(ru_msgsnd), LONG, "ld", 0},
136 {"mwchan", "MWCHAN", NULL, "wait-channel", LJUST, mwchan, 0, CHAR,
138 {"ni", "", "nice", NULL, 0, NULL, 0, CHAR, NULL, 0},
139 {"nice", "NI", NULL, "nice", 0, kvar, KOFF(ki_nice), CHAR, "d", 0},
140 {"nivcsw", "NIVCSW", NULL, "involuntary-context-switches", USER, rvar,
141 ROFF(ru_nivcsw), LONG, "ld", 0},
142 {"nlwp", "NLWP", NULL, "threads", 0, kvar, KOFF(ki_numthreads), UINT,
144 {"nsignals", "", "nsigs", NULL, 0, NULL, 0, CHAR, NULL, 0},
145 {"nsigs", "NSIGS", NULL, "signals-taken", USER, rvar,
146 ROFF(ru_nsignals), LONG, "ld", 0},
147 {"nswap", "NSWAP", NULL, "swaps", USER, rvar, ROFF(ru_nswap), LONG,
149 {"nvcsw", "NVCSW", NULL, "voluntary-context-switches", USER, rvar,
150 ROFF(ru_nvcsw), LONG, "ld", 0},
151 {"nwchan", "NWCHAN", NULL, "wait-channel-address", LJUST, nwchan, 0,
153 {"oublk", "OUBLK", NULL, "written-blocks", USER, rvar,
154 ROFF(ru_oublock), LONG, "ld", 0},
155 {"oublock", "", "oublk", NULL, 0, NULL, 0, CHAR, NULL, 0},
156 {"paddr", "PADDR", NULL, "process-address", 0, kvar, KOFF(ki_paddr),
158 {"pagein", "PAGEIN", NULL, "pageins", USER, pagein, 0, CHAR, NULL, 0},
159 {"pcpu", "", "%cpu", NULL, 0, NULL, 0, CHAR, NULL, 0},
160 {"pending", "", "sig", NULL, 0, NULL, 0, CHAR, NULL, 0},
161 {"pgid", "PGID", NULL, "process-group", 0, kvar, KOFF(ki_pgid), UINT,
163 {"pid", "PID", NULL, "pid", 0, kvar, KOFF(ki_pid), UINT, PIDFMT, 0},
164 {"pmem", "", "%mem", NULL, 0, NULL, 0, CHAR, NULL, 0},
165 {"ppid", "PPID", NULL, "ppid", 0, kvar, KOFF(ki_ppid), UINT, PIDFMT, 0},
166 {"pri", "PRI", NULL, "priority", 0, pri, 0, CHAR, NULL, 0},
167 {"re", "RE", NULL, "residency-time", INF127, kvar, KOFF(ki_swtime),
169 {"rgid", "RGID", NULL, "real-gid", 0, kvar, KOFF(ki_rgid), UINT,
171 {"rgroup", "RGROUP", NULL, "real-group", LJUST, rgroupname, 0, CHAR,
173 {"rss", "RSS", NULL, "rss", 0, kvar, KOFF(ki_rssize), PGTOK, "ld", 0},
174 {"rtprio", "RTPRIO", NULL, "realtime-priority", 0, priorityr,
175 KOFF(ki_pri), CHAR, NULL, 0},
176 {"ruid", "RUID", NULL, "real-uid", 0, kvar, KOFF(ki_ruid), UINT,
178 {"ruser", "RUSER", NULL, "real-user", LJUST, runame, 0, CHAR, NULL, 0},
179 {"sid", "SID", NULL, "sid", 0, kvar, KOFF(ki_sid), UINT, PIDFMT, 0},
180 {"sig", "PENDING", NULL, "signals-pending", 0, kvar, KOFF(ki_siglist),
182 {"sigcatch", "CAUGHT", NULL, "signals-caught", 0, kvar,
183 KOFF(ki_sigcatch), UINT, "x", 0},
184 {"sigignore", "IGNORED", NULL, "signals-ignored", 0, kvar,
185 KOFF(ki_sigignore), UINT, "x", 0},
186 {"sigmask", "BLOCKED", NULL, "signal-mask", 0, kvar, KOFF(ki_sigmask),
188 {"sl", "SL", NULL, "sleep-time", INF127, kvar, KOFF(ki_slptime), UINT,
190 {"ssiz", "SSIZ", NULL, "stack-size", 0, kvar, KOFF(ki_ssize), PGTOK,
192 {"start", "STARTED", NULL, "start-time", LJUST|USER, started, 0, CHAR,
194 {"stat", "", "state", NULL, 0, NULL, 0, CHAR, NULL, 0},
195 {"state", "STAT", NULL, "state", LJUST, state, 0, CHAR, NULL, 0},
196 {"svgid", "SVGID", NULL, "saved-gid", 0, kvar, KOFF(ki_svgid), UINT,
198 {"svuid", "SVUID", NULL, "saved-uid", 0, kvar, KOFF(ki_svuid), UINT,
200 {"systime", "SYSTIME", NULL, "system-time", USER, systime, 0, CHAR,
202 {"tdaddr", "TDADDR", NULL, "thread-address", 0, kvar, KOFF(ki_tdaddr),
204 {"tdev", "TDEV", NULL, "terminal-device", 0, tdev, 0, CHAR, NULL, 0},
205 {"tdnam", "", "tdname", NULL, 0, NULL, 0, CHAR, NULL, 0},
206 {"tdname", "TDNAME", NULL, "thread-name", LJUST, tdnam, 0, CHAR,
208 {"tid", "", "lwp", NULL, 0, NULL, 0, CHAR, NULL, 0},
209 {"time", "TIME", NULL, "cpu-time", USER, cputime, 0, CHAR, NULL, 0},
210 {"tpgid", "TPGID", NULL, "terminal-process-gid", 0, kvar,
211 KOFF(ki_tpgid), UINT, PIDFMT, 0},
212 {"tracer", "TRACER", NULL, "tracer", 0, kvar, KOFF(ki_tracer), UINT,
214 {"tsid", "TSID", NULL, "terminal-sid", 0, kvar, KOFF(ki_tsid), UINT,
216 {"tsiz", "TSIZ", NULL, "text-size", 0, kvar, KOFF(ki_tsize), PGTOK,
218 {"tt", "TT ", NULL, "terminal-name", 0, tname, 0, CHAR, NULL, 0},
219 {"tty", "TTY", NULL, "tty", LJUST, longtname, 0, CHAR, NULL, 0},
220 {"ucomm", "UCOMM", NULL, "accounting-name", LJUST, ucomm, 0, CHAR,
222 {"uid", "UID", NULL, "uid", 0, kvar, KOFF(ki_uid), UINT, UIDFMT, 0},
223 {"upr", "UPR", NULL, "user-priority", 0, upr, 0, CHAR, NULL, 0},
224 {"uprocp", "UPROCP", NULL, "process-address", 0, kvar, KOFF(ki_paddr),
226 {"user", "USER", NULL, "user", LJUST, uname, 0, CHAR, NULL, 0},
227 {"usertime", "USERTIME", NULL, "user-time", USER, usertime, 0, CHAR,
229 {"usrpri", "", "upr", NULL, 0, NULL, 0, CHAR, NULL, 0},
230 {"vmaddr", "VMADDR", NULL, "vmspace-address", 0, kvar, KOFF(ki_vmspace),
232 {"vsize", "", "vsz", NULL, 0, NULL, 0, CHAR, NULL, 0},
233 {"vsz", "VSZ", NULL, "virtual-size", 0, vsize, 0, CHAR, NULL, 0},
234 {"wchan", "WCHAN", NULL, "wait-channel", LJUST, wchan, 0, CHAR, NULL,
236 {"xstat", "XSTAT", NULL, "exit-status", 0, kvar, KOFF(ki_xstat),
238 {"", NULL, NULL, NULL, 0, NULL, 0, CHAR, NULL, 0},
251 for (v = var; *(p = v->name); ++v) {
253 if (termwidth && (i += len + 1) > termwidth) {
257 xo_emit("{P:/%s}{l:key/%s}", sep, p);
261 xo_close_list("key");
266 parsefmt(const char *p, int user)
268 char *tempstr, *tempstr1;
270 #define FMTSEP " \t,\n"
271 tempstr1 = tempstr = strdup(p);
272 while (tempstr && *tempstr) {
278 * If an item contains an equals sign, it specifies a column
279 * header, may contain embedded separator characters and
280 * is always the last item.
282 if (tempstr[strcspn(tempstr, "="FMTSEP)] != '=')
283 while ((cp = strsep(&tempstr, FMTSEP)) != NULL &&
290 if (cp == NULL || !(v = findvar(cp, user, &hp)))
294 * If the user is NOT adding this field manually,
295 * get on with our lives if this VAR is already
296 * represented in the list.
298 vent = find_varentry(v);
302 if ((vent = malloc(sizeof(struct varent))) == NULL)
303 errx(1, "malloc failed");
304 vent->header = v->header;
310 vent->var = malloc(sizeof(*vent->var));
311 if (vent->var == NULL)
312 errx(1, "malloc failed");
313 memcpy(vent->var, v, sizeof(*vent->var));
314 STAILQ_INSERT_TAIL(&varlist, vent, next_ve);
317 if (STAILQ_EMPTY(&varlist)) {
318 warnx("no valid keywords; valid keywords:");
325 findvar(char *p, int user, char **header)
336 v = bsearch(&key, var, sizeof(var)/sizeof(VAR) - 1, sizeof(VAR), vcmp);
340 * If the user specified an alternate-header for this
341 * (aliased) format-name, then we need to copy that
342 * alternate-header when making the recursive call to
346 parsefmt(v->alias, user);
349 * XXX - This processing will not be correct for
350 * any alias which expands into a list of format
351 * keywords. Presently there are no aliases
354 rflen = strlen(v->alias) + strlen(hp) + 2;
355 realfmt = malloc(rflen);
357 errx(1, "malloc failed");
358 snprintf(realfmt, rflen, "%s=%s", v->alias, hp);
359 parsefmt(realfmt, user);
362 return ((VAR *)NULL);
365 warnx("%s: keyword not found", p);
374 vcmp(const void *a, const void *b)
376 return (strcmp(((const VAR *)a)->name, ((const VAR *)b)->name));