1.\" $NetBSD: getloadavg.3,v 1.9 1999/06/15 12:14:08 simonb 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. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)getloadavg.3 8.1 (Berkeley) 6/4/93 35.\" 36.Dd June 4, 1993 37.Dt GETLOADAVG 3 38.Os 39.Sh NAME 40.Nm getloadavg 41.Nd get system load averages 42.Sh LIBRARY 43.Lb libc 44.Sh SYNOPSIS 45.Fd #include <stdlib.h> 46.Fn getloadavg "double loadavg[]" "int nelem" 47.Sh DESCRIPTION 48The 49.Fn getloadavg 50function returns the number of processes in the system run queue 51averaged over various periods of time. 52Up to 53.Fa nelem 54samples are retrieved and assigned to successive elements of 55.Fa loadavg Ns Bq . 56The system imposes a maximum of 3 samples, representing averages 57over the last 1, 5, and 15 minutes, respectively. 58.Sh DIAGNOSTICS 59If the load average was unobtainable, \-1 is returned; otherwise, 60the number of samples actually retrieved is returned. 61.Sh SEE ALSO 62.Xr uptime 1 , 63.Xr sysctl 3 , 64.Xr kvm_getloadavg 3 65.Sh HISTORY 66The 67.Fn getloadavg 68function appeared in 69.Bx 4.3 Reno . 70