original/man2/getrusage.2

   1 .\" Copyright (c) 1992 Drew Eckhardt, March 28, 1992
   2 .\" and Copyright (c) 2002 Michael Kerrisk
   3 .\"
   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.
   8 .\"
   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.
  13 .\"
  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
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  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
  30 .\"
  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
  38 .\"
  39 .TH GETRUSAGE 2 2014-05-10 "Linux" "Linux Programmer's Manual"
  40 .SH NAME
  41 getrusage \- get resource usage
  42 .SH SYNOPSIS
  43 .B #include <sys/time.h>
  44 .br
  45 .B #include <sys/resource.h>
  46 .sp
  47 .BI "int getrusage(int " who ", struct rusage *" usage );
  48 .SH DESCRIPTION
  49 .PP
  50 .BR getrusage ()
  51 returns resource usage measures for
  52 .IR who ,
  53 which can be one of the following:
  54 .TP
  55 .B RUSAGE_SELF
  56 Return resource usage statistics for the calling process,
  57 which is the sum of resources used by all threads in the process.
  58 .TP
  59 .B RUSAGE_CHILDREN
  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.
  65 .TP
  66 .BR RUSAGE_THREAD " (since Linux 2.6.26)"
  67 Return resource usage statistics for the calling thread.
  68 The
  69 .B _GNU_SOURCE
  70 feature test macro must be defined (before including
  71 .I any
  72 header file)
  73 in order to obtain the definition of this constant from
  74 .IR <sys/resource.h> .
  75 .PP
  76 The resource usages are returned in the structure pointed to by
  77 .IR usage ,
  78 which has the following form:
  79 .PP
  80 .in +4n
  81 .nf
  82 struct rusage {
  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 */
  99 };
 100 .fi
 101 .in
 102 .PP
 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:
 108 .TP
 109 .I ru_utime
 110 This is the total amount of time spent executing in user mode,
 111 expressed in a
 112 .I timeval
 113 structure (seconds plus microseconds).
 114 .TP
 115 .I ru_stime
 116 This is the total amount of time spent executing in kernel mode,
 117 expressed in a
 118 .I timeval
 119 structure (seconds plus microseconds).
 120 .TP
 121 .IR ru_maxrss " (since Linux 2.6.32)"
 122 This is the maximum resident set size used (in kilobytes).
 123 For
 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.
 127 .TP
 128 .IR ru_ixrss " (unmaintained)"
 129 This field is currently unused on Linux.
 130 .\" On some systems,
 131 .\" this is the integral of the text segment memory consumption,
 132 .\" expressed in kilobyte-seconds.
 133 .TP
 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.
 138 .TP
 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.
 143 .TP
 144 .I ru_minflt
 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.
 148 .TP
 149 .I ru_majflt
 150 The number of page faults serviced that required I/O activity.
 151 .TP
 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.
 155 .TP
 156 .IR ru_inblock " (since Linux 2.6.22)"
 157 The number of times the filesystem had to perform input.
 158 .TP
 159 .IR ru_oublock " (since Linux 2.6.22)"
 160 The number of times the filesystem had to perform output.
 161 .TP
 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
 165 .\" On some systems,
 166 .\" this field records the number of messages sent over sockets.
 167 .TP
 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
 171 .\" On some systems,
 172 .\" this field records the number of messages received over sockets.
 173 .TP
 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.
 177 .TP
 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).
 182 .TP
 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.
 187 .PP
 188 .SH RETURN VALUE
 189 On success, zero is returned.
 190 On error, \-1 is returned, and
 191 .I errno
 192 is set appropriately.
 193 .SH ERRORS
 194 .TP
 195 .B EFAULT
 196 .I usage
 197 points outside the accessible address space.
 198 .TP
 199 .B EINVAL
 200 .I who
 201 is invalid.
 202 .SH CONFORMING TO
 203 SVr4, 4.3BSD.
 204 POSIX.1-2001 specifies
 205 .BR getrusage (),
 206 but specifies only the fields
 207 .I ru_utime
 208 and
 209 .IR ru_stime .
 210
 211 .B RUSAGE_THREAD
 212 is Linux-specific.
 213 .SH NOTES
 214 Resource usage metrics are preserved across an
 215 .BR execve (2).
 216
 217 Including
 218 .I <sys/time.h>
 219 is not required these days, but increases portability.
 220 (Indeed,
 221 .I struct timeval
 222 is defined in
 223 .IR <sys/time.h> .)
 224 .PP
 225 In Linux kernel versions before 2.6.9, if the disposition of
 226 .B SIGCHLD
 227 is set to
 228 .B SIG_IGN
 229 then the resource usages of child processes
 230 are automatically included in the value returned by
 231 .BR RUSAGE_CHILDREN ,
 232 although POSIX.1-2001 explicitly prohibits this.
 233 This nonconformance is rectified in Linux 2.6.9 and later.
 234 .\" See the description of getrusage() in XSH.
 235 .\" A similar statement was also in SUSv2.
 236 .LP
 237 The structure definition shown at the start of this page
 238 was taken from 4.3BSD Reno.
 239
 240 Ancient systems provided a
 241 .BR vtimes ()
 242 function with a similar purpose to
 243 .BR getrusage ().
 244 For backward compatibility, glibc also provides
 245 .BR vtimes ().
 246 All new applications should be written using
 247 .BR getrusage ().
 248
 249 See also the description of
 250 .IR /proc/PID/stat
 251 in
 252 .BR proc (5).
 253 .SH SEE ALSO
 254 .BR clock_gettime (2),
 255 .BR getrlimit (2),
 256 .BR times (2),
 257 .BR wait (2),
 258 .BR wait4 (2),
 259 .BR clock (3)
 260 .SH COLOPHON
 261 This page is part of release 3.68 of the Linux
 262 .I man-pages
 263 project.
 264 A description of the project,
 265 information about reporting bugs,
 266 and the latest version of this page,
 267 can be found at
 268 \%http://www.kernel.org/doc/man\-pages/.