doc/guide/localhost/MLtonRusage

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <meta name="generator" content="AsciiDoc 8.6.9">
   6 <title>MLtonRusage</title>
   7 <link rel="stylesheet" href="./asciidoc.css" type="text/css">
   8 <link rel="stylesheet" href="./pygments.css" type="text/css">
   9
  10
  11 <script type="text/javascript" src="./asciidoc.js"></script>
  12 <script type="text/javascript">
  13 /*<![CDATA[*/
  14 asciidoc.install();
  15 /*]]>*/
  16 </script>
  17 <link rel="stylesheet" href="./mlton.css" type="text/css">
  18 </head>
  19 <body class="article">
  20 <div id="banner">
  21 <div id="banner-home">
  22 <a href="./Home">MLton 20180207</a>
  23 </div>
  24 </div>
  25 <div id="header">
  26 <h1>MLtonRusage</h1>
  27 </div>
  28 <div id="content">
  29 <div id="preamble">
  30 <div class="sectionbody">
  31 <div class="listingblock">
  32 <div class="content"><div class="highlight"><pre><span class="k">signature</span><span class="w"> </span><span class="n">MLTON_RUSAGE</span><span class="w"> </span><span class="p">=</span><span class="w"></span>
  33 <span class="w">   </span><span class="k">sig</span><span class="w"></span>
  34 <span class="w">      </span><span class="k">type</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="p">{</span><span class="n">utime</span><span class="p">:</span><span class="w"> </span><span class="n">Time</span><span class="p">.</span><span class="n">time</span><span class="p">,</span><span class="w"> </span><span class="cm">(* user time *)</span><span class="w"></span>
  35 <span class="w">                </span><span class="n">stime</span><span class="p">:</span><span class="w"> </span><span class="n">Time</span><span class="p">.</span><span class="n">time</span><span class="p">}</span><span class="w"> </span><span class="cm">(* system time *)</span><span class="w"></span>
  36
  37 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">measureGC</span><span class="p">:</span><span class="w"> </span><span class="n">bool</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">unit</span><span class="w"></span>
  38 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">rusage</span><span class="p">:</span><span class="w"> </span><span class="n">unit</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="p">{</span><span class="n">children</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="p">,</span><span class="w"> </span><span class="n">gc</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="p">,</span><span class="w"> </span><span class="n">self</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="p">}</span><span class="w"></span>
  39 <span class="w">   </span><span class="k">end</span><span class="w"></span>
  40 </pre></div></div></div>
  41 <div class="ulist"><ul>
  42 <li>
  43 <p>
  44 <span class="monospaced">type t</span>
  45 </p>
  46 <div class="paragraph"><p>corresponds to a subset of the C <span class="monospaced">struct rusage</span>.</p></div>
  47 </li>
  48 <li>
  49 <p>
  50 <span class="monospaced">measureGC b</span>
  51 </p>
  52 <div class="paragraph"><p>controls whether garbage collection time is separately measured during
  53 program execution.  This affects the behavior of both <span class="monospaced">rusage</span> and
  54 <span class="monospaced">Timer.checkCPUTimes</span>, both of which will return gc times of zero with
  55 <span class="monospaced">measureGC false</span>.  Garbage collection time is always measured when
  56 either <span class="monospaced">gc-messages</span> or <span class="monospaced">gc-summary</span> is given as a
  57 <a href="RunTimeOptions">runtime system option</a>.</p></div>
  58 </li>
  59 <li>
  60 <p>
  61 <span class="monospaced">rusage ()</span>
  62 </p>
  63 <div class="paragraph"><p>corresponds to the C <span class="monospaced">getrusage</span> function.  It returns the resource
  64 usage of the exited children, the garbage collector, and the process
  65 itself.  The <span class="monospaced">self</span> component includes the usage of the <span class="monospaced">gc</span>
  66 component, regardless of whether <span class="monospaced">measureGC</span> is <span class="monospaced">true</span> or <span class="monospaced">false</span>.  If
  67 <span class="monospaced">rusage</span> is used in a program, either directly, or indirectly via the
  68 <span class="monospaced">Timer</span> structure, then <span class="monospaced">measureGC true</span> is automatically called at
  69 the start of the program (it can still be disable by user code later).</p></div>
  70 </li>
  71 </ul></div>
  72 </div>
  73 </div>
  74 </div>
  75 <div id="footnotes"><hr></div>
  76 <div id="footer">
  77 <div id="footer-text">
  78 </div>
  79 <div id="footer-badges">
  80 </div>
  81 </div>
  82 </body>
  83 </html>