<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Gets the current resource usages</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.getopt.html">getopt</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.ini-alter.html">ini_alter</a></div> <div class="up"><a href="ref.info.html">PHP Options/Info Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.getrusage" class="refentry"> <div class="refnamediv"> <h1 class="refname">getrusage</h1> <p class="verinfo">(PHP 4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">getrusage</span> — <span class="dc-title">Gets the current resource usages</span></p> </div> <div class="refsect1 description" id="refsect1-function.getrusage-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">array</span> <span class="methodname"><strong>getrusage</strong></span> ([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$who</code><span class="initializer"> = 0</span></span> ] )</div> <p class="para rdfs-comment"> This is an interface to <strong class="command">getrusage(2)</strong>. It gets data returned from the system call. </p> </div> <div class="refsect1 parameters" id="refsect1-function.getrusage-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <code class="parameter">who</code></dt> <dd> <p class="para"> If <code class="parameter">who</code> is 1, getrusage will be called with <strong><code>RUSAGE_CHILDREN</code></strong>. </p> </dd> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.getrusage-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns an associative array containing the data returned from the system call. All entries are accessible by using their documented field names. </p> </div> <div class="refsect1 examples" id="refsect1-function.getrusage-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-545"> <p><strong>Example #1 <span class="function"><strong>getrusage()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$dat </span><span style="color: #007700">= </span><span style="color: #0000BB">getrusage</span><span style="color: #007700">();<br />echo </span><span style="color: #0000BB">$dat</span><span style="color: #007700">[</span><span style="color: #DD0000">"ru_oublock"</span><span style="color: #007700">]; </span><span style="color: #FF8000">// number of block output operations<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">$dat</span><span style="color: #007700">[</span><span style="color: #DD0000">"ru_inblock"</span><span style="color: #007700">]; </span><span style="color: #FF8000">// number of block input operations<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">$dat</span><span style="color: #007700">[</span><span style="color: #DD0000">"ru_msgsnd"</span><span style="color: #007700">]; </span><span style="color: #FF8000">// number of IPC messages sent<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">$dat</span><span style="color: #007700">[</span><span style="color: #DD0000">"ru_msgrcv"</span><span style="color: #007700">]; </span><span style="color: #FF8000">// number of IPC messages received<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">$dat</span><span style="color: #007700">[</span><span style="color: #DD0000">"ru_maxrss"</span><span style="color: #007700">]; </span><span style="color: #FF8000">// maximum resident set size<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">$dat</span><span style="color: #007700">[</span><span style="color: #DD0000">"ru_ixrss"</span><span style="color: #007700">]; </span><span style="color: #FF8000">// integral shared memory size<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">$dat</span><span style="color: #007700">[</span><span style="color: #DD0000">"ru_idrss"</span><span style="color: #007700">]; </span><span style="color: #FF8000">// integral unshared data size<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">$dat</span><span style="color: #007700">[</span><span style="color: #DD0000">"ru_minflt"</span><span style="color: #007700">]; </span><span style="color: #FF8000">// number of page reclaims (soft page faults)<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">$dat</span><span style="color: #007700">[</span><span style="color: #DD0000">"ru_majflt"</span><span style="color: #007700">]; </span><span style="color: #FF8000">// number of page faults (hard page faults)<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">$dat</span><span style="color: #007700">[</span><span style="color: #DD0000">"ru_nsignals"</span><span style="color: #007700">]; </span><span style="color: #FF8000">// number of signals received<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">$dat</span><span style="color: #007700">[</span><span style="color: #DD0000">"ru_nvcsw"</span><span style="color: #007700">]; </span><span style="color: #FF8000">// number of voluntary context switches<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">$dat</span><span style="color: #007700">[</span><span style="color: #DD0000">"ru_nivcsw"</span><span style="color: #007700">]; </span><span style="color: #FF8000">// number of involuntary context switches<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">$dat</span><span style="color: #007700">[</span><span style="color: #DD0000">"ru_nswap"</span><span style="color: #007700">]; </span><span style="color: #FF8000">// number of swaps<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">$dat</span><span style="color: #007700">[</span><span style="color: #DD0000">"ru_utime.tv_usec"</span><span style="color: #007700">]; </span><span style="color: #FF8000">// user time used (microseconds)<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">$dat</span><span style="color: #007700">[</span><span style="color: #DD0000">"ru_utime.tv_sec"</span><span style="color: #007700">]; </span><span style="color: #FF8000">// user time used (seconds)<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">$dat</span><span style="color: #007700">[</span><span style="color: #DD0000">"ru_stime.tv_usec"</span><span style="color: #007700">]; </span><span style="color: #FF8000">// system time used (microseconds)<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 changelog" id="refsect1-function.getrusage-changelog"> <h3 class="title">Changelog</h3> <p class="para"> <table class="doctable informaltable"> <thead> <tr> <th>Version</th> <th>Description</th> </tr> </thead> <tbody class="tbody"> <tr> <td>7.0.0</td> <td> This function is now supported on Windows. </td> </tr> </tbody> </table> </p> </div> <div class="refsect1 notes" id="refsect1-function.getrusage-notes"> <h3 class="title">Notes</h3> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> On Windows <span class="function"><strong>getrusage()</strong></span> will only return the following members: </p> <p class="para"> <ul class="simplelist"> <li class="member"><em>"ru_stime.tv_sec"</em></li> <li class="member"><em>"ru_stime.tv_usec"</em></li> <li class="member"><em>"ru_utime.tv_sec"</em></li> <li class="member"><em>"ru_utime.tv_usec"</em></li> <li class="member"> <em>"ru_majflt"</em> (only if <code class="parameter">who</code> is <strong><code>RUSAGE_SELF</code></strong>) </li> <li class="member"> <em>"ru_maxrss"</em> (only if <code class="parameter">who</code> is <strong><code>RUSAGE_SELF</code></strong>) </li> </ul> </p> <p class="para"> If <span class="function"><strong>getrusage()</strong></span> is called with <code class="parameter">who</code> set to <em>1</em> (<strong><code>RUSAGE_CHILDREN</code></strong>), then resource usage for threads are collected (meaning that internally the function is called with <strong><code>RUSAGE_THREAD</code></strong>). </p> </p></blockquote> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> on BeOS 2000, only the following members are returned: </p> <p class="para"> <ul class="simplelist"> <li class="member"><em>"ru_stime.tv_sec"</em></li> <li class="member"><em>"ru_stime.tv_usec"</em></li> <li class="member"><em>"ru_utime.tv_sec"</em></li> <li class="member"><em>"ru_utime.tv_usec"</em></li> </ul> </p> </p></blockquote> </div> <div class="refsect1 seealso" id="refsect1-function.getrusage-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member">Your system's man page on <strong class="command">getrusage(2)</strong></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.getopt.html">getopt</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.ini-alter.html">ini_alter</a></div> <div class="up"><a href="ref.info.html">PHP Options/Info Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>