aboutsummaryrefslogblamecommitdiffhomepage
path: root/src/llvm_kaleidoscope_rs/codegen.rs.html
blob: f8029102e8b63728c3b104fb7a3a498c3792c11a (plain) (tree)
1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                

































































































                       



































                         


























                         































































































































































                         
                                                                                    
 


                                                                                                                          
 
                                                                                                              
 





                                                                                                                                                     

 











                                                                                                                                                                                                                
          
                                                                                             
 


                                                                                                          


         
                                            
                                                                      







                                                                                                                                                                       
              











                                                                                                                                                                        
                     
                                                                                                                                                                 

                 



                                                                                                                                                                         

                     




                                                                                                                                                              
 
                                                                                                                                                     
                 
                                                                                                                                                                             
              





















                                                                                                                                                               

                  











































                                                                                                                                                          

                  
                                                                                   
             





                          
                     












































                                                                                                                                                                    

                  

                                                                                                                                                         
 




                                                                                                                                                                 
 



                                                                                                                                     
 


                                                                                                                       
 

                                                                                                   
 
                                                                            
 





                                                                                                                

                 

                                                                                                                                                        
             


         

                                                                                                                                                                                                                                                     
 

                                                                                       
 

                                                                                                                                                    
 

                                                                                                      
 


                                                                                                                   

         
         

     







                                                                                                                                     
 

                                                                                                                                                                  
 

                                                                                                                                                              

         


                                                                                                                       
 

                                                                                 
 



                                                                                                                              

         



                                                                                                                                                          
 

                                                                                 
 

                                                             


                                                                                                                                          
 









                                                                                                                                                                                                                                                                        


             
                                                     
     
 
                   
                                                                                                                                                                                                                                              
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/codegen.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>codegen.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../llvm_kaleidoscope_rs/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../llvm_kaleidoscope_rs/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../llvm_kaleidoscope_rs/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
</pre><pre class="rust"><code><span class="kw">use </span>std::collections::HashMap;

<span class="kw">use </span><span class="kw">crate</span>::llvm::{FnValue, FunctionPassManager, IRBuilder, Module, Value};
<span class="kw">use </span><span class="kw">crate</span>::parser::{ExprAST, FunctionAST, PrototypeAST};
<span class="kw">use </span><span class="kw">crate</span>::Either;

<span class="kw">type </span>CodegenResult&lt;T&gt; = <span class="prelude-ty">Result</span>&lt;T, String&gt;;

<span class="doccomment">/// Code generator from kaleidoscope AST to LLVM IR.
</span><span class="kw">pub struct </span>Codegen&lt;<span class="lifetime">&#39;llvm</span>, <span class="lifetime">&#39;a</span>&gt; {
    module: <span class="kw-2">&amp;</span><span class="lifetime">&#39;llvm </span>Module,
    builder: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>IRBuilder&lt;<span class="lifetime">&#39;llvm</span>&gt;,
    fpm: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>FunctionPassManager&lt;<span class="lifetime">&#39;llvm</span>&gt;,
    fn_protos: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>HashMap&lt;String, PrototypeAST&gt;,
}

<span class="kw">impl</span>&lt;<span class="lifetime">&#39;llvm</span>, <span class="lifetime">&#39;a</span>&gt; Codegen&lt;<span class="lifetime">&#39;llvm</span>, <span class="lifetime">&#39;a</span>&gt; {
    <span class="doccomment">/// Compile either a [`PrototypeAST`] or a [`FunctionAST`] into the LLVM `module`.
    </span><span class="kw">pub fn </span>compile(
        module: <span class="kw-2">&amp;</span><span class="lifetime">&#39;llvm </span>Module,
        fn_protos: <span class="kw-2">&amp;mut </span>HashMap&lt;String, PrototypeAST&gt;,
        compilee: Either&lt;<span class="kw-2">&amp;</span>PrototypeAST, <span class="kw-2">&amp;</span>FunctionAST&gt;,
    ) -&gt; CodegenResult&lt;FnValue&lt;<span class="lifetime">&#39;llvm</span>&gt;&gt; {
        <span class="kw">let </span><span class="kw-2">mut </span>cg = Codegen {
            module,
            builder: <span class="kw-2">&amp;</span>IRBuilder::with_ctx(module),
            fpm: <span class="kw-2">&amp;</span>FunctionPassManager::with_ctx(module),
            fn_protos,
        };
        <span class="kw">let </span><span class="kw-2">mut </span>variables = HashMap::new();

        <span class="kw">match </span>compilee {
            Either::A(proto) =&gt; <span class="prelude-val">Ok</span>(cg.codegen_prototype(proto)),
            Either::B(func) =&gt; cg.codegen_function(func, <span class="kw-2">&amp;mut </span>variables),
        }
    }

    <span class="kw">fn </span>codegen_expr(
        <span class="kw-2">&amp;</span><span class="self">self</span>,
        expr: <span class="kw-2">&amp;</span>ExprAST,
        named_values: <span class="kw-2">&amp;mut </span>HashMap&lt;String, Value&lt;<span class="lifetime">&#39;llvm</span>&gt;&gt;,
    ) -&gt; CodegenResult&lt;Value&lt;<span class="lifetime">&#39;llvm</span>&gt;&gt; {
        <span class="kw">match </span>expr {
            ExprAST::Number(num) =&gt; <span class="prelude-val">Ok</span>(<span class="self">self</span>.module.type_f64().const_f64(<span class="kw-2">*</span>num)),
            ExprAST::Variable(name) =&gt; <span class="kw">match </span>named_values.get(name.as_str()) {
                <span class="prelude-val">Some</span>(value) =&gt; <span class="prelude-val">Ok</span>(<span class="kw-2">*</span>value),
                <span class="prelude-val">None </span>=&gt; <span class="prelude-val">Err</span>(<span class="string">&quot;Unknown variable name&quot;</span>.into()),
            },
            ExprAST::Binary(binop, lhs, rhs) =&gt; {
                <span class="kw">let </span>l = <span class="self">self</span>.codegen_expr(lhs, named_values)<span class="question-mark">?</span>;
                <span class="kw">let </span>r = <span class="self">self</span>.codegen_expr(rhs, named_values)<span class="question-mark">?</span>;

                <span class="kw">match </span>binop {
                    <span class="string">&#39;+&#39; </span>=&gt; <span class="prelude-val">Ok</span>(<span class="self">self</span>.builder.fadd(l, r)),
                    <span class="string">&#39;-&#39; </span>=&gt; <span class="prelude-val">Ok</span>(<span class="self">self</span>.builder.fsub(l, r)),
                    <span class="string">&#39;*&#39; </span>=&gt; <span class="prelude-val">Ok</span>(<span class="self">self</span>.builder.fmul(l, r)),
                    <span class="string">&#39;&lt;&#39; </span>=&gt; {
                        <span class="kw">let </span>res = <span class="self">self</span>.builder.fcmpult(l, r);
                        <span class="comment">// Turn bool into f64.
                        </span><span class="prelude-val">Ok</span>(<span class="self">self</span>.builder.uitofp(res, <span class="self">self</span>.module.type_f64()))
                    }
                    <span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(<span class="string">&quot;invalid binary operator&quot;</span>.into()),
                }
            }
            ExprAST::Call(callee, args) =&gt; <span class="kw">match </span><span class="self">self</span>.get_function(callee) {
                <span class="prelude-val">Some</span>(callee) =&gt; {
                    <span class="kw">if </span>callee.args() != args.len() {
                        <span class="kw">return </span><span class="prelude-val">Err</span>(<span class="string">&quot;Incorrect # arguments passed&quot;</span>.into());
                    }

                    <span class="comment">// Generate code for function argument expressions.
                    </span><span class="kw">let </span><span class="kw-2">mut </span>args: Vec&lt;Value&lt;<span class="lifetime">&#39;_</span>&gt;&gt; = args
                        .iter()
                        .map(|arg| <span class="self">self</span>.codegen_expr(arg, named_values))
                        .collect::&lt;CodegenResult&lt;<span class="kw">_</span>&gt;&gt;()<span class="question-mark">?</span>;

                    <span class="prelude-val">Ok</span>(<span class="self">self</span>.builder.call(callee, <span class="kw-2">&amp;mut </span>args))
                }
                <span class="prelude-val">None </span>=&gt; <span class="prelude-val">Err</span>(<span class="string">&quot;Unknown function referenced&quot;</span>.into()),
            },
            ExprAST::If { cond, then, else_ } =&gt; {
                <span class="comment">// For &#39;if&#39; expressions we are building the following CFG.
                //
                //         ; cond
                //         br
                //          |
                //    +-----+------+
                //    v            v
                //  ; then       ; else
                //    |            |
                //    +-----+------+
                //          v
                //        ; merge
                //        phi then, else
                //        ret phi

                </span><span class="kw">let </span>cond_v = {
                    <span class="comment">// Codgen &#39;cond&#39; expression.
                    </span><span class="kw">let </span>v = <span class="self">self</span>.codegen_expr(cond, named_values)<span class="question-mark">?</span>;
                    <span class="comment">// Compare &#39;v&#39; against &#39;0&#39; as &#39;one = ordered not equal&#39;.
                    </span><span class="self">self</span>.builder
                        .fcmpone(v, <span class="self">self</span>.module.type_f64().const_f64(<span class="number">0f64</span>))
                };

                <span class="comment">// Get the function we are currently inserting into.
                </span><span class="kw">let </span>the_function = <span class="self">self</span>.builder.get_insert_block().get_parent();

                <span class="comment">// Create basic blocks for the &#39;then&#39; / &#39;else&#39; expressions as well as the return
                // instruction (&#39;merge&#39;).
                //
                // Append the &#39;then&#39; basic block to the function, don&#39;t insert the &#39;else&#39; and
                // &#39;merge&#39; basic blocks yet.
                </span><span class="kw">let </span>then_bb = <span class="self">self</span>.module.append_basic_block(the_function);
                <span class="kw">let </span>else_bb = <span class="self">self</span>.module.create_basic_block();
                <span class="kw">let </span>merge_bb = <span class="self">self</span>.module.create_basic_block();

                <span class="comment">// Create a conditional branch based on the result of the &#39;cond&#39; expression.
                </span><span class="self">self</span>.builder.cond_br(cond_v, then_bb, else_bb);

                <span class="comment">// Move to &#39;then&#39; basic block and codgen the &#39;then&#39; expression.
                </span><span class="self">self</span>.builder.pos_at_end(then_bb);
                <span class="kw">let </span>then_v = <span class="self">self</span>.codegen_expr(then, named_values)<span class="question-mark">?</span>;
                <span class="comment">// Create unconditional branch to &#39;merge&#39; block.
                </span><span class="self">self</span>.builder.br(merge_bb);
                <span class="comment">// Update reference to current basic block (in case the &#39;then&#39; expression added new
                // basic blocks).
                </span><span class="kw">let </span>then_bb = <span class="self">self</span>.builder.get_insert_block();

                <span class="comment">// Now append the &#39;else&#39; basic block to the function.
                </span>the_function.append_basic_block(else_bb);
                <span class="comment">// Move to &#39;else&#39; basic block and codgen the &#39;else&#39; expression.
                </span><span class="self">self</span>.builder.pos_at_end(else_bb);
                <span class="kw">let </span>else_v = <span class="self">self</span>.codegen_expr(else_, named_values)<span class="question-mark">?</span>;
                <span class="comment">// Create unconditional branch to &#39;merge&#39; block.
                </span><span class="self">self</span>.builder.br(merge_bb);
                <span class="comment">// Update reference to current basic block (in case the &#39;else&#39; expression added new
                // basic blocks).
                </span><span class="kw">let </span>else_bb = <span class="self">self</span>.builder.get_insert_block();

                <span class="comment">// Now append the &#39;merge&#39; basic block to the function.
                </span>the_function.append_basic_block(merge_bb);
                <span class="comment">// Move to &#39;merge&#39; basic block.
                </span><span class="self">self</span>.builder.pos_at_end(merge_bb);
                <span class="comment">// Codegen the phi node returning the appropriate value depending on the branch
                // condition.
                </span><span class="kw">let </span>phi = <span class="self">self</span>.builder.phi(
                    <span class="self">self</span>.module.type_f64(),
                    <span class="kw-2">&amp;</span>[(then_v, then_bb), (else_v, else_bb)],
                );

                <span class="prelude-val">Ok</span>(<span class="kw-2">*</span>phi)
            }
            ExprAST::For {
                var,
                start,
                end,
                step,
                body,
            } =&gt; {
                <span class="comment">// For &#39;for&#39; expression we build the following structure.
                //
                // entry:
                //   init = start expression
                //   br loop
                // loop:
                //   i = phi [%init, %entry], [%new_i, %loop]
                //   ; loop body ...
                //   new_i = increment %i by step expression
                //   ; check end condition and branch
                // end:

                // Compute initial value for the loop variable.
                </span><span class="kw">let </span>start_val = <span class="self">self</span>.codegen_expr(start, named_values)<span class="question-mark">?</span>;

                <span class="kw">let </span>the_function = <span class="self">self</span>.builder.get_insert_block().get_parent();
                <span class="comment">// Get current basic block (used in the loop variable phi node).
                </span><span class="kw">let </span>entry_bb = <span class="self">self</span>.builder.get_insert_block();
                <span class="comment">// Add new basic block to emit loop body.
                </span><span class="kw">let </span>loop_bb = <span class="self">self</span>.module.append_basic_block(the_function);

                <span class="self">self</span>.builder.br(loop_bb);
                <span class="self">self</span>.builder.pos_at_end(loop_bb);

                <span class="comment">// Build phi not to pick loop variable in case we come from the &#39;entry&#39; block.
                // Which is the case when we enter the loop for the first time.
                // We will add another incoming value once we computed the updated loop variable
                // below.
                </span><span class="kw">let </span>variable = <span class="self">self
                    </span>.builder
                    .phi(<span class="self">self</span>.module.type_f64(), <span class="kw-2">&amp;</span>[(start_val, entry_bb)]);

                <span class="comment">// Insert the loop variable into the named values map that it can be referenced
                // from the body as well as the end condition.
                // In case the loop variable shadows an existing variable remember the shared one.
                </span><span class="kw">let </span>old_val = named_values.insert(var.into(), <span class="kw-2">*</span>variable);

                <span class="comment">// Generate the loop body.
                </span><span class="self">self</span>.codegen_expr(body, named_values)<span class="question-mark">?</span>;

                <span class="comment">// Generate step value expression if available else use &#39;1&#39;.
                </span><span class="kw">let </span>step_val = <span class="kw">if let </span><span class="prelude-val">Some</span>(step) = step {
                    <span class="self">self</span>.codegen_expr(step, named_values)<span class="question-mark">?
                </span>} <span class="kw">else </span>{
                    <span class="self">self</span>.module.type_f64().const_f64(<span class="number">1f64</span>)
                };

                <span class="comment">// Increment loop variable.
                </span><span class="kw">let </span>next_var = <span class="self">self</span>.builder.fadd(<span class="kw-2">*</span>variable, step_val);

                <span class="comment">// Generate the loop end condition.
                </span><span class="kw">let </span>end_cond = <span class="self">self</span>.codegen_expr(end, named_values)<span class="question-mark">?</span>;
                <span class="kw">let </span>end_cond = <span class="self">self
                    </span>.builder
                    .fcmpone(end_cond, <span class="self">self</span>.module.type_f64().const_f64(<span class="number">0f64</span>));

                <span class="comment">// Get current basic block.
                </span><span class="kw">let </span>loop_end_bb = <span class="self">self</span>.builder.get_insert_block();
                <span class="comment">// Add new basic block following the loop.
                </span><span class="kw">let </span>after_bb = <span class="self">self</span>.module.append_basic_block(the_function);

                <span class="comment">// Register additional incoming value for the loop variable. This will choose the
                // updated loop variable if we are iterating in the loop.
                </span>variable.add_incoming(next_var, loop_end_bb);

                <span class="comment">// Branch depending on the loop end condition.
                </span><span class="self">self</span>.builder.cond_br(end_cond, loop_bb, after_bb);

                <span class="self">self</span>.builder.pos_at_end(after_bb);

                <span class="comment">// Restore the shadowed variable if there was one.
                </span><span class="kw">if let </span><span class="prelude-val">Some</span>(old_val) = old_val {
                    <span class="comment">// We inserted &#39;var&#39; above so it must exist.
                    </span><span class="kw-2">*</span>named_values.get_mut(var).unwrap() = old_val;
                } <span class="kw">else </span>{
                    named_values.remove(var);
                }

                <span class="comment">// Loops just always return 0.
                </span><span class="prelude-val">Ok</span>(<span class="self">self</span>.module.type_f64().const_f64(<span class="number">0f64</span>))
            }
        }
    }

    <span class="kw">fn </span>codegen_prototype(<span class="kw-2">&amp;</span><span class="self">self</span>, PrototypeAST(name, args): <span class="kw-2">&amp;</span>PrototypeAST) -&gt; FnValue&lt;<span class="lifetime">&#39;llvm</span>&gt; {
        <span class="kw">let </span>type_f64 = <span class="self">self</span>.module.type_f64();

        <span class="kw">let </span><span class="kw-2">mut </span>doubles = Vec::new();
        doubles.resize(args.len(), type_f64);

        <span class="comment">// Build the function type: fn(f64, f64, ..) -&gt; f64
        </span><span class="kw">let </span>ft = <span class="self">self</span>.module.type_fn(<span class="kw-2">&amp;mut </span>doubles, type_f64);

        <span class="comment">// Create the function declaration.
        </span><span class="kw">let </span>f = <span class="self">self</span>.module.add_fn(name, ft);

        <span class="comment">// Set the names of the function arguments.
        </span><span class="kw">for </span>idx <span class="kw">in </span><span class="number">0</span>..f.args() {
            f.arg(idx).set_name(<span class="kw-2">&amp;</span>args[idx]);
        }

        f
    }

    <span class="kw">fn </span>codegen_function(
        <span class="kw-2">&amp;mut </span><span class="self">self</span>,
        FunctionAST(proto, body): <span class="kw-2">&amp;</span>FunctionAST,
        named_values: <span class="kw-2">&amp;mut </span>HashMap&lt;String, Value&lt;<span class="lifetime">&#39;llvm</span>&gt;&gt;,
    ) -&gt; CodegenResult&lt;FnValue&lt;<span class="lifetime">&#39;llvm</span>&gt;&gt; {
        <span class="comment">// Insert the function prototype into the `fn_protos` map to keep track for re-generating
        // declarations in other modules.
        </span><span class="self">self</span>.fn_protos.insert(proto.<span class="number">0</span>.clone(), proto.clone());

        <span class="kw">let </span>the_function = <span class="self">self</span>.get_function(<span class="kw-2">&amp;</span>proto.<span class="number">0</span>)
            .expect(<span class="string">&quot;If proto not already generated, get_function will do for us since we updated fn_protos before-hand!&quot;</span>);

        <span class="kw">if </span>the_function.basic_blocks() &gt; <span class="number">0 </span>{
            <span class="kw">return </span><span class="prelude-val">Err</span>(<span class="string">&quot;Function cannot be redefined.&quot;</span>.into());
        }

        <span class="comment">// Create entry basic block to insert code.
        </span><span class="kw">let </span>bb = <span class="self">self</span>.module.append_basic_block(the_function);
        <span class="self">self</span>.builder.pos_at_end(bb);

        <span class="comment">// New scope, clear the map with the function args.
        </span>named_values.clear();

        <span class="comment">// Update the map with the current functions args.
        </span><span class="kw">for </span>idx <span class="kw">in </span><span class="number">0</span>..the_function.args() {
            <span class="kw">let </span>arg = the_function.arg(idx);
            named_values.insert(arg.get_name().into(), arg);
        }

        <span class="comment">// Codegen function body.
        </span><span class="kw">if let </span><span class="prelude-val">Ok</span>(ret) = <span class="self">self</span>.codegen_expr(body, named_values) {
            <span class="self">self</span>.builder.ret(ret);
            <span class="macro">assert!</span>(the_function.verify());

            <span class="comment">// Run the optimization passes on the function.
            </span><span class="self">self</span>.fpm.run(the_function);

            <span class="prelude-val">Ok</span>(the_function)
        } <span class="kw">else </span>{
            <span class="macro">todo!</span>(<span class="string">&quot;Failed to codegen function body, erase from module!&quot;</span>);
        }
    }

    <span class="doccomment">/// Lookup function with `name` in the LLVM module and return the corresponding value reference.
    /// If the function is not available in the module, check if the prototype is known and codegen
    /// it.
    /// Return [`None`] if the prototype is not known.
    </span><span class="kw">fn </span>get_function(<span class="kw-2">&amp;</span><span class="self">self</span>, name: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Option</span>&lt;FnValue&lt;<span class="lifetime">&#39;llvm</span>&gt;&gt; {
        <span class="kw">let </span>callee = <span class="kw">match </span><span class="self">self</span>.module.get_fn(name) {
            <span class="prelude-val">Some</span>(callee) =&gt; callee,
            <span class="prelude-val">None </span>=&gt; {
                <span class="kw">let </span>proto = <span class="self">self</span>.fn_protos.get(name)<span class="question-mark">?</span>;
                <span class="self">self</span>.codegen_prototype(proto)
            }
        };

        <span class="prelude-val">Some</span>(callee)
    }
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="llvm_kaleidoscope_rs" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0 (897e37553 2022-11-02)" ></div></body></html>