keyword.c revision 104388
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#if 0
35#ifndef lint
36static char sccsid[] = "@(#)keyword.c	8.5 (Berkeley) 4/2/94";
37#endif /* not lint */
38#endif
39#include <sys/cdefs.h>
40__FBSDID("$FreeBSD: head/bin/ps/keyword.c 104388 2002-10-02 20:33:52Z jhb $");
41
42#include <sys/param.h>
43#include <sys/time.h>
44#include <sys/resource.h>
45#include <sys/proc.h>
46#include <sys/sysctl.h>
47#include <sys/user.h>
48
49#include <err.h>
50#include <stddef.h>
51#include <stdio.h>
52#include <stdlib.h>
53#include <string.h>
54
55#include "ps.h"
56
57static VAR *findvar(char *);
58static int  vcmp(const void *, const void *);
59
60/* Compute offset in common structures. */
61#define	KOFF(x)	offsetof(struct kinfo_proc, x)
62#define	ROFF(x)	offsetof(struct rusage, x)
63
64#define	UIDFMT	"u"
65#define	UIDLEN	5
66#define	PIDFMT	"d"
67#define	PIDLEN	5
68#define USERLEN (MAXLOGNAME - 1)
69
70static VAR var[] = {
71	{"%cpu", "%CPU", NULL, 0, pcpu, NULL, 4, 0, CHAR, NULL, 0},
72	{"%mem", "%MEM", NULL, 0, pmem, NULL, 4, 0, CHAR, NULL, 0},
73	{"acflag", "ACFLG", NULL, 0, kvar, NULL, 3, KOFF(ki_acflag), USHORT,
74		"x", 0},
75	{"acflg", "", "acflag", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
76	{"args", "COMMAND", NULL, COMM|LJUST|USER, arguments, NULL, 16, 0,
77		CHAR, NULL, 0},
78	{"blocked", "", "sigmask", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
79	{"caught", "", "sigcatch", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
80	{"comm", "COMMAND", NULL, LJUST, ucomm, NULL, MAXCOMLEN, 0, CHAR,
81		NULL, 0},
82	{"command", "COMMAND", NULL, COMM|LJUST|USER, command, NULL, 16, 0,
83		CHAR, NULL, 0},
84	{"cpu", "CPU", NULL, 0, kvar, NULL, 3, KOFF(ki_estcpu), UINT, "d",
85		0},
86	{"cputime", "", "time", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
87	{"etime", "ELAPSED", NULL, USER, elapsed, NULL, 9, 0, CHAR, NULL, 0},
88	{"f", "F", NULL, 0, kvar, NULL, 7, KOFF(ki_flag), INT, "x", 0},
89	{"flags", "", "f", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
90	{"ignored", "", "sigignore", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
91	{"inblk", "INBLK", NULL, USER, rvar, NULL, 4, ROFF(ru_inblock), LONG,
92		"ld", 0},
93	{"inblock", "", "inblk", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
94	{"jobc", "JOBC", NULL, 0, kvar, NULL, 4, KOFF(ki_jobc), SHORT, "d",
95		0},
96	{"ktrace", "KTRACE", NULL, 0, kvar, NULL, 8, KOFF(ki_traceflag), INT,
97		"x", 0},
98	{"lim", "LIM", NULL, 0, maxrss, NULL, 5, 0, CHAR, NULL, 0},
99	{"login", "LOGIN", NULL, LJUST, logname, NULL, MAXLOGNAME-1, 0, CHAR,
100		NULL, 0},
101	{"logname", "", "login", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
102	{"lstart", "STARTED", NULL, LJUST|USER, lstarted, NULL, 28, 0, CHAR,
103		NULL, 0},
104	{"lvl", "LVL", NULL, LJUST, lattr, NULL, 3, 0, CHAR, NULL, 0},
105	{"majflt", "MAJFLT", NULL, USER, rvar, NULL, 4, ROFF(ru_majflt),
106		LONG, "ld", 0},
107	{"minflt", "MINFLT", NULL, USER, rvar, NULL, 4, ROFF(ru_minflt),
108		LONG, "ld", 0},
109	{"msgrcv", "MSGRCV", NULL, USER, rvar, NULL, 4, ROFF(ru_msgrcv),
110		LONG, "ld", 0},
111	{"msgsnd", "MSGSND", NULL, USER, rvar, NULL, 4, ROFF(ru_msgsnd),
112		LONG, "ld", 0},
113	{"lockname", "LOCK", NULL, LJUST, lockname, NULL, 6, 0, CHAR, NULL,
114		0},
115	{"mwchan", "MWCHAN", NULL, LJUST, mwchan, NULL, 6, 0, CHAR, NULL, 0},
116	{"ni", "", "nice", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
117	{"nice", "NI", NULL, 0, kvar, NULL, 2, KOFF(ki_nice), CHAR, "d",
118		0},
119	{"nivcsw", "NIVCSW", NULL, USER, rvar, NULL, 5, ROFF(ru_nivcsw),
120		LONG, "ld", 0},
121	{"nsignals", "", "nsigs", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
122	{"nsigs", "NSIGS", NULL, USER, rvar, NULL, 4, ROFF(ru_nsignals),
123		LONG, "ld", 0},
124	{"nswap", "NSWAP", NULL, USER, rvar, NULL, 4, ROFF(ru_nswap),
125		LONG, "ld", 0},
126	{"nvcsw", "NVCSW", NULL, USER, rvar, NULL, 5, ROFF(ru_nvcsw),
127		LONG, "ld", 0},
128	{"oublk", "OUBLK", NULL, USER, rvar, NULL, 4, ROFF(ru_oublock),
129		LONG, "ld", 0},
130	{"oublock", "", "oublk", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
131	{"paddr", "PADDR", NULL, 0, kvar, NULL, 8, KOFF(ki_paddr), KPTR,
132		"lx", 0},
133	{"pagein", "PAGEIN", NULL, USER, pagein, NULL, 6, 0, CHAR, NULL, 0},
134	{"pcpu", "", "%cpu", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
135	{"pending", "", "sig", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
136	{"pgid", "PGID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_pgid), UINT,
137		PIDFMT, 0},
138	{"pid", "PID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_pid), UINT,
139		PIDFMT, 0},
140	{"pmem", "", "%mem", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
141	{"ppid", "PPID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_ppid), UINT,
142		PIDFMT, 0},
143	{"pri", "PRI", NULL, 0, pri, NULL, 3, 0, CHAR, NULL, 0},
144	{"re", "RE", NULL, 0, kvar, NULL, 3, KOFF(ki_swtime), UINT, "d",
145		0},
146	{"rgid", "RGID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_rgid),
147		UINT, UIDFMT, 0},
148	{"rgroup", "RGROUP", NULL, LJUST|DSIZ, rgroupname, s_rgroupname,
149		USERLEN, 0, CHAR, NULL, 0},
150	{"rss", "RSS", NULL, 0, kvar, NULL, 4, KOFF(ki_rssize), PGTOK, "ld", 0},
151	{"rtprio", "RTPRIO", NULL, 0, priorityr, NULL, 7, KOFF(ki_pri), CHAR,
152		NULL, 0},
153	{"ruid", "RUID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_ruid),
154		UINT, UIDFMT, 0},
155	{"ruser", "RUSER", NULL, LJUST|DSIZ, runame, s_runame, USERLEN,
156		0, CHAR, NULL, 0},
157	{"sid", "SID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_sid), UINT,
158		PIDFMT, 0},
159	{"sig", "PENDING", NULL, 0, kvar, NULL, 8, KOFF(ki_siglist), INT,
160		"x", 0},
161	{"sigcatch", "CAUGHT", NULL, 0, kvar, NULL, 8, KOFF(ki_sigcatch),
162		UINT, "x", 0},
163	{"sigignore", "IGNORED", NULL, 0, kvar, NULL, 8, KOFF(ki_sigignore),
164		UINT, "x", 0},
165	{"sigmask", "BLOCKED", NULL, 0, kvar, NULL, 8, KOFF(ki_sigmask),
166		UINT, "x", 0},
167	{"sl", "SL", NULL, 0, kvar, NULL, 3, KOFF(ki_slptime), UINT, "d",
168		0},
169	{"start", "STARTED", NULL, LJUST|USER, started, NULL, 7, 0, CHAR, NULL,
170		0},
171	{"stat", "", "state", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
172	{"state", "STAT", NULL, 0, state, NULL, 4, 0, CHAR, NULL, 0},
173	{"svgid", "SVGID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_svgid),
174		UINT, UIDFMT, 0},
175	{"svuid", "SVUID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_svuid),
176		UINT, UIDFMT, 0},
177	{"tdev", "TDEV", NULL, 0, tdev, NULL, 4, 0, CHAR, NULL, 0},
178	{"time", "TIME", NULL, USER, cputime, NULL, 9, 0, CHAR, NULL, 0},
179	{"tpgid", "TPGID", NULL, 0, kvar, NULL, 4, KOFF(ki_tpgid), UINT,
180		PIDFMT, 0},
181	{"tsid", "TSID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_tsid), UINT,
182		PIDFMT, 0},
183	{"tsiz", "TSIZ", NULL, 0, kvar, NULL, 4, KOFF(ki_tsize), PGTOK, "ld", 0},
184	{"tt", "TT ", NULL, 0, tname, NULL, 4, 0, CHAR, NULL, 0},
185	{"tty", "TTY", NULL, LJUST, longtname, NULL, 8, 0, CHAR, NULL, 0},
186	{"ucomm", "UCOMM", NULL, LJUST, ucomm, NULL, MAXCOMLEN, 0, CHAR, NULL,
187		0},
188	{"uid", "UID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_uid), UINT,
189		UIDFMT, 0},
190	{"upr", "UPR", NULL, 0, kvar, NULL, 3, KOFF(ki_pri.pri_user), UCHAR,
191		"d", 0},
192	{"user", "USER", NULL, LJUST|DSIZ, uname, s_uname, USERLEN, 0, CHAR,
193		NULL, 0},
194	{"usrpri", "", "upr", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
195	{"vsize", "", "vsz", 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
196	{"vsz", "VSZ", NULL, 0, vsize, NULL, 5, 0, CHAR, NULL, 0},
197	{"wchan", "WCHAN", NULL, LJUST, wchan, NULL, 6, 0, CHAR, NULL, 0},
198	{"xstat", "XSTAT", NULL, 0, kvar, NULL, 4, KOFF(ki_xstat), USHORT,
199		"x", 0},
200	{"", NULL, NULL, 0, NULL, NULL, 0, 0, CHAR, NULL, 0},
201};
202
203void
204showkey(void)
205{
206	VAR *v;
207	int i;
208	const char *p, *sep;
209
210	i = 0;
211	sep = "";
212	for (v = var; *(p = v->name); ++v) {
213		int len = strlen(p);
214		if (termwidth && (i += len + 1) > termwidth) {
215			i = len;
216			sep = "\n";
217		}
218		(void) printf("%s%s", sep, p);
219		sep = " ";
220	}
221	(void) printf("\n");
222}
223
224void
225parsefmt(const char *p)
226{
227	static struct varent *vtail;
228	char *tempstr, *tempstr1;
229
230#define		FMTSEP	" \t,\n"
231	tempstr1 = tempstr = strdup(p);
232	while (tempstr && *tempstr) {
233		char *cp;
234		VAR *v;
235		struct varent *vent;
236
237		/*
238		 * If an item contains an equals sign, it specifies a column
239		 * header, may contain embedded separator characters and
240		 * is always the last item.
241		 */
242		if (tempstr[strcspn(tempstr, "="FMTSEP)] != '=')
243			while ((cp = strsep(&tempstr, FMTSEP)) != NULL &&
244			    *cp == '\0')
245				/* void */;
246		else {
247			cp = tempstr;
248			tempstr = NULL;
249		}
250		if (cp == NULL || !(v = findvar(cp)))
251			continue;
252		if ((vent = malloc(sizeof(struct varent))) == NULL)
253			errx(1, "malloc failed");
254		vent->var = malloc(sizeof(*vent->var));
255		if (vent->var == NULL)
256			errx(1, "malloc failed");
257		memcpy(vent->var, v, sizeof(*vent->var));
258		vent->next = NULL;
259		if (vhead == NULL)
260			vhead = vtail = vent;
261		else {
262			vtail->next = vent;
263			vtail = vent;
264		}
265	}
266	free(tempstr1);
267	if (!vhead) {
268		warnx("no valid keywords; valid keywords:");
269		showkey();
270		exit(1);
271	}
272}
273
274static VAR *
275findvar(char *p)
276{
277	VAR *v, key;
278	char *hp;
279
280	hp = strchr(p, '=');
281	if (hp)
282		*hp++ = '\0';
283
284	key.name = p;
285	v = bsearch(&key, var, sizeof(var)/sizeof(VAR) - 1, sizeof(VAR), vcmp);
286
287	if (v && v->alias) {
288		if (hp) {
289			warnx("%s: illegal keyword specification", p);
290			eval = 1;
291		}
292		parsefmt(v->alias);
293		return ((VAR *)NULL);
294	}
295	if (!v) {
296		warnx("%s: keyword not found", p);
297		eval = 1;
298	} else if (hp)
299		v->header = strdup(hp);
300	return (v);
301}
302
303static int
304vcmp(const void *a, const void *b)
305{
306        return (strcmp(((const VAR *)a)->name, ((const VAR *)b)->name));
307}
308