xref: /freebsd/bin/ps/keyword.c (revision 8fa113e5fc65fe6abc757f0089f477a87ee4d185)
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
36 static char sccsid[] = "@(#)keyword.c	8.5 (Berkeley) 4/2/94";
37 #else
38 static const char rcsid[] =
39   "$FreeBSD$";
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 
61 static VAR *findvar __P((char *));
62 static int  vcmp __P((const void *, const void *));
63 
64 #ifdef NOTINUSE
65 int	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 
84 VAR 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 	{"lvl", "LVL", NULL, LJUST, lattr, NULL, 3},
109 	{"majflt", "MAJFLT",
110 		NULL, USER, rvar, NULL, 4, ROFF(ru_majflt), LONG, "ld"},
111 	{"minflt", "MINFLT",
112 		NULL, USER, rvar, NULL, 4, ROFF(ru_minflt), LONG, "ld"},
113 	{"mtxname", "MUTEX", NULL, LJUST, mtxname, NULL, 6},
114 	{"msgrcv", "MSGRCV",
115 		NULL, USER, rvar, NULL, 4, ROFF(ru_msgrcv), LONG, "ld"},
116 	{"msgsnd", "MSGSND",
117 		NULL, USER, rvar, NULL, 4, ROFF(ru_msgsnd), LONG, "ld"},
118 	{"ni", "", "nice"},
119 	{"nice", "NI", NULL, 0, kvar, NULL, 2, KOFF(ki_nice), CHAR, "d"},
120 	{"nivcsw", "NIVCSW",
121 		NULL, USER, rvar, NULL, 5, ROFF(ru_nivcsw), LONG, "ld"},
122 	{"nsignals", "", "nsigs"},
123 	{"nsigs", "NSIGS",
124 		NULL, USER, rvar, NULL, 4, ROFF(ru_nsignals), LONG, "ld"},
125 	{"nswap", "NSWAP",
126 		NULL, USER, rvar, NULL, 4, ROFF(ru_nswap), LONG, "ld"},
127 	{"nvcsw", "NVCSW",
128 		NULL, USER, rvar, NULL, 5, ROFF(ru_nvcsw), LONG, "ld"},
129 	{"nwchan", "WCHAN", NULL, 0, kvar, NULL, 8, KOFF(ki_wchan), KPTR, "lx"},
130 	{"oublk", "OUBLK",
131 		NULL, USER, rvar, NULL, 4, ROFF(ru_oublock), LONG, "ld"},
132 	{"oublock", "", "oublk"},
133 	{"paddr", "PADDR", NULL, 0, kvar, NULL, 8, KOFF(ki_paddr), KPTR, "lx"},
134 	{"pagein", "PAGEIN", NULL, USER, pagein, NULL, 6},
135 	{"pcpu", "", "%cpu"},
136 	{"pending", "", "sig"},
137 	{"pgid", "PGID",
138 		NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_pgid), UINT, PIDFMT},
139 	{"pid", "PID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_pid), UINT, PIDFMT},
140 	{"pmem", "", "%mem"},
141 	{"ppid", "PPID",
142 		NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_ppid), UINT, PIDFMT},
143 	{"pri", "PRI", NULL, 0, pri, NULL, 3},
144 	{"re", "RE", NULL, 0, kvar, NULL, 3, KOFF(ki_swtime), UINT, "d"},
145 	{"rgid", "RGID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_rgid),
146 		UINT, UIDFMT},
147 	{"rss", "RSS", NULL, 0, kvar, NULL, 4, KOFF(ki_rssize), UINT, "d"},
148 	{"rtprio", "RTPRIO", NULL, 0, priorityr, NULL, 7, KOFF(ki_pri)},
149 	{"ruid", "RUID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_ruid),
150 		UINT, UIDFMT},
151 	{"ruser", "RUSER", NULL, LJUST|DSIZ, runame, s_runame, USERLEN},
152 	{"sid", "SID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_sid), UINT,
153 		PIDFMT},
154 	{"sig", "PENDING", NULL, 0, kvar, NULL, 8, KOFF(ki_siglist), INT, "x"},
155 	{"sigcatch", "CAUGHT",
156 		NULL, 0, kvar, NULL, 8, KOFF(ki_sigcatch), UINT, "x"},
157 	{"sigignore", "IGNORED",
158 		NULL, 0, kvar, NULL, 8, KOFF(ki_sigignore), UINT, "x"},
159 	{"sigmask", "BLOCKED",
160 		NULL, 0, kvar, NULL, 8, KOFF(ki_sigmask), UINT, "x"},
161 	{"sl", "SL", NULL, 0, kvar, NULL, 3, KOFF(ki_slptime), UINT, "d"},
162 	{"start", "STARTED", NULL, LJUST|USER, started, NULL, 7},
163 	{"stat", "", "state"},
164 	{"state", "STAT", NULL, 0, state, NULL, 4},
165 	{"svgid", "SVGID", NULL, 0,
166 		kvar, NULL, UIDLEN, KOFF(ki_svgid), UINT, UIDFMT},
167 	{"svuid", "SVUID", NULL, 0,
168 		kvar, NULL, UIDLEN, KOFF(ki_svuid), UINT, UIDFMT},
169 	{"tdev", "TDEV", NULL, 0, tdev, NULL, 4},
170 	{"time", "TIME", NULL, USER, cputime, NULL, 9},
171 	{"tpgid", "TPGID",
172 		NULL, 0, kvar, NULL, 4, KOFF(ki_tpgid), UINT, PIDFMT},
173 	{"tsid", "TSID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_tsid), UINT,
174 		PIDFMT},
175 	{"tsiz", "TSIZ", NULL, 0, tsize, NULL, 4},
176 	{"tt", "TT ", NULL, 0, tname, NULL, 4},
177 	{"tty", "TTY", NULL, LJUST, longtname, NULL, 8},
178 	{"ucomm", "UCOMM", NULL, LJUST, ucomm, NULL, MAXCOMLEN},
179 	{"uid", "UID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_uid),
180 		UINT, UIDFMT},
181 	{"upr", "UPR", NULL, 0, kvar, NULL, 3, KOFF(ki_pri.pri_user),
182 		UCHAR, "d"},
183 	{"user", "USER", NULL, LJUST|DSIZ, uname, s_uname, USERLEN},
184 	{"usrpri", "", "upr"},
185 	{"vsize", "", "vsz"},
186 	{"vsz", "VSZ", NULL, 0, vsize, NULL, 5},
187 	{"wchan", "WCHAN", NULL, LJUST, wchan, NULL, 6},
188 	{"xstat", "XSTAT", NULL, 0, kvar, NULL, 4, KOFF(ki_xstat), USHORT, "x"},
189 	{""},
190 };
191 
192 void
193 showkey()
194 {
195 	VAR *v;
196 	int i;
197 	char *p, *sep;
198 
199 	i = 0;
200 	sep = "";
201 	for (v = var; *(p = v->name); ++v) {
202 		int len = strlen(p);
203 		if (termwidth && (i += len + 1) > termwidth) {
204 			i = len;
205 			sep = "\n";
206 		}
207 		(void) printf("%s%s", sep, p);
208 		sep = " ";
209 	}
210 	(void) printf("\n");
211 }
212 
213 void
214 parsefmt(p)
215 	char *p;
216 {
217 	static struct varent *vtail;
218 
219 #define	FMTSEP	" \t,\n"
220 	while (p && *p) {
221 		char *cp;
222 		VAR *v;
223 		struct varent *vent;
224 
225 		while ((cp = strsep(&p, FMTSEP)) != NULL && *cp == '\0')
226 			/* void */;
227 		if (cp == NULL || !(v = findvar(cp)))
228 			continue;
229 		if ((vent = malloc(sizeof(struct varent))) == NULL)
230 			err(1, NULL);
231 		vent->var = v;
232 		vent->next = NULL;
233 		if (vhead == NULL)
234 			vhead = vtail = vent;
235 		else {
236 			vtail->next = vent;
237 			vtail = vent;
238 		}
239 	}
240 	if (!vhead)
241 		errx(1, "no valid keywords");
242 }
243 
244 static VAR *
245 findvar(p)
246 	char *p;
247 {
248 	VAR *v, key;
249 	char *hp;
250 	int vcmp();
251 
252 	hp = strchr(p, '=');
253 	if (hp)
254 		*hp++ = '\0';
255 
256 	key.name = p;
257 	v = bsearch(&key, var, sizeof(var)/sizeof(VAR) - 1, sizeof(VAR), vcmp);
258 
259 	if (v && v->alias) {
260 		if (hp) {
261 			warnx("%s: illegal keyword specification", p);
262 			eval = 1;
263 		}
264 		parsefmt(v->alias);
265 		return ((VAR *)NULL);
266 	}
267 	if (!v) {
268 		warnx("%s: keyword not found", p);
269 		eval = 1;
270 	} else if (hp)
271 		v->header = hp;
272 	return (v);
273 }
274 
275 static int
276 vcmp(a, b)
277         const void *a, *b;
278 {
279         return (strcmp(((VAR *)a)->name, ((VAR *)b)->name));
280 }
281