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