doc/guide/localhost/MLtonRlimit

   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>MLtonRlimit</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>MLtonRlimit</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_RLIMIT</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">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>
  35 <span class="w">                          </span><span class="k">type</span><span class="w"> </span><span class="n">t</span><span class="w"></span>
  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>
  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>
  38 <span class="w">                       </span><span class="k">end</span><span class="w"></span>
  39
  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>
  41
  42 <span class="w">      </span><span class="k">type</span><span class="w"> </span><span class="n">t</span><span class="w"></span>
  43
  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>
  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>
  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>
  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>
  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>
  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>
  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>
  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>
  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>
  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>
  54
  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>
  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>
  57 <span class="w">   </span><span class="k">end</span><span class="w"></span>
  58 </pre></div></div></div>
  59 <div class="paragraph"><p><span class="monospaced">MLton.Rlimit</span> provides a wrapper around the C <span class="monospaced">getrlimit</span> and
  60 <span class="monospaced">setrlimit</span> functions.</p></div>
  61 <div class="ulist"><ul>
  62 <li>
  63 <p>
  64 <span class="monospaced">type Rlim.t</span>
  65 </p>
  66 <div class="paragraph"><p>the type of resource limits.</p></div>
  67 </li>
  68 <li>
  69 <p>
  70 <span class="monospaced">infinity</span>
  71 </p>
  72 <div class="paragraph"><p>indicates that a resource is unlimited.</p></div>
  73 </li>
  74 <li>
  75 <p>
  76 <span class="monospaced">type t</span>
  77 </p>
  78 <div class="paragraph"><p>the types of resources that can be inspected and modified.</p></div>
  79 </li>
  80 <li>
  81 <p>
  82 <span class="monospaced">get r</span>
  83 </p>
  84 <div class="paragraph"><p>returns the current hard and soft limits for resource <span class="monospaced">r</span>. May raise
  85 <span class="monospaced">OS.SysErr</span>.</p></div>
  86 </li>
  87 <li>
  88 <p>
  89 <span class="monospaced">set (r, {hard, soft})</span>
  90 </p>
  91 <div class="paragraph"><p>sets the hard and soft limits for resource <span class="monospaced">r</span>.  May raise
  92 <span class="monospaced">OS.SysErr</span>.</p></div>
  93 </li>
  94 </ul></div>
  95 </div>
  96 </div>
  97 </div>
  98 <div id="footnotes"><hr></div>
  99 <div id="footer">
 100 <div id="footer-text">
 101 </div>
 102 <div id="footer-badges">
 103 </div>
 104 </div>
 105 </body>
 106 </html>