Import Upstream version 20180207
[hcoop/debian/mlton.git] / doc / guide / localhost / MLtonRlimit
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>MLtonRlimit</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>MLtonRlimit</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_RLIMIT</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">structure</span><span class="w"> </span><span class="n">RLim</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="k">sig</span><span class="w"></span>\r
35<span class="w"> </span><span class="k">type</span><span class="w"> </span><span class="n">t</span><span class="w"></span>\r
36<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">castFromSysWord</span><span class="p">:</span><span class="w"> </span><span class="n">SysWord</span><span class="p">.</span><span class="n">word</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">t</span><span class="w"></span>\r
37<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">castToSysWord</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">SysWord</span><span class="p">.</span><span class="n">word</span><span class="w"></span>\r
38<span class="w"> </span><span class="k">end</span><span class="w"></span>\r
39\r
40<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">infinity</span><span class="p">:</span><span class="w"> </span><span class="n">RLim</span><span class="p">.</span><span class="n">t</span><span class="w"></span>\r
41\r
42<span class="w"> </span><span class="k">type</span><span class="w"> </span><span class="n">t</span><span class="w"></span>\r
43\r
44<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">coreFileSize</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="cm">(* CORE max core file size *)</span><span class="w"></span>\r
45<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">cpuTime</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="cm">(* CPU CPU time in seconds *)</span><span class="w"></span>\r
46<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">dataSize</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="cm">(* DATA max data size *)</span><span class="w"></span>\r
47<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">fileSize</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="cm">(* FSIZE Maximum filesize *)</span><span class="w"></span>\r
48<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">numFiles</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="cm">(* NOFILE max number of open files *)</span><span class="w"></span>\r
49<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">lockedInMemorySize</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="cm">(* MEMLOCK max locked address space *)</span><span class="w"></span>\r
50<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">numProcesses</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="cm">(* NPROC max number of processes *)</span><span class="w"></span>\r
51<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">residentSetSize</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="cm">(* RSS max resident set size *)</span><span class="w"></span>\r
52<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">stackSize</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="cm">(* STACK max stack size *)</span><span class="w"></span>\r
53<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">virtualMemorySize</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="cm">(* AS virtual memory limit *)</span><span class="w"></span>\r
54\r
55<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">get</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="p">{</span><span class="n">hard</span><span class="p">:</span><span class="w"> </span><span class="n">rlim</span><span class="p">,</span><span class="w"> </span><span class="n">soft</span><span class="p">:</span><span class="w"> </span><span class="n">rlim</span><span class="p">}</span><span class="w"></span>\r
56<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">set</span><span class="p">:</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="p">{</span><span class="n">hard</span><span class="p">:</span><span class="w"> </span><span class="n">rlim</span><span class="p">,</span><span class="w"> </span><span class="n">soft</span><span class="p">:</span><span class="w"> </span><span class="n">rlim</span><span class="p">}</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">unit</span><span class="w"></span>\r
57<span class="w"> </span><span class="k">end</span><span class="w"></span>\r
58</pre></div></div></div>\r
59<div class="paragraph"><p><span class="monospaced">MLton.Rlimit</span> provides a wrapper around the C <span class="monospaced">getrlimit</span> and\r
60<span class="monospaced">setrlimit</span> functions.</p></div>\r
61<div class="ulist"><ul>\r
62<li>\r
63<p>\r
64<span class="monospaced">type Rlim.t</span>\r
65</p>\r
66<div class="paragraph"><p>the type of resource limits.</p></div>\r
67</li>\r
68<li>\r
69<p>\r
70<span class="monospaced">infinity</span>\r
71</p>\r
72<div class="paragraph"><p>indicates that a resource is unlimited.</p></div>\r
73</li>\r
74<li>\r
75<p>\r
76<span class="monospaced">type t</span>\r
77</p>\r
78<div class="paragraph"><p>the types of resources that can be inspected and modified.</p></div>\r
79</li>\r
80<li>\r
81<p>\r
82<span class="monospaced">get r</span>\r
83</p>\r
84<div class="paragraph"><p>returns the current hard and soft limits for resource <span class="monospaced">r</span>. May raise\r
85<span class="monospaced">OS.SysErr</span>.</p></div>\r
86</li>\r
87<li>\r
88<p>\r
89<span class="monospaced">set (r, {hard, soft})</span>\r
90</p>\r
91<div class="paragraph"><p>sets the hard and soft limits for resource <span class="monospaced">r</span>. May raise\r
92<span class="monospaced">OS.SysErr</span>.</p></div>\r
93</li>\r
94</ul></div>\r
95</div>\r
96</div>\r
97</div>\r
98<div id="footnotes"><hr></div>\r
99<div id="footer">\r
100<div id="footer-text">\r
101</div>\r
102<div id="footer-badges">\r
103</div>\r
104</div>\r
105</body>\r
106</html>\r