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