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  * 4. 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
  30 #if 0
  31 #ifndef lint
  32 static char sccsid[] = "@(#)keyword.c   8.5 (Berkeley) 4/2/94";
  33 #endif /* not lint */
  34 #endif
  35 #include <sys/cdefs.h>
  36 __FBSDID("$FreeBSD$");
  37
  38 #include <sys/param.h>
  39 #include <sys/time.h>
  40 #include <sys/resource.h>
  41 #include <sys/proc.h>
  42 #include <sys/sysctl.h>
  43 #include <sys/user.h>
  44
  45 #include <err.h>
  46 #include <stddef.h>
  47 #include <stdio.h>
  48 #include <stdlib.h>
  49 #include <string.h>
  50 #include <libxo/xo.h>
  51
  52 #include "ps.h"
  53
  54 static VAR *findvar(char *, int, char **header);
  55 static int  vcmp(const void *, const void *);
  56
  57 /* Compute offset in common structures. */
  58 #define KOFF(x) offsetof(struct kinfo_proc, x)
  59 #define ROFF(x) offsetof(struct rusage, x)
  60
  61 #define LWPFMT  "d"
  62 #define NLWPFMT "d"
  63 #define UIDFMT  "u"
  64 #define PIDFMT  "d"
  65
  66 /* PLEASE KEEP THE TABLE BELOW SORTED ALPHABETICALLY!!! */
  67 static VAR var[] = {
  68         {"%cpu", "%CPU", NULL, "percent-cpu", 0, pcpu, 0, CHAR, NULL, 0},
  69         {"%mem", "%MEM", NULL, "percent-memory", 0, pmem, 0, CHAR, NULL, 0},
  70         {"acflag", "ACFLG", NULL, "accounting-flag", 0, kvar, KOFF(ki_acflag),
  71             USHORT, "x", 0},
  72         {"acflg", "", "acflag", NULL, 0, NULL, 0, CHAR, NULL, 0},
  73         {"args", "COMMAND", NULL, "arguments", COMM|LJUST|USER, arguments, 0,
  74             CHAR, NULL, 0},
  75         {"blocked", "", "sigmask", NULL, 0, NULL, 0, CHAR, NULL, 0},
  76         {"caught", "", "sigcatch", NULL, 0, NULL, 0, CHAR, NULL, 0},
  77         {"class", "CLASS", NULL, "login-class", LJUST, loginclass, 0, CHAR,
  78             NULL, 0},
  79         {"comm", "COMMAND", NULL, "command", LJUST, ucomm, 0, CHAR, NULL, 0},
  80         {"command", "COMMAND", NULL, "command", COMM|LJUST|USER, command, 0,
  81             CHAR, NULL, 0},
  82         {"cow", "COW", NULL, "copy-on-write-faults", 0, kvar, KOFF(ki_cow),
  83             UINT, "u", 0},
  84         {"cpu", "CPU", NULL, "cpu-usage", 0, kvar, KOFF(ki_estcpu), UINT, "d",
  85             0},
  86         {"cputime", "", "time", NULL, 0, NULL, 0, CHAR, NULL, 0},
  87         {"dsiz", "DSIZ", NULL, "data-size", 0, kvar, KOFF(ki_dsize), PGTOK,
  88             "ld", 0},
  89         {"egid", "", "gid", NULL, 0, NULL, 0, CHAR, NULL, 0},
  90         {"egroup", "", "group", NULL, 0, NULL, 0, CHAR, NULL, 0},
  91         {"emul", "EMUL", NULL, "emulation-envirnment", LJUST, emulname, 0,
  92             CHAR, NULL, 0},
  93         {"etime", "ELAPSED", NULL, "elapsed-time", USER, elapsed, 0, CHAR,
  94             NULL, 0},
  95         {"etimes", "ELAPSED", NULL, "elapsed-times", USER, elapseds, 0, CHAR,
  96             NULL, 0},
  97         {"euid", "", "uid", NULL, 0, NULL, 0, CHAR, NULL, 0},
  98         {"f", "F", NULL, "flags", 0, kvar, KOFF(ki_flag), LONG, "lx", 0},
  99         {"f2", "F2", NULL, "flags2", 0, kvar, KOFF(ki_flag2), INT, "08x", 0},
 100         {"fib", "FIB", NULL, "fib", 0, kvar, KOFF(ki_fibnum), INT, "d", 0},
 101         {"flags", "", "f", NULL, 0, NULL, 0, CHAR, NULL, 0},
 102         {"flags2", "", "f2", NULL, 0, NULL, 0, CHAR, NULL, 0},
 103         {"gid", "GID", NULL, "gid", 0, kvar, KOFF(ki_groups), UINT, UIDFMT, 0},
 104         {"group", "GROUP", NULL, "group", LJUST, egroupname, 0, CHAR, NULL, 0},
 105         {"ignored", "", "sigignore", NULL, 0, NULL, 0, CHAR, NULL, 0},
 106         {"inblk", "INBLK", NULL, "read-blocks", USER, rvar, ROFF(ru_inblock),
 107             LONG, "ld", 0},
 108         {"inblock", "", "inblk", NULL, 0, NULL, 0, CHAR, NULL, 0},
 109         {"jail", "JAIL", NULL, "jail-name", LJUST, jailname, 0, CHAR, NULL, 0},
 110         {"jid", "JID", NULL, "jail-id", 0, kvar, KOFF(ki_jid), INT, "d", 0},
 111         {"jobc", "JOBC", NULL, "job-control-count", 0, kvar, KOFF(ki_jobc),
 112             SHORT, "d", 0},
 113         {"ktrace", "KTRACE", NULL, "ktrace", 0, kvar, KOFF(ki_traceflag), INT,
 114             "x", 0},
 115         {"label", "LABEL", NULL, "label", LJUST, label, 0, CHAR, NULL, 0},
 116         {"lim", "LIM", NULL, "memory-limit", 0, maxrss, 0, CHAR, NULL, 0},
 117         {"lockname", "LOCK", NULL, "lock-name", LJUST, lockname, 0, CHAR, NULL,
 118             0},
 119         {"login", "LOGIN", NULL, "login-name", LJUST, logname, 0, CHAR, NULL,
 120             0},
 121         {"logname", "", "login", NULL, 0, NULL, 0, CHAR, NULL, 0},
 122         {"lstart", "STARTED", NULL, "start-time", LJUST|USER, lstarted, 0,
 123             CHAR, NULL, 0},
 124         {"lwp", "LWP", NULL, "thread-id", 0, kvar, KOFF(ki_tid), UINT,
 125             LWPFMT, 0},
 126         {"majflt", "MAJFLT", NULL, "major-faults", USER, rvar, ROFF(ru_majflt),
 127             LONG, "ld", 0},
 128         {"minflt", "MINFLT", NULL, "minor-faults", USER, rvar, ROFF(ru_minflt),
 129             LONG, "ld", 0},
 130         {"msgrcv", "MSGRCV", NULL, "received-messages", USER, rvar,
 131             ROFF(ru_msgrcv), LONG, "ld", 0},
 132         {"msgsnd", "MSGSND", NULL, "sent-messages", USER, rvar,
 133             ROFF(ru_msgsnd), LONG, "ld", 0},
 134         {"mwchan", "MWCHAN", NULL, "wait-channel", LJUST, mwchan, 0, CHAR,
 135             NULL, 0},
 136         {"ni", "", "nice", NULL, 0, NULL, 0, CHAR, NULL, 0},
 137         {"nice", "NI", NULL, "nice", 0, kvar, KOFF(ki_nice), CHAR, "d", 0},
 138         {"nivcsw", "NIVCSW", NULL, "involuntary-context-switches", USER, rvar,
 139             ROFF(ru_nivcsw), LONG, "ld", 0},
 140         {"nlwp", "NLWP", NULL, "threads", 0, kvar, KOFF(ki_numthreads), UINT,
 141             NLWPFMT, 0},
 142         {"nsignals", "", "nsigs", NULL, 0, NULL, 0, CHAR, NULL, 0},
 143         {"nsigs", "NSIGS", NULL, "signals-taken", USER, rvar,
 144             ROFF(ru_nsignals), LONG, "ld", 0},
 145         {"nswap", "NSWAP", NULL, "swaps", USER, rvar, ROFF(ru_nswap), LONG,
 146             "ld", 0},
 147         {"nvcsw", "NVCSW", NULL, "voluntary-context-switches", USER, rvar,
 148             ROFF(ru_nvcsw), LONG, "ld", 0},
 149         {"nwchan", "NWCHAN", NULL, "wait-channel-address", LJUST, nwchan, 0,
 150             CHAR, NULL, 0},
 151         {"oublk", "OUBLK", NULL, "written-blocks", USER, rvar,
 152             ROFF(ru_oublock), LONG, "ld", 0},
 153         {"oublock", "", "oublk", NULL, 0, NULL, 0, CHAR, NULL, 0},
 154         {"paddr", "PADDR", NULL, "process-address", 0, kvar, KOFF(ki_paddr),
 155             KPTR, "lx", 0},
 156         {"pagein", "PAGEIN", NULL, "pageins", USER, pagein, 0, CHAR, NULL, 0},
 157         {"pcpu", "", "%cpu", NULL, 0, NULL, 0, CHAR, NULL, 0},
 158         {"pending", "", "sig", NULL, 0, NULL, 0, CHAR, NULL, 0},
 159         {"pgid", "PGID", NULL, "process-group", 0, kvar, KOFF(ki_pgid), UINT,
 160             PIDFMT, 0},
 161         {"pid", "PID", NULL, "pid", 0, kvar, KOFF(ki_pid), UINT, PIDFMT, 0},
 162         {"pmem", "", "%mem", NULL, 0, NULL, 0, CHAR, NULL, 0},
 163         {"ppid", "PPID", NULL, "ppid", 0, kvar, KOFF(ki_ppid), UINT, PIDFMT, 0},
 164         {"pri", "PRI", NULL, "priority", 0, pri, 0, CHAR, NULL, 0},
 165         {"re", "RE", NULL, "residency-time", INF127, kvar, KOFF(ki_swtime),
 166             UINT, "d", 0},
 167         {"rgid", "RGID", NULL, "real-gid", 0, kvar, KOFF(ki_rgid), UINT,
 168             UIDFMT, 0},
 169         {"rgroup", "RGROUP", NULL, "real-group", LJUST, rgroupname, 0, CHAR,
 170             NULL, 0},
 171         {"rss", "RSS", NULL, "rss", 0, kvar, KOFF(ki_rssize), PGTOK, "ld", 0},
 172         {"rtprio", "RTPRIO", NULL, "realtime-priority", 0, priorityr,
 173             KOFF(ki_pri), CHAR, NULL, 0},
 174         {"ruid", "RUID", NULL, "real-uid", 0, kvar, KOFF(ki_ruid), UINT,
 175             UIDFMT, 0},
 176         {"ruser", "RUSER", NULL, "real-user", LJUST, runame, 0, CHAR, NULL, 0},
 177         {"sid", "SID", NULL, "sid", 0, kvar, KOFF(ki_sid), UINT, PIDFMT, 0},
 178         {"sig", "PENDING", NULL, "signals-pending", 0, kvar, KOFF(ki_siglist),
 179             INT, "x", 0},
 180         {"sigcatch", "CAUGHT", NULL, "signals-caught", 0, kvar,
 181             KOFF(ki_sigcatch), UINT, "x", 0},
 182         {"sigignore", "IGNORED", NULL, "signals-ignored", 0, kvar,
 183             KOFF(ki_sigignore), UINT, "x", 0},
 184         {"sigmask", "BLOCKED", NULL, "signal-mask", 0, kvar, KOFF(ki_sigmask),
 185             UINT, "x", 0},
 186         {"sl", "SL", NULL, "sleep-time", INF127, kvar, KOFF(ki_slptime), UINT,
 187             "d", 0},
 188         {"ssiz", "SSIZ", NULL, "stack-size", 0, kvar, KOFF(ki_ssize), PGTOK,
 189             "ld", 0},
 190         {"start", "STARTED", NULL, "start-time", LJUST|USER, started, 0, CHAR,
 191             NULL, 0},
 192         {"stat", "", "state", NULL, 0, NULL, 0, CHAR, NULL, 0},
 193         {"state", "STAT", NULL, "state", LJUST, state, 0, CHAR, NULL, 0},
 194         {"svgid", "SVGID", NULL, "saved-gid", 0, kvar, KOFF(ki_svgid), UINT,
 195             UIDFMT, 0},
 196         {"svuid", "SVUID", NULL, "saved-uid", 0, kvar, KOFF(ki_svuid), UINT,
 197             UIDFMT, 0},
 198         {"systime", "SYSTIME", NULL, "system-time", USER, systime, 0, CHAR,
 199             NULL, 0},
 200         {"tdaddr", "TDADDR", NULL, "thread-address", 0, kvar, KOFF(ki_tdaddr),
 201             KPTR, "lx", 0},
 202         {"tdev", "TDEV", NULL, "terminal-device", 0, tdev, 0, CHAR, NULL, 0},
 203         {"tdnam", "", "tdname", NULL, 0, NULL, 0, CHAR, NULL, 0},
 204         {"tdname", "TDNAME", NULL, "thread-name", LJUST, tdnam, 0, CHAR,
 205             NULL, 0},
 206         {"tid", "", "lwp", NULL, 0, NULL, 0, CHAR, NULL, 0},
 207         {"time", "TIME", NULL, "cpu-time", USER, cputime, 0, CHAR, NULL, 0},
 208         {"tpgid", "TPGID", NULL, "terminal-process-gid", 0, kvar,
 209             KOFF(ki_tpgid), UINT, PIDFMT, 0},
 210         {"tracer", "TRACER", NULL, "tracer", 0, kvar, KOFF(ki_tracer), UINT,
 211             PIDFMT, 0},
 212         {"tsid", "TSID", NULL, "terminal-sid", 0, kvar, KOFF(ki_tsid), UINT,
 213             PIDFMT, 0},
 214         {"tsiz", "TSIZ", NULL, "text-size", 0, kvar, KOFF(ki_tsize), PGTOK,
 215             "ld", 0},
 216         {"tt", "TT ", NULL, "terminal-name", 0, tname, 0, CHAR, NULL, 0},
 217         {"tty", "TTY", NULL, "tty", LJUST, longtname, 0, CHAR, NULL, 0},
 218         {"ucomm", "UCOMM", NULL, "accounting-name", LJUST, ucomm, 0, CHAR,
 219             NULL, 0},
 220         {"uid", "UID", NULL, "uid", 0, kvar, KOFF(ki_uid), UINT, UIDFMT, 0},
 221         {"upr", "UPR", NULL, "user-priority", 0, upr, 0, CHAR, NULL, 0},
 222         {"uprocp", "UPROCP", NULL, "process-address", 0, kvar, KOFF(ki_paddr),
 223             KPTR, "lx", 0},
 224         {"user", "USER", NULL, "user", LJUST, uname, 0, CHAR, NULL, 0},
 225         {"usertime", "USERTIME", NULL, "user-time", USER, usertime, 0, CHAR,
 226             NULL, 0},
 227         {"usrpri", "", "upr", NULL, 0, NULL, 0, CHAR, NULL, 0},
 228         {"vmaddr", "VMADDR", NULL, "vmspace-address", 0, kvar, KOFF(ki_vmspace),
 229             KPTR, "lx", 0},
 230         {"vsize", "", "vsz", NULL, 0, NULL, 0, CHAR, NULL, 0},
 231         {"vsz", "VSZ", NULL, "virtual-size", 0, vsize, 0, CHAR, NULL, 0},
 232         {"wchan", "WCHAN", NULL, "wait-channel", LJUST, wchan, 0, CHAR, NULL,
 233             0},
 234         {"xstat", "XSTAT", NULL, "exit-status", 0, kvar, KOFF(ki_xstat),
 235             USHORT, "x", 0},
 236         {"", NULL, NULL, NULL, 0, NULL, 0, CHAR, NULL, 0},
 237 };
 238
 239 void
 240 showkey(void)
 241 {
 242         VAR *v;
 243         int i;
 244         const char *p, *sep;
 245
 246         i = 0;
 247         sep = "";
 248         xo_open_list("key");
 249         for (v = var; *(p = v->name); ++v) {
 250                 int len = strlen(p);
 251                 if (termwidth && (i += len + 1) > termwidth) {
 252                         i = len;
 253                         sep = "\n";
 254                 }
 255                 xo_emit("{P:/%s}{l:key/%s}", sep, p);
 256                 sep = " ";
 257         }
 258         xo_emit("\n");
 259         xo_close_list("key");
 260         xo_finish();
 261 }
 262
 263 void
 264 parsefmt(const char *p, int user)
 265 {
 266         char *tempstr, *tempstr1;
 267
 268 #define         FMTSEP  " \t,\n"
 269         tempstr1 = tempstr = strdup(p);
 270         while (tempstr && *tempstr) {
 271                 char *cp, *hp;
 272                 VAR *v;
 273                 struct varent *vent;
 274
 275                 /*
 276                  * If an item contains an equals sign, it specifies a column
 277                  * header, may contain embedded separator characters and
 278                  * is always the last item.
 279                  */
 280                 if (tempstr[strcspn(tempstr, "="FMTSEP)] != '=')
 281                         while ((cp = strsep(&tempstr, FMTSEP)) != NULL &&
 282                             *cp == '\0')
 283                                 /* void */;
 284                 else {
 285                         cp = tempstr;
 286                         tempstr = NULL;
 287                 }
 288                 if (cp == NULL || !(v = findvar(cp, user, &hp)))
 289                         continue;
 290                 if (!user) {
 291                         /*
 292                          * If the user is NOT adding this field manually,
 293                          * get on with our lives if this VAR is already
 294                          * represented in the list.
 295                          */
 296                         vent = find_varentry(v);
 297                         if (vent != NULL)
 298                                 continue;
 299                 }
 300                 if ((vent = malloc(sizeof(struct varent))) == NULL)
 301                         errx(1, "malloc failed");
 302                 vent->header = v->header;
 303                 if (hp) {
 304                         hp = strdup(hp);
 305                         if (hp)
 306                                 vent->header = hp;
 307                 }
 308                 vent->var = malloc(sizeof(*vent->var));
 309                 if (vent->var == NULL)
 310                         errx(1, "malloc failed");
 311                 memcpy(vent->var, v, sizeof(*vent->var));
 312                 STAILQ_INSERT_TAIL(&varlist, vent, next_ve);
 313         }
 314         free(tempstr1);
 315         if (STAILQ_EMPTY(&varlist)) {
 316                 warnx("no valid keywords; valid keywords:");
 317                 showkey();
 318                 exit(1);
 319         }
 320 }
 321
 322 static VAR *
 323 findvar(char *p, int user, char **header)
 324 {
 325         size_t rflen;
 326         VAR *v, key;
 327         char *hp, *realfmt;
 328
 329         hp = strchr(p, '=');
 330         if (hp)
 331                 *hp++ = '\0';
 332
 333         key.name = p;
 334         v = bsearch(&key, var, sizeof(var)/sizeof(VAR) - 1, sizeof(VAR), vcmp);
 335
 336         if (v && v->alias) {
 337                 /*
 338                  * If the user specified an alternate-header for this
 339                  * (aliased) format-name, then we need to copy that
 340                  * alternate-header when making the recursive call to
 341                  * process the alias.
 342                  */
 343                 if (hp == NULL)
 344                         parsefmt(v->alias, user);
 345                 else {
 346                         /*
 347                          * XXX - This processing will not be correct for
 348                          * any alias which expands into a list of format
 349                          * keywords.  Presently there are no aliases
 350                          * which do that.
 351                          */
 352                         rflen = strlen(v->alias) + strlen(hp) + 2;
 353                         realfmt = malloc(rflen);
 354                         if (realfmt == NULL)
 355                                 errx(1, "malloc failed");
 356                         snprintf(realfmt, rflen, "%s=%s", v->alias, hp);
 357                         parsefmt(realfmt, user);
 358                         free(realfmt);
 359                 }
 360                 return ((VAR *)NULL);
 361         }
 362         if (!v) {
 363                 warnx("%s: keyword not found", p);
 364                 eval = 1;
 365         }
 366         if (header)
 367                 *header = hp;
 368         return (v);
 369 }
 370
 371 static int
 372 vcmp(const void *a, const void *b)
 373 {
 374         return (strcmp(((const VAR *)a)->name, ((const VAR *)b)->name));
 375 }