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