xref: /dragonfly/bin/ps/keyword.c (revision 7b0266d8)
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  * @(#)keyword.c	8.5 (Berkeley) 4/2/94
34  * $FreeBSD: src/bin/ps/keyword.c,v 1.24.2.3 2002/10/10 20:05:32 jmallett Exp $
35  * $DragonFly: src/bin/ps/keyword.c,v 1.13 2004/11/14 13:58:42 eirikn Exp $
36  */
37 
38 #include <sys/param.h>
39 #include <sys/time.h>
40 #include <sys/resource.h>
41 #include <sys/sysctl.h>
42 #include <sys/ucred.h>
43 #include <sys/user.h>
44 
45 #include <err.h>
46 #include <errno.h>
47 #include <stddef.h>
48 #include <stdio.h>
49 #include <stdlib.h>
50 #include <string.h>
51 #include <utmp.h>
52 
53 #include "ps.h"
54 
55 static VAR *findvar (char *);
56 static int  vcmp (const void *, const void *);
57 
58 #ifdef NOTINUSE
59 int	utime(), stime(), ixrss(), idrss(), isrss();
60 	{{"utime"}, "UTIME", USER, utime, NULL, 4},
61 	{{"stime"}, "STIME", USER, stime, NULL, 4},
62 	{{"ixrss"}, "IXRSS", USER, ixrss, NULL, 4},
63 	{{"idrss"}, "IDRSS", USER, idrss, NULL, 4},
64 	{{"isrss"}, "ISRSS", USER, isrss, NULL, 4},
65 #endif
66 
67 /* Compute offset in common structures. */
68 #define	POFF(x)	offsetof(struct proc, x)
69 #define	TOFF(x)	offsetof(struct thread, x)
70 #define	EOFF(x)	offsetof(struct eproc, x)
71 #define	UOFF(x)	offsetof(struct usave, x)
72 #define	ROFF(x)	offsetof(struct rusage, x)
73 
74 #define	UIDFMT	"u"
75 #define	UIDLEN	5
76 #define	PIDFMT	"d"
77 #define	PIDLEN	5
78 #define USERLEN UT_NAMESIZE
79 
80 const VAR var[] = {
81 	{"%cpu", "%CPU", NULL, 0, pcpu, NULL, 4, 0, 0, NULL, NULL, 0},
82 	{"%mem", "%MEM", NULL, 0, pmem, NULL, 4, 0, 0, NULL, NULL, 0},
83 	{"acflag", "ACFLG", NULL, 0, pvar, NULL, 3, POFF(p_acflag), USHORT, "x",
84 		NULL, 0},
85 	{"acflg", "", "acflag", 0, NULL, NULL, 0, 0, 0, NULL, NULL, 0},
86 	{"blocked", "", "sigmask", 0, NULL, NULL, 0, 0, 0, NULL, NULL, 0},
87 	{"caught", "", "sigcatch", 0, NULL, NULL, 0, 0, 0, NULL, NULL, 0},
88 	{"command", "COMMAND", NULL, COMM|LJUST|USER, command, NULL, 16, 0, 0, NULL,
89 		NULL, 0},
90 	{"cpu", "CPU", NULL, 0, pvar, NULL, 3, POFF(p_estcpu), UINT, "d", NULL, 0},
91 	{"lastcpu", "C", NULL, 0, pvar, NULL, 3, EOFF(e_cpuid), UINT, "d", NULL, 0},
92 	{"cputime", "", "time", 0, NULL, NULL, 0, 0, 0, NULL, NULL, 0},
93 	{"f", "F", NULL, 0, pvar, NULL, 7, POFF(p_flag), INT, "x", NULL, 0},
94 	{"flags", "", "f", 0, NULL, NULL, 0, 0, 0, NULL, NULL, 0},
95 	{"iac", "IAC",  NULL, 0, pvar, NULL, 4, POFF(p_interactive), CHAR, PIDFMT,
96 		NULL, 0},
97 	{"ignored", "", "sigignore", 0, NULL, NULL, 0, 0, 0, NULL, NULL, 0},
98 	{"inblk", "INBLK", NULL, USER, rvar, NULL, 4, ROFF(ru_inblock), LONG, "ld",
99 		NULL, 0},
100 	{"inblock", "", "inblk", 0, NULL, NULL, 0, 0, 0, NULL, NULL, 0},
101 	{"jobc", "JOBC", NULL, 0, evar, NULL, 4, EOFF(e_jobc), SHORT, "d", NULL, 0},
102 	{"ktrace", "KTRACE", NULL, 0, pvar, NULL, 8, POFF(p_traceflag), INT, "x",
103 		NULL, 0},
104 	{"ktracep", "KTRACEP", NULL, 0, pvar, NULL, 8, POFF(p_tracep), LONG, "lx",
105 		NULL, 0},
106 	{"lim", "LIM", NULL, 0, maxrss, NULL, 5, 0, 0, NULL, NULL, 0},
107 	{"login", "LOGIN", NULL, LJUST, logname, NULL, MAXLOGNAME-1, 0, 0, NULL,
108 		NULL, 0},
109 	{"logname", "", "login", 0, NULL, NULL, 0, 0, 0, NULL, NULL, 0},
110 	{"lstart", "STARTED", NULL, LJUST|USER, lstarted, NULL, 28, 0, 0, NULL, NULL,
111 		0},
112 	{"majflt", "MAJFLT", NULL, USER, rvar, NULL, 4, ROFF(ru_majflt), LONG, "ld",
113 		NULL, 0},
114 	{"minflt", "MINFLT", NULL, USER, rvar, NULL, 4, ROFF(ru_minflt), LONG, "ld",
115 		NULL, 0},
116 	{"msgrcv", "MSGRCV", NULL, USER, rvar, NULL, 4, ROFF(ru_msgrcv), LONG, "ld",
117 		NULL, 0},
118 	{"msgsnd", "MSGSND", NULL, USER, rvar, NULL, 4, ROFF(ru_msgsnd), LONG, "ld",
119 		NULL, 0},
120 	{"ni", "", "nice", 0, NULL, NULL, 0, 0, 0, NULL, NULL, 0},
121 	{"nice", "NI", NULL, 0, pnice, NULL, 3, 0, 0, NULL, NULL, 0},
122 	{"nivcsw", "NIVCSW", NULL, USER, rvar, NULL, 5, ROFF(ru_nivcsw), LONG, "ld",
123 		NULL, 0},
124 	{"nsignals", "", "nsigs", 0, NULL, NULL, 0, 0, 0, NULL, NULL, 0},
125 	{"nsigs", "NSIGS", NULL, USER, rvar, NULL, 4, ROFF(ru_nsignals), LONG, "ld",
126 		NULL, 0},
127 	{"nswap", "NSWAP", NULL, USER, rvar, NULL, 4, ROFF(ru_nswap), LONG, "ld",
128 		NULL, 0},
129 	{"nvcsw", "NVCSW", NULL, USER, rvar, NULL, 5, ROFF(ru_nvcsw), LONG, "ld",
130 		NULL, 0},
131 	{"nwchan", "WCHAN", NULL, 0, tvar, NULL, 8, TOFF(td_wchan), KPTR, "lx", NULL,
132 		0},
133 	{"oublk", "OUBLK", NULL, USER, rvar, NULL, 4, ROFF(ru_oublock), LONG, "ld",
134 		NULL, 0},
135 	{"oublock", "", "oublk", 0, NULL, NULL, 0, 0 ,0, NULL, NULL, 0},
136 	{"p_ru", "P_RU", NULL, 0, pvar, NULL, 6, POFF(p_ru), KPTR, "lx", NULL, 0},
137 	{"paddr", "PADDR", NULL, 0, evar, NULL, 8, EOFF(e_paddr), KPTR, "lx", NULL,
138 		0},
139 	{"pagein", "PAGEIN", NULL, USER, pagein, NULL, 6, 0, 0, NULL, NULL, 0},
140 	{"pcpu", "", "%cpu", 0, NULL, NULL, 0, 0,0, NULL, NULL, 0},
141 	{"pending", "", "sig", 0, NULL, NULL, 0, 0, 0, NULL, NULL, 0},
142 	{"pgid", "PGID", NULL, 0, evar, NULL, PIDLEN, EOFF(e_pgid), UINT, PIDFMT,
143 		NULL, 0},
144 	{"pid", "PID", NULL, 0, pvar, NULL, PIDLEN, POFF(p_pid), UINT, PIDFMT,
145 		NULL, 0},
146 	{"pmem", "", "%mem", 0, NULL, NULL, 0, 0, 0, NULL, NULL, 0},
147 	{"ppid", "PPID", NULL, 0, evar, NULL, PIDLEN, EOFF(e_ppid), UINT, PIDFMT,
148 		NULL, 0},
149 	{"pri", "PRI", NULL, 0, pri, NULL, 3, 0, 0, NULL, NULL, 0},
150 	{"re", "RE", NULL, 0, pvar, NULL, 3, POFF(p_swtime), UINT, "d", NULL, 0},
151 	{"rgid", "RGID", NULL, 0, evar, NULL, UIDLEN, EOFF(e_ucred.cr_rgid),
152 		UINT, UIDFMT, NULL, 0},
153 	{"rlink", "RLINK", NULL, 0, pvar, NULL, 8, POFF(p_procq.tqe_prev), KPTR, "lx",
154 		NULL, 0},
155 	{"rss", "RSS", NULL, 0, p_rssize, NULL, 4, 0, 0, NULL, NULL, 0},
156 	{"rssize", "", "rsz", 0, NULL, NULL, 0, 0, 0, NULL, NULL, 0},
157 	{"rsz", "RSZ", NULL, 0, rssize, NULL, 4, 0, 0, NULL, NULL, 0},
158 	{"rtprio", "RTPRIO", NULL, 0, rtprior, NULL, 7, POFF(p_rtprio), 0, NULL, NULL,
159 		0},
160 	{"ruid", "RUID", NULL, 0, evar, NULL, UIDLEN, EOFF(e_ucred.cr_ruid),
161 		UINT, UIDFMT, NULL, 0},
162 	{"ruser", "RUSER", NULL, LJUST|DSIZ, runame, s_runame, USERLEN, 0, 0, NULL,
163 		NULL, 0},
164 	{"sess", "SESS", NULL, 0, evar, NULL, 6, EOFF(e_sess), KPTR, "lx", NULL, 0},
165 	{"sig", "PENDING", NULL, 0, pvar, NULL, 8, POFF(p_siglist), INT, "x", NULL,
166 		0},
167 	{"sigcatch", "CAUGHT", NULL, 0, evar, NULL, 8, EOFF(e_procsig.ps_sigcatch),
168 		UINT, "x", NULL, 0},
169 	{"sigignore", "IGNORED", NULL, 0, evar, NULL, 8, EOFF(e_procsig.ps_sigignore),
170 		UINT, "x", NULL, 0},
171 	{"sigmask", "BLOCKED", NULL, 0, pvar, NULL, 8, POFF(p_sigmask), UINT, "x",
172 		NULL, 0},
173 	{"sl", "SL", NULL, 0, pvar, NULL, 3, POFF(p_slptime), UINT, "d", NULL, 0},
174 	{"start", "STARTED", NULL, LJUST|USER, started, NULL, 7, 0, 0, NULL, NULL, 0},
175 	{"stat", "", "state", 0, NULL, NULL, 0, 0, 0, NULL, NULL, 0},
176 	{"state", "STAT", NULL, 0, state, NULL, 4, 0, 0, NULL, NULL, 0},
177 	{"svgid", "SVGID", NULL, 0, evar, NULL, UIDLEN, EOFF(e_ucred.cr_svgid), UINT,
178 		UIDFMT, NULL, 0},
179 	{"svuid", "SVUID", NULL, 0, evar, NULL, UIDLEN, EOFF(e_ucred.cr_svuid), UINT,
180 		UIDFMT, NULL, 0},
181 	{"tdev", "TDEV", NULL, 0, tdev, NULL, 4, 0, 0, NULL, NULL, 0},
182 	{"time", "TIME", NULL, USER, cputime, NULL, 9, 0, 0, NULL, NULL, 0},
183 	{"tpgid", "TPGID", NULL, 0, evar, NULL, 4, EOFF(e_tpgid), UINT, PIDFMT, NULL,
184 		0},
185 	{"tsess", "TSESS", NULL, 0, evar, NULL, 6, EOFF(e_tsess), KPTR, "lx", NULL, 0},
186 	{"tsiz", "TSIZ", NULL, 0, tsize, NULL, 4, 0, 0, NULL, NULL, 0},
187 	{"tt", "TT ", NULL, 0, tname, NULL, 4, 0, 0, NULL, NULL, 0},
188 	{"tty", "TTY", NULL, LJUST, longtname, NULL, 8, 0, 0, NULL, NULL, 0},
189 	{"ucomm", "UCOMM", NULL, LJUST, ucomm, NULL, MAXCOMLEN, 0, 0, NULL, NULL, 0},
190 	{"uid", "UID", NULL, 0, evar, NULL, UIDLEN, EOFF(e_ucred.cr_uid),
191 		UINT, UIDFMT, NULL, 0},
192 	{"user", "USER", NULL, LJUST|DSIZ, uname, s_uname, USERLEN, 0, 0, NULL, NULL,
193 		0},
194 	{"vsize", "", "vsz", 0, 0, NULL, 0, 0, 0, NULL, NULL, 0},
195 	{"vsz", "VSZ", NULL, 0, vsize, NULL, 5, 0, 0, NULL, NULL, 0},
196 	{"wchan", "WCHAN", NULL, LJUST, wchan, NULL, 6, 0, 0, NULL, NULL, 0},
197 	{"xstat", "XSTAT", NULL, 0, pvar, NULL, 4, POFF(p_xstat), USHORT, "x", NULL,
198 		0},
199 	{"", NULL, NULL, 0, NULL, NULL, 0, 0, 0, NULL, NULL, 0},
200 };
201 
202 void
203 showkey(void)
204 {
205 	const VAR *v;
206 	int i;
207 	const char *p, *sep;
208 
209 	i = 0;
210 	sep = "";
211 	for (v = var; *(p = v->name); ++v) {
212 		int len = strlen(p);
213 		if (termwidth && (i += len + 1) > termwidth) {
214 			i = len;
215 			sep = "\n";
216 		}
217 		printf("%s%s", sep, p);
218 		sep = " ";
219 	}
220 	printf("\n");
221 }
222 
223 void
224 parsefmt(const char *fmt)
225 {
226 	static struct varent *vtail;
227 	char *p, *op;
228 
229 	op = p = strdup(fmt);
230 
231 	if (p == NULL)
232 		errx(1, "Not enough memory");
233 
234 #define	FMTSEP	" \t,\n"
235 	while (p && *p) {
236 		char *cp;
237 		VAR *v;
238 		struct varent *vent;
239 
240 		while ((cp = strsep(&p, FMTSEP)) != NULL && *cp == '\0')
241 			/* void */;
242 		if (cp == NULL || !(v = findvar(cp)))
243 			continue;
244 		if ((vent = malloc(sizeof(struct varent))) == NULL)
245 			err(1, NULL);
246 		vent->var = v;
247 		vent->next = NULL;
248 		if (vhead == NULL)
249 			vhead = vtail = vent;
250 		else {
251 			vtail->next = vent;
252 			vtail = vent;
253 		}
254 	}
255 	if (!vhead) {
256 		warnx("no valid keywords; valid keywords:");
257 		showkey();
258 		exit(1);
259 	}
260 
261 	free(op);
262 }
263 
264 static VAR *
265 findvar(char *p)
266 {
267 	VAR *v, key;
268 	char *hp;
269 
270 	hp = strchr(p, '=');
271 	if (hp)
272 		*hp++ = '\0';
273 
274 	key.name = p;
275 	v = bsearch(&key, var, sizeof(var)/sizeof(VAR) - 1, sizeof(VAR), vcmp);
276 
277 	if (v && v->alias) {
278 		if (hp) {
279 			warnx("%s: illegal keyword specification", p);
280 			eval = 1;
281 		}
282 		parsefmt(v->alias);
283 		return ((VAR *)NULL);
284 	}
285 	if (!v) {
286 		warnx("%s: keyword not found", p);
287 		eval = 1;
288 	} else if (hp)
289 		v->header = hp;
290 	return (v);
291 }
292 
293 static int
294 vcmp(const void *a, const void *b)
295 {
296         return (strcmp(((const VAR *)a)->name, ((const VAR *)b)->name));
297 }
298