xref: /freebsd/bin/ps/keyword.c (revision 09e8dea79366f1e5b3a73e8a271b26e4b6bf2e6a)
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 
34 #include <sys/cdefs.h>
35 
36 __FBSDID("$FreeBSD$");
37 
38 #if 0
39 #ifndef lint
40 static char sccsid[] = "@(#)keyword.c	8.5 (Berkeley) 4/2/94";
41 #endif /* not lint */
42 #endif
43 
44 #include <sys/param.h>
45 #include <sys/time.h>
46 #include <sys/resource.h>
47 #include <sys/proc.h>
48 #include <sys/sysctl.h>
49 #include <sys/user.h>
50 
51 #include <err.h>
52 #include <stddef.h>
53 #include <stdio.h>
54 #include <stdlib.h>
55 #include <string.h>
56 #include <utmp.h>
57 
58 #include "ps.h"
59 
60 static VAR *findvar(char *);
61 static int  vcmp(const void *, const void *);
62 
63 #ifdef NOTINUSE
64 int	utime(), stime(), ixrss(), idrss(), isrss();
65 	{{"utime"}, "UTIME", USER, utime, NULL, 4},
66 	{{"stime"}, "STIME", USER, stime, NULL, 4},
67 	{{"ixrss"}, "IXRSS", USER, ixrss, NULL, 4},
68 	{{"idrss"}, "IDRSS", USER, idrss, NULL, 4},
69 	{{"isrss"}, "ISRSS", USER, isrss, NULL, 4},
70 #endif
71 
72 /* Compute offset in common structures. */
73 #define	KOFF(x)	offsetof(struct kinfo_proc, x)
74 #define	ROFF(x)	offsetof(struct rusage, x)
75 
76 #define	UIDFMT	"u"
77 #define	UIDLEN	5
78 #define	PIDFMT	"d"
79 #define	PIDLEN	5
80 #define USERLEN UT_NAMESIZE
81 
82 static VAR var[] = {
83 	{"%cpu", "%CPU", NULL, 0, pcpu, NULL, 4, 0, CHAR, NULL, 0},
84 	{"%mem", "%MEM", NULL, 0, pmem, NULL, 4, 0, CHAR, NULL, 0},
85 	{"acflag", "ACFLG", NULL, 0, kvar, NULL, 3, KOFF(ki_acflag), USHORT,
86 		"x", 0},
87 	{"acflg", "", "acflag", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
88 	{"args", "COMMAND", NULL, COMM|LJUST|USER, arguments, NULL, 16, 0,
89 		CHAR, NULL, 0},
90 	{"blocked", "", "sigmask", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
91 	{"caught", "", "sigcatch", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
92 	{"comm", "COMMAND", NULL, LJUST, ucomm, NULL, MAXCOMLEN, 0, CHAR,
93 		NULL, 0},
94 	{"command", "COMMAND", NULL, COMM|LJUST|USER, command, NULL, 16, 0,
95 		CHAR, NULL, 0},
96 	{"cpu", "CPU", NULL, 0, kvar, NULL, 3, KOFF(ki_estcpu), UINT, "d",
97 		0},
98 	{"cputime", "", "time", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
99 	{"etime", "ELAPSED", NULL, USER, elapsed, NULL, 9, 0, CHAR, NULL, 0},
100 	{"f", "F", NULL, 0, kvar, NULL, 7, KOFF(ki_flag), INT, "x", 0},
101 	{"flags", "", "f", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
102 	{"ignored", "", "sigignore", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
103 	{"inblk", "INBLK", NULL, USER, rvar, NULL, 4, ROFF(ru_inblock), LONG,
104 		"ld", 0},
105 	{"inblock", "", "inblk", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
106 	{"jobc", "JOBC", NULL, 0, kvar, NULL, 4, KOFF(ki_jobc), SHORT, "d",
107 		0},
108 	{"ktrace", "KTRACE", NULL, 0, kvar, NULL, 8, KOFF(ki_traceflag), INT,
109 		"x", 0},
110 	{"lim", "LIM", NULL, 0, maxrss, NULL, 5, 0, CHAR, NULL, 0},
111 	{"login", "LOGIN", NULL, LJUST, logname, NULL, MAXLOGNAME-1, 0, CHAR,
112 		NULL, 0},
113 	{"logname", "", "login", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
114 	{"lstart", "STARTED", NULL, LJUST|USER, lstarted, NULL, 28, 0, CHAR,
115 		NULL, 0},
116 	{"lvl", "LVL", NULL, LJUST, lattr, NULL, 3, 0, CHAR, NULL, 0},
117 	{"majflt", "MAJFLT", NULL, USER, rvar, NULL, 4, ROFF(ru_majflt),
118 		LONG, "ld", 0},
119 	{"minflt", "MINFLT", NULL, USER, rvar, NULL, 4, ROFF(ru_minflt),
120 		LONG, "ld", 0},
121 	{"msgrcv", "MSGRCV", NULL, USER, rvar, NULL, 4, ROFF(ru_msgrcv),
122 		LONG, "ld", 0},
123 	{"msgsnd", "MSGSND", NULL, USER, rvar, NULL, 4, ROFF(ru_msgsnd),
124 		LONG, "ld", 0},
125 	{"mtxname", "MUTEX", NULL, LJUST, mtxname, NULL, 6, 0, CHAR, NULL,
126 		0},
127 	{"mwchan", "MWCHAN", NULL, LJUST, mwchan, NULL, 6, 0, CHAR, NULL, 0},
128 	{"ni", "", "nice", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
129 	{"nice", "NI", NULL, 0, kvar, NULL, 2, KOFF(ki_nice), CHAR, "d",
130 		0},
131 	{"nivcsw", "NIVCSW", NULL, USER, rvar, NULL, 5, ROFF(ru_nivcsw),
132 		LONG, "ld", 0},
133 	{"nsignals", "", "nsigs", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
134 	{"nsigs", "NSIGS", NULL, USER, rvar, NULL, 4, ROFF(ru_nsignals),
135 		LONG, "ld", 0},
136 	{"nswap", "NSWAP", NULL, USER, rvar, NULL, 4, ROFF(ru_nswap),
137 		LONG, "ld", 0},
138 	{"nvcsw", "NVCSW", NULL, USER, rvar, NULL, 5, ROFF(ru_nvcsw),
139 		LONG, "ld", 0},
140 	{"oublk", "OUBLK", NULL, USER, rvar, NULL, 4, ROFF(ru_oublock),
141 		LONG, "ld", 0},
142 	{"oublock", "", "oublk", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
143 	{"paddr", "PADDR", NULL, 0, kvar, NULL, 8, KOFF(ki_paddr), KPTR,
144 		"lx", 0},
145 	{"pagein", "PAGEIN", NULL, USER, pagein, NULL, 6, 0, CHAR, NULL, 0},
146 	{"pcpu", "", "%cpu", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
147 	{"pending", "", "sig", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
148 	{"pgid", "PGID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_pgid), UINT,
149 		PIDFMT, 0},
150 	{"pid", "PID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_pid), UINT,
151 		PIDFMT, 0},
152 	{"pmem", "", "%mem", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
153 	{"ppid", "PPID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_ppid), UINT,
154 		PIDFMT, 0},
155 	{"pri", "PRI", NULL, 0, pri, NULL, 3, 0, CHAR, NULL, 0},
156 	{"re", "RE", NULL, 0, kvar, NULL, 3, KOFF(ki_swtime), UINT, "d",
157 		0},
158 	{"rgid", "RGID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_rgid),
159 		UINT, UIDFMT, 0},
160 	{"rgroup", "RGROUP", NULL, LJUST|DSIZ, rgroupname, s_rgroupname,
161 		USERLEN, 0, CHAR, NULL, 0},
162 	{"rss", "RSS", NULL, 0, kvar, NULL, 4, KOFF(ki_rssize), UINT, "d",
163 		0},
164 	{"rtprio", "RTPRIO", NULL, 0, priorityr, NULL, 7, KOFF(ki_pri), CHAR,
165 		NULL, 0},
166 	{"ruid", "RUID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_ruid),
167 		UINT, UIDFMT, 0},
168 	{"ruser", "RUSER", NULL, LJUST|DSIZ, runame, s_runame, USERLEN,
169 		0, CHAR, NULL, 0},
170 	{"sid", "SID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_sid), UINT,
171 		PIDFMT, 0},
172 	{"sig", "PENDING", NULL, 0, kvar, NULL, 8, KOFF(ki_siglist), INT,
173 		"x", 0},
174 	{"sigcatch", "CAUGHT", NULL, 0, kvar, NULL, 8, KOFF(ki_sigcatch),
175 		UINT, "x", 0},
176 	{"sigignore", "IGNORED", NULL, 0, kvar, NULL, 8, KOFF(ki_sigignore),
177 		UINT, "x", 0},
178 	{"sigmask", "BLOCKED", NULL, 0, kvar, NULL, 8, KOFF(ki_sigmask),
179 		UINT, "x", 0},
180 	{"sl", "SL", NULL, 0, kvar, NULL, 3, KOFF(ki_slptime), UINT, "d",
181 		0},
182 	{"start", "STARTED", NULL, LJUST|USER, started, NULL, 7, 0, CHAR, NULL,
183 		0},
184 	{"stat", "", "state", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
185 	{"state", "STAT", NULL, 0, state, NULL, 4, 0, CHAR, NULL, 0},
186 	{"svgid", "SVGID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_svgid),
187 		UINT, UIDFMT, 0},
188 	{"svuid", "SVUID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_svuid),
189 		UINT, UIDFMT, 0},
190 	{"tdev", "TDEV", NULL, 0, tdev, NULL, 4, 0, CHAR, NULL, 0},
191 	{"time", "TIME", NULL, USER, cputime, NULL, 9, 0, CHAR, NULL, 0},
192 	{"tpgid", "TPGID", NULL, 0, kvar, NULL, 4, KOFF(ki_tpgid), UINT,
193 		PIDFMT, 0},
194 	{"tsid", "TSID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_tsid), UINT,
195 		PIDFMT, 0},
196 	{"tsiz", "TSIZ", NULL, 0, tsize, NULL, 4, 0, CHAR, NULL, 0},
197 	{"tt", "TT ", NULL, 0, tname, NULL, 4, 0, CHAR, NULL, 0},
198 	{"tty", "TTY", NULL, LJUST, longtname, NULL, 8, 0, CHAR, NULL, 0},
199 	{"ucomm", "UCOMM", NULL, LJUST, ucomm, NULL, MAXCOMLEN, 0, CHAR, NULL,
200 		0},
201 	{"uid", "UID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_uid), UINT,
202 		UIDFMT, 0},
203 	{"upr", "UPR", NULL, 0, kvar, NULL, 3, KOFF(ki_pri.pri_user), UCHAR,
204 		"d", 0},
205 	{"user", "USER", NULL, LJUST|DSIZ, uname, s_uname, USERLEN, 0, CHAR,
206 		NULL, 0},
207 	{"usrpri", "", "upr", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
208 	{"vsize", "", "vsz", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
209 	{"vsz", "VSZ", NULL, 0, vsize, NULL, 5, 0, CHAR, NULL, 0},
210 	{"wchan", "WCHAN", NULL, LJUST, wchan, NULL, 6, 0, CHAR, NULL, 0},
211 	{"xstat", "XSTAT", NULL, 0, kvar, NULL, 4, KOFF(ki_xstat), USHORT,
212 		"x", 0},
213 	{"", NULL, NULL, 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
214 };
215 
216 void
217 showkey(void)
218 {
219 	VAR *v;
220 	int i;
221 	const char *p, *sep;
222 
223 	i = 0;
224 	sep = "";
225 	for (v = var; *(p = v->name); ++v) {
226 		int len = strlen(p);
227 		if (termwidth && (i += len + 1) > termwidth) {
228 			i = len;
229 			sep = "\n";
230 		}
231 		(void) printf("%s%s", sep, p);
232 		sep = " ";
233 	}
234 	(void) printf("\n");
235 }
236 
237 void
238 parsefmt(const char *p)
239 {
240 	static struct varent *vtail;
241 	char *tempstr, *tempstr1;
242 
243 #define		FMTSEP	" \t,\n"
244 	tempstr1 = tempstr = strdup(p);
245 	while (tempstr && *tempstr) {
246 		char *cp;
247 		VAR *v;
248 		struct varent *vent;
249 
250 		/*
251 		 * If an item contains an equals sign, it specifies a column
252 		 * header, may contain embedded separator characters and
253 		 * is always the last item.
254 		 */
255 		if (tempstr[strcspn(tempstr, "="FMTSEP)] != '=')
256 			while ((cp = strsep(&tempstr, FMTSEP)) != NULL &&
257 			    *cp == '\0')
258 				/* void */;
259 		else {
260 			cp = tempstr;
261 			tempstr = NULL;
262 		}
263 		if (cp == NULL || !(v = findvar(cp)))
264 			continue;
265 		if ((vent = malloc(sizeof(struct varent))) == NULL)
266 			errx(1, "malloc failed");
267 		vent->var = malloc(sizeof(*vent->var));
268 		if (vent->var == NULL)
269 			errx(1, "malloc failed");
270 		memcpy(vent->var, v, sizeof(*vent->var));
271 		vent->next = NULL;
272 		if (vhead == NULL)
273 			vhead = vtail = vent;
274 		else {
275 			vtail->next = vent;
276 			vtail = vent;
277 		}
278 	}
279 	free(tempstr1);
280 	if (!vhead)
281 		errx(1, "no valid keywords");
282 }
283 
284 static VAR *
285 findvar(char *p)
286 {
287 	VAR *v, key;
288 	char *hp;
289 
290 	hp = strchr(p, '=');
291 	if (hp)
292 		*hp++ = '\0';
293 
294 	key.name = p;
295 	v = bsearch(&key, var, sizeof(var)/sizeof(VAR) - 1, sizeof(VAR), vcmp);
296 
297 	if (v && v->alias) {
298 		if (hp) {
299 			warnx("%s: illegal keyword specification", p);
300 			eval = 1;
301 		}
302 		parsefmt(v->alias);
303 		return ((VAR *)NULL);
304 	}
305 	if (!v) {
306 		warnx("%s: keyword not found", p);
307 		eval = 1;
308 	} else if (hp)
309 		v->header = strdup(hp);
310 	return (v);
311 }
312 
313 static int
314 vcmp(const void *a, const void *b)
315 {
316         return (strcmp(((const VAR *)a)->name, ((const VAR *)b)->name));
317 }
318