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