keyword.c revision 130827
1279264Sdelphij/*- 296593Smarkm * Copyright (c) 1990, 1993, 1994 396593Smarkm * The Regents of the University of California. All rights reserved. 4142429Snectar * 596593Smarkm * Redistribution and use in source and binary forms, with or without 696593Smarkm * modification, are permitted provided that the following conditions 796593Smarkm * are met: 896593Smarkm * 1. Redistributions of source code must retain the above copyright 996593Smarkm * notice, this list of conditions and the following disclaimer. 1096593Smarkm * 2. Redistributions in binary form must reproduce the above copyright 1196593Smarkm * notice, this list of conditions and the following disclaimer in the 1296593Smarkm * documentation and/or other materials provided with the distribution. 1396593Smarkm * 4. Neither the name of the University nor the names of its contributors 1496593Smarkm * may be used to endorse or promote products derived from this software 1596593Smarkm * without specific prior written permission. 1696593Smarkm * 1796593Smarkm * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 1896593Smarkm * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1996593Smarkm * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20215698Ssimon * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 21215698Ssimon * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22215698Ssimon * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23215698Ssimon * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24215698Ssimon * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2596593Smarkm * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2696593Smarkm * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2796593Smarkm * SUCH DAMAGE. 2896593Smarkm */ 2996593Smarkm 3096593Smarkm#if 0 3196593Smarkm#ifndef lint 3296593Smarkmstatic char sccsid[] = "@(#)keyword.c 8.5 (Berkeley) 4/2/94"; 3396593Smarkm#endif /* not lint */ 3496593Smarkm#endif 3596593Smarkm#include <sys/cdefs.h> 3696593Smarkm__FBSDID("$FreeBSD: head/bin/ps/keyword.c 130827 2004-06-20 22:22:49Z gad $"); 3796593Smarkm 3896593Smarkm#include <sys/param.h> 3996593Smarkm#include <sys/time.h> 4096593Smarkm#include <sys/resource.h> 41279264Sdelphij#include <sys/proc.h> 42279264Sdelphij#include <sys/sysctl.h> 4396593Smarkm#include <sys/user.h> 4496593Smarkm 45215698Ssimon#include <err.h> 46215698Ssimon#include <stddef.h> 47215698Ssimon#include <stdio.h> 48215698Ssimon#include <stdlib.h> 49142429Snectar#include <string.h> 50215698Ssimon 51142429Snectar#include "ps.h" 52142429Snectar 53279264Sdelphijstatic VAR *findvar(char *, int, char **header); 54279264Sdelphijstatic int vcmp(const void *, const void *); 55279264Sdelphij 5696593Smarkm/* Compute offset in common structures. */ 57279264Sdelphij#define KOFF(x) offsetof(struct kinfo_proc, x) 58279264Sdelphij#define ROFF(x) offsetof(struct rusage, x) 59279264Sdelphij 60279264Sdelphij#define LWPFMT "d" 61279264Sdelphij#define LWPLEN 6 62279264Sdelphij#define NLWPFMT "d" 63215698Ssimon#define NLWPLEN 4 64279264Sdelphij#define UIDFMT "u" 65279264Sdelphij#define UIDLEN 5 66279264Sdelphij#define PIDFMT "d" 67279264Sdelphij#define PIDLEN 5 68279264Sdelphij#define USERLEN (MAXLOGNAME - 1) 69215698Ssimon 70279264Sdelphij/* PLEASE KEEP THE TABLE BELOW SORTED ALPHABETICALLY!!! */ 7196593Smarkmstatic VAR var[] = { 7296593Smarkm {"%cpu", "%CPU", NULL, 0, pcpu, NULL, 4, 0, CHAR, NULL, 0}, 7396593Smarkm {"%mem", "%MEM", NULL, 0, pmem, NULL, 4, 0, CHAR, NULL, 0}, 7496593Smarkm {"acflag", "ACFLG", NULL, 0, kvar, NULL, 3, KOFF(ki_acflag), USHORT, 7596593Smarkm "x", 0}, 7696593Smarkm {"acflg", "", "acflag", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 7796593Smarkm {"args", "COMMAND", NULL, COMM|LJUST|USER, arguments, NULL, 16, 0, 7896593Smarkm CHAR, NULL, 0}, 7996593Smarkm {"blocked", "", "sigmask", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 8096593Smarkm {"caught", "", "sigcatch", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 8196593Smarkm {"comm", "COMMAND", NULL, LJUST, ucomm, NULL, MAXCOMLEN, 0, CHAR, 8296593Smarkm NULL, 0}, 8396593Smarkm {"command", "COMMAND", NULL, COMM|LJUST|USER, command, NULL, 16, 0, 8496593Smarkm CHAR, NULL, 0}, 8596593Smarkm {"cpu", "CPU", NULL, 0, kvar, NULL, 3, KOFF(ki_estcpu), UINT, "d", 8696593Smarkm 0}, 8796593Smarkm {"cputime", "", "time", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 8896593Smarkm {"etime", "ELAPSED", NULL, USER, elapsed, NULL, 12, 0, CHAR, NULL, 0}, 8996593Smarkm {"f", "F", NULL, 0, kvar, NULL, 7, KOFF(ki_flag), INT, "x", 0}, 9096593Smarkm {"flags", "", "f", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 9196593Smarkm {"ignored", "", "sigignore", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 9296593Smarkm {"inblk", "INBLK", NULL, USER, rvar, NULL, 4, ROFF(ru_inblock), LONG, 9396593Smarkm "ld", 0}, 9496593Smarkm {"inblock", "", "inblk", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 9596593Smarkm {"jobc", "JOBC", NULL, 0, kvar, NULL, 4, KOFF(ki_jobc), SHORT, "d", 9696593Smarkm 0}, 9796593Smarkm {"ktrace", "KTRACE", NULL, 0, kvar, NULL, 8, KOFF(ki_traceflag), INT, 9896593Smarkm "x", 0}, 9996593Smarkm {"label", "LABEL", NULL, LJUST|DSIZ, label, s_label, SHRT_MAX, 0, CHAR, 10096593Smarkm NULL, 0}, 10196593Smarkm {"lim", "LIM", NULL, 0, maxrss, NULL, 5, 0, CHAR, NULL, 0}, 10296593Smarkm {"lockname", "LOCK", NULL, LJUST, lockname, NULL, 6, 0, CHAR, NULL, 10396593Smarkm 0}, 10496593Smarkm {"login", "LOGIN", NULL, LJUST, logname, NULL, MAXLOGNAME-1, 0, CHAR, 10596593Smarkm NULL, 0}, 10696593Smarkm {"logname", "", "login", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 10796593Smarkm {"lstart", "STARTED", NULL, LJUST|USER, lstarted, NULL, 28, 0, CHAR, 10896593Smarkm NULL, 0}, 10996593Smarkm {"lwp", "LWP", NULL, 0, kvar, NULL, LWPLEN, KOFF(ki_tid), UINT, 11096593Smarkm LWPFMT, 0}, 11196593Smarkm {"majflt", "MAJFLT", NULL, USER, rvar, NULL, 4, ROFF(ru_majflt), 11296593Smarkm LONG, "ld", 0}, 11396593Smarkm {"minflt", "MINFLT", NULL, USER, rvar, NULL, 4, ROFF(ru_minflt), 11496593Smarkm LONG, "ld", 0}, 11596593Smarkm {"msgrcv", "MSGRCV", NULL, USER, rvar, NULL, 4, ROFF(ru_msgrcv), 11696593Smarkm LONG, "ld", 0}, 11796593Smarkm {"msgsnd", "MSGSND", NULL, USER, rvar, NULL, 4, ROFF(ru_msgsnd), 11896593Smarkm LONG, "ld", 0}, 11996593Smarkm {"mwchan", "MWCHAN", NULL, LJUST, mwchan, NULL, 6, 0, CHAR, NULL, 0}, 12096593Smarkm {"ni", "", "nice", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 12196593Smarkm {"nice", "NI", NULL, 0, kvar, NULL, 2, KOFF(ki_nice), CHAR, "d", 12296593Smarkm 0}, 12396593Smarkm {"nivcsw", "NIVCSW", NULL, USER, rvar, NULL, 5, ROFF(ru_nivcsw), 12496593Smarkm LONG, "ld", 0}, 12596593Smarkm {"nlwp", "NLWP", NULL, 0, kvar, NULL, NLWPLEN, KOFF(ki_numthreads), 12696593Smarkm UINT, NLWPFMT, 0}, 12796593Smarkm {"nsignals", "", "nsigs", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 12896593Smarkm {"nsigs", "NSIGS", NULL, USER, rvar, NULL, 4, ROFF(ru_nsignals), 12996593Smarkm LONG, "ld", 0}, 13096593Smarkm {"nswap", "NSWAP", NULL, USER, rvar, NULL, 4, ROFF(ru_nswap), 13196593Smarkm LONG, "ld", 0}, 13296593Smarkm {"nvcsw", "NVCSW", NULL, USER, rvar, NULL, 5, ROFF(ru_nvcsw), 133142429Snectar LONG, "ld", 0}, 13496593Smarkm {"nwchan", "NWCHAN", NULL, LJUST, nwchan, NULL, 8, 0, CHAR, NULL, 0}, 135100946Snectar {"oublk", "OUBLK", NULL, USER, rvar, NULL, 4, ROFF(ru_oublock), 136279264Sdelphij LONG, "ld", 0}, 137215698Ssimon {"oublock", "", "oublk", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 138215698Ssimon {"paddr", "PADDR", NULL, 0, kvar, NULL, 8, KOFF(ki_paddr), KPTR, 139215698Ssimon "lx", 0}, 140215698Ssimon {"pagein", "PAGEIN", NULL, USER, pagein, NULL, 6, 0, CHAR, NULL, 0}, 14196593Smarkm {"pcpu", "", "%cpu", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 142110010Smarkm {"pending", "", "sig", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 143110010Smarkm {"pgid", "PGID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_pgid), UINT, 144110010Smarkm PIDFMT, 0}, 14596593Smarkm {"pid", "PID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_pid), UINT, 14696593Smarkm PIDFMT, 0}, 14796593Smarkm {"pmem", "", "%mem", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 14896593Smarkm {"ppid", "PPID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_ppid), UINT, 149215698Ssimon PIDFMT, 0}, 15096593Smarkm {"pri", "PRI", NULL, 0, pri, NULL, 3, 0, CHAR, NULL, 0}, 15196593Smarkm {"re", "RE", NULL, INF127, kvar, NULL, 3, KOFF(ki_swtime), UINT, "d", 152215698Ssimon 0}, 15396593Smarkm {"rgid", "RGID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_rgid), 154215698Ssimon UINT, UIDFMT, 0}, 15596593Smarkm {"rgroup", "RGROUP", NULL, LJUST|DSIZ, rgroupname, s_rgroupname, 15696593Smarkm USERLEN, 0, CHAR, NULL, 0}, 15796593Smarkm {"rss", "RSS", NULL, 0, kvar, NULL, 4, KOFF(ki_rssize), PGTOK, "ld", 0}, 15896593Smarkm {"rtprio", "RTPRIO", NULL, 0, priorityr, NULL, 7, KOFF(ki_pri), CHAR, 159215698Ssimon NULL, 0}, 16096593Smarkm {"ruid", "RUID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_ruid), 161215698Ssimon UINT, UIDFMT, 0}, 16296593Smarkm {"ruser", "RUSER", NULL, LJUST|DSIZ, runame, s_runame, USERLEN, 16396593Smarkm 0, CHAR, NULL, 0}, 16496593Smarkm {"sid", "SID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_sid), UINT, 16596593Smarkm PIDFMT, 0}, 16696593Smarkm {"sig", "PENDING", NULL, 0, kvar, NULL, 8, KOFF(ki_siglist), INT, 16796593Smarkm "x", 0}, 16896593Smarkm {"sigcatch", "CAUGHT", NULL, 0, kvar, NULL, 8, KOFF(ki_sigcatch), 16996593Smarkm UINT, "x", 0}, 17096593Smarkm {"sigignore", "IGNORED", NULL, 0, kvar, NULL, 8, KOFF(ki_sigignore), 17196593Smarkm UINT, "x", 0}, 17296593Smarkm {"sigmask", "BLOCKED", NULL, 0, kvar, NULL, 8, KOFF(ki_sigmask), 17396593Smarkm UINT, "x", 0}, 17496593Smarkm {"sl", "SL", NULL, INF127, kvar, NULL, 3, KOFF(ki_slptime), UINT, "d", 17596593Smarkm 0}, 176142429Snectar {"start", "STARTED", NULL, LJUST|USER, started, NULL, 7, 0, CHAR, NULL, 17796593Smarkm 0}, 17896593Smarkm {"stat", "", "state", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 17996593Smarkm {"state", "STAT", NULL, 0, state, NULL, 4, 0, CHAR, NULL, 0}, 18096593Smarkm {"svgid", "SVGID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_svgid), 181127131Snectar UINT, UIDFMT, 0}, 182 {"svuid", "SVUID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_svuid), 183 UINT, UIDFMT, 0}, 184 {"tdev", "TDEV", NULL, 0, tdev, NULL, 4, 0, CHAR, NULL, 0}, 185 {"time", "TIME", NULL, USER, cputime, NULL, 9, 0, CHAR, NULL, 0}, 186 {"tpgid", "TPGID", NULL, 0, kvar, NULL, 4, KOFF(ki_tpgid), UINT, 187 PIDFMT, 0}, 188 {"tsid", "TSID", NULL, 0, kvar, NULL, PIDLEN, KOFF(ki_tsid), UINT, 189 PIDFMT, 0}, 190 {"tsiz", "TSIZ", NULL, 0, kvar, NULL, 4, KOFF(ki_tsize), PGTOK, "ld", 0}, 191 {"tt", "TT ", NULL, 0, tname, NULL, 4, 0, CHAR, NULL, 0}, 192 {"tty", "TTY", NULL, LJUST, longtname, NULL, 8, 0, CHAR, NULL, 0}, 193 {"ucomm", "UCOMM", NULL, LJUST, ucomm, NULL, MAXCOMLEN, 0, CHAR, NULL, 194 0}, 195 {"uid", "UID", NULL, 0, kvar, NULL, UIDLEN, KOFF(ki_uid), UINT, 196 UIDFMT, 0}, 197 {"upr", "UPR", NULL, 0, kvar, NULL, 3, KOFF(ki_pri.pri_user), UCHAR, 198 "d", 0}, 199 {"uprocp", "UPROCP", NULL, 0, kvar, NULL, 8, KOFF(ki_paddr), KPTR, 200 "lx", 0}, 201 {"user", "USER", NULL, LJUST|DSIZ, uname, s_uname, USERLEN, 0, CHAR, 202 NULL, 0}, 203 {"usrpri", "", "upr", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 204 {"vsize", "", "vsz", 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 205 {"vsz", "VSZ", NULL, 0, vsize, NULL, 5, 0, CHAR, NULL, 0}, 206 {"wchan", "WCHAN", NULL, LJUST, wchan, NULL, 6, 0, CHAR, NULL, 0}, 207 {"xstat", "XSTAT", NULL, 0, kvar, NULL, 4, KOFF(ki_xstat), USHORT, 208 "x", 0}, 209 {"", NULL, NULL, 0, NULL, NULL, 0, 0, CHAR, NULL, 0}, 210}; 211 212void 213showkey(void) 214{ 215 VAR *v; 216 int i; 217 const char *p, *sep; 218 219 i = 0; 220 sep = ""; 221 for (v = var; *(p = v->name); ++v) { 222 int len = strlen(p); 223 if (termwidth && (i += len + 1) > termwidth) { 224 i = len; 225 sep = "\n"; 226 } 227 (void) printf("%s%s", sep, p); 228 sep = " "; 229 } 230 (void) printf("\n"); 231} 232 233void 234parsefmt(const char *p, int user) 235{ 236 static struct varent *vtail; 237 char *tempstr, *tempstr1; 238 239#define FMTSEP " \t,\n" 240 tempstr1 = tempstr = strdup(p); 241 while (tempstr && *tempstr) { 242 char *cp, *hp; 243 VAR *v; 244 struct varent *vent; 245 246 /* 247 * If an item contains an equals sign, it specifies a column 248 * header, may contain embedded separator characters and 249 * is always the last item. 250 */ 251 if (tempstr[strcspn(tempstr, "="FMTSEP)] != '=') 252 while ((cp = strsep(&tempstr, FMTSEP)) != NULL && 253 *cp == '\0') 254 /* void */; 255 else { 256 cp = tempstr; 257 tempstr = NULL; 258 } 259 if (cp == NULL || !(v = findvar(cp, user, &hp))) 260 continue; 261 if (!user) { 262 /* 263 * If the user is NOT adding this field manually, 264 * get on with our lives if this VAR is already 265 * represented in the list. 266 */ 267 vent = find_varentry(v); 268 if (vent != NULL) 269 continue; 270 } 271 if ((vent = malloc(sizeof(struct varent))) == NULL) 272 errx(1, "malloc failed"); 273 vent->header = v->header; 274 if (hp) { 275 hp = strdup(hp); 276 if (hp) 277 vent->header = hp; 278 } 279 vent->var = malloc(sizeof(*vent->var)); 280 if (vent->var == NULL) 281 errx(1, "malloc failed"); 282 memcpy(vent->var, v, sizeof(*vent->var)); 283 vent->next = NULL; 284 if (vhead == NULL) 285 vhead = vtail = vent; 286 else { 287 vtail->next = vent; 288 vtail = vent; 289 } 290 } 291 free(tempstr1); 292 if (!vhead) { 293 warnx("no valid keywords; valid keywords:"); 294 showkey(); 295 exit(1); 296 } 297} 298 299static VAR * 300findvar(char *p, int user, char **header) 301{ 302 VAR *v, key; 303 char *hp; 304 305 hp = strchr(p, '='); 306 if (hp) 307 *hp++ = '\0'; 308 309 key.name = p; 310 v = bsearch(&key, var, sizeof(var)/sizeof(VAR) - 1, sizeof(VAR), vcmp); 311 312 if (v && v->alias) { 313 if (hp) { 314 warnx("%s: illegal keyword specification", p); 315 eval = 1; 316 } 317 parsefmt(v->alias, user); 318 return ((VAR *)NULL); 319 } 320 if (!v) { 321 warnx("%s: keyword not found", p); 322 eval = 1; 323 } 324 if (header) 325 *header = hp; 326 return (v); 327} 328 329static int 330vcmp(const void *a, const void *b) 331{ 332 return (strcmp(((const VAR *)a)->name, ((const VAR *)b)->name)); 333} 334