1.\" $NetBSD: kvm_getloadavg.3,v 1.13 2018/12/11 23:02:19 sevan Exp $ 2.\" 3.\" Copyright (c) 1992, 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.\" @(#)kvm_getloadavg.3 8.1 (Berkeley) 6/4/93 31.\" 32.Dd December 11, 2018 33.Dt KVM_GETLOADAVG 3 34.Os 35.Sh NAME 36.Nm kvm_getloadavg 37.Nd get system load averages, from live or dead kernels 38.Sh LIBRARY 39.Lb libkvm 40.Sh SYNOPSIS 41.In sys/resource.h 42.In kvm.h 43.Ft int 44.Fn kvm_getloadavg "kvm_t *kd" "double loadavg[]" "int nelem" 45.Sh DESCRIPTION 46The 47.Fn kvm_getloadavg 48function returns the number of processes in the system run queue 49of the kernel or core file, indicated by 50.Fa kd . 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. 57On a live system, the load average is obtained by calling 58.Xr getloadavg 3 . 59If performing post mortem on a kernel core file, 60.Nm 61is able to extract the system load averages at the time of death from the core 62file directly. 63.Sh RETURN VALUES 64If the load average was unobtainable, \-1 is returned; otherwise, 65the number of samples actually retrieved is returned. 66.Sh SEE ALSO 67.Xr uptime 1 , 68.Xr getloadavg 3 , 69.Xr kvm 3 , 70.Xr kvm_open 3 , 71.Xr sysctl 3 72