2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright (c) 1989, 1991, 1993
|
|
|
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
|
.\" 3. Neither the name of the University nor the names of its contributors
|
|
|
|
|
.\" may be used to endorse or promote products derived from this software
|
|
|
|
|
.\" without specific prior written permission.
|
|
|
|
|
.\"
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
|
.\"
|
|
|
|
|
.\" @(#)getloadavg.3 8.1 (Berkeley) 6/4/93
|
|
|
|
|
.\"
|
2007-12-03 19:59:38 +00:00
|
|
|
.\" 2007-12-08, mtk, Converted from mdoc to man macros
|
2007-12-03 19:53:53 +00:00
|
|
|
.\"
|
2007-12-03 19:59:38 +00:00
|
|
|
.TH GETLOADAVG 3 2007-12-08 "Linux" "Linux Programmer's Manual"
|
2007-12-03 19:53:53 +00:00
|
|
|
.SH NAME
|
|
|
|
|
getloadavg \- get system load averages
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
getresuid.2, mremap.2, poll.2, remap_file_pages.2, setresuid.2, splice.2, sync_file_range.2, syscall.2, tee.2, vmsplice.2, INFINITY.3, aio_init.3, asprintf.3, assert_perror.3, basename.3, bsd_signal.3, canonicalize_file_name.3, clog10.3, crypt.3, dl_iterate_phdr.3, dlopen.3, encrypt.3, exp10.3, fcloseall.3, fenv.3, fopencookie.3, ftw.3, getaddrinfo_a.3, getloadavg.3, getutent.3, grantpt.3, hsearch.3, lseek64.3, memmem.3, mempcpy.3, pow10.3, program_invocation_name.3, ptsname.3, putgrent.3, sched_getcpu.3, sincos.3, strchr.3, strfry.3, strnlen.3, strptime.3, strstr.3, strverscmp.3, swab.3, sysv_signal.3, tsearch.3, unlockpt.3, wcwidth.3: Add reference to feature_test_macros(7)
Some pages simply list feature test macro requirements in
the form:
#define #GNU_SOURCE
#include <someheader.h>
For these pages, add a "See feature_test_macros(7)" comment
on the "#define" line.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-10-31 04:31:47 +00:00
|
|
|
.BR "#define _BSD_SOURCE" " /* See feature_test_macros(7) */"
|
2007-12-03 19:53:53 +00:00
|
|
|
.B #include <stdlib.h>
|
|
|
|
|
.sp
|
|
|
|
|
.BI "int getloadavg(double " loadavg[] ", int " nelem );
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
2004-11-03 13:51:07 +00:00
|
|
|
The
|
2007-12-03 19:53:53 +00:00
|
|
|
.BR getloadavg ()
|
2004-11-03 13:51:07 +00:00
|
|
|
function returns the number of processes in the system run queue
|
|
|
|
|
averaged over various periods of time.
|
|
|
|
|
Up to
|
2007-12-03 19:53:53 +00:00
|
|
|
.I nelem
|
2004-11-03 13:51:07 +00:00
|
|
|
samples are retrieved and assigned to successive elements of
|
2007-12-03 19:53:53 +00:00
|
|
|
.IR loadavg [].
|
2004-11-03 13:51:07 +00:00
|
|
|
The system imposes a maximum of 3 samples, representing averages
|
|
|
|
|
over the last 1, 5, and 15 minutes, respectively.
|
2007-12-03 19:53:53 +00:00
|
|
|
.SH RETURN VALUE
|
2004-11-03 13:51:07 +00:00
|
|
|
If the load average was unobtainable, \-1 is returned; otherwise,
|
|
|
|
|
the number of samples actually retrieved is returned.
|
2007-12-03 19:53:53 +00:00
|
|
|
.\" .SH HISTORY
|
2007-11-16 06:34:05 +00:00
|
|
|
.\" The
|
2007-12-03 19:53:53 +00:00
|
|
|
.\" BR getloadavg ()
|
2007-11-16 06:34:05 +00:00
|
|
|
.\" function appeared in
|
2007-12-03 19:53:53 +00:00
|
|
|
.\" 4.3BSD Reno .
|
|
|
|
|
.SH VERSIONS
|
2006-01-01 12:00:09 +00:00
|
|
|
This function is available in glibc since version 2.2.
|
2007-12-03 19:53:53 +00:00
|
|
|
.SH "CONFORMING TO"
|
2007-04-12 22:42:49 +00:00
|
|
|
Not in POSIX.1-2001.
|
2006-08-04 12:39:17 +00:00
|
|
|
Present on the BSDs and Solaris.
|
2005-06-23 13:50:48 +00:00
|
|
|
.\" mdoc seems to have a bug - there must be no newline here
|
2007-12-03 19:53:53 +00:00
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR uptime (1),
|
|
|
|
|
.BR proc (5),
|
|
|
|
|
.BR feature_test_macros (7)
|
