4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <meta name="generator" content="AsciiDoc 8.6.9">
7 <link rel="stylesheet" href="./asciidoc.css" type="text/css">
8 <link rel="stylesheet" href="./pygments.css" type="text/css">
11 <script type="text/javascript" src="./asciidoc.js"></script>
12 <script type="text/javascript">
17 <link rel="stylesheet" href="./mlton.css" type="text/css">
19 <body class="article">
21 <div id="banner-home">
22 <a href="./Home">MLton 20180207</a>
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">-></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">-></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">-></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">-></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">-></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">-></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">-></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">-></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">-></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">-></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">-></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>
53 <span class="monospaced">collect ()</span>
55 <div class="paragraph"><p>causes a garbage collection to occur.</p></div>
59 <span class="monospaced">pack ()</span>
61 <div class="paragraph"><p>shrinks the heap as much as possible so that other processes can use
62 available RAM.</p></div>
66 <span class="monospaced">setMessages b</span>
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>
74 <span class="monospaced">setSummary b</span>
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>
82 <span class="monospaced">unpack ()</span>
84 <div class="paragraph"><p>resizes a packed heap to the size desired by the runtime.</p></div>
88 <span class="monospaced">Statistics.bytesAllocated ()</span>
90 <div class="paragraph"><p>returns bytes allocated (as of the most recent garbage collection).</p></div>
94 <span class="monospaced">Statistics.lastBytesLive ()</span>
96 <div class="paragraph"><p>returns bytes live (as of the most recent garbage collection).</p></div>
100 <span class="monospaced">Statistics.numCopyingGCs ()</span>
102 <div class="paragraph"><p>returns number of (major) copying garbage collections performed (as of
103 the most recent garbage collection).</p></div>
107 <span class="monospaced">Statistics.numMarkCompactGCs ()</span>
109 <div class="paragraph"><p>returns number of (major) mark-compact garbage collections performed
110 (as of the most recent garbage collection).</p></div>
114 <span class="monospaced">Statistics.numMinorGCs ()</span>
116 <div class="paragraph"><p>returns number of minor garbage collections performed (as of the most
117 recent garbage collection).</p></div>
121 <span class="monospaced">Statistics.maxBytesLive ()</span>
123 <div class="paragraph"><p>returns maximum bytes live (as of the most recent garbage collection).</p></div>
129 <div id="footnotes"><hr></div>
131 <div id="footer-text">
133 <div id="footer-badges">