2 "Copyright (c) 1984 through 1996, William LeFebvre";
5 * Top users/processes display for Unix
8 * This program may be freely redistributed,
9 * but this entire comment MUST remain intact.
11 * Copyright (c) 1984, 1989, William LeFebvre, Rice University
12 * Copyright (c) 1989 - 1994, William LeFebvre, Northwestern University
13 * Copyright (c) 1994, 1995, William LeFebvre, Argonne National Laboratory
14 * Copyright (c) 1996, William LeFebvre, Group sys Consulting
20 * See the file "Changes" for information on version-to-version changes.
24 * This file contains "main" and other high-level routines.
28 * The following preprocessor variables, when defined, are used to
29 * distinguish between different Unix implementations:
31 * SIGHOLD - use SVR4 sighold function when defined
32 * SIGRELSE - use SVR4 sigrelse function when defined
33 * FD_SET - macros FD_SET and FD_ZERO are used when defined
43 /* includes specific to top */
44 #include "display.h" /* interface to display package */
45 #include "screen.h" /* interface to screen package */
47 #include "top.local.h"
52 /* Size of the stdio buffer given to stdout */
53 #define Buffersize 2048
55 /* The buffer that stdio will use */
56 char stdoutbuf[Buffersize];
58 /* build Signal masks */
59 #define Smask(s) (1 << ((s) - 1))
65 /* imported from screen.c */
66 extern int overstrike;
68 /* signal handling routines */
76 volatile sig_atomic_t leaveflag;
77 volatile sig_atomic_t tstopflag;
78 volatile sig_atomic_t winchflag;
80 /* internal routines */
83 /* values which need to be accessed by signal handlers */
84 static int max_topn; /* maximum displayable processes */
86 /* miscellaneous things */
87 struct process_select ps;
91 /* routines that don't return int */
99 extern int (*compares[])();
101 extern int proc_compare();
102 extern int io_compare();
106 caddr_t get_process_info();
108 /* different routines for displaying the user's identification */
109 /* (values assigned to get_userid) */
113 /* display routines that need to be predeclared */
131 /* pointers to display routines */
132 int (*d_loadave)() = i_loadave;
133 int (*d_procstates)() = i_procstates;
134 int (*d_cpustates)() = i_cpustates;
135 int (*d_memory)() = i_memory;
136 int (*d_swap)() = i_swap;
137 int (*d_message)() = i_message;
138 int (*d_header)() = i_header;
139 int (*d_process)() = i_process;
149 register int active_procs;
152 struct system_info system_info;
153 struct statics statics;
156 static char tempbuf1[50];
157 static char tempbuf2[50];
158 int old_sigmask; /* only used for BSD-style signals */
159 int topn = Default_TOPN;
160 int delay = Default_DELAY;
161 int displays = 0; /* indicates unspecified */
164 char *(*get_userid)() = username;
165 char *uname_field = "USERNAME";
173 char do_unames = Yes;
174 char interactive = Maybe;
176 #if Default_TOPN == Infinity
177 char topn_specified = No;
182 struct timeval timeout;
184 char *order_name = NULL;
188 /* FD_SET and friends are not present: fake it */
190 #define FD_ZERO(x) (*(x) = 0)
191 #define FD_SET(f, x) (*(x) = 1<<f)
196 static char command_chars[] = "\f qh?en#sdkriIutHmSCo";
198 static char command_chars[] = "\f qh?en#sdkriIutHmSC";
200 /* these defines enumerate the "strchr"s of the commands in command_chars */
206 #define CMD_OSLIMIT 4 /* terminals with OS can only handle commands */
207 #define CMD_errors 5 /* less than or equal to CMD_OSLIMIT */
208 #define CMD_number1 6
209 #define CMD_number2 7
211 #define CMD_displays 9
213 #define CMD_renice 11
214 #define CMD_idletog 12
215 #define CMD_idletog2 13
217 #define CMD_selftog 15
218 #define CMD_thrtog 16
219 #define CMD_viewtog 17
220 #define CMD_viewsys 18
221 #define CMD_wcputog 19
226 /* set the buffer for stdout */
229 debug = fopen("debug.run", "w");
230 setbuffer(stdout, NULL, 0);
232 setbuffer(stdout, stdoutbuf, Buffersize);
238 if ((myname = strrchr(argv[0], '/')) == 0)
248 /* initialize some selection options */
257 /* get preset options from the environment */
258 if ((env_top = getenv("TOP")) != NULL)
260 av = preset_argv = argparse(env_top, &preset_argc);
263 /* set the dummy argument to an explanatory message, in case
264 getopt encounters a bad argument */
265 preset_argv[0] = "while processing environment";
268 /* process options */
270 /* if we're done doing the presets, then process the real arguments */
271 if (preset_argc == 0)
276 /* this should keep getopt happy... */
280 while ((i = getopt(ac, av, "CSIHbinquvs:d:U:m:o:t")) != EOF)
284 case 'v': /* show version number */
285 fprintf(stderr, "%s: version %s\n",
286 myname, version_string());
290 case 'u': /* toggle uid/username display */
291 do_unames = !do_unames;
294 case 'U': /* display only username's processes */
295 if ((ps.uid = userid(optarg)) == -1)
297 fprintf(stderr, "%s: unknown user\n", optarg);
302 case 'S': /* show system processes */
303 ps.system = !ps.system;
306 case 'I': /* show idle processes */
310 case 'i': /* go interactive regardless */
314 case 'n': /* batch, or non-interactive */
319 case 'd': /* number of displays to show */
320 if ((i = atoiwi(optarg)) == Invalid || i == 0)
323 "%s: warning: display count should be positive -- option ignored\n",
334 if ((delay = atoi(optarg)) < 0 || (delay == 0 && getuid() != 0))
337 "%s: warning: seconds delay should be positive -- using default\n",
339 delay = Default_DELAY;
344 case 'q': /* be quick about it */
345 /* only allow this if user is really root */
348 /* be very un-nice! */
354 "%s: warning: `-q' option can only be used by root\n",
360 case 'm': /* select display mode */
361 if (strcmp(optarg, "io") == 0) {
362 displaymode = DISP_IO;
363 } else if (strcmp(optarg, "cpu") == 0) {
364 displaymode = DISP_CPU;
367 "%s: warning: `-m' option can only take args "
374 case 'o': /* select sort order */
379 "%s: this platform does not support arbitrary ordering. Sorry.\n",
386 ps.self = (ps.self == -1) ? getpid() : -1;
394 ps.thread = !ps.thread;
400 "Usage: %s [-bCHIinqStuv] [-d count] [-m io | cpu] [-o field] [-s time]\n"
401 " [-U username] [number]\n",
402 version_string(), myname);
407 /* get count of top processes to display (if any) */
410 if ((topn = atoiwi(av[optind])) == Invalid)
413 "%s: warning: process display count should be non-negative -- using default\n",
417 #if Default_TOPN == Infinity
420 topn_specified = Yes;
425 /* tricky: remember old value of preset_argc & set preset_argc = 0 */
429 /* repeat only if we really did the preset arguments */
432 /* set constants for username/uid display correctly */
435 uname_field = " UID ";
439 /* initialize the kernel memory interface */
440 if (machine_init(&statics) == -1)
446 /* determine sorting order index, if necessary */
447 if (order_name != NULL)
449 if ((order_index = string_index(order_name, statics.order_names)) == -1)
453 fprintf(stderr, "%s: '%s' is not a recognized sorting order.\n",
455 fprintf(stderr, "\tTry one of these:");
456 pp = statics.order_names;
459 fprintf(stderr, " %s", *pp++);
467 #ifdef no_initialization_needed
468 /* initialize the hashing stuff */
475 /* initialize termcap */
476 init_termcap(interactive);
478 /* get the string to use for the process area header */
479 header_text = format_header(uname_field);
481 /* initialize display interface */
482 if ((max_topn = display_init(&statics)) == -1)
484 fprintf(stderr, "%s: can't allocate sufficient memory\n", myname);
488 /* print warning if user requested more processes than we can display */
492 "%s: warning: this terminal can only display %d processes.\n",
497 /* adjust for topn == Infinity */
498 if (topn == Infinity)
501 * For smart terminals, infinity really means everything that can
502 * be displayed, or Largest.
503 * On dumb terminals, infinity means every process in the system!
504 * We only really want to do that if it was explicitly specified.
505 * This is always the case when "Default_TOPN != Infinity". But if
506 * topn wasn't explicitly specified and we are on a dumb terminal
507 * and the default is Infinity, then (and only then) we use
508 * "Nominal_TOPN" instead.
510 #if Default_TOPN == Infinity
511 topn = smart_terminal ? Largest :
512 (topn_specified ? Largest : Nominal_TOPN);
518 /* set header display accordingly */
519 display_header(topn > 0);
521 /* determine interactive state */
522 if (interactive == Maybe)
524 interactive = smart_terminal;
527 /* if # of displays not specified, fill it in */
530 displays = smart_terminal ? Infinity : 1;
533 /* hold interrupt signals while setting up the screen and the handlers */
539 old_sigmask = sigblock(Smask(SIGINT) | Smask(SIGQUIT) | Smask(SIGTSTP));
542 (void) signal(SIGINT, leave);
543 (void) signal(SIGQUIT, leave);
544 (void) signal(SIGTSTP, tstop);
546 (void) signal(SIGWINCH, winch);
553 (void) sigsetmask(old_sigmask);
557 fputs("....", stderr);
558 fflush(stderr); /* why must I do this? */
559 sleep((unsigned)(3 * warnings));
566 * main loop -- repeat while display count is positive or while it
567 * indicates infinity (by being -1)
570 while ((displays == -1) || (displays-- > 0))
575 /* get the current stats */
576 get_system_info(&system_info);
579 compare = compares[order_index];
581 if (displaymode == DISP_CPU)
582 compare = proc_compare;
584 compare = io_compare;
587 /* get the current set of processes */
589 get_process_info(&system_info, &ps, compare);
591 /* display the load averages */
592 (*d_loadave)(system_info.last_pid,
593 system_info.load_avg);
595 /* display the current time */
596 /* this method of getting the time SHOULD be fairly portable */
598 i_uptime(&system_info.boottime, &curr_time);
599 i_timeofday(&curr_time);
601 /* display process state breakdown */
602 (*d_procstates)(system_info.p_total,
603 system_info.procstates);
605 /* display the cpu state percentage breakdown */
606 if (dostates) /* but not the first time */
608 (*d_cpustates)(system_info.cpustates);
612 /* we'll do it next time */
624 /* display memory stats */
625 (*d_memory)(system_info.memory);
627 /* display swap stats */
628 (*d_swap)(system_info.swap);
630 /* handle message area */
633 /* update the header area */
634 (*d_header)(header_text);
638 /* determine number of processes to actually display */
639 /* this number will be the smallest of: active processes,
640 number user requested, number current screen accomodates */
641 active_procs = system_info.P_ACTIVE;
642 if (active_procs > topn)
646 if (active_procs > max_topn)
648 active_procs = max_topn;
651 /* now show the top "n" processes. */
652 for (i = 0; i < active_procs; i++)
654 (*d_process)(i, format_next_process(processes, get_userid));
662 /* do end-screen processing */
665 /* now, flush the output buffer */
666 if (fflush(stdout) != 0)
668 new_message(MT_standout, " Write error on stdout");
674 /* only do the rest if we have more displays to show */
677 /* switch out for new display on smart terminals */
686 d_loadave = u_loadave;
687 d_procstates = u_procstates;
688 d_cpustates = u_cpustates;
691 d_message = u_message;
693 d_process = u_process;
701 (void) signal(SIGALRM, onalrm);
702 (void) alarm((unsigned)delay);
704 /* wait for the rest of it .... */
707 else while (no_command)
709 /* assume valid command unless told otherwise */
712 /* set up arguments for select with timeout */
714 FD_SET(0, &readfds); /* for standard input */
715 timeout.tv_sec = delay;
724 /* move to the lower left */
728 /* default the signal handler action */
729 (void) signal(SIGTSTP, SIG_DFL);
731 /* unblock the signal and send ourselves one */
735 (void) sigsetmask(sigblock(0) & ~(1 << (SIGTSTP - 1)));
737 (void) kill(0, SIGTSTP);
739 /* reset the signal handler */
740 (void) signal(SIGTSTP, tstop);
750 /* reascertain the screen dimensions */
753 /* tell display to resize */
754 max_topn = display_resize();
756 /* reset the signal handler */
757 (void) signal(SIGWINCH, winch);
764 /* wait for either input or the end of the delay period */
765 sel_ret = select(2, &readfds, NULL, NULL, &timeout);
766 if (sel_ret < 0 && errno != EINTR)
773 /* something to read -- clear the message area first */
776 /* now read it and convert to command strchr */
777 /* (use "change" as a temporary to hold strchr) */
778 if (read(0, &ch, 1) != 1)
780 /* read error: either 0 or -1 */
781 new_message(MT_standout, " Read error on stdin");
786 if ((iptr = strchr(command_chars, ch)) == NULL)
788 if (ch != '\r' && ch != '\n')
790 /* illegal command */
791 new_message(MT_standout, " Command not understood");
798 change = iptr - command_chars;
799 if (overstrike && change > CMD_OSLIMIT)
802 new_message(MT_standout,
803 " Command cannot be handled by this terminal");
809 case CMD_redraw: /* redraw screen */
813 case CMD_update: /* merely update display */
814 /* is the load average high? */
815 if (system_info.load_avg[0] > LoadMax)
817 /* yes, go home for visual feedback */
823 case CMD_quit: /* quit */
828 case CMD_help1: /* help */
833 standout("Hit any key to continue: ");
835 (void) read(0, &ch, 1);
838 case CMD_errors: /* show errors */
839 if (error_count() == 0)
841 new_message(MT_standout,
842 " Currently no errors to report.");
851 standout("Hit any key to continue: ");
853 (void) read(0, &ch, 1);
857 case CMD_number1: /* new number */
859 new_message(MT_standout,
860 "Number of processes to show: ");
861 newval = readline(tempbuf1, 8, Yes);
864 if (newval > max_topn)
866 new_message(MT_standout | MT_delayed,
867 " This terminal can only display %d processes.",
874 /* inhibit the header */
877 else if (newval > topn && topn == 0)
879 /* redraw the header */
887 case CMD_delay: /* new seconds delay */
888 new_message(MT_standout, "Seconds to delay: ");
889 if ((i = readline(tempbuf1, 8, Yes)) > -1)
891 if ((delay = i) == 0 && getuid() != 0)
899 case CMD_displays: /* change display count */
900 new_message(MT_standout,
901 "Displays to show (currently %s): ",
902 displays == -1 ? "infinite" :
904 if ((i = readline(tempbuf1, 10, Yes)) > 0)
915 case CMD_kill: /* kill program */
916 new_message(0, "kill ");
917 if (readline(tempbuf2, sizeof(tempbuf2), No) > 0)
919 if ((errmsg = kill_procs(tempbuf2)) != NULL)
921 new_message(MT_standout, "%s", errmsg);
932 case CMD_renice: /* renice program */
933 new_message(0, "renice ");
934 if (readline(tempbuf2, sizeof(tempbuf2), No) > 0)
936 if ((errmsg = renice_procs(tempbuf2)) != NULL)
938 new_message(MT_standout, "%s", errmsg);
952 new_message(MT_standout | MT_delayed,
953 " %sisplaying idle processes.",
954 ps.idle ? "D" : "Not d");
959 ps.self = (ps.self == -1) ? getpid() : -1;
960 new_message(MT_standout | MT_delayed,
961 " %sisplaying self.",
962 (ps.self == -1) ? "D" : "Not d");
967 new_message(MT_standout,
968 "Username to show: ");
969 if (readline(tempbuf2, sizeof(tempbuf2), No) > 0)
971 if (tempbuf2[0] == '+' &&
976 else if ((i = userid(tempbuf2)) == -1)
978 new_message(MT_standout,
979 " %s: unknown user", tempbuf2);
995 ps.thread = !ps.thread;
996 new_message(MT_standout | MT_delayed,
997 "Displaying threads %s",
998 ps.thread ? "separately" : "as a count");
999 header_text = format_header(uname_field);
1005 new_message(MT_standout | MT_delayed,
1007 ps.wcpu ? "W" : "");
1008 header_text = format_header(uname_field);
1013 if (++displaymode == DISP_MAX)
1015 header_text = format_header(uname_field);
1016 display_header(Yes);
1017 d_header = i_header;
1021 ps.system = !ps.system;
1025 new_message(MT_standout,
1027 if (readline(tempbuf2, sizeof(tempbuf2), No) > 0)
1029 if ((i = string_index(tempbuf2, statics.order_names)) == -1)
1031 new_message(MT_standout,
1032 " %s: unrecognized sorting order", tempbuf2);
1049 new_message(MT_standout, " BAD CASE IN SWITCH!");
1054 /* flush out stuff that may have been written */
1069 * reset_display() - reset all the display routine pointers so that entire
1070 * screen will get redrawn.
1076 d_loadave = i_loadave;
1077 d_procstates = i_procstates;
1078 d_cpustates = i_cpustates;
1079 d_memory = i_memory;
1081 d_message = i_message;
1082 d_header = i_header;
1083 d_process = i_process;
1090 sigret_t leave() /* exit under normal conditions -- INT handler */
1096 sigret_t tstop(i) /* SIGTSTP handler */
1105 sigret_t winch(i) /* SIGWINCH handler */
1114 void quit(status) /* exit under duress */
1124 sigret_t onalrm() /* SIGALRM handler */
1127 /* this is only used in batch mode to break out of the pause() */