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