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. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * @(#)keyword.c 8.5 (Berkeley) 4/2/94
30 * $FreeBSD: src/bin/ps/keyword.c,v 1.24.2.3 2002/10/10 20:05:32 jmallett Exp $
31 */
32
33 #include <sys/kinfo.h>
34 #include <sys/param.h>
35 #include <sys/time.h>
36 #include <sys/queue.h>
37 #include <sys/resource.h>
38 #include <sys/sysctl.h>
39 #include <sys/ucred.h>
40
41 #include <err.h>
42 #include <errno.h>
43 #include <stddef.h>
44 #include <stdio.h>
45 #include <stdlib.h>
46 #include <string.h>
47
48 #include "ps.h"
49
50 static struct varent *makevarent(const char *);
51 static int vcmp(const void *, const void *);
52
53 struct varent_head var_head = STAILQ_HEAD_INITIALIZER(var_head);
54
55 #ifdef NOTINUSE
56 int utime(), stime(), ixrss(), idrss(), isrss();
57 {{"utime"}, "UTIME", USER, utime, NULL, 4},
58 {{"stime"}, "STIME", USER, stime, NULL, 4},
59 {{"ixrss"}, "IXRSS", USER, ixrss, NULL, 4},
60 {{"idrss"}, "IDRSS", USER, idrss, NULL, 4},
61 {{"isrss"}, "ISRSS", USER, isrss, NULL, 4},
62 #endif
63
64 /* Compute offset in common structures. */
65 #define POFF(x) offsetof(struct kinfo_proc, kp_##x)
66 #define LPOFF(x) offsetof(struct kinfo_lwp, kl_##x)
67 #define ROFF(x) offsetof(struct rusage, x)
68
69 #define UIDFMT "u"
70 #define UIDLEN 5
71 #define PIDFMT "d"
72 #define PIDLEN 6
73 #define USERLEN (MAXLOGNAME-1)
74
75 static const VAR var[] = {
76 {"%cpu", "%CPU", NULL, 0, pcpu, NULL, 4, 0, 0, NULL, NULL},
77 {"%mem", "%MEM", NULL, 0, pmem, NULL, 4, 0, 0, NULL, NULL},
78 {"acflag", "ACFLG", NULL, 0, pvar, NULL, 3, POFF(acflag), USHORT, "x",
79 NULL},
80 {"acflg", "", "acflag", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
81 {"args", "", "command", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
82 {"batch", "BAT", NULL, 0, lpest, NULL, 3, LPOFF(origcpu), UINT, "d", NULL},
83 {"blocked", "", "sigmask", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
84 {"caught", "", "sigcatch", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
85 {"comm", "", "ucomm", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
86 {"command", "COMMAND", NULL, COMM|LJUST|USER, command, NULL, 16, 0, 0, NULL,
87 NULL},
88 {"cpu", "CPU", NULL, 0, lpest, NULL, 3, LPOFF(estcpu), UINT, "d", NULL},
89 {"cputime", "", "time", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
90 {"f", "F", NULL, 0, pvar, NULL, 7, POFF(flags), INT, "x", NULL},
91 {"flags", "", "f", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
92 #if 0
93 {"iac", "IAC", NULL, 0, pvar, NULL, 4, POFF(p_usdata.bsd4.interactive), CHAR, PIDFMT,
94 NULL},
95 #endif
96 {"ignored", "", "sigignore", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
97 {"inblk", "INBLK", NULL, USER, rvar, NULL, 4, ROFF(ru_inblock), LONG, "ld",
98 NULL},
99 {"inblock", "", "inblk", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
100 {"jail", "JAIL", NULL, 0, pvar, NULL, 3, POFF(jailid), INT, "d", NULL},
101 {"jobc", "JOBC", NULL, 0, pvar, NULL, 4, POFF(jobc), SHORT, "d", NULL},
102 {"ktrace", "KTRACE", NULL, 0, pvar, NULL, 8, POFF(traceflag), INT, "x",
103 NULL},
104 #if 0
105 {"ktracep", "KTRACEP", NULL, 0, pvar, NULL, 8, POFF(p_tracenode), LONG, "lx",
106 NULL},
107 #endif
108 {"lastcpu", "C", NULL, 0, lpvar, NULL, 3, LPOFF(cpuid), UINT, "d", NULL},
109 {"lim", "LIM", NULL, 0, maxrss, NULL, 5, 0, 0, NULL, NULL},
110 {"login", "LOGIN", NULL, LJUST, logname, NULL, MAXLOGNAME-1, 0, 0, NULL,
111 NULL},
112 {"logname", "", "login", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
113 {"lstart", "STARTED", NULL, LJUST|USER, lstarted, NULL, 28, 0, 0, NULL, NULL},
114 {"majflt", "MAJFLT", NULL, USER, rvar, NULL, 4, ROFF(ru_majflt), LONG, "ld",
115 NULL},
116 {"minflt", "MINFLT", NULL, USER, rvar, NULL, 4, ROFF(ru_minflt), LONG, "ld",
117 NULL},
118 {"msgrcv", "MSGRCV", NULL, USER, rvar, NULL, 4, ROFF(ru_msgrcv), LONG, "ld",
119 NULL},
120 {"msgsnd", "MSGSND", NULL, USER, rvar, NULL, 4, ROFF(ru_msgsnd), LONG, "ld",
121 NULL},
122 {"ni", "", "nice", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
123 {"nice", "NI", NULL, 0, pnice, NULL, 3, 0, 0, NULL, NULL},
124 {"nivcsw", "NIVCSW", NULL, USER, rvar, NULL, 5, ROFF(ru_nivcsw), LONG, "ld",
125 NULL},
126 {"nlwp", "NLWP", NULL, 0, pvar, NULL, 4, POFF(nthreads), INT, "d",
127 NULL},
128 {"nsignals", "", "nsigs", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
129 {"nsigs", "NSIGS", NULL, USER, rvar, NULL, 4, ROFF(ru_nsignals), LONG, "ld",
130 NULL},
131 {"nswap", "NSWAP", NULL, USER, rvar, NULL, 4, ROFF(ru_nswap), LONG, "ld",
132 NULL},
133 {"nvcsw", "NVCSW", NULL, USER, rvar, NULL, 5, ROFF(ru_nvcsw), LONG, "ld",
134 NULL},
135 {"nwchan", "WCHAN", NULL, 0, lpvar, NULL, 8, LPOFF(wchan), KPTR, "lx", NULL},
136 {"oublk", "OUBLK", NULL, USER, rvar, NULL, 4, ROFF(ru_oublock), LONG, "ld",
137 NULL},
138 {"oublock", "", "oublk", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
139 {"p_ru", "P_RU", NULL, 0, pvar, NULL, 6, POFF(ru), KPTR, "lx", NULL},
140 {"paddr", "PADDR", NULL, 0, pvar, NULL, 8, POFF(paddr), KPTR, "lx", NULL},
141 {"pagein", "PAGEIN", NULL, USER, pagein, NULL, 6, 0, 0, NULL, NULL},
142 {"pcpu", "", "%cpu", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
143 {"pending", "", "sig", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
144 {"pgid", "PGID", NULL, 0, pvar, NULL, PIDLEN, POFF(pgid), UINT, PIDFMT,
145 NULL},
146 {"pid", "PID", NULL, 0, pvar, NULL, PIDLEN, POFF(pid), UINT, PIDFMT,
147 NULL},
148 {"pmem", "", "%mem", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
149 {"ppid", "PPID", NULL, 0, pvar, NULL, PIDLEN, POFF(ppid), UINT, PIDFMT,
150 NULL},
151 {"pri", "PRI", NULL, 0, pri, NULL, 3, 0, 0, NULL, NULL},
152 {"re", "RE", NULL, 0, lpvar, NULL, 3, POFF(swtime), UINT, "d", NULL},
153 {"rgid", "RGID", NULL, 0, pvar, NULL, UIDLEN, POFF(rgid),
154 UINT, UIDFMT, NULL},
155 #if 0
156 {"rlink", "RLINK", NULL, 0, pvar, NULL, 8, POFF(p_lwp.lwp_procq.tqe_prev), KPTR, "lx",
157 NULL},
158 #endif
159 {"rss", "RSS", NULL, 0, p_rssize, NULL, 6, 0, 0, NULL, NULL},
160 {"rssize", "", "rsz", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
161 {"rsz", "RSZ", NULL, 0, rssize, NULL, 6, 0, 0, NULL, NULL},
162 {"rtprio", "RTPRIO", NULL, 0, rtprior, NULL, 7, 0, 0, NULL, NULL},
163 {"ruid", "RUID", NULL, 0, pvar, NULL, UIDLEN, POFF(ruid),
164 UINT, UIDFMT, NULL},
165 {"ruser", "RUSER", NULL, LJUST|DSIZ, runame, s_runame, USERLEN, 0, 0, NULL,
166 NULL},
167 {"sess", "SESS", NULL, 0, pvar, NULL, 6, POFF(sid), UINT, PIDFMT, NULL},
168 {"sig", "PENDING", NULL, 0, pvar, NULL, 8, POFF(siglist), INT, "x", NULL},
169 {"sigcatch", "CAUGHT", NULL, 0, pvar, NULL, 8, POFF(sigcatch),
170 UINT, "x", NULL},
171 {"sigignore", "IGNORED", NULL, 0, pvar, NULL, 8, POFF(sigignore),
172 UINT, "x", NULL},
173 {"sigmask", "BLOCKED", NULL, 0, lpvar, NULL, 8, LPOFF(sigmask), UINT, "x",
174 NULL},
175 {"sl", "SL", NULL, 0, lpvar, NULL, 3, LPOFF(slptime), UINT, "d", NULL},
176 {"start", "STARTED", NULL, LJUST|USER, started, NULL, 7, 0, 0, NULL, NULL},
177 {"stat", "", "state", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
178 {"state", "STAT ", NULL, 0, state, NULL, 6, 0, 0, NULL, NULL},
179 {"svgid", "SVGID", NULL, 0, pvar, NULL, UIDLEN, POFF(svgid), UINT,
180 UIDFMT, NULL},
181 {"svuid", "SVUID", NULL, 0, pvar, NULL, UIDLEN, POFF(svuid), UINT,
182 UIDFMT, NULL},
183 {"tdev", "TDEV", NULL, 0, tdev, NULL, 4, 0, 0, NULL, NULL},
184 {"tdpri", "TDPRI", NULL, 0, tdpri, NULL, 5, 0, 0, NULL, NULL},
185 {"tid", "TID", NULL, 0, lpvar, NULL, PIDLEN, LPOFF(tid), UINT, PIDFMT,
186 NULL},
187 {"time", "TIME", NULL, USER, cputime, NULL, 9, 0, 0, NULL, NULL},
188 {"tpgid", "TPGID", NULL, 0, pvar, NULL, 4, POFF(tpgid), UINT, PIDFMT, NULL},
189 {"tsess", "TSESS", NULL, 0, pvar, NULL, 6, POFF(tsid), UINT, PIDFMT, NULL},
190 {"tsig", "PENDING", NULL, 0, lpvar, NULL, 8, LPOFF(siglist), INT, "x", NULL},
191 {"tsiz", "TSIZ", NULL, 0, tsize, NULL, 4, 0, 0, NULL, NULL},
192 {"tt", "TT ", NULL, 0, tname, NULL, 2, 0, 0, NULL, NULL},
193 {"tty", "TTY", NULL, LJUST, longtname, NULL, 8, 0, 0, NULL, NULL},
194 {"ucomm", "UCOMM", NULL, LJUST, ucomm, NULL, MAXCOMLEN, 0, 0, NULL, NULL},
195 {"uid", "UID", NULL, 0, pvar, NULL, UIDLEN, POFF(uid),
196 UINT, UIDFMT, NULL},
197 {"user", "USER", NULL, LJUST|DSIZ, uname, s_uname, USERLEN, 0, 0, NULL, NULL},
198 {"vsize", "", "vsz", 0, 0, NULL, 0, 0, 0, NULL, NULL},
199 {"vsz", "VSZ", NULL, 0, vsize, NULL, 6, 0, 0, NULL, NULL},
200 {"wchan", "WCHAN", NULL, LJUST, wchan, NULL, WMESGLEN, 0, 0, NULL, NULL},
201 {"xstat", "XSTAT", NULL, 0, pvar, NULL, 7, POFF(exitstat), USHORT, "x", NULL},
202 {"", NULL, NULL, 0, NULL, NULL, 0, 0, 0, NULL, NULL},
203 };
204
205 void
showkey(void)206 showkey(void)
207 {
208 const VAR *v;
209 int i;
210 const char *p, *sep;
211
212 i = 0;
213 sep = "";
214 for (v = var; *(p = v->name); ++v) {
215 int len = strlen(p);
216 if (termwidth && (i += len + 1) > termwidth) {
217 i = len;
218 sep = "\n";
219 }
220 printf("%s%s", sep, p);
221 sep = " ";
222 }
223 printf("\n");
224 }
225
226 void
parsefmt(const char * fmt)227 parsefmt(const char *fmt)
228 {
229 struct varent *vent;
230 char *p, *op;
231 const char *cp;
232
233 op = p = strdup(fmt);
234
235 if (op == NULL)
236 errx(1, "Not enough memory");
237
238 #define FMTSEP " \t,\n"
239 while (p != NULL && *p != '\0') {
240 while ((cp = strsep(&p, FMTSEP)) != NULL && *cp == '\0')
241 /* void */;
242 if (cp == NULL)
243 continue;
244 if ((vent = makevarent(cp)) == NULL)
245 continue;
246 STAILQ_INSERT_TAIL(&var_head, vent, link);
247 }
248 if (STAILQ_EMPTY(&var_head)) {
249 warnx("no valid keywords; valid keywords:");
250 showkey();
251 exit(1);
252 }
253
254 free(op);
255 }
256
257 /*
258 * Insert TID column after PID one in selected output format.
259 */
260 void
insert_tid_in_fmt(void)261 insert_tid_in_fmt(void)
262 {
263 struct varent *tidvent;
264 struct varent *vent;
265
266 if ((tidvent = makevarent("tid")) == NULL)
267 errx(1, "Not enough memory");
268
269 STAILQ_FOREACH(vent, &var_head, link) {
270 if (strcmp(vent->var->name, "pid") == 0) {
271 STAILQ_INSERT_AFTER(&var_head, vent, tidvent, link);
272 break;
273 }
274 }
275 }
276
277 static struct varent *
makevarent(const char * p)278 makevarent(const char *p)
279 {
280 struct varent *vent = NULL;
281 const VAR *v;
282 VAR key;
283 char *hp;
284
285 hp = strchr(p, '=');
286 if (hp)
287 *hp++ = '\0';
288
289 aliased:
290 key.name = p;
291 v = bsearch(&key, var, sizeof(var)/sizeof(VAR) - 1, sizeof(VAR), vcmp);
292
293 if (v && v->alias) {
294 p = v->alias;
295 if (hp == NULL && v->header[0] != '\0')
296 hp = strdup(v->header);
297 goto aliased;
298 }
299 if (!v) {
300 warnx("%s: keyword not found", p);
301 eval = 1;
302 return(NULL);
303 }
304 if ((vent = malloc(sizeof(struct varent))) == NULL)
305 err(1, NULL);
306 vent->var = v;
307 vent->width = v->width;
308 if (hp) {
309 vent->header = strdup(hp);
310 if (vent->header == NULL)
311 err(1, "Not enough memory");
312 }
313 else
314 vent->header = v->header;
315 return (vent);
316 }
317
318 static int
vcmp(const void * a,const void * b)319 vcmp(const void *a, const void *b)
320 {
321 return (strcmp(((const VAR *)a)->name, ((const VAR *)b)->name));
322 }
323