xref: /freebsd/bin/ps/keyword.c (revision ce834215a70ff69e7e222827437116eee2f9ac6f)
1 /*-
2  * Copyright (c) 1990, 1993, 1994
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	$Id: keyword.c,v 1.14 1997/03/04 00:33:56 ache Exp $
34  */
35 
36 #ifndef lint
37 static char const sccsid[] = "@(#)keyword.c	8.5 (Berkeley) 4/2/94";
38 #endif /* not lint */
39 
40 #include <sys/param.h>
41 #include <sys/time.h>
42 #include <sys/resource.h>
43 #include <sys/proc.h>
44 
45 #include <err.h>
46 #include <errno.h>
47 #include <stddef.h>
48 #include <stdio.h>
49 #include <stdlib.h>
50 #include <string.h>
51 #include <utmp.h>
52 
53 #include "ps.h"
54 
55 #ifdef P_PPWAIT
56 #define NEWVM
57 #endif
58 
59 #ifdef NEWVM
60 #include <sys/ucred.h>
61 #include <sys/user.h>
62 #include <sys/sysctl.h>
63 #endif
64 
65 static VAR *findvar __P((char *));
66 static int  vcmp __P((const void *, const void *));
67 
68 #ifdef NOTINUSE
69 int	utime(), stime(), ixrss(), idrss(), isrss();
70 	{{"utime"}, "UTIME", USER, utime, NULL, 4},
71 	{{"stime"}, "STIME", USER, stime, NULL, 4},
72 	{{"ixrss"}, "IXRSS", USER, ixrss, NULL, 4},
73 	{{"idrss"}, "IDRSS", USER, idrss, NULL, 4},
74 	{{"isrss"}, "ISRSS", USER, isrss, NULL, 4},
75 #endif
76 
77 /* Compute offset in common structures. */
78 #define	POFF(x)	offsetof(struct proc, x)
79 #define	EOFF(x)	offsetof(struct eproc, x)
80 #define	UOFF(x)	offsetof(struct usave, x)
81 #define	ROFF(x)	offsetof(struct rusage, x)
82 
83 #define	UIDFMT	"u"
84 #define	UIDLEN	5
85 #define	PIDFMT	"d"
86 #define	PIDLEN	5
87 #define USERLEN UT_NAMESIZE
88 
89 VAR var[] = {
90 #ifdef NEWVM
91 	{"%cpu", "%CPU", NULL, 0, pcpu, NULL, 4},
92 	{"%mem", "%MEM", NULL, 0, pmem, NULL, 4},
93 	{"acflag", "ACFLG",
94 		NULL, 0, pvar, NULL, 3, POFF(p_acflag), USHORT, "x"},
95 	{"acflg", "", "acflag"},
96 	{"blocked", "", "sigmask"},
97 	{"caught", "", "sigcatch"},
98 	{"command", "COMMAND", NULL, COMM|LJUST|USER, command, NULL, 16},
99 	{"cpu", "CPU", NULL, 0, pvar, NULL, 3, POFF(p_estcpu), ULONG, "d"},
100 	{"cputime", "", "time"},
101 	{"f", "F", NULL, 0, pvar, NULL, 7, POFF(p_flag), LONG, "x"},
102 	{"flags", "", "f"},
103 	{"ignored", "", "sigignore"},
104 	{"inblk", "INBLK",
105 		NULL, USER, rvar, NULL, 4, ROFF(ru_inblock), LONG, "d"},
106 	{"inblock", "", "inblk"},
107 	{"jobc", "JOBC", NULL, 0, evar, NULL, 4, EOFF(e_jobc), SHORT, "d"},
108 	{"ktrace", "KTRACE",
109 		NULL, 0, pvar, NULL, 8, POFF(p_traceflag), LONG, "x"},
110 	{"ktracep", "KTRACEP",
111 		NULL, 0, pvar, NULL, 8, POFF(p_tracep), LONG, "x"},
112 	{"lim", "LIM", NULL, 0, maxrss, NULL, 5},
113 	{"login", "LOGIN", NULL, LJUST, logname, NULL, MAXLOGNAME-1},
114 	{"logname", "", "login"},
115 	{"lstart", "STARTED", NULL, LJUST|USER, lstarted, NULL, 28},
116 	{"majflt", "MAJFLT",
117 		NULL, USER, rvar, NULL, 4, ROFF(ru_majflt), LONG, "d"},
118 	{"minflt", "MINFLT",
119 		NULL, USER, rvar, NULL, 4, ROFF(ru_minflt), LONG, "d"},
120 	{"msgrcv", "MSGRCV",
121 		NULL, USER, rvar, NULL, 4, ROFF(ru_msgrcv), LONG, "d"},
122 	{"msgsnd", "MSGSND",
123 		NULL, USER, rvar, NULL, 4, ROFF(ru_msgsnd), LONG, "d"},
124 	{"ni", "", "nice"},
125 	{"nice", "NI", NULL, 0, pvar, NULL, 2, POFF(p_nice), CHAR, "d"},
126 	{"nivcsw", "NIVCSW",
127 		NULL, USER, rvar, NULL, 5, ROFF(ru_nivcsw), LONG, "d"},
128 	{"nsignals", "", "nsigs"},
129 	{"nsigs", "NSIGS",
130 		NULL, USER, rvar, NULL, 4, ROFF(ru_nsignals), LONG, "d"},
131 	{"nswap", "NSWAP",
132 		NULL, USER, rvar, NULL, 4, ROFF(ru_nswap), LONG, "d"},
133 	{"nvcsw", "NVCSW",
134 		NULL, USER, rvar, NULL, 5, ROFF(ru_nvcsw), LONG, "d"},
135 	{"nwchan", "WCHAN", NULL, 0, pvar, NULL, 6, POFF(p_wchan), KPTR, "x"},
136 	{"oublk", "OUBLK",
137 		NULL, USER, rvar, NULL, 4, ROFF(ru_oublock), LONG, "d"},
138 	{"oublock", "", "oublk"},
139 	{"p_ru", "P_RU", NULL, 0, pvar, NULL, 6, POFF(p_ru), KPTR, "x"},
140 	{"paddr", "PADDR", NULL, 0, evar, NULL, 6, EOFF(e_paddr), KPTR, "x"},
141 	{"pagein", "PAGEIN", NULL, USER, pagein, NULL, 6},
142 	{"pcpu", "", "%cpu"},
143 	{"pending", "", "sig"},
144 	{"pgid", "PGID",
145 		NULL, 0, evar, NULL, PIDLEN, EOFF(e_pgid), ULONG, PIDFMT},
146 	{"pid", "PID", NULL, 0, pvar, NULL, PIDLEN, POFF(p_pid), LONG, PIDFMT},
147 	{"pmem", "", "%mem"},
148 	{"ppid", "PPID",
149 		NULL, 0, evar, NULL, PIDLEN, EOFF(e_ppid), LONG, PIDFMT},
150 	{"pri", "PRI", NULL, 0, pri, NULL, 3},
151 	{"re", "RE", NULL, 0, pvar, NULL, 3, POFF(p_swtime), ULONG, "d"},
152 	{"rgid", "RGID", NULL, 0, evar, NULL, UIDLEN, EOFF(e_pcred.p_rgid),
153 		ULONG, UIDFMT},
154 	{"rlink", "RLINK",
155 		NULL, 0, pvar, NULL, 8, POFF(p_procq.tqe_prev), KPTR, "x"},
156 	{"rss", "RSS", NULL, 0, p_rssize, NULL, 4},
157 	{"rssize", "", "rsz"},
158 	{"rsz", "RSZ", NULL, 0, rssize, NULL, 4},
159 	{"rtprio", "RTPRIO", NULL, 0, pvar, NULL, 7, POFF(p_rtprio), LONG, "d"},
160 	{"ruid", "RUID", NULL, 0, evar, NULL, UIDLEN, EOFF(e_pcred.p_ruid),
161 		ULONG, UIDFMT},
162 	{"ruser", "RUSER", NULL, LJUST|DSIZ, runame, s_runame, USERLEN},
163 	{"sess", "SESS", NULL, 0, evar, NULL, 6, EOFF(e_sess), KPTR, "x"},
164 	{"sig", "PENDING", NULL, 0, pvar, NULL, 8, POFF(p_siglist), LONG, "x"},
165 	{"sigcatch", "CAUGHT",
166 		NULL, 0, pvar, NULL, 8, POFF(p_sigcatch), LONG, "x"},
167 	{"sigignore", "IGNORED",
168 		NULL, 0, pvar, NULL, 8, POFF(p_sigignore), LONG, "x"},
169 	{"sigmask", "BLOCKED",
170 		NULL, 0, pvar, NULL, 8, POFF(p_sigmask), LONG, "x"},
171 	{"sl", "SL", NULL, 0, pvar, NULL, 3, POFF(p_slptime), ULONG, "d"},
172 	{"start", "STARTED", NULL, LJUST|USER, started, NULL, 7},
173 	{"stat", "", "state"},
174 	{"state", "STAT", NULL, 0, state, NULL, 4},
175 	{"svgid", "SVGID", NULL, 0,
176 		evar, NULL, UIDLEN, EOFF(e_pcred.p_svgid), ULONG, UIDFMT},
177 	{"svuid", "SVUID", NULL, 0,
178 		evar, NULL, UIDLEN, EOFF(e_pcred.p_svuid), ULONG, UIDFMT},
179 	{"tdev", "TDEV", NULL, 0, tdev, NULL, 4},
180 	{"time", "TIME", NULL, USER, cputime, NULL, 9},
181 	{"tpgid", "TPGID",
182 		NULL, 0, evar, NULL, 4, EOFF(e_tpgid), ULONG, PIDFMT},
183 	{"tsess", "TSESS", NULL, 0, evar, NULL, 6, EOFF(e_tsess), KPTR, "x"},
184 	{"tsiz", "TSIZ", NULL, 0, tsize, NULL, 4},
185 	{"tt", "TT ", NULL, 0, tname, NULL, 4},
186 	{"tty", "TTY", NULL, LJUST, longtname, NULL, 8},
187 	{"ucomm", "UCOMM", NULL, LJUST, ucomm, NULL, MAXCOMLEN},
188 	{"uid", "UID", NULL, 0, evar, NULL, UIDLEN, EOFF(e_ucred.cr_uid),
189 		ULONG, UIDFMT},
190 	{"upr", "UPR", NULL, 0, pvar, NULL, 3, POFF(p_usrpri), CHAR, "d"},
191 	{"user", "USER", NULL, LJUST|DSIZ, uname, s_uname, USERLEN},
192 	{"usrpri", "", "upr"},
193 	{"vsize", "", "vsz"},
194 	{"vsz", "VSZ", NULL, 0, vsize, NULL, 5},
195 	{"wchan", "WCHAN", NULL, LJUST, wchan, NULL, 6},
196 	{"xstat", "XSTAT", NULL, 0, pvar, NULL, 4, POFF(p_xstat), USHORT, "x"},
197 #else
198 	{"%cpu", "%CPU", NULL, 0, pcpu, NULL, 4},
199 	{"%mem", "%MEM", NULL, 0, pmem, NULL, 4},
200 	{"acflag", "ACFLG",
201 		NULL, USER, uvar, NULL, 3, UOFF(u_acflag), SHORT, "x"},
202 	{"acflg", "", "acflag"},
203 	{"blocked", "", "sigmask"},
204 	{"caught", "", "sigcatch"},
205 	{"command", "COMMAND", NULL, COMM|LJUST|USER, command, NULL, 16},
206 	{"cpu", "CPU", NULL, 0, pvar, NULL, 3, POFF(p_cpu), ULONG, "d"},
207 	{"cputime", "", "time"},
208 	{"f", "F", NULL, 0, pvar, NULL, 7, POFF(p_flag), LONG, "x"},
209 	{"flags", "", "f"},
210 	{"ignored", "", "sigignore"},
211 	{"inblk", "INBLK",
212 		NULL, USER, rvar, NULL, 4, ROFF(ru_inblock), LONG, "d"},
213 	{"inblock", "", "inblk"},
214 	{"jobc", "JOBC", NULL, 0, evar, NULL, 4, EOFF(e_jobc), SHORT, "d"},
215 	{"ktrace", "KTRACE",
216 		NULL, 0, pvar, NULL, 8, POFF(p_traceflag), LONG, "x"},
217 	{"ktracep", "KTRACEP",
218 		NULL, 0, pvar, NULL, 8, POFF(p_tracep), LONG, "x"},
219 	{"lim", "LIM", NULL, 0, maxrss, NULL, 5},
220 	{"logname", "LOGNAME", NULL, LJUST, logname, NULL, MAXLOGNAME-1},
221 	{"lstart", "STARTED", NULL, LJUST|USER, lstarted, NULL, 28},
222 	{"majflt", "MAJFLT",
223 		NULL, USER, rvar, NULL, 4, ROFF(ru_majflt), LONG, "d"},
224 	{"minflt", "MINFLT",
225 		NULL, USER, rvar, NULL, 4, ROFF(ru_minflt), LONG, "d"},
226 	{"msgrcv", "MSGRCV",
227 		NULL, USER, rvar, NULL, 4, ROFF(ru_msgrcv), LONG, "d"},
228 	{"msgsnd", "MSGSND",
229 		NULL, USER, rvar, NULL, 4, ROFF(ru_msgsnd), LONG, "d"},
230 	{"ni", "", "nice"},
231 	{"nice", "NI", NULL, 0, pvar, NULL, 2, POFF(p_nice), CHAR, "d"},
232 	{"nivcsw", "NIVCSW",
233 		NULL, USER, rvar, NULL, 5, ROFF(ru_nivcsw), LONG, "d"},
234 	{"nsignals", "", "nsigs"},
235 	{"nsigs", "NSIGS",
236 		NULL, USER, rvar, NULL, 4, ROFF(ru_nsignals), LONG, "d"},
237 	{"nswap", "NSWAP",
238 		NULL, USER, rvar, NULL, 4, ROFF(ru_nswap), LONG, "d"},
239 	{"nvcsw", "NVCSW",
240 		NULL, USER, rvar, NULL, 5, ROFF(ru_nvcsw), LONG, "d"},
241 	{"nwchan", "WCHAN", NULL, 0, pvar, NULL, 6, POFF(p_wchan), KPTR, "x"},
242 	{"oublk", "OUBLK",
243 		NULL, USER, rvar, NULL, 4, ROFF(ru_oublock), LONG, "d"},
244 	{"oublock", "", "oublk"},
245 	{"p_ru", "P_RU", NULL, 0, pvar, NULL, 6, POFF(p_ru), KPTR, "x"},
246 	{"paddr", "PADDR", NULL, 0, evar, NULL, 6, EOFF(e_paddr), KPTR, "x"},
247 	{"pagein", "PAGEIN", NULL, USER, pagein, NULL, 6},
248 	{"pcpu", "", "%cpu"},
249 	{"pending", "", "sig"},
250 	{"pgid", "PGID",
251 		NULL, 0, evar, NULL, PIDLEN, EOFF(e_pgid), ULONG, PIDFMT},
252 	{"pid", "PID", NULL, 0, pvar, NULL, PIDLEN, POFF(p_pid), LONG, PIDFMT},
253 	{"pmem", "", "%mem"},
254 	{"poip", "POIP", NULL, 0, pvar, NULL, 4, POFF(p_poip), SHORT, "d"},
255 	{"ppid", "PPID",
256 		NULL, 0, pvar, NULL, PIDLEN, POFF(p_ppid), LONG, PIDFMT},
257 	{"pri", "PRI", NULL, 0, pri, NULL, 3},
258 	{"re", "RE", NULL, 0, pvar, NULL, 3, POFF(p_swtime), ULONG, "d"},
259 	{"rgid", "RGID",
260 		NULL, 0, pvar, NULL, UIDLEN, POFF(p_rgid), USHORT, UIDFMT},
261 	{"rlink", "RLINK", NULL, 0, pvar, NULL, 8, POFF(p_rlink), KPTR, "x"},
262 	{"rss", "RSS", NULL, 0, p_rssize, NULL, 4},
263 	{"rssize", "", "rsz"},
264 	{"rsz", "RSZ", NULL, 0, rssize, NULL, 4},
265 	{"ruid", "RUID",
266 		NULL, 0, pvar, NULL, UIDLEN, POFF(p_ruid), USHORT, UIDFMT},
267 	{"rtprio", "RTPRIO", NULL, 0, pvar, NULL, 7, POFF(p_rtprio), LONG, "d"},
268 	{"ruser", "RUSER", NULL, LJUST|DSIZ, runame, s_runame, USERLEN},
269 	{"sess", "SESS", NULL, 0, evar, NULL, 6, EOFF(e_sess), KPTR, "x"},
270 	{"sig", "PENDING", NULL, 0, pvar, NULL, 8, POFF(p_sig), LONG, "x"},
271 	{"sigcatch", "CAUGHT",
272 		NULL, 0, pvar, NULL, 8, POFF(p_sigcatch), LONG, "x"},
273 	{"sigignore", "IGNORED",
274 		NULL, 0, pvar, NULL, 8, POFF(p_sigignore), LONG, "x"},
275 	{"sigmask", "BLOCKED",
276 		NULL, 0, pvar, NULL, 8, POFF(p_sigmask), LONG, "x"},
277 	{"sl", "SL", NULL, 0, pvar, NULL, 3, POFF(p_slptime), ULONG, "d"},
278 	{"start", "STARTED", NULL, LJUST|USER, started, NULL, 7},
279 	{"stat", "", "state"},
280 	{"state", "STAT", NULL, 0, state, NULL, 4},
281 	{"svgid", "SVGID",
282 		NULL, 0, pvar, NULL, UIDLEN, POFF(p_svgid), USHORT, UIDFMT},
283 	{"svuid", "SVUID",
284 		NULL, 0, pvar, NULL, UIDLEN, POFF(p_svuid), USHORT, UIDFMT},
285 	{"tdev", "TDEV", NULL, 0, tdev, NULL, 4},
286 	{"time", "TIME", NULL, USER, cputime, NULL, 9},
287 	{"tpgid", "TPGID",
288 		NULL, 0, evar, NULL, 4, EOFF(e_tpgid), ULONG, PIDFMT},
289 	{"trs", "TRS", NULL, 0, trss, NULL, 3},
290 	{"tsess", "TSESS", NULL, 0, evar, NULL, 6, EOFF(e_tsess), KPTR, "x"},
291 	{"tsiz", "TSIZ", NULL, 0, tsize, NULL, 4},
292 	{"tt", "TT", NULL, LJUST, tname, NULL, 4},
293 	{"tty", "TTY", NULL, LJUST, longtname, NULL, 8},
294 	{"ucomm", "UCOMM", NULL, LJUST, ucomm, NULL, MAXCOMLEN},
295 	{"uid", "UID", NULL, 0, pvar, NULL, UIDLEN, POFF(p_uid),USHORT, UIDFMT},
296 	{"upr", "UPR", NULL, 0, pvar, NULL, 3, POFF(p_usrpri), CHAR, "d"},
297 	{"uprocp", "UPROCP",
298 		NULL, USER, uvar, NULL, 6, UOFF(u_procp), KPTR, "x"},
299 	{"user", "USER", NULL, LJUST|DSIZ, uname, s_uname, USERLEN},
300 	{"usrpri", "", "upr"},
301 	{"vsize", "", "vsz"},
302 	{"vsz", "VSZ", NULL, 0, vsize, NULL, 5},
303 	{"wchan", "WCHAN", NULL, LJUST, wchan, NULL, 6},
304 	{"xstat", "XSTAT", NULL, 0, pvar, NULL, 4, POFF(p_xstat), USHORT, "x"},
305 #endif
306 	{""},
307 };
308 
309 void
310 showkey()
311 {
312 	VAR *v;
313 	int i;
314 	char *p, *sep;
315 
316 	i = 0;
317 	sep = "";
318 	for (v = var; *(p = v->name); ++v) {
319 		int len = strlen(p);
320 		if (termwidth && (i += len + 1) > termwidth) {
321 			i = len;
322 			sep = "\n";
323 		}
324 		(void) printf("%s%s", sep, p);
325 		sep = " ";
326 	}
327 	(void) printf("\n");
328 }
329 
330 void
331 parsefmt(p)
332 	char *p;
333 {
334 	static struct varent *vtail;
335 
336 #define	FMTSEP	" \t,\n"
337 	while (p && *p) {
338 		char *cp;
339 		VAR *v;
340 		struct varent *vent;
341 
342 		while ((cp = strsep(&p, FMTSEP)) != NULL && *cp == '\0')
343 			/* void */;
344 		if (!(v = findvar(cp)))
345 			continue;
346 		if ((vent = malloc(sizeof(struct varent))) == NULL)
347 			err(1, NULL);
348 		vent->var = v;
349 		vent->next = NULL;
350 		if (vhead == NULL)
351 			vhead = vtail = vent;
352 		else {
353 			vtail->next = vent;
354 			vtail = vent;
355 		}
356 	}
357 	if (!vhead)
358 		errx(1, "no valid keywords");
359 }
360 
361 static VAR *
362 findvar(p)
363 	char *p;
364 {
365 	VAR *v, key;
366 	char *hp;
367 	int vcmp();
368 
369 	key.name = p;
370 
371 	hp = strchr(p, '=');
372 	if (hp)
373 		*hp++ = '\0';
374 
375 	key.name = p;
376 	v = bsearch(&key, var, sizeof(var)/sizeof(VAR) - 1, sizeof(VAR), vcmp);
377 
378 	if (v && v->alias) {
379 		if (hp) {
380 			warnx("%s: illegal keyword specification", p);
381 			eval = 1;
382 		}
383 		parsefmt(v->alias);
384 		return ((VAR *)NULL);
385 	}
386 	if (!v) {
387 		warnx("%s: keyword not found", p);
388 		eval = 1;
389 	}
390 	if (hp)
391 		v->header = hp;
392 	return (v);
393 }
394 
395 static int
396 vcmp(a, b)
397         const void *a, *b;
398 {
399         return (strcmp(((VAR *)a)->name, ((VAR *)b)->name));
400 }
401