man3/getloadavg.3

   1 .\" Copyright (c) 1989, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" %%%LICENSE_START(BSD_3_CLAUSE_UCB)
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. Neither the name of the University nor the names of its contributors
  14 .\"    may be used to endorse or promote products derived from this software
  15 .\"    without specific prior written permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27 .\" SUCH DAMAGE.
  28 .\" %%%LICENSE_END
  29 .\"
  30 .\"     @(#)getloadavg.3        8.1 (Berkeley) 6/4/93
  31 .\"
  32 .\" 2007-12-08, mtk, Converted from mdoc to man macros
  33 .\"
  34 .TH GETLOADAVG 3 2021-03-22 "Linux" "Linux Programmer's Manual"
  35 .SH NAME
  36 getloadavg \- get system load averages
  37 .SH SYNOPSIS
  38 .nf
  39 .B #include <stdlib.h>
  40 .PP
  41 .BI "int getloadavg(double " loadavg[] ", int " nelem );
  42 .fi
  43 .PP
  44 .RS -4
  45 Feature Test Macro Requirements for glibc (see
  46 .BR feature_test_macros (7)):
  47 .RE
  48 .PP
  49 .BR getloadavg ():
  50 .nf
  51     Since glibc 2.19:
  52         _DEFAULT_SOURCE
  53     In glibc up to and including 2.19:
  54         _BSD_SOURCE
  55 .fi
  56 .SH DESCRIPTION
  57 The
  58 .BR getloadavg ()
  59 function returns the number of processes in the system run queue
  60 averaged over various periods of time.
  61 Up to
  62 .I nelem
  63 samples are retrieved and assigned to successive elements of
  64 .IR loadavg[] .
  65 The system imposes a maximum of 3 samples, representing averages
  66 over the last 1, 5, and 15 minutes, respectively.
  67 .SH RETURN VALUE
  68 If the load average was unobtainable, \-1 is returned; otherwise,
  69 the number of samples actually retrieved is returned.
  70 .\" .SH HISTORY
  71 .\" The
  72 .\" BR getloadavg ()
  73 .\" function appeared in
  74 .\" 4.3BSD Reno .
  75 .SH VERSIONS
  76 This function is available in glibc since version 2.2.
  77 .SH ATTRIBUTES
  78 For an explanation of the terms used in this section, see
  79 .BR attributes (7).
  80 .ad l
  81 .nh
  82 .TS
  83 allbox;
  84 lbx lb lb
  85 l l l.
  86 Interface       Attribute       Value
  87 T{
  88 .BR getloadavg ()
  89 T}      Thread safety   MT-Safe
  90 .TE
  91 .hy
  92 .ad
  93 .sp 1
  94 .SH CONFORMING TO
  95 Not in POSIX.1.
  96 Present on the BSDs and Solaris.
  97 .\" mdoc seems to have a bug - there must be no newline here
  98 .SH SEE ALSO
  99 .BR uptime (1),
 100 .BR proc (5)