xref: /dragonfly/bin/ps/keyword.c (revision 19380330)
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.30 2007/11/25 18:10:06 swildner Exp $
36  */
37 
38 #include <sys/user.h>
39 #include <sys/kinfo.h>
40 #include <sys/param.h>
41 #include <sys/time.h>
42 #include <sys/queue.h>
43 #include <sys/resource.h>
44 #include <sys/sysctl.h>
45 #include <sys/ucred.h>
46 
47 #include <err.h>
48 #include <errno.h>
49 #include <stddef.h>
50 #include <stdio.h>
51 #include <stdlib.h>
52 #include <string.h>
53 #include <utmp.h>
54 
55 #include "ps.h"
56 
57 static struct varent	*makevarent(const char *);
58 static int		 vcmp(const void *, const void *);
59 
60 struct varent_head var_head = STAILQ_HEAD_INITIALIZER(var_head);
61 
62 #ifdef NOTINUSE
63 int	utime(), stime(), ixrss(), idrss(), isrss();
64 	{{"utime"}, "UTIME", USER, utime, NULL, 4},
65 	{{"stime"}, "STIME", USER, stime, NULL, 4},
66 	{{"ixrss"}, "IXRSS", USER, ixrss, NULL, 4},
67 	{{"idrss"}, "IDRSS", USER, idrss, NULL, 4},
68 	{{"isrss"}, "ISRSS", USER, isrss, NULL, 4},
69 #endif
70 
71 /* Compute offset in common structures. */
72 #define	POFF(x)	offsetof(struct kinfo_proc, kp_##x)
73 #define	LPOFF(x) offsetof(struct kinfo_lwp, kl_##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 const VAR var[] = {
83 	{"%cpu", "%CPU", NULL, 0, pcpu, NULL, 4, 0, 0, NULL, NULL},
84 	{"%mem", "%MEM", NULL, 0, pmem, NULL, 4, 0, 0, NULL, NULL},
85 	{"acflag", "ACFLG", NULL, 0, pvar, NULL, 3, POFF(acflag), USHORT, "x",
86 		NULL},
87 	{"acflg", "", "acflag", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
88 	{"batch", "BAT", NULL, 0, lpest, NULL, 3, LPOFF(origcpu), UINT, "d", NULL},
89 	{"blocked", "", "sigmask", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
90 	{"caught", "", "sigcatch", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
91 	{"comm", "", "ucomm", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
92 	{"command", "COMMAND", NULL, COMM|LJUST|USER, command, NULL, 16, 0, 0, NULL,
93 		NULL},
94 	{"cpu", "CPU", NULL, 0, lpest, NULL, 3, LPOFF(estcpu), UINT, "d", NULL},
95 	{"cputime", "", "time", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
96 	{"f", "F", NULL, 0, pvar, NULL, 7, POFF(flags), INT, "x", NULL},
97 	{"flags", "", "f", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
98 #if 0
99 	{"iac", "IAC",  NULL, 0, pvar, NULL, 4, POFF(p_usdata.bsd4.interactive), CHAR, PIDFMT,
100 		NULL},
101 #endif
102 	{"ignored", "", "sigignore", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
103 	{"inblk", "INBLK", NULL, USER, rvar, NULL, 4, ROFF(ru_inblock), LONG, "ld",
104 		NULL},
105 	{"inblock", "", "inblk", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
106 	{"jail", "JAIL", NULL, 0, pvar, NULL, 3, POFF(jailid), INT, "d", NULL},
107 	{"jobc", "JOBC", NULL, 0, pvar, NULL, 4, POFF(jobc), SHORT, "d", NULL},
108 	{"ktrace", "KTRACE", NULL, 0, pvar, NULL, 8, POFF(traceflag), INT, "x",
109 		NULL},
110 #if 0
111 	{"ktracep", "KTRACEP", NULL, 0, pvar, NULL, 8, POFF(p_tracenode), LONG, "lx",
112 		NULL},
113 #endif
114 	{"lastcpu", "C", NULL, 0, lpvar, NULL, 3, LPOFF(cpuid), UINT, "d", NULL},
115 	{"lim", "LIM", NULL, 0, maxrss, NULL, 5, 0, 0, NULL, NULL},
116 	{"login", "LOGIN", NULL, LJUST, logname, NULL, MAXLOGNAME-1, 0, 0, NULL,
117 		NULL},
118 	{"logname", "", "login", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
119 	{"lstart", "STARTED", NULL, LJUST|USER, lstarted, NULL, 28, 0, 0, NULL, NULL},
120 	{"majflt", "MAJFLT", NULL, USER, rvar, NULL, 4, ROFF(ru_majflt), LONG, "ld",
121 		NULL},
122 	{"minflt", "MINFLT", NULL, USER, rvar, NULL, 4, ROFF(ru_minflt), LONG, "ld",
123 		NULL},
124 	{"msgrcv", "MSGRCV", NULL, USER, rvar, NULL, 4, ROFF(ru_msgrcv), LONG, "ld",
125 		NULL},
126 	{"msgsnd", "MSGSND", NULL, USER, rvar, NULL, 4, ROFF(ru_msgsnd), LONG, "ld",
127 		NULL},
128 	{"ni", "", "nice", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
129 	{"nice", "NI", NULL, 0, pnice, NULL, 3, 0, 0, NULL, NULL},
130 	{"nivcsw", "NIVCSW", NULL, USER, rvar, NULL, 5, ROFF(ru_nivcsw), LONG, "ld",
131 		NULL},
132 	{"nlwp", "NLWP", NULL, 0, pvar, NULL, 4, POFF(nthreads), INT, "d",
133 		NULL},
134 	{"nsignals", "", "nsigs", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
135 	{"nsigs", "NSIGS", NULL, USER, rvar, NULL, 4, ROFF(ru_nsignals), LONG, "ld",
136 		NULL},
137 	{"nswap", "NSWAP", NULL, USER, rvar, NULL, 4, ROFF(ru_nswap), LONG, "ld",
138 		NULL},
139 	{"nvcsw", "NVCSW", NULL, USER, rvar, NULL, 5, ROFF(ru_nvcsw), LONG, "ld",
140 		NULL},
141 	{"nwchan", "WCHAN", NULL, 0, lpvar, NULL, 8, LPOFF(wchan), KPTR, "lx", NULL},
142 	{"oublk", "OUBLK", NULL, USER, rvar, NULL, 4, ROFF(ru_oublock), LONG, "ld",
143 		NULL},
144 	{"oublock", "", "oublk", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
145 	{"p_ru", "P_RU", NULL, 0, pvar, NULL, 6, POFF(ru), KPTR, "lx", NULL},
146 	{"paddr", "PADDR", NULL, 0, pvar, NULL, 8, POFF(paddr), KPTR, "lx", NULL},
147 	{"pagein", "PAGEIN", NULL, USER, pagein, NULL, 6, 0, 0, NULL, NULL},
148 	{"pcpu", "", "%cpu", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
149 	{"pending", "", "sig", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
150 	{"pgid", "PGID", NULL, 0, pvar, NULL, PIDLEN, POFF(pgid), UINT, PIDFMT,
151 		NULL},
152 	{"pid", "PID", NULL, 0, pvar, NULL, PIDLEN, POFF(pid), UINT, PIDFMT,
153 		NULL},
154 	{"pmem", "", "%mem", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
155 	{"ppid", "PPID", NULL, 0, pvar, NULL, PIDLEN, POFF(ppid), UINT, PIDFMT,
156 		NULL},
157 	{"pri", "PRI", NULL, 0, pri, NULL, 3, 0, 0, NULL, NULL},
158 	{"re", "RE", NULL, 0, lpvar, NULL, 3, POFF(swtime), UINT, "d", NULL},
159 	{"rgid", "RGID", NULL, 0, pvar, NULL, UIDLEN, POFF(rgid),
160 		UINT, UIDFMT, NULL},
161 #if 0
162 	{"rlink", "RLINK", NULL, 0, pvar, NULL, 8, POFF(p_lwp.lwp_procq.tqe_prev), KPTR, "lx",
163 		NULL},
164 #endif
165 	{"rss", "RSS", NULL, 0, p_rssize, NULL, 6, 0, 0, NULL, NULL},
166 	{"rssize", "", "rsz", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
167 	{"rsz", "RSZ", NULL, 0, rssize, NULL, 6, 0, 0, NULL, NULL},
168 	{"rtprio", "RTPRIO", NULL, 0, rtprior, NULL, 7, 0, 0, NULL, NULL},
169 	{"ruid", "RUID", NULL, 0, pvar, NULL, UIDLEN, POFF(ruid),
170 		UINT, UIDFMT, NULL},
171 	{"ruser", "RUSER", NULL, LJUST|DSIZ, runame, s_runame, USERLEN, 0, 0, NULL,
172 		NULL},
173 	{"sess", "SESS", NULL, 0, pvar, NULL, 6, POFF(sid), UINT, PIDFMT, NULL},
174 	{"sig", "PENDING", NULL, 0, pvar, NULL, 8, POFF(siglist), INT, "x", NULL},
175 	{"sigcatch", "CAUGHT", NULL, 0, pvar, NULL, 8, POFF(sigcatch),
176 		UINT, "x", NULL},
177 	{"sigignore", "IGNORED", NULL, 0, pvar, NULL, 8, POFF(sigignore),
178 		UINT, "x", NULL},
179 	{"sigmask", "BLOCKED", NULL, 0, lpvar, NULL, 8, LPOFF(sigmask), UINT, "x",
180 		NULL},
181 	{"sl", "SL", NULL, 0, lpvar, NULL, 3, LPOFF(slptime), UINT, "d", NULL},
182 	{"start", "STARTED", NULL, LJUST|USER, started, NULL, 7, 0, 0, NULL, NULL},
183 	{"stat", "", "state", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
184 	{"state", "STAT  ", NULL, 0, state, NULL, 6, 0, 0, NULL, NULL},
185 	{"svgid", "SVGID", NULL, 0, pvar, NULL, UIDLEN, POFF(svgid), UINT,
186 		UIDFMT, NULL},
187 	{"svuid", "SVUID", NULL, 0, pvar, NULL, UIDLEN, POFF(svuid), UINT,
188 		UIDFMT, NULL},
189 	{"tdev", "TDEV", NULL, 0, tdev, NULL, 4, 0, 0, NULL, NULL},
190 	{"tdpri", "TDPRI", NULL, 0, tdpri, NULL, 5, 0, 0, NULL, NULL},
191 	{"tid", "TID", NULL, 0, lpvar, NULL, PIDLEN, LPOFF(tid), UINT, PIDFMT,
192 		NULL},
193 	{"time", "TIME", NULL, USER, cputime, NULL, 9, 0, 0, NULL, NULL},
194 	{"tpgid", "TPGID", NULL, 0, pvar, NULL, 4, POFF(tpgid), UINT, PIDFMT, NULL},
195 	{"tsess", "TSESS", NULL, 0, pvar, NULL, 6, POFF(tsid), UINT, PIDFMT, NULL},
196 	{"tsig", "PENDING", NULL, 0, lpvar, NULL, 8, LPOFF(siglist), INT, "x", NULL},
197 	{"tsiz", "TSIZ", NULL, 0, tsize, NULL, 4, 0, 0, NULL, NULL},
198 	{"tt", "TT ", NULL, 0, tname, NULL, 2, 0, 0, NULL, NULL},
199 	{"tty", "TTY", NULL, LJUST, longtname, NULL, 8, 0, 0, NULL, NULL},
200 	{"ucomm", "UCOMM", NULL, LJUST, ucomm, NULL, MAXCOMLEN, 0, 0, NULL, NULL},
201 	{"uid", "UID", NULL, 0, pvar, NULL, UIDLEN, POFF(uid),
202 		UINT, UIDFMT, NULL},
203 	{"user", "USER", NULL, LJUST|DSIZ, uname, s_uname, USERLEN, 0, 0, NULL, NULL},
204 	{"vsize", "", "vsz", 0, 0, NULL, 0, 0, 0, NULL, NULL},
205 	{"vsz", "VSZ", NULL, 0, vsize, NULL, 6, 0, 0, NULL, NULL},
206 	{"wchan", "WCHAN", NULL, LJUST, wchan, NULL, WMESGLEN, 0, 0, NULL, NULL},
207 	{"xstat", "XSTAT", NULL, 0, pvar, NULL, 7, POFF(exitstat), USHORT, "x", NULL},
208 	{"", NULL, NULL, 0, NULL, NULL, 0, 0, 0, NULL, NULL},
209 };
210 
211 void
212 showkey(void)
213 {
214 	const VAR *v;
215 	int i;
216 	const char *p, *sep;
217 
218 	i = 0;
219 	sep = "";
220 	for (v = var; *(p = v->name); ++v) {
221 		int len = strlen(p);
222 		if (termwidth && (i += len + 1) > termwidth) {
223 			i = len;
224 			sep = "\n";
225 		}
226 		printf("%s%s", sep, p);
227 		sep = " ";
228 	}
229 	printf("\n");
230 }
231 
232 void
233 parsefmt(const char *fmt)
234 {
235 	struct varent *vent;
236 	char *p, *op;
237 	const char *cp;
238 
239 	op = p = strdup(fmt);
240 
241 	if (op == NULL)
242 		errx(1, "Not enough memory");
243 
244 #define	FMTSEP	" \t,\n"
245 	while (p != NULL && *p != '\0') {
246 		while ((cp = strsep(&p, FMTSEP)) != NULL && *cp == '\0')
247 			/* void */;
248 		if (cp == NULL)
249 			continue;
250 		if ((vent = makevarent(cp)) == NULL)
251 			continue;
252 		STAILQ_INSERT_TAIL(&var_head, vent, link);
253 	}
254 	if (STAILQ_EMPTY(&var_head)) {
255 		warnx("no valid keywords; valid keywords:");
256 		showkey();
257 		exit(1);
258 	}
259 
260 	free(op);
261 }
262 
263 /*
264  * Insert TID column after PID one in selected output format.
265  */
266 void
267 insert_tid_in_fmt(void)
268 {
269 	struct varent *tidvent;
270 	struct varent *vent;
271 
272 	if ((tidvent = makevarent("tid")) == NULL)
273 		errx(1, "Not enough memory");
274 
275 	STAILQ_FOREACH(vent, &var_head, link) {
276 		if (strcmp(vent->var->name, "pid") == 0) {
277 			STAILQ_INSERT_AFTER(&var_head, vent, tidvent, link);
278 			break;
279 		}
280 	}
281 }
282 
283 static struct varent *
284 makevarent(const char *p)
285 {
286 	struct varent *vent = NULL;
287 	const VAR *v;
288 	VAR key;
289 	char *hp;
290 
291 	hp = strchr(p, '=');
292 	if (hp)
293 		*hp++ = '\0';
294 
295 	key.name = p;
296 	v = bsearch(&key, var, sizeof(var)/sizeof(VAR) - 1, sizeof(VAR), vcmp);
297 
298 	if (v && v->alias) {
299 		if (hp) {
300 			warnx("%s: illegal keyword specification", p);
301 			eval = 1;
302 		}
303 		parsefmt(v->alias);
304 		return(NULL);
305 	}
306 	if (!v) {
307 		warnx("%s: keyword not found", p);
308 		eval = 1;
309 		return(NULL);
310 	}
311 	if ((vent = malloc(sizeof(struct varent))) == NULL)
312 		err(1, NULL);
313 	vent->var = v;
314 	vent->width = v->width;
315 	if (hp) {
316 		vent->header = strdup(hp);
317 		if (vent->header == NULL)
318 			err(1, "Not enough memory");
319 	}
320 	else
321 		vent->header = v->header;
322 	return (vent);
323 }
324 
325 static int
326 vcmp(const void *a, const void *b)
327 {
328         return (strcmp(((const VAR *)a)->name, ((const VAR *)b)->name));
329 }
330