getloadavg(3) [opendarwin man page]

GETLOADAVG(3)						     Linux Programmer's Manual						     GETLOADAVG(3)

NAME

       getloadavg - get system load averages

SYNOPSIS

       #include <stdlib.h>

       int getloadavg(double loadavg[], int nelem);

   Feature Test Macro Requirements for glibc (see feature_test_macros(7)):

       getloadavg():
	   Since glibc 2.19:
	       _DEFAULT_SOURCE
	   In glibc up to and including 2.19:
	       _BSD_SOURCE

DESCRIPTION

       The  getloadavg() function returns the number of processes in the system run queue averaged over various periods of time.  Up to nelem sam-
       ples are retrieved and assigned to successive elements of loadavg[].  The system imposes a maximum of 3 samples, representing averages over
       the last 1, 5, and 15 minutes, respectively.

RETURN VALUE

       If the load average was unobtainable, -1 is returned; otherwise, the number of samples actually retrieved is returned.

VERSIONS

       This function is available in glibc since version 2.2.

ATTRIBUTES

       For an explanation of the terms used in this section, see attributes(7).

       +-------------+---------------+---------+
       |Interface    | Attribute     | Value   |
       +-------------+---------------+---------+
       |getloadavg() | Thread safety | MT-Safe |
       +-------------+---------------+---------+
CONFORMING TO

       Not in POSIX.1.	Present on the BSDs and Solaris.

SEE ALSO

       uptime(1), proc(5)

COLOPHON

       This  page is part of release 4.15 of the Linux man-pages project.  A description of the project, information about reporting bugs, and the
       latest version of this page, can be found at https://www.kernel.org/doc/man-pages/.

Linux								    2016-03-15							     GETLOADAVG(3)

getloadavg(3C)						   Standard C Library Functions 					    getloadavg(3C)

NAME

       getloadavg - get system load averages

SYNOPSIS

       #include <sys/loadavg.h>

       int getloadavg(double loadavg[], int nelem);

DESCRIPTION

       The  getloadavg()  function returns the number of processes in the system run queue averaged over various periods of time. Up to nelem sam-
       ples are retrieved and assigned to successive elements of loadavg[]. The system imposes a maximum of 3 samples, representing averages  over
       the  last 1, 5, and 15 minutes, respectively. The LOADAVG_1MIN, LOADAVG_5MIN, and LOADAVG_15MIN indices, defined in <sys/loadavg.h>, can be
       used to extract the data from the appropriate element of the loadavg[] array.

RETURN VALUES

       Upon successful completion, the number of samples actually retrieved is returned. If the load average was unobtainable, -1 is returned  and
       errno is set to indicate the error.

ERRORS

       The getloadavg() function will fail if:

       EINVAL	 The number of elements specified is less than 0.

USAGE

       If the caller is in a non-global zone and the pools facility is active, the behavior of getloadavg() is equivalent to that of pset_getload-
       avg(3C) called with psetid set to PS_MYID.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Async-Signal-Safe 	   |
       +-----------------------------+-----------------------------+

SEE ALSO

       uptime(1), w(1), pooladm(1M), Kstat(3PERL), pset_getloadavg(3C), standards(5)

SunOS 5.11							    28 Jun 2004 						    getloadavg(3C)