]>
Commit | Line | Data |
---|---|---|
fea681da MK |
1 | .\" Copyright (c) 1989, 1991, 1993 |
2 | .\" The Regents of the University of California. All rights reserved. | |
3 | .\" | |
491b7776 | 4 | .\" %%%LICENSE_START(BSD_3_CLAUSE_UCB) |
fea681da MK |
5 | .\" Redistribution and use in source and binary forms, with or without |
6 | .\" modification, are permitted provided that the following conditions | |
7 | .\" are met: | |
8 | .\" 1. Redistributions of source code must retain the above copyright | |
9 | .\" notice, this list of conditions and the following disclaimer. | |
10 | .\" 2. Redistributions in binary form must reproduce the above copyright | |
11 | .\" notice, this list of conditions and the following disclaimer in the | |
12 | .\" documentation and/or other materials provided with the distribution. | |
13 | .\" 3. Neither the name of the University nor the names of its contributors | |
14 | .\" may be used to endorse or promote products derived from this software | |
15 | .\" without specific prior written permission. | |
16 | .\" | |
17 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | |
18 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
19 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
20 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | |
21 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
22 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
23 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
24 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
25 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
26 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
27 | .\" SUCH DAMAGE. | |
8c9302dc | 28 | .\" %%%LICENSE_END |
fea681da MK |
29 | .\" |
30 | .\" @(#)getloadavg.3 8.1 (Berkeley) 6/4/93 | |
31 | .\" | |
352bedee | 32 | .\" 2007-12-08, mtk, Converted from mdoc to man macros |
3233d665 | 33 | .\" |
97986708 | 34 | .TH GETLOADAVG 3 2016-03-15 "Linux" "Linux Programmer's Manual" |
3233d665 MK |
35 | .SH NAME |
36 | getloadavg \- get system load averages | |
37 | .SH SYNOPSIS | |
38 | .nf | |
3233d665 | 39 | .B #include <stdlib.h> |
68e4db0a | 40 | .PP |
3233d665 MK |
41 | .BI "int getloadavg(double " loadavg[] ", int " nelem ); |
42 | .fi | |
68e4db0a | 43 | .PP |
7f0ec8ee MK |
44 | .in -4n |
45 | Feature Test Macro Requirements for glibc (see | |
46 | .BR feature_test_macros (7)): | |
47 | .in | |
68e4db0a | 48 | .PP |
7f0ec8ee MK |
49 | .BR getloadavg (): |
50 | .nf | |
51 | Since glibc 2.19: | |
52 | _DEFAULT_SOURCE | |
53 | In glibc up to and including 2.19: | |
54 | _BSD_SOURCE | |
55 | .fi | |
3233d665 | 56 | .SH DESCRIPTION |
fea681da | 57 | The |
3233d665 | 58 | .BR getloadavg () |
fea681da MK |
59 | function returns the number of processes in the system run queue |
60 | averaged over various periods of time. | |
61 | Up to | |
3233d665 | 62 | .I nelem |
fea681da | 63 | samples are retrieved and assigned to successive elements of |
3233d665 | 64 | .IR loadavg []. |
fea681da MK |
65 | The system imposes a maximum of 3 samples, representing averages |
66 | over the last 1, 5, and 15 minutes, respectively. | |
3233d665 | 67 | .SH RETURN VALUE |
fea681da MK |
68 | If the load average was unobtainable, \-1 is returned; otherwise, |
69 | the number of samples actually retrieved is returned. | |
3233d665 | 70 | .\" .SH HISTORY |
bed8a6f2 | 71 | .\" The |
3233d665 | 72 | .\" BR getloadavg () |
bed8a6f2 | 73 | .\" function appeared in |
3233d665 MK |
74 | .\" 4.3BSD Reno . |
75 | .SH VERSIONS | |
b62a20b7 | 76 | This function is available in glibc since version 2.2. |
28412482 | 77 | .SH ATTRIBUTES |
f5d92a47 MK |
78 | For an explanation of the terms used in this section, see |
79 | .BR attributes (7). | |
80 | .TS | |
81 | allbox; | |
82 | lb lb lb | |
83 | l l l. | |
84 | Interface Attribute Value | |
85 | T{ | |
28412482 | 86 | .BR getloadavg () |
f5d92a47 MK |
87 | T} Thread safety MT-Safe |
88 | .TE | |
47297adb | 89 | .SH CONFORMING TO |
0b6956ee | 90 | Not in POSIX.1. |
a7fadb55 | 91 | Present on the BSDs and Solaris. |
08f75afe | 92 | .\" mdoc seems to have a bug - there must be no newline here |
3233d665 MK |
93 | .SH SEE ALSO |
94 | .BR uptime (1), | |
0a4f8b7b | 95 | .BR proc (5) |