Allow top(1) to toggle display of processes+threads or *only* threads
[dragonfly.git] / usr.bin / top / machine.c
1 /*
2  * top - a top users display for Unix
3  *
4  * SYNOPSIS:  For FreeBSD-2.x and later
5  *
6  * DESCRIPTION:
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/)
11  *
12  * This is the machine-dependent module for FreeBSD 2.2
13  * Works for:
14  *      FreeBSD 2.2.x, 3.x, 4.x, and probably FreeBSD 2.1.x
15  *
16  * LIBS: -lkvm
17  *
18  * AUTHOR:  Christos Zoulas <christos@ee.cornell.edu>
19  *          Steven Wallace  <swallace@freebsd.org>
20  *          Wolfram Schneider <wosch@FreeBSD.org>
21  *          Hiten Pandya <hmp@backplane.com>
22  *
23  * $FreeBSD: src/usr.bin/top/machine.c,v 1.29.2.2 2001/07/31 20:27:05 tmm Exp $
24  * $DragonFly: src/usr.bin/top/machine.c,v 1.12 2004/06/04 11:21:53 hmp Exp $
25  */
26
27
28 #include <sys/time.h>
29 #include <sys/types.h>
30 #include <sys/signal.h>
31 #include <sys/param.h>
32
33 #include "os.h"
34 #include <stdio.h>
35 #include <nlist.h>
36 #include <math.h>
37 #include <kvm.h>
38 #include <pwd.h>
39 #include <sys/errno.h>
40 #include <sys/sysctl.h>
41 #include <sys/dkstat.h>
42 #include <sys/file.h>
43 #include <sys/time.h>
44 #include <sys/user.h>
45 #include <sys/vmmeter.h>
46 #include <sys/resource.h>
47 #include <sys/rtprio.h>
48
49 /* Swap */
50 #include <stdlib.h>
51 #include <sys/conf.h>
52
53 #include <osreldate.h> /* for changes in kernel structures */
54
55 #include "top.h"
56 #include "machine.h"
57
58 static int check_nlist(struct nlist *);
59 static int getkval(unsigned long, int *, int, char *);
60 extern char* printable(char *);
61 int swapmode(int *retavail, int *retfree);
62 static int smpmode;
63 static int namelength;
64 static int cmdlength;
65
66 /* 
67  * needs to be a global symbol, so wrapper can be
68  * modified accordingly.
69  */
70 static int show_threads = 0;
71
72 /* get_process_info passes back a handle.  This is what it looks like: */
73
74 struct handle
75 {
76     struct kinfo_proc **next_proc;      /* points to next valid proc pointer */
77     int remaining;              /* number of pointers remaining */
78 };
79
80 /* declarations for load_avg */
81 #include "loadavg.h"
82
83 #define PP(pp, field) ((pp)->kp_proc . field)
84 #define EP(pp, field) ((pp)->kp_eproc . field)
85 #define TP(pp, field) ((pp)->kp_thread . field)
86 #define VP(pp, field) ((pp)->kp_eproc.e_vm . field)
87
88 /* define what weighted cpu is.  */
89 #define weighted_cpu(pct, pp) (PP((pp), p_swtime) == 0 ? 0.0 : \
90                          ((pct) / (1.0 - exp(PP((pp), p_swtime) * logcpu))))
91
92 /* what we consider to be process size: */
93 #define PROCSIZE(pp) (VP((pp), vm_map.size) / 1024)
94
95 /* definitions for indices in the nlist array */
96
97 static struct nlist nlst[] = {
98 #define X_CCPU          0
99     { "_ccpu" },
100 #define X_CP_TIME       1
101     { "_cp_time" },
102 #define X_AVENRUN       2
103     { "_averunnable" },
104
105 #define X_BUFSPACE      3
106         { "_bufspace" },        /* K in buffer cache */
107
108 /* Last pid */
109 #define X_LASTPID       4
110     { "_nextpid" },             
111     { 0 }
112 };
113
114 /*
115  *  These definitions control the format of the per-process area
116  */
117
118 static char smp_header[] =
119   "  PID %-*.*s PRI NICE  SIZE    RES STATE  C   TIME   WCPU    CPU COMMAND";
120
121 #define smp_Proc_format \
122         "%5d %-*.*s %3d %3d%7s %6s %-6.6s %1x%7s %5.2f%% %5.2f%% %.*s"
123
124 static char up_header[] =
125   "  PID %-*.*s PRI NICE  SIZE    RES STATE    TIME   WCPU    CPU COMMAND";
126
127 #define up_Proc_format \
128         "%5d %-*.*s %3d %3d%7s %6s %-6.6s%.0d%7s %5.2f%% %5.2f%% %.*s"
129
130
131
132 /* process state names for the "STATE" column of the display */
133 /* the extra nulls in the string "run" are for adding a slash and
134    the processor number when needed */
135
136 char *state_abbrev[] =
137 {
138     "", "START", "RUN\0\0\0", "SLEEP", "STOP", "ZOMB",
139 };
140
141
142 static kvm_t *kd;
143
144 /* values that we stash away in _init and use in later routines */
145
146 static double logcpu;
147
148 /* these are retrieved from the kernel in _init */
149
150 static load_avg  ccpu;
151
152 /* these are offsets obtained via nlist and used in the get_ functions */
153
154 static unsigned long cp_time_offset;
155 static unsigned long avenrun_offset;
156 static unsigned long lastpid_offset;
157 static long lastpid;
158 static unsigned long bufspace_offset;
159 static long cnt;
160
161 /* these are for calculating cpu state percentages */
162
163 static long cp_time[CPUSTATES];
164 static long cp_old[CPUSTATES];
165 static long cp_diff[CPUSTATES];
166
167 /* these are for detailing the process states */
168
169 int process_states[6];
170 char *procstatenames[] = {
171     "", " starting, ", " running, ", " sleeping, ", " stopped, ",
172     " zombie, ",
173     NULL
174 };
175
176 /* these are for detailing the cpu states */
177
178 int cpu_states[CPUSTATES];
179 char *cpustatenames[] = {
180     "user", "nice", "system", "interrupt", "idle", NULL
181 };
182
183 /* these are for detailing the memory statistics */
184
185 int memory_stats[7];
186 char *memorynames[] = {
187     "K Active, ", "K Inact, ", "K Wired, ", "K Cache, ", "K Buf, ", "K Free",
188     NULL
189 };
190
191 int swap_stats[7];
192 char *swapnames[] = {
193 /*   0           1            2           3            4       5 */
194     "K Total, ", "K Used, ", "K Free, ", "% Inuse, ", "K In, ", "K Out",
195     NULL
196 };
197
198
199 /* these are for keeping track of the proc array */
200
201 static int nproc;
202 static int onproc = -1;
203 static int pref_len;
204 static struct kinfo_proc *pbase;
205 static struct kinfo_proc **pref;
206
207 /* these are for getting the memory statistics */
208
209 static int pageshift;           /* log base 2 of the pagesize */
210
211 /* define pagetok in terms of pageshift */
212
213 #define pagetok(size) ((size) << pageshift)
214
215 /* useful externals */
216 long percentages();
217
218 #ifdef ORDER
219 /* sorting orders. first is default */
220 char *ordernames[] = {
221     "cpu", "size", "res", "time", "pri", "thr", NULL
222 };
223 #endif
224
225 int
226 machine_init(struct statics *statics)
227 {
228     register int i = 0;
229     register int pagesize;
230     size_t modelen;
231     struct passwd *pw;
232
233     modelen = sizeof(smpmode);
234     if ((sysctlbyname("machdep.smp_active", &smpmode, &modelen, NULL, 0) < 0 &&
235          sysctlbyname("smp.smp_active", &smpmode, &modelen, NULL, 0) < 0) ||
236         modelen != sizeof(smpmode))
237             smpmode = 0;
238
239     while ((pw = getpwent()) != NULL) {
240         if (strlen(pw->pw_name) > namelength)
241             namelength = strlen(pw->pw_name);
242     }
243     if (namelength < 8)
244         namelength = 8;
245     if (smpmode && namelength > 13)
246         namelength = 13;
247     else if (namelength > 15)
248         namelength = 15;
249
250     if ((kd = kvm_open(NULL, NULL, NULL, O_RDONLY, "kvm_open")) == NULL)
251         return -1;
252
253
254     /* get the list of symbols we want to access in the kernel */
255     (void) kvm_nlist(kd, nlst);
256     if (nlst[0].n_type == 0)
257     {
258         fprintf(stderr, "top: nlist failed\n");
259         return(-1);
260     }
261
262     /* make sure they were all found */
263     if (i > 0 && check_nlist(nlst) > 0)
264     {
265         return(-1);
266     }
267
268     (void) getkval(nlst[X_CCPU].n_value,   (int *)(&ccpu),      sizeof(ccpu),
269             nlst[X_CCPU].n_name);
270
271     /* stash away certain offsets for later use */
272     cp_time_offset = nlst[X_CP_TIME].n_value;
273     avenrun_offset = nlst[X_AVENRUN].n_value;
274     lastpid_offset =  nlst[X_LASTPID].n_value;
275     bufspace_offset = nlst[X_BUFSPACE].n_value;
276
277     /* this is used in calculating WCPU -- calculate it ahead of time */
278     logcpu = log(loaddouble(ccpu));
279
280     pbase = NULL;
281     pref = NULL;
282     nproc = 0;
283     onproc = -1;
284     /* get the page size with "getpagesize" and calculate pageshift from it */
285     pagesize = getpagesize();
286     pageshift = 0;
287     while (pagesize > 1)
288     {
289         pageshift++;
290         pagesize >>= 1;
291     }
292
293     /* we only need the amount of log(2)1024 for our conversion */
294     pageshift -= LOG1024;
295
296     /* fill in the statics information */
297     statics->procstate_names = procstatenames;
298     statics->cpustate_names = cpustatenames;
299     statics->memory_names = memorynames;
300     statics->swap_names = swapnames;
301 #ifdef ORDER
302     statics->order_names = ordernames;
303 #endif
304
305     /* all done! */
306     return(0);
307 }
308
309 char *format_header(register char *uname_field)
310 {
311     register char *ptr;
312     static char Header[128];
313
314     snprintf(Header, sizeof(Header), smpmode ? smp_header : up_header,
315              namelength, namelength, uname_field);
316
317     if (screen_width <= 79)
318         cmdlength = 80;
319     else
320         cmdlength = 89;
321
322     cmdlength = cmdlength - strlen(Header) + 6;
323
324     return Header;
325 }
326
327 static int swappgsin = -1;
328 static int swappgsout = -1;
329 extern struct timeval timeout;
330
331 void
332 get_system_info(struct system_info *si)
333 {
334     long total;
335     load_avg avenrun[3];
336     int mib[2];
337     struct timeval boottime;
338     size_t bt_size;
339
340     /* get the cp_time array */
341     (void) getkval(cp_time_offset, (int *)cp_time, sizeof(cp_time),
342                    nlst[X_CP_TIME].n_name);
343     (void) getkval(avenrun_offset, (int *)avenrun, sizeof(avenrun),
344                    nlst[X_AVENRUN].n_name);
345
346     (void) getkval(lastpid_offset, (int *)(&lastpid), sizeof(lastpid),
347                    "!");
348
349     /* convert load averages to doubles */
350     {
351         register int i;
352         register double *infoloadp;
353         load_avg *avenrunp;
354
355 #ifdef notyet
356         struct loadavg sysload;
357         int size;
358         getkerninfo(KINFO_LOADAVG, &sysload, &size, 0);
359 #endif
360
361         infoloadp = si->load_avg;
362         avenrunp = avenrun;
363         for (i = 0; i < 3; i++)
364         {
365 #ifdef notyet
366             *infoloadp++ = ((double) sysload.ldavg[i]) / sysload.fscale;
367 #endif
368             *infoloadp++ = loaddouble(*avenrunp++);
369         }
370     }
371
372     /* convert cp_time counts to percentages */
373     total = percentages(CPUSTATES, cpu_states, cp_time, cp_old, cp_diff);
374
375     /* sum memory & swap statistics */
376     {
377         struct vmmeter vmm;
378         struct vmstats vms;
379         int vms_size = sizeof(vms);
380         int vmm_size = sizeof(vmm);
381         static unsigned int swap_delay = 0;
382         static int swapavail = 0;
383         static int swapfree = 0;
384         static int bufspace = 0;
385
386         if (sysctlbyname("vm.vmstats", &vms, &vms_size, NULL, 0)) {
387                 perror("sysctlbyname: vm.vmstats");
388                 exit(1);
389         }
390         if (sysctlbyname("vm.vmmeter", &vmm, &vmm_size, NULL, 0)) {
391                 perror("sysctlbyname: vm.vmstats");
392                 exit(1);
393         }
394         (void) getkval(bufspace_offset, (int *)(&bufspace), sizeof(bufspace),
395                    "_bufspace");
396
397         /* convert memory stats to Kbytes */
398         memory_stats[0] = pagetok(vms.v_active_count);
399         memory_stats[1] = pagetok(vms.v_inactive_count);
400         memory_stats[2] = pagetok(vms.v_wire_count);
401         memory_stats[3] = pagetok(vms.v_cache_count);
402         memory_stats[4] = bufspace / 1024;
403         memory_stats[5] = pagetok(vms.v_free_count);
404         memory_stats[6] = -1;
405
406         /* first interval */
407         if (swappgsin < 0) {
408             swap_stats[4] = 0;
409             swap_stats[5] = 0;
410         } 
411
412         /* compute differences between old and new swap statistic */
413         else {
414             swap_stats[4] = pagetok(((vmm.v_swappgsin - swappgsin)));
415             swap_stats[5] = pagetok(((vmm.v_swappgsout - swappgsout)));
416         }
417
418         swappgsin = vmm.v_swappgsin;
419         swappgsout = vmm.v_swappgsout;
420
421         /* call CPU heavy swapmode() only for changes */
422         if (swap_stats[4] > 0 || swap_stats[5] > 0 || swap_delay == 0) {
423             swap_stats[3] = swapmode(&swapavail, &swapfree);
424             swap_stats[0] = swapavail;
425             swap_stats[1] = swapavail - swapfree;
426             swap_stats[2] = swapfree;
427         }
428         swap_delay = 1;
429         swap_stats[6] = -1;
430     }
431
432     /* set arrays and strings */
433     si->cpustates = cpu_states;
434     si->memory = memory_stats;
435     si->swap = swap_stats;
436
437
438     if(lastpid > 0) {
439         si->last_pid = lastpid;
440     } else {
441         si->last_pid = -1;
442     }
443
444     /*
445      * Print how long system has been up.
446      * (Found by looking getting "boottime" from the kernel)
447      */
448     mib[0] = CTL_KERN;
449     mib[1] = KERN_BOOTTIME;
450     bt_size = sizeof(boottime);
451     if (sysctl(mib, 2, &boottime, &bt_size, NULL, 0) != -1 &&
452         boottime.tv_sec != 0) {
453         si->boottime = boottime;
454     } else {
455         si->boottime.tv_sec = -1;
456     }
457 }
458
459 static struct handle handle;
460
461 caddr_t get_process_info(struct system_info *si, struct process_select *sel,
462                          int (*compare)())
463 {
464     register int i;
465     register int total_procs;
466     register int active_procs;
467     register struct kinfo_proc **prefp;
468     register struct kinfo_proc *pp;
469
470     /* these are copied out of sel for speed */
471     int show_idle;
472     int show_self;
473     int show_system;
474     int show_only_threads;
475     int show_uid;
476     int show_command;
477
478     
479     pbase = kvm_getprocs(kd, KERN_PROC_ALL, 0, &nproc);
480     if (nproc > onproc)
481         pref = (struct kinfo_proc **) realloc(pref, sizeof(struct kinfo_proc *)
482                 * (onproc = nproc));
483     if (pref == NULL || pbase == NULL) {
484         (void) fprintf(stderr, "top: Out of memory.\n");
485         quit(23);
486     }
487     /* get a pointer to the states summary array */
488     si->procstates = process_states;
489
490     /* set up flags which define what we are going to select */
491     show_idle = sel->idle;
492     show_self = sel->self;
493     show_system = sel->system;
494     show_threads = sel->threads;
495     show_only_threads = sel->only_threads;
496     show_uid = sel->uid != -1;
497     show_command = sel->command != NULL;
498
499     /* count up process states and get pointers to interesting procs */
500     total_procs = 0;
501     active_procs = 0;
502     memset((char *)process_states, 0, sizeof(process_states));
503     prefp = pref;
504     for (pp = pbase, i = 0; i < nproc; pp++, i++)
505     {
506         /*
507          *  Place pointers to each valid proc structure in pref[].
508          *  Process slots that are actually in use have a non-zero
509          *  status field.  Processes with P_SYSTEM set are system
510          *  processes---these get ignored unless show_sysprocs is set.
511          */
512         if ((show_threads && (TP(pp, td_proc) == NULL)) ||
513             (!show_only_threads && (PP(pp, p_stat) != 0 &&
514             (show_self != PP(pp, p_pid)) &&
515             (show_system || ((PP(pp, p_flag) & P_SYSTEM) == 0)))))
516         {
517             total_procs++;
518             process_states[(unsigned char) PP(pp, p_stat)]++;
519             if ((show_threads && (TP(pp, td_proc) == NULL)) ||
520                 (!show_only_threads && (PP(pp, p_stat) != SZOMB) &&
521                 (show_idle || (PP(pp, p_pctcpu) != 0) ||
522                  (PP(pp, p_stat) == SRUN)) &&
523                 (!show_uid || EP(pp, e_ucred.cr_ruid) == (uid_t)sel->uid)))
524             {
525                 *prefp++ = pp;
526                 active_procs++;
527             }
528         }
529     }
530
531     /* if requested, sort the "interesting" processes */
532     if (compare != NULL)
533     {
534         qsort((char *)pref, active_procs, sizeof(struct kinfo_proc *), compare);
535     }
536
537     /* remember active and total counts */
538     si->p_total = total_procs;
539     si->p_active = pref_len = active_procs;
540
541     /* pass back a handle */
542     handle.next_proc = pref;
543     handle.remaining = active_procs;
544     return((caddr_t)&handle);
545 }
546
547 char fmt[128];          /* static area where result is built */
548
549 char *format_next_process(caddr_t handle, char *(*get_userid)())
550 {
551     struct kinfo_proc *pp;
552     long cputime;
553     double pct;
554     struct handle *hp;
555     char status[16];
556     char const *wrapper;
557     int state;
558     int nice;
559
560     /* find and remember the next proc structure */
561     hp = (struct handle *)handle;
562     pp = *(hp->next_proc++);
563     hp->remaining--;
564     
565     /* set the wrapper for the process/thread name */
566     if ((PP(pp, p_flag) & P_INMEM) == 0)
567          wrapper = "[]"; /* swapped process [pname] */
568     else if (((PP(pp, p_flag) & P_SYSTEM) != 0) && (TP(pp, td_proc) != NULL))
569          wrapper = "()"; /* system process (pname) */
570     else if (show_threads && (TP(pp, td_proc) == NULL))
571          wrapper = "<>"; /* pure kernel threads <thread> */
572     else
573          wrapper = NULL;
574   
575     /* get the process's command name */
576     if (wrapper != NULL) {
577         char *comm = TP(pp, td_comm);
578 #define COMSIZ sizeof(TP(pp, td_comm))
579         char buf[COMSIZ];
580         (void) strncpy(buf, comm, COMSIZ);
581         comm[0] = wrapper[0];
582         (void) strncpy(&comm[1], buf, COMSIZ - 2);
583         comm[COMSIZ - 2] = '\0';
584         (void) strncat(comm, &wrapper[1], COMSIZ - 1);
585         comm[COMSIZ - 1] = '\0';
586     }
587
588     /*
589      * Convert the process's runtime from microseconds to seconds.  This
590      * time includes the interrupt time although that is not wanted here.
591      * ps(1) is similarly sloppy.
592      */
593     cputime = (EP(pp, e_uticks) + EP(pp, e_sticks)) / 1000000;
594
595     /* calculate the base for cpu percentages */
596     pct = pctdouble(PP(pp, p_pctcpu));
597
598     /* generate "STATE" field */
599     switch (state = PP(pp, p_stat)) {
600         case SRUN:
601             if (smpmode && TP(pp, td_flags) & TDF_RUNNING)
602                 sprintf(status, "CPU%d", EP(pp, e_cpuid));
603             else
604                 strcpy(status, "RUN");
605             break;
606         case SSLEEP:
607             if (TP(pp, td_wmesg) != NULL) {
608                 sprintf(status, "%.6s", EP(pp, e_wmesg));
609                 break;
610             }
611             /* fall through */
612         default:
613
614             if (state >= 0 &&
615                 state < sizeof(state_abbrev) / sizeof(*state_abbrev))
616                     sprintf(status, "%.6s", state_abbrev[(unsigned char) state]);
617             else
618                     sprintf(status, "?%5d", state);
619             break;
620     }
621
622     /*
623      * idle time 0 - 31 -> nice value +21 - +52
624      * normal time      -> nice value -20 - +20 
625      * real time 0 - 31 -> nice value -52 - -21
626      * thread    0 - 31 -> nice value -53 -
627      */
628     switch(PP(pp, p_rtprio.type)) {
629     case RTP_PRIO_REALTIME:
630         nice = PRIO_MIN - 1 - RTP_PRIO_MAX + PP(pp, p_rtprio.prio);
631         break;
632     case RTP_PRIO_IDLE:
633         nice = PRIO_MAX + 1 + PP(pp, p_rtprio.prio);
634         break;
635     case RTP_PRIO_THREAD:
636         nice = PRIO_MIN - 1 - RTP_PRIO_MAX - PP(pp, p_rtprio.prio);
637         break;
638     default:
639         nice = PP(pp, p_nice);
640         break;
641     }
642
643
644     /* format this entry */
645     snprintf(fmt, sizeof(fmt),
646             smpmode ? smp_Proc_format : up_Proc_format,
647             PP(pp, p_pid),
648             namelength, namelength,
649             (*get_userid)(EP(pp, e_ucred.cr_ruid)),
650             (show_threads && (TP(pp, td_proc) == NULL)) ? TP(pp, td_pri) :
651                 PP(pp, p_priority),
652             nice,
653             format_k2(PROCSIZE(pp)),
654             format_k2(pagetok(VP(pp, vm_rssize))),
655             status,
656             smpmode ? EP(pp, e_cpuid) : 0,
657             format_time(cputime),
658             100.0 * weighted_cpu(pct, pp),
659             100.0 * pct,
660             cmdlength,
661             printable(TP(pp, td_comm)));
662
663     /* return the result */
664     return(fmt);
665 }
666
667
668 /*
669  * check_nlist(nlst) - checks the nlist to see if any symbols were not
670  *              found.  For every symbol that was not found, a one-line
671  *              message is printed to stderr.  The routine returns the
672  *              number of symbols NOT found.
673  */
674
675 static int check_nlist(register struct nlist *nlst)
676 {
677     register int i;
678
679     /* check to see if we got ALL the symbols we requested */
680     /* this will write one line to stderr for every symbol not found */
681
682     i = 0;
683     while (nlst->n_name != NULL)
684     {
685         if (nlst->n_type == 0)
686         {
687             /* this one wasn't found */
688             (void) fprintf(stderr, "kernel: no symbol named `%s'\n",
689                            nlst->n_name);
690             i = 1;
691         }
692         nlst++;
693     }
694
695     return(i);
696 }
697
698
699 /*
700  *  getkval(offset, ptr, size, refstr) - get a value out of the kernel.
701  *      "offset" is the byte offset into the kernel for the desired value,
702  *      "ptr" points to a buffer into which the value is retrieved,
703  *      "size" is the size of the buffer (and the object to retrieve),
704  *      "refstr" is a reference string used when printing error meessages,
705  *          if "refstr" starts with a '!', then a failure on read will not
706  *          be fatal (this may seem like a silly way to do things, but I
707  *          really didn't want the overhead of another argument).
708  *      
709  */
710
711 static int getkval(unsigned long offset, int *ptr, int size, char *refstr)
712 {
713     if (kvm_read(kd, offset, (char *) ptr, size) != size)
714     {
715         if (*refstr == '!')
716         {
717             return(0);
718         }
719         else
720         {
721             fprintf(stderr, "top: kvm_read for %s: %s\n",
722                 refstr, strerror(errno));
723             quit(23);
724         }
725     }
726     return(1);
727 }
728     
729 /* comparison routines for qsort */
730
731 /*
732  *  proc_compare - comparison function for "qsort"
733  *      Compares the resource consumption of two processes using five
734  *      distinct keys.  The keys (in descending order of importance) are:
735  *      percent cpu, cpu ticks, state, resident set size, total virtual
736  *      memory usage.  The process states are ordered as follows (from least
737  *      to most important):  WAIT, zombie, sleep, stop, start, run.  The
738  *      array declaration below maps a process state index into a number
739  *      that reflects this ordering.
740  */
741
742 static unsigned char sorted_state[] =
743 {
744     0,  /* not used             */
745     3,  /* sleep                */
746     1,  /* ABANDONED (WAIT)     */
747     6,  /* run                  */
748     5,  /* start                */
749     2,  /* zombie               */
750     4   /* stop                 */
751 };
752  
753
754 #define ORDERKEY_PCTCPU \
755   if (lresult = (long) PP(p2, p_pctcpu) - (long) PP(p1, p_pctcpu), \
756      (result = lresult > 0 ? 1 : lresult < 0 ? -1 : 0) == 0)
757
758 #define CPTICKS(p)      (EP(p, e_uticks) + EP(p, e_sticks))
759
760 #define ORDERKEY_CPTICKS \
761   if ((result = CPTICKS(p2) > CPTICKS(p1) ? 1 : \
762                 CPTICKS(p2) < CPTICKS(p1) ? -1 : 0) == 0)
763
764 #define ORDERKEY_STATE \
765   if ((result = sorted_state[(unsigned char) PP(p2, p_stat)] - \
766                 sorted_state[(unsigned char) PP(p1, p_stat)]) == 0)
767
768 #define ORDERKEY_PRIO \
769   if ((result = PP(p2, p_priority) - PP(p1, p_priority)) == 0)
770
771 #define ORDERKEY_KTHREADS \
772   if ((result = (TP(p1, td_proc) == NULL) - (TP(p2, td_proc) == NULL)) == 0)
773
774 #define ORDERKEY_KTHREADS_PRIO \
775   if ((result = TP(p2, td_pri) - TP(p1, td_pri)) == 0)
776
777 #define ORDERKEY_RSSIZE \
778   if ((result = VP(p2, vm_rssize) - VP(p1, vm_rssize)) == 0) 
779
780 #define ORDERKEY_MEM \
781   if ( (result = PROCSIZE(p2) - PROCSIZE(p1)) == 0 )
782
783 /* compare_cpu - the comparison function for sorting by cpu percentage */
784
785 int
786 #ifdef ORDER
787 compare_cpu(struct proc **pp1, struct proc **pp2)
788 #else
789 proc_compare(struct proc **pp1, struct proc **pp2)
790 #endif
791 {
792     register struct kinfo_proc *p1;
793     register struct kinfo_proc *p2;
794     register int result;
795     register pctcpu lresult;
796
797     /* remove one level of indirection */
798     p1 = *(struct kinfo_proc **) pp1;
799     p2 = *(struct kinfo_proc **) pp2;
800
801     ORDERKEY_PCTCPU
802     ORDERKEY_CPTICKS
803     ORDERKEY_STATE
804     ORDERKEY_PRIO
805     ORDERKEY_RSSIZE
806     ORDERKEY_MEM
807     ;
808
809     return(result);
810 }
811
812 #ifdef ORDER
813 /* compare routines */
814 int compare_size(), compare_res(), compare_time(), compare_prio(), compare_thr();
815
816 int (*proc_compares[])() = {
817     compare_cpu,
818     compare_size,
819     compare_res,
820     compare_time,
821     compare_prio,
822     compare_thr,
823     NULL
824 };
825
826 /* compare_size - the comparison function for sorting by total memory usage */
827
828 int
829 compare_size(struct proc **pp1, struct proc **pp2)
830 {
831     register struct kinfo_proc *p1;
832     register struct kinfo_proc *p2;
833     register int result;
834     register pctcpu lresult;
835
836     /* remove one level of indirection */
837     p1 = *(struct kinfo_proc **) pp1;
838     p2 = *(struct kinfo_proc **) pp2;
839
840     ORDERKEY_MEM
841     ORDERKEY_RSSIZE
842     ORDERKEY_PCTCPU
843     ORDERKEY_CPTICKS
844     ORDERKEY_STATE
845     ORDERKEY_PRIO
846     ;
847
848     return(result);
849 }
850
851 /* compare_res - the comparison function for sorting by resident set size */
852
853 int
854 compare_res(struct proc **pp1, struct proc **pp2)
855 {
856     register struct kinfo_proc *p1;
857     register struct kinfo_proc *p2;
858     register int result;
859     register pctcpu lresult;
860
861     /* remove one level of indirection */
862     p1 = *(struct kinfo_proc **) pp1;
863     p2 = *(struct kinfo_proc **) pp2;
864
865     ORDERKEY_RSSIZE
866     ORDERKEY_MEM
867     ORDERKEY_PCTCPU
868     ORDERKEY_CPTICKS
869     ORDERKEY_STATE
870     ORDERKEY_PRIO
871     ;
872
873     return(result);
874 }
875
876 /* compare_time - the comparison function for sorting by total cpu time */
877
878 int
879 compare_time(struct proc **pp1, struct proc **pp2)
880 {
881     register struct kinfo_proc *p1;
882     register struct kinfo_proc *p2;
883     register int result;
884     register pctcpu lresult;
885   
886     /* remove one level of indirection */
887     p1 = *(struct kinfo_proc **) pp1;
888     p2 = *(struct kinfo_proc **) pp2;
889
890     ORDERKEY_CPTICKS
891     ORDERKEY_PCTCPU
892     ORDERKEY_KTHREADS
893     ORDERKEY_KTHREADS_PRIO
894     ORDERKEY_STATE
895     ORDERKEY_PRIO
896     ORDERKEY_RSSIZE
897     ORDERKEY_MEM
898     ;
899
900       return(result);
901   }
902   
903 /* compare_prio - the comparison function for sorting by cpu percentage */
904
905 int
906 compare_prio(struct proc **pp1, struct proc **pp2)
907 {
908     register struct kinfo_proc *p1;
909     register struct kinfo_proc *p2;
910     register int result;
911     register pctcpu lresult;
912
913     /* remove one level of indirection */
914     p1 = *(struct kinfo_proc **) pp1;
915     p2 = *(struct kinfo_proc **) pp2;
916
917     ORDERKEY_KTHREADS
918     ORDERKEY_KTHREADS_PRIO
919     ORDERKEY_PRIO
920     ORDERKEY_CPTICKS
921     ORDERKEY_PCTCPU
922     ORDERKEY_STATE
923     ORDERKEY_RSSIZE
924     ORDERKEY_MEM
925     ;
926
927     return(result);
928 }
929
930 int
931 compare_thr(struct proc **pp1, struct proc **pp2)
932 {
933     register struct kinfo_proc *p1;
934     register struct kinfo_proc *p2;
935     register int result;
936     register pctcpu lresult;
937
938     /* remove one level of indirection */
939     p1 = *(struct kinfo_proc **) pp1;
940     p2 = *(struct kinfo_proc **) pp2;
941
942     ORDERKEY_KTHREADS
943     ORDERKEY_KTHREADS_PRIO
944     ORDERKEY_CPTICKS
945     ORDERKEY_PCTCPU
946     ORDERKEY_STATE
947     ORDERKEY_RSSIZE
948     ORDERKEY_MEM
949     ;
950
951     return(result);
952 }
953
954
955 #endif
956
957 /*
958  * proc_owner(pid) - returns the uid that owns process "pid", or -1 if
959  *              the process does not exist.
960  *              It is EXTREMLY IMPORTANT that this function work correctly.
961  *              If top runs setuid root (as in SVR4), then this function
962  *              is the only thing that stands in the way of a serious
963  *              security problem.  It validates requests for the "kill"
964  *              and "renice" commands.
965  */
966
967 int proc_owner(int pid)
968 {
969     register int cnt;
970     register struct kinfo_proc **prefp;
971     register struct kinfo_proc *pp;
972
973     prefp = pref;
974     cnt = pref_len;
975     while (--cnt >= 0)
976     {
977         pp = *prefp++;  
978         if (PP(pp, p_pid) == (pid_t)pid)
979         {
980             return((int)EP(pp, e_ucred.cr_ruid));
981         }
982     }
983     return(-1);
984 }
985
986
987 /*
988  * swapmode is based on a program called swapinfo written
989  * by Kevin Lahey <kml@rokkaku.atl.ga.us>.
990  */
991
992 #define SVAR(var) __STRING(var) /* to force expansion */
993 #define KGET(idx, var)                                                  \
994         KGET1(idx, &var, sizeof(var), SVAR(var))
995 #define KGET1(idx, p, s, msg)                                           \
996         KGET2(nlst[idx].n_value, p, s, msg)
997 #define KGET2(addr, p, s, msg)                                          \
998         if (kvm_read(kd, (u_long)(addr), p, s) != s) {                  \
999                 warnx("cannot read %s: %s", msg, kvm_geterr(kd));       \
1000                 return (0);                                             \
1001        }
1002 #define KGETRET(addr, p, s, msg)                                        \
1003         if (kvm_read(kd, (u_long)(addr), p, s) != s) {                  \
1004                 warnx("cannot read %s: %s", msg, kvm_geterr(kd));       \
1005                 return (0);                                             \
1006         }
1007
1008
1009 int
1010 swapmode(int *retavail, int *retfree)
1011 {
1012         int n;
1013         int pagesize = getpagesize();
1014         struct kvm_swap swapary[1];
1015
1016         *retavail = 0;
1017         *retfree = 0;
1018
1019 #define CONVERT(v)      ((quad_t)(v) * pagesize / 1024)
1020
1021         n = kvm_getswapinfo(kd, swapary, 1, 0);
1022         if (n < 0 || swapary[0].ksw_total == 0)
1023                 return(0);
1024
1025         *retavail = CONVERT(swapary[0].ksw_total);
1026         *retfree = CONVERT(swapary[0].ksw_total - swapary[0].ksw_used);
1027
1028         n = (int)((double)swapary[0].ksw_used * 100.0 /
1029             (double)swapary[0].ksw_total);
1030         return(n);
1031 }
1032