1 /* $NetBSD: keyword.c,v 1.51 2007/09/01 16:54:39 yamt 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.51 2007/09/01 16:54:39 yamt 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, of) \ 76 { .name = n1, .header = n2, .flag = 0, .oproc = pvar, \ 77 .off = POFF(of), .type = UINT32, .fmt = UIDFMT } 78 #define GID(n1, n2, off) UID(n1, n2, off) 79 80 #define PIDFMT "d" 81 #define PID(n1, n2, of) \ 82 { .name = n1, .header = n2, .flag = 0, .oproc = pvar, \ 83 .off = POFF(of), .type = INT32, .fmt = PIDFMT } 84 85 #define LVAR(n1, n2, fl, of, ty, fm) \ 86 { .name = n1, .header = n2, .flag = (fl) | LWP, .oproc = pvar, \ 87 .off = LOFF(of), .type = ty, .fmt = fm } 88 #define PVAR(n1, n2, fl, of, ty, fm) \ 89 { .name = n1, .header = n2, .flag = (fl) | 0, .oproc = pvar, \ 90 .off = POFF(of), .type = ty, .fmt = fm } 91 #define PUVAR(n1, n2, fl, of, ty, fm) \ 92 { .name = n1, .header = n2, .flag = (fl) | UAREA, .oproc = pvar, \ 93 .off = POFF(of), .type = ty, .fmt = fm } 94 #define VAR3(n1, n2, fl) \ 95 { .name = n1, .header = n2, .flag = fl } 96 #define VAR4(n1, n2, fl, op) \ 97 { .name = n1, .header = n2, .flag = fl, .oproc = op, } 98 #define VAR6(n1, n2, fl, op, of, ty) \ 99 { .name = n1, .header = n2, .flag = fl, .oproc = op, \ 100 .off = of, .type = ty } 101 102 /* NB: table must be sorted, in vi use: 103 * :/^VAR/,/end_sort/! sort -t\" +1 104 * breaking long lines just makes the sort harder 105 * 106 * We support all the fields required by P1003.1-2004 (SUSv3), with 107 * the correct default headers, except for the "tty" field, where the 108 * standard says the header should be "TT", but we have "TTY". 109 */ 110 VAR var[] = { 111 VAR6("%cpu", "%CPU", 0, pcpu, 0, PCPU), 112 VAR6("%mem", "%MEM", 0, pmem, POFF(p_vm_rssize), INT32), 113 PVAR("acflag", "ACFLG", 0, p_acflag, USHORT, "x"), 114 VAR3("acflg", "acflag", ALIAS), 115 VAR3("args", "command", ALIAS), 116 VAR3("blocked", "sigmask", ALIAS), 117 VAR3("caught", "sigcatch", ALIAS), 118 VAR4("comm", "COMMAND", COMM|ARGV0|LJUST, command), 119 VAR4("command", "COMMAND", COMM|LJUST, command), 120 PVAR("cpu", "CPU", 0, p_estcpu, UINT, "u"), 121 VAR3("cputime", "time", ALIAS), 122 VAR6("ctime", "CTIME", 0, putimeval, POFF(p_uctime_sec), TIMEVAL), 123 GID("egid", "EGID", p_gid), 124 VAR4("egroup", "EGROUP", LJUST, gname), 125 VAR4("emul", "EMUL", LJUST, emul), 126 VAR6("etime", "ELAPSED", 0, elapsed, POFF(p_ustart_sec), TIMEVAL), 127 UID("euid", "EUID", p_uid), 128 VAR4("euser", "EUSER", LJUST, uname), 129 PVAR("f", "F", 0, p_flag, INT, "x"), 130 VAR3("flags", "f", ALIAS), 131 GID("gid", "GID", p_gid), 132 VAR4("group", "GROUP", LJUST, gname), 133 VAR4("groupnames", "GROUPNAMES", LJUST, groupnames), 134 VAR4("groups", "GROUPS", LJUST, groups), 135 LVAR("holdcnt", "HOLDCNT", 0, l_holdcnt, INT, "d"), 136 VAR3("ignored", "sigignore", ALIAS), 137 PUVAR("inblk", "INBLK", 0, p_uru_inblock, UINT64, PRIu64), 138 VAR3("inblock", "inblk", ALIAS), 139 PVAR("jobc", "JOBC", 0, p_jobc, SHORT, "d"), 140 PVAR("ktrace", "KTRACE", 0, p_traceflag, INT, "x"), 141 /*XXX*/ PVAR("ktracep", "KTRACEP", 0, p_tracep, KPTR, PRIx64), 142 LVAR("laddr", "LADDR", 0, l_laddr, KPTR, PRIx64), 143 LVAR("lid", "LID", 0, l_lid, INT32, "d"), 144 VAR4("lim", "LIM", 0, maxrss), 145 VAR4("lname", "LNAME", LJUST|LWP, lname), 146 VAR4("login", "LOGIN", LJUST, logname), 147 VAR3("logname", "login", ALIAS), 148 VAR6("lstart", "STARTED", LJUST, lstarted, POFF(p_ustart_sec), UINT32), 149 VAR4("lstate", "STAT", LJUST|LWP, lstate), 150 PUVAR("majflt", "MAJFLT", 0, p_uru_majflt, UINT64, PRIu64), 151 PUVAR("minflt", "MINFLT", 0, p_uru_minflt, UINT64, PRIu64), 152 PUVAR("msgrcv", "MSGRCV", 0, p_uru_msgrcv, UINT64, PRIu64), 153 PUVAR("msgsnd", "MSGSND", 0, p_uru_msgsnd, UINT64, PRIu64), 154 VAR3("ni", "nice", ALIAS), 155 VAR6("nice", "NI", 0, pnice, POFF(p_nice), UCHAR), 156 PUVAR("nivcsw", "NIVCSW", 0, p_uru_nivcsw, UINT64, PRIu64), 157 PVAR("nlwp", "NLWP", 0, p_nlwps, UINT64, PRId64), 158 VAR3("nsignals", "nsigs", ALIAS), 159 PUVAR("nsigs", "NSIGS", 0, p_uru_nsignals, UINT64, PRIu64), 160 PUVAR("nswap", "NSWAP", 0, p_uru_nswap, UINT64, PRIu64), 161 PUVAR("nvcsw", "NVCSW", 0, p_uru_nvcsw, UINT64, PRIu64), 162 /*XXX*/ LVAR("nwchan", "WCHAN", 0, l_wchan, KPTR, PRIx64), 163 PUVAR("oublk", "OUBLK", 0, p_uru_oublock, UINT64, PRIu64), 164 VAR3("oublock", "oublk", ALIAS), 165 /*XXX*/ PVAR("p_ru", "P_RU", 0, p_ru, KPTR, PRIx64), 166 /*XXX*/ PVAR("paddr", "PADDR", 0, p_paddr, KPTR, PRIx64), 167 PUVAR("pagein", "PAGEIN", 0, p_uru_majflt, UINT64, PRIu64), 168 VAR3("pcpu", "%cpu", ALIAS), 169 VAR3("pending", "sig", ALIAS), 170 PID("pgid", "PGID", p__pgid), 171 PID("pid", "PID", p_pid), 172 VAR3("pmem", "%mem", ALIAS), 173 PID("ppid", "PPID", p_ppid), 174 VAR4("pri", "PRI", LWP, pri), 175 LVAR("re", "RE", INF127, l_swtime, UINT, "u"), 176 GID("rgid", "RGID", p_rgid), 177 VAR4("rgroup", "RGROUP", LJUST, rgname), 178 /*XXX*/ LVAR("rlink", "RLINK", 0, l_back, KPTR, PRIx64), 179 PVAR("rlwp", "RLWP", 0, p_nrlwps, UINT64, PRId64), 180 VAR6("rss", "RSS", 0, p_rssize, POFF(p_vm_rssize), INT32), 181 VAR3("rssize", "rsz", ALIAS), 182 VAR6("rsz", "RSZ", 0, rssize, POFF(p_vm_rssize), INT32), 183 UID("ruid", "RUID", p_ruid), 184 VAR4("ruser", "RUSER", LJUST, runame), 185 PVAR("sess", "SESS", 0, p_sess, KPTR24, PRIx64), 186 PID("sid", "SID", p_sid), 187 PVAR("sig", "PENDING", 0, p_siglist, SIGLIST, "s"), 188 PVAR("sigcatch", "CAUGHT", 0, p_sigcatch, SIGLIST, "s"), 189 PVAR("sigignore", "IGNORED", 0, p_sigignore, SIGLIST, "s"), 190 PVAR("sigmask", "BLOCKED", 0, p_sigmask, SIGLIST, "s"), 191 LVAR("sl", "SL", INF127, l_slptime, UINT, "u"), 192 VAR6("start", "STARTED", 0, started, POFF(p_ustart_sec), UINT32), 193 VAR3("stat", "state", ALIAS), 194 VAR4("state", "STAT", LJUST, state), 195 VAR6("stime", "STIME", 0, putimeval, POFF(p_ustime_sec), TIMEVAL), 196 GID("svgid", "SVGID", p_svgid), 197 VAR4("svgroup", "SVGROUP", LJUST, svgname), 198 UID("svuid", "SVUID", p_svuid), 199 VAR4("svuser", "SVUSER", LJUST, svuname), 200 /* "tdev" is UINT32, but we do this for sorting purposes */ 201 VAR6("tdev", "TDEV", 0, tdev, POFF(p_tdev), INT32), 202 VAR6("time", "TIME", 0, cputime, 0, CPUTIME), 203 PID("tpgid", "TPGID", p_tpgid), 204 PVAR("tsess", "TSESS", 0, p_tsess, KPTR, PRIx64), 205 VAR6("tsiz", "TSIZ", 0, tsize, POFF(p_vm_tsize), INT32), 206 VAR6("tt", "TTY", LJUST, tname, POFF(p_tdev), INT32), 207 VAR6("tty", "TTY", LJUST, longtname, POFF(p_tdev), INT32), 208 LVAR("uaddr", "UADDR", 0, l_addr, KPTR, PRIx64), 209 VAR4("ucomm", "UCOMM", LJUST, ucomm), 210 UID("uid", "UID", p_uid), 211 LVAR("upr", "UPR", 0, l_usrpri, UCHAR, "u"), 212 VAR4("user", "USER", LJUST, uname), 213 VAR3("usrpri", "upr", ALIAS), 214 VAR6("utime", "UTIME", 0, putimeval, POFF(p_uutime_sec), TIMEVAL), 215 VAR3("vsize", "vsz", ALIAS), 216 VAR6("vsz", "VSZ", 0, vsize, 0, VSIZE), 217 VAR4("wchan", "WCHAN", LJUST|LWP, wchan), 218 PVAR("xstat", "XSTAT", 0, p_xstat, USHORT, "x"), 219 /* "zzzz" end_sort */ 220 { .name = "" }, 221 }; 222 223 void 224 showkey(void) 225 { 226 VAR *v; 227 int i; 228 const char *p; 229 const char *sep; 230 231 i = 0; 232 sep = ""; 233 for (v = var; *(p = v->name); ++v) { 234 int len = strlen(p); 235 if (termwidth && (i += len + 1) > termwidth) { 236 i = len; 237 sep = "\n"; 238 } 239 (void)printf("%s%s", sep, p); 240 sep = " "; 241 } 242 (void)printf("\n"); 243 } 244 245 /* 246 * Parse the string pp, and insert or append entries to the list 247 * referenced by listptr. If pos in non-null and *pos is non-null, then 248 * *pos specifies where to insert (instead of appending). If pos is 249 * non-null, then a new value is returned through *pos referring to the 250 * last item inserted. 251 */ 252 static void 253 parsevarlist(const char *pp, struct varlist *listptr, struct varent **pos) 254 { 255 char *p, *sp, *equalsp; 256 257 /* dup to avoid zapping arguments. We will free sp later. */ 258 p = sp = strdup(pp); 259 260 /* 261 * Everything after the first '=' is part of a custom header. 262 * Temporarily replace it with '\0' to simplify other code. 263 */ 264 equalsp = strchr(p, '='); 265 if (equalsp) 266 *equalsp = '\0'; 267 268 #define FMTSEP " \t,\n" 269 while (p && *p) { 270 char *cp; 271 VAR *v; 272 struct varent *vent; 273 274 /* 275 * skip separators before the first keyword, and 276 * look for the separator after the keyword. 277 */ 278 for (cp = p; *cp != '\0'; cp++) { 279 p = strpbrk(cp, FMTSEP); 280 if (p != cp) 281 break; 282 } 283 if (*cp == '\0') 284 break; 285 /* 286 * Now cp points to the start of a keyword, 287 * and p is NULL or points past the end of the keyword. 288 * 289 * Terminate the keyword with '\0', or reinstate the 290 * '=' that was removed earlier, if appropriate. 291 */ 292 if (p) { 293 *p = '\0'; 294 p++; 295 } else if (equalsp) { 296 *equalsp = '='; 297 } 298 299 /* 300 * If findvar() likes the keyword or keyword=header, 301 * add it to our list. If findvar() doesn't like it, 302 * it will print a warning, so we ignore it. 303 */ 304 if ((v = findvar(cp)) == NULL) 305 continue; 306 if ((vent = malloc(sizeof(struct varent))) == NULL) 307 err(1, NULL); 308 vent->var = v; 309 if (pos && *pos) 310 SIMPLEQ_INSERT_AFTER(listptr, *pos, vent, next); 311 else { 312 SIMPLEQ_INSERT_TAIL(listptr, vent, next); 313 } 314 if (pos) 315 *pos = vent; 316 } 317 free(sp); 318 if (SIMPLEQ_EMPTY(listptr)) 319 errx(1, "no valid keywords"); 320 } 321 322 void 323 parsefmt(const char *p) 324 { 325 326 parsevarlist(p, &displaylist, NULL); 327 } 328 329 void 330 parsefmt_insert(const char *p, struct varent **pos) 331 { 332 333 parsevarlist(p, &displaylist, pos); 334 } 335 336 void 337 parsesort(const char *p) 338 { 339 340 parsevarlist(p, &sortlist, NULL); 341 } 342 343 /* Search through a list for an entry with a specified name. */ 344 struct varent * 345 varlist_find(struct varlist *list, const char *name) 346 { 347 struct varent *vent; 348 349 SIMPLEQ_FOREACH(vent, list, next) { 350 if (strcmp(vent->var->name, name) == 0) 351 break; 352 } 353 return vent; 354 } 355 356 static VAR * 357 findvar(const char *p) 358 { 359 VAR *v; 360 char *hp; 361 362 hp = strchr(p, '='); 363 if (hp) 364 *hp++ = '\0'; 365 366 v = bsearch(p, var, sizeof(var)/sizeof(VAR) - 1, sizeof(VAR), vcmp); 367 if (v && v->flag & ALIAS) 368 v = findvar(v->header); 369 if (!v) { 370 warnx("%s: keyword not found", p); 371 eval = 1; 372 return NULL; 373 } 374 375 if (v && hp) { 376 /* 377 * Override the header. 378 * 379 * We need to copy the entry first, and override the 380 * header in the copy, because the same field might be 381 * used multiple times with different headers. We also 382 * need to strdup the header. 383 */ 384 struct var *newvar; 385 char *newheader; 386 387 if ((newvar = malloc(sizeof(struct var))) == NULL) 388 err(1, NULL); 389 if ((newheader = strdup(hp)) == NULL) 390 err(1, NULL); 391 memcpy(newvar, v, sizeof(struct var)); 392 newvar->header = newheader; 393 394 /* 395 * According to P1003.1-2004, if the header text is null, 396 * such as -o user=, the field width will be at least as 397 * wide as the default header text. 398 */ 399 if (*hp == '\0') 400 newvar->width = strlen(v->header); 401 402 v = newvar; 403 } 404 return v; 405 } 406 407 static int 408 vcmp(const void *a, const void *b) 409 { 410 return strcmp(a, ((const VAR *)b)->name); 411 } 412