xref: /freebsd/lib/libc/gen/getloadavg.3 (revision dc36d6f9bb1753f3808552f3afd30eda9a7b206a)
158f0484fSRodney W. Grimes.\" Copyright (c) 1989, 1991, 1993
258f0484fSRodney W. Grimes.\"	The Regents of the University of California.  All rights reserved.
358f0484fSRodney W. Grimes.\"
458f0484fSRodney W. Grimes.\" Redistribution and use in source and binary forms, with or without
558f0484fSRodney W. Grimes.\" modification, are permitted provided that the following conditions
658f0484fSRodney W. Grimes.\" are met:
758f0484fSRodney W. Grimes.\" 1. Redistributions of source code must retain the above copyright
858f0484fSRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer.
958f0484fSRodney W. Grimes.\" 2. Redistributions in binary form must reproduce the above copyright
1058f0484fSRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer in the
1158f0484fSRodney W. Grimes.\"    documentation and/or other materials provided with the distribution.
12*fbbd9655SWarner Losh.\" 3. Neither the name of the University nor the names of its contributors
1358f0484fSRodney W. Grimes.\"    may be used to endorse or promote products derived from this software
1458f0484fSRodney W. Grimes.\"    without specific prior written permission.
1558f0484fSRodney W. Grimes.\"
1658f0484fSRodney W. Grimes.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
1758f0484fSRodney W. Grimes.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1858f0484fSRodney W. Grimes.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1958f0484fSRodney W. Grimes.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
2058f0484fSRodney W. Grimes.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2158f0484fSRodney W. Grimes.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2258f0484fSRodney W. Grimes.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2358f0484fSRodney W. Grimes.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2458f0484fSRodney W. Grimes.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2558f0484fSRodney W. Grimes.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2658f0484fSRodney W. Grimes.\" SUCH DAMAGE.
2758f0484fSRodney W. Grimes.\"
2858f0484fSRodney W. Grimes.Dd June 4, 1993
2958f0484fSRodney W. Grimes.Dt GETLOADAVG 3
3058f0484fSRodney W. Grimes.Os
3158f0484fSRodney W. Grimes.Sh NAME
3258f0484fSRodney W. Grimes.Nm getloadavg
3358f0484fSRodney W. Grimes.Nd get system load averages
3425bb73e0SAlexey Zelkin.Sh LIBRARY
3525bb73e0SAlexey Zelkin.Lb libc
3658f0484fSRodney W. Grimes.Sh SYNOPSIS
3732eef9aeSRuslan Ermilov.In stdlib.h
383ce29386SBruce Evans.Ft int
3958f0484fSRodney W. Grimes.Fn getloadavg "double loadavg[]" "int nelem"
4058f0484fSRodney W. Grimes.Sh DESCRIPTION
4158f0484fSRodney W. GrimesThe
4258f0484fSRodney W. Grimes.Fn getloadavg
4358f0484fSRodney W. Grimesfunction returns the number of processes in the system run queue
4458f0484fSRodney W. Grimesaveraged over various periods of time.
4558f0484fSRodney W. GrimesUp to
4658f0484fSRodney W. Grimes.Fa nelem
4758f0484fSRodney W. Grimessamples are retrieved and assigned to successive elements of
4858f0484fSRodney W. Grimes.Fa loadavg Ns Bq .
4958f0484fSRodney W. GrimesThe system imposes a maximum of 3 samples, representing averages
5058f0484fSRodney W. Grimesover the last 1, 5, and 15 minutes, respectively.
5158f0484fSRodney W. Grimes.Sh DIAGNOSTICS
5258f0484fSRodney W. GrimesIf the load average was unobtainable, \-1 is returned; otherwise,
5358f0484fSRodney W. Grimesthe number of samples actually retrieved is returned.
5458f0484fSRodney W. Grimes.Sh SEE ALSO
5558f0484fSRodney W. Grimes.Xr uptime 1 ,
5678b0b234SMike Pritchard.Xr kvm_getloadavg 3 ,
5778b0b234SMike Pritchard.Xr sysctl 3
5858f0484fSRodney W. Grimes.Sh HISTORY
5958f0484fSRodney W. GrimesThe
6058f0484fSRodney W. Grimes.Fn getloadavg
6158f0484fSRodney W. Grimesfunction appeared in
6258f0484fSRodney W. Grimes.Bx 4.3 Reno .
63