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