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