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



PPRROOLLOOGG
       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.

NNAAMMEE
       getrusage -- get information about resource utilization

SSYYNNOOPPSSIISS
       #include <sys/resource.h>

       int getrusage(int _w_h_o, struct rusage *_r___u_s_a_g_e);

DDEESSCCRRIIPPTTIIOONN
       The _g_e_t_r_u_s_a_g_e() 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 _w_h_o argument is RUSAGE_SELF, information
       shall be returned about resources used by the current process. If the
       value of the _w_h_o 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 _g_e_t_r_u_s_a_g_e().

       The _r___u_s_a_g_e argument is a pointer to an object of type ssttrruucctt rruussaaggee in
       which the returned information is stored.

RREETTUURRNN VVAALLUUEE
       Upon successful completion, _g_e_t_r_u_s_a_g_e() shall return 0; otherwise, -1
       shall be returned and _e_r_r_n_o set to indicate the error.

EERRRROORRSS
       The _g_e_t_r_u_s_a_g_e() function shall fail if:

       EEIINNVVAALL The value of the _w_h_o argument is not valid.

       _T_h_e _f_o_l_l_o_w_i_n_g _s_e_c_t_i_o_n_s _a_r_e _i_n_f_o_r_m_a_t_i_v_e_.

EEXXAAMMPPLLEESS
   UUssiinngg ggeettrruussaaggee(())
       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);

AAPPPPLLIICCAATTIIOONN UUSSAAGGEE
       None.

RRAATTIIOONNAALLEE
       None.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       _e_x_i_t(), _s_i_g_a_c_t_i_o_n(), _t_i_m_e(), _t_i_m_e_s(), _w_a_i_t()

       The Base Definitions volume of POSIX.1-2017, <<ssyyss__rreessoouurrccee..hh>>

CCOOPPYYRRIIGGHHTT
       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)
