procps/ps.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Mini ps implementation(s) for busybox
   4  *
   5  * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
   6  * Fix for SELinux Support:(c)2007 Hiroshi Shinji <shiroshi@my.email.ne.jp>
   7  *                         (c)2007 Yuichi Nakamura <ynakam@hitachisoft.jp>
   8  *
   9  * Licensed under GPLv2, see file LICENSE in this source tree.
  10  */
  11
  12 #include "libbb.h"
  13
  14 /* Absolute maximum on output line length */
  15 enum { MAX_WIDTH = 2*1024 };
  16
  17 #if ENABLE_DESKTOP
  18
  19 #include <sys/times.h> /* for times() */
  20 #ifndef AT_CLKTCK
  21 #define AT_CLKTCK 17
  22 #endif
  23
  24
  25 #if ENABLE_SELINUX
  26 #define SELINUX_O_PREFIX "label,"
  27 #define DEFAULT_O_STR    (SELINUX_O_PREFIX "pid,user" IF_FEATURE_PS_TIME(",time") ",args")
  28 #else
  29 #define DEFAULT_O_STR    ("pid,user" IF_FEATURE_PS_TIME(",time") ",args")
  30 #endif
  31
  32 typedef struct {
  33         uint16_t width;
  34         char name6[6];
  35         const char *header;
  36         void (*f)(char *buf, int size, const procps_status_t *ps);
  37         int ps_flags;
  38 } ps_out_t;
  39
  40 struct globals {
  41         ps_out_t* out;
  42         int out_cnt;
  43         int print_header;
  44         int need_flags;
  45         char *buffer;
  46         unsigned terminal_width;
  47 #if ENABLE_FEATURE_PS_TIME
  48         unsigned kernel_HZ;
  49         unsigned long long seconds_since_boot;
  50 #endif
  51         char default_o[sizeof(DEFAULT_O_STR)];
  52 } FIX_ALIASING;
  53 #define G (*(struct globals*)&bb_common_bufsiz1)
  54 #define out                (G.out               )
  55 #define out_cnt            (G.out_cnt           )
  56 #define print_header       (G.print_header      )
  57 #define need_flags         (G.need_flags        )
  58 #define buffer             (G.buffer            )
  59 #define terminal_width     (G.terminal_width    )
  60 #define kernel_HZ          (G.kernel_HZ         )
  61 #define seconds_since_boot (G.seconds_since_boot)
  62 #define default_o          (G.default_o         )
  63 #define INIT_G() do { } while (0)
  64
  65 #if ENABLE_FEATURE_PS_TIME
  66 /* for ELF executables, notes are pushed before environment and args */
  67 static ptrdiff_t find_elf_note(ptrdiff_t findme)
  68 {
  69         ptrdiff_t *ep = (ptrdiff_t *) environ;
  70
  71         while (*ep++);
  72         while (*ep) {
  73                 if (ep[0] == findme) {
  74                         return ep[1];
  75                 }
  76                 ep += 2;
  77         }
  78         return -1;
  79 }
  80
  81 #if ENABLE_FEATURE_PS_UNUSUAL_SYSTEMS
  82 static unsigned get_HZ_by_waiting(void)
  83 {
  84         struct timeval tv1, tv2;
  85         unsigned t1, t2, r, hz;
  86         unsigned cnt = cnt; /* for compiler */
  87         int diff;
  88
  89         r = 0;
  90
  91         /* Wait for times() to reach new tick */
  92         t1 = times(NULL);
  93         do {
  94                 t2 = times(NULL);
  95         } while (t2 == t1);
  96         gettimeofday(&tv2, NULL);
  97
  98         do {
  99                 t1 = t2;
 100                 tv1.tv_usec = tv2.tv_usec;
 101
 102                 /* Wait exactly one times() tick */
 103                 do {
 104                         t2 = times(NULL);
 105                 } while (t2 == t1);
 106                 gettimeofday(&tv2, NULL);
 107
 108                 /* Calculate ticks per sec, rounding up to even */
 109                 diff = tv2.tv_usec - tv1.tv_usec;
 110                 if (diff <= 0) diff += 1000000;
 111                 hz = 1000000u / (unsigned)diff;
 112                 hz = (hz+1) & ~1;
 113
 114                 /* Count how many same hz values we saw */
 115                 if (r != hz) {
 116                         r = hz;
 117                         cnt = 0;
 118                 }
 119                 cnt++;
 120         } while (cnt < 3); /* exit if saw 3 same values */
 121
 122         return r;
 123 }
 124 #else
 125 static inline unsigned get_HZ_by_waiting(void)
 126 {
 127         /* Better method? */
 128         return 100;
 129 }
 130 #endif
 131
 132 static unsigned get_kernel_HZ(void)
 133 {
 134         //char buf[64];
 135         struct sysinfo info;
 136
 137         if (kernel_HZ)
 138                 return kernel_HZ;
 139
 140         /* Works for ELF only, Linux 2.4.0+ */
 141         kernel_HZ = find_elf_note(AT_CLKTCK);
 142         if (kernel_HZ == (unsigned)-1)
 143                 kernel_HZ = get_HZ_by_waiting();
 144
 145         //if (open_read_close("/proc/uptime", buf, sizeof(buf)) <= 0)
 146         //      bb_perror_msg_and_die("can't read %s", "/proc/uptime");
 147         //buf[sizeof(buf)-1] = '\0';
 148         ///sscanf(buf, "%llu", &seconds_since_boot);
 149         sysinfo(&info);
 150         seconds_since_boot = info.uptime;
 151
 152         return kernel_HZ;
 153 }
 154 #endif
 155
 156 /* Print value to buf, max size+1 chars (including trailing '\0') */
 157
 158 static void func_user(char *buf, int size, const procps_status_t *ps)
 159 {
 160 #if 1
 161         safe_strncpy(buf, get_cached_username(ps->uid), size+1);
 162 #else
 163         /* "compatible" version, but it's larger */
 164         /* procps 2.18 shows numeric UID if name overflows the field */
 165         /* TODO: get_cached_username() returns numeric string if
 166          * user has no passwd record, we will display it
 167          * left-justified here; too long usernames are shown
 168          * as _right-justified_ IDs. Is it worth fixing? */
 169         const char *user = get_cached_username(ps->uid);
 170         if (strlen(user) <= size)
 171                 safe_strncpy(buf, user, size+1);
 172         else
 173                 sprintf(buf, "%*u", size, (unsigned)ps->uid);
 174 #endif
 175 }
 176
 177 static void func_group(char *buf, int size, const procps_status_t *ps)
 178 {
 179         safe_strncpy(buf, get_cached_groupname(ps->gid), size+1);
 180 }
 181
 182 static void func_comm(char *buf, int size, const procps_status_t *ps)
 183 {
 184         safe_strncpy(buf, ps->comm, size+1);
 185 }
 186
 187 static void func_args(char *buf, int size, const procps_status_t *ps)
 188 {
 189         read_cmdline(buf, size+1, ps->pid, ps->comm);
 190 }
 191
 192 static void func_pid(char *buf, int size, const procps_status_t *ps)
 193 {
 194         sprintf(buf, "%*u", size, ps->pid);
 195 }
 196
 197 static void func_ppid(char *buf, int size, const procps_status_t *ps)
 198 {
 199         sprintf(buf, "%*u", size, ps->ppid);
 200 }
 201
 202 static void func_pgid(char *buf, int size, const procps_status_t *ps)
 203 {
 204         sprintf(buf, "%*u", size, ps->pgid);
 205 }
 206
 207 static void put_lu(char *buf, int size, unsigned long u)
 208 {
 209         char buf4[5];
 210
 211         /* see http://en.wikipedia.org/wiki/Tera */
 212         smart_ulltoa4(u, buf4, " mgtpezy");
 213         buf4[4] = '\0';
 214         sprintf(buf, "%.*s", size, buf4);
 215 }
 216
 217 static void func_vsz(char *buf, int size, const procps_status_t *ps)
 218 {
 219         put_lu(buf, size, ps->vsz);
 220 }
 221
 222 static void func_rss(char *buf, int size, const procps_status_t *ps)
 223 {
 224         put_lu(buf, size, ps->rss);
 225 }
 226
 227 static void func_tty(char *buf, int size, const procps_status_t *ps)
 228 {
 229         buf[0] = '?';
 230         buf[1] = '\0';
 231         if (ps->tty_major) /* tty field of "0" means "no tty" */
 232                 snprintf(buf, size+1, "%u,%u", ps->tty_major, ps->tty_minor);
 233 }
 234
 235 #if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
 236
 237 static void func_rgroup(char *buf, int size, const procps_status_t *ps)
 238 {
 239         safe_strncpy(buf, get_cached_groupname(ps->rgid), size+1);
 240 }
 241
 242 static void func_ruser(char *buf, int size, const procps_status_t *ps)
 243 {
 244         safe_strncpy(buf, get_cached_username(ps->ruid), size+1);
 245 }
 246
 247 static void func_nice(char *buf, int size, const procps_status_t *ps)
 248 {
 249         sprintf(buf, "%*d", size, ps->niceness);
 250 }
 251
 252 #endif
 253
 254 #if ENABLE_FEATURE_PS_TIME
 255
 256 static void func_etime(char *buf, int size, const procps_status_t *ps)
 257 {
 258         /* elapsed time [[dd-]hh:]mm:ss; here only mm:ss */
 259         unsigned long mm;
 260         unsigned ss;
 261
 262         mm = ps->start_time / get_kernel_HZ();
 263         /* must be after get_kernel_HZ()! */
 264         mm = seconds_since_boot - mm;
 265         ss = mm % 60;
 266         mm /= 60;
 267         snprintf(buf, size+1, "%3lu:%02u", mm, ss);
 268 }
 269
 270 static void func_time(char *buf, int size, const procps_status_t *ps)
 271 {
 272         /* cumulative time [[dd-]hh:]mm:ss; here only mm:ss */
 273         unsigned long mm;
 274         unsigned ss;
 275
 276         mm = (ps->utime + ps->stime) / get_kernel_HZ();
 277         ss = mm % 60;
 278         mm /= 60;
 279         snprintf(buf, size+1, "%3lu:%02u", mm, ss);
 280 }
 281
 282 #endif
 283
 284 #if ENABLE_SELINUX
 285 static void func_label(char *buf, int size, const procps_status_t *ps)
 286 {
 287         safe_strncpy(buf, ps->context ? ps->context : "unknown", size+1);
 288 }
 289 #endif
 290
 291 /*
 292 static void func_nice(char *buf, int size, const procps_status_t *ps)
 293 {
 294         ps->???
 295 }
 296
 297 static void func_pcpu(char *buf, int size, const procps_status_t *ps)
 298 {
 299 }
 300 */
 301
 302 static const ps_out_t out_spec[] = {
 303 // Mandated by POSIX:
 304         { 8                  , "user"  ,"USER"   ,func_user  ,PSSCAN_UIDGID  },
 305         { 8                  , "group" ,"GROUP"  ,func_group ,PSSCAN_UIDGID  },
 306         { 16                 , "comm"  ,"COMMAND",func_comm  ,PSSCAN_COMM    },
 307         { MAX_WIDTH          , "args"  ,"COMMAND",func_args  ,PSSCAN_COMM    },
 308         { 5                  , "pid"   ,"PID"    ,func_pid   ,PSSCAN_PID     },
 309         { 5                  , "ppid"  ,"PPID"   ,func_ppid  ,PSSCAN_PPID    },
 310         { 5                  , "pgid"  ,"PGID"   ,func_pgid  ,PSSCAN_PGID    },
 311 #if ENABLE_FEATURE_PS_TIME
 312         { sizeof("ELAPSED")-1, "etime" ,"ELAPSED",func_etime ,PSSCAN_START_TIME },
 313 #endif
 314 #if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
 315         { 5                  , "nice"  ,"NI"     ,func_nice  ,PSSCAN_NICE    },
 316         { 8                  , "rgroup","RGROUP" ,func_rgroup,PSSCAN_RUIDGID },
 317         { 8                  , "ruser" ,"RUSER"  ,func_ruser ,PSSCAN_RUIDGID },
 318 //      { 5                  , "pcpu"  ,"%CPU"   ,func_pcpu  ,PSSCAN_        },
 319 #endif
 320 #if ENABLE_FEATURE_PS_TIME
 321         { 6                  , "time"  ,"TIME"   ,func_time  ,PSSCAN_STIME | PSSCAN_UTIME },
 322 #endif
 323         { 6                  , "tty"   ,"TT"     ,func_tty   ,PSSCAN_TTY     },
 324         { 4                  , "vsz"   ,"VSZ"    ,func_vsz   ,PSSCAN_VSZ     },
 325 // Not mandated by POSIX, but useful:
 326         { 4                  , "rss"   ,"RSS"    ,func_rss   ,PSSCAN_RSS     },
 327 #if ENABLE_SELINUX
 328         { 35                 , "label" ,"LABEL"  ,func_label ,PSSCAN_CONTEXT },
 329 #endif
 330 };
 331
 332 static ps_out_t* new_out_t(void)
 333 {
 334         out = xrealloc_vector(out, 2, out_cnt);
 335         return &out[out_cnt++];
 336 }
 337
 338 static const ps_out_t* find_out_spec(const char *name)
 339 {
 340         unsigned i;
 341         char buf[ARRAY_SIZE(out_spec)*7 + 1];
 342         char *p = buf;
 343
 344         for (i = 0; i < ARRAY_SIZE(out_spec); i++) {
 345                 if (strncmp(name, out_spec[i].name6, 6) == 0)
 346                         return &out_spec[i];
 347                 p += sprintf(p, "%.6s,", out_spec[i].name6);
 348         }
 349         p[-1] = '\0';
 350         bb_error_msg_and_die("bad -o argument '%s', supported arguments: %s", name, buf);
 351 }
 352
 353 static void parse_o(char* opt)
 354 {
 355         ps_out_t* new;
 356         // POSIX: "-o is blank- or comma-separated list" (FIXME)
 357         char *comma, *equal;
 358         while (1) {
 359                 comma = strchr(opt, ',');
 360                 equal = strchr(opt, '=');
 361                 if (comma && (!equal || equal > comma)) {
 362                         *comma = '\0';
 363                         *new_out_t() = *find_out_spec(opt);
 364                         *comma = ',';
 365                         opt = comma + 1;
 366                         continue;
 367                 }
 368                 break;
 369         }
 370         // opt points to last spec in comma separated list.
 371         // This one can have =HEADER part.
 372         new = new_out_t();
 373         if (equal)
 374                 *equal = '\0';
 375         *new = *find_out_spec(opt);
 376         if (equal) {
 377                 *equal = '=';
 378                 new->header = equal + 1;
 379                 // POSIX: the field widths shall be ... at least as wide as
 380                 // the header text (default or overridden value).
 381                 // If the header text is null, such as -o user=,
 382                 // the field width shall be at least as wide as the
 383                 // default header text
 384                 if (new->header[0]) {
 385                         new->width = strlen(new->header);
 386                         print_header = 1;
 387                 }
 388         } else
 389                 print_header = 1;
 390 }
 391
 392 static void alloc_line_buffer(void)
 393 {
 394         int i;
 395         int width = 0;
 396         for (i = 0; i < out_cnt; i++) {
 397                 need_flags |= out[i].ps_flags;
 398                 if (out[i].header[0]) {
 399                         print_header = 1;
 400                 }
 401                 width += out[i].width + 1; /* "FIELD " */
 402                 if ((int)(width - terminal_width) > 0) {
 403                         /* The rest does not fit on the screen */
 404                         //out[i].width -= (width - terminal_width - 1);
 405                         out_cnt = i + 1;
 406                         break;
 407                 }
 408         }
 409 #if ENABLE_SELINUX
 410         if (!is_selinux_enabled())
 411                 need_flags &= ~PSSCAN_CONTEXT;
 412 #endif
 413         buffer = xmalloc(width + 1); /* for trailing \0 */
 414 }
 415
 416 static void format_header(void)
 417 {
 418         int i;
 419         ps_out_t* op;
 420         char *p;
 421
 422         if (!print_header)
 423                 return;
 424         p = buffer;
 425         i = 0;
 426         if (out_cnt) {
 427                 while (1) {
 428                         op = &out[i];
 429                         if (++i == out_cnt) /* do not pad last field */
 430                                 break;
 431                         p += sprintf(p, "%-*s ", op->width, op->header);
 432                 }
 433                 strcpy(p, op->header);
 434         }
 435         printf("%.*s\n", terminal_width, buffer);
 436 }
 437
 438 static void format_process(const procps_status_t *ps)
 439 {
 440         int i, len;
 441         char *p = buffer;
 442         i = 0;
 443         if (out_cnt) while (1) {
 444                 out[i].f(p, out[i].width, ps);
 445                 // POSIX: Any field need not be meaningful in all
 446                 // implementations. In such a case a hyphen ( '-' )
 447                 // should be output in place of the field value.
 448                 if (!p[0]) {
 449                         p[0] = '-';
 450                         p[1] = '\0';
 451                 }
 452                 len = strlen(p);
 453                 p += len;
 454                 len = out[i].width - len + 1;
 455                 if (++i == out_cnt) /* do not pad last field */
 456                         break;
 457                 p += sprintf(p, "%*s", len, "");
 458         }
 459         printf("%.*s\n", terminal_width, buffer);
 460 }
 461
 462 int ps_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 463 int ps_main(int argc UNUSED_PARAM, char **argv)
 464 {
 465         procps_status_t *p;
 466         llist_t* opt_o = NULL;
 467         int opt;
 468         enum {
 469                 OPT_Z = (1 << 0),
 470                 OPT_o = (1 << 1),
 471                 OPT_a = (1 << 2),
 472                 OPT_A = (1 << 3),
 473                 OPT_d = (1 << 4),
 474                 OPT_e = (1 << 5),
 475                 OPT_f = (1 << 6),
 476                 OPT_l = (1 << 7),
 477                 OPT_T = (1 << 8) * ENABLE_FEATURE_SHOW_THREADS,
 478         };
 479
 480         INIT_G();
 481
 482         // POSIX:
 483         // -a  Write information for all processes associated with terminals
 484         //     Implementations may omit session leaders from this list
 485         // -A  Write information for all processes
 486         // -d  Write information for all processes, except session leaders
 487         // -e  Write information for all processes (equivalent to -A)
 488         // -f  Generate a full listing
 489         // -l  Generate a long listing
 490         // -o col1,col2,col3=header
 491         //     Select which columns to display
 492         /* We allow (and ignore) most of the above. FIXME.
 493          * -T is picked for threads (POSIX hasn't it standardized).
 494          * procps v3.2.7 supports -T and shows tids as SPID column,
 495          * it also supports -L where it shows tids as LWP column.
 496          */
 497         opt_complementary = "o::";
 498         opt = getopt32(argv, "Zo:aAdefl"IF_FEATURE_SHOW_THREADS("T"), &opt_o);
 499         if (opt_o) {
 500                 do {
 501                         parse_o(llist_pop(&opt_o));
 502                 } while (opt_o);
 503         } else {
 504                 /* Below: parse_o() needs char*, NOT const char*... */
 505 #if ENABLE_SELINUX
 506                 if (!(opt & OPT_Z) || !is_selinux_enabled()) {
 507                         /* no -Z or no SELinux: do not show LABEL */
 508                         strcpy(default_o, DEFAULT_O_STR + sizeof(SELINUX_O_PREFIX)-1);
 509                 } else
 510 #endif
 511                 {
 512                         strcpy(default_o, DEFAULT_O_STR);
 513                 }
 514                 parse_o(default_o);
 515         }
 516 #if ENABLE_FEATURE_SHOW_THREADS
 517         if (opt & OPT_T)
 518                 need_flags |= PSSCAN_TASKS;
 519 #endif
 520
 521         /* Was INT_MAX, but some libc's go belly up with printf("%.*s")
 522          * and such large widths */
 523         terminal_width = MAX_WIDTH;
 524         if (isatty(1)) {
 525                 get_terminal_width_height(0, &terminal_width, NULL);
 526                 if (--terminal_width > MAX_WIDTH)
 527                         terminal_width = MAX_WIDTH;
 528         }
 529         alloc_line_buffer();
 530         format_header();
 531
 532         p = NULL;
 533         while ((p = procps_scan(p, need_flags)) != NULL) {
 534                 format_process(p);
 535         }
 536
 537         return EXIT_SUCCESS;
 538 }
 539
 540
 541 #else /* !ENABLE_DESKTOP */
 542
 543
 544 int ps_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 545 int ps_main(int argc UNUSED_PARAM, char **argv UNUSED_PARAM)
 546 {
 547         procps_status_t *p;
 548         int psscan_flags = PSSCAN_PID | PSSCAN_UIDGID
 549                         | PSSCAN_STATE | PSSCAN_VSZ | PSSCAN_COMM;
 550         unsigned terminal_width IF_NOT_FEATURE_PS_WIDE(= 79);
 551         enum {
 552                 OPT_Z = (1 << 0) * ENABLE_SELINUX,
 553                 OPT_T = (1 << ENABLE_SELINUX) * ENABLE_FEATURE_SHOW_THREADS,
 554         };
 555         int opts = 0;
 556         /* If we support any options, parse argv */
 557 #if ENABLE_SELINUX || ENABLE_FEATURE_SHOW_THREADS || ENABLE_FEATURE_PS_WIDE
 558 # if ENABLE_FEATURE_PS_WIDE
 559         /* -w is a bit complicated */
 560         int w_count = 0;
 561         opt_complementary = "-:ww";
 562         opts = getopt32(argv, IF_SELINUX("Z")IF_FEATURE_SHOW_THREADS("T")"w", &w_count);
 563         /* if w is given once, GNU ps sets the width to 132,
 564          * if w is given more than once, it is "unlimited"
 565          */
 566         if (w_count) {
 567                 terminal_width = (w_count == 1) ? 132 : MAX_WIDTH;
 568         } else {
 569                 get_terminal_width_height(0, &terminal_width, NULL);
 570                 /* Go one less... */
 571                 if (--terminal_width > MAX_WIDTH)
 572                         terminal_width = MAX_WIDTH;
 573         }
 574 # else
 575         /* -w is not supported, only -Z and/or -T */
 576         opt_complementary = "-";
 577         opts = getopt32(argv, IF_SELINUX("Z")IF_FEATURE_SHOW_THREADS("T"));
 578 # endif
 579 #endif
 580
 581 #if ENABLE_SELINUX
 582         if ((opts & OPT_Z) && is_selinux_enabled()) {
 583                 psscan_flags = PSSCAN_PID | PSSCAN_CONTEXT
 584                                 | PSSCAN_STATE | PSSCAN_COMM;
 585                 puts("  PID CONTEXT                          STAT COMMAND");
 586         } else
 587 #endif
 588         {
 589                 puts("  PID USER       VSZ STAT COMMAND");
 590         }
 591         if (opts & OPT_T) {
 592                 psscan_flags |= PSSCAN_TASKS;
 593         }
 594
 595         p = NULL;
 596         while ((p = procps_scan(p, psscan_flags)) != NULL) {
 597                 int len;
 598 #if ENABLE_SELINUX
 599                 if (psscan_flags & PSSCAN_CONTEXT) {
 600                         len = printf("%5u %-32.32s %s  ",
 601                                         p->pid,
 602                                         p->context ? p->context : "unknown",
 603                                         p->state);
 604                 } else
 605 #endif
 606                 {
 607                         const char *user = get_cached_username(p->uid);
 608                         //if (p->vsz == 0)
 609                         //      len = printf("%5u %-8.8s        %s ",
 610                         //              p->pid, user, p->state);
 611                         //else
 612                         {
 613                                 char buf6[6];
 614                                 smart_ulltoa5(p->vsz, buf6, " mgtpezy");
 615                                 buf6[5] = '\0';
 616                                 len = printf("%5u %-8.8s %s %s  ",
 617                                         p->pid, user, buf6, p->state);
 618                         }
 619                 }
 620
 621                 {
 622                         int sz = terminal_width - len;
 623                         char buf[sz + 1];
 624                         read_cmdline(buf, sz, p->pid, p->comm);
 625                         puts(buf);
 626                 }
 627         }
 628         if (ENABLE_FEATURE_CLEAN_UP)
 629                 clear_username_cache();
 630         return EXIT_SUCCESS;
 631 }
 632
 633 #endif /* !ENABLE_DESKTOP */