1 .\" Copyright (c) 1992 Drew Eckhardt, March 28, 1992
2 .\" and Copyright (c) 2002 Michael Kerrisk
4 .\" %%%LICENSE_START(VERBATIM)
5 .\" Permission is granted to make and distribute verbatim copies of this
6 .\" manual provided the copyright notice and this permission notice are
7 .\" preserved on all copies.
9 .\" Permission is granted to copy and distribute modified versions of this
10 .\" manual under the conditions for verbatim copying, provided that the
11 .\" entire resulting derived work is distributed under the terms of a
12 .\" permission notice identical to this one.
14 .\" Since the Linux kernel and libraries are constantly changing, this
15 .\" manual page may be incorrect or out-of-date. The author(s) assume no
16 .\" responsibility for errors or omissions, or for damages resulting from
17 .\" the use of the information contained herein. The author(s) may not
18 .\" have taken the same level of care in the production of this manual,
19 .\" which is licensed free of charge, as they might when working
22 .\" Formatted or processed versions of this manual, if unaccompanied by
23 .\" the source, must acknowledge the copyright and authors of this work.
26 .\" 2004-11-16 -- mtk: the getrlimit.2 page, which formerly included
27 .\" coverage of getrusage(2), has been split, so that the latter is
28 .\" now covered in its own getrusage.2. For older details of change
29 .\" history, etc., see getrlimit.2
31 .\" Modified 2004-11-16, mtk, Noted that the nonconformance
32 .\" when SIGCHLD is being ignored is fixed in 2.6.9.
33 .\" 2008-02-22, Sripathi Kodi <sripathik@in.ibm.com>: Document RUSAGE_THREAD
34 .\" 2008-05-25, mtk, clarify RUSAGE_CHILDREN + other clean-ups.
35 .\" 2010-05-24, Mark Hills <mark@pogo.org.uk>: Description of fields,
36 .\" document ru_maxrss
37 .\" 2010-05-24, mtk, enhanced description of various fields
39 .TH GETRUSAGE 2 2017-09-15 "Linux" "Linux Programmer's Manual"
41 getrusage \- get resource usage
43 .B #include <sys/time.h>
45 .B #include <sys/resource.h>
47 .BI "int getrusage(int " who ", struct rusage *" usage );
51 returns resource usage measures for
53 which can be one of the following:
56 Return resource usage statistics for the calling process,
57 which is the sum of resources used by all threads in the process.
60 Return resource usage statistics for all children of the
61 calling process that have terminated and been waited for.
62 These statistics will include the resources used by grandchildren,
63 and further removed descendants,
64 if all of the intervening descendants waited on their terminated children.
66 .BR RUSAGE_THREAD " (since Linux 2.6.26)"
67 Return resource usage statistics for the calling thread.
70 feature test macro must be defined (before including
73 in order to obtain the definition of this constant from
74 .IR <sys/resource.h> .
76 The resource usages are returned in the structure pointed to by
78 which has the following form:
83 struct timeval ru_utime; /* user CPU time used */
84 struct timeval ru_stime; /* system CPU time used */
85 long ru_maxrss; /* maximum resident set size */
86 long ru_ixrss; /* integral shared memory size */
87 long ru_idrss; /* integral unshared data size */
88 long ru_isrss; /* integral unshared stack size */
89 long ru_minflt; /* page reclaims (soft page faults) */
90 long ru_majflt; /* page faults (hard page faults) */
91 long ru_nswap; /* swaps */
92 long ru_inblock; /* block input operations */
93 long ru_oublock; /* block output operations */
94 long ru_msgsnd; /* IPC messages sent */
95 long ru_msgrcv; /* IPC messages received */
96 long ru_nsignals; /* signals received */
97 long ru_nvcsw; /* voluntary context switches */
98 long ru_nivcsw; /* involuntary context switches */
103 Not all fields are completed;
104 unmaintained fields are set to zero by the kernel.
105 (The unmaintained fields are provided for compatibility with other systems,
106 and because they may one day be supported on Linux.)
107 The fields are interpreted as follows:
110 This is the total amount of time spent executing in user mode,
113 structure (seconds plus microseconds).
116 This is the total amount of time spent executing in kernel mode,
119 structure (seconds plus microseconds).
121 .IR ru_maxrss " (since Linux 2.6.32)"
122 This is the maximum resident set size used (in kilobytes).
124 .BR RUSAGE_CHILDREN ,
125 this is the resident set size of the largest child, not the maximum
126 resident set size of the process tree.
128 .IR ru_ixrss " (unmaintained)"
129 This field is currently unused on Linux.
131 .\" this is the integral of the text segment memory consumption,
132 .\" expressed in kilobyte-seconds.
134 .IR ru_idrss " (unmaintained)"
135 This field is currently unused on Linux.
136 .\" On some systems, this is the integral of the data segment memory consumption,
137 .\" expressed in kilobyte-seconds.
139 .IR ru_isrss " (unmaintained)"
140 This field is currently unused on Linux.
141 .\" On some systems, this is the integral of the stack memory consumption,
142 .\" expressed in kilobyte-seconds.
145 The number of page faults serviced without any I/O activity; here
146 I/O activity is avoided by \*(lqreclaiming\*(rq a page frame from
147 the list of pages awaiting reallocation.
150 The number of page faults serviced that required I/O activity.
152 .IR ru_nswap " (unmaintained)"
153 This field is currently unused on Linux.
154 .\" On some systems, this is the number of swaps out of physical memory.
156 .IR ru_inblock " (since Linux 2.6.22)"
157 The number of times the filesystem had to perform input.
159 .IR ru_oublock " (since Linux 2.6.22)"
160 The number of times the filesystem had to perform output.
162 .IR ru_msgsnd " (unmaintained)"
163 This field is currently unused on Linux.
164 .\" On FreeBSD 6.2, this appears to measure messages sent over sockets
166 .\" this field records the number of messages sent over sockets.
168 .IR ru_msgrcv " (unmaintained)"
169 This field is currently unused on Linux.
170 .\" On FreeBSD 6.2, this appears to measure messages received over sockets
172 .\" this field records the number of messages received over sockets.
174 .IR ru_nsignals " (unmaintained)"
175 This field is currently unused on Linux.
176 .\" On some systems, this field records the number of signals received.
178 .IR ru_nvcsw " (since Linux 2.6)"
179 The number of times a context switch resulted due to a process
180 voluntarily giving up the processor before its time slice was
181 completed (usually to await availability of a resource).
183 .IR ru_nivcsw " (since Linux 2.6)"
184 The number of times a context switch resulted due to a higher
185 priority process becoming runnable or because the current process
186 exceeded its time slice.
189 On success, zero is returned.
190 On error, \-1 is returned, and
192 is set appropriately.
197 points outside the accessible address space.
203 For an explanation of the terms used in this section, see
209 Interface Attribute Value
212 T} Thread safety MT-Safe
216 POSIX.1-2001, POSIX.1-2008, SVr4, 4.3BSD.
219 but specifies only the fields
227 Resource usage metrics are preserved across an
232 is not required these days, but increases portability.
238 In Linux kernel versions before 2.6.9, if the disposition of
242 then the resource usages of child processes
243 are automatically included in the value returned by
244 .BR RUSAGE_CHILDREN ,
245 although POSIX.1-2001 explicitly prohibits this.
246 This nonconformance is rectified in Linux 2.6.9 and later.
247 .\" See the description of getrusage() in XSH.
248 .\" A similar statement was also in SUSv2.
250 The structure definition shown at the start of this page
251 was taken from 4.3BSD Reno.
253 Ancient systems provided a
255 function with a similar purpose to
257 For backward compatibility, glibc also provides
259 All new applications should be written using
262 See also the description of
267 .BR clock_gettime (2),