1 /* Get the system load averages.
2 Copyright (C) 1985, 86, 87, 88, 89, 91, 92, 93, 1994, 1995
3 Free Software Foundation, Inc.
5 This file is part of XEmacs.
7 XEmacs is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 2, or (at your option) any
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with XEmacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 /* Compile-time symbols that this file uses:
24 FIXUP_KERNEL_SYMBOL_ADDR() Adjust address in returned struct nlist.
25 KERNEL_FILE Pathname of the kernel to nlist.
26 LDAV_CVT() Scale the load average from the kernel.
28 LDAV_SYMBOL Name of kernel symbol giving load average.
29 LOAD_AVE_TYPE Type of the load average array in the kernel.
30 Must be defined unless one of
31 apollo, DGUX, NeXT, or UMAX is defined;
32 otherwise, no load average is available.
33 NLIST_STRUCT Include nlist.h, not a.out.h, and
34 the nlist n_name element is a pointer,
36 NLIST_NAME_UNION struct nlist has an n_un member, not n_name.
37 LINUX_LDAV_FILE [__linux__]: File containing load averages.
39 Specific system predefines this file uses, aside from setting
40 default values if not emacs:
43 BSD Real BSD, not just BSD-like.
49 sequent Sequent Dynix 3.x.x (BSD)
50 _SEQUENT_ Sequent DYNIX/ptx 1.x.x (SYSV)
51 sony_news NEWS-OS (works at least for 4.1C)
54 WIN32_NATIVE No-op for Windows9x/NT.
55 CYGWIN No-op for Cygwin.
56 __linux__ Linux: assumes /proc filesystem mounted.
57 Support from Michael K. Johnson.
58 __NetBSD__ NetBSD: assumes /kern filesystem mounted.
59 __OpenBSD__ OpenBSD: ditto.
61 In addition, to avoid nesting many #ifdefs, we internally set
62 LDAV_DONE to indicate that the load average has been computed.
64 We also #define LDAV_PRIVILEGED if a program will require
65 special installation to be able to call getloadavg. */
67 /* This should always be first. */
73 #include "sysfile.h" /* for encapsulated open, close, read, write */
75 #ifndef HAVE_GETLOADAVG
77 /* The existing Emacs configuration files define a macro called
78 LOAD_AVE_CVT, which accepts a value of type LOAD_AVE_TYPE, and
79 returns the load average multiplied by 100. What we actually want
80 is a macro called LDAV_CVT, which returns the load average as an
83 For backwards compatibility, we'll define LDAV_CVT in terms of
84 LOAD_AVE_CVT, but future machine config files should just define
87 #if !defined(LDAV_CVT) && defined(LOAD_AVE_CVT)
88 #define LDAV_CVT(n) (LOAD_AVE_CVT (n) / 100.0)
91 #if defined (HAVE_KSTAT_H)
93 #endif /* HAVE_KSTAT_H */
95 #if !defined (BSD) && defined (ultrix)
96 /* Ultrix behaves like BSD on Vaxen. */
101 /* NeXT in the 2.{0,1,2} releases defines BSD in <sys/param.h>, which
102 conflicts with the definition understood in this file, that this
106 /* NeXT defines FSCALE in <sys/param.h>. However, we take FSCALE being
107 defined to mean that the nlist method should be used, which is not true. */
111 /* Set values that are different from the defaults, which are
112 set a little farther down with #ifndef. */
115 /* Some shorthands. */
117 #if defined (HPUX) && !defined (hpux)
121 #if defined(hp300) && !defined(hpux)
125 #if defined(ultrix) && defined(mips)
129 #if (defined(sun) && defined(SVR4)) || defined (SOLARIS2)
133 #if defined (__osf__) && (defined (__alpha) || defined (__alpha__))
136 #include <netinet/in.h> /* Needed for Digital UNIX V3 */
137 #include <net/proto_net.h>
138 #include <sys/table.h>
141 #if defined (__osf__) && (defined (mips) || defined (__mips__))
143 #include <sys/table.h>
146 /* UTek's /bin/cc on the 4300 has no architecture specific cpp define by
147 default, but _MACH_IND_SYS_TYPES is defined in <sys/types.h>. Combine
148 that with a couple of other things and we'll have a unique match. */
149 #if !defined (tek4300) && defined (unix) && defined (m68k) && defined (mc68000) && defined (mc68020) && defined (_MACH_IND_SYS_TYPES)
150 #define tek4300 /* Define by emacs, but not by other users. */
154 /* VAX C can't handle multi-line #ifs, or lines longer than 256 chars. */
155 #ifndef LOAD_AVE_TYPE
158 #define LOAD_AVE_TYPE long
162 #define LOAD_AVE_TYPE long
166 #define LOAD_AVE_TYPE long
170 #define LOAD_AVE_TYPE long
174 #define LOAD_AVE_TYPE long
178 #define LOAD_AVE_TYPE long
182 #define LOAD_AVE_TYPE long
186 #define LOAD_AVE_TYPE long
190 #define LOAD_AVE_TYPE long
193 #if defined (ardent) && defined (titan)
194 #define LOAD_AVE_TYPE long
198 #define LOAD_AVE_TYPE long
201 #if defined(alliant) && defined(i860) /* Alliant FX/2800 */
202 #define LOAD_AVE_TYPE long
206 #define LOAD_AVE_TYPE long
210 #define LOAD_AVE_TYPE double
212 #define LDAV_CVT(n) (n)
216 #endif /* No LOAD_AVE_TYPE. */
219 /* <sys/param.h> defines an incorrect value for FSCALE on Alpha OSF/1,
220 according to ghazi@noc.rutgers.edu. */
222 #define FSCALE 1024.0
225 #if defined(alliant) && defined(i860) /* Alliant FX/2800 */
226 /* <sys/param.h> defines an incorrect value for FSCALE on an
227 Alliant FX/2800 Concentrix 2.2, according to ghazi@noc.rutgers.edu. */
235 /* SunOS and some others define FSCALE in sys/param.h. */
238 #define FSCALE 2048.0
241 #if defined(MIPS) || defined(SVR4) || defined(decstation)
245 #if defined (sgi) || defined (sequent)
246 /* Sometimes both MIPS and sgi are defined, so FSCALE was just defined
247 above under #ifdef MIPS. But we want the sgi value. */
249 #define FSCALE 1000.0
252 #if defined (ardent) && defined (titan)
253 #define FSCALE 65536.0
261 #define FSCALE 65536.0
264 #endif /* Not FSCALE. */
266 #if !defined (LDAV_CVT) && defined (FSCALE)
267 #define LDAV_CVT(n) (((double) (n)) / FSCALE)
270 /* VAX C can't handle multi-line #ifs, or lines longer that 256 characters. */
289 #if defined (_SEQUENT_) || defined (sequent)
309 #if defined (ardent) && defined (titan)
321 #if defined(alliant) && defined(i860) /* Alliant FX/2800 */
329 #endif /* defined (NLIST_STRUCT) */
332 #if defined(sgi) || (defined(mips) && !defined(BSD))
333 #define FIXUP_KERNEL_SYMBOL_ADDR(nl) ((nl)[0].n_value &= ~(1 << 31))
337 #if !defined (KERNEL_FILE) && defined (sequent)
338 #define KERNEL_FILE "/dynix"
341 #if !defined (KERNEL_FILE) && defined (hpux)
342 #define KERNEL_FILE "/hp-ux"
345 #if !defined(KERNEL_FILE) && (defined(_SEQUENT_) || defined(MIPS) || defined(SVR4) || defined(ISC) || defined (sgi) || defined(SVR4) || (defined (ardent) && defined (titan)))
346 #define KERNEL_FILE "/unix"
350 #if !defined (LDAV_SYMBOL) && defined (alliant)
351 #define LDAV_SYMBOL "_Loadavg"
354 #if !defined(LDAV_SYMBOL) && ((defined(hpux) && !defined(hp9000s300)) || defined(_SEQUENT_) || defined(SVR4) || defined(ISC) || defined(sgi) || (defined (ardent) && defined (titan)) || defined (_AIX))
355 #define LDAV_SYMBOL "avenrun"
364 /* LOAD_AVE_TYPE should only get defined if we're going to use the
366 #if !defined(LOAD_AVE_TYPE) && (defined(BSD) || defined(LDAV_CVT) || defined(KERNEL_FILE) || defined(LDAV_SYMBOL))
367 #define LOAD_AVE_TYPE double
374 #else /* NLIST_STRUCT */
376 #endif /* NLIST_STRUCT */
384 #define KERNEL_FILE "/vmunix"
385 #endif /* KERNEL_FILE */
388 #define LDAV_SYMBOL "_avenrun"
389 #endif /* LDAV_SYMBOL */
392 #define LDAV_CVT(n) ((double) (n))
393 #endif /* !LDAV_CVT */
395 #endif /* LOAD_AVE_TYPE */
398 #ifdef HAVE_MACH_MACH_H
399 #include <mach/mach.h>
406 #include <sys/sysmp.h>
412 #include <sys/time.h>
413 #include <sys/wait.h>
414 #include <sys/syscall.h>
417 #include <machine/cpu.h>
418 #include <inq_stats/statistics.h>
419 #include <inq_stats/sysstats.h>
420 #include <inq_stats/cpustats.h>
421 #include <inq_stats/procstats.h>
422 #else /* Not UMAX_43. */
423 #include <sys/sysdefs.h>
424 #include <sys/statistics.h>
425 #include <sys/sysstats.h>
426 #include <sys/cpudefs.h>
427 #include <sys/cpustats.h>
428 #include <sys/procstats.h>
429 #endif /* Not UMAX_43. */
433 #include <sys/dg_sys_info.h>
436 #if defined (HAVE_SYS_PSTAT_H)
437 #include <sys/pstat.h>
438 #endif /* HAVE_SYS_PSTAT_H (on HPUX) */
441 /* Avoid static vars inside a function since in HPUX they dump as pure. */
444 static processor_set_t default_set;
445 static int getloadavg_initialized;
449 static unsigned int cpus = 0;
450 static unsigned int samples;
454 static struct dg_sys_info_load_info load_info; /* what-a-mouthful! */
458 /* File descriptor open to /dev/kmem */
460 /* Nonzero iff channel is valid. */
461 static int getloadavg_initialized;
462 /* Offset in kmem to seek to read load average, or 0 means invalid. */
466 static struct nlist nl[2];
474 # define countof(x) (sizeof (x) / sizeof (*(x)))
477 #endif /* LOAD_AVE_TYPE */
479 /* Put the 1 minute, 5 minute and 15 minute load averages
480 into the first NELEM elements of LOADAVG.
481 Return the number written (never more than 3, but may be less than NELEM),
482 or -1 if an error occurred. */
484 int getloadavg (double loadavg[], int nelem);
487 getloadavg (double loadavg[], int nelem)
489 int elem = 0; /* Return value. */
491 #ifdef NO_GET_LOAD_AVG
493 /* Set errno to zero to indicate that there was no particular error;
494 this function just can't work at all on this system. */
497 #endif /* NO_GET_LOAD_AVG */
499 #if ! defined (LDAV_DONE) && defined (HAVE_KSTAT_H) && defined (HAVE_LIBKSTAT)
501 /* getloadavg is best implemented using kstat (kernel stats), on
502 systems (like SunOS5) that support it, since you don't need special
503 privileges to use it.
505 Initial implementation courtesy Zlatko Calusic <zcalusic@carnet.hr>.
506 Integrated to XEmacs by Hrvoje Niksic <hniksic@xemacs.org>.
507 Additional cleanup by Hrvoje Niksic, based on code published by
508 Casper Dik <Casper.Dik@Holland.Sun.Com>. */
511 static char *avestrings[] = { "avenrun_1min",
515 if (nelem > countof (avestrings))
516 nelem = countof (avestrings);
521 ksp = kstat_lookup (kc, "unix", 0, "system_misc");
527 if (kstat_read (kc, ksp, 0) < 0)
532 for (elem = 0; elem < nelem; elem++)
535 (kstat_named_t *) kstat_data_lookup (ksp, avestrings[elem]);
541 loadavg[elem] = (double)kn->value.ul / FSCALE;
544 #endif /* HAVE_KSTAT_H && HAVE_LIBKSTAT */
546 #if !defined (LDAV_DONE) && defined (HAVE_SYS_PSTAT_H)
548 /* This is totally undocumented, and is not guaranteed to work, but
549 mayhap it might .... If it does work, it will work only on HP-UX
550 8.0 or later. -- Darryl Okahata <darrylo@sr.hp.com> */
551 #undef LOAD_AVE_TYPE /* Make sure these don't exist. */
554 struct pst_dynamic procinfo;
557 statbuf.pst_dynamic = &procinfo;
558 if (pstat (PSTAT_DYNAMIC, statbuf, sizeof (struct pst_dynamic), 0, 0) == -1)
560 loadavg[elem++] = procinfo.psd_avg_1_min;
561 loadavg[elem++] = procinfo.psd_avg_5_min;
562 loadavg[elem++] = procinfo.psd_avg_15_min;
565 #if !defined (LDAV_DONE) && defined (__linux__)
569 #ifndef LINUX_LDAV_FILE
570 #define LINUX_LDAV_FILE "/proc/loadavg"
577 fd = open (LINUX_LDAV_FILE, O_RDONLY);
580 count = read (fd, ldavgbuf, 40);
585 count = sscanf (ldavgbuf, "%lf %lf %lf",
586 &load_ave[0], &load_ave[1], &load_ave[2]);
590 for (elem = 0; elem < nelem && elem < count; elem++)
591 loadavg[elem] = load_ave[elem];
592 #endif /* __linux__ */
594 #if !defined (LDAV_DONE) && defined (__NetBSD__) || defined (__OpenBSD__)
598 #ifndef NETBSD_LDAV_FILE
599 #define NETBSD_LDAV_FILE "/kern/loadavg"
602 unsigned long int load_ave[3], scale;
606 fp = fopen (NETBSD_LDAV_FILE, "r");
609 count = fscanf (fp, "%lu %lu %lu %lu\n",
610 &load_ave[0], &load_ave[1], &load_ave[2],
616 for (elem = 0; elem < nelem; elem++)
617 loadavg[elem] = (double) load_ave[elem] / (double) scale;
618 #endif /* __NetBSD__ or __OpenBSD__ */
620 #if !defined (LDAV_DONE) && defined (NeXT)
622 /* The NeXT code was adapted from iscreen 3.2. */
625 struct processor_set_basic_info info;
628 /* We only know how to get the 1-minute average for this system,
629 so even if the caller asks for more than 1, we only return 1. */
631 if (!getloadavg_initialized)
633 if (processor_set_default (host_self (), &default_set) == KERN_SUCCESS)
634 getloadavg_initialized = 1;
637 if (getloadavg_initialized)
639 info_count = PROCESSOR_SET_BASIC_INFO_COUNT;
640 if (processor_set_info (default_set, PROCESSOR_SET_BASIC_INFO, &host,
641 (processor_set_info_t) &info, &info_count)
643 getloadavg_initialized = 0;
647 loadavg[elem++] = (double) info.load_average / LOAD_SCALE;
651 if (!getloadavg_initialized)
655 #if !defined (LDAV_DONE) && defined (UMAX)
657 /* UMAX 4.2, which runs on the Encore Multimax multiprocessor, does not
658 have a /dev/kmem. Information about the workings of the running kernel
659 can be gathered with inq_stats system calls.
660 We only know how to get the 1-minute average for this system. */
662 struct proc_summary proc_sum_data;
663 struct stat_descr proc_info;
665 REGISTER unsigned int i, j;
669 REGISTER unsigned int c, i;
670 struct cpu_config conf;
671 struct stat_descr desc;
674 desc.sd_subsys = SUBSYS_CPU;
675 desc.sd_type = CPUTYPE_CONFIG;
676 desc.sd_addr = (char *) &conf;
677 desc.sd_size = sizeof conf;
679 if (inq_stats (1, &desc))
683 for (i = 0; i < conf.config_maxclass; ++i)
685 struct class_stats stats;
686 memset ((char *) &stats, 0, sizeof stats);
688 desc.sd_type = CPUTYPE_CLASS;
690 desc.sd_addr = (char *) &stats;
691 desc.sd_size = sizeof stats;
693 if (inq_stats (1, &desc))
696 c += stats.class_numcpus;
699 samples = cpus < 2 ? 3 : (2 * cpus / 3);
702 proc_info.sd_next = 0;
703 proc_info.sd_subsys = SUBSYS_PROC;
704 proc_info.sd_type = PROCTYPE_SUMMARY;
705 proc_info.sd_addr = (char *) &proc_sum_data;
706 proc_info.sd_size = sizeof (struct proc_summary);
707 proc_info.sd_sizeused = 0;
709 if (inq_stats (1, &proc_info) != 0)
712 load = proc_sum_data.ps_nrunnable;
714 for (i = samples - 1; i > 0; --i)
716 load += proc_sum_data.ps_nrun[j];
717 if (j++ == PS_NRUNSIZE)
722 loadavg[elem++] = load / samples / cpus;
725 #if !defined (LDAV_DONE) && defined (DGUX)
727 /* This call can return -1 for an error, but with good args
728 it's not supposed to fail. The first argument is for no
729 apparent reason of type `long int *'. */
730 dg_sys_info ((long int *) &load_info,
731 DG_SYS_INFO_LOAD_INFO_TYPE,
732 DG_SYS_INFO_LOAD_VERSION_0);
735 loadavg[elem++] = load_info.one_minute;
737 loadavg[elem++] = load_info.five_minute;
739 loadavg[elem++] = load_info.fifteen_minute;
742 #if !defined (LDAV_DONE) && defined (OSF_MIPS)
745 struct tbl_loadavg load_ave;
746 table (TBL_LOADAVG, 0, &load_ave, 1, sizeof (load_ave));
748 = (load_ave.tl_lscale == 0
749 ? load_ave.tl_avenrun.d[0]
750 : (load_ave.tl_avenrun.l[0] / (double) load_ave.tl_lscale));
751 #endif /* OSF_MIPS */
753 #if !defined (LDAV_DONE) && (defined (WIN32_NATIVE) || defined (CYGWIN))
756 /* A faithful emulation is going to have to be saved for a rainy day. */
757 for ( ; elem < nelem; elem++)
761 #endif /* WIN32_NATIVE or CYGWIN */
763 #if !defined (LDAV_DONE) && defined (OSF_ALPHA)
766 struct tbl_loadavg load_ave;
767 table (TBL_LOADAVG, 0, &load_ave, 1, sizeof (load_ave));
768 for (elem = 0; elem < nelem; elem++)
770 = (load_ave.tl_lscale == 0
771 ? load_ave.tl_avenrun.d[elem]
772 : (load_ave.tl_avenrun.l[elem] / (double) load_ave.tl_lscale));
773 #endif /* OSF_ALPHA */
775 #if !defined (LDAV_DONE) && defined(LOAD_AVE_TYPE)
777 /* UNIX-specific code -- read the average from /dev/kmem. */
779 #define LDAV_PRIVILEGED /* This code requires special installation. */
781 LOAD_AVE_TYPE load_ave[3];
783 /* Get the address of LDAV_SYMBOL. */
788 strcpy (nl[0].n_name, LDAV_SYMBOL);
789 strcpy (nl[1].n_name, "");
790 #else /* NLIST_STRUCT */
791 #ifdef NLIST_NAME_UNION
792 nl[0].n_un.n_name = LDAV_SYMBOL;
793 nl[1].n_un.n_name = 0;
794 #else /* not NLIST_NAME_UNION */
795 nl[0].n_name = (char *) LDAV_SYMBOL;
797 #endif /* not NLIST_NAME_UNION */
798 #endif /* NLIST_STRUCT */
802 #if !(defined (_AIX) && !defined (ps2))
803 nlist (KERNEL_FILE, nl)
805 knlist (nl, 1, sizeof (nl[0]))
808 /* Omit "&& nl[0].n_type != 0 " -- it breaks on Sun386i. */
810 #ifdef FIXUP_KERNEL_SYMBOL_ADDR
811 FIXUP_KERNEL_SYMBOL_ADDR (nl);
813 offset = nl[0].n_value;
815 #endif /* !SUNOS_5 */
819 ldav_off = sysmp (MP_KERNADDR, MPKA_AVENRUN);
821 offset = (long) ldav_off & 0x7fffffff;
825 /* Make sure we have /dev/kmem open. */
826 if (!getloadavg_initialized)
829 channel = open ("/dev/kmem", 0);
832 /* Set the channel to close on exec, so it does not
833 litter any child's descriptor table. */
838 (void) fcntl (channel, F_SETFD, FD_CLOEXEC);
840 getloadavg_initialized = 1;
843 /* We pass 0 for the kernel, corefile, and swapfile names
844 to use the currently running kernel. */
845 kd = kvm_open (0, 0, 0, O_RDONLY, 0);
848 /* nlist the currently running kernel. */
850 offset = nl[0].n_value;
851 getloadavg_initialized = 1;
856 /* If we can, get the load average values. */
857 if (offset && getloadavg_initialized)
859 /* Try to read the load. */
861 if (lseek (channel, offset, 0) == -1L
862 || read (channel, (char *) load_ave, sizeof (load_ave))
863 != sizeof (load_ave))
866 getloadavg_initialized = 0;
869 if (kvm_read (kd, offset, (char *) load_ave, sizeof (load_ave))
870 != sizeof (load_ave))
873 getloadavg_initialized = 0;
878 if (offset == 0 || !getloadavg_initialized)
882 loadavg[elem++] = LDAV_CVT (load_ave[0]);
884 loadavg[elem++] = LDAV_CVT (load_ave[1]);
886 loadavg[elem++] = LDAV_CVT (load_ave[2]);
889 #endif /* !LDAV_DONE && LOAD_AVE_TYPE */
894 #endif /* ! HAVE_GETLOADAVG */
898 main (int argc, char **argv)
903 naptime = atoi (argv[1]);
910 errno = 0; /* Don't be misled if it doesn't set errno. */
911 loads = getloadavg (avg, 3);
914 perror ("Error getting load average");
918 printf ("1-minute: %f ", avg[0]);
920 printf ("5-minute: %f ", avg[1]);
922 printf ("15-minute: %f ", avg[2]);