Import Upstream version 20180207
[hcoop/debian/mlton.git] / doc / guide / localhost / Inline
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>Inline</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>Inline</h1>
27 </div>
28 <div id="content">
29 <div id="preamble">
30 <div class="sectionbody">
31 <div class="paragraph"><p><a href="Inline">Inline</a> is an optimization pass for the <a href="SSA">SSA</a>
32 <a href="IntermediateLanguage">IntermediateLanguage</a>, invoked from <a href="SSASimplify">SSASimplify</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>This pass inlines <a href="SSA">SSA</a> functions using a size-based metric.</p></div>
39 </div>
40 </div>
41 <div class="sect1">
42 <h2 id="_implementation">Implementation</h2>
43 <div class="sectionbody">
44 <div class="ulist"><ul>
45 <li>
46 <p>
47 <a href="https://github.com/MLton/mlton/blob/master/mlton/ssa/inline.sig"><span class="monospaced">inline.sig</span></a>
48 </p>
49 </li>
50 <li>
51 <p>
52 <a href="https://github.com/MLton/mlton/blob/master/mlton/ssa/inline.fun"><span class="monospaced">inline.fun</span></a>
53 </p>
54 </li>
55 </ul></div>
56 </div>
57 </div>
58 <div class="sect1">
59 <h2 id="_details_and_notes">Details and Notes</h2>
60 <div class="sectionbody">
61 <div class="paragraph"><p>The <a href="Inline">Inline</a> pass can be invoked to use one of three metrics:</p></div>
62 <div class="ulist"><ul>
63 <li>
64 <p>
65 <span class="monospaced">NonRecursive(product, small)</span>&#8201;&#8212;&#8201;inline any function satisfying <span class="monospaced">(numCalls - 1) * (size - small) &lt;= product</span>, where <span class="monospaced">numCalls</span> is the static number of calls to the function and <span class="monospaced">size</span> is the size of the function.
66 </p>
67 </li>
68 <li>
69 <p>
70 <span class="monospaced">Leaf(size)</span>&#8201;&#8212;&#8201;inline any leaf function smaller than <span class="monospaced">size</span>
71 </p>
72 </li>
73 <li>
74 <p>
75 <span class="monospaced">LeafNoLoop(size)</span>&#8201;&#8212;&#8201;inline any leaf function without loops smaller than <span class="monospaced">size</span>
76 </p>
77 </li>
78 </ul></div>
79 </div>
80 </div>
81 </div>
82 <div id="footnotes"><hr></div>
83 <div id="footer">
84 <div id="footer-text">
85 </div>
86 <div id="footer-badges">
87 </div>
88 </div>
89 </body>
90 </html>