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