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