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.20 2005/06/29 01:25:10 dillon Exp $
  36  */
  37
  38 #include <sys/param.h>
  39 #include <sys/time.h>
  40 #include <sys/queue.h>
  41 #include <sys/resource.h>
  42 #include <sys/sysctl.h>
  43 #include <sys/ucred.h>
  44 #include <sys/user.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 proc, x)
  72 #define TOFF(x) offsetof(struct thread, x)
  73 #define EOFF(x) offsetof(struct eproc, x)
  74 #define UOFF(x) offsetof(struct usave, x)
  75 #define ROFF(x) offsetof(struct rusage, x)
  76
  77 #define UIDFMT  "u"
  78 #define UIDLEN  5
  79 #define PIDFMT  "d"
  80 #define PIDLEN  5
  81 #define USERLEN UT_NAMESIZE
  82
  83 static const VAR var[] = {
  84         {"%cpu", "%CPU", NULL, 0, pcpu, NULL, 4, 0, 0, NULL, NULL},
  85         {"%mem", "%MEM", NULL, 0, pmem, NULL, 4, 0, 0, NULL, NULL},
  86         {"acflag", "ACFLG", NULL, 0, pvar, NULL, 3, POFF(p_acflag), USHORT, "x",
  87                 NULL},
  88         {"acflg", "", "acflag", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
  89         {"batch", "BAT", NULL, 0, pest, NULL, 3, POFF(p_usdata.bsd4.origcpu), UINT, "d", NULL},
  90         {"blocked", "", "sigmask", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
  91         {"caught", "", "sigcatch", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
  92         {"command", "COMMAND", NULL, COMM|LJUST|USER, command, NULL, 16, 0, 0, NULL,
  93                 NULL},
  94         {"cpu", "CPU", NULL, 0, pest, NULL, 3, POFF(p_usdata.bsd4.estcpu), UINT, "d", NULL},
  95         {"lastcpu", "C", NULL, 0, pvar, NULL, 3, EOFF(e_cpuid), UINT, "d", NULL},
  96         {"cputime", "", "time", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
  97         {"f", "F", NULL, 0, pvar, NULL, 7, POFF(p_flag), INT, "x", NULL},
  98         {"flags", "", "f", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
  99 #if 0
 100         {"iac", "IAC",  NULL, 0, pvar, NULL, 4, POFF(p_usdata.bsd4.interactive), CHAR, PIDFMT,
 101                 NULL},
 102 #endif
 103         {"ignored", "", "sigignore", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
 104         {"inblk", "INBLK", NULL, USER, rvar, NULL, 4, ROFF(ru_inblock), LONG, "ld",
 105                 NULL},
 106         {"inblock", "", "inblk", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
 107         {"jobc", "JOBC", NULL, 0, evar, NULL, 4, EOFF(e_jobc), SHORT, "d", NULL},
 108         {"ktrace", "KTRACE", NULL, 0, pvar, NULL, 8, POFF(p_traceflag), INT, "x",
 109                 NULL},
 110         {"ktracep", "KTRACEP", NULL, 0, pvar, NULL, 8, POFF(p_tracep), LONG, "lx",
 111                 NULL},
 112         {"lim", "LIM", NULL, 0, maxrss, NULL, 5, 0, 0, NULL, NULL},
 113         {"login", "LOGIN", NULL, LJUST, logname, NULL, MAXLOGNAME-1, 0, 0, NULL,
 114                 NULL},
 115         {"logname", "", "login", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
 116         {"lstart", "STARTED", NULL, LJUST|USER, lstarted, NULL, 28, 0, 0, NULL, NULL},
 117         {"majflt", "MAJFLT", NULL, USER, rvar, NULL, 4, ROFF(ru_majflt), LONG, "ld",
 118                 NULL},
 119         {"minflt", "MINFLT", NULL, USER, rvar, NULL, 4, ROFF(ru_minflt), LONG, "ld",
 120                 NULL},
 121         {"msgrcv", "MSGRCV", NULL, USER, rvar, NULL, 4, ROFF(ru_msgrcv), LONG, "ld",
 122                 NULL},
 123         {"msgsnd", "MSGSND", NULL, USER, rvar, NULL, 4, ROFF(ru_msgsnd), LONG, "ld",
 124                 NULL},
 125         {"ni", "", "nice", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
 126         {"nice", "NI", NULL, 0, pnice, NULL, 3, 0, 0, NULL, NULL},
 127         {"nivcsw", "NIVCSW", NULL, USER, rvar, NULL, 5, ROFF(ru_nivcsw), LONG, "ld",
 128                 NULL},
 129         {"nsignals", "", "nsigs", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
 130         {"nsigs", "NSIGS", NULL, USER, rvar, NULL, 4, ROFF(ru_nsignals), LONG, "ld",
 131                 NULL},
 132         {"nswap", "NSWAP", NULL, USER, rvar, NULL, 4, ROFF(ru_nswap), LONG, "ld",
 133                 NULL},
 134         {"nvcsw", "NVCSW", NULL, USER, rvar, NULL, 5, ROFF(ru_nvcsw), LONG, "ld",
 135                 NULL},
 136         {"nwchan", "WCHAN", NULL, 0, tvar, NULL, 8, TOFF(td_wchan), KPTR, "lx", NULL},
 137         {"oublk", "OUBLK", NULL, USER, rvar, NULL, 4, ROFF(ru_oublock), LONG, "ld",
 138                 NULL},
 139         {"oublock", "", "oublk", 0, NULL, NULL, 0, 0 ,0, NULL, NULL},
 140         {"p_ru", "P_RU", NULL, 0, pvar, NULL, 6, POFF(p_ru), KPTR, "lx", NULL},
 141         {"paddr", "PADDR", NULL, 0, evar, NULL, 8, EOFF(e_paddr), KPTR, "lx", NULL},
 142         {"pagein", "PAGEIN", NULL, USER, pagein, NULL, 6, 0, 0, NULL, NULL},
 143         {"pcpu", "", "%cpu", 0, NULL, NULL, 0, 0,0, NULL, NULL},
 144         {"pending", "", "sig", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
 145         {"pgid", "PGID", NULL, 0, evar, NULL, PIDLEN, EOFF(e_pgid), UINT, PIDFMT,
 146                 NULL},
 147         {"pid", "PID", NULL, 0, pvar, NULL, PIDLEN, POFF(p_pid), UINT, PIDFMT,
 148                 NULL},
 149         {"pmem", "", "%mem", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
 150         {"ppid", "PPID", NULL, 0, evar, NULL, PIDLEN, EOFF(e_ppid), UINT, PIDFMT,
 151                 NULL},
 152         {"pri", "PRI", NULL, 0, pri, NULL, 3, 0, 0, NULL, NULL},
 153         {"re", "RE", NULL, 0, pvar, NULL, 3, POFF(p_swtime), UINT, "d", NULL},
 154         {"rgid", "RGID", NULL, 0, evar, NULL, UIDLEN, EOFF(e_ucred.cr_rgid),
 155                 UINT, UIDFMT, NULL},
 156         {"rlink", "RLINK", NULL, 0, pvar, NULL, 8, POFF(p_procq.tqe_prev), KPTR, "lx",
 157                 NULL},
 158         {"rss", "RSS", NULL, 0, p_rssize, NULL, 4, 0, 0, NULL, NULL},
 159         {"rssize", "", "rsz", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
 160         {"rsz", "RSZ", NULL, 0, rssize, NULL, 4, 0, 0, NULL, NULL},
 161         {"rtprio", "RTPRIO", NULL, 0, rtprior, NULL, 7, POFF(p_rtprio), 0, NULL, NULL},
 162         {"ruid", "RUID", NULL, 0, evar, NULL, UIDLEN, EOFF(e_ucred.cr_ruid),
 163                 UINT, UIDFMT, NULL},
 164         {"ruser", "RUSER", NULL, LJUST|DSIZ, runame, s_runame, USERLEN, 0, 0, NULL,
 165                 NULL},
 166         {"sess", "SESS", NULL, 0, evar, NULL, 6, EOFF(e_sess), KPTR, "lx", NULL},
 167         {"sig", "PENDING", NULL, 0, pvar, NULL, 8, POFF(p_siglist), INT, "x", NULL},
 168         {"sigcatch", "CAUGHT", NULL, 0, evar, NULL, 8, EOFF(e_procsig.ps_sigcatch),
 169                 UINT, "x", NULL},
 170         {"sigignore", "IGNORED", NULL, 0, evar, NULL, 8, EOFF(e_procsig.ps_sigignore),
 171                 UINT, "x", NULL},
 172         {"sigmask", "BLOCKED", NULL, 0, pvar, NULL, 8, POFF(p_sigmask), UINT, "x",
 173                 NULL},
 174         {"sl", "SL", NULL, 0, pvar, NULL, 3, POFF(p_slptime), UINT, "d", NULL},
 175         {"start", "STARTED", NULL, LJUST|USER, started, NULL, 7, 0, 0, NULL, NULL},
 176         {"stat", "", "state", 0, NULL, NULL, 0, 0, 0, NULL, NULL},
 177         {"state", "STAT", NULL, 0, state, NULL, 4, 0, 0, NULL, NULL},
 178         {"svgid", "SVGID", NULL, 0, evar, NULL, UIDLEN, EOFF(e_ucred.cr_svgid), UINT,
 179                 UIDFMT, NULL},
 180         {"svuid", "SVUID", NULL, 0, evar, NULL, UIDLEN, EOFF(e_ucred.cr_svuid), UINT,
 181                 UIDFMT, NULL},
 182         {"tdev", "TDEV", NULL, 0, tdev, NULL, 4, 0, 0, NULL, NULL},
 183         {"tdpri", "TDPRI", NULL, 0, tdpri, NULL, 5, 0, 0, NULL, NULL},
 184         {"time", "TIME", NULL, USER, cputime, NULL, 9, 0, 0, NULL, NULL},
 185         {"tpgid", "TPGID", NULL, 0, evar, NULL, 4, EOFF(e_tpgid), UINT, PIDFMT, NULL},
 186         {"tsess", "TSESS", NULL, 0, evar, NULL, 6, EOFF(e_tsess), KPTR, "lx", NULL},
 187         {"tsiz", "TSIZ", NULL, 0, tsize, NULL, 4, 0, 0, NULL, NULL},
 188         {"tt", "TT ", NULL, 0, tname, NULL, 4, 0, 0, NULL, NULL},
 189         {"tty", "TTY", NULL, LJUST, longtname, NULL, 8, 0, 0, NULL, NULL},
 190         {"ucomm", "UCOMM", NULL, LJUST, ucomm, NULL, MAXCOMLEN, 0, 0, NULL, NULL},
 191         {"uid", "UID", NULL, 0, evar, NULL, UIDLEN, EOFF(e_ucred.cr_uid),
 192                 UINT, UIDFMT, NULL},
 193         {"user", "USER", NULL, LJUST|DSIZ, uname, s_uname, USERLEN, 0, 0, NULL, NULL},
 194         {"vsize", "", "vsz", 0, 0, NULL, 0, 0, 0, NULL, NULL},
 195         {"vsz", "VSZ", NULL, 0, vsize, NULL, 5, 0, 0, NULL, NULL},
 196         {"wchan", "WCHAN", NULL, LJUST, wchan, NULL, 6, 0, 0, NULL, NULL},
 197         {"xstat", "XSTAT", NULL, 0, pvar, NULL, 4, POFF(p_xstat), USHORT, "x", NULL},
 198         {"", NULL, NULL, 0, NULL, NULL, 0, 0, 0, NULL, NULL},
 199 };
 200
 201 void
 202 showkey(void)
 203 {
 204         const VAR *v;
 205         int i;
 206         const char *p, *sep;
 207
 208         i = 0;
 209         sep = "";
 210         for (v = var; *(p = v->name); ++v) {
 211                 int len = strlen(p);
 212                 if (termwidth && (i += len + 1) > termwidth) {
 213                         i = len;
 214                         sep = "\n";
 215                 }
 216                 printf("%s%s", sep, p);
 217                 sep = " ";
 218         }
 219         printf("\n");
 220 }
 221
 222 void
 223 parsefmt(const char *fmt)
 224 {
 225         struct varent *vent;
 226         char *p, *op;
 227         const char *cp;
 228
 229         op = p = strdup(fmt);
 230
 231         if (op == NULL)
 232                 errx(1, "Not enough memory");
 233
 234 #define FMTSEP  " \t,\n"
 235         while (p != NULL && *p != '\0') {
 236                 while ((cp = strsep(&p, FMTSEP)) != NULL && *cp == '\0')
 237                         /* void */;
 238                 if (cp == NULL)
 239                         continue;
 240                 if ((vent = makevarent(cp)) == NULL)
 241                         continue;
 242                 STAILQ_INSERT_TAIL(&var_head, vent, link);
 243         }
 244         if (STAILQ_EMPTY(&var_head)) {
 245                 warnx("no valid keywords; valid keywords:");
 246                 showkey();
 247                 exit(1);
 248         }
 249
 250         free(op);
 251 }
 252
 253 static struct varent *
 254 makevarent(const char *p)
 255 {
 256         struct varent *vent = NULL;
 257         const VAR *v;
 258         VAR key;
 259         char *hp;
 260
 261         hp = strchr(p, '=');
 262         if (hp)
 263                 *hp++ = '\0';
 264
 265         key.name = p;
 266         v = bsearch(&key, var, sizeof(var)/sizeof(VAR) - 1, sizeof(VAR), vcmp);
 267
 268         if (v && v->alias) {
 269                 if (hp) {
 270                         warnx("%s: illegal keyword specification", p);
 271                         eval = 1;
 272                 }
 273                 parsefmt(v->alias);
 274                 return(NULL);
 275         }
 276         if (!v) {
 277                 warnx("%s: keyword not found", p);
 278                 eval = 1;
 279                 return(NULL);
 280         }
 281         if ((vent = malloc(sizeof(struct varent))) == NULL)
 282                 err(1, NULL);
 283         vent->var = v;
 284         vent->width = v->width;
 285         if (hp) {
 286                 vent->header = strdup(hp);
 287                 if (vent->header == NULL)
 288                         err(1, "Not enough memory");
 289         }
 290         else
 291                 vent->header = v->header;
 292         return (vent);
 293 }
 294
 295 static int
 296 vcmp(const void *a, const void *b)
 297 {
 298         return (strcmp(((const VAR *)a)->name, ((const VAR *)b)->name));
 299 }