1 .\" Copyright (c) 1985, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by the University of
15 .\" California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" @(#)getrusage.2 8.1 (Berkeley) 6/4/93
40 .Nd get information about resource utilization
44 .Fd #include <sys/types.h>
45 .Fd #include <sys/time.h>
46 .Fd #include <sys/resource.h>
47 .Fd "#define RUSAGE_SELF 0"
48 .Fd "#define RUSAGE_CHILDREN -1"
50 .Fn getrusage "int who" "struct rusage *rusage"
53 returns information describing the resources utilized by the current
54 process, or all its terminated child processes.
63 points will be filled in with
64 the following structure:
67 struct timeval ru_utime; /* user time used */
68 struct timeval ru_stime; /* system time used */
69 long ru_maxrss; /* max resident set size */
70 long ru_ixrss; /* integral shared text memory size */
71 long ru_idrss; /* integral unshared data size */
72 long ru_isrss; /* integral unshared stack size */
73 long ru_minflt; /* page reclaims */
74 long ru_majflt; /* page faults */
75 long ru_nswap; /* swaps */
76 long ru_inblock; /* block input operations */
77 long ru_oublock; /* block output operations */
78 long ru_msgsnd; /* messages sent */
79 long ru_msgrcv; /* messages received */
80 long ru_nsignals; /* signals received */
81 long ru_nvcsw; /* voluntary context switches */
82 long ru_nivcsw; /* involuntary context switches */
86 The fields are interpreted as follows:
87 .Bl -tag -width ru_minfltaa
89 the total amount of time spent executing in user mode.
91 the total amount of time spent in the system executing on behalf
94 the maximum resident set size utilized (in kilobytes).
98 value indicating the amount of memory used
100 that was also shared among other processes. This value is expressed
101 in units of kilobytes * ticks-of-execution.
102 Ticks are statistics clock ticks.
103 The statistics clock has a frequency of
104 .Fn sysconf _SC_CLOCK_TCK
107 an integral value of the amount of unshared memory residing in the
108 data segment of a process (expressed in units of
109 kilobytes * ticks-of-execution).
111 an integral value of the amount of unshared memory residing in the
112 stack segment of a process (expressed in units of
113 kilobytes * ticks-of-execution).
115 the number of page faults serviced without any I/O activity; here
116 I/O activity is avoided by
119 the list of pages awaiting reallocation.
121 the number of page faults serviced that required I/O activity.
123 the number of times a process was
128 the number of times the file system had to perform input.
130 the number of times the file system had to perform output.
132 the number of IPC messages sent.
134 the number of IPC messages received.
136 the number of signals delivered.
138 the number of times a context switch resulted due to a process
139 voluntarily giving up the processor before its time slice was
140 completed (usually to await availability of a resource).
142 the number of times a context switch resulted due to a higher
143 priority process becoming runnable or because the current process
144 exceeded its time slice.
151 account only for real
152 I/O; data supplied by the caching mechanism is charged only
153 to the first process to read or write the data.
159 function will fail if:
164 parameter is not a valid value.
166 The address specified by the
168 parameter is not in a valid part of the process address space.
175 There is no way to obtain information about a child process
176 that has not yet terminated.
180 function call appeared in