2 * top - a top users display for Unix
4 * SYNOPSIS: For DragonFly 2.x and later
7 * Originally written for BSD4.4 system by Christos Zoulas.
8 * Ported to FreeBSD 2.x by Steven Wallace && Wolfram Schneider
9 * Order support hacked in from top-3.5beta6/machine/m_aix41.c
10 * by Monte Mitzelfelt (for latest top see http://www.groupsys.com/topinfo/)
12 * This is the machine-dependent module for DragonFly 2.5.1
14 * DragonFly 2.x and above
18 * AUTHOR: Jan Lentfer <Jan.Lentfer@web.de>
19 * This module has been put together from different sources and is based on the
20 * work of many other people, e.g. Matthew Dillon, Simon Schubert, Jordan Gordeev.
22 * $FreeBSD: src/usr.bin/top/machine.c,v 1.29.2.2 2001/07/31 20:27:05 tmm Exp $
23 * $DragonFly: src/usr.bin/top/machine.c,v 1.26 2008/10/16 01:52:33 swildner Exp $
27 #include <sys/types.h>
28 #include <sys/signal.h>
29 #include <sys/param.h>
38 #include <sys/errno.h>
39 #include <sys/sysctl.h>
43 #include <sys/vmmeter.h>
44 #include <sys/resource.h>
45 #include <sys/rtprio.h>
52 #include <osreldate.h> /* for changes in kernel structures */
54 #include <sys/kinfo.h>
62 int swapmode(int *retavail, int *retfree);
64 static int namelength;
66 static int show_fullcmd;
71 * needs to be a global symbol, so wrapper can be modified accordingly.
73 static int show_threads = 0;
75 /* get_process_info passes back a handle. This is what it looks like: */
78 struct kinfo_proc **next_proc; /* points to next valid proc pointer */
79 int remaining; /* number of pointers remaining */
82 /* declarations for load_avg */
85 #define PP(pp, field) ((pp)->kp_ ## field)
86 #define LP(pp, field) ((pp)->kp_lwp.kl_ ## field)
87 #define VP(pp, field) ((pp)->kp_vm_ ## field)
89 /* define what weighted cpu is. */
90 #define weighted_cpu(pct, pp) (PP((pp), swtime) == 0 ? 0.0 : \
91 ((pct) / (1.0 - exp(PP((pp), swtime) * logcpu))))
93 /* what we consider to be process size: */
94 #define PROCSIZE(pp) (VP((pp), map_size) / 1024)
97 * These definitions control the format of the per-process area
100 static char smp_header[] =
101 " PID %-*.*s PRI NICE SIZE RES STATE C TIME WCPU CPU COMMAND";
103 #define smp_Proc_format \
104 "%5d %-*.*s %3d %3d%7s %6s %-6.6s %1x%7s %5.2f%% %5.2f%% %.*s"
106 static char up_header[] =
107 " PID %-*.*s PRI NICE SIZE RES STATE TIME WCPU CPU COMMAND";
109 #define up_Proc_format \
110 "%5d %-*.*s %3d %3d%7s %6s %-6.6s%.0d%7s %5.2f%% %5.2f%% %.*s"
114 /* process state names for the "STATE" column of the display */
116 * the extra nulls in the string "run" are for adding a slash and the
117 * processor number when needed
120 const char *state_abbrev[] = {
121 "", "RUN\0\0\0", "STOP", "SLEEP",
127 /* values that we stash away in _init and use in later routines */
129 static double logcpu;
134 /* these are for calculating cpu state percentages */
136 static struct kinfo_cputime *cp_time, *cp_old;
138 /* these are for detailing the process states */
140 int process_states[6];
141 char *procstatenames[] = {
142 "", " starting, ", " running, ", " sleeping, ", " stopped, ",
147 /* these are for detailing the cpu states */
150 char *cpustatenames[CPU_STATES + 1] = {
151 "user", "nice", "system", "interrupt", "idle", NULL
154 /* these are for detailing the memory statistics */
156 long memory_stats[7];
157 char *memorynames[] = {
158 "K Active, ", "K Inact, ", "K Wired, ", "K Cache, ", "K Buf, ", "K Free",
163 char *swapnames[] = {
165 "K Total, ", "K Used, ", "K Free, ", "% Inuse, ", "K In, ", "K Out",
170 /* these are for keeping track of the proc array */
173 static int onproc = -1;
175 static struct kinfo_proc *pbase;
176 static struct kinfo_proc **pref;
178 /* these are for getting the memory statistics */
180 static int pageshift; /* log base 2 of the pagesize */
182 /* define pagetok in terms of pageshift */
184 #define pagetok(size) ((size) << pageshift)
186 /* sorting orders. first is default */
187 char *ordernames[] = {
188 "cpu", "size", "res", "time", "pri", "thr", NULL
191 /* compare routines */
192 int proc_compare(const void *, const void *), compare_size(const void *, const void *),
193 compare_res(const void *, const void *), compare_time(const void *, const void *),
194 compare_prio(const void *, const void *), compare_thr(const void *, const void *);
196 int (*proc_compares[]) () = {
206 cputime_percentages(int out[CPU_STATES], struct kinfo_cputime *new,
207 struct kinfo_cputime *old)
209 struct kinfo_cputime diffs;
210 uint64_t total_change, half_total;
215 diffs.cp_user = new->cp_user - old->cp_user;
216 diffs.cp_nice = new->cp_nice - old->cp_nice;
217 diffs.cp_sys = new->cp_sys - old->cp_sys;
218 diffs.cp_intr = new->cp_intr - old->cp_intr;
219 diffs.cp_idle = new->cp_idle - old->cp_idle;
220 total_change = diffs.cp_user + diffs.cp_nice + diffs.cp_sys +
221 diffs.cp_intr + diffs.cp_idle;
222 old->cp_user = new->cp_user;
223 old->cp_nice = new->cp_nice;
224 old->cp_sys = new->cp_sys;
225 old->cp_intr = new->cp_intr;
226 old->cp_idle = new->cp_idle;
228 /* avoid divide by zero potential */
229 if (total_change == 0)
232 /* calculate percentages based on overall change, rounding up */
233 half_total = total_change >> 1;
235 out[0] = ((diffs.cp_user * 1000LL + half_total) / total_change);
236 out[1] = ((diffs.cp_nice * 1000LL + half_total) / total_change);
237 out[2] = ((diffs.cp_sys * 1000LL + half_total) / total_change);
238 out[3] = ((diffs.cp_intr * 1000LL + half_total) / total_change);
239 out[4] = ((diffs.cp_idle * 1000LL + half_total) / total_change);
243 machine_init(struct statics *statics)
248 struct timeval boottime;
251 if (kinfo_get_cpus(&n_cpus))
252 err(1, "kinfo_get_cpus failed");
255 modelen = sizeof(boottime);
256 if (sysctlbyname("kern.boottime", &boottime, &modelen, NULL, 0) == -1) {
257 /* we have no boottime to report */
258 boottime.tv_sec = -1;
260 modelen = sizeof(smpmode);
261 if ((sysctlbyname("machdep.smp_active", &smpmode, &modelen, NULL, 0) < 0 &&
262 sysctlbyname("smp.smp_active", &smpmode, &modelen, NULL, 0) < 0) ||
263 modelen != sizeof(smpmode))
266 while ((pw = getpwent()) != NULL) {
267 if ((int)strlen(pw->pw_name) > namelength)
268 namelength = strlen(pw->pw_name);
272 if (smpmode && namelength > 13)
274 else if (namelength > 15)
277 if ((kd = kvm_open(NULL, NULL, NULL, O_RDONLY, NULL)) == NULL)
280 if (kinfo_get_sched_ccpu(&ccpu)) {
281 fprintf(stderr, "top: kinfo_get_sched_ccpu failed\n");
284 /* this is used in calculating WCPU -- calculate it ahead of time */
285 logcpu = log(loaddouble(ccpu));
292 * get the page size with "getpagesize" and calculate pageshift from
295 pagesize = getpagesize();
297 while (pagesize > 1) {
302 /* we only need the amount of log(2)1024 for our conversion */
303 pageshift -= LOG1024;
305 /* fill in the statics information */
306 statics->procstate_names = procstatenames;
307 statics->cpustate_names = cpustatenames;
308 statics->memory_names = memorynames;
309 statics->boottime = boottime.tv_sec;
310 statics->swap_names = swapnames;
311 statics->order_names = ordernames;
312 /* we need kvm descriptor in order to show full commands */
313 statics->flags.fullcmds = kd != NULL;
320 format_header(char *uname_field)
322 static char Header[128];
324 snprintf(Header, sizeof(Header), smpmode ? smp_header : up_header,
325 namelength, namelength, uname_field);
327 if (screen_width <= 79)
330 cmdlength = screen_width-1;
332 cmdlength = cmdlength - strlen(Header) + 6;
337 static int swappgsin = -1;
338 static int swappgsout = -1;
339 extern struct timeval timeout;
342 get_system_info(struct system_info *si)
347 if (cpu_states == NULL) {
348 cpu_states = malloc(sizeof(*cpu_states) * CPU_STATES * n_cpus);
349 if (cpu_states == NULL)
351 bzero(cpu_states, sizeof(*cpu_states) * CPU_STATES * n_cpus);
353 if (cp_time == NULL) {
354 cp_time = malloc(2 * n_cpus * sizeof(cp_time[0]));
357 cp_old = cp_time + n_cpus;
359 len = n_cpus * sizeof(cp_old[0]);
361 if (sysctlbyname("kern.cputime", cp_old, &len, NULL, 0))
362 err(1, "kern.cputime");
364 len = n_cpus * sizeof(cp_time[0]);
366 if (sysctlbyname("kern.cputime", cp_time, &len, NULL, 0))
367 err(1, "kern.cputime");
369 getloadavg(si->load_avg, 3);
373 /* convert cp_time counts to percentages */
374 for (cpu = 0; cpu < n_cpus; ++cpu) {
375 cputime_percentages(cpu_states + cpu * CPU_STATES,
376 &cp_time[cpu], &cp_old[cpu]);
379 /* sum memory & swap statistics */
383 size_t vms_size = sizeof(vms);
384 size_t vmm_size = sizeof(vmm);
385 static unsigned int swap_delay = 0;
386 static int swapavail = 0;
387 static int swapfree = 0;
388 static int bufspace = 0;
390 if (sysctlbyname("vm.vmstats", &vms, &vms_size, NULL, 0))
391 err(1, "sysctlbyname: vm.vmstats");
393 if (sysctlbyname("vm.vmmeter", &vmm, &vmm_size, NULL, 0))
394 err(1, "sysctlbyname: vm.vmmeter");
396 if (kinfo_get_vfs_bufspace(&bufspace))
397 err(1, "kinfo_get_vfs_bufspace");
399 /* convert memory stats to Kbytes */
400 memory_stats[0] = pagetok(vms.v_active_count);
401 memory_stats[1] = pagetok(vms.v_inactive_count);
402 memory_stats[2] = pagetok(vms.v_wire_count);
403 memory_stats[3] = pagetok(vms.v_cache_count);
404 memory_stats[4] = bufspace / 1024;
405 memory_stats[5] = pagetok(vms.v_free_count);
406 memory_stats[6] = -1;
413 /* compute differences between old and new swap statistic */
415 swap_stats[4] = pagetok(((vmm.v_swappgsin - swappgsin)));
416 swap_stats[5] = pagetok(((vmm.v_swappgsout - swappgsout)));
419 swappgsin = vmm.v_swappgsin;
420 swappgsout = vmm.v_swappgsout;
422 /* call CPU heavy swapmode() only for changes */
423 if (swap_stats[4] > 0 || swap_stats[5] > 0 || swap_delay == 0) {
424 swap_stats[3] = swapmode(&swapavail, &swapfree);
425 swap_stats[0] = swapavail;
426 swap_stats[1] = swapavail - swapfree;
427 swap_stats[2] = swapfree;
433 /* set arrays and strings */
434 si->cpustates = cpu_states;
435 si->memory = memory_stats;
436 si->swap = swap_stats;
440 si->last_pid = lastpid;
447 static struct handle handle;
450 get_process_info(struct system_info *si, struct process_select *sel,
456 struct kinfo_proc **prefp;
457 struct kinfo_proc *pp;
459 /* these are copied out of sel for speed */
465 pbase = kvm_getprocs(kd, KERN_PROC_ALL, 0, &nproc);
467 pref = (struct kinfo_proc **)realloc(pref, sizeof(struct kinfo_proc *)
469 if (pref == NULL || pbase == NULL) {
470 (void)fprintf(stderr, "top: Out of memory.\n");
473 /* get a pointer to the states summary array */
474 si->procstates = process_states;
476 /* set up flags which define what we are going to select */
477 show_idle = sel->idle;
478 show_system = sel->system;
479 show_uid = sel->uid != -1;
480 show_fullcmd = sel->fullcmd;
482 /* count up process states and get pointers to interesting procs */
485 memset((char *)process_states, 0, sizeof(process_states));
487 for (pp = pbase, i = 0; i < nproc; pp++, i++) {
489 * Place pointers to each valid proc structure in pref[].
490 * Process slots that are actually in use have a non-zero
491 * status field. Processes with P_SYSTEM set are system
492 * processes---these get ignored unless show_sysprocs is set.
494 if ((show_threads && (LP(pp, pid) == -1)) ||
495 (show_system || ((PP(pp, flags) & P_SYSTEM) == 0))) {
497 process_states[(unsigned char)PP(pp, stat)]++;
498 if ((show_threads && (LP(pp, pid) == -1)) ||
499 (show_idle || (LP(pp, pctcpu) != 0) ||
500 (LP(pp, stat) == LSRUN)) &&
501 (!show_uid || PP(pp, ruid) == (uid_t) sel->uid)) {
508 qsort((char *)pref, active_procs, sizeof(struct kinfo_proc *),
509 proc_compares[compare_index]);
511 /* remember active and total counts */
512 si->p_total = total_procs;
513 si->p_active = pref_len = active_procs;
515 /* pass back a handle */
516 handle.next_proc = pref;
517 handle.remaining = active_procs;
518 return ((caddr_t) & handle);
521 char fmt[128]; /* static area where result is built */
524 format_next_process(caddr_t xhandle, char *(*get_userid) (int))
526 struct kinfo_proc *pp;
536 /* find and remember the next proc structure */
537 hp = (struct handle *)xhandle;
538 pp = *(hp->next_proc++);
541 /* get the process's command name */
543 if ((comm_full = kvm_getargv(kd, pp, 0)) == NULL) {
552 * Convert the process's runtime from microseconds to seconds. This
553 * time includes the interrupt time although that is not wanted here.
554 * ps(1) is similarly sloppy.
556 cputime = (LP(pp, uticks) + LP(pp, sticks)) / 1000000;
558 /* calculate the base for cpu percentages */
559 pct = pctdouble(LP(pp, pctcpu));
561 /* generate "STATE" field */
562 switch (state = LP(pp, stat)) {
564 if (smpmode && LP(pp, tdflags) & TDF_RUNNING)
565 sprintf(status, "CPU%d", LP(pp, cpuid));
567 strcpy(status, "RUN");
570 if (LP(pp, wmesg) != NULL) {
571 sprintf(status, "%.6s", LP(pp, wmesg));
578 (unsigned)state < sizeof(state_abbrev) / sizeof(*state_abbrev))
579 sprintf(status, "%.6s", state_abbrev[(unsigned char)state]);
581 sprintf(status, "?%5d", state);
585 if (PP(pp, stat) == SZOMB)
586 strcpy(status, "ZOMB");
589 * idle time 0 - 31 -> nice value +21 - +52 normal time -> nice
590 * value -20 - +20 real time 0 - 31 -> nice value -52 - -21 thread
591 * 0 - 31 -> nice value -53 -
593 switch (LP(pp, rtprio.type)) {
594 case RTP_PRIO_REALTIME:
595 xnice = PRIO_MIN - 1 - RTP_PRIO_MAX + LP(pp, rtprio.prio);
598 xnice = PRIO_MAX + 1 + LP(pp, rtprio.prio);
600 case RTP_PRIO_THREAD:
601 xnice = PRIO_MIN - 1 - RTP_PRIO_MAX - LP(pp, rtprio.prio);
604 xnice = PP(pp, nice);
608 /* format this entry */
609 snprintf(fmt, sizeof(fmt),
610 smpmode ? smp_Proc_format : up_Proc_format,
612 namelength, namelength,
613 get_userid(PP(pp, ruid)),
614 (int)((show_threads && (LP(pp, pid) == -1)) ?
615 LP(pp, tdprio) : LP(pp, prio)),
617 format_k(PROCSIZE(pp)),
618 format_k(pagetok(VP(pp, rssize))),
620 (int)(smpmode ? LP(pp, cpuid) : 0),
621 format_time(cputime),
622 100.0 * weighted_cpu(pct, pp),
625 show_fullcmd ? *comm_full : comm);
627 /* return the result */
631 /* comparison routines for qsort */
634 * proc_compare - comparison function for "qsort"
635 * Compares the resource consumption of two processes using five
636 * distinct keys. The keys (in descending order of importance) are:
637 * percent cpu, cpu ticks, state, resident set size, total virtual
638 * memory usage. The process states are ordered as follows (from least
639 * to most important): WAIT, zombie, sleep, stop, start, run. The
640 * array declaration below maps a process state index into a number
641 * that reflects this ordering.
644 static unsigned char sorted_state[] =
648 1, /* ABANDONED (WAIT) */
656 #define ORDERKEY_PCTCPU \
657 if (lresult = (long) LP(p2, pctcpu) - (long) LP(p1, pctcpu), \
658 (result = lresult > 0 ? 1 : lresult < 0 ? -1 : 0) == 0)
660 #define CPTICKS(p) (LP(p, uticks) + LP(p, sticks))
662 #define ORDERKEY_CPTICKS \
663 if ((result = CPTICKS(p2) > CPTICKS(p1) ? 1 : \
664 CPTICKS(p2) < CPTICKS(p1) ? -1 : 0) == 0)
666 #define ORDERKEY_STATE \
667 if ((result = sorted_state[(unsigned char) PP(p2, stat)] - \
668 sorted_state[(unsigned char) PP(p1, stat)]) == 0)
670 #define ORDERKEY_PRIO \
671 if ((result = LP(p2, prio) - LP(p1, prio)) == 0)
673 #define ORDERKEY_KTHREADS \
674 if ((result = (LP(p1, pid) == 0) - (LP(p2, pid) == 0)) == 0)
676 #define ORDERKEY_KTHREADS_PRIO \
677 if ((result = LP(p2, tdprio) - LP(p1, tdprio)) == 0)
679 #define ORDERKEY_RSSIZE \
680 if ((result = VP(p2, rssize) - VP(p1, rssize)) == 0)
682 #define ORDERKEY_MEM \
683 if ( (result = PROCSIZE(p2) - PROCSIZE(p1)) == 0 )
685 /* compare_cpu - the comparison function for sorting by cpu percentage */
688 proc_compare(const void *arg1, const void *arg2)
690 const struct proc *const *pp1 = arg1;
691 const struct proc *const *pp2 = arg2;
692 const struct kinfo_proc *p1;
693 const struct kinfo_proc *p2;
697 /* remove one level of indirection */
698 p1 = *(const struct kinfo_proc *const *)pp1;
699 p2 = *(const struct kinfo_proc *const *)pp2;
712 /* compare_size - the comparison function for sorting by total memory usage */
715 compare_size(const void *arg1, const void *arg2)
717 struct proc *const *pp1 = arg1;
718 struct proc *const *pp2 = arg2;
719 struct kinfo_proc *p1;
720 struct kinfo_proc *p2;
724 /* remove one level of indirection */
725 p1 = *(struct kinfo_proc *const *)pp1;
726 p2 = *(struct kinfo_proc *const *)pp2;
739 /* compare_res - the comparison function for sorting by resident set size */
742 compare_res(const void *arg1, const void *arg2)
744 struct proc *const *pp1 = arg1;
745 struct proc *const *pp2 = arg2;
746 struct kinfo_proc *p1;
747 struct kinfo_proc *p2;
751 /* remove one level of indirection */
752 p1 = *(struct kinfo_proc *const *)pp1;
753 p2 = *(struct kinfo_proc *const *)pp2;
766 /* compare_time - the comparison function for sorting by total cpu time */
769 compare_time(const void *arg1, const void *arg2)
771 struct proc *const *pp1 = arg1;
772 struct proc *const *pp2 = arg2;
773 const struct kinfo_proc *p1;
774 const struct kinfo_proc *p2;
778 /* remove one level of indirection */
779 p1 = *(struct kinfo_proc *const *)pp1;
780 p2 = *(struct kinfo_proc *const *)pp2;
785 ORDERKEY_KTHREADS_PRIO
795 /* compare_prio - the comparison function for sorting by cpu percentage */
798 compare_prio(const void *arg1, const void *arg2)
800 struct proc *const *pp1 = arg1;
801 struct proc *const *pp2 = arg2;
802 const struct kinfo_proc *p1;
803 const struct kinfo_proc *p2;
807 /* remove one level of indirection */
808 p1 = *(struct kinfo_proc *const *)pp1;
809 p2 = *(struct kinfo_proc *const *)pp2;
812 ORDERKEY_KTHREADS_PRIO
825 compare_thr(const void *arg1, const void *arg2)
827 struct proc *const *pp1 = arg1;
828 struct proc *const *pp2 = arg2;
829 const struct kinfo_proc *p1;
830 const struct kinfo_proc *p2;
834 /* remove one level of indirection */
835 p1 = *(struct kinfo_proc *const *)pp1;
836 p2 = *(struct kinfo_proc *const *)pp2;
839 ORDERKEY_KTHREADS_PRIO
851 * proc_owner(pid) - returns the uid that owns process "pid", or -1 if
852 * the process does not exist.
853 * It is EXTREMLY IMPORTANT that this function work correctly.
854 * If top runs setuid root (as in SVR4), then this function
855 * is the only thing that stands in the way of a serious
856 * security problem. It validates requests for the "kill"
857 * and "renice" commands.
864 struct kinfo_proc **prefp;
865 struct kinfo_proc *pp;
869 while (--xcnt >= 0) {
871 if (PP(pp, pid) == (pid_t) pid) {
872 return ((int)PP(pp, ruid));
880 * swapmode is based on a program called swapinfo written
881 * by Kevin Lahey <kml@rokkaku.atl.ga.us>.
884 swapmode(int *retavail, int *retfree)
887 int pagesize = getpagesize();
888 struct kvm_swap swapary[1];
893 #define CONVERT(v) ((quad_t)(v) * pagesize / 1024)
895 n = kvm_getswapinfo(kd, swapary, 1, 0);
896 if (n < 0 || swapary[0].ksw_total == 0)
899 *retavail = CONVERT(swapary[0].ksw_total);
900 *retfree = CONVERT(swapary[0].ksw_total - swapary[0].ksw_used);
902 n = (int)((double)swapary[0].ksw_used * 100.0 /
903 (double)swapary[0].ksw_total);