xref: /freebsd/bin/ps/keyword.c (revision ee2ea5ceafed78a5bd9810beb9e3ca927180c226)
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 	{"blocked", "", "sigmask", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
89 	{"caught", "", "sigcatch", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
90 	{"command", "COMMAND", NULL, COMM|LJUST|USER, command, NULL, 16,
91 		0, CHAR, NULL, 0},
92 	{"cpu", "CPU", NULL, 0, kvar, NULL, 3, KOFF(ki_estcpu), UINT, "d",
93 		0},
94 	{"cputime", "", "time", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
95 	{"f", "F", NULL, 0, kvar, NULL, 7, KOFF(ki_flag), INT, "x", 0},
96 	{"flags", "", "f", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
97 	{"ignored", "", "sigignore", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
98 	{"inblk", "INBLK", NULL, USER, rvar, NULL, 4, ROFF(ru_inblock), LONG,
99 		"ld", 0},
100 	{"inblock", "", "inblk", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
101 	{"jobc", "JOBC", NULL, 0, kvar, NULL, 4, KOFF(ki_jobc), SHORT, "d",
102 		0},
103 	{"ktrace", "KTRACE", NULL, 0, kvar, NULL, 8, KOFF(ki_traceflag), INT,
104 		"x", 0},
105 	{"lim", "LIM", NULL, 0, maxrss, NULL, 5, 0, CHAR, NULL, 0},
106 	{"login", "LOGIN", NULL, LJUST, logname, NULL, MAXLOGNAME-1, 0, CHAR,
107 		NULL, 0},
108 	{"logname", "", "login", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
109 	{"lstart", "STARTED", NULL, LJUST|USER, lstarted, NULL, 28, 0, CHAR,
110 		NULL, 0},
111 	{"lvl", "LVL", NULL, LJUST, lattr, NULL, 3, 0, CHAR, NULL, 0},
112 	{"majflt", "MAJFLT", NULL, USER, rvar, NULL, 4, ROFF(ru_majflt),
113 		LONG, "ld", 0},
114 	{"minflt", "MINFLT", NULL, USER, rvar, NULL, 4, ROFF(ru_minflt),
115 		LONG, "ld", 0},
116 	{"msgrcv", "MSGRCV", NULL, USER, rvar, NULL, 4, ROFF(ru_msgrcv),
117 		LONG, "ld", 0},
118 	{"msgsnd", "MSGSND", NULL, USER, rvar, NULL, 4, ROFF(ru_msgsnd),
119 		LONG, "ld", 0},
120 	{"mtxname", "MUTEX", NULL, LJUST, mtxname, NULL, 6, 0, CHAR, NULL,
121 		0},
122 	{"mwchan", "MWCHAN", NULL, LJUST, mwchan, NULL, 6, 0, CHAR, NULL, 0},
123 	{"ni", "", "nice", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
124 	{"nice", "NI", NULL, 0, kvar, NULL, 2, KOFF(ki_nice), CHAR, "d",
125 		0},
126 	{"nivcsw", "NIVCSW", NULL, USER, rvar, NULL, 5, ROFF(ru_nivcsw),
127 		LONG, "ld", 0},
128 	{"nsignals", "", "nsigs", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
129 	{"nsigs", "NSIGS", NULL, USER, rvar, NULL, 4, ROFF(ru_nsignals),
130 		LONG, "ld", 0},
131 	{"nswap", "NSWAP", NULL, USER, rvar, NULL, 4, ROFF(ru_nswap),
132 		LONG, "ld", 0},
133 	{"nvcsw", "NVCSW", NULL, USER, rvar, NULL, 5, ROFF(ru_nvcsw),
134 		LONG, "ld", 0},
135 	{"oublk", "OUBLK", NULL, USER, rvar, NULL, 4, ROFF(ru_oublock),
136 		LONG, "ld", 0},
137 	{"oublock", "", "oublk", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
138 	{"paddr", "PADDR", NULL, 0, kvar, NULL, 8, KOFF(ki_paddr), KPTR,
139 		"lx", 0},
140 	{"pagein", "PAGEIN", NULL, USER, pagein, NULL, 6, 0, CHAR, NULL, 0},
141 	{"pcpu", "", "%cpu", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
142 	{"pending", "", "sig", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
143 	{"pgid", "PGID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_pgid), UINT,
144 		PIDFMT, 0},
145 	{"pid", "PID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_pid), UINT,
146 		PIDFMT, 0},
147 	{"pmem", "", "%mem", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
148 	{"ppid", "PPID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_ppid), UINT,
149 		PIDFMT, 0},
150 	{"pri", "PRI", NULL, 0, pri, NULL, 3, 0, CHAR, NULL, 0},
151 	{"re", "RE", NULL, 0, kvar, NULL, 3, KOFF(ki_swtime), UINT, "d",
152 		0},
153 	{"rgid", "RGID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_rgid),
154 		UINT, UIDFMT, 0},
155 	{"rss", "RSS", NULL, 0, kvar, NULL, 4, KOFF(ki_rssize), UINT, "d",
156 		0},
157 	{"rtprio", "RTPRIO", NULL, 0, priorityr, NULL, 7, KOFF(ki_pri), CHAR,
158 		NULL, 0},
159 	{"ruid", "RUID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_ruid),
160 		UINT, UIDFMT, 0},
161 	{"ruser", "RUSER", NULL, LJUST|DSIZ, runame, s_runame, USERLEN,
162 		0, CHAR, NULL, 0},
163 	{"sid", "SID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_sid), UINT,
164 		PIDFMT, 0},
165 	{"sig", "PENDING", NULL, 0, kvar, NULL, 8, KOFF(ki_siglist), INT,
166 		"x", 0},
167 	{"sigcatch", "CAUGHT", NULL, 0, kvar, NULL, 8, KOFF(ki_sigcatch),
168 		UINT, "x", 0},
169 	{"sigignore", "IGNORED", NULL, 0, kvar, NULL, 8, KOFF(ki_sigignore),
170 		UINT, "x", 0},
171 	{"sigmask", "BLOCKED", NULL, 0, kvar, NULL, 8, KOFF(ki_sigmask),
172 		UINT, "x", 0},
173 	{"sl", "SL", NULL, 0, kvar, NULL, 3, KOFF(ki_slptime), UINT, "d",
174 		0},
175 	{"start", "STARTED", NULL, LJUST|USER, started, NULL, 7, 0, CHAR, NULL,
176 		0},
177 	{"stat", "", "state", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
178 	{"state", "STAT", NULL, 0, state, NULL, 4, 0, CHAR, NULL, 0},
179 	{"svgid", "SVGID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_svgid),
180 		UINT, UIDFMT, 0},
181 	{"svuid", "SVUID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_svuid),
182 		UINT, UIDFMT, 0},
183 	{"tdev", "TDEV", NULL, 0, tdev, NULL, 4, 0, CHAR, NULL, 0},
184 	{"time", "TIME", NULL, USER, cputime, NULL, 9, 0, CHAR, NULL, 0},
185 	{"tpgid", "TPGID", NULL, 0, kvar, NULL, 4, KOFF(ki_tpgid), UINT,
186 		PIDFMT, 0},
187 	{"tsid", "TSID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_tsid), UINT,
188 		PIDFMT, 0},
189 	{"tsiz", "TSIZ", NULL, 0, tsize, NULL, 4, 0, CHAR, NULL, 0},
190 	{"tt", "TT ", NULL, 0, tname, NULL, 4, 0, CHAR, NULL, 0},
191 	{"tty", "TTY", NULL, LJUST, longtname, NULL, 8, 0, CHAR, NULL, 0},
192 	{"ucomm", "UCOMM", NULL, LJUST, ucomm, NULL, MAXCOMLEN, 0, CHAR, NULL,
193 		0},
194 	{"uid", "UID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_uid), UINT,
195 		UIDFMT, 0},
196 	{"upr", "UPR", NULL, 0, kvar, NULL, 3, KOFF(ki_pri.pri_user), UCHAR,
197 		"d", 0},
198 	{"user", "USER", NULL, LJUST|DSIZ, uname, s_uname, USERLEN, 0, CHAR,
199 		NULL, 0},
200 	{"usrpri", "", "upr", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
201 	{"vsize", "", "vsz", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
202 	{"vsz", "VSZ", NULL, 0, vsize, NULL, 5, 0, CHAR, NULL, 0},
203 	{"wchan", "WCHAN", NULL, LJUST, wchan, NULL, 6, 0, CHAR, NULL, 0},
204 	{"xstat", "XSTAT", NULL, 0, kvar, NULL, 4, KOFF(ki_xstat), USHORT,
205 		"x", 0},
206 	{"", NULL, NULL, 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
207 };
208 
209 void
210 showkey(void)
211 {
212 	VAR *v;
213 	int i;
214 	const char *p, *sep;
215 
216 	i = 0;
217 	sep = "";
218 	for (v = var; *(p = v->name); ++v) {
219 		int len = strlen(p);
220 		if (termwidth && (i += len + 1) > termwidth) {
221 			i = len;
222 			sep = "\n";
223 		}
224 		(void) printf("%s%s", sep, p);
225 		sep = " ";
226 	}
227 	(void) printf("\n");
228 }
229 
230 void
231 parsefmt(const char *p)
232 {
233 	static struct varent *vtail;
234 	char *tempstr, *tempstr1;
235 
236 #define	FMTSEP	" \t,\n"
237 	tempstr1 = tempstr = strdup(p);
238 	while (tempstr && *tempstr) {
239 		char *cp;
240 		VAR *v;
241 		struct varent *vent;
242 
243 		while ((cp = strsep(&tempstr, FMTSEP)) != NULL && *cp == '\0')
244 			/* void */;
245 		if (cp == NULL || !(v = findvar(cp)))
246 			continue;
247 		if ((vent = malloc(sizeof(struct varent))) == NULL)
248 			err(1, NULL);
249 		vent->var = v;
250 		vent->next = NULL;
251 		if (vhead == NULL)
252 			vhead = vtail = vent;
253 		else {
254 			vtail->next = vent;
255 			vtail = vent;
256 		}
257 	}
258 	free(tempstr1);
259 	if (!vhead)
260 		errx(1, "no valid keywords");
261 }
262 
263 static VAR *
264 findvar(char *p)
265 {
266 	VAR *v, key;
267 	char *hp;
268 
269 	hp = strchr(p, '=');
270 	if (hp)
271 		*hp++ = '\0';
272 
273 	key.name = p;
274 	v = bsearch(&key, var, sizeof(var)/sizeof(VAR) - 1, sizeof(VAR), vcmp);
275 
276 	if (v && v->alias) {
277 		if (hp) {
278 			warnx("%s: illegal keyword specification", p);
279 			eval = 1;
280 		}
281 		parsefmt(v->alias);
282 		return ((VAR *)NULL);
283 	}
284 	if (!v) {
285 		warnx("%s: keyword not found", p);
286 		eval = 1;
287 	} else if (hp)
288 		v->header = hp;
289 	return (v);
290 }
291 
292 static int
293 vcmp(const void *a, const void *b)
294 {
295         return (strcmp(((const VAR *)a)->name, ((const VAR *)b)->name));
296 }
297