Name

getrusage — get resource usage

Synopsis

#include <sys/time.h>
#include <sys/resource.h>
int getrusage( int   who,
  struct rusage *  usage);

DESCRIPTION

getrusage() returns current resource usages, for a who of either RUSAGE_SELF or RUSAGE_CHILDREN. The former asks for resources used by the calling process, the latter for resources used by those of its children that have terminated and have been waited for.

struct rusage {
  struct timeval   ru_utime;
/* user time used */
  struct timeval   ru_stime;
/* system time used */
  long   ru_maxrss;
/* maximum resident set size */
  long   ru_ixrss;
/* integral shared memory size */
  long   ru_idrss;
/* integral unshared data size */
  long   ru_isrss;
/* integral unshared stack size */
  long   ru_minflt;
/* page reclaims */
  long   ru_majflt;
/* page faults */
  long   ru_nswap;
/* swaps */
  long   ru_inblock;
/* block input operations */
  long   ru_oublock;
/* block output operations */
  long   ru_msgsnd;
/* messages sent */
  long   ru_msgrcv;
/* messages received */
  long   ru_nsignals;
/* signals received */
  long   ru_nvcsw;
/* voluntary context switches */
  long   ru_nivcsw;
/* involuntary context switches */
};

RETURN VALUE

On success, zero is returned. On error, −1 is returned, and errno is set appropriately.

ERRORS

EFAULT

usage points outside the accessible address space.

EINVAL

who is invalid.

CONFORMING TO

SVr4, 4.3BSD. POSIX.1-2001 specifies getrusage(), but only specifies the fields ru_utime and ru_stime.

NOTES

Including <sys/time.h> is not required these days, but increases portability. (Indeed, struct timeval is defined in <sys/time.h>

In Linux kernel versions before 2.6.9, if the disposition of SIGCHLD is set to SIG_IGN then the resource usages of child processes are automatically included in the value returned by RUSAGE_CHILDREN, although POSIX.1-2001 explicitly prohibits this. This non-conformance is rectified in Linux 2.6.9 and later.

The structure definition shown at the start of this page was taken from 4.3BSD Reno. Not all fields are meaningful under Linux. In Linux 2.4 only the fields ru_utime, ru_stime, ru_minflt, and ru_majflt are maintained. Since Linux 2.6, ru_nvcsw and ru_nivcsw are also maintained.

SEE ALSO

getrlimit(2), times(2), wait(2), wait4(2)

COLOPHON

This page is part of release 2.79 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/.


Copyright (c) 1992 Drew Eckhardt, March 28, 1992
and Copyright (c) 2002 Michael Kerrisk

Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.

Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.

Since the Linux kernel and libraries are constantly changing, this
manual page may be incorrect or out-of-date.  The author(s) assume no
responsibility for errors or omissions, or for damages resulting from
the use of the information contained herein.  The author(s) may not
have taken the same level of care in the production of this manual,
which is licensed free of charge, as they might when working
professionally.

Formatted or processed versions of this manual, if unaccompanied by
the source, must acknowledge the copyright and authors of this work.

2004-11-16 -- mtk: the getrlimit.2 page, which formerly included
coverage of getrusage(2), has been split, so that the latter is
now covered in its own getrusage.2.  For older details of change
history, etc., see getrlimit.2

Modified 2004-11-16, mtk, Noted that the non-conformance
when SIGCHLD is being ignored is fixed in 2.6.9.