1GETRUSAGE(P)               POSIX Programmer's Manual              GETRUSAGE(P)
2
3
4

NAME

6       getrusage - get information about resource utilization
7

SYNOPSIS

9       #include <sys/resource.h>
10
11       int getrusage(int who, struct rusage *r_usage);
12
13

DESCRIPTION

15       The  getrusage()  function shall provide measures of the resources used
16       by the current process or its  terminated  and  waited-for  child  pro‐
17       cesses.  If  the  value of the who argument is RUSAGE_SELF, information
18       shall be returned about resources used by the current process.  If  the
19       value  of  the  who  argument  is RUSAGE_CHILDREN, information shall be
20       returned about resources used by the terminated and waited-for children
21       of  the current process. If the child is never waited for (for example,
22       if the parent has SA_NOCLDWAIT set or sets  SIGCHLD  to  SIG_IGN),  the
23       resource  information  for  the  child  process  is  discarded  and not
24       included in the resource information provided by getrusage().
25
26       The r_usage argument is a pointer to an object of type struct rusage in
27       which the returned information is stored.
28

RETURN VALUE

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

ERRORS

34       The getrusage() function shall fail if:
35
36       EINVAL The value of the who argument is not valid.
37
38
39       The following sections are informative.
40

EXAMPLES

42   Using getrusage()
43       The following example returns information about the resources  used  by
44       the current process.
45
46
47              #include <sys/resource.h>
48              ...
49              int who = RUSAGE_SELF;
50              struct rusage usage;
51              int ret;
52
53
54              ret = getrusage(who, &usage);
55

APPLICATION USAGE

57       None.
58

RATIONALE

60       None.
61

FUTURE DIRECTIONS

63       None.
64

SEE ALSO

66       exit() , sigaction() , time() , times() , wait() , the Base Definitions
67       volume of IEEE Std 1003.1-2001, <sys/resource.h>
68

70       Portions of this text are reprinted and reproduced in  electronic  form
71       from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
72       -- Portable Operating System Interface (POSIX),  The  Open  Group  Base
73       Specifications  Issue  6,  Copyright  (C) 2001-2003 by the Institute of
74       Electrical and Electronics Engineers, Inc and The Open  Group.  In  the
75       event of any discrepancy between this version and the original IEEE and
76       The Open Group Standard, the original IEEE and The Open Group  Standard
77       is  the  referee document. The original Standard can be obtained online
78       at http://www.opengroup.org/unix/online.html .
79
80
81
82IEEE/The Open Group                  2003                         GETRUSAGE(P)
Impressum