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