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