2 * Copyright (c) 1984 through 2008, William LeFebvre
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
11 * * Redistributions in binary form must reproduce the above
12 * copyright notice, this list of conditions and the following disclaimer
13 * in the documentation and/or other materials provided with the
16 * * Neither the name of William LeFebvre nor the names of other
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 "Copyright (c) 1984 through 2008, William LeFebvre";
37 * Changes to other files that we can do at the same time:
38 * screen.c:init_termcap: get rid of the "interactive" argument and have it
39 * pass back something meaningful (such as success/failure/error).
46 #include <sys/types.h>
50 #ifdef HAVE_SYS_UTSNAME_H
51 #include <sys/utsname.h>
60 #define STDIN_FILENO 0
63 /* determine which type of signal functions to use */
64 /* cant have sigaction without sigprocmask */
65 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGPROCMASK)
68 /* always use sigaction when it is available */
72 /* use sighold/sigrelse, otherwise use old fashioned BSD signals */
73 #if !defined(HAVE_SIGHOLD) || !defined(HAVE_SIGRELSE)
78 /* if FD_SET and friends aren't present, then fake something up */
81 #define FD_ZERO(x) (*(x) = 0)
82 #define FD_SET(f, x) (*(x) = 1<<f)
85 /* includes specific to top */
89 #include "globalstate.h"
102 #define BUFFERSIZE 4096
106 /* externs for getopt: */
111 static char stdoutbuf[BUFFERSIZE];
112 static jmp_buf jmp_int;
115 char *myname = "top";
132 set_signal(int sig, RETSIGTYPE (*handler)(int))
135 #ifdef HAVE_SIGACTION
136 struct sigaction action;
138 action.sa_handler = handler;
140 (void) sigaction(sig, &action, NULL);
142 (void) signal(sig, handler);
147 release_signal(int sig)
150 #ifdef HAVE_SIGACTION
153 sigaddset(&set, sig);
154 sigprocmask(SIG_UNBLOCK, &set, NULL);
162 (void) sigsetmask(sigblock(0) & ~(sigmask(sig)));
167 sig_leave(int i) /* exit under normal conditions -- INT handler */
175 sig_tstop(int i) /* SIGTSTP handler */
178 /* move to the lower left */
182 /* default the signal handler action */
183 set_signal(SIGTSTP, SIG_DFL);
185 /* unblock the TSTP signal */
186 release_signal(SIGTSTP);
188 /* send ourselves a TSTP to stop the process */
189 (void) kill(0, SIGTSTP);
191 /* reset the signal handler */
192 set_signal(SIGTSTP, sig_tstop);
197 /* jump back to a known place in the main loop */
198 longjmp(jmp_int, JMP_RESUME);
205 sig_winch(int i) /* SIGWINCH handler */
208 /* reascertain the screen dimensions */
211 /* jump back to a known place in the main loop */
212 longjmp(jmp_int, JMP_RESIZE);
216 #ifdef HAVE_SIGACTION
217 static sigset_t signalset;
224 #ifdef HAVE_SIGACTION
225 sigemptyset(&signalset);
226 sigaddset(&signalset, SIGINT);
227 sigaddset(&signalset, SIGQUIT);
228 sigaddset(&signalset, SIGTSTP);
230 sigaddset(&signalset, SIGWINCH);
232 sigprocmask(SIG_BLOCK, &signalset, NULL);
233 return (void *)(&signalset);
249 mask = sigblock(sigmask(SIGINT) | sigmask(SIGQUIT) |
250 sigmask(SIGTSTP) | sigmask(SIGWINCH));
252 mask = sigblock(sigmask(SIGINT) | sigmask(SIGQUIT) | sigmask(SIGTSTP));
263 (void) set_signal(SIGINT, sig_leave);
264 (void) set_signal(SIGQUIT, sig_leave);
265 (void) set_signal(SIGTSTP, sig_tstop);
267 (void) set_signal(SIGWINCH, sig_winch);
272 release_signals(void *parm)
275 #ifdef HAVE_SIGACTION
276 sigprocmask(SIG_UNBLOCK, (sigset_t *)parm, NULL);
289 (void) sigsetmask((int)parm);
294 * void do_arguments(globalstate *gstate, int ac, char **av)
296 * Arguments processing. gstate points to the global state,
297 * ac and av are the arguments to process. This can be called
298 * multiple times with different sets of arguments.
301 #ifdef HAVE_GETOPT_LONG
302 static struct option longopts[] = {
303 { "color", no_argument, NULL, 'C' },
304 { "debug", no_argument, NULL, 'D' },
305 { "system-procs", no_argument, NULL, 'S' },
306 { "idle-procs", no_argument, NULL, 'I' },
307 { "tag-names", no_argument, NULL, 'T' },
308 { "all", no_argument, NULL, 'a' },
309 { "batch", no_argument, NULL, 'b' },
310 { "full-commands", no_argument, NULL, 'c' },
311 { "interactive", no_argument, NULL, 'i' },
312 { "quick", no_argument, NULL, 'q' },
313 { "threads", no_argument, NULL, 't' },
314 { "uids", no_argument, NULL, 'u' },
315 { "version", no_argument, NULL, 'v' },
316 { "delay", required_argument, NULL, 's' },
317 { "displays", required_argument, NULL, 'd' },
318 { "user", required_argument, NULL, 'U' },
319 { "sort-order", required_argument, NULL, 'o' },
320 { "display-mode", required_argument, NULL, 'm' },
321 { NULL, 0, NULL, 0 },
327 do_arguments(globalstate *gstate, int ac, char **av)
332 /* this appears to keep getopt happy */
335 #ifdef HAVE_GETOPT_LONG
336 while ((i = getopt_long(ac, av, "CDSIMTabcinqtuvs:d:U:o:m:", longopts, NULL)) != -1)
338 while ((i = getopt(ac, av, "CDSIMTabcinqtuvs:d:U:o:m:")) != EOF)
345 gstate->use_color = !gstate->use_color;
354 fprintf(stderr, "%s: version %s\n", myname, version_string());
360 gstate->interactive = No;
364 gstate->displays = Infinity;
365 gstate->topn = Infinity;
369 gstate->interactive = Yes;
373 gstate->order_name = optarg;
378 if (i == Invalid || i == 0)
380 message_error(" Bad display count");
384 gstate->displays = i;
390 if (i < 0 || (i == 0 && getuid() != 0))
392 message_error(" Bad seconds delay");
401 gstate->show_usernames = !gstate->show_usernames;
408 message_error(" Unknown user '%s'", optarg);
412 gstate->pselect.uid = i;
418 gstate->pselect.mode = i;
422 gstate->pselect.system = !gstate->pselect.system;
426 gstate->pselect.idle = !gstate->pselect.idle;
436 gstate->show_tags = 1;
441 gstate->pselect.fullcmd = !gstate->pselect.fullcmd;
445 gstate->pselect.threads = !gstate->pselect.threads;
448 case 'q': /* be quick about it */
449 /* only allow this if user is really root */
452 /* be very un-nice! */
457 message_error(" Option -q can only be used by root");
464 Usage: %s [-ISTabcinqu] [-d x] [-s x] [-o field] [-U username] [number]\n",
465 version_string(), myname);
470 /* get count of top processes to display */
471 if (optind < ac && *av[optind])
473 if ((i = atoiwi(av[optind])) == Invalid)
475 message_error(" Process count not a number");
485 do_display(globalstate *gstate)
492 struct system_info system_info;
496 time_mark(&(gstate->now));
497 curr_time = (time_t)(gstate->now.tv_sec);
499 /* get the current stats */
500 get_system_info(&system_info);
502 /* get the current processes */
503 processes = get_process_info(&system_info, &(gstate->pselect), gstate->order_index);
505 /* determine number of processes to actually display */
506 if (gstate->topn > 0)
508 /* this number will be the smallest of: active processes,
509 number user requested, number current screen accomodates */
510 active_procs = system_info.P_ACTIVE;
511 if (active_procs > gstate->topn)
513 active_procs = gstate->topn;
515 if (active_procs > gstate->max_topn)
517 active_procs = gstate->max_topn;
526 #ifdef HAVE_FORMAT_PROCESS_HEADER
527 /* get the process header to use */
528 hdr = format_process_header(&(gstate->pselect), processes, active_procs);
530 hdr = gstate->header_text;
533 /* full screen or update? */
534 if (gstate->fulldraw)
537 i_loadave(system_info.last_pid, system_info.load_avg);
538 i_uptime(&(gstate->statics->boottime), &curr_time);
539 i_timeofday(&curr_time);
540 i_procstates(system_info.p_total, system_info.procstates, gstate->pselect.threads);
541 if (gstate->show_cpustates)
543 i_cpustates(system_info.cpustates);
551 gstate->show_cpustates = Yes;
553 i_kernel(system_info.kernel);
554 i_memory(system_info.memory);
555 i_swap(system_info.swap);
556 i_message(&(gstate->now));
558 for (i = 0; i < active_procs; i++)
560 i_process(i, format_next_process(processes, gstate->get_userid));
563 if (gstate->smart_terminal)
565 gstate->fulldraw = No;
570 u_loadave(system_info.last_pid, system_info.load_avg);
571 u_uptime(&(gstate->statics->boottime), &curr_time);
572 i_timeofday(&curr_time);
573 u_procstates(system_info.p_total, system_info.procstates, gstate->pselect.threads);
574 u_cpustates(system_info.cpustates);
575 u_kernel(system_info.kernel);
576 u_memory(system_info.memory);
577 u_swap(system_info.swap);
578 u_message(&(gstate->now));
580 for (i = 0; i < active_procs; i++)
582 u_process(i, format_next_process(processes, gstate->get_userid));
590 timeval_xdprint(char *s, struct timeval tv)
593 xdprintf("%s %d.%06d\n", s, tv.tv_sec, tv.tv_usec);
598 do_wait(globalstate *gstate)
603 wait.tv_sec = gstate->delay;
605 select(0, NULL, NULL, NULL, &wait);
609 do_command(globalstate *gstate)
613 struct timeval wait = {0, 0};
618 /* calculate new refresh time */
619 gstate->refresh = gstate->now;
620 gstate->refresh.tv_sec += gstate->delay;
623 /* loop waiting for time to expire */
625 /* calculate time to wait */
626 if (gstate->delay > 0)
628 wait = gstate->refresh;
629 wait.tv_usec -= now.tv_usec;
630 if (wait.tv_usec < 0)
632 wait.tv_usec += 1000000;
635 wait.tv_sec -= now.tv_sec;
638 /* set up arguments for select on stdin (0) */
640 FD_SET(STDIN_FILENO, &readfds);
642 /* wait for something to read or time out */
643 if (select(32, &readfds, NULL, NULL, &wait) > 0)
646 if (read(STDIN_FILENO, &ch, 1) != 1)
649 message_error(" Read error on stdin");
654 /* mark pending messages as old */
658 status = command_process(gstate, (int)ch);
669 message_error(" Unknown command");
673 message_error(" Command not available");
679 } while (timercmp(&now, &(gstate->refresh), < ));
683 do_minidisplay(globalstate *gstate)
687 struct system_info si;
689 /* save the real delay and substitute 1 second */
690 real_delay = gstate->delay;
693 /* wait 1 second for a command */
694 time_mark(&(gstate->now));
697 /* do a mini update that only updates the cpustates */
698 get_system_info(&si);
699 u_cpustates(si.cpustates);
701 /* restore the delay time */
702 gstate->delay = real_delay;
709 main(int argc, char *argv[])
718 struct statics statics;
724 if ((myname = strrchr(argv[0], '/')) == 0)
734 /* binary compatibility check */
739 if (uname(&uts) == 0)
741 if (strcmp(uts.machine, UNAME_HARDWARE) != 0)
743 fprintf(stderr, "%s: incompatible hardware platform\n",
745 exit(EX_UNAVAILABLE);
752 gstate = (globalstate *)calloc(1, sizeof(globalstate));
753 gstate->statics = &statics;
756 /* preset defaults for various options */
757 gstate->show_usernames = Yes;
758 gstate->topn = DEFAULT_TOPN;
759 gstate->delay = DEFAULT_DELAY;
760 gstate->fulldraw = Yes;
761 gstate->use_color = Yes;
762 gstate->interactive = Maybe;
764 /* preset defaults for process selection */
765 gstate->pselect.idle = Yes;
766 gstate->pselect.system = No;
767 gstate->pselect.fullcmd = No;
768 gstate->pselect.command = NULL;
769 gstate->pselect.uid = -1;
770 gstate->pselect.mode = 0;
772 /* use a large buffer for stdout */
774 setvbuf(stdout, stdoutbuf, _IOFBF, BUFFERSIZE);
776 #ifdef HAVE_SETBUFFER
777 setbuffer(stdout, stdoutbuf, BUFFERSIZE);
781 /* get preset options from the environment */
782 if ((env_top = getenv("TOP")) != NULL)
784 preset_argv = argparse(env_top, &preset_argc);
785 preset_argv[0] = myname;
786 do_arguments(gstate, preset_argc, preset_argv);
789 /* process arguments */
790 do_arguments(gstate, argc, argv);
793 /* If colour has been turned on read in the settings. */
794 env_top = getenv("TOPCOLOURS");
797 env_top = getenv("TOPCOLORS");
799 /* must do something about error messages */
800 color_env_parse(env_top);
801 color_activate(gstate->use_color);
804 /* in order to support forward compatability, we have to ensure that
805 the entire statics structure is set to a known value before we call
806 machine_init. This way fields that a module does not know about
807 will retain their default values */
808 memzero((void *)&statics, sizeof(statics));
809 statics.boottime = -1;
811 /* call the platform-specific init */
812 if (machine_init(&statics) == -1)
817 /* create a helper list of sort order names */
818 gstate->order_namelist = string_list(statics.order_names);
820 /* look up chosen sorting order */
821 if (gstate->order_name != NULL)
825 if (statics.order_names == NULL)
827 message_error(" This platform does not support arbitrary ordering");
829 else if ((i = string_index(gstate->order_name,
830 statics.order_names)) == -1)
832 message_error(" Sort order `%s' not recognized", gstate->order_name);
833 message_error(" Recognized sort orders: %s", gstate->order_namelist);
837 gstate->order_index = i;
841 /* initialize extensions */
844 /* initialize termcap */
845 gstate->smart_terminal = screen_readtermcap(gstate->interactive);
847 /* determine interactive state */
848 if (gstate->interactive == Maybe)
850 gstate->interactive = smart_terminal;
853 /* if displays were not specified, choose an appropriate default */
854 if (gstate->displays == 0)
856 gstate->displays = gstate->smart_terminal ? Infinity: 1;
859 /* we don't need a mini display when delay is less than 2
860 seconds or when we are not on a smart terminal */
861 if (gstate->delay <= 1 || !smart_terminal)
866 #ifndef HAVE_FORMAT_PROCESS_HEADER
867 /* set constants for username/uid display */
868 if (gstate->show_usernames)
870 gstate->header_text = format_header("USERNAME");
871 gstate->get_userid = username;
875 gstate->header_text = format_header(" UID ");
876 gstate->get_userid = itoa7;
879 gstate->pselect.usernames = gstate->show_usernames;
881 /* initialize display */
882 if ((gstate->max_topn = display_init(&statics)) == -1)
884 fprintf(stderr, "%s: can't allocate sufficient memory\n", myname);
888 /* check for infinity and for overflowed screen */
889 if (gstate->topn == Infinity)
891 gstate->topn = INT_MAX;
893 else if (gstate->topn > gstate->max_topn)
895 message_error(" This terminal can only display %d processes",
900 /* producing a list of color tags is easy */
901 if (gstate->show_tags)
908 /* hold all signals while we initialize the screen */
909 mask = hold_signals();
912 /* set the signal handlers */
915 /* longjmp re-entry point */
916 /* set the jump buffer for long jumps out of signal handlers */
917 if (setjmp(jmp_int) != 0)
919 /* this is where we end up after processing sigwinch or sigtstp */
921 /* tell display to resize its buffers, and get the new length */
922 if ((gstate->max_topn = display_resize()) == -1)
929 /* set up for a full redraw, and get the current line count */
930 gstate->fulldraw = Yes;
932 /* safe to release the signals now */
933 release_signals(mask);
937 /* release the signals */
938 release_signals(mask);
940 /* some systems require a warmup */
941 /* always do a warmup for batch mode */
942 if (gstate->interactive == 0 || statics.flags.warmup)
944 struct system_info system_info;
945 struct timeval timeout;
947 time_mark(&(gstate->now));
948 get_system_info(&system_info);
949 (void)get_process_info(&system_info, &gstate->pselect, 0);
952 select(0, NULL, NULL, NULL, &timeout);
954 /* if we've warmed up, then we can show good states too */
955 gstate->show_cpustates = Yes;
961 while ((gstate->displays == -1) || (--gstate->displays > 0))
964 if (gstate->interactive)
968 do_minidisplay(gstate);
979 /* do one last display */
984 return 1; /* Keep compiler quiet. */