Check kp (struct kinfo_proc *kp) against NULL and not 0, because it is a
[dragonfly.git] / bin / ps / ps.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  * @(#) Copyright (c) 1990, 1993, 1994 The Regents of the University of California.  All rights reserved.
34  * @(#)ps.c     8.4 (Berkeley) 4/2/94
35  * $FreeBSD: src/bin/ps/ps.c,v 1.30.2.6 2002/07/04 08:30:37 sobomax Exp $
36  * $DragonFly: src/bin/ps/ps.c,v 1.9 2004/06/21 01:03:06 hmp Exp $
37  */
38
39 #include <sys/param.h>
40 #include <sys/user.h>
41 #include <sys/time.h>
42 #include <sys/resource.h>
43 #include <sys/stat.h>
44 #include <sys/ioctl.h>
45 #include <sys/sysctl.h>
46
47 #include <ctype.h>
48 #include <err.h>
49 #include <errno.h>
50 #include <fcntl.h>
51 #include <kvm.h>
52 #include <limits.h>
53 #include <locale.h>
54 #include <nlist.h>
55 #include <paths.h>
56 #include <stdio.h>
57 #include <stdlib.h>
58 #include <string.h>
59 #include <unistd.h>
60 #include <pwd.h>
61 #include <utmp.h>
62
63 #include "ps.h"
64
65 #define SEP ", \t"              /* username separators */
66
67 KINFO *kinfo;
68 struct varent *vhead, *vtail;
69
70 int     eval;                   /* exit value */
71 int     cflag;                  /* -c */
72 int     rawcpu;                 /* -C */
73 int     sumrusage;              /* -S */
74 int     termwidth;              /* width of screen (0 == infinity) */
75 int     totwidth;               /* calculated width of requested variables */
76
77 static int needuser, needcomm, needenv;
78 #if defined(LAZY_PS)
79 static int forceuread=0;
80 #define PS_ARGS "aCcefghjLlM:mN:O:o:p:rSTt:U:uvwx"
81 #else
82 static int forceuread=1;
83 #define PS_ARGS "aCceghjLlM:mN:O:o:p:rSTt:U:uvwx"
84 #endif
85
86 enum sort { DEFAULT, SORTMEM, SORTCPU } sortby = DEFAULT;
87
88 static const char *getfmt (char **(*)(kvm_t *, const struct kinfo_proc *, int),
89                     KINFO *, char *, int);
90 static char     *kludge_oldps_options (char *);
91 static int       pscomp (const void *, const void *);
92 static void      saveuser (KINFO *);
93 static void      scanvars (void);
94 static void      dynsizevars (KINFO *);
95 static void      sizevars (void);
96 static void      usage (void);
97 static uid_t    *getuids(const char *, int *);
98
99 struct timeval btime;
100 static size_t btime_size = sizeof(struct timeval);
101
102 static char dfmt[] = "pid tt state time command";
103 static char jfmt[] = "user pid ppid pgid sess jobc state tt time command";
104 static char lfmt[] = "uid pid ppid cpu pri nice vsz rss wchan state tt time command";
105 static char   o1[] = "pid";
106 static char   o2[] = "tt state time command";
107 static char ufmt[] = "user pid %cpu %mem vsz rss tt state start time command";
108 static char vfmt[] = "pid state time sl re pagein vsz rss lim tsiz %cpu %mem command";
109
110 kvm_t *kd;
111
112 int
113 main(int argc, char **argv)
114 {
115         struct kinfo_proc *kp;
116         struct varent *vent;
117         struct winsize ws;
118         dev_t ttydev;
119         pid_t pid;
120         uid_t *uids;
121         int all, ch, flag, i, fmt, lineno, nentries, nocludge, dropgid;
122         int prtheader, wflag, what, xflg, uid, nuids;
123         char errbuf[_POSIX2_LINE_MAX];
124         const char *cp, *nlistf, *memf;
125
126         (void) setlocale(LC_ALL, "");
127
128         if ((ioctl(STDOUT_FILENO, TIOCGWINSZ, (char *)&ws) == -1 &&
129              ioctl(STDERR_FILENO, TIOCGWINSZ, (char *)&ws) == -1 &&
130              ioctl(STDIN_FILENO,  TIOCGWINSZ, (char *)&ws) == -1) ||
131              ws.ws_col == 0)
132                 termwidth = 79;
133         else
134                 termwidth = ws.ws_col - 1;
135
136         /*
137          * Don't apply a kludge if the first argument is an option taking an
138          * argument
139          */
140         if (argc > 1) {
141                 nocludge = 0;
142                 if (argv[1][0] == '-') {
143                         for (cp = PS_ARGS; *cp != '\0'; cp++) {
144                                 if (*cp != ':')
145                                         continue;
146                                 if (*(cp - 1) == argv[1][1]) {
147                                         nocludge = 1;
148                                         break;
149                                 }
150                         }
151                 }
152                 if (nocludge == 0)
153                         argv[1] = kludge_oldps_options(argv[1]);
154         }
155
156         all = fmt = prtheader = wflag = xflg = 0;
157         pid = -1;
158         nuids = 0;
159         uids = NULL;
160         ttydev = NODEV;
161         dropgid = 0;
162         memf = nlistf = _PATH_DEVNULL;
163         while ((ch = getopt(argc, argv, PS_ARGS)) != -1)
164                 switch((char)ch) {
165                 case 'a':
166                         all = 1;
167                         break;
168                 case 'C':
169                         rawcpu = 1;
170                         break;
171                 case 'c':
172                         cflag = 1;
173                         break;
174                 case 'e':                       /* XXX set ufmt */
175                         needenv = 1;
176                         break;
177                 case 'g':
178                         break;                  /* no-op */
179                 case 'h':
180                         prtheader = ws.ws_row > 5 ? ws.ws_row : 22;
181                         break;
182                 case 'j':
183                         parsefmt(jfmt);
184                         fmt = 1;
185                         jfmt[0] = '\0';
186                         break;
187                 case 'L':
188                         showkey();
189                         exit(0);
190                 case 'l':
191                         parsefmt(lfmt);
192                         fmt = 1;
193                         lfmt[0] = '\0';
194                         break;
195                 case 'M':
196                         memf = optarg;
197                         dropgid = 1;
198                         break;
199                 case 'm':
200                         sortby = SORTMEM;
201                         break;
202                 case 'N':
203                         nlistf = optarg;
204                         dropgid = 1;
205                         break;
206                 case 'O':
207                         parsefmt(o1);
208                         parsefmt(optarg);
209                         parsefmt(o2);
210                         o1[0] = o2[0] = '\0';
211                         fmt = 1;
212                         break;
213                 case 'o':
214                         parsefmt(optarg);
215                         fmt = 1;
216                         break;
217 #if defined(LAZY_PS)
218                 case 'f':
219                         if (getuid() == 0 || getgid() == 0)
220                             forceuread = 1;
221                         break;
222 #endif
223                 case 'p':
224                         pid = atol(optarg);
225                         xflg = 1;
226                         break;
227                 case 'r':
228                         sortby = SORTCPU;
229                         break;
230                 case 'S':
231                         sumrusage = 1;
232                         break;
233                 case 'T':
234                         if ((optarg = ttyname(STDIN_FILENO)) == NULL)
235                                 errx(1, "stdin: not a terminal");
236                         /* FALLTHROUGH */
237                 case 't': {
238                         struct stat sb;
239                         char pathbuf[PATH_MAX];
240                         const char *ttypath;
241
242                         if (strcmp(optarg, "co") == 0)
243                                 ttypath = _PATH_CONSOLE;
244                         else if (*optarg != '/') {
245                                 snprintf(pathbuf,
246                                     sizeof(pathbuf), "%s%s", _PATH_TTY, optarg);
247                                 ttypath = pathbuf;
248                         } else
249                                 ttypath = optarg;
250                         if (stat(ttypath, &sb) == -1)
251                                 err(1, "%s", ttypath);
252                         if (!S_ISCHR(sb.st_mode))
253                                 errx(1, "%s: not a terminal", ttypath);
254                         ttydev = sb.st_rdev;
255                         break;
256                 }
257                 case 'U':
258                         uids = getuids(optarg, &nuids);
259                         xflg++;         /* XXX: intuitive? */
260                         break;
261                 case 'u':
262                         parsefmt(ufmt);
263                         sortby = SORTCPU;
264                         fmt = 1;
265                         ufmt[0] = '\0';
266                         break;
267                 case 'v':
268                         parsefmt(vfmt);
269                         sortby = SORTMEM;
270                         fmt = 1;
271                         vfmt[0] = '\0';
272                         break;
273                 case 'w':
274                         if (wflag)
275                                 termwidth = UNLIMITED;
276                         else if (termwidth < 131)
277                                 termwidth = 131;
278                         wflag++;
279                         break;
280                 case 'x':
281                         xflg = 1;
282                         break;
283                 case '?':
284                 default:
285                         usage();
286                 }
287         argc -= optind;
288         argv += optind;
289
290 #define BACKWARD_COMPATIBILITY
291 #ifdef  BACKWARD_COMPATIBILITY
292         if (*argv) {
293                 nlistf = *argv;
294                 if (*++argv) {
295                         memf = *argv;
296                 }
297         }
298 #endif
299         /*
300          * Discard setgid privileges if not the running kernel so that bad
301          * guys can't print interesting stuff from kernel memory.
302          */
303         if (dropgid) {
304                 setgid(getgid());
305                 setuid(getuid());
306         }
307
308         kd = kvm_openfiles(nlistf, memf, NULL, O_RDONLY, errbuf);
309         if (kd == 0)
310                 errx(1, "%s", errbuf);
311
312         if (!fmt)
313                 parsefmt(dfmt);
314
315         /* XXX - should be cleaner */
316         if (!all && ttydev == NODEV && pid == -1 && !nuids) {
317                 if ((uids = malloc(sizeof (*uids))) == NULL)
318                         errx(1, "malloc: %s", strerror(errno));
319                 nuids = 1;
320                 *uids = getuid();
321         }
322
323         /*
324          * scan requested variables, noting what structures are needed,
325          * and adjusting header widths as appropriate.
326          */
327         scanvars();
328
329         /*
330          * Get boot time
331          */
332         if (sysctlbyname("kern.boottime", &btime, &btime_size, NULL, 0) < 0) {
333                 perror("sysctl: kern.boottime");
334                 exit(EXIT_FAILURE);
335         }
336
337         /*
338          * get proc list
339          */
340         if (nuids == 1) {
341                 what = KERN_PROC_UID;
342                 flag = *uids;
343         } else if (ttydev != NODEV) {
344                 what = KERN_PROC_TTY;
345                 flag = ttydev;
346         } else if (pid != -1) {
347                 what = KERN_PROC_PID;
348                 flag = pid;
349         } else {
350                 what = KERN_PROC_ALL;
351                 flag = 0;
352         }
353         /*
354          * select procs
355          */
356         if ((kp = kvm_getprocs(kd, what, flag, &nentries)) == NULL)
357                 errx(1, "%s", kvm_geterr(kd));
358         if ((kinfo = malloc(nentries * sizeof(*kinfo))) == NULL)
359                 err(1, NULL);
360         for (i = nentries; --i >= 0; ++kp) {
361                 kinfo[i].ki_p = kp;
362                 if (needuser)
363                         saveuser(&kinfo[i]);
364                 dynsizevars(&kinfo[i]);
365         }
366
367         sizevars();
368
369         /*
370          * print header
371          */
372         printheader();
373         if (nentries == 0)
374                 exit(1);
375         /*
376          * sort proc list
377          */
378         qsort(kinfo, nentries, sizeof(KINFO), pscomp);
379         /*
380          * for each proc, call each variable output function.
381          */
382         for (i = lineno = 0; i < nentries; i++) {
383                 if (xflg == 0 && (KI_EPROC(&kinfo[i])->e_tdev == NODEV ||
384                     (KI_PROC(&kinfo[i])->p_flag & P_CONTROLT ) == 0))
385                         continue;
386                 if (nuids > 1) {
387                         for (uid = 0; uid < nuids; uid++)
388                                 if (KI_EPROC(&kinfo[i])->e_ucred.cr_uid ==
389                                     uids[uid])
390                                         break;
391                         if (uid == nuids)
392                                 continue;
393                 }
394                 for (vent = vhead; vent; vent = vent->next) {
395                         (vent->var->oproc)(&kinfo[i], vent);
396                         if (vent->next != NULL)
397                                 (void)putchar(' ');
398                 }
399                 (void)putchar('\n');
400                 if (prtheader && lineno++ == prtheader - 4) {
401                         (void)putchar('\n');
402                         printheader();
403                         lineno = 0;
404                 }
405         }
406         free(uids);
407
408         exit(eval);
409 }
410
411 uid_t *
412 getuids(const char *arg, int *nuids)
413 {
414         char name[UT_NAMESIZE + 1];
415         struct passwd *pwd;
416         uid_t *uids, *moreuids;
417         size_t l;
418         int alloc;
419
420
421         alloc = 0;
422         *nuids = 0;
423         uids = NULL;
424         for (; (l = strcspn(arg, SEP)) > 0; arg += l + strspn(arg + l, SEP)) {
425                 if (l >= sizeof name) {
426                         warnx("%.*s: name too long", l, arg);
427                         continue;
428                 }
429                 strncpy(name, arg, l);
430                 name[l] = '\0';
431                 if ((pwd = getpwnam(name)) == NULL) {
432                         warnx("%s: no such user", name);
433                         continue;
434                 }
435                 if (*nuids >= alloc) {
436                         alloc = (alloc + 1) << 1;
437                         moreuids = realloc(uids, alloc * sizeof (*uids));
438                         if (moreuids == NULL) {
439                                 free(uids);
440                                 errx(1, "realloc: %s", strerror(errno));
441                         }
442                         uids = moreuids;
443                 }
444                 uids[(*nuids)++] = pwd->pw_uid;
445         }
446         endpwent();
447
448         if (!*nuids)
449                 errx(1, "No users specified");
450
451         return uids;
452 }
453
454 static void
455 scanvars(void)
456 {
457         struct varent *vent;
458         VAR *v;
459
460         for (vent = vhead; vent; vent = vent->next) {
461                 v = vent->var;
462                 if (v->flag & DSIZ) {
463                         v->dwidth = v->width;
464                         v->width = 0;
465                 }
466                 if (v->flag & USER)
467                         needuser = 1;
468                 if (v->flag & COMM)
469                         needcomm = 1;
470         }
471 }
472
473 static void
474 dynsizevars(KINFO *ki)
475 {
476         struct varent *vent;
477         VAR *v;
478         int i;
479
480         for (vent = vhead; vent; vent = vent->next) {
481                 v = vent->var;
482                 if (!(v->flag & DSIZ))
483                         continue;
484                 i = (v->sproc)( ki);
485                 if (v->width < i)
486                         v->width = i;
487                 if (v->width > v->dwidth)
488                         v->width = v->dwidth;
489         }
490 }
491
492 static void
493 sizevars(void)
494 {
495         struct varent *vent;
496         VAR *v;
497         int i;
498
499         for (vent = vhead; vent; vent = vent->next) {
500                 v = vent->var;
501                 i = strlen(v->header);
502                 if (v->width < i)
503                         v->width = i;
504                 totwidth += v->width + 1;       /* +1 for space */
505         }
506         totwidth--;
507 }
508
509 static const char *
510 getfmt(char **(*fn) (kvm_t *, const struct kinfo_proc *, int), KINFO *ki, char
511     *comm, int maxlen)
512 {
513         const char *s;
514
515         if ((s =
516             fmt_argv((*fn)(kd, ki->ki_p, termwidth), comm, maxlen)) == NULL)
517                 err(1, NULL);
518         return (s);
519 }
520
521 #define UREADOK(ki)     (forceuread || (KI_PROC(ki)->p_flag & P_INMEM))
522
523 static void
524 saveuser(KINFO *ki)
525 {
526         struct usave *usp;
527
528         usp = &ki->ki_u;
529
530         if (KI_PROC(ki)->p_flag & P_INMEM) {
531                 /*
532                  * The u-area might be swapped out, and we can't get
533                  * at it because we have a crashdump and no swap.
534                  * If it's here fill in these fields, otherwise, just
535                  * leave them 0.
536                  */
537                 usp->u_start = KI_THREAD(ki)->td_start;
538                 usp->u_ru = KI_EPROC(ki)->e_stats.p_ru;
539                 usp->u_cru = KI_EPROC(ki)->e_stats.p_cru;
540                 usp->u_valid = 1;
541         } else
542                 usp->u_valid = 0;
543         /*
544          * save arguments if needed
545          */
546         if (needcomm && (UREADOK(ki) || (KI_PROC(ki)->p_args != NULL))) {
547                 ki->ki_args = getfmt(kvm_getargv, ki, KI_THREAD(ki)->td_comm,
548                     MAXCOMLEN);
549         } else if (needcomm) {
550                 char *tmp;
551                 tmp = malloc(strlen(KI_THREAD(ki)->td_comm) + 3);
552                 sprintf(tmp, "(%s)", KI_THREAD(ki)->td_comm);
553                 ki->ki_args = tmp;
554         } else {
555                 ki->ki_args = NULL;
556         }
557         if (needenv && UREADOK(ki)) {
558                 ki->ki_env = getfmt(kvm_getenvv, ki, (char *)NULL, 0);
559         } else if (needenv) {
560                 ki->ki_env = "()";
561         } else {
562                 ki->ki_env = NULL;
563         }
564 }
565
566 static int
567 pscomp(const void *a, const void *b)
568 {
569         int i;
570 #define VSIZE(k) (KI_EPROC(k)->e_vm.vm_dsize + KI_EPROC(k)->e_vm.vm_ssize + \
571                   KI_EPROC(k)->e_vm.vm_tsize)
572
573         if (sortby == SORTCPU)
574                 return (getpcpu((const KINFO *)b) - getpcpu((const KINFO *)a));
575         if (sortby == SORTMEM)
576                 return (VSIZE((const KINFO *)b) - VSIZE((const KINFO *)a));
577         i =  KI_EPROC((const KINFO *)a)->e_tdev - KI_EPROC((const KINFO *)b)->e_tdev;
578         if (i == 0)
579                 i = KI_PROC((const KINFO *)a)->p_pid - KI_PROC((const KINFO *)b)->p_pid;
580         return (i);
581 }
582
583 /*
584  * ICK (all for getopt), would rather hide the ugliness
585  * here than taint the main code.
586  *
587  *  ps foo -> ps -foo
588  *  ps 34 -> ps -p34
589  *
590  * The old convention that 't' with no trailing tty arg means the users
591  * tty, is only supported if argv[1] doesn't begin with a '-'.  This same
592  * feature is available with the option 'T', which takes no argument.
593  */
594 static char *
595 kludge_oldps_options(char *s)
596 {
597         size_t len;
598         char *newopts, *ns, *cp;
599
600         len = strlen(s);
601         if ((newopts = ns = malloc(len + 2)) == NULL)
602                 err(1, NULL);
603         /*
604          * options begin with '-'
605          */
606         if (*s != '-')
607                 *ns++ = '-';    /* add option flag */
608         /*
609          * gaze to end of argv[1]
610          */
611         cp = s + len - 1;
612         /*
613          * if last letter is a 't' flag with no argument (in the context
614          * of the oldps options -- option string NOT starting with a '-' --
615          * then convert to 'T' (meaning *this* terminal, i.e. ttyname(0)).
616          *
617          * However, if a flag accepting a string argument is found in the
618          * option string, the remainder of the string is the argument to
619          * that flag; do not modify that argument.
620          */
621         if (strcspn(s, "MNOoU") == len && *cp == 't' && *s != '-')
622                 *cp = 'T';
623         else {
624                 /*
625                  * otherwise check for trailing number, which *may* be a
626                  * pid.
627                  */
628                 while (cp >= s && isdigit(*cp))
629                         --cp;
630         }
631         cp++;
632         memmove(ns, s, (size_t)(cp - s));       /* copy up to trailing number */
633         ns += cp - s;
634         /*
635          * if there's a trailing number, and not a preceding 'p' (pid) or
636          * 't' (tty) flag, then assume it's a pid and insert a 'p' flag.
637          */
638         if (isdigit(*cp) &&
639             (cp == s || (cp[-1] != 't' && cp[-1] != 'p')) &&
640             (cp - 1 == s || cp[-2] != 't'))
641                 *ns++ = 'p';
642         (void)strcpy(ns, cp);           /* and append the number */
643
644         return (newopts);
645 }
646
647 static void
648 usage(void)
649 {
650
651         (void)fprintf(stderr, "%s\n%s\n%s\n",
652             "usage: ps [-aChjlmrSTuvwx] [-O|o fmt] [-p pid] [-t tty] [-U user]",
653             "          [-M core] [-N system]",
654             "       ps [-L]");
655         exit(1);
656 }