GETRUSAGE(3)               POSIX Programmer's Manual              GETRUSAGE(3)



PROLOG
       This manual page is part of the POSIX Programmer's Manual.  The OS
       implementation of this interface may differ (consult the corresponding
       OS manual page for details of OS behavior), or the interface may not be
       implemented on OS.

NAME
       getrusage -- get information about resource utilization

SYNOPSIS
       #include <sys/resource.h>

       int getrusage(int who, struct rusage *_r__usage);

DESCRIPTION
       The getrusage() function shall provide measures of the resources used
       by the current process or its terminated and waited-for child
       processes. If the value of the who argument is RUSAGE_SELF, information
       shall be returned about resources used by the current process. If the
       value of the who argument is RUSAGE_CHILDREN, information shall be
       returned about resources used by the terminated and waited-for children
       of the current process. If the child is never waited for (for example,
       if the parent has SA_NOCLDWAIT set or sets SIGCHLD to SIG_IGN), the
       resource information for the child process is discarded and not
       included in the resource information provided by getrusage().

       The _r__usage argument is a pointer to an object of type struct rusage in
       which the returned information is stored.

RETURN VALUE
       Upon successful completion, getrusage() shall return 0; otherwise, -1
       shall be returned and errno set to indicate the error.

ERRORS
       The getrusage() function shall fail if:

       EINVAL The value of the who argument is not valid.

       The following sections are informative.

EXAMPLES
   Using getrusage()
       The following example returns information about the resources used by
       the current process.


           #include <sys/resource.h>
           ...
           int who = RUSAGE_SELF;
           struct rusage usage;
           int ret;

           ret = getrusage(who, &usage);

APPLICATION USAGE
       None.

RATIONALE
       None.

FUTURE DIRECTIONS
       None.

SEE ALSO
       exit(), sigaction(), time(), times(), wait()

       The Base Definitions volume of POSIX.1-2017, <sys_resource.h>

COPYRIGHT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1-2017, Standard for Information Technology --
       Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the
       Institute of Electrical and Electronics Engineers, Inc and The Open
       Group.  In the event of any discrepancy between this version and the
       original IEEE and The Open Group Standard, the original IEEE and The
       Open Group Standard is the referee document. The original Standard can
       be obtained online at http://www.opengroup.org/unix/online.html .

       Any typographical or formatting errors that appear in this page are
       most likely to have been introduced during the conversion of the source
       files to man page format. To report such errors, see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .



IEEE/The Open Group                  2017                         GETRUSAGE(3)
