xref: /netbsd-src/bin/ps/keyword.c (revision e5548b402ae4c44fb816de42c7bba9581ce23ef5)
1 /*	$NetBSD: keyword.c,v 1.45 2005/11/05 19:27:24 chs Exp $	*/
2 
3 /*-
4  * Copyright (c) 1990, 1993, 1994
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #include <sys/cdefs.h>
33 #ifndef lint
34 #if 0
35 static char sccsid[] = "@(#)keyword.c	8.5 (Berkeley) 4/2/94";
36 #else
37 __RCSID("$NetBSD: keyword.c,v 1.45 2005/11/05 19:27:24 chs Exp $");
38 #endif
39 #endif /* not lint */
40 
41 #include <sys/param.h>
42 #include <sys/time.h>
43 #include <sys/lwp.h>
44 #include <sys/proc.h>
45 #include <sys/resource.h>
46 #include <sys/sysctl.h>
47 #include <sys/ucred.h>
48 
49 #include <err.h>
50 #include <errno.h>
51 #include <kvm.h>
52 #include <stddef.h>
53 #include <stdio.h>
54 #include <stdlib.h>
55 #include <string.h>
56 #include <signal.h>
57 
58 #include "ps.h"
59 
60 static VAR *findvar(const char *);
61 static int  vcmp(const void *, const void *);
62 
63 #if 0 	/* kernel doesn't calculate these */
64 	PUVAR("idrss", "IDRSS", 0, p_uru_idrss, UINT64, PRIu64),
65 	PUVAR("isrss", "ISRSS", 0, p_uru_isrss, UINT64, PRId64),
66 	PUVAR("ixrss", "IXRSS", 0, p_uru_ixrss, UINT64, PRId64),
67 	PUVAR("maxrss", "MAXRSS", 0, p_uru_maxrss, UINT64, PRIu64),
68 #endif
69 
70 /* Compute offset in common structures. */
71 #define	POFF(x)	offsetof(struct kinfo_proc2, x)
72 #define	LOFF(x)	offsetof(struct kinfo_lwp, x)
73 
74 #define	UIDFMT	"u"
75 #define	UID(n1, n2, off) \
76 	{ n1, n2, 0, pvar, POFF(off), UINT32, UIDFMT }
77 #define	GID(n1, n2, off)	UID(n1, n2, off)
78 
79 #define	PIDFMT	"d"
80 #define	PID(n1, n2, off) \
81 	{ n1, n2, 0, pvar, POFF(off), INT32, PIDFMT }
82 
83 #define	LVAR(n1, n2, fl, off, type, fmt) \
84 	{ n1, n2, (fl) | LWP, pvar, LOFF(off), type, fmt }
85 #define	PVAR(n1, n2, fl, off, type, fmt) \
86 	{ n1, n2, (fl) | 0, pvar, POFF(off), type, fmt }
87 #define	PUVAR(n1, n2, fl, off, type, fmt) \
88 	{ n1, n2, (fl) | UAREA, pvar, POFF(off), type, fmt }
89 
90 /* NB: table must be sorted, in vi use:
91  *	:/^VAR/,/end_sort/! sort -t\" +1
92  * breaking long lines just makes the sort harder
93  */
94 VAR var[] = {
95 	{"%cpu", "%CPU", 0, pcpu, 0, PCPU},
96 	{"%mem", "%MEM", 0, pmem, POFF(p_vm_rssize), INT32},
97 	PVAR("acflag", "ACFLG", 0, p_acflag, USHORT, "x"),
98 	{"acflg", "acflag", ALIAS},
99 	{"args", "command", ALIAS},
100 	{"blocked", "sigmask", ALIAS},
101 	{"caught", "sigcatch", ALIAS},
102 	{"comm", "COMMAND", COMM|ARGV0|LJUST, command},
103 	{"command", "COMMAND", COMM|LJUST, command},
104 	PVAR("cpu", "CPU", 0, p_estcpu, UINT, "u"),
105 	{"cputime", "time", ALIAS},
106 	{"ctime", "CTIME", 0, putimeval, POFF(p_uctime_sec), TIMEVAL},
107 	GID("egid", "EGID", p_gid),
108 	{"egroup", "EGROUP", LJUST, gname},
109 	{"etime", "ELAPSED", 0, elapsed, POFF(p_ustart_sec), TIMEVAL},
110 	UID("euid", "EUID", p_uid),
111 	{"euser", "EUSER", LJUST, uname},
112 	PVAR("f", "F", 0, p_flag, INT, "x"),
113 	{"flags", "f", ALIAS},
114 	GID("gid", "GID", p_gid),
115 	{"group", "GROUP", LJUST, gname},
116 	{"groupnames", "GROUPNAMES", LJUST, groupnames},
117 	{"groups", "GROUPS", LJUST, groups},
118 	LVAR("holdcnt", "HOLDCNT", 0, l_holdcnt, INT, "d"),
119 	{"ignored", "sigignore", ALIAS},
120 	PUVAR("inblk", "INBLK", 0, p_uru_inblock, UINT64, PRIu64),
121 	{"inblock", "inblk", ALIAS},
122 	PVAR("jobc", "JOBC", 0, p_jobc, SHORT, "d"),
123 	PVAR("ktrace", "KTRACE", 0, p_traceflag, INT, "x"),
124 /*XXX*/	PVAR("ktracep", "KTRACEP", 0, p_tracep, KPTR, PRIx64),
125 	LVAR("laddr", "LADDR", 0, l_laddr, KPTR, PRIx64),
126 	LVAR("lid", "LID", 0, l_lid, INT32, "d"),
127 	{"lim", "LIM", 0, maxrss},
128 	{"login", "LOGIN", LJUST, logname},
129 	{"logname", "login", ALIAS},
130 	{"lstart", "STARTED", LJUST, lstarted, POFF(p_ustart_sec), UINT32},
131 	{"lstate", "STAT", LJUST|LWP, lstate},
132 	PUVAR("majflt", "MAJFLT", 0, p_uru_majflt, UINT64, PRIu64),
133 	PUVAR("minflt", "MINFLT", 0, p_uru_minflt, UINT64, PRIu64),
134 	PUVAR("msgrcv", "MSGRCV", 0, p_uru_msgrcv, UINT64, PRIu64),
135 	PUVAR("msgsnd", "MSGSND", 0, p_uru_msgsnd, UINT64, PRIu64),
136 	{"ni", "nice", ALIAS},
137 	{"nice", "NI", 0, pnice, POFF(p_nice), UCHAR},
138 	PUVAR("nivcsw", "NIVCSW", 0, p_uru_nivcsw, UINT64, PRIu64),
139 	PVAR("nlwp", "NLWP", 0, p_nlwps, UINT64, PRId64),
140 	{"nsignals", "nsigs", ALIAS},
141 	PUVAR("nsigs", "NSIGS", 0, p_uru_nsignals, UINT64, PRIu64),
142 	PUVAR("nswap", "NSWAP", 0, p_uru_nswap, UINT64, PRIu64),
143 	PUVAR("nvcsw", "NVCSW", 0, p_uru_nvcsw, UINT64, PRIu64),
144 /*XXX*/	LVAR("nwchan", "WCHAN", 0, l_wchan, KPTR, PRIx64),
145 	PUVAR("oublk", "OUBLK", 0, p_uru_oublock, UINT64, PRIu64),
146 	{"oublock", "oublk", ALIAS},
147 /*XXX*/	PVAR("p_ru", "P_RU", 0, p_ru, KPTR, PRIx64),
148 /*XXX*/	PVAR("paddr", "PADDR", 0, p_paddr, KPTR, PRIx64),
149 	PUVAR("pagein", "PAGEIN", 0, p_uru_majflt, UINT64, PRIu64),
150 	{"pcpu", "%cpu", ALIAS},
151 	{"pending", "sig", ALIAS},
152 	PID("pgid", "PGID", p__pgid),
153 	PID("pid", "PID", p_pid),
154 	{"pmem", "%mem", ALIAS},
155 	PID("ppid", "PPID", p_ppid),
156 	{"pri", "PRI", LWP, pri},
157 	LVAR("re", "RE", INF127, l_swtime, UINT, "u"),
158 	GID("rgid", "RGID", p_rgid),
159 	{"rgroup", "RGROUP", LJUST, rgname},
160 /*XXX*/	LVAR("rlink", "RLINK", 0, l_back, KPTR, PRIx64),
161 	PVAR("rlwp", "RLWP", 0, p_nrlwps, UINT64, PRId64),
162 	{"rss", "RSS", 0, p_rssize, POFF(p_vm_rssize), INT32},
163 	{"rssize", "rsz", ALIAS},
164 	{"rsz", "RSZ", 0, rssize, POFF(p_vm_rssize), INT32},
165 	UID("ruid", "RUID", p_ruid),
166 	{"ruser", "RUSER", LJUST, runame},
167 	PVAR("sess", "SESS", 0, p_sess, KPTR24, PRIx64),
168 	PID("sid", "SID", p_sid),
169 	PVAR("sig", "PENDING", 0, p_siglist, SIGLIST, "s"),
170 	PVAR("sigcatch", "CAUGHT", 0, p_sigcatch, SIGLIST, "s"),
171 	PVAR("sigignore", "IGNORED", 0, p_sigignore, SIGLIST, "s"),
172 	PVAR("sigmask", "BLOCKED", 0, p_sigmask, SIGLIST, "s"),
173 	LVAR("sl", "SL", INF127, l_slptime, UINT, "u"),
174 	{"start", "STARTED", 0, started, POFF(p_ustart_sec), UINT32},
175 	{"stat", "state", ALIAS},
176 	{"state", "STAT", LJUST, state},
177 	{"stime", "STIME", 0, putimeval, POFF(p_ustime_sec), TIMEVAL},
178 	GID("svgid", "SVGID", p_svgid),
179 	{"svgroup", "SVGROUP", LJUST, svgname},
180 	UID("svuid", "SVUID", p_svuid),
181 	{"svuser", "SVUSER", LJUST, svuname},
182 	/* "tdev" is UINT32, but we do this for sorting purposes */
183 	{"tdev", "TDEV", 0, tdev, POFF(p_tdev), INT32},
184 	{"time", "TIME", 0, cputime, 0, CPUTIME},
185 	PID("tpgid", "TPGID", p_tpgid),
186 	PVAR("tsess", "TSESS", 0, p_tsess, KPTR, PRIx64),
187 	{"tsiz", "TSIZ", 0, tsize, POFF(p_vm_tsize), INT32},
188 	{"tt", "TTY", LJUST, tname, POFF(p_tdev), INT32},
189 	{"tty", "TTY", LJUST, longtname, POFF(p_tdev), INT32},
190 	LVAR("uaddr", "UADDR", 0, l_addr, KPTR, PRIx64),
191 	{"ucomm", "UCOMM", LJUST, ucomm},
192 	UID("uid", "UID", p_uid),
193 	LVAR("upr", "UPR", 0, l_usrpri, UCHAR, "u"),
194 	{"user", "USER", LJUST, uname},
195 	{"usrpri", "upr", ALIAS},
196 	{"utime", "UTIME", 0, putimeval, POFF(p_uutime_sec), TIMEVAL},
197 	{"vsize", "vsz", ALIAS},
198 	{"vsz", "VSZ", 0, vsize, 0, VSIZE},
199 	{"wchan", "WCHAN", LJUST|LWP, wchan},
200 	PVAR("xstat", "XSTAT", 0, p_xstat, USHORT, "x"),
201 /* "zzzz" end_sort */
202 	{""},
203 };
204 
205 void
206 showkey(void)
207 {
208 	VAR *v;
209 	int i;
210 	const char *p;
211 	const char *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 		(void)printf("%s%s", sep, p);
222 		sep = " ";
223 	}
224 	(void)printf("\n");
225 }
226 
227 static void
228 parsevarlist(const char *pp, struct varent **head, struct varent **tail)
229 {
230 	char *p;
231 
232 	/* dup to avoid zapping arguments, can't free because it
233 	   might contain a header. */
234 	p = strdup(pp);
235 
236 #define	FMTSEP	" \t,\n"
237 	while (p && *p) {
238 		char *cp;
239 		VAR *v;
240 		struct varent *vent;
241 
242 		while ((cp = strsep(&p, FMTSEP)) != NULL && *cp == '\0')
243 			/* void */;
244 		if (cp == NULL || !(v = findvar(cp)))
245 			continue;
246 		if ((vent = malloc(sizeof(struct varent))) == NULL)
247 			err(1, NULL);
248 		vent->var = v;
249 		vent->next = NULL;
250 		if (*head == NULL)
251 			*head = vent;
252 		else
253 			(*tail)->next = vent;
254 		*tail = vent;
255 	}
256 	if (!*head)
257 		errx(1, "no valid keywords");
258 }
259 
260 void
261 parsefmt(const char *p)
262 {
263 	static struct varent *vtail;
264 
265 	parsevarlist(p, &vhead, &vtail);
266 }
267 
268 void
269 parsesort(const char *p)
270 {
271 	static struct varent *sorttail;
272 
273 	parsevarlist(p, &sorthead, &sorttail);
274 }
275 
276 static VAR *
277 findvar(const char *p)
278 {
279 	VAR *v;
280 	char *hp;
281 
282 	hp = strchr(p, '=');
283 	if (hp)
284 		*hp++ = '\0';
285 
286 	v = bsearch(p, var, sizeof(var)/sizeof(VAR) - 1, sizeof(VAR), vcmp);
287 	if (v && v->flag & ALIAS)
288 		v = findvar(v->header);
289 	if (!v) {
290 		warnx("%s: keyword not found", p);
291 		eval = 1;
292 		return NULL;
293 	}
294 
295 	if (v && hp)
296 		v->header = hp;
297 	return v;
298 }
299 
300 static int
301 vcmp(const void *a, const void *b)
302 {
303         return strcmp(a, ((const VAR *)b)->name);
304 }
305