share/man/man3c/getloadavg.3c

   1 '\" te
   2 .\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH GETLOADAVG 3C "Jun 28, 2004"
   7 .SH NAME
   8 getloadavg \- get system load averages
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/loadavg.h>
  13
  14 \fBint\fR \fBgetloadavg\fR(\fBdouble\fR \fIloadavg\fR[\|], \fBint\fR \fInelem\fR);
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 The \fBgetloadavg()\fR function returns the number of processes in the system
  21 run queue averaged over various periods of time. Up to \fInelem\fR samples are
  22 retrieved and assigned to successive elements of \fIloadavg\fR[\|]. The system
  23 imposes a maximum of 3 samples, representing averages over the last 1, 5, and
  24 15 minutes, respectively. The \fBLOADAVG_1MIN\fR, \fBLOADAVG_5MIN\fR, and
  25 \fBLOADAVG_15MIN\fR indices, defined in <\fBsys/loadavg.h\fR>, can be used to
  26 extract the data from the appropriate element of the \fIloadavg\fR\fB[\|]\fR
  27 array.
  28 .SH RETURN VALUES
  29 .sp
  30 .LP
  31 Upon successful completion, the number of samples actually retrieved is
  32 returned. If the load average was unobtainable, \fB\(mi1\fR is returned and
  33 \fBerrno\fR is set to indicate the error.
  34 .SH ERRORS
  35 .sp
  36 .LP
  37 The \fBgetloadavg()\fR function will fail if:
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fBEINVAL\fR\fR
  42 .ad
  43 .RS 10n
  44 The number of elements specified is less than 0.
  45 .RE
  46
  47 .SH USAGE
  48 .sp
  49 .LP
  50 If the caller is in a non-global zone and the pools facility is active, the
  51 behavior of \fBgetloadavg()\fR is equivalent to that of
  52 \fBpset_getloadavg\fR(3C) called with \fIpsetid\fR set to \fBPS_MYID\fR.
  53 .SH ATTRIBUTES
  54 .sp
  55 .LP
  56 See \fBattributes\fR(5) for descriptions of the following attributes:
  57 .sp
  58
  59 .sp
  60 .TS
  61 box;
  62 c | c
  63 l | l .
  64 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  65 _
  66 MT-Level        Async-Signal-Safe
  67 .TE
  68
  69 .SH SEE ALSO
  70 .sp
  71 .LP
  72 \fBuptime\fR(1), \fBw\fR(1), \fBpooladm\fR(1M), \fBKstat\fR(3PERL),
  73 \fBpset_getloadavg\fR(3C), \fBstandards\fR(5)