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