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