GETRUSAGE(3POSIX)

πŸ’– getrusage(3POSIX) β€” the resource-utilization bestie πŸ’–

okay so real talk: this page lives in the POSIX Programmer's Manual (that's the 3POSIX part, bestie, iykyk ✨).

⚠️ PROLOG β€” pls read this first, it's important!! 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 ✨

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. yes bestie it's literally the receipt for your CPU time 🧾✨

If the value of the who argument is RUSAGE_SELF, information shall be returned about resources used by the current process. πŸͺž (that's you!! main character energy fr)

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. πŸ‘Ά

πŸ’€ BUT WAIT β€” 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(). it's giving "you didn't wait for me so now the data's gone" 😭

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. 🚫 (like bestie that's not a real who, stop it)

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

look at her go, so clean, so iconic ✨


πŸ’œ APPLICATION USAGE πŸ’œ

None.

(yeah that's it. nothing. the void. 🫧)


🧚 RATIONALE 🧚

None.


⭐ FUTURE DIRECTIONS ⭐

None.


πŸ”₯ SEE ALSO πŸ”₯

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

The Base Definitions volume of POSIX.1‐2017, <sys_resource.h> πŸ“š


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 .


and that's the whole page bestie!! brought to you by IEEE/The Open Group, 2017 β€” yeah, the GETRUSAGE(3POSIX) era, we love a vintage queen πŸ’…πŸŽ€