original/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 2014-04-01 "Linux" "Linux Programmer's Manual"
  35 .SH NAME
  36 getloadavg \- get system load averages
  37 .SH SYNOPSIS
  38 .nf
  39 .BR "#define _BSD_SOURCE" "         /* See feature_test_macros(7) */"
  40 .B #include <stdlib.h>
  41 .sp
  42 .BI "int getloadavg(double " loadavg[] ", int " nelem );
  43 .fi
  44 .SH DESCRIPTION
  45 The
  46 .BR getloadavg ()
  47 function returns the number of processes in the system run queue
  48 averaged over various periods of time.
  49 Up to
  50 .I nelem
  51 samples are retrieved and assigned to successive elements of
  52 .IR loadavg [].
  53 The system imposes a maximum of 3 samples, representing averages
  54 over the last 1, 5, and 15 minutes, respectively.
  55 .SH RETURN VALUE
  56 If the load average was unobtainable, \-1 is returned; otherwise,
  57 the number of samples actually retrieved is returned.
  58 .\" .SH HISTORY
  59 .\" The
  60 .\" BR getloadavg ()
  61 .\" function appeared in
  62 .\" 4.3BSD Reno .
  63 .SH VERSIONS
  64 This function is available in glibc since version 2.2.
  65 .SH ATTRIBUTES
  66 .SS Multithreading (see pthreads(7))
  67 The
  68 .BR getloadavg ()
  69 function is thread-safe.
  70 .SH CONFORMING TO
  71 Not in POSIX.1-2001.
  72 Present on the BSDs and Solaris.
  73 .\" mdoc seems to have a bug - there must be no newline here
  74 .SH SEE ALSO
  75 .BR uptime (1),
  76 .BR proc (5)
  77 .SH COLOPHON
  78 This page is part of release 3.79 of the Linux
  79 .I man-pages
  80 project.
  81 A description of the project,
  82 information about reporting bugs,
  83 and the latest version of this page,
  84 can be found at
  85 \%http://www.kernel.org/doc/man\-pages/.