1.\" $OpenBSD: getloadavg.3,v 1.12 2010/09/20 07:41:17 jmc 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.Dd $Mdocdate: September 20 2010 $ 31.Dt GETLOADAVG 3 32.Os 33.Sh NAME 34.Nm getloadavg 35.Nd get system load averages 36.Sh SYNOPSIS 37.Fd #include <stdlib.h> 38.Ft int 39.Fn getloadavg "double loadavg[]" "int nelem" 40.Sh DESCRIPTION 41The 42.Fn getloadavg 43function returns the number of processes in the system run queue 44averaged over various periods of time. 45Up to 46.Fa nelem 47samples are retrieved and assigned to successive elements of 48.Fa loadavg Ns Bq . 49The system imposes a maximum of 3 samples, representing averages 50over the last 1, 5, and 15 minutes, respectively. 51.Sh RETURN VALUES 52Upon successful completion, the number of samples retrieved is returned. 53If an error occurs, \-1 is returned and the global variable 54.Va errno 55is set to indicate the error. 56.Sh ERRORS 57Please see 58.Xr sysctl 3 59for a list of possible errors. 60.Sh SEE ALSO 61.Xr uptime 1 , 62.Xr kvm_getloadavg 3 , 63.Xr sysctl 3 64.Sh HISTORY 65The 66.Fn getloadavg 67function appeared in 68.Bx 4.3 Reno . 69