doc/guide/localhost/Monomorphise

   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>Monomorphise</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>Monomorphise</h1>
  27 </div>
  28 <div id="content">
  29 <div id="preamble">
  30 <div class="sectionbody">
  31 <div class="paragraph"><p><a href="Monomorphise">Monomorphise</a> is a translation pass from the <a href="XML">XML</a>
  32 <a href="IntermediateLanguage">IntermediateLanguage</a> to the <a href="SXML">SXML</a> <a href="IntermediateLanguage">IntermediateLanguage</a>.</p></div>
  33 </div>
  34 </div>
  35 <div class="sect1">
  36 <h2 id="_description">Description</h2>
  37 <div class="sectionbody">
  38 <div class="paragraph"><p>Monomorphisation eliminates polymorphic values and datatype
  39 declarations by duplicating them for each type at which they are used.</p></div>
  40 <div class="paragraph"><p>Consider the following <a href="XML">XML</a> program.</p></div>
  41 <div class="listingblock">
  42 <div class="content"><div class="highlight"><pre><span class="k">datatype</span><span class="w"> </span><span class="n">&#39;a</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">T</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">&#39;a</span><span class="w"></span>
  43 <span class="k">fun</span><span class="w"> </span><span class="n">&#39;a</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="p">(</span><span class="n">x</span><span class="p">:</span><span class="w"> </span><span class="n">&#39;a</span><span class="p">)</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">T</span><span class="w"> </span><span class="n">x</span><span class="w"></span>
  44 <span class="k">val</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="mi">1</span><span class="w"></span>
  45 <span class="k">val</span><span class="w"> </span><span class="n">b</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="mi">2</span><span class="w"></span>
  46 <span class="k">val</span><span class="w"> </span><span class="n">z</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="p">(</span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="mi">4</span><span class="p">)</span><span class="w"></span>
  47 </pre></div></div></div>
  48 <div class="paragraph"><p>The result of monomorphising this program is the following <a href="SXML">SXML</a> program:</p></div>
  49 <div class="listingblock">
  50 <div class="content"><div class="highlight"><pre><span class="k">datatype</span><span class="w"> </span><span class="n">t1</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">T1</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">int</span><span class="w"></span>
  51 <span class="k">datatype</span><span class="w"> </span><span class="n">t2</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">T2</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="w"></span>
  52 <span class="k">fun</span><span class="w"> </span><span class="n">f1</span><span class="w"> </span><span class="p">(</span><span class="n">x</span><span class="p">:</span><span class="w"> </span><span class="n">int</span><span class="p">)</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">T1</span><span class="w"> </span><span class="n">x</span><span class="w"></span>
  53 <span class="k">fun</span><span class="w"> </span><span class="n">f2</span><span class="w"> </span><span class="p">(</span><span class="n">x</span><span class="p">:</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="p">)</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">T2</span><span class="w"> </span><span class="n">x</span><span class="w"></span>
  54 <span class="k">val</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">f1</span><span class="w"> </span><span class="mi">1</span><span class="w"></span>
  55 <span class="k">val</span><span class="w"> </span><span class="n">b</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">f1</span><span class="w"> </span><span class="mi">2</span><span class="w"></span>
  56 <span class="k">val</span><span class="w"> </span><span class="n">z</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">f2</span><span class="w"> </span><span class="p">(</span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="mi">4</span><span class="p">)</span><span class="w"></span>
  57 </pre></div></div></div>
  58 </div>
  59 </div>
  60 <div class="sect1">
  61 <h2 id="_implementation">Implementation</h2>
  62 <div class="sectionbody">
  63 <div class="ulist"><ul>
  64 <li>
  65 <p>
  66 <a href="https://github.com/MLton/mlton/blob/master/mlton/xml/monomorphise.sig"><span class="monospaced">monomorphise.sig</span></a>
  67 </p>
  68 </li>
  69 <li>
  70 <p>
  71 <a href="https://github.com/MLton/mlton/blob/master/mlton/xml/monomorphise.fun"><span class="monospaced">monomorphise.fun</span></a>
  72 </p>
  73 </li>
  74 </ul></div>
  75 </div>
  76 </div>
  77 <div class="sect1">
  78 <h2 id="_details_and_notes">Details and Notes</h2>
  79 <div class="sectionbody">
  80 <div class="paragraph"><p>The monomorphiser works by making one pass over the entire program.
  81 On the way down, it creates a cache for each variable declared in a
  82 polymorphic declaration that maps a lists of type arguments to a new
  83 variable name.  At a variable reference, it consults the cache (based
  84 on the types the variable is applied to).  If there is already an
  85 entry in the cache, it is used.  If not, a new entry is created.  On
  86 the way up, the monomorphiser duplicates a variable declaration for
  87 each entry in the cache.</p></div>
  88 <div class="paragraph"><p>As with variables, the monomorphiser records all of the type at which
  89 constructors are used.  After the entire program is processed, the
  90 monomorphiser duplicates each datatype declaration and its associated
  91 constructors.</p></div>
  92 <div class="paragraph"><p>The monomorphiser duplicates all of the functions declared in a
  93 <span class="monospaced">fun</span> declaration as a unit.  Consider the following program</p></div>
  94 <div class="listingblock">
  95 <div class="content"><div class="highlight"><pre><span class="k">fun</span><span class="w"> </span><span class="n">&#39;a</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="p">(</span><span class="n">x</span><span class="p">:</span><span class="w"> </span><span class="n">&#39;a</span><span class="p">)</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">g</span><span class="w"> </span><span class="n">x</span><span class="w"></span>
  96 <span class="k">and</span><span class="w"> </span><span class="n">g</span><span class="w"> </span><span class="p">(</span><span class="n">y</span><span class="p">:</span><span class="w"> </span><span class="n">&#39;a</span><span class="p">)</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="n">y</span><span class="w"></span>
  97 <span class="k">val</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="mi">13</span><span class="w"></span>
  98 <span class="k">val</span><span class="w"> </span><span class="n">b</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">g</span><span class="w"> </span><span class="mi">14</span><span class="w"></span>
  99 <span class="k">val</span><span class="w"> </span><span class="n">c</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">)</span><span class="w"></span>
 100 </pre></div></div></div>
 101 <div class="paragraph"><p>and its monomorphisation</p></div>
 102 <div class="listingblock">
 103 <div class="content"><div class="highlight"><pre><span class="k">fun</span><span class="w"> </span><span class="n">f1</span><span class="w"> </span><span class="p">(</span><span class="n">x</span><span class="p">:</span><span class="w"> </span><span class="n">int</span><span class="p">)</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">g1</span><span class="w"> </span><span class="n">x</span><span class="w"></span>
 104 <span class="k">and</span><span class="w"> </span><span class="n">g1</span><span class="w"> </span><span class="p">(</span><span class="n">y</span><span class="p">:</span><span class="w"> </span><span class="n">int</span><span class="p">)</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">f1</span><span class="w"> </span><span class="n">y</span><span class="w"></span>
 105 <span class="k">fun</span><span class="w"> </span><span class="n">f2</span><span class="w"> </span><span class="p">(</span><span class="n">x</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="p">)</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">g2</span><span class="w"> </span><span class="n">x</span><span class="w"></span>
 106 <span class="k">and</span><span class="w"> </span><span class="n">g2</span><span class="w"> </span><span class="p">(</span><span class="n">y</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="p">)</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">f2</span><span class="w"> </span><span class="n">y</span><span class="w"></span>
 107 <span class="k">val</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">f1</span><span class="w"> </span><span class="mi">13</span><span class="w"></span>
 108 <span class="k">val</span><span class="w"> </span><span class="n">b</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">g1</span><span class="w"> </span><span class="mi">14</span><span class="w"></span>
 109 <span class="k">val</span><span class="w"> </span><span class="n">c</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">f2</span><span class="w"> </span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">)</span><span class="w"></span>
 110 </pre></div></div></div>
 111 </div>
 112 </div>
 113 <div class="sect1">
 114 <h2 id="_pathological_datatype_declarations">Pathological datatype declarations</h2>
 115 <div class="sectionbody">
 116 <div class="paragraph"><p>SML allows a pathological polymorphic datatype declaration in which
 117 recursive uses of the defined type constructor are applied to
 118 different type arguments than the definition.  This has been
 119 disallowed by others on type theoretic grounds.  A canonical example
 120 is the following.</p></div>
 121 <div class="listingblock">
 122 <div class="content"><div class="highlight"><pre><span class="k">datatype</span><span class="w"> </span><span class="n">&#39;a</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">A</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">&#39;a</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="n">B</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="p">(</span><span class="n">&#39;a</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">&#39;a</span><span class="p">)</span><span class="w"> </span><span class="n">t</span><span class="w"></span>
 123 <span class="k">val</span><span class="w"> </span><span class="n">z</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">B</span><span class="w"> </span><span class="p">(</span><span class="n">B</span><span class="w"> </span><span class="p">(</span><span class="n">A</span><span class="w"> </span><span class="p">((</span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">),</span><span class="w"> </span><span class="p">(</span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="mi">4</span><span class="p">))))</span><span class="w"></span>
 124 </pre></div></div></div>
 125 <div class="paragraph"><p>The presence of the recursion in the datatype declaration might appear
 126 to cause the need for the monomorphiser to create an infinite number
 127 of types.  However, due to the absence of polymorphic recursion in
 128 SML, there are in fact only a finite number of instances of such types
 129 in any given program.  The monomorphiser translates the above program
 130 to the following one.</p></div>
 131 <div class="listingblock">
 132 <div class="content"><div class="highlight"><pre><span class="k">datatype</span><span class="w"> </span><span class="n">t1</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">B1</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">t2</span><span class="w"></span>
 133 <span class="k">datatype</span><span class="w"> </span><span class="n">t2</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">B2</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">t3</span><span class="w"></span>
 134 <span class="k">datatype</span><span class="w"> </span><span class="n">t3</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">A3</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="p">(</span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="p">)</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="p">(</span><span class="n">int</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">int</span><span class="p">)</span><span class="w"></span>
 135 <span class="k">val</span><span class="w"> </span><span class="n">z</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="n">B1</span><span class="w"> </span><span class="p">(</span><span class="n">B2</span><span class="w"> </span><span class="p">(</span><span class="n">A3</span><span class="w"> </span><span class="p">((</span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p">),</span><span class="w"> </span><span class="p">(</span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="mi">4</span><span class="p">))))</span><span class="w"></span>
 136 </pre></div></div></div>
 137 <div class="paragraph"><p>It is crucial that the monomorphiser be allowed to drop unused
 138 constructors from datatype declarations in order for the translation
 139 to terminate.</p></div>
 140 </div>
 141 </div>
 142 </div>
 143 <div id="footnotes"><hr></div>
 144 <div id="footer">
 145 <div id="footer-text">
 146 </div>
 147 <div id="footer-badges">
 148 </div>
 149 </div>
 150 </body>
 151 </html>