man7.org > Linux > man-pages

Linux/UNIX system programming training

getloadavg(3) — Linux manual page

NAME | LIBRARY | SYNOPSIS | DESCRIPTION | RETURN VALUE | ATTRIBUTES | STANDARDS | HISTORY | SEE ALSO | COLOPHON 

getloadavg(3)           Library Functions Manual           getloadavg(3)

NAME         top

       getloadavg - get system load averages

LIBRARY         top

       Standard C library (libc, -lc)

SYNOPSIS         top

       #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         top

       The getloadavg() function returns the number of processes in the
       system run queue averaged over various periods of time.  Up to
       nelem samples 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         top

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

ATTRIBUTES         top

       For an explanation of the terms used in this section, see
       attributes(7).
       ┌─────────────────────────────────────┬───────────────┬─────────┐
       │ Interface                           │ Attribute     │ Value   │
       ├─────────────────────────────────────┼───────────────┼─────────┤
       │ getloadavg()                        │ Thread safety │ MT-Safe │
       └─────────────────────────────────────┴───────────────┴─────────┘

STANDARDS         top

       BSD.

HISTORY         top

       4.3BSD-Reno, Solaris.  glibc 2.2.

SEE ALSO         top

       uptime(1), proc(5)

COLOPHON         top

       This page is part of the man-pages (Linux kernel and C library
       user-space interface documentation) project.  Information about
       the project can be found at 
       ⟨https://www.kernel.org/doc/man-pages/⟩.  If you have a bug report
       for this manual page, see
       ⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
       This page was obtained from the tarball man-pages-6.9.1.tar.gz
       fetched from
       ⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
       2024-06-26.  If you discover any rendering problems in this HTML
       version of the page, or you believe there is a better or more up-
       to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not
       part of the original manual page), send a mail to
       man-pages@man7.org

Linux man-pages 6.9.1          2024-05-02                  getloadavg(3)

HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface.

For details of in-depth Linux/UNIX system programming training courses that I teach, look here.

Hosting by jambit GmbH.

Cover of TLPI