Apply patch from Felipe Kellermann to simlify logic of sort functions.
[oweals/busybox.git] / procps / top.c
1 /*
2  * A tiny 'top' utility.
3  *
4  * This is written specifically for the linux /proc/<PID>/stat(m)
5  * files format.
6
7  * This reads the PIDs of all processes and their status and shows
8  * the status of processes (first ones that fit to screen) at given
9  * intervals.
10  *
11  * NOTES:
12  * - At startup this changes to /proc, all the reads are then
13  *   relative to that.
14  *
15  * (C) Eero Tamminen <oak at welho dot com>
16  *
17  * Rewritten by Vladimir Oleynik (C) 2002 <dzo@simtreas.ru>
18  */
19
20 /* Original code Copyrights */
21 /*
22  * Copyright (c) 1992 Branko Lankester
23  * Copyright (c) 1992 Roger Binns
24  * Copyright (C) 1994-1996 Charles L. Blake.
25  * Copyright (C) 1992-1998 Michael K. Johnson
26  * May 
27  * This reads the PIDs of all processes and their status and shows
28  * the status of processes (first ones that fit to screen) at given
29  * intervals.
30  *
31  * NOTES:
32  * - At startup this changes to /proc, all the reads are then
33  *   relative to that.
34  *
35  * (C) Eero Tamminen <oak at welho dot com>
36  *
37  * Rewritten by Vladimir Oleynik (C) 2002 <dzo@simtreas.ru>
38  */
39
40 /* Original code Copyrights */
41 /*
42  * Copyright (c) 1992 Branko Lankester
43  * Copyright (c) 1992 Roger Binns
44  * Copyright (C) 1994-1996 Charles L. Blake.
45  * Copyright (C) 1992-1998 Michael K. Johnson
46  * May be distributed under the conditions of the
47  * GNU Library General Public License
48  */
49
50 #include <sys/types.h>
51 #include <stdio.h>
52 #include <stdlib.h>
53 #include <unistd.h>
54 #include <string.h>
55 #include <sys/ioctl.h>
56 /* get page info */
57 #include <asm/page.h>
58 #include "busybox.h"
59
60 //#define FEATURE_CPU_USAGE_PERCENTAGE  /* + 2k */
61
62 #ifdef FEATURE_CPU_USAGE_PERCENTAGE
63 #include <time.h>
64 #include <sys/time.h>
65 #include <fcntl.h>
66 #include <netinet/in.h>  /* htons */
67 #endif
68
69
70 typedef int (*cmp_t)(procps_status_t *P, procps_status_t *Q);
71
72 static procps_status_t *top;   /* Hehe */
73 static int ntop;
74
75
76 static int pid_sort (procps_status_t *P, procps_status_t *Q)
77 {
78     return (Q->pid - P->pid);
79 }
80
81 static int mem_sort (procps_status_t *P, procps_status_t *Q)
82 {
83     return (int)(Q->rss - P->rss);
84 }
85
86 #ifdef FEATURE_CPU_USAGE_PERCENTAGE
87
88 #define sort_depth 3
89 static cmp_t sort_function[sort_depth];
90
91 static int pcpu_sort (procps_status_t *P, procps_status_t *Q)
92 {
93     return (Q->pcpu - P->pcpu);
94 }
95
96 static int time_sort (procps_status_t *P, procps_status_t *Q)
97 {
98     return (int)((Q->stime + Q->utime) - (P->stime + P->utime));
99 }
100
101 int mult_lvl_cmp(void* a, void* b) {
102     int i, cmp_val;
103
104     for(i = 0; i < sort_depth; i++) {
105         cmp_val = (*sort_function[i])(a, b);
106         if (cmp_val != 0)
107             return cmp_val;
108     }
109     return 0;
110 }
111
112 /* This structure stores some critical information from one frame to
113    the next. mostly used for sorting. Added cumulative and resident fields. */
114 struct save_hist {
115     int ticks;
116     int pid;
117     int utime;
118     int stime;
119 };
120
121 /*
122  * Calculates percent cpu usage for each task.
123  */
124
125 static struct save_hist *save_history;
126
127 static unsigned long Hertz;
128
129 /***********************************************************************
130  * Some values in /proc are expressed in units of 1/HZ seconds, where HZ
131  * is the kernel clock tick rate. One of these units is called a jiffy.
132  * The HZ value used in the kernel may vary according to hacker desire.
133  * According to Linus Torvalds, this is not true. He considers the values
134  * in /proc as being in architecture-dependent units that have no relation
135  * to the kernel clock tick rate. Examination of the kernel source code
136  * reveals that opinion as wishful thinking.
137  *
138  * In any case, we need the HZ constant as used in /proc. (the real HZ value
139  * may differ, but we don't care) There are several ways we could get HZ:
140  *
141  * 1. Include the kernel header file. If it changes, recompile this library.
142  * 2. Use the sysconf() function. When HZ changes, recompile the C library!
143  * 3. Ask the kernel. This is obviously correct...
144  *
145  * Linus Torvalds won't let us ask the kernel, because he thinks we should
146  * not know the HZ value. Oh well, we don't have to listen to him.
147  * Someone smuggled out the HZ value. :-)
148  *
149  * This code should work fine, even if Linus fixes the kernel to match his
150  * stated behavior. The code only fails in case of a partial conversion.
151  *
152  */
153
154 #define FILE_TO_BUF(filename, fd) do{                           \
155     if (fd == -1 && (fd = open(filename, O_RDONLY)) == -1) {    \
156         bb_perror_msg_and_die("/proc not be mounted?");            \
157     }                                                           \
158     lseek(fd, 0L, SEEK_SET);                                    \
159     if ((local_n = read(fd, buf, sizeof buf - 1)) < 0) {        \
160         bb_perror_msg_and_die("%s", filename);                     \
161     }                                                           \
162     buf[local_n] = '\0';                                        \
163 }while(0)
164
165 #define FILE_TO_BUF2(filename, fd) do{                          \
166     lseek(fd, 0L, SEEK_SET);                                    \
167     if ((local_n = read(fd, buf, sizeof buf - 1)) < 0) {        \
168         bb_perror_msg_and_die("%s", filename);                     \
169     }                                                           \
170     buf[local_n] = '\0';                                        \
171 }while(0)
172
173 static void init_Hertz_value(void) {
174   unsigned long user_j, nice_j, sys_j, other_j;  /* jiffies (clock ticks) */
175   double up_1, up_2, seconds;
176   unsigned long jiffies, h;
177   char buf[80];
178   int uptime_fd = -1;
179   int stat_fd = -1;
180
181   long smp_num_cpus = sysconf(_SC_NPROCESSORS_CONF);
182
183   if(smp_num_cpus<1) smp_num_cpus=1;
184   do {
185     int local_n;
186
187     FILE_TO_BUF("uptime", uptime_fd);
188     up_1 = strtod(buf, 0);
189     FILE_TO_BUF("stat", stat_fd);
190     sscanf(buf, "cpu %lu %lu %lu %lu", &user_j, &nice_j, &sys_j, &other_j);
191     FILE_TO_BUF2("uptime", uptime_fd);
192     up_2 = strtod(buf, 0);
193   } while((long)( (up_2-up_1)*1000.0/up_1 )); /* want under 0.1% error */
194
195   close(uptime_fd);
196   close(stat_fd);
197
198   jiffies = user_j + nice_j + sys_j + other_j;
199   seconds = (up_1 + up_2) / 2;
200   h = (unsigned long)( (double)jiffies/seconds/smp_num_cpus );
201   /* actual values used by 2.4 kernels: 32 64 100 128 1000 1024 1200 */
202   switch(h){
203   case   30 ...   34 :  Hertz =   32; break; /* ia64 emulator */
204   case   48 ...   52 :  Hertz =   50; break;
205   case   58 ...   62 :  Hertz =   60; break;
206   case   63 ...   65 :  Hertz =   64; break; /* StrongARM /Shark */
207   case   95 ...  105 :  Hertz =  100; break; /* normal Linux */
208   case  124 ...  132 :  Hertz =  128; break; /* MIPS, ARM */
209   case  195 ...  204 :  Hertz =  200; break; /* normal << 1 */
210   case  253 ...  260 :  Hertz =  256; break;
211   case  295 ...  304 :  Hertz =  300; break; /* 3 cpus */
212   case  393 ...  408 :  Hertz =  400; break; /* normal << 2 */
213   case  495 ...  504 :  Hertz =  500; break; /* 5 cpus */
214   case  595 ...  604 :  Hertz =  600; break; /* 6 cpus */
215   case  695 ...  704 :  Hertz =  700; break; /* 7 cpus */
216   case  790 ...  808 :  Hertz =  800; break; /* normal << 3 */
217   case  895 ...  904 :  Hertz =  900; break; /* 9 cpus */
218   case  990 ... 1010 :  Hertz = 1000; break; /* ARM */
219   case 1015 ... 1035 :  Hertz = 1024; break; /* Alpha, ia64 */
220   case 1095 ... 1104 :  Hertz = 1100; break; /* 11 cpus */
221   case 1180 ... 1220 :  Hertz = 1200; break; /* Alpha */
222   default:
223     /* If 32-bit or big-endian (not Alpha or ia64), assume HZ is 100. */
224     Hertz = (sizeof(long)==sizeof(int) || htons(999)==999) ? 100UL : 1024UL;
225   }
226 }
227
228 static void do_stats(void)
229 {
230     struct timeval t;
231     static struct timeval oldtime;
232     struct timezone timez;
233     float elapsed_time;
234
235     procps_status_t *cur;
236     int total_time, i, n;
237     static int prev_count;
238     int systime, usrtime, pid;
239
240     struct save_hist *New_save_hist;
241
242     /*
243      * Finds the current time (in microseconds) and calculates the time
244      * elapsed since the last update.
245      */
246     gettimeofday(&t, &timez);
247     elapsed_time = (t.tv_sec - oldtime.tv_sec)
248         + (float) (t.tv_usec - oldtime.tv_usec) / 1000000.0;
249     oldtime.tv_sec  = t.tv_sec;
250     oldtime.tv_usec = t.tv_usec;
251
252     New_save_hist  = alloca(sizeof(struct save_hist)*ntop);
253     /*
254      * Make a pass through the data to get stats.
255      */
256     for(n = 0; n < ntop; n++) {
257         cur = top + n;
258
259         /*
260          * Calculate time in cur process.  Time is sum of user time
261          * (usrtime) plus system time (systime).
262          */
263         systime = cur->stime;
264         usrtime = cur->utime;
265         pid = cur->pid;
266         total_time = systime + usrtime;
267         New_save_hist[n].ticks = total_time;
268         New_save_hist[n].pid = pid;
269         New_save_hist[n].stime = systime;
270         New_save_hist[n].utime = usrtime;
271
272         /* find matching entry from previous pass */
273         for (i = 0; i < prev_count; i++) {
274             if (save_history[i].pid == pid) {
275                 total_time -= save_history[i].ticks;
276                 systime -= save_history[i].stime;
277                 usrtime -= save_history[i].utime;
278                 break;
279             }
280         }
281
282         /*
283          * Calculate percent cpu time for cur task.
284          */
285         i = (total_time * 10 * 100/Hertz) / elapsed_time;
286         if (i > 999)
287             i = 999;
288         cur->pcpu = i;
289
290     }
291
292     /*
293      * Save cur frame's information.
294      */
295     free(save_history);
296     save_history = memcpy(xmalloc(sizeof(struct save_hist)*n), New_save_hist,
297                                                 sizeof(struct save_hist)*n);
298     prev_count = n;
299     qsort(top, n, sizeof(procps_status_t), (void*)mult_lvl_cmp);
300 }
301 #else
302 static cmp_t sort_function;
303 #endif /* FEATURE_CPU_USAGE_PERCENTAGE */
304
305 /* display generic info (meminfo / loadavg) */
306 static unsigned long display_generic(void)
307 {
308         FILE *fp;
309         char buf[80];
310         float avg1, avg2, avg3;
311         unsigned long total, used, mfree, shared, buffers, cached;
312         unsigned int needs_conversion = 1;
313
314         /* read memory info */
315         fp = bb_xfopen("meminfo", "r");
316
317         /*
318          * Old kernels (such as 2.4.x) had a nice summary of memory info that
319          * we could parse, however this is gone entirely in 2.6. Try parsing
320          * the old way first, and if that fails, parse each field manually.
321          *
322          * First, we read in the first line. Old kernels will have bogus
323          * strings we don't care about, whereas new kernels will start right
324          * out with MemTotal:
325          *                              -- PFM.
326          */
327         if (fscanf(fp, "MemTotal: %lu %s\n", &total, buf) != 2) {
328                 fgets(buf, sizeof(buf), fp);    /* skip first line */
329
330                 fscanf(fp, "Mem: %lu %lu %lu %lu %lu %lu",
331                    &total, &used, &mfree, &shared, &buffers, &cached);
332         } else {
333                 /*
334                  * Revert to manual parsing, which incidentally already has the
335                  * sizes in kilobytes. This should be safe for both 2.4 and
336                  * 2.6.
337                  */
338                 needs_conversion = 0;
339
340                 fscanf(fp, "MemFree: %lu %s\n", &mfree, buf);
341
342                 /*
343                  * MemShared: is no longer present in 2.6. Report this as 0,
344                  * to maintain consistent behavior with normal procps.
345                  */
346                 if (fscanf(fp, "MemShared: %lu %s\n", &shared, buf) != 2)
347                         shared = 0;
348
349                 fscanf(fp, "Buffers: %lu %s\n", &buffers, buf);
350                 fscanf(fp, "Cached: %lu %s\n", &cached, buf);
351
352                 used = total - mfree;
353         }
354         fclose(fp);
355
356         /* read load average */
357         fp = bb_xfopen("loadavg", "r");
358         if (fscanf(fp, "%f %f %f", &avg1, &avg2, &avg3) != 3) {
359                 bb_error_msg_and_die("failed to read '%s'", "loadavg");
360         }
361         fclose(fp);
362
363         if (needs_conversion) {
364                 /* convert to kilobytes */
365                 used /= 1024;
366                 mfree /= 1024;
367                 shared /= 1024;
368                 buffers /= 1024;
369                 cached /= 1024;
370                 total /= 1024;
371         }
372
373         /* output memory info and load average */
374         /* clear screen & go to top */
375         printf("\e[H\e[J" "Mem: "
376                "%ldK used, %ldK free, %ldK shrd, %ldK buff, %ldK cached\n",
377                used, mfree, shared, buffers, cached);
378         printf("Load average: %.2f, %.2f, %.2f    "
379                         "(State: S=sleeping R=running, W=waiting)\n",
380                avg1, avg2, avg3);
381         return total;
382 }
383
384
385 /* display process statuses */
386 static void display_status(int count, int col)
387 {
388         procps_status_t *s = top;
389         char rss_str_buf[8];
390         unsigned long total_memory = display_generic();
391
392 #ifdef FEATURE_CPU_USAGE_PERCENTAGE
393         /* what info of the processes is shown */
394         printf("\n\e[7m  PID USER     STATUS   RSS  PPID %%CPU %%MEM COMMAND\e[0m\n");
395 #else
396         printf("\n\e[7m  PID USER     STATUS   RSS  PPID %%MEM COMMAND\e[0m\n");
397 #endif
398
399         while (count--) {
400                 char *namecmd = s->short_cmd;
401                 int pmem;
402
403                 pmem = 1000.0 * s->rss / total_memory;
404                 if (pmem > 999) pmem = 999;
405
406                 if(s->rss > 10*1024)
407                         sprintf(rss_str_buf, "%6ldM", s->rss/1024);
408                 else
409                         sprintf(rss_str_buf, "%7ld", s->rss);
410 #ifdef FEATURE_CPU_USAGE_PERCENTAGE
411                 printf("%5d %-8s %s  %s %5d %2d.%d %2u.%u ",
412                         s->pid, s->user, s->state, rss_str_buf, s->ppid,
413                         s->pcpu/10, s->pcpu%10, pmem/10, pmem%10);
414 #else
415                 printf("%5d %-8s %s  %s %5d %2u.%u ",
416                         s->pid, s->user, s->state, rss_str_buf, s->ppid,
417                         pmem/10, pmem%10);
418 #endif
419                         if(strlen(namecmd) > col)
420                                 namecmd[col] = 0;
421                         printf("%s\n", namecmd);
422                 s++;
423         }
424 }
425
426 static void clearmems(void)
427 {
428         free(top);
429         top = 0;
430         ntop = 0;
431 }
432
433 #if defined CONFIG_FEATURE_USE_TERMIOS
434 #include <termios.h>
435 #include <sys/time.h>
436 #include <signal.h>
437
438
439 static struct termios initial_settings;
440
441 static void reset_term(void)
442 {
443         tcsetattr(0, TCSANOW, (void *) &initial_settings);
444 #ifdef CONFIG_FEATURE_CLEAN_UP
445         clearmems();
446 #ifdef FEATURE_CPU_USAGE_PERCENTAGE
447         free(save_history);
448 #endif
449 #endif /* CONFIG_FEATURE_CLEAN_UP */
450 }
451
452 static void sig_catcher (int sig)
453 {
454         reset_term();
455 }
456 #endif /* CONFIG_FEATURE_USE_TERMIOS */
457
458
459 int top_main(int argc, char **argv)
460 {
461         int opt, interval, lines, col;
462 #if defined CONFIG_FEATURE_USE_TERMIOS
463         struct termios new_settings;
464         struct timeval tv;
465         fd_set readfds;
466         unsigned char c;
467         struct sigaction sa;
468 #endif /* CONFIG_FEATURE_USE_TERMIOS */
469
470         /* Default update rate is 5 seconds */
471         interval = 5;
472
473         /* do normal option parsing */
474         while ((opt = getopt(argc, argv, "d:")) > 0) {
475             switch (opt) {
476                 case 'd':
477                     interval = atoi(optarg);
478                     break;
479                 default:
480                     bb_show_usage();
481             }
482         }
483
484         /* Default to 25 lines - 5 lines for status */
485         lines = 25 - 5;
486         /* Default CMD format size */
487 #ifdef FEATURE_CPU_USAGE_PERCENTAGE
488         col = 35 - 6;
489 #else
490         col = 35;
491 #endif
492         /* change to /proc */
493         if (chdir("/proc") < 0) {
494                 bb_perror_msg_and_die("chdir('/proc')");
495         }
496 #if defined CONFIG_FEATURE_USE_TERMIOS
497         tcgetattr(0, (void *) &initial_settings);
498         memcpy(&new_settings, &initial_settings, sizeof(struct termios));
499         new_settings.c_lflag &= ~(ISIG | ICANON); /* unbuffered input */
500         /* Turn off echoing */
501         new_settings.c_lflag &= ~(ECHO | ECHONL);
502
503         signal (SIGTERM, sig_catcher);
504         sigaction (SIGTERM, (struct sigaction *) 0, &sa);
505         sa.sa_flags |= SA_RESTART;
506         sa.sa_flags &= ~SA_INTERRUPT;
507         sigaction (SIGTERM, &sa, (struct sigaction *) 0);
508         sigaction (SIGINT, &sa, (struct sigaction *) 0);
509         tcsetattr(0, TCSANOW, (void *) &new_settings);
510         atexit(reset_term);
511
512         get_terminal_width_height(0, &col, &lines);
513         if (lines > 4) {
514             lines -= 5;
515 #ifdef FEATURE_CPU_USAGE_PERCENTAGE
516             col = col - 80 + 35 - 6;
517 #else
518             col = col - 80 + 35;
519 #endif
520         }
521 #endif /* CONFIG_FEATURE_USE_TERMIOS */
522 #ifdef FEATURE_CPU_USAGE_PERCENTAGE
523         sort_function[0] = pcpu_sort;
524         sort_function[1] = mem_sort;
525         sort_function[2] = time_sort;
526 #else
527         sort_function = mem_sort;
528 #endif
529         while (1) {
530                 /* read process IDs & status for all the processes */
531                 procps_status_t * p;
532
533 #ifdef CONFIG_SELINUX
534                 while ((p = procps_scan(0, 0, NULL) ) != 0) {
535 #else
536                 while ((p = procps_scan(0)) != 0) {
537 #endif
538                         int n = ntop;
539
540                         top = xrealloc(top, (++ntop)*sizeof(procps_status_t));
541                         memcpy(top + n, p, sizeof(procps_status_t));
542                 }
543                 if (ntop == 0) {
544                 bb_perror_msg_and_die("scandir('/proc')");
545         }
546 #ifdef FEATURE_CPU_USAGE_PERCENTAGE
547                 if(!Hertz) {
548                         init_Hertz_value();
549                         do_stats();
550                         sleep(1);
551                         clearmems();
552                         continue;
553         }
554                 do_stats();
555 #else
556                 qsort(top, ntop, sizeof(procps_status_t), (void*)sort_function);
557 #endif
558                 opt = lines;
559                 if (opt > ntop) {
560                         opt = ntop;
561                 }
562                 /* show status for each of the processes */
563                 display_status(opt, col);
564 #if defined CONFIG_FEATURE_USE_TERMIOS
565                 tv.tv_sec = interval;
566                 tv.tv_usec = 0;
567                 FD_ZERO (&readfds);
568                 FD_SET (0, &readfds);
569                 select (1, &readfds, NULL, NULL, &tv);
570                 if (FD_ISSET (0, &readfds)) {
571                         if (read (0, &c, 1) <= 0) {   /* signal */
572                 return EXIT_FAILURE;
573         }
574                         if(c == 'q' || c == initial_settings.c_cc[VINTR])
575                                 return EXIT_SUCCESS;
576                         if(c == 'M') {
577 #ifdef FEATURE_CPU_USAGE_PERCENTAGE
578                                 sort_function[0] = mem_sort;
579                                 sort_function[1] = pcpu_sort;
580                                 sort_function[2] = time_sort;
581 #else
582                                 sort_function = mem_sort;
583 #endif
584                         }
585 #ifdef FEATURE_CPU_USAGE_PERCENTAGE
586                         if(c == 'P') {
587                                 sort_function[0] = pcpu_sort;
588                                 sort_function[1] = mem_sort;
589                                 sort_function[2] = time_sort;
590                         }
591                         if(c == 'T') {
592                                 sort_function[0] = time_sort;
593                                 sort_function[1] = mem_sort;
594                                 sort_function[2] = pcpu_sort;
595                         }
596 #endif
597                         if(c == 'N') {
598 #ifdef FEATURE_CPU_USAGE_PERCENTAGE
599                                 sort_function[0] = pid_sort;
600 #else
601                                 sort_function = pid_sort;
602 #endif
603                         }
604                 }
605 #else
606                 sleep(interval);
607 #endif                                  /* CONFIG_FEATURE_USE_TERMIOS */
608                 clearmems();
609         }
610
611         return EXIT_SUCCESS;
612 }