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.
47 MSDOS No-op for MSDOS.
50 sequent Sequent Dynix 3.x.x (BSD)
51 _SEQUENT_ Sequent DYNIX/ptx 1.x.x (SYSV)
52 sony_news NEWS-OS (works at least for 4.1C)
55 WIN32 No-op for Windows95/NT.
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. */
75 #include <sys/types.h>
77 /* Both the Emacs and non-Emacs sections want this. Some
78 configuration files' definitions for the LOAD_AVE_CVT macro (like
79 sparc.h's) use macros like FSCALE, defined here. */
81 #include <sys/param.h>
86 #include "sysfile.h" /* for encapsulated open, close, read, write */
89 /* Exclude all the code except the test program at the end
90 if the system has its own `getloadavg' function.
92 The declaration of `errno' is needed by the test program
93 as well as the function itself, so it comes first. */
97 #ifndef HAVE_GETLOADAVG
99 /* The existing Emacs configuration files define a macro called
100 LOAD_AVE_CVT, which accepts a value of type LOAD_AVE_TYPE, and
101 returns the load average multiplied by 100. What we actually want
102 is a macro called LDAV_CVT, which returns the load average as an
105 For backwards compatibility, we'll define LDAV_CVT in terms of
106 LOAD_AVE_CVT, but future machine config files should just define
107 LDAV_CVT directly. */
109 #if !defined(LDAV_CVT) && defined(LOAD_AVE_CVT)
110 #define LDAV_CVT(n) (LOAD_AVE_CVT (n) / 100.0)
114 #if defined (HAVE_KSTAT_H)
116 #endif /* HAVE_KSTAT_H */
119 #if !defined (BSD) && defined (ultrix)
120 /* Ultrix behaves like BSD on Vaxen. */
125 /* NeXT in the 2.{0,1,2} releases defines BSD in <sys/param.h>, which
126 conflicts with the definition understood in this file, that this
130 /* NeXT defines FSCALE in <sys/param.h>. However, we take FSCALE being
131 defined to mean that the nlist method should be used, which is not true. */
135 /* Set values that are different from the defaults, which are
136 set a little farther down with #ifndef. */
139 /* Some shorthands. */
141 #if defined (HPUX) && !defined (hpux)
145 #if defined(hp300) && !defined(hpux)
149 #if defined(ultrix) && defined(mips)
153 #if (defined(sun) && defined(SVR4)) || defined (SOLARIS2)
157 #if defined (__osf__) && (defined (__alpha) || defined (__alpha__))
160 #include <netinet/in.h> /* Needed for Digital UNIX V3 */
161 #include <net/proto_net.h>
162 #include <sys/table.h>
165 #if defined (__osf__) && (defined (mips) || defined (__mips__))
167 #include <sys/table.h>
170 /* UTek's /bin/cc on the 4300 has no architecture specific cpp define by
171 default, but _MACH_IND_SYS_TYPES is defined in <sys/types.h>. Combine
172 that with a couple of other things and we'll have a unique match. */
173 #if !defined (tek4300) && defined (unix) && defined (m68k) && defined (mc68000) && defined (mc68020) && defined (_MACH_IND_SYS_TYPES)
174 #define tek4300 /* Define by emacs, but not by other users. */
178 /* VAX C can't handle multi-line #ifs, or lines longer than 256 chars. */
179 #ifndef LOAD_AVE_TYPE
182 #define LOAD_AVE_TYPE long
186 #define LOAD_AVE_TYPE long
190 #define LOAD_AVE_TYPE long
194 #define LOAD_AVE_TYPE long
198 #define LOAD_AVE_TYPE long
202 #define LOAD_AVE_TYPE long
206 #define LOAD_AVE_TYPE long
210 #define LOAD_AVE_TYPE long
214 #define LOAD_AVE_TYPE long
217 #if defined (ardent) && defined (titan)
218 #define LOAD_AVE_TYPE long
222 #define LOAD_AVE_TYPE long
225 #if defined(alliant) && defined(i860) /* Alliant FX/2800 */
226 #define LOAD_AVE_TYPE long
230 #define LOAD_AVE_TYPE long
234 #define LOAD_AVE_TYPE double
236 #define LDAV_CVT(n) (n)
240 #endif /* No LOAD_AVE_TYPE. */
243 /* <sys/param.h> defines an incorrect value for FSCALE on Alpha OSF/1,
244 according to ghazi@noc.rutgers.edu. */
246 #define FSCALE 1024.0
249 #if defined(alliant) && defined(i860) /* Alliant FX/2800 */
250 /* <sys/param.h> defines an incorrect value for FSCALE on an
251 Alliant FX/2800 Concentrix 2.2, according to ghazi@noc.rutgers.edu. */
259 /* SunOS and some others define FSCALE in sys/param.h. */
262 #define FSCALE 2048.0
265 #if defined(MIPS) || defined(SVR4) || defined(decstation)
269 #if defined (sgi) || defined (sequent)
270 /* Sometimes both MIPS and sgi are defined, so FSCALE was just defined
271 above under #ifdef MIPS. But we want the sgi value. */
273 #define FSCALE 1000.0
276 #if defined (ardent) && defined (titan)
277 #define FSCALE 65536.0
285 #define FSCALE 65536.0
288 #endif /* Not FSCALE. */
290 #if !defined (LDAV_CVT) && defined (FSCALE)
291 #define LDAV_CVT(n) (((double) (n)) / FSCALE)
294 /* VAX C can't handle multi-line #ifs, or lines longer that 256 characters. */
313 #if defined (_SEQUENT_) || defined (sequent)
333 #if defined (ardent) && defined (titan)
345 #if defined(alliant) && defined(i860) /* Alliant FX/2800 */
353 #endif /* defined (NLIST_STRUCT) */
356 #if defined(sgi) || (defined(mips) && !defined(BSD))
357 #define FIXUP_KERNEL_SYMBOL_ADDR(nl) ((nl)[0].n_value &= ~(1 << 31))
361 #if !defined (KERNEL_FILE) && defined (sequent)
362 #define KERNEL_FILE "/dynix"
365 #if !defined (KERNEL_FILE) && defined (hpux)
366 #define KERNEL_FILE "/hp-ux"
369 #if !defined(KERNEL_FILE) && (defined(_SEQUENT_) || defined(MIPS) || defined(SVR4) || defined(ISC) || defined (sgi) || defined(SVR4) || (defined (ardent) && defined (titan)))
370 #define KERNEL_FILE "/unix"
374 #if !defined (LDAV_SYMBOL) && defined (alliant)
375 #define LDAV_SYMBOL "_Loadavg"
378 #if !defined(LDAV_SYMBOL) && ((defined(hpux) && !defined(hp9000s300)) || defined(_SEQUENT_) || defined(SVR4) || defined(ISC) || defined(sgi) || (defined (ardent) && defined (titan)) || defined (_AIX))
379 #define LDAV_SYMBOL "avenrun"
388 /* LOAD_AVE_TYPE should only get defined if we're going to use the
390 #if !defined(LOAD_AVE_TYPE) && (defined(BSD) || defined(LDAV_CVT) || defined(KERNEL_FILE) || defined(LDAV_SYMBOL))
391 #define LOAD_AVE_TYPE double
398 #else /* NLIST_STRUCT */
400 #endif /* NLIST_STRUCT */
408 #define KERNEL_FILE "/vmunix"
409 #endif /* KERNEL_FILE */
412 #define LDAV_SYMBOL "_avenrun"
413 #endif /* LDAV_SYMBOL */
416 #define LDAV_CVT(n) ((double) (n))
417 #endif /* !LDAV_CVT */
419 #endif /* LOAD_AVE_TYPE */
422 #ifdef HAVE_MACH_MACH_H
423 #include <mach/mach.h>
430 #include <sys/sysmp.h>
436 #include <sys/time.h>
437 #include <sys/wait.h>
438 #include <sys/syscall.h>
441 #include <machine/cpu.h>
442 #include <inq_stats/statistics.h>
443 #include <inq_stats/sysstats.h>
444 #include <inq_stats/cpustats.h>
445 #include <inq_stats/procstats.h>
446 #else /* Not UMAX_43. */
447 #include <sys/sysdefs.h>
448 #include <sys/statistics.h>
449 #include <sys/sysstats.h>
450 #include <sys/cpudefs.h>
451 #include <sys/cpustats.h>
452 #include <sys/procstats.h>
453 #endif /* Not UMAX_43. */
457 #include <sys/dg_sys_info.h>
461 #if defined (HAVE_SYS_PSTAT_H)
462 #include <sys/pstat.h>
463 #endif /* HAVE_SYS_PSTAT_H (on HPUX) */
466 #if defined(HAVE_FCNTL_H) || defined(_POSIX_VERSION)
469 #include <sys/file.h>
472 /* Avoid static vars inside a function since in HPUX they dump as pure. */
475 static processor_set_t default_set;
476 static int getloadavg_initialized;
480 static unsigned int cpus = 0;
481 static unsigned int samples;
485 static struct dg_sys_info_load_info load_info; /* what-a-mouthful! */
489 /* File descriptor open to /dev/kmem */
491 /* Nonzero iff channel is valid. */
492 static int getloadavg_initialized;
493 /* Offset in kmem to seek to read load average, or 0 means invalid. */
497 static struct nlist nl[2];
505 # define countof(x) (sizeof (x) / sizeof (*(x)))
508 #endif /* LOAD_AVE_TYPE */
510 /* Put the 1 minute, 5 minute and 15 minute load averages
511 into the first NELEM elements of LOADAVG.
512 Return the number written (never more than 3, but may be less than NELEM),
513 or -1 if an error occurred. */
516 getloadavg (double loadavg[], int nelem)
518 int elem = 0; /* Return value. */
520 #ifdef NO_GET_LOAD_AVG
522 /* Set errno to zero to indicate that there was no particular error;
523 this function just can't work at all on this system. */
526 #endif /* NO_GET_LOAD_AVG */
528 #if ! defined (LDAV_DONE) && defined (HAVE_KSTAT_H) && defined (HAVE_LIBKSTAT)
530 /* getloadavg is best implemented using kstat (kernel stats), on
531 systems (like SunOS5) that support it, since you don't need special
532 privileges to use it.
534 Initial implementation courtesy Zlatko Calusic <zcalusic@carnet.hr>.
535 Integrated to XEmacs by Hrvoje Niksic <hniksic@xemacs.org>.
536 Additional cleanup by Hrvoje Niksic, based on code published by
537 Casper Dik <Casper.Dik@Holland.Sun.Com>. */
540 static char *avestrings[] = { "avenrun_1min",
544 if (nelem > countof (avestrings))
545 nelem = countof (avestrings);
550 ksp = kstat_lookup (kc, "unix", 0, "system_misc");
556 if (kstat_read (kc, ksp, 0) < 0)
561 for (elem = 0; elem < nelem; elem++)
564 (kstat_named_t *) kstat_data_lookup (ksp, avestrings[elem]);
570 loadavg[elem] = (double)kn->value.ul / FSCALE;
573 #endif /* HAVE_KSTAT_H && HAVE_LIBKSTAT */
575 #if !defined (LDAV_DONE) && defined (HAVE_SYS_PSTAT_H)
577 /* This is totally undocumented, and is not guaranteed to work, but
578 mayhap it might .... If it does work, it will work only on HP-UX
579 8.0 or later. -- Darryl Okahata <darrylo@sr.hp.com> */
580 #undef LOAD_AVE_TYPE /* Make sure these don't exist. */
583 struct pst_dynamic procinfo;
586 statbuf.pst_dynamic = &procinfo;
587 if (pstat (PSTAT_DYNAMIC, statbuf, sizeof (struct pst_dynamic), 0, 0) == -1)
589 loadavg[elem++] = procinfo.psd_avg_1_min;
590 loadavg[elem++] = procinfo.psd_avg_5_min;
591 loadavg[elem++] = procinfo.psd_avg_15_min;
594 #if !defined (LDAV_DONE) && defined (__linux__)
598 #ifndef LINUX_LDAV_FILE
599 #define LINUX_LDAV_FILE "/proc/loadavg"
606 fd = open (LINUX_LDAV_FILE, O_RDONLY);
609 count = read (fd, ldavgbuf, 40);
614 count = sscanf (ldavgbuf, "%lf %lf %lf",
615 &load_ave[0], &load_ave[1], &load_ave[2]);
619 for (elem = 0; elem < nelem && elem < count; elem++)
620 loadavg[elem] = load_ave[elem];
621 #endif /* __linux__ */
623 #if !defined (LDAV_DONE) && defined (__NetBSD__) || defined (__OpenBSD__)
627 #ifndef NETBSD_LDAV_FILE
628 #define NETBSD_LDAV_FILE "/kern/loadavg"
631 unsigned long int load_ave[3], scale;
635 fp = fopen (NETBSD_LDAV_FILE, "r");
638 count = fscanf (fp, "%lu %lu %lu %lu\n",
639 &load_ave[0], &load_ave[1], &load_ave[2],
645 for (elem = 0; elem < nelem; elem++)
646 loadavg[elem] = (double) load_ave[elem] / (double) scale;
647 #endif /* __NetBSD__ or __OpenBSD__ */
649 #if !defined (LDAV_DONE) && defined (NeXT)
651 /* The NeXT code was adapted from iscreen 3.2. */
654 struct processor_set_basic_info info;
657 /* We only know how to get the 1-minute average for this system,
658 so even if the caller asks for more than 1, we only return 1. */
660 if (!getloadavg_initialized)
662 if (processor_set_default (host_self (), &default_set) == KERN_SUCCESS)
663 getloadavg_initialized = 1;
666 if (getloadavg_initialized)
668 info_count = PROCESSOR_SET_BASIC_INFO_COUNT;
669 if (processor_set_info (default_set, PROCESSOR_SET_BASIC_INFO, &host,
670 (processor_set_info_t) &info, &info_count)
672 getloadavg_initialized = 0;
676 loadavg[elem++] = (double) info.load_average / LOAD_SCALE;
680 if (!getloadavg_initialized)
684 #if !defined (LDAV_DONE) && defined (UMAX)
686 /* UMAX 4.2, which runs on the Encore Multimax multiprocessor, does not
687 have a /dev/kmem. Information about the workings of the running kernel
688 can be gathered with inq_stats system calls.
689 We only know how to get the 1-minute average for this system. */
691 struct proc_summary proc_sum_data;
692 struct stat_descr proc_info;
694 REGISTER unsigned int i, j;
698 REGISTER unsigned int c, i;
699 struct cpu_config conf;
700 struct stat_descr desc;
703 desc.sd_subsys = SUBSYS_CPU;
704 desc.sd_type = CPUTYPE_CONFIG;
705 desc.sd_addr = (char *) &conf;
706 desc.sd_size = sizeof conf;
708 if (inq_stats (1, &desc))
712 for (i = 0; i < conf.config_maxclass; ++i)
714 struct class_stats stats;
715 memset ((char *) &stats, 0, sizeof stats);
717 desc.sd_type = CPUTYPE_CLASS;
719 desc.sd_addr = (char *) &stats;
720 desc.sd_size = sizeof stats;
722 if (inq_stats (1, &desc))
725 c += stats.class_numcpus;
728 samples = cpus < 2 ? 3 : (2 * cpus / 3);
731 proc_info.sd_next = 0;
732 proc_info.sd_subsys = SUBSYS_PROC;
733 proc_info.sd_type = PROCTYPE_SUMMARY;
734 proc_info.sd_addr = (char *) &proc_sum_data;
735 proc_info.sd_size = sizeof (struct proc_summary);
736 proc_info.sd_sizeused = 0;
738 if (inq_stats (1, &proc_info) != 0)
741 load = proc_sum_data.ps_nrunnable;
743 for (i = samples - 1; i > 0; --i)
745 load += proc_sum_data.ps_nrun[j];
746 if (j++ == PS_NRUNSIZE)
751 loadavg[elem++] = load / samples / cpus;
754 #if !defined (LDAV_DONE) && defined (DGUX)
756 /* This call can return -1 for an error, but with good args
757 it's not supposed to fail. The first argument is for no
758 apparent reason of type `long int *'. */
759 dg_sys_info ((long int *) &load_info,
760 DG_SYS_INFO_LOAD_INFO_TYPE,
761 DG_SYS_INFO_LOAD_VERSION_0);
764 loadavg[elem++] = load_info.one_minute;
766 loadavg[elem++] = load_info.five_minute;
768 loadavg[elem++] = load_info.fifteen_minute;
771 #if !defined (LDAV_DONE) && defined (OSF_MIPS)
774 struct tbl_loadavg load_ave;
775 table (TBL_LOADAVG, 0, &load_ave, 1, sizeof (load_ave));
777 = (load_ave.tl_lscale == 0
778 ? load_ave.tl_avenrun.d[0]
779 : (load_ave.tl_avenrun.l[0] / (double) load_ave.tl_lscale));
780 #endif /* OSF_MIPS */
782 #if !defined (LDAV_DONE) && (defined (MSDOS) || defined (WIN32))
785 /* A faithful emulation is going to have to be saved for a rainy day. */
786 for ( ; elem < nelem; elem++)
792 #if !defined (LDAV_DONE) && defined (OSF_ALPHA)
795 struct tbl_loadavg load_ave;
796 table (TBL_LOADAVG, 0, &load_ave, 1, sizeof (load_ave));
797 for (elem = 0; elem < nelem; elem++)
799 = (load_ave.tl_lscale == 0
800 ? load_ave.tl_avenrun.d[elem]
801 : (load_ave.tl_avenrun.l[elem] / (double) load_ave.tl_lscale));
802 #endif /* OSF_ALPHA */
804 #if !defined (LDAV_DONE) && defined(LOAD_AVE_TYPE)
806 /* UNIX-specific code -- read the average from /dev/kmem. */
808 #define LDAV_PRIVILEGED /* This code requires special installation. */
810 LOAD_AVE_TYPE load_ave[3];
812 /* Get the address of LDAV_SYMBOL. */
817 strcpy (nl[0].n_name, LDAV_SYMBOL);
818 strcpy (nl[1].n_name, "");
819 #else /* NLIST_STRUCT */
820 #ifdef NLIST_NAME_UNION
821 nl[0].n_un.n_name = LDAV_SYMBOL;
822 nl[1].n_un.n_name = 0;
823 #else /* not NLIST_NAME_UNION */
824 nl[0].n_name = (char *) LDAV_SYMBOL;
826 #endif /* not NLIST_NAME_UNION */
827 #endif /* NLIST_STRUCT */
831 #if !(defined (_AIX) && !defined (ps2))
832 nlist (KERNEL_FILE, nl)
834 knlist (nl, 1, sizeof (nl[0]))
837 /* Omit "&& nl[0].n_type != 0 " -- it breaks on Sun386i. */
839 #ifdef FIXUP_KERNEL_SYMBOL_ADDR
840 FIXUP_KERNEL_SYMBOL_ADDR (nl);
842 offset = nl[0].n_value;
844 #endif /* !SUNOS_5 */
848 ldav_off = sysmp (MP_KERNADDR, MPKA_AVENRUN);
850 offset = (long) ldav_off & 0x7fffffff;
854 /* Make sure we have /dev/kmem open. */
855 if (!getloadavg_initialized)
858 channel = open ("/dev/kmem", 0);
861 /* Set the channel to close on exec, so it does not
862 litter any child's descriptor table. */
867 (void) fcntl (channel, F_SETFD, FD_CLOEXEC);
869 getloadavg_initialized = 1;
872 /* We pass 0 for the kernel, corefile, and swapfile names
873 to use the currently running kernel. */
874 kd = kvm_open (0, 0, 0, O_RDONLY, 0);
877 /* nlist the currently running kernel. */
879 offset = nl[0].n_value;
880 getloadavg_initialized = 1;
885 /* If we can, get the load average values. */
886 if (offset && getloadavg_initialized)
888 /* Try to read the load. */
890 if (lseek (channel, offset, 0) == -1L
891 || read (channel, (char *) load_ave, sizeof (load_ave))
892 != sizeof (load_ave))
895 getloadavg_initialized = 0;
898 if (kvm_read (kd, offset, (char *) load_ave, sizeof (load_ave))
899 != sizeof (load_ave))
902 getloadavg_initialized = 0;
907 if (offset == 0 || !getloadavg_initialized)
911 loadavg[elem++] = LDAV_CVT (load_ave[0]);
913 loadavg[elem++] = LDAV_CVT (load_ave[1]);
915 loadavg[elem++] = LDAV_CVT (load_ave[2]);
918 #endif /* !LDAV_DONE && LOAD_AVE_TYPE */
923 #endif /* ! HAVE_GETLOADAVG */
927 main (int argc, char **argv)
932 naptime = atoi (argv[1]);
939 errno = 0; /* Don't be misled if it doesn't set errno. */
940 loads = getloadavg (avg, 3);
943 perror ("Error getting load average");
947 printf ("1-minute: %f ", avg[0]);
949 printf ("5-minute: %f ", avg[1]);
951 printf ("15-minute: %f ", avg[2]);
966 /* Emulate getloadavg. */
968 getloadavg (double loadavg[], int nelem)
972 /* A faithful emulation is going to have to be saved for a rainy day. */
973 for (i = 0; i < nelem; i++)
980 #endif /*__GNUWIN32__*/
981 #endif /* WINDOWSNT */