getrusage()

getrusage() — Gets the current resource usages.

Built-in function of PHP 8.5. The manual lists it as available in PHP 4, PHP 5, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.

What it does

This is an interface to getrusage(2). It gets data returned from the system call.

Signature

getrusage(int $mode = 0): array|false

Parameters

Return value

Returns an associative array containing the data returned from the system call. All entries are accessible by using their documented field names. Returns false on failure.

Example

A runnable snippet:

$dat = getrusage(); echo $dat["ru_oublock"]; // number of block output operations echo $dat["ru_inblock"]; // number of block input operations echo $dat["ru_msgsnd"]; // number of IPC messages sent echo $dat["ru_msgrcv"]; // number of IPC messages received echo $dat["ru_maxrss"]; // maximum resident set size echo $dat["ru_ixrss"]; // integral shared memory size echo $dat["ru_idrss"]; // integral unshared data size echo $dat["ru_minflt"]; // number of page reclaims (soft page faults) echo $dat["ru_majflt"]; // number of page faults (hard page faults) echo $dat["ru_nsignals"]; // number of signals received echo $dat["ru_nvcsw"]; // number of voluntary context switches echo $dat["ru_nivcsw"]; // number of involuntary context switches echo $dat["ru_nswap"]; // number of swaps echo $dat["ru_utime.tv_usec"]; // user time used (microseconds) echo $dat["ru_utime.tv_sec"]; // user time used (seconds) echo $dat["ru_stime.tv_usec"]; // system time used (microseconds) echo $dat["ru_stime.tv_sec"]; // system time used (seconds)

All PHP 8.5 built-in functions

Reference card built from the PHP manual page getrusage() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.