doc/guide/localhost/MLtonGC

   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>MLtonGC</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>MLtonGC</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_GC</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">val</span><span class="w"> </span><span class="n">collect</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="n">unit</span><span class="w"></span>
  35 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">pack</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="n">unit</span><span class="w"></span>
  36 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">setMessages</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>
  37 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">setSummary</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">unpack</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="n">unit</span><span class="w"></span>
  39 <span class="w">      </span><span class="k">structure</span><span class="w"> </span><span class="n">Statistics</span><span class="w"> </span><span class="p">:</span><span class="w"></span>
  40 <span class="w">         </span><span class="k">sig</span><span class="w"></span>
  41 <span class="w">            </span><span class="k">val</span><span class="w"> </span><span class="n">bytesAllocated</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="n">IntInf</span><span class="p">.</span><span class="n">int</span><span class="w"></span>
  42 <span class="w">            </span><span class="k">val</span><span class="w"> </span><span class="n">lastBytesLive</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="n">IntInf</span><span class="p">.</span><span class="n">int</span><span class="w"></span>
  43 <span class="w">            </span><span class="k">val</span><span class="w"> </span><span class="n">numCopyingGCs</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="n">IntInf</span><span class="p">.</span><span class="n">int</span><span class="w"></span>
  44 <span class="w">            </span><span class="k">val</span><span class="w"> </span><span class="n">numMarkCompactGCs</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="n">IntInf</span><span class="p">.</span><span class="n">int</span><span class="w"></span>
  45 <span class="w">            </span><span class="k">val</span><span class="w"> </span><span class="n">numMinorGCs</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="n">IntInf</span><span class="p">.</span><span class="n">int</span><span class="w"></span>
  46 <span class="w">            </span><span class="k">val</span><span class="w"> </span><span class="n">maxBytesLive</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="n">IntInf</span><span class="p">.</span><span class="n">int</span><span class="w"></span>
  47 <span class="w">         </span><span class="k">end</span><span class="w"></span>
  48 <span class="w">   </span><span class="k">end</span><span class="w"></span>
  49 </pre></div></div></div>
  50 <div class="ulist"><ul>
  51 <li>
  52 <p>
  53 <span class="monospaced">collect ()</span>
  54 </p>
  55 <div class="paragraph"><p>causes a garbage collection to occur.</p></div>
  56 </li>
  57 <li>
  58 <p>
  59 <span class="monospaced">pack ()</span>
  60 </p>
  61 <div class="paragraph"><p>shrinks the heap as much as possible so that other processes can use
  62 available RAM.</p></div>
  63 </li>
  64 <li>
  65 <p>
  66 <span class="monospaced">setMessages b</span>
  67 </p>
  68 <div class="paragraph"><p>controls whether diagnostic messages are printed at the beginning and
  69 end of each garbage collection.  It is the same as the <span class="monospaced">gc-messages</span>
  70 runtime system option.</p></div>
  71 </li>
  72 <li>
  73 <p>
  74 <span class="monospaced">setSummary b</span>
  75 </p>
  76 <div class="paragraph"><p>controls whether a summary of garbage collection statistics is printed
  77 upon termination of the program.  It is the same as the <span class="monospaced">gc-summary</span>
  78 runtime system option.</p></div>
  79 </li>
  80 <li>
  81 <p>
  82 <span class="monospaced">unpack ()</span>
  83 </p>
  84 <div class="paragraph"><p>resizes a packed heap to the size desired by the runtime.</p></div>
  85 </li>
  86 <li>
  87 <p>
  88 <span class="monospaced">Statistics.bytesAllocated ()</span>
  89 </p>
  90 <div class="paragraph"><p>returns bytes allocated (as of the most recent garbage collection).</p></div>
  91 </li>
  92 <li>
  93 <p>
  94 <span class="monospaced">Statistics.lastBytesLive ()</span>
  95 </p>
  96 <div class="paragraph"><p>returns bytes live (as of the most recent garbage collection).</p></div>
  97 </li>
  98 <li>
  99 <p>
 100 <span class="monospaced">Statistics.numCopyingGCs ()</span>
 101 </p>
 102 <div class="paragraph"><p>returns number of (major) copying garbage collections performed (as of
 103 the most recent garbage collection).</p></div>
 104 </li>
 105 <li>
 106 <p>
 107 <span class="monospaced">Statistics.numMarkCompactGCs ()</span>
 108 </p>
 109 <div class="paragraph"><p>returns number of (major) mark-compact garbage collections performed
 110 (as of the most recent garbage collection).</p></div>
 111 </li>
 112 <li>
 113 <p>
 114 <span class="monospaced">Statistics.numMinorGCs ()</span>
 115 </p>
 116 <div class="paragraph"><p>returns number of minor garbage collections performed (as of the most
 117 recent garbage collection).</p></div>
 118 </li>
 119 <li>
 120 <p>
 121 <span class="monospaced">Statistics.maxBytesLive ()</span>
 122 </p>
 123 <div class="paragraph"><p>returns maximum bytes live (as of the most recent garbage collection).</p></div>
 124 </li>
 125 </ul></div>
 126 </div>
 127 </div>
 128 </div>
 129 <div id="footnotes"><hr></div>
 130 <div id="footer">
 131 <div id="footer-text">
 132 </div>
 133 <div id="footer-badges">
 134 </div>
 135 </div>
 136 </body>
 137 </html>