man/man3c/getloadavg.3c

         te
 Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
 The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
 You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
 When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
 getloadavg 3C "28 Jun 2004" "SunOS 5.11" "Standard C Library Functions"
 NAME
getloadavg - get system load averages
 SYNOPSIS

#include <sys/loadavg.h>

int getloadavg(double loadavg[\|], int nelem);


 DESCRIPTION

The getloadavg() function returns the number of processes in the system
run queue averaged over various periods of time. Up to nelem samples are
retrieved and assigned to successive elements of loadavg[\|]. The system
imposes a maximum of 3 samples, representing averages over the last 1, 5, and
15 minutes, respectively. The LOADAVG_1MIN, LOADAVG_5MIN, and
LOADAVG_15MIN indices, defined in <sys/loadavg.h>, can be used to
extract the data from the appropriate element of the loadavg[\|]
array.
 RETURN VALUES

Upon successful completion, the number of samples actually retrieved is
returned. If the load average was unobtainable, -1 is returned and
errno is set to indicate the error.
 ERRORS

The getloadavg() function will fail if:

EINVAL

The number of elements specified is less than 0.


 USAGE

If the caller is in a non-global zone and the pools facility is active, the
behavior of getloadavg() is equivalent to that of
pset_getloadavg(3C) called with psetid set to PS_MYID.
 ATTRIBUTES

See attributes(5) for descriptions of the following attributes:


ATTRIBUTE TYPEATTRIBUTE VALUE
MT-LevelAsync-Signal-Safe


 SEE ALSO

uptime(1), w(1), pooladm(1M), Kstat(3PERL),
pset_getloadavg(3C), standards(5)