PROLOG | NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | EXAMPLES | APPLICATION USAGE | RATIONALE | FUTURE DIRECTIONS | SEE ALSO | COPYRIGHT

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

PROLOG         top

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

NAME         top

       getrusage — get information about resource utilization

SYNOPSIS         top

       #include <sys/resource.h>

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

DESCRIPTION         top

       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         top

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

ERRORS         top

       The getrusage() function shall fail if:

       EINVAL The value of the who argument is not valid.

       The following sections are informative.

EXAMPLES         top

   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         top

       None.

RATIONALE         top

       None.

FUTURE DIRECTIONS         top

       None.

SEE ALSO         top

       exit(3p), sigaction(3p), time(3p), times(3p), wait(3p)

       The Base Definitions volume of POSIX.1‐2008, sys_resource.h(0p)

COPYRIGHT         top

       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1, 2013 Edition, Standard for Information
       Technology -- Portable Operating System Interface (POSIX), The Open
       Group Base Specifications Issue 7, Copyright (C) 2013 by the
       Institute of Electrical and Electronics Engineers, Inc and The Open
       Group.  (This is POSIX.1-2008 with the 2013 Technical Corrigendum 1
       applied.) 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.unix.org/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                 2013                       GETRUSAGE(3P)