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