doc/guide/localhost/ConcurrentML

   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>ConcurrentML</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>ConcurrentML</h1>
  27 </div>
  28 <div id="content">
  29 <div id="preamble">
  30 <div class="sectionbody">
  31 <div class="paragraph"><p><a href="http://cml.cs.uchicago.edu/">Concurrent ML</a> is an SML concurrency
  32 library based on synchronous message passing.  MLton has an initial
  33 port of CML from SML/NJ, but is missing a thread-safe wrapper around
  34 the Basis Library and event-based equivalents to <span class="monospaced">IO</span> and <span class="monospaced">OS</span>
  35 functions.</p></div>
  36 <div class="paragraph"><p>All of the core CML functionality is present.</p></div>
  37 <div class="listingblock">
  38 <div class="content"><div class="highlight"><pre><span class="k">structure</span><span class="w"> </span><span class="n">CML</span><span class="p">:</span><span class="w"> </span><span class="n">CML</span><span class="w"></span>
  39 <span class="k">structure</span><span class="w"> </span><span class="n">SyncVar</span><span class="p">:</span><span class="w"> </span><span class="n">SYNC_VAR</span><span class="w"></span>
  40 <span class="k">structure</span><span class="w"> </span><span class="n">Mailbox</span><span class="p">:</span><span class="w"> </span><span class="n">MAILBOX</span><span class="w"></span>
  41 <span class="k">structure</span><span class="w"> </span><span class="n">Multicast</span><span class="p">:</span><span class="w"> </span><span class="n">MULTICAST</span><span class="w"></span>
  42 <span class="k">structure</span><span class="w"> </span><span class="n">SimpleRPC</span><span class="p">:</span><span class="w"> </span><span class="n">SIMPLE_RPC</span><span class="w"></span>
  43 <span class="k">structure</span><span class="w"> </span><span class="n">RunCML</span><span class="p">:</span><span class="w"> </span><span class="n">RUN_CML</span><span class="w"></span>
  44 </pre></div></div></div>
  45 <div class="paragraph"><p>The <span class="monospaced">RUN_CML</span> signature is minimal.</p></div>
  46 <div class="listingblock">
  47 <div class="content"><div class="highlight"><pre><span class="k">signature</span><span class="w"> </span><span class="n">RUN_CML</span><span class="w"> </span><span class="p">=</span><span class="w"></span>
  48 <span class="w">   </span><span class="k">sig</span><span class="w"></span>
  49 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">isRunning</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">bool</span><span class="w"></span>
  50 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">doit</span><span class="p">:</span><span class="w"> </span><span class="p">(</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="p">)</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">Time</span><span class="p">.</span><span class="n">time</span><span class="w"> </span><span class="n">option</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">OS</span><span class="p">.</span><span class="n">Process</span><span class="p">.</span><span class="n">status</span><span class="w"></span>
  51 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">shutdown</span><span class="p">:</span><span class="w"> </span><span class="n">OS</span><span class="p">.</span><span class="n">Process</span><span class="p">.</span><span class="n">status</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">&#39;a</span><span class="w"></span>
  52 <span class="w">   </span><span class="k">end</span><span class="w"></span>
  53 </pre></div></div></div>
  54 <div class="paragraph"><p>MLton&#8217;s <span class="monospaced">RunCML</span> structure does not include all of the cleanup and
  55 logging operations of SML/NJ&#8217;s <span class="monospaced">RunCML</span> structure.  However, the
  56 implementation does include the <span class="monospaced">CML.timeOutEvt</span> and <span class="monospaced">CML.atTimeEvt</span>
  57 functions, and a preemptive scheduler that knows to sleep when there
  58 are no ready threads and some threads blocked on time events.</p></div>
  59 <div class="paragraph"><p>Because MLton does not wrap the Basis Library for CML, the "right" way
  60 to call a Basis Library function that is stateful is to wrap the call
  61 with <span class="monospaced">MLton.Thread.atomically</span>.</p></div>
  62 </div>
  63 </div>
  64 <div class="sect1">
  65 <h2 id="_usage">Usage</h2>
  66 <div class="sectionbody">
  67 <div class="ulist"><ul>
  68 <li>
  69 <p>
  70 You can import the CML Library into an MLB file with:
  71 </p>
  72 <table class="tableblock frame-all grid-all"
  73 style="
  74 width:100%;
  75 ">
  76 <col style="width:50%;">
  77 <col style="width:50%;">
  78 <thead>
  79 <tr>
  80 <th class="tableblock halign-left valign-top" >MLB file</th>
  81 <th class="tableblock halign-left valign-top" >Description</th>
  82 </tr>
  83 </thead>
  84 <tbody>
  85 <tr>
  86 <td class="tableblock halign-left valign-top" ><p class="tableblock"><span class="monospaced">$(SML_LIB)/cml/cml.mlb</span></p></td>
  87 <td class="tableblock halign-left valign-top" ><p class="tableblock"></p></td>
  88 </tr>
  89 </tbody>
  90 </table>
  91 </li>
  92 <li>
  93 <p>
  94 If you are porting a project from SML/NJ&#8217;s <a href="CompilationManager">CompilationManager</a> to
  95 MLton&#8217;s <a href="MLBasis"> ML Basis system</a> using <span class="monospaced">cm2mlb</span>, note that the
  96 following map is included by default:
  97 </p>
  98 <div class="listingblock">
  99 <div class="content monospaced">
 100 <pre># CML Library
 101 $cml                                    $(SML_LIB)/cml
 102 $cml/cml.cm                             $(SML_LIB)/cml/cml.mlb</pre>
 103 </div></div>
 104 <div class="paragraph"><p>This will automatically convert a <span class="monospaced">$cml/cml.cm</span> import in an input <span class="monospaced">.cm</span> file into a <span class="monospaced">$(SML_LIB)/cml/cml.mlb</span> import in the output <span class="monospaced">.mlb</span> file.</p></div>
 105 </li>
 106 </ul></div>
 107 </div>
 108 </div>
 109 <div class="sect1">
 110 <h2 id="_also_see">Also see</h2>
 111 <div class="sectionbody">
 112 <div class="ulist"><ul>
 113 <li>
 114 <p>
 115 <a href="ConcurrentMLImplementation">ConcurrentMLImplementation</a>
 116 </p>
 117 </li>
 118 <li>
 119 <p>
 120 <a href="eXene">eXene</a>
 121 </p>
 122 </li>
 123 </ul></div>
 124 </div>
 125 </div>
 126 </div>
 127 <div id="footnotes"><hr></div>
 128 <div id="footer">
 129 <div id="footer-text">
 130 </div>
 131 <div id="footer-badges">
 132 </div>
 133 </div>
 134 </body>
 135 </html>