1 /* $NetBSD: keyword.c,v 1.48 2006/10/02 18:43:13 apb Exp $ */ 2 3 /*- 4 * Copyright (c) 1990, 1993, 1994 5 * The Regents of the University of California. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. Neither the name of the University nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 */ 31 32 #include <sys/cdefs.h> 33 #ifndef lint 34 #if 0 35 static char sccsid[] = "@(#)keyword.c 8.5 (Berkeley) 4/2/94"; 36 #else 37 __RCSID("$NetBSD: keyword.c,v 1.48 2006/10/02 18:43:13 apb Exp $"); 38 #endif 39 #endif /* not lint */ 40 41 #include <sys/param.h> 42 #include <sys/time.h> 43 #include <sys/lwp.h> 44 #include <sys/proc.h> 45 #include <sys/resource.h> 46 #include <sys/sysctl.h> 47 #include <sys/ucred.h> 48 49 #include <err.h> 50 #include <errno.h> 51 #include <kvm.h> 52 #include <stddef.h> 53 #include <stdio.h> 54 #include <stdlib.h> 55 #include <string.h> 56 #include <signal.h> 57 58 #include "ps.h" 59 60 static VAR *findvar(const char *); 61 static int vcmp(const void *, const void *); 62 63 #if 0 /* kernel doesn't calculate these */ 64 PUVAR("idrss", "IDRSS", 0, p_uru_idrss, UINT64, PRIu64), 65 PUVAR("isrss", "ISRSS", 0, p_uru_isrss, UINT64, PRId64), 66 PUVAR("ixrss", "IXRSS", 0, p_uru_ixrss, UINT64, PRId64), 67 PUVAR("maxrss", "MAXRSS", 0, p_uru_maxrss, UINT64, PRIu64), 68 #endif 69 70 /* Compute offset in common structures. */ 71 #define POFF(x) offsetof(struct kinfo_proc2, x) 72 #define LOFF(x) offsetof(struct kinfo_lwp, x) 73 74 #define UIDFMT "u" 75 #define UID(n1, n2, off) \ 76 { n1, n2, 0, pvar, POFF(off), UINT32, UIDFMT } 77 #define GID(n1, n2, off) UID(n1, n2, off) 78 79 #define PIDFMT "d" 80 #define PID(n1, n2, off) \ 81 { n1, n2, 0, pvar, POFF(off), INT32, PIDFMT } 82 83 #define LVAR(n1, n2, fl, off, type, fmt) \ 84 { n1, n2, (fl) | LWP, pvar, LOFF(off), type, fmt } 85 #define PVAR(n1, n2, fl, off, type, fmt) \ 86 { n1, n2, (fl) | 0, pvar, POFF(off), type, fmt } 87 #define PUVAR(n1, n2, fl, off, type, fmt) \ 88 { n1, n2, (fl) | UAREA, pvar, POFF(off), type, fmt } 89 90 /* NB: table must be sorted, in vi use: 91 * :/^VAR/,/end_sort/! sort -t\" +1 92 * breaking long lines just makes the sort harder 93 * 94 * We support all the fields required by P1003.1-2004 (SUSv3), with 95 * the correct default headers, except for the "tty" field, where the 96 * standard says the header should be "TT", but we have "TTY". 97 */ 98 VAR var[] = { 99 {"%cpu", "%CPU", 0, pcpu, 0, PCPU}, 100 {"%mem", "%MEM", 0, pmem, POFF(p_vm_rssize), INT32}, 101 PVAR("acflag", "ACFLG", 0, p_acflag, USHORT, "x"), 102 {"acflg", "acflag", ALIAS}, 103 {"args", "command", ALIAS}, 104 {"blocked", "sigmask", ALIAS}, 105 {"caught", "sigcatch", ALIAS}, 106 {"comm", "COMMAND", COMM|ARGV0|LJUST, command}, 107 {"command", "COMMAND", COMM|LJUST, command}, 108 PVAR("cpu", "CPU", 0, p_estcpu, UINT, "u"), 109 {"cputime", "time", ALIAS}, 110 {"ctime", "CTIME", 0, putimeval, POFF(p_uctime_sec), TIMEVAL}, 111 GID("egid", "EGID", p_gid), 112 {"egroup", "EGROUP", LJUST, gname}, 113 {"etime", "ELAPSED", 0, elapsed, POFF(p_ustart_sec), TIMEVAL}, 114 UID("euid", "EUID", p_uid), 115 {"euser", "EUSER", LJUST, uname}, 116 PVAR("f", "F", 0, p_flag, INT, "x"), 117 {"flags", "f", ALIAS}, 118 GID("gid", "GID", p_gid), 119 {"group", "GROUP", LJUST, gname}, 120 {"groupnames", "GROUPNAMES", LJUST, groupnames}, 121 {"groups", "GROUPS", LJUST, groups}, 122 LVAR("holdcnt", "HOLDCNT", 0, l_holdcnt, INT, "d"), 123 {"ignored", "sigignore", ALIAS}, 124 PUVAR("inblk", "INBLK", 0, p_uru_inblock, UINT64, PRIu64), 125 {"inblock", "inblk", ALIAS}, 126 PVAR("jobc", "JOBC", 0, p_jobc, SHORT, "d"), 127 PVAR("ktrace", "KTRACE", 0, p_traceflag, INT, "x"), 128 /*XXX*/ PVAR("ktracep", "KTRACEP", 0, p_tracep, KPTR, PRIx64), 129 LVAR("laddr", "LADDR", 0, l_laddr, KPTR, PRIx64), 130 LVAR("lid", "LID", 0, l_lid, INT32, "d"), 131 {"lim", "LIM", 0, maxrss}, 132 {"login", "LOGIN", LJUST, logname}, 133 {"logname", "login", ALIAS}, 134 {"lstart", "STARTED", LJUST, lstarted, POFF(p_ustart_sec), UINT32}, 135 {"lstate", "STAT", LJUST|LWP, lstate}, 136 PUVAR("majflt", "MAJFLT", 0, p_uru_majflt, UINT64, PRIu64), 137 PUVAR("minflt", "MINFLT", 0, p_uru_minflt, UINT64, PRIu64), 138 PUVAR("msgrcv", "MSGRCV", 0, p_uru_msgrcv, UINT64, PRIu64), 139 PUVAR("msgsnd", "MSGSND", 0, p_uru_msgsnd, UINT64, PRIu64), 140 {"ni", "nice", ALIAS}, 141 {"nice", "NI", 0, pnice, POFF(p_nice), UCHAR}, 142 PUVAR("nivcsw", "NIVCSW", 0, p_uru_nivcsw, UINT64, PRIu64), 143 PVAR("nlwp", "NLWP", 0, p_nlwps, UINT64, PRId64), 144 {"nsignals", "nsigs", ALIAS}, 145 PUVAR("nsigs", "NSIGS", 0, p_uru_nsignals, UINT64, PRIu64), 146 PUVAR("nswap", "NSWAP", 0, p_uru_nswap, UINT64, PRIu64), 147 PUVAR("nvcsw", "NVCSW", 0, p_uru_nvcsw, UINT64, PRIu64), 148 /*XXX*/ LVAR("nwchan", "WCHAN", 0, l_wchan, KPTR, PRIx64), 149 PUVAR("oublk", "OUBLK", 0, p_uru_oublock, UINT64, PRIu64), 150 {"oublock", "oublk", ALIAS}, 151 /*XXX*/ PVAR("p_ru", "P_RU", 0, p_ru, KPTR, PRIx64), 152 /*XXX*/ PVAR("paddr", "PADDR", 0, p_paddr, KPTR, PRIx64), 153 PUVAR("pagein", "PAGEIN", 0, p_uru_majflt, UINT64, PRIu64), 154 {"pcpu", "%cpu", ALIAS}, 155 {"pending", "sig", ALIAS}, 156 PID("pgid", "PGID", p__pgid), 157 PID("pid", "PID", p_pid), 158 {"pmem", "%mem", ALIAS}, 159 PID("ppid", "PPID", p_ppid), 160 {"pri", "PRI", LWP, pri}, 161 LVAR("re", "RE", INF127, l_swtime, UINT, "u"), 162 GID("rgid", "RGID", p_rgid), 163 {"rgroup", "RGROUP", LJUST, rgname}, 164 /*XXX*/ LVAR("rlink", "RLINK", 0, l_back, KPTR, PRIx64), 165 PVAR("rlwp", "RLWP", 0, p_nrlwps, UINT64, PRId64), 166 {"rss", "RSS", 0, p_rssize, POFF(p_vm_rssize), INT32}, 167 {"rssize", "rsz", ALIAS}, 168 {"rsz", "RSZ", 0, rssize, POFF(p_vm_rssize), INT32}, 169 UID("ruid", "RUID", p_ruid), 170 {"ruser", "RUSER", LJUST, runame}, 171 PVAR("sess", "SESS", 0, p_sess, KPTR24, PRIx64), 172 PID("sid", "SID", p_sid), 173 PVAR("sig", "PENDING", 0, p_siglist, SIGLIST, "s"), 174 PVAR("sigcatch", "CAUGHT", 0, p_sigcatch, SIGLIST, "s"), 175 PVAR("sigignore", "IGNORED", 0, p_sigignore, SIGLIST, "s"), 176 PVAR("sigmask", "BLOCKED", 0, p_sigmask, SIGLIST, "s"), 177 LVAR("sl", "SL", INF127, l_slptime, UINT, "u"), 178 {"start", "STARTED", 0, started, POFF(p_ustart_sec), UINT32}, 179 {"stat", "state", ALIAS}, 180 {"state", "STAT", LJUST, state}, 181 {"stime", "STIME", 0, putimeval, POFF(p_ustime_sec), TIMEVAL}, 182 GID("svgid", "SVGID", p_svgid), 183 {"svgroup", "SVGROUP", LJUST, svgname}, 184 UID("svuid", "SVUID", p_svuid), 185 {"svuser", "SVUSER", LJUST, svuname}, 186 /* "tdev" is UINT32, but we do this for sorting purposes */ 187 {"tdev", "TDEV", 0, tdev, POFF(p_tdev), INT32}, 188 {"time", "TIME", 0, cputime, 0, CPUTIME}, 189 PID("tpgid", "TPGID", p_tpgid), 190 PVAR("tsess", "TSESS", 0, p_tsess, KPTR, PRIx64), 191 {"tsiz", "TSIZ", 0, tsize, POFF(p_vm_tsize), INT32}, 192 {"tt", "TTY", LJUST, tname, POFF(p_tdev), INT32}, 193 {"tty", "TTY", LJUST, longtname, POFF(p_tdev), INT32}, 194 LVAR("uaddr", "UADDR", 0, l_addr, KPTR, PRIx64), 195 {"ucomm", "UCOMM", LJUST, ucomm}, 196 UID("uid", "UID", p_uid), 197 LVAR("upr", "UPR", 0, l_usrpri, UCHAR, "u"), 198 {"user", "USER", LJUST, uname}, 199 {"usrpri", "upr", ALIAS}, 200 {"utime", "UTIME", 0, putimeval, POFF(p_uutime_sec), TIMEVAL}, 201 {"vsize", "vsz", ALIAS}, 202 {"vsz", "VSZ", 0, vsize, 0, VSIZE}, 203 {"wchan", "WCHAN", LJUST|LWP, wchan}, 204 PVAR("xstat", "XSTAT", 0, p_xstat, USHORT, "x"), 205 /* "zzzz" end_sort */ 206 {""}, 207 }; 208 209 void 210 showkey(void) 211 { 212 VAR *v; 213 int i; 214 const char *p; 215 const char *sep; 216 217 i = 0; 218 sep = ""; 219 for (v = var; *(p = v->name); ++v) { 220 int len = strlen(p); 221 if (termwidth && (i += len + 1) > termwidth) { 222 i = len; 223 sep = "\n"; 224 } 225 (void)printf("%s%s", sep, p); 226 sep = " "; 227 } 228 (void)printf("\n"); 229 } 230 231 /* 232 * Parse the string pp, and insert or append entries to the list 233 * referenced by listptr. If pos in non-null and *pos is non-null, then 234 * *pos specifies where to insert (instead of appending). If pos is 235 * non-null, then a new value is returned through *pos referring to the 236 * last item inserted. 237 */ 238 static void 239 parsevarlist(const char *pp, struct varlist *listptr, struct varent **pos) 240 { 241 char *p, *sp, *equalsp; 242 243 /* dup to avoid zapping arguments. We will free sp later. */ 244 p = sp = strdup(pp); 245 246 /* 247 * Everything after the first '=' is part of a custom header. 248 * Temporarily replace it with '\0' to simplify other code. 249 */ 250 equalsp = strchr(p, '='); 251 if (equalsp) 252 *equalsp = '\0'; 253 254 #define FMTSEP " \t,\n" 255 while (p && *p) { 256 char *cp; 257 VAR *v; 258 struct varent *vent; 259 260 /* 261 * skip separators before the first keyword, and 262 * look for the separator after the keyword. 263 */ 264 for (cp = p; *cp != '\0'; cp++) { 265 p = strpbrk(cp, FMTSEP); 266 if (p != cp) 267 break; 268 } 269 if (*cp == '\0') 270 break; 271 /* 272 * Now cp points to the start of a keyword, 273 * and p is NULL or points past the end of the keyword. 274 * 275 * Terminate the keyword with '\0', or reinstate the 276 * '=' that was removed earlier, if appropriate. 277 */ 278 if (p) { 279 *p = '\0'; 280 p++; 281 } else if (equalsp) { 282 *equalsp = '='; 283 } 284 285 /* 286 * If findvar() likes the keyword or keyword=header, 287 * add it to our list. If findvar() doesn't like it, 288 * it will print a warning, so we ignore it. 289 */ 290 if ((v = findvar(cp)) == NULL) 291 continue; 292 if ((vent = malloc(sizeof(struct varent))) == NULL) 293 err(1, NULL); 294 vent->var = v; 295 if (pos && *pos) 296 SIMPLEQ_INSERT_AFTER(listptr, *pos, vent, next); 297 else { 298 SIMPLEQ_INSERT_TAIL(listptr, vent, next); 299 } 300 if (pos) 301 *pos = vent; 302 } 303 free(sp); 304 if (SIMPLEQ_EMPTY(listptr)) 305 errx(1, "no valid keywords"); 306 } 307 308 void 309 parsefmt(const char *p) 310 { 311 312 parsevarlist(p, &displaylist, NULL); 313 } 314 315 void 316 parsefmt_insert(const char *p, struct varent **pos) 317 { 318 319 parsevarlist(p, &displaylist, pos); 320 } 321 322 void 323 parsesort(const char *p) 324 { 325 326 parsevarlist(p, &sortlist, NULL); 327 } 328 329 /* Search through a list for an entry with a specified name. */ 330 struct varent * 331 varlist_find(struct varlist *list, const char *name) 332 { 333 struct varent *vent; 334 335 SIMPLEQ_FOREACH(vent, list, next) { 336 if (strcmp(vent->var->name, name) == 0) 337 break; 338 } 339 return vent; 340 } 341 342 static VAR * 343 findvar(const char *p) 344 { 345 VAR *v; 346 char *hp; 347 348 hp = strchr(p, '='); 349 if (hp) 350 *hp++ = '\0'; 351 352 v = bsearch(p, var, sizeof(var)/sizeof(VAR) - 1, sizeof(VAR), vcmp); 353 if (v && v->flag & ALIAS) 354 v = findvar(v->header); 355 if (!v) { 356 warnx("%s: keyword not found", p); 357 eval = 1; 358 return NULL; 359 } 360 361 if (v && hp) { 362 /* 363 * Override the header. 364 * 365 * We need to copy the entry first, and override the 366 * header in the copy, because the same field might be 367 * used multiple times with different headers. We also 368 * need to strdup the header. 369 */ 370 struct var *newvar; 371 char *newheader; 372 373 if ((newvar = malloc(sizeof(struct var))) == NULL) 374 err(1, NULL); 375 if ((newheader = strdup(hp)) == NULL) 376 err(1, NULL); 377 memcpy(newvar, v, sizeof(struct var)); 378 newvar->header = newheader; 379 380 /* 381 * According to P1003.1-2004, if the header text is null, 382 * such as -o user=, the field width will be at least as 383 * wide as the default header text. 384 */ 385 if (*hp == '\0') 386 newvar->width = strlen(v->header); 387 388 v = newvar; 389 } 390 return v; 391 } 392 393 static int 394 vcmp(const void *a, const void *b) 395 { 396 return strcmp(a, ((const VAR *)b)->name); 397 } 398