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