2012-11-15 12:06:41 +01:00
|
|
|
.\" $NetBSD: getloadavg.3,v 1.15 2011/04/12 04:55:05 jruoho Exp $
|
2011-02-14 20:36:03 +01: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
|
|
|
|
|
.\"
|
2012-11-15 12:06:41 +01:00
|
|
|
.Dd April 12, 2011
|
2011-02-14 20:36:03 +01:00
|
|
|
.Dt GETLOADAVG 3
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm getloadavg
|
|
|
|
|
.Nd get system load averages
|
|
|
|
|
.Sh LIBRARY
|
|
|
|
|
.Lb libc
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.In stdlib.h
|
|
|
|
|
.Ft int
|
|
|
|
|
.Fn getloadavg "double loadavg[]" "int nelem"
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.Fn getloadavg
|
|
|
|
|
function returns the number of processes in the system run queue
|
|
|
|
|
averaged over various periods of time.
|
|
|
|
|
Up to
|
|
|
|
|
.Fa nelem
|
|
|
|
|
samples are retrieved and assigned to successive elements of
|
|
|
|
|
.Fa loadavg Ns Bq .
|
|
|
|
|
The system imposes a maximum of 3 samples, representing averages
|
|
|
|
|
over the last 1, 5, and 15 minutes, respectively.
|
2012-11-15 12:06:41 +01:00
|
|
|
.Sh RETURN VALUES
|
2011-02-14 20:36:03 +01:00
|
|
|
If the load average was unobtainable, \-1 is returned; otherwise,
|
|
|
|
|
the number of samples actually retrieved is returned.
|
|
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr uptime 1 ,
|
|
|
|
|
.Xr kvm_getloadavg 3 ,
|
|
|
|
|
.Xr sysctl 3
|
|
|
|
|
.Sh HISTORY
|
|
|
|
|
The
|
|
|
|
|
.Fn getloadavg
|
|
|
|
|
function appeared in
|
|
|
|
|
.Bx 4.3 Reno .
|
