xref: /dragonfly/bin/ps/keyword.c (revision c69bf40f)
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. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * @(#)keyword.c	8.5 (Berkeley) 4/2/94
30  * $FreeBSD: src/bin/ps/keyword.c,v 1.24.2.3 2002/10/10 20:05:32 jmallett Exp $
31  */
32 
33 #include <sys/user.h>
34 #include <sys/kinfo.h>
35 #include <sys/param.h>
36 #include <sys/time.h>
37 #include <sys/queue.h>
38 #include <sys/resource.h>
39 #include <sys/sysctl.h>
40 #include <sys/ucred.h>
41 
42 #include <err.h>
43 #include <errno.h>
44 #include <stddef.h>
45 #include <stdio.h>
46 #include <stdlib.h>
47 #include <string.h>
48 
49 #include "ps.h"
50 
51 static struct varent	*makevarent(const char *);
52 static int		 vcmp(const void *, const void *);
53 
54 struct varent_head var_head = STAILQ_HEAD_INITIALIZER(var_head);
55 
56 #ifdef NOTINUSE
57 int	utime(), stime(), ixrss(), idrss(), isrss();
58 	{{"utime"}, "UTIME", USER, utime, NULL, 4},
59 	{{"stime"}, "STIME", USER, stime, NULL, 4},
60 	{{"ixrss"}, "IXRSS", USER, ixrss, NULL, 4},
61 	{{"idrss"}, "IDRSS", USER, idrss, NULL, 4},
62 	{{"isrss"}, "ISRSS", USER, isrss, NULL, 4},
63 #endif
64 
65 /* Compute offset in common structures. */
66 #define	POFF(x)	offsetof(struct kinfo_proc, kp_##x)
67 #define	LPOFF(x) offsetof(struct kinfo_lwp, kl_##x)
68 #define	ROFF(x)	offsetof(struct rusage, x)
69 
70 #define	UIDFMT	"u"
71 #define	UIDLEN	5
72 #define	PIDFMT	"d"
73 #define	PIDLEN	6
74 #define USERLEN (MAXLOGNAME-1)
75 
76 static const VAR var[] = {
77 	{"%cpu", "%CPU", NULL, 0, pcpu, NULL, 4, 0, 0, NULL, NULL},
78 	{"%mem", "%MEM", NULL, 0, pmem, NULL, 4, 0, 0, NULL, NULL},
79 	{"acflag", "ACFLG", NULL, 0, pvar, NULL, 3, POFF(acflag), USHORT, "x",
80 		NULL},
81 	{"acflg", "", "acflag", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
82 	{"args", "", "command", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
83 	{"batch", "BAT", NULL, 0, lpest, NULL, 3, LPOFF(origcpu), UINT, "d", NULL},
84 	{"blocked", "", "sigmask", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
85 	{"caught", "", "sigcatch", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
86 	{"comm", "", "ucomm", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
87 	{"command", "COMMAND", NULL, COMM|LJUST|USER, command, NULL, 16, 0, 0, NULL,
88 		NULL},
89 	{"cpu", "CPU", NULL, 0, lpest, NULL, 3, LPOFF(estcpu), UINT, "d", NULL},
90 	{"cputime", "", "time", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
91 	{"f", "F", NULL, 0, pvar, NULL, 7, POFF(flags), INT, "x", NULL},
92 	{"flags", "", "f", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
93 #if 0
94 	{"iac", "IAC",  NULL, 0, pvar, NULL, 4, POFF(p_usdata.bsd4.interactive), CHAR, PIDFMT,
95 		NULL},
96 #endif
97 	{"ignored", "", "sigignore", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
98 	{"inblk", "INBLK", NULL, USER, rvar, NULL, 4, ROFF(ru_inblock), LONG, "ld",
99 		NULL},
100 	{"inblock", "", "inblk", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
101 	{"jail", "JAIL", NULL, 0, pvar, NULL, 3, POFF(jailid), INT, "d", NULL},
102 	{"jobc", "JOBC", NULL, 0, pvar, NULL, 4, POFF(jobc), SHORT, "d", NULL},
103 	{"ktrace", "KTRACE", NULL, 0, pvar, NULL, 8, POFF(traceflag), INT, "x",
104 		NULL},
105 #if 0
106 	{"ktracep", "KTRACEP", NULL, 0, pvar, NULL, 8, POFF(p_tracenode), LONG, "lx",
107 		NULL},
108 #endif
109 	{"lastcpu", "C", NULL, 0, lpvar, NULL, 3, LPOFF(cpuid), UINT, "d", NULL},
110 	{"lim", "LIM", NULL, 0, maxrss, NULL, 5, 0, 0, NULL, NULL},
111 	{"login", "LOGIN", NULL, LJUST, logname, NULL, MAXLOGNAME-1, 0, 0, NULL,
112 		NULL},
113 	{"logname", "", "login", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
114 	{"lstart", "STARTED", NULL, LJUST|USER, lstarted, NULL, 28, 0, 0, NULL, NULL},
115 	{"majflt", "MAJFLT", NULL, USER, rvar, NULL, 4, ROFF(ru_majflt), LONG, "ld",
116 		NULL},
117 	{"minflt", "MINFLT", NULL, USER, rvar, NULL, 4, ROFF(ru_minflt), LONG, "ld",
118 		NULL},
119 	{"msgrcv", "MSGRCV", NULL, USER, rvar, NULL, 4, ROFF(ru_msgrcv), LONG, "ld",
120 		NULL},
121 	{"msgsnd", "MSGSND", NULL, USER, rvar, NULL, 4, ROFF(ru_msgsnd), LONG, "ld",
122 		NULL},
123 	{"ni", "", "nice", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
124 	{"nice", "NI", NULL, 0, pnice, NULL, 3, 0, 0, NULL, NULL},
125 	{"nivcsw", "NIVCSW", NULL, USER, rvar, NULL, 5, ROFF(ru_nivcsw), LONG, "ld",
126 		NULL},
127 	{"nlwp", "NLWP", NULL, 0, pvar, NULL, 4, POFF(nthreads), INT, "d",
128 		NULL},
129 	{"nsignals", "", "nsigs", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
130 	{"nsigs", "NSIGS", NULL, USER, rvar, NULL, 4, ROFF(ru_nsignals), LONG, "ld",
131 		NULL},
132 	{"nswap", "NSWAP", NULL, USER, rvar, NULL, 4, ROFF(ru_nswap), LONG, "ld",
133 		NULL},
134 	{"nvcsw", "NVCSW", NULL, USER, rvar, NULL, 5, ROFF(ru_nvcsw), LONG, "ld",
135 		NULL},
136 	{"nwchan", "WCHAN", NULL, 0, lpvar, NULL, 8, LPOFF(wchan), KPTR, "lx", NULL},
137 	{"oublk", "OUBLK", NULL, USER, rvar, NULL, 4, ROFF(ru_oublock), LONG, "ld",
138 		NULL},
139 	{"oublock", "", "oublk", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
140 	{"p_ru", "P_RU", NULL, 0, pvar, NULL, 6, POFF(ru), KPTR, "lx", NULL},
141 	{"paddr", "PADDR", NULL, 0, pvar, NULL, 8, POFF(paddr), KPTR, "lx", NULL},
142 	{"pagein", "PAGEIN", NULL, USER, pagein, NULL, 6, 0, 0, NULL, NULL},
143 	{"pcpu", "", "%cpu", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
144 	{"pending", "", "sig", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
145 	{"pgid", "PGID", NULL, 0, pvar, NULL, PIDLEN, POFF(pgid), UINT, PIDFMT,
146 		NULL},
147 	{"pid", "PID", NULL, 0, pvar, NULL, PIDLEN, POFF(pid), UINT, PIDFMT,
148 		NULL},
149 	{"pmem", "", "%mem", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
150 	{"ppid", "PPID", NULL, 0, pvar, NULL, PIDLEN, POFF(ppid), UINT, PIDFMT,
151 		NULL},
152 	{"pri", "PRI", NULL, 0, pri, NULL, 3, 0, 0, NULL, NULL},
153 	{"re", "RE", NULL, 0, lpvar, NULL, 3, POFF(swtime), UINT, "d", NULL},
154 	{"rgid", "RGID", NULL, 0, pvar, NULL, UIDLEN, POFF(rgid),
155 		UINT, UIDFMT, NULL},
156 #if 0
157 	{"rlink", "RLINK", NULL, 0, pvar, NULL, 8, POFF(p_lwp.lwp_procq.tqe_prev), KPTR, "lx",
158 		NULL},
159 #endif
160 	{"rss", "RSS", NULL, 0, p_rssize, NULL, 6, 0, 0, NULL, NULL},
161 	{"rssize", "", "rsz", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
162 	{"rsz", "RSZ", NULL, 0, rssize, NULL, 6, 0, 0, NULL, NULL},
163 	{"rtprio", "RTPRIO", NULL, 0, rtprior, NULL, 7, 0, 0, NULL, NULL},
164 	{"ruid", "RUID", NULL, 0, pvar, NULL, UIDLEN, POFF(ruid),
165 		UINT, UIDFMT, NULL},
166 	{"ruser", "RUSER", NULL, LJUST|DSIZ, runame, s_runame, USERLEN, 0, 0, NULL,
167 		NULL},
168 	{"sess", "SESS", NULL, 0, pvar, NULL, 6, POFF(sid), UINT, PIDFMT, NULL},
169 	{"sig", "PENDING", NULL, 0, pvar, NULL, 8, POFF(siglist), INT, "x", NULL},
170 	{"sigcatch", "CAUGHT", NULL, 0, pvar, NULL, 8, POFF(sigcatch),
171 		UINT, "x", NULL},
172 	{"sigignore", "IGNORED", NULL, 0, pvar, NULL, 8, POFF(sigignore),
173 		UINT, "x", NULL},
174 	{"sigmask", "BLOCKED", NULL, 0, lpvar, NULL, 8, LPOFF(sigmask), UINT, "x",
175 		NULL},
176 	{"sl", "SL", NULL, 0, lpvar, NULL, 3, LPOFF(slptime), UINT, "d", NULL},
177 	{"start", "STARTED", NULL, LJUST|USER, started, NULL, 7, 0, 0, NULL, NULL},
178 	{"stat", "", "state", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
179 	{"state", "STAT  ", NULL, 0, state, NULL, 6, 0, 0, NULL, NULL},
180 	{"svgid", "SVGID", NULL, 0, pvar, NULL, UIDLEN, POFF(svgid), UINT,
181 		UIDFMT, NULL},
182 	{"svuid", "SVUID", NULL, 0, pvar, NULL, UIDLEN, POFF(svuid), UINT,
183 		UIDFMT, NULL},
184 	{"tdev", "TDEV", NULL, 0, tdev, NULL, 4, 0, 0, NULL, NULL},
185 	{"tdpri", "TDPRI", NULL, 0, tdpri, NULL, 5, 0, 0, NULL, NULL},
186 	{"tid", "TID", NULL, 0, lpvar, NULL, PIDLEN, LPOFF(tid), UINT, PIDFMT,
187 		NULL},
188 	{"time", "TIME", NULL, USER, cputime, NULL, 9, 0, 0, NULL, NULL},
189 	{"tpgid", "TPGID", NULL, 0, pvar, NULL, 4, POFF(tpgid), UINT, PIDFMT, NULL},
190 	{"tsess", "TSESS", NULL, 0, pvar, NULL, 6, POFF(tsid), UINT, PIDFMT, NULL},
191 	{"tsig", "PENDING", NULL, 0, lpvar, NULL, 8, LPOFF(siglist), INT, "x", NULL},
192 	{"tsiz", "TSIZ", NULL, 0, tsize, NULL, 4, 0, 0, NULL, NULL},
193 	{"tt", "TT ", NULL, 0, tname, NULL, 2, 0, 0, NULL, NULL},
194 	{"tty", "TTY", NULL, LJUST, longtname, NULL, 8, 0, 0, NULL, NULL},
195 	{"ucomm", "UCOMM", NULL, LJUST, ucomm, NULL, MAXCOMLEN, 0, 0, NULL, NULL},
196 	{"uid", "UID", NULL, 0, pvar, NULL, UIDLEN, POFF(uid),
197 		UINT, UIDFMT, NULL},
198 	{"user", "USER", NULL, LJUST|DSIZ, uname, s_uname, USERLEN, 0, 0, NULL, NULL},
199 	{"vsize", "", "vsz", 0, 0, NULL, 0, 0, 0, NULL, NULL},
200 	{"vsz", "VSZ", NULL, 0, vsize, NULL, 6, 0, 0, NULL, NULL},
201 	{"wchan", "WCHAN", NULL, LJUST, wchan, NULL, WMESGLEN, 0, 0, NULL, NULL},
202 	{"xstat", "XSTAT", NULL, 0, pvar, NULL, 7, POFF(exitstat), USHORT, "x", NULL},
203 	{"", NULL, NULL, 0, NULL, NULL, 0, 0, 0, NULL, NULL},
204 };
205 
206 void
207 showkey(void)
208 {
209 	const 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 		printf("%s%s", sep, p);
222 		sep = " ";
223 	}
224 	printf("\n");
225 }
226 
227 void
228 parsefmt(const char *fmt)
229 {
230 	struct varent *vent;
231 	char *p, *op;
232 	const char *cp;
233 
234 	op = p = strdup(fmt);
235 
236 	if (op == NULL)
237 		errx(1, "Not enough memory");
238 
239 #define	FMTSEP	" \t,\n"
240 	while (p != NULL && *p != '\0') {
241 		while ((cp = strsep(&p, FMTSEP)) != NULL && *cp == '\0')
242 			/* void */;
243 		if (cp == NULL)
244 			continue;
245 		if ((vent = makevarent(cp)) == NULL)
246 			continue;
247 		STAILQ_INSERT_TAIL(&var_head, vent, link);
248 	}
249 	if (STAILQ_EMPTY(&var_head)) {
250 		warnx("no valid keywords; valid keywords:");
251 		showkey();
252 		exit(1);
253 	}
254 
255 	free(op);
256 }
257 
258 /*
259  * Insert TID column after PID one in selected output format.
260  */
261 void
262 insert_tid_in_fmt(void)
263 {
264 	struct varent *tidvent;
265 	struct varent *vent;
266 
267 	if ((tidvent = makevarent("tid")) == NULL)
268 		errx(1, "Not enough memory");
269 
270 	STAILQ_FOREACH(vent, &var_head, link) {
271 		if (strcmp(vent->var->name, "pid") == 0) {
272 			STAILQ_INSERT_AFTER(&var_head, vent, tidvent, link);
273 			break;
274 		}
275 	}
276 }
277 
278 static struct varent *
279 makevarent(const char *p)
280 {
281 	struct varent *vent = NULL;
282 	const VAR *v;
283 	VAR key;
284 	char *hp;
285 
286 	hp = strchr(p, '=');
287 	if (hp)
288 		*hp++ = '\0';
289 
290 aliased:
291 	key.name = p;
292 	v = bsearch(&key, var, sizeof(var)/sizeof(VAR) - 1, sizeof(VAR), vcmp);
293 
294 	if (v && v->alias) {
295 		p = v->alias;
296 		if (hp == NULL && v->header[0] != '\0')
297 			hp = strdup(v->header);
298 		goto aliased;
299 	}
300 	if (!v) {
301 		warnx("%s: keyword not found", p);
302 		eval = 1;
303 		return(NULL);
304 	}
305 	if ((vent = malloc(sizeof(struct varent))) == NULL)
306 		err(1, NULL);
307 	vent->var = v;
308 	vent->width = v->width;
309 	if (hp) {
310 		vent->header = strdup(hp);
311 		if (vent->header == NULL)
312 			err(1, "Not enough memory");
313 	}
314 	else
315 		vent->header = v->header;
316 	return (vent);
317 }
318 
319 static int
320 vcmp(const void *a, const void *b)
321 {
322         return (strcmp(((const VAR *)a)->name, ((const VAR *)b)->name));
323 }
324