Initial public busybox upstream commit
[busybox4maemo] / 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 the GPL version 2, see the file LICENSE in this tarball.
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 //#include <sys/sysinfo.h> /* for sysinfo() */
21 #ifndef AT_CLKTCK
22 #define AT_CLKTCK 17
23 #endif
24
25
26 #if ENABLE_SELINUX
27 #define SELINIX_O_PREFIX "label,"
28 #define DEFAULT_O_STR    (SELINIX_O_PREFIX "pid,user" USE_FEATURE_PS_TIME(",time") ",args")
29 #else
30 #define DEFAULT_O_STR    ("pid,user" USE_FEATURE_PS_TIME(",time") ",args")
31 #endif
32
33 typedef struct {
34         uint16_t width;
35         char name[6];
36         const char *header;
37         void (*f)(char *buf, int size, const procps_status_t *ps);
38         int ps_flags;
39 } ps_out_t;
40
41 struct globals {
42         ps_out_t* out;
43         int out_cnt;
44         int print_header;
45         int need_flags;
46         char *buffer;
47         unsigned terminal_width;
48 #if ENABLE_FEATURE_PS_TIME
49         unsigned kernel_HZ;
50         unsigned long long seconds_since_boot;
51 #endif
52         char default_o[sizeof(DEFAULT_O_STR)];
53 };
54 #define G (*(struct globals*)&bb_common_bufsiz1)
55 #define out                (G.out               )
56 #define out_cnt            (G.out_cnt           )
57 #define print_header       (G.print_header      )
58 #define need_flags         (G.need_flags        )
59 #define buffer             (G.buffer            )
60 #define terminal_width     (G.terminal_width    )
61 #define kernel_HZ          (G.kernel_HZ         )
62 #define seconds_since_boot (G.seconds_since_boot)
63 #define default_o          (G.default_o         )
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("cannot 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_comm(char *buf, int size, const procps_status_t *ps)
178 {
179         safe_strncpy(buf, ps->comm, size+1);
180 }
181
182 static void func_args(char *buf, int size, const procps_status_t *ps)
183 {
184         read_cmdline(buf, size, ps->pid, ps->comm);
185 }
186
187 static void func_pid(char *buf, int size, const procps_status_t *ps)
188 {
189         sprintf(buf, "%*u", size, ps->pid);
190 }
191
192 static void func_ppid(char *buf, int size, const procps_status_t *ps)
193 {
194         sprintf(buf, "%*u", size, ps->ppid);
195 }
196
197 static void func_pgid(char *buf, int size, const procps_status_t *ps)
198 {
199         sprintf(buf, "%*u", size, ps->pgid);
200 }
201
202 static void put_lu(char *buf, int size, unsigned long u)
203 {
204         char buf4[5];
205
206         /* see http://en.wikipedia.org/wiki/Tera */
207         smart_ulltoa4(u, buf4, " mgtpezy");
208         buf4[4] = '\0';
209         sprintf(buf, "%.*s", size, buf4);
210 }
211
212 static void func_vsz(char *buf, int size, const procps_status_t *ps)
213 {
214         put_lu(buf, size, ps->vsz);
215 }
216
217 static void func_rss(char *buf, int size, const procps_status_t *ps)
218 {
219         put_lu(buf, size, ps->rss);
220 }
221
222 static void func_tty(char *buf, int size, const procps_status_t *ps)
223 {
224         buf[0] = '?';
225         buf[1] = '\0';
226         if (ps->tty_major) /* tty field of "0" means "no tty" */
227                 snprintf(buf, size+1, "%u,%u", ps->tty_major, ps->tty_minor);
228 }
229
230 #if ENABLE_FEATURE_PS_TIME
231 static void func_etime(char *buf, int size, const procps_status_t *ps)
232 {
233         /* elapsed time [[dd-]hh:]mm:ss; here only mm:ss */
234         unsigned long mm;
235         unsigned ss;
236
237         mm = ps->start_time / get_kernel_HZ();
238         /* must be after get_kernel_HZ()! */
239         mm = seconds_since_boot - mm;
240         ss = mm % 60;
241         mm /= 60;
242         snprintf(buf, size+1, "%3lu:%02u", mm, ss);
243 }
244
245 static void func_time(char *buf, int size, const procps_status_t *ps)
246 {
247         /* cumulative time [[dd-]hh:]mm:ss; here only mm:ss */
248         unsigned long mm;
249         unsigned ss;
250
251         mm = (ps->utime + ps->stime) / get_kernel_HZ();
252         ss = mm % 60;
253         mm /= 60;
254         snprintf(buf, size+1, "%3lu:%02u", mm, ss);
255 }
256 #endif
257
258 #if ENABLE_SELINUX
259 static void func_label(char *buf, int size, const procps_status_t *ps)
260 {
261         safe_strncpy(buf, ps->context ? ps->context : "unknown", size+1);
262 }
263 #endif
264
265 /*
266 static void func_nice(char *buf, int size, const procps_status_t *ps)
267 {
268         ps->???
269 }
270
271 static void func_pcpu(char *buf, int size, const procps_status_t *ps)
272 {
273 }
274 */
275
276 static const ps_out_t out_spec[] = {
277 // Mandated by POSIX:
278         { 8                  , "user"  ,"USER"   ,func_user  ,PSSCAN_UIDGID  },
279         { 16                 , "comm"  ,"COMMAND",func_comm  ,PSSCAN_COMM    },
280         { 256                , "args"  ,"COMMAND",func_args  ,PSSCAN_COMM    },
281         { 5                  , "pid"   ,"PID"    ,func_pid   ,PSSCAN_PID     },
282         { 5                  , "ppid"  ,"PPID"   ,func_ppid  ,PSSCAN_PPID    },
283         { 5                  , "pgid"  ,"PGID"   ,func_pgid  ,PSSCAN_PGID    },
284 #if ENABLE_FEATURE_PS_TIME
285         { sizeof("ELAPSED")-1, "etime" ,"ELAPSED",func_etime ,PSSCAN_START_TIME },
286 #endif
287 //      { sizeof("GROUP"  )-1, "group" ,"GROUP"  ,func_group ,PSSCAN_UIDGID  },
288 //      { sizeof("NI"     )-1, "nice"  ,"NI"     ,func_nice  ,PSSCAN_        },
289 //      { sizeof("%CPU"   )-1, "pcpu"  ,"%CPU"   ,func_pcpu  ,PSSCAN_        },
290 //      { sizeof("RGROUP" )-1, "rgroup","RGROUP" ,func_rgroup,PSSCAN_UIDGID  },
291 //      { sizeof("RUSER"  )-1, "ruser" ,"RUSER"  ,func_ruser ,PSSCAN_UIDGID  },
292 #if ENABLE_FEATURE_PS_TIME
293         { 6                  , "time"  ,"TIME"   ,func_time  ,PSSCAN_STIME | PSSCAN_UTIME },
294 #endif
295         { 6                  , "tty"   ,"TT"     ,func_tty   ,PSSCAN_TTY     },
296         { 4                  , "vsz"   ,"VSZ"    ,func_vsz   ,PSSCAN_VSZ     },
297 // Not mandated by POSIX, but useful:
298         { 4                  , "rss"   ,"RSS"    ,func_rss   ,PSSCAN_RSS     },
299 #if ENABLE_SELINUX
300         { 35                 , "label" ,"LABEL"  ,func_label ,PSSCAN_CONTEXT },
301 #endif
302 };
303
304 static ps_out_t* new_out_t(void)
305 {
306         int i = out_cnt++;
307         out = xrealloc(out, out_cnt * sizeof(*out));
308         return &out[i];
309 }
310
311 static const ps_out_t* find_out_spec(const char *name)
312 {
313         int i;
314         for (i = 0; i < ARRAY_SIZE(out_spec); i++) {
315                 if (!strcmp(name, out_spec[i].name))
316                         return &out_spec[i];
317         }
318         bb_error_msg_and_die("bad -o argument '%s'", name);
319 }
320
321 static void parse_o(char* opt)
322 {
323         ps_out_t* new;
324         // POSIX: "-o is blank- or comma-separated list" (FIXME)
325         char *comma, *equal;
326         while (1) {
327                 comma = strchr(opt, ',');
328                 equal = strchr(opt, '=');
329                 if (comma && (!equal || equal > comma)) {
330                         *comma = '\0';
331                         *new_out_t() = *find_out_spec(opt);
332                         *comma = ',';
333                         opt = comma + 1;
334                         continue;
335                 }
336                 break;
337         }
338         // opt points to last spec in comma separated list.
339         // This one can have =HEADER part.
340         new = new_out_t();
341         if (equal)
342                 *equal = '\0';
343         *new = *find_out_spec(opt);
344         if (equal) {
345                 *equal = '=';
346                 new->header = equal + 1;
347                 // POSIX: the field widths shall be ... at least as wide as
348                 // the header text (default or overridden value).
349                 // If the header text is null, such as -o user=,
350                 // the field width shall be at least as wide as the
351                 // default header text
352                 if (new->header[0]) {
353                         new->width = strlen(new->header);
354                         print_header = 1;
355                 }
356         } else
357                 print_header = 1;
358 }
359
360 static void post_process(void)
361 {
362         int i;
363         int width = 0;
364         for (i = 0; i < out_cnt; i++) {
365                 need_flags |= out[i].ps_flags;
366                 if (out[i].header[0]) {
367                         print_header = 1;
368                 }
369                 width += out[i].width + 1; /* "FIELD " */
370         }
371 #if ENABLE_SELINUX
372         if (!is_selinux_enabled())
373                 need_flags &= ~PSSCAN_CONTEXT;
374 #endif
375         buffer = xmalloc(width + 1); /* for trailing \0 */
376 }
377
378 static void format_header(void)
379 {
380         int i;
381         ps_out_t* op;
382         char *p;
383
384         if (!print_header)
385                 return;
386         p = buffer;
387         i = 0;
388         if (out_cnt) {
389                 while (1) {
390                         op = &out[i];
391                         if (++i == out_cnt) /* do not pad last field */
392                                 break;
393                         p += sprintf(p, "%-*s ", op->width, op->header);
394                 }
395                 strcpy(p, op->header);
396         }
397         printf("%.*s\n", terminal_width, buffer);
398 }
399
400 static void format_process(const procps_status_t *ps)
401 {
402         int i, len;
403         char *p = buffer;
404         i = 0;
405         if (out_cnt) while (1) {
406                 out[i].f(p, out[i].width, ps);
407                 // POSIX: Any field need not be meaningful in all
408                 // implementations. In such a case a hyphen ( '-' )
409                 // should be output in place of the field value.
410                 if (!p[0]) {
411                         p[0] = '-';
412                         p[1] = '\0';
413                 }
414                 len = strlen(p);
415                 p += len;
416                 len = out[i].width - len + 1;
417                 if (++i == out_cnt) /* do not pad last field */
418                         break;
419                 p += sprintf(p, "%*s", len, "");
420         }
421         printf("%.*s\n", terminal_width, buffer);
422 }
423
424 int ps_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
425 int ps_main(int argc ATTRIBUTE_UNUSED, char **argv)
426 {
427         procps_status_t *p;
428         llist_t* opt_o = NULL;
429         USE_SELINUX(int opt;)
430
431         // POSIX:
432         // -a  Write information for all processes associated with terminals
433         //     Implementations may omit session leaders from this list
434         // -A  Write information for all processes
435         // -d  Write information for all processes, except session leaders
436         // -e  Write information for all processes (equivalent to -A.)
437         // -f  Generate a full listing
438         // -l  Generate a long listing
439         // -o col1,col2,col3=header
440         //     Select which columns to display
441         /* We allow (and ignore) most of the above. FIXME */
442         opt_complementary = "o::";
443         USE_SELINUX(opt =) getopt32(argv, "Zo:aAdefl", &opt_o);
444         if (opt_o) {
445                 do {
446                         parse_o(opt_o->data);
447                         opt_o = opt_o->link;
448                 } while (opt_o);
449         } else {
450                 /* Below: parse_o() needs char*, NOT const char*... */
451 #if ENABLE_SELINUX
452                 if (!(opt & 1) || !is_selinux_enabled()) {
453                         /* no -Z or no SELinux: do not show LABEL */
454                         strcpy(default_o, DEFAULT_O_STR + sizeof(SELINIX_O_PREFIX)-1);
455                 } else
456 #endif
457                 {
458                         strcpy(default_o, DEFAULT_O_STR);
459                 }
460                 parse_o(default_o);
461         }
462         post_process();
463
464         /* Was INT_MAX, but some libc's go belly up with printf("%.*s")
465          * and such large widths */
466         terminal_width = MAX_WIDTH;
467         if (isatty(1)) {
468                 get_terminal_width_height(0, &terminal_width, NULL);
469                 if (--terminal_width > MAX_WIDTH)
470                         terminal_width = MAX_WIDTH;
471         }
472         format_header();
473
474         p = NULL;
475         while ((p = procps_scan(p, need_flags))) {
476                 format_process(p);
477         }
478
479         return EXIT_SUCCESS;
480 }
481
482
483 #else /* !ENABLE_DESKTOP */
484
485
486 int ps_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
487 int ps_main(int argc ATTRIBUTE_UNUSED, char **argv ATTRIBUTE_UNUSED)
488 {
489         procps_status_t *p = NULL;
490         int len;
491         SKIP_SELINUX(const) int use_selinux = 0;
492         USE_SELINUX(int i;)
493 #if !ENABLE_FEATURE_PS_WIDE
494         enum { terminal_width = 79 };
495 #else
496         int terminal_width;
497         int w_count = 0;
498 #endif
499
500 #if ENABLE_FEATURE_PS_WIDE || ENABLE_SELINUX
501 #if ENABLE_FEATURE_PS_WIDE
502         opt_complementary = "-:ww";
503         USE_SELINUX(i =) getopt32(argv, USE_SELINUX("Z") "w", &w_count);
504         /* if w is given once, GNU ps sets the width to 132,
505          * if w is given more than once, it is "unlimited"
506          */
507         if (w_count) {
508                 terminal_width = (w_count==1) ? 132 : MAX_WIDTH;
509         } else {
510                 get_terminal_width_height(0, &terminal_width, NULL);
511                 /* Go one less... */
512                 if (--terminal_width > MAX_WIDTH)
513                         terminal_width = MAX_WIDTH;
514         }
515 #else /* only ENABLE_SELINUX */
516         i = getopt32(argv, "Z");
517 #endif
518 #if ENABLE_SELINUX
519         if ((i & 1) && is_selinux_enabled())
520                 use_selinux = PSSCAN_CONTEXT;
521 #endif
522 #endif /* ENABLE_FEATURE_PS_WIDE || ENABLE_SELINUX */
523
524         if (use_selinux)
525                 puts("  PID CONTEXT                          STAT COMMAND");
526         else
527                 puts("  PID USER       VSZ STAT COMMAND");
528
529         while ((p = procps_scan(p, 0
530                         | PSSCAN_PID
531                         | PSSCAN_UIDGID
532                         | PSSCAN_STATE
533                         | PSSCAN_VSZ
534                         | PSSCAN_COMM
535                         | use_selinux
536         ))) {
537 #if ENABLE_SELINUX
538                 if (use_selinux) {
539                         len = printf("%5u %-32.32s %s  ",
540                                         p->pid,
541                                         p->context ? p->context : "unknown",
542                                         p->state);
543                 } else
544 #endif
545                 {
546                         const char *user = get_cached_username(p->uid);
547                         //if (p->vsz == 0)
548                         //      len = printf("%5u %-8.8s        %s ",
549                         //              p->pid, user, p->state);
550                         //else
551                         {
552                                 char buf6[6];
553                                 smart_ulltoa5(p->vsz, buf6, " mgtpezy");
554                                 buf6[5] = '\0';
555                                 len = printf("%5u %-8.8s %s %s  ",
556                                         p->pid, user, buf6, p->state);
557                         }
558                 }
559
560                 {
561                         int sz = terminal_width - len;
562                         char buf[sz + 1];
563                         read_cmdline(buf, sz, p->pid, p->comm);
564                         puts(buf);
565                 }
566         }
567         if (ENABLE_FEATURE_CLEAN_UP)
568                 clear_username_cache();
569         return EXIT_SUCCESS;
570 }
571
572 #endif /* ENABLE_DESKTOP */