xref: /openbsd-src/bin/ps/keyword.c (revision a28daedfc357b214be5c701aa8ba8adb29a7f1c2)
1 /*	$OpenBSD: keyword.c,v 1.28 2008/03/08 19:20:12 millert Exp $	*/
2 /*	$NetBSD: keyword.c,v 1.12.6.1 1996/05/30 21:25:13 cgd Exp $	*/
3 
4 /*-
5  * Copyright (c) 1990, 1993, 1994
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 #ifndef lint
34 #if 0
35 static char sccsid[] = "@(#)keyword.c	8.5 (Berkeley) 4/2/94";
36 #else
37 static char rcsid[] = "$OpenBSD: keyword.c,v 1.28 2008/03/08 19:20:12 millert Exp $";
38 #endif
39 #endif /* not lint */
40 
41 #include <sys/param.h>
42 #include <sys/time.h>
43 #include <sys/resource.h>
44 #include <sys/proc.h>
45 
46 #include <err.h>
47 #include <errno.h>
48 #include <stddef.h>
49 #include <stdio.h>
50 #include <stdlib.h>
51 #include <string.h>
52 
53 #include "ps.h"
54 
55 #include <sys/ucred.h>
56 #include <sys/sysctl.h>
57 
58 static VAR *findvar(char *);
59 static int  vcmp(const void *, const void *);
60 
61 #ifdef NOTINUSE
62 int	utime(), stime(), ixrss(), idrss(), isrss();
63 	{{"utime"}, "UTIME", USER, utime, 4},
64 	{{"stime"}, "STIME", USER, stime, 4},
65 	{{"ixrss"}, "IXRSS", USER, ixrss, 4},
66 	{{"idrss"}, "IDRSS", USER, idrss, 4},
67 	{{"isrss"}, "ISRSS", USER, isrss, 4},
68 #endif
69 
70 /* Compute offset in common structures. */
71 #define	POFF(x)	offsetof(struct kinfo_proc2, x)
72 
73 #define	UIDFMT	"u"
74 #define	UIDLEN	5
75 #define	UID(n1, n2, fn, off) \
76 	{ n1, n2, NULL, 0, fn, UIDLEN, 0, off, UINT32, UIDFMT }
77 #define	GID(n1, n2, fn, off)	UID(n1, n2, fn, off)
78 
79 #define	PIDFMT	"d"
80 #define	PIDLEN	5
81 #define	PID(n1, n2, fn, off) \
82 	{ n1, n2, NULL, 0, fn, PIDLEN, 0, off, INT32, PIDFMT }
83 
84 #define	USERLEN	8
85 
86 /* Bit types must match their respective entries in struct kinfo_proc2 */
87 VAR var[] = {
88 	{"%cpu", "%CPU", NULL, NLIST, pcpu, 4},
89 	{"%mem", "%MEM", NULL, NLIST, pmem, 4},
90 	{"acflag", "ACFLG", NULL, 0, pvar, 3, 0, POFF(p_acflag), UINT16, "x"},
91 	{"acflg", "", "acflag"},
92 	{"args", "", "command"},
93 	{"blocked", "", "sigmask"},
94 	{"caught", "", "sigcatch"},
95 	{"comm", "", "ucomm"},
96 	{"command", "COMMAND", NULL, COMM|LJUST|USER, command, 16},
97 	{"cpu", "CPU", NULL, 0, pvar, 3, 0, POFF(p_estcpu), UINT32, "d"},
98 	{"cpuid", "CPUID", NULL, 0, pvar, 8, 0, POFF(p_cpuid), UINT64, "lld"},
99 	{"cputime", "", "time"},
100 	{"dsiz", "DSIZ", NULL, 0, dsize, 4},
101 	{"emul", "EMUL", NULL, LJUST, emulname, EMULNAMELEN},
102 	{"etime", "", "start"},
103 	{"f", "F", NULL, 0, pvar, 7, 0, POFF(p_flag), INT32, "x"},
104 	{"flags", "", "f"},
105 	GID("gid", "GID", pvar, POFF(p_gid)),
106 	{"group", "GROUP", NULL, LJUST, gname, USERLEN},
107 	{"ignored", "", "sigignore"},
108 	{"inblk", "INBLK", NULL, USER, pvar, 4, 0, POFF(p_uru_inblock), UINT64, "lld"},
109 	{"inblock", "", "inblk"},
110 	{"jobc", "JOBC", NULL, 0, pvar, 4, 0, POFF(p_jobc), INT16, "d"},
111 	{"ktrace", "KTRACE", NULL, 0, pvar, 8, 0, POFF(p_traceflag), INT32, "x"},
112 	/* XXX */
113 	{"ktracep", "KTRACEP", NULL, 0, pvar, 8, 0, POFF(p_tracep), UINT64, "llx"},
114 	{"lim", "LIM", NULL, 0, maxrss, 5},
115 	{"login", "LOGIN", NULL, LJUST, logname, MAXLOGNAME},
116 	{"logname", "", "login"},
117 	{"lstart", "STARTED", NULL, LJUST|USER, lstarted, 28},
118 	{"majflt", "MAJFLT", NULL, USER, pvar, 4, 0, POFF(p_uru_majflt), UINT64, "lld"},
119 	{"minflt", "MINFLT", NULL, USER, pvar, 4, 0, POFF(p_uru_minflt), UINT64, "lld"},
120 	{"msgrcv", "MSGRCV", NULL, USER, pvar, 4, 0, POFF(p_uru_msgrcv), UINT64, "lld"},
121 	{"msgsnd", "MSGSND", NULL, USER, pvar, 4, 0, POFF(p_uru_msgsnd), UINT64, "lld"},
122 	{"ni", "", "nice"},
123 	{"nice", "NI", NULL, 0, pnice, 3},
124 	{"nivcsw", "NIVCSW", NULL, USER, pvar, 5, 0, POFF(p_uru_nivcsw), UINT64, "lld"},
125 	{"nsignals", "", "nsigs"},
126 	{"nsigs", "NSIGS", NULL, USER, pvar, 4, 0, POFF(p_uru_nsignals), UINT64, "lld"},
127 	{"nswap", "NSWAP", NULL, USER, pvar, 4, 0, POFF(p_uru_nswap), UINT64, "lld"},
128 	{"nvcsw", "NVCSW", NULL, USER, pvar, 5, 0, POFF(p_uru_nvcsw), UINT64, "lld"},
129 	/* XXX */
130 	{"nwchan", "WCHAN", NULL, 0, pvar, 7, 0, POFF(p_wchan), UINT64, "llx"},
131 	{"oublk", "OUBLK", NULL, USER, pvar, 4, 0, POFF(p_uru_oublock), UINT64, "lld"},
132 	{"oublock", "", "oublk"},
133 	/* XXX */
134 	{"p_ru", "P_RU", NULL, 0, pvar, 6, 0, POFF(p_ru), UINT64, "llx"},
135 	/* XXX */
136 	{"paddr", "PADDR", NULL, 0, pvar, 6, 0, POFF(p_paddr), UINT64, "llx"},
137 	{"pagein", "PAGEIN", NULL, USER, pagein, 6},
138 	{"pcpu", "", "%cpu"},
139 	{"pending", "", "sig"},
140 	PID("pgid", "PGID", pvar, POFF(p__pgid)),
141 	PID("pid", "PID", pvar, POFF(p_pid)),
142 	{"pmem", "", "%mem"},
143 	PID("ppid", "PPID", pvar, POFF(p_ppid)),
144 	{"pri", "PRI", NULL, 0, pri, 3},
145 	{"re", "RE", NULL, INF127, pvar, 3, 0, POFF(p_swtime), UINT32, "u"},
146 	GID("rgid", "RGID", pvar, POFF(p_rgid)),
147 	/* XXX */
148 	{"rgroup", "RGROUP", NULL, LJUST, rgname, USERLEN},
149 	{"rlink", "RLINK", NULL, 0, pvar, 8, 0, POFF(p_back), UINT64, "llx"},
150 	{"rss", "RSS", NULL, 0, p_rssize, 5},
151 	{"rssize", "", "rsz"},
152 	{"rsz", "RSZ", NULL, 0, rssize, 4},
153 	UID("ruid", "RUID", pvar, POFF(p_ruid)),
154 	{"ruser", "RUSER", NULL, LJUST, runame, USERLEN},
155 	{"sess", "SESS", NULL, 0, pvar, PTRWIDTH, 0, POFF(p_sess), UINT64, "llx"},
156 	{"sig", "PENDING", NULL, 0, pvar, 8, 0, POFF(p_siglist), INT32, "x"},
157 	{"sigcatch", "CAUGHT", NULL, 0, pvar, 8, 0, POFF(p_sigcatch), UINT32, "x"},
158 	{"sigignore", "IGNORED",
159 		NULL, 0, pvar, 8, 0, POFF(p_sigignore), UINT32, "x"},
160 	{"sigmask", "BLOCKED", NULL, 0, pvar, 8, 0, POFF(p_sigmask), UINT32, "x"},
161 	{"sl", "SL", NULL, INF127, pvar, 3, 0, POFF(p_slptime), UINT32, "u"},
162 	{"ssiz", "SSIZ", NULL, 0, ssize, 4},
163 	{"start", "STARTED", NULL, LJUST|USER, started, 8},
164 	{"stat", "", "state"},
165 	{"state", "STAT", NULL, LJUST|NLIST, state, 5},
166 	GID("svgid", "SVGID", pvar, POFF(p_svgid)),
167 	UID("svuid", "SVUID", pvar, POFF(p_svuid)),
168 	{"tdev", "TDEV", NULL, 0, tdev, 4},
169 	{"time", "TIME", NULL, USER, cputime, 9},
170 	PID("tpgid", "TPGID", pvar, POFF(p_tpgid)),
171 	{"tsess", "TSESS", NULL, 0, pvar, PTRWIDTH, 0, POFF(p_tsess), UINT64, "llx"},
172 	{"tsiz", "TSIZ", NULL, 0, tsize, 4},
173 	{"tt", "TT", NULL, LJUST, tname, 3},
174 	{"tty", "TTY", NULL, LJUST, longtname, 8},
175 	{"ucomm", "UCOMM", NULL, LJUST, ucomm, MAXCOMLEN},
176 	UID("uid", "UID", pvar, POFF(p_uid)),
177 	{"upr", "UPR", NULL, 0, pvar, 3, 0, POFF(p_usrpri), UINT8, "d"},
178 	{"user", "USER", NULL, LJUST, euname, USERLEN},
179 	{"usrpri", "", "upr"},
180 	{"vsize", "", "vsz"},
181 	{"vsz", "VSZ", NULL, 0, vsize, 5},
182 	{"wchan", "WCHAN", NULL, LJUST, wchan, 7},
183 	{"xstat", "XSTAT", NULL, 0, pvar, 4, 0, POFF(p_xstat), UINT16, "x"},
184 	{""},
185 };
186 
187 void
188 showkey(void)
189 {
190 	VAR *v;
191 	int i;
192 	char *p, *sep;
193 
194 	i = 0;
195 	sep = "";
196 	for (v = var; *(p = v->name); ++v) {
197 		int len = strlen(p);
198 		if (termwidth && (i += len + 1) > termwidth) {
199 			i = len;
200 			sep = "\n";
201 		}
202 		(void) printf("%s%s", sep, p);
203 		sep = " ";
204 	}
205 	(void) printf("\n");
206 }
207 
208 void
209 parsefmt(char *p)
210 {
211 	static struct varent *vtail;
212 
213 #define	FMTSEP	" \t,\n"
214 	while (p && *p) {
215 		char *cp;
216 		VAR *v;
217 		struct varent *vent;
218 
219 		while ((cp = strsep(&p, FMTSEP)) != NULL && *cp == '\0')
220 			/* void */;
221 		if (!cp)
222 			break;
223 		if (!(v = findvar(cp)) || v->parsed == 1)
224 			continue;
225 		v->parsed = 1;
226 		if ((vent = malloc(sizeof(struct varent))) == NULL)
227 			err(1, NULL);
228 		vent->var = v;
229 		vent->next = NULL;
230 		if (vhead == NULL)
231 			vhead = vtail = vent;
232 		else {
233 			vtail->next = vent;
234 			vtail = vent;
235 		}
236 	}
237 	if (!vhead)
238 		errx(1, "no valid keywords");
239 }
240 
241 static VAR *
242 findvar(char *p)
243 {
244 	VAR *v, key;
245 	char *hp;
246 	int vcmp(const void *, const void *);
247 
248 	key.name = p;
249 
250 	hp = strchr(p, '=');
251 	if (hp)
252 		*hp++ = '\0';
253 
254 	key.name = p;
255 	v = bsearch(&key, var, sizeof(var)/sizeof(VAR) - 1, sizeof(VAR), vcmp);
256 
257 	if (v && v->alias) {
258 		if (hp) {
259 			warnx("%s: illegal keyword specification", p);
260 			eval = 1;
261 		}
262 		parsefmt(v->alias);
263 		return (NULL);
264 	}
265 	if (!v) {
266 		warnx("%s: keyword not found", p);
267 		eval = 1;
268 		return (NULL);
269 	}
270 	if (hp)
271 		v->header = hp;
272 	return (v);
273 }
274 
275 static int
276 vcmp(const void *a, const void *b)
277 {
278 	return (strcmp(((VAR *)a)->name, ((VAR *)b)->name));
279 }
280