xref: /netbsd/lib/libc/gen/getloadavg.3 (revision 6550d01e)
1.\"	$NetBSD: getloadavg.3,v 1.14 2003/08/07 16:42:50 agc Exp $
2.\"
3.\" Copyright (c) 1989, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\"     @(#)getloadavg.3	8.1 (Berkeley) 6/4/93
31.\"
32.Dd June 4, 1993
33.Dt GETLOADAVG 3
34.Os
35.Sh NAME
36.Nm getloadavg
37.Nd get system load averages
38.Sh LIBRARY
39.Lb libc
40.Sh SYNOPSIS
41.In stdlib.h
42.Ft int
43.Fn getloadavg "double loadavg[]" "int nelem"
44.Sh DESCRIPTION
45The
46.Fn getloadavg
47function returns the number of processes in the system run queue
48averaged over various periods of time.
49Up to
50.Fa nelem
51samples are retrieved and assigned to successive elements of
52.Fa loadavg Ns Bq .
53The system imposes a maximum of 3 samples, representing averages
54over the last 1, 5, and 15 minutes, respectively.
55.Sh DIAGNOSTICS
56If the load average was unobtainable, \-1 is returned; otherwise,
57the number of samples actually retrieved is returned.
58.Sh SEE ALSO
59.Xr uptime 1 ,
60.Xr kvm_getloadavg 3 ,
61.Xr sysctl 3
62.Sh HISTORY
63The
64.Fn getloadavg
65function appeared in
66.Bx 4.3 Reno .
67