HCoop / hcoop / debian / mlton.git / blame
| Commit | Line | Data |
|---|---|---|
| 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>MLtonWorld</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 | |
| 14 | asciidoc.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>MLtonWorld</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_WORLD</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">datatype</span><span class="w"> </span><span class="n">status</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">Clone</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">Original</span><span class="w"></span>\r | |
| 35 | \r | |
| 36 | <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">load</span><span class="p">:</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="p">-></span><span class="w"> </span><span class="n">'a</span><span class="w"></span>\r | |
| 37 | <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">save</span><span class="p">:</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="p">-></span><span class="w"> </span><span class="n">status</span><span class="w"></span>\r | |
| 38 | <span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">saveThread</span><span class="p">:</span><span class="w"> </span><span class="n">string</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">Thread</span><span class="p">.</span><span class="n">Runnable</span><span class="p">.</span><span class="n">t</span><span class="w"> </span><span class="p">-></span><span class="w"> </span><span class="n">unit</span><span class="w"></span>\r | |
| 39 | <span class="w"> </span><span class="k">end</span><span class="w"></span>\r | |
| 40 | </pre></div></div></div>\r | |
| 41 | <div class="ulist"><ul>\r | |
| 42 | <li>\r | |
| 43 | <p>\r | |
| 44 | <span class="monospaced">datatype status</span>\r | |
| 45 | </p>\r | |
| 46 | <div class="paragraph"><p>specifies whether a world is original or restarted (a clone).</p></div>\r | |
| 47 | </li>\r | |
| 48 | <li>\r | |
| 49 | <p>\r | |
| 50 | <span class="monospaced">load f</span>\r | |
| 51 | </p>\r | |
| 52 | <div class="paragraph"><p>loads the saved computation from file <span class="monospaced">f</span>.</p></div>\r | |
| 53 | </li>\r | |
| 54 | <li>\r | |
| 55 | <p>\r | |
| 56 | <span class="monospaced">save f</span>\r | |
| 57 | </p>\r | |
| 58 | <div class="paragraph"><p>saves the entire state of the computation to the file <span class="monospaced">f</span>. The\r | |
| 59 | computation can then be restarted at a later time using <span class="monospaced">World.load</span>\r | |
| 60 | or the <span class="monospaced">load-world</span> <a href="RunTimeOptions">runtime option</a>. The call to\r | |
| 61 | <span class="monospaced">save</span> in the original computation returns <span class="monospaced">Original</span> and the call in\r | |
| 62 | the restarted world returns <span class="monospaced">Clone</span>.</p></div>\r | |
| 63 | </li>\r | |
| 64 | <li>\r | |
| 65 | <p>\r | |
| 66 | <span class="monospaced">saveThread (f, rt)</span>\r | |
| 67 | </p>\r | |
| 68 | <div class="paragraph"><p>saves the entire state of the computation to the file <span class="monospaced">f</span> that will\r | |
| 69 | resume with thread <span class="monospaced">rt</span> upon restart.</p></div>\r | |
| 70 | </li>\r | |
| 71 | </ul></div>\r | |
| 72 | </div>\r | |
| 73 | </div>\r | |
| 74 | <div class="sect1">\r | |
| 75 | <h2 id="_notes">Notes</h2>\r | |
| 76 | <div class="sectionbody">\r | |
| 77 | <div class="paragraph"><p><a id="ASLR"></a>\r | |
| 78 | Executables that save and load worlds are incompatible with\r | |
| 79 | <a href="http://en.wikipedia.org/wiki/Address_space_layout_randomization">address space layout randomization (ASLR)</a>\r | |
| 80 | of the executable (though, not of shared libraries). The state of a\r | |
| 81 | computation includes addresses into the code and data segments of the\r | |
| 82 | executable (e.g., static runtime-system data, return addresses); such\r | |
| 83 | addresses are invalid when interpreted by the executable loaded at a\r | |
| 84 | different base address.</p></div>\r | |
| 85 | <div class="paragraph"><p>Executables that save and load worlds should be compiled with an\r | |
| 86 | option to suppress the generation of position-independent executables.</p></div>\r | |
| 87 | <div class="ulist"><ul>\r | |
| 88 | <li>\r | |
| 89 | <p>\r | |
| 90 | <a href="RunningOnDarwin">Darwin 11 (Mac OS X Lion) and higher</a> : <span class="monospaced">-link-opt -fno-PIE</span>\r | |
| 91 | </p>\r | |
| 92 | </li>\r | |
| 93 | </ul></div>\r | |
| 94 | </div>\r | |
| 95 | </div>\r | |
| 96 | <div class="sect1">\r | |
| 97 | <h2 id="_example">Example</h2>\r | |
| 98 | <div class="sectionbody">\r | |
| 99 | <div class="paragraph"><p>Suppose that <span class="monospaced">save-world.sml</span> contains the following.</p></div>\r | |
| 100 | <div class="listingblock">\r | |
| 101 | <div class="content"><div class="highlight"><pre><span class="k">open</span><span class="w"> </span><span class="n">MLton</span><span class="p">.</span><span class="n">World</span><span class="w"></span>\r | |
| 102 | \r | |
| 103 | <span class="k">val</span><span class="w"> </span><span class="p">_</span><span class="w"> </span><span class="p">=</span><span class="w"></span>\r | |
| 104 | <span class="w"> </span><span class="k">case</span><span class="w"> </span><span class="n">save</span><span class="w"> </span><span class="s">"world"</span><span class="w"> </span><span class="k">of</span><span class="w"></span>\r | |
| 105 | <span class="w"> </span><span class="n">Original</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="n">print</span><span class="w"> </span><span class="s">"I am the original</span><span class="se">\n</span><span class="s">"</span><span class="w"></span>\r | |
| 106 | <span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">Clone</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="n">print</span><span class="w"> </span><span class="s">"I am the clone</span><span class="se">\n</span><span class="s">"</span><span class="w"></span>\r | |
| 107 | </pre></div></div></div>\r | |
| 108 | <div class="paragraph"><p>Then, if we compile <span class="monospaced">save-world.sml</span> and run it, the <span class="monospaced">Original</span>\r | |
| 109 | branch will execute, and a file named <span class="monospaced">world</span> will be created.</p></div>\r | |
| 110 | <div class="listingblock">\r | |
| 111 | <div class="content monospaced">\r | |
| 112 | <pre>% mlton save-world.sml\r | |
| 113 | % ./save-world\r | |
| 114 | I am the original</pre>\r | |
| 115 | </div></div>\r | |
| 116 | <div class="paragraph"><p>We can then load <span class="monospaced">world</span> using the <span class="monospaced">load-world</span>\r | |
| 117 | <a href="RunTimeOptions">run time option</a>.</p></div>\r | |
| 118 | <div class="listingblock">\r | |
| 119 | <div class="content monospaced">\r | |
| 120 | <pre>% ./save-world @MLton load-world world --\r | |
| 121 | I am the clone</pre>\r | |
| 122 | </div></div>\r | |
| 123 | </div>\r | |
| 124 | </div>\r | |
| 125 | </div>\r | |
| 126 | <div id="footnotes"><hr></div>\r | |
| 127 | <div id="footer">\r | |
| 128 | <div id="footer-text">\r | |
| 129 | </div>\r | |
| 130 | <div id="footer-badges">\r | |
| 131 | </div>\r | |
| 132 | </div>\r | |
| 133 | </body>\r | |
| 134 | </html>\r |