keyword.c revision 110411
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 34#if 0 35#ifndef lint 36static char sccsid[] = "@(#)keyword.c 8.5 (Berkeley) 4/2/94"; 37#endif /* not lint */ 38#endif 39#include <sys/cdefs.h> 40__FBSDID("$FreeBSD: head/bin/ps/keyword.c 110411 2003-02-05 19:22:39Z sobomax $"); 41 42#include <sys/param.h> 43#include <sys/time.h> 44#include <sys/resource.h> 45#include <sys/proc.h> 46#include <sys/sysctl.h> 47#include <sys/user.h> 48 49#include <err.h> 50#include <stddef.h> 51#include <stdio.h> 52#include <stdlib.h> 53#include <string.h> 54 55#include "ps.h" 56 57static VAR *findvar(char *, int, char **header); 58static int vcmp(const void *, const void *); 59 60/* Compute offset in common structures. */ 61#define KOFF(x) offsetof(struct kinfo_proc, x) 62#define ROFF(x) offsetof(struct rusage, x) 63 64#define UIDFMT "u" 65#define UIDLEN 5 66#define PIDFMT "d" 67#define PIDLEN 5 68#define USERLEN (MAXLOGNAME - 1) 69 70/* PLEASE KEEP THE TABLE BELOW SORTED ALPHABETICALLY!!! */ 71static VAR var[] = { 72 {"%cpu", "%CPU", NULL, 0, pcpu, NULL, 4, 0, CHAR, NULL, 0}, 73 {"%mem", "%MEM", NULL, 0, pmem, NULL, 4, 0, CHAR, NULL, 0}, 74 {"acflag", "ACFLG", NULL, 0, kvar, NULL, 3, KOFF(ki_acflag), USHORT, 75 "x", 0}, 76 {"acflg", "", "acflag", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 77 {"args", "COMMAND", NULL, COMM|LJUST|USER, arguments, NULL, 16, 0, 78 CHAR, NULL, 0}, 79 {"blocked", "", "sigmask", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 80 {"caught", "", "sigcatch", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 81 {"comm", "COMMAND", NULL, LJUST, ucomm, NULL, MAXCOMLEN, 0, CHAR, 82 NULL, 0}, 83 {"command", "COMMAND", NULL, COMM|LJUST|USER, command, NULL, 16, 0, 84 CHAR, NULL, 0}, 85 {"cpu", "CPU", NULL, 0, kvar, NULL, 3, KOFF(ki_estcpu), UINT, "d", 86 0}, 87 {"cputime", "", "time", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 88 {"etime", "ELAPSED", NULL, USER, elapsed, NULL, 12, 0, CHAR, NULL, 0}, 89 {"f", "F", NULL, 0, kvar, NULL, 7, KOFF(ki_flag), INT, "x", 0}, 90 {"flags", "", "f", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 91 {"ignored", "", "sigignore", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 92 {"inblk", "INBLK", NULL, USER, rvar, NULL, 4, ROFF(ru_inblock), LONG, 93 "ld", 0}, 94 {"inblock", "", "inblk", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 95 {"jobc", "JOBC", NULL, 0, kvar, NULL, 4, KOFF(ki_jobc), SHORT, "d", 96 0}, 97 {"ktrace", "KTRACE", NULL, 0, kvar, NULL, 8, KOFF(ki_traceflag), INT, 98 "x", 0}, 99 {"label", "LABEL", NULL, LJUST|DSIZ, label, s_label, SHRT_MAX, 0, CHAR, 100 NULL, 0}, 101 {"lim", "LIM", NULL, 0, maxrss, NULL, 5, 0, CHAR, NULL, 0}, 102 {"lockname", "LOCK", NULL, LJUST, lockname, NULL, 6, 0, CHAR, NULL, 103 0}, 104 {"login", "LOGIN", NULL, LJUST, logname, NULL, MAXLOGNAME-1, 0, CHAR, 105 NULL, 0}, 106 {"logname", "", "login", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 107 {"lstart", "STARTED", NULL, LJUST|USER, lstarted, NULL, 28, 0, CHAR, 108 NULL, 0}, 109 {"majflt", "MAJFLT", NULL, USER, rvar, NULL, 4, ROFF(ru_majflt), 110 LONG, "ld", 0}, 111 {"minflt", "MINFLT", NULL, USER, rvar, NULL, 4, ROFF(ru_minflt), 112 LONG, "ld", 0}, 113 {"msgrcv", "MSGRCV", NULL, USER, rvar, NULL, 4, ROFF(ru_msgrcv), 114 LONG, "ld", 0}, 115 {"msgsnd", "MSGSND", NULL, USER, rvar, NULL, 4, ROFF(ru_msgsnd), 116 LONG, "ld", 0}, 117 {"mwchan", "MWCHAN", NULL, LJUST, mwchan, NULL, 6, 0, CHAR, NULL, 0}, 118 {"ni", "", "nice", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 119 {"nice", "NI", NULL, 0, kvar, NULL, 2, KOFF(ki_nice), CHAR, "d", 120 0}, 121 {"nivcsw", "NIVCSW", NULL, USER, rvar, NULL, 5, ROFF(ru_nivcsw), 122 LONG, "ld", 0}, 123 {"nsignals", "", "nsigs", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 124 {"nsigs", "NSIGS", NULL, USER, rvar, NULL, 4, ROFF(ru_nsignals), 125 LONG, "ld", 0}, 126 {"nswap", "NSWAP", NULL, USER, rvar, NULL, 4, ROFF(ru_nswap), 127 LONG, "ld", 0}, 128 {"nvcsw", "NVCSW", NULL, USER, rvar, NULL, 5, ROFF(ru_nvcsw), 129 LONG, "ld", 0}, 130 {"oublk", "OUBLK", NULL, USER, rvar, NULL, 4, ROFF(ru_oublock), 131 LONG, "ld", 0}, 132 {"oublock", "", "oublk", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 133 {"paddr", "PADDR", NULL, 0, kvar, NULL, 8, KOFF(ki_paddr), KPTR, 134 "lx", 0}, 135 {"pagein", "PAGEIN", NULL, USER, pagein, NULL, 6, 0, CHAR, NULL, 0}, 136 {"pcpu", "", "%cpu", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 137 {"pending", "", "sig", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 138 {"pgid", "PGID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_pgid), UINT, 139 PIDFMT, 0}, 140 {"pid", "PID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_pid), UINT, 141 PIDFMT, 0}, 142 {"pmem", "", "%mem", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 143 {"ppid", "PPID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_ppid), UINT, 144 PIDFMT, 0}, 145 {"pri", "PRI", NULL, 0, pri, NULL, 3, 0, CHAR, NULL, 0}, 146 {"re", "RE", NULL, 0, kvar, NULL, 3, KOFF(ki_swtime), UINT, "d", 147 0}, 148 {"rgid", "RGID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_rgid), 149 UINT, UIDFMT, 0}, 150 {"rgroup", "RGROUP", NULL, LJUST|DSIZ, rgroupname, s_rgroupname, 151 USERLEN, 0, CHAR, NULL, 0}, 152 {"rss", "RSS", NULL, 0, kvar, NULL, 4, KOFF(ki_rssize), PGTOK, "ld", 0}, 153 {"rtprio", "RTPRIO", NULL, 0, priorityr, NULL, 7, KOFF(ki_pri), CHAR, 154 NULL, 0}, 155 {"ruid", "RUID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_ruid), 156 UINT, UIDFMT, 0}, 157 {"ruser", "RUSER", NULL, LJUST|DSIZ, runame, s_runame, USERLEN, 158 0, CHAR, NULL, 0}, 159 {"sid", "SID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_sid), UINT, 160 PIDFMT, 0}, 161 {"sig", "PENDING", NULL, 0, kvar, NULL, 8, KOFF(ki_siglist), INT, 162 "x", 0}, 163 {"sigcatch", "CAUGHT", NULL, 0, kvar, NULL, 8, KOFF(ki_sigcatch), 164 UINT, "x", 0}, 165 {"sigignore", "IGNORED", NULL, 0, kvar, NULL, 8, KOFF(ki_sigignore), 166 UINT, "x", 0}, 167 {"sigmask", "BLOCKED", NULL, 0, kvar, NULL, 8, KOFF(ki_sigmask), 168 UINT, "x", 0}, 169 {"sl", "SL", NULL, 0, kvar, NULL, 3, KOFF(ki_slptime), UINT, "d", 170 0}, 171 {"start", "STARTED", NULL, LJUST|USER, started, NULL, 7, 0, CHAR, NULL, 172 0}, 173 {"stat", "", "state", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 174 {"state", "STAT", NULL, 0, state, NULL, 4, 0, CHAR, NULL, 0}, 175 {"svgid", "SVGID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_svgid), 176 UINT, UIDFMT, 0}, 177 {"svuid", "SVUID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_svuid), 178 UINT, UIDFMT, 0}, 179 {"tdev", "TDEV", NULL, 0, tdev, NULL, 4, 0, CHAR, NULL, 0}, 180 {"time", "TIME", NULL, USER, cputime, NULL, 9, 0, CHAR, NULL, 0}, 181 {"tpgid", "TPGID", NULL, 0, kvar, NULL, 4, KOFF(ki_tpgid), UINT, 182 PIDFMT, 0}, 183 {"tsid", "TSID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_tsid), UINT, 184 PIDFMT, 0}, 185 {"tsiz", "TSIZ", NULL, 0, kvar, NULL, 4, KOFF(ki_tsize), PGTOK, "ld", 0}, 186 {"tt", "TT ", NULL, 0, tname, NULL, 4, 0, CHAR, NULL, 0}, 187 {"tty", "TTY", NULL, LJUST, longtname, NULL, 8, 0, CHAR, NULL, 0}, 188 {"ucomm", "UCOMM", NULL, LJUST, ucomm, NULL, MAXCOMLEN, 0, CHAR, NULL, 189 0}, 190 {"uid", "UID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_uid), UINT, 191 UIDFMT, 0}, 192 {"upr", "UPR", NULL, 0, kvar, NULL, 3, KOFF(ki_pri.pri_user), UCHAR, 193 "d", 0}, 194 {"user", "USER", NULL, LJUST|DSIZ, uname, s_uname, USERLEN, 0, CHAR, 195 NULL, 0}, 196 {"usrpri", "", "upr", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 197 {"vsize", "", "vsz", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 198 {"vsz", "VSZ", NULL, 0, vsize, NULL, 5, 0, CHAR, NULL, 0}, 199 {"wchan", "WCHAN", NULL, LJUST, wchan, NULL, 6, 0, CHAR, NULL, 0}, 200 {"xstat", "XSTAT", NULL, 0, kvar, NULL, 4, KOFF(ki_xstat), USHORT, 201 "x", 0}, 202 {"", NULL, NULL, 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 203}; 204 205void 206showkey(void) 207{ 208 VAR *v; 209 int i; 210 const char *p, *sep; 211 212 i = 0; 213 sep = ""; 214 for (v = var; *(p = v->name); ++v) { 215 int len = strlen(p); 216 if (termwidth && (i += len + 1) > termwidth) { 217 i = len; 218 sep = "\n"; 219 } 220 (void) printf("%s%s", sep, p); 221 sep = " "; 222 } 223 (void) printf("\n"); 224} 225 226void 227parsefmt(const char *p, int user) 228{ 229 static struct varent *vtail; 230 char *tempstr, *tempstr1; 231 232#define FMTSEP " \t,\n" 233 tempstr1 = tempstr = strdup(p); 234 while (tempstr && *tempstr) { 235 char *cp, *hp; 236 VAR *v; 237 struct varent *vent; 238 239 /* 240 * If an item contains an equals sign, it specifies a column 241 * header, may contain embedded separator characters and 242 * is always the last item. 243 */ 244 if (tempstr[strcspn(tempstr, "="FMTSEP)] != '=') 245 while ((cp = strsep(&tempstr, FMTSEP)) != NULL && 246 *cp == '\0') 247 /* void */; 248 else { 249 cp = tempstr; 250 tempstr = NULL; 251 } 252 if (cp == NULL || !(v = findvar(cp, user, &hp))) 253 continue; 254 if (!user) { 255 /* 256 * If the user is NOT adding this field manually, 257 * get on with our lives if this VAR is already 258 * represented in the list. 259 */ 260 vent = find_varentry(v); 261 if (vent != NULL) 262 continue; 263 } 264 if ((vent = malloc(sizeof(struct varent))) == NULL) 265 errx(1, "malloc failed"); 266 vent->header = v->header; 267 if (hp) { 268 hp = strdup(hp); 269 if (hp) 270 vent->header = hp; 271 } 272 vent->var = malloc(sizeof(*vent->var)); 273 if (vent->var == NULL) 274 errx(1, "malloc failed"); 275 memcpy(vent->var, v, sizeof(*vent->var)); 276 vent->next = NULL; 277 if (vhead == NULL) 278 vhead = vtail = vent; 279 else { 280 vtail->next = vent; 281 vtail = vent; 282 } 283 } 284 free(tempstr1); 285 if (!vhead) { 286 warnx("no valid keywords; valid keywords:"); 287 showkey(); 288 exit(1); 289 } 290} 291 292static VAR * 293findvar(char *p, int user, char **header) 294{ 295 VAR *v, key; 296 char *hp; 297 298 hp = strchr(p, '='); 299 if (hp) 300 *hp++ = '\0'; 301 302 key.name = p; 303 v = bsearch(&key, var, sizeof(var)/sizeof(VAR) - 1, sizeof(VAR), vcmp); 304 305 if (v && v->alias) { 306 if (hp) { 307 warnx("%s: illegal keyword specification", p); 308 eval = 1; 309 } 310 parsefmt(v->alias, user); 311 return ((VAR *)NULL); 312 } 313 if (!v) { 314 warnx("%s: keyword not found", p); 315 eval = 1; 316 } 317 if (header) 318 *header = hp; 319 return (v); 320} 321 322static int 323vcmp(const void *a, const void *b) 324{ 325 return (strcmp(((const VAR *)a)->name, ((const VAR *)b)->name)); 326} 327