1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
|
<!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="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></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="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../../llvm_kaleidoscope_rs/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" 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>
</pre><pre class="rust">
<span class="kw">use</span> <span class="ident">std::collections::HashMap</span>;
<span class="kw">use</span> <span class="kw">crate</span><span class="ident">::llvm</span>::{<span class="ident">Builder</span>, <span class="ident">FnValue</span>, <span class="ident">Module</span>, <span class="ident">Value</span>};
<span class="kw">use</span> <span class="kw">crate</span><span class="ident">::parser</span>::{<span class="ident">ExprAST</span>, <span class="ident">FunctionAST</span>, <span class="ident">PrototypeAST</span>};
<span class="kw">use</span> <span class="kw">crate</span><span class="ident">::Either</span>;
<span class="kw">type</span> <span class="ident">CodegenResult</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="op">=</span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">String</span><span class="op">></span>;
<span class="doccomment">/// Code generator from kaleidoscope AST to LLVM IR.</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Codegen</span><span class="op"><</span><span class="lifetime">'llvm</span>, <span class="lifetime">'a</span><span class="op">></span> {
<span class="ident">module</span>: <span class="kw-2">&</span><span class="lifetime">'llvm</span> <span class="ident">Module</span>,
<span class="ident">builder</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">Builder</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>,
}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'llvm</span>, <span class="lifetime">'a</span><span class="op">></span> <span class="ident">Codegen</span><span class="op"><</span><span class="lifetime">'llvm</span>, <span class="lifetime">'a</span><span class="op">></span> {
<span class="doccomment">/// Compile either a [`PrototypeAST`] or a [`FunctionAST`] into the LLVM `module`.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">compile</span>(
<span class="ident">module</span>: <span class="kw-2">&</span><span class="lifetime">'llvm</span> <span class="ident">Module</span>,
<span class="ident">compilee</span>: <span class="ident">Either</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">PrototypeAST</span>, <span class="kw-2">&</span><span class="ident">FunctionAST</span><span class="op">></span>,
) <span class="op">-</span><span class="op">></span> <span class="ident">CodegenResult</span><span class="op"><</span><span class="ident">FnValue</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">cg</span> <span class="op">=</span> <span class="ident">Codegen</span> {
<span class="ident">module</span>,
<span class="ident">builder</span>: <span class="kw-2">&</span><span class="ident">Builder::with_ctx</span>(<span class="ident">module</span>),
};
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">variables</span> <span class="op">=</span> <span class="ident">HashMap::new</span>();
<span class="kw">match</span> <span class="ident">compilee</span> {
<span class="ident">Either::A</span>(<span class="ident">proto</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(<span class="ident">cg</span>.<span class="ident">codegen_prototype</span>(<span class="ident">proto</span>)),
<span class="ident">Either::B</span>(<span class="ident">func</span>) <span class="op">=</span><span class="op">></span> <span class="ident">cg</span>.<span class="ident">codegen_function</span>(<span class="ident">func</span>, <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">variables</span>),
}
}
<span class="kw">fn</span> <span class="ident">codegen_expr</span>(
<span class="kw-2">&</span><span class="self">self</span>,
<span class="ident">expr</span>: <span class="kw-2">&</span><span class="ident">ExprAST</span>,
<span class="ident">named_values</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">HashMap</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'llvm</span> <span class="ident">str</span>, <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span><span class="op">></span>,
) <span class="op">-</span><span class="op">></span> <span class="ident">CodegenResult</span><span class="op"><</span><span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span><span class="op">></span> {
<span class="kw">match</span> <span class="ident">expr</span> {
<span class="ident">ExprAST::Number</span>(<span class="ident">num</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(<span class="self">self</span>.<span class="ident">module</span>.<span class="ident">type_f64</span>().<span class="ident">const_f64</span>(<span class="kw-2">*</span><span class="ident">num</span>)),
<span class="ident">ExprAST::Variable</span>(<span class="ident">name</span>) <span class="op">=</span><span class="op">></span> <span class="kw">match</span> <span class="ident">named_values</span>.<span class="ident">get</span>(<span class="ident">name</span>.<span class="ident">as_str</span>()) {
<span class="prelude-val">Some</span>(<span class="ident">value</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(<span class="kw-2">*</span><span class="ident">value</span>),
<span class="prelude-val">None</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="string">"Unknown variable name"</span>.<span class="ident">into</span>()),
},
<span class="ident">ExprAST::Binary</span>(<span class="ident">binop</span>, <span class="ident">lhs</span>, <span class="ident">rhs</span>) <span class="op">=</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">l</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">codegen_expr</span>(<span class="ident">lhs</span>, <span class="ident">named_values</span>)<span class="question-mark">?</span>;
<span class="kw">let</span> <span class="ident">r</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">codegen_expr</span>(<span class="ident">rhs</span>, <span class="ident">named_values</span>)<span class="question-mark">?</span>;
<span class="kw">match</span> <span class="ident">binop</span> {
<span class="string">'+'</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(<span class="self">self</span>.<span class="ident">builder</span>.<span class="ident">fadd</span>(<span class="ident">l</span>, <span class="ident">r</span>)),
<span class="string">'-'</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(<span class="self">self</span>.<span class="ident">builder</span>.<span class="ident">fsub</span>(<span class="ident">l</span>, <span class="ident">r</span>)),
<span class="string">'*'</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(<span class="self">self</span>.<span class="ident">builder</span>.<span class="ident">fmul</span>(<span class="ident">l</span>, <span class="ident">r</span>)),
<span class="string">'<'</span> <span class="op">=</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">builder</span>.<span class="ident">fcmpult</span>(<span class="ident">l</span>, <span class="ident">r</span>);
<span class="comment">// Turn bool into f64.</span>
<span class="prelude-val">Ok</span>(<span class="self">self</span>.<span class="ident">builder</span>.<span class="ident">uitofp</span>(<span class="ident">res</span>, <span class="self">self</span>.<span class="ident">module</span>.<span class="ident">type_f64</span>()))
}
<span class="kw">_</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="string">"invalid binary operator"</span>.<span class="ident">into</span>()),
}
}
<span class="ident">ExprAST::Call</span>(<span class="ident">callee</span>, <span class="ident">args</span>) <span class="op">=</span><span class="op">></span> <span class="kw">match</span> <span class="self">self</span>.<span class="ident">module</span>.<span class="ident">get_fn</span>(<span class="ident">callee</span>) {
<span class="prelude-val">Some</span>(<span class="ident">callee</span>) <span class="op">=</span><span class="op">></span> {
<span class="kw">if</span> <span class="ident">callee</span>.<span class="ident">args</span>() <span class="op">!</span><span class="op">=</span> <span class="ident">args</span>.<span class="ident">len</span>() {
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="string">"Incorrect # arguments passed"</span>.<span class="ident">into</span>());
}
<span class="comment">// Generate code for function argument expressions.</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">args</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">Value</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">args</span>
.<span class="ident">iter</span>()
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">arg</span><span class="op">|</span> <span class="self">self</span>.<span class="ident">codegen_expr</span>(<span class="ident">arg</span>, <span class="ident">named_values</span>))
.<span class="ident">collect</span>::<span class="op"><</span><span class="ident">CodegenResult</span><span class="op"><</span><span class="kw">_</span><span class="op">></span><span class="op">></span>()<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(<span class="self">self</span>.<span class="ident">builder</span>.<span class="ident">call</span>(<span class="ident">callee</span>, <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">args</span>))
}
<span class="prelude-val">None</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="string">"Unknown function referenced"</span>.<span class="ident">into</span>()),
},
}
}
<span class="kw">fn</span> <span class="ident">codegen_prototype</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">PrototypeAST</span>(<span class="ident">name</span>, <span class="ident">args</span>): <span class="kw-2">&</span><span class="ident">PrototypeAST</span>) <span class="op">-</span><span class="op">></span> <span class="ident">FnValue</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">type_f64</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">module</span>.<span class="ident">type_f64</span>();
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">doubles</span> <span class="op">=</span> <span class="ident">Vec::new</span>();
<span class="ident">doubles</span>.<span class="ident">resize</span>(<span class="ident">args</span>.<span class="ident">len</span>(), <span class="ident">type_f64</span>);
<span class="comment">// Build the function type: fn(f64, f64, ..) -> f64</span>
<span class="kw">let</span> <span class="ident">ft</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">module</span>.<span class="ident">type_fn</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">doubles</span>, <span class="ident">type_f64</span>);
<span class="comment">// Create the function declaration.</span>
<span class="kw">let</span> <span class="ident">f</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">module</span>.<span class="ident">add_fn</span>(<span class="ident">name</span>, <span class="ident">ft</span>);
<span class="comment">// Set the names of the function arguments.</span>
<span class="kw">for</span> <span class="ident">idx</span> <span class="kw">in</span> <span class="number">0</span>..<span class="ident">f</span>.<span class="ident">args</span>() {
<span class="ident">f</span>.<span class="ident">arg</span>(<span class="ident">idx</span>).<span class="ident">set_name</span>(<span class="kw-2">&</span><span class="ident">args</span>[<span class="ident">idx</span>]);
}
<span class="ident">f</span>
}
<span class="kw">fn</span> <span class="ident">codegen_function</span>(
<span class="kw-2">&</span><span class="self">self</span>,
<span class="ident">FunctionAST</span>(<span class="ident">proto</span>, <span class="ident">body</span>): <span class="kw-2">&</span><span class="ident">FunctionAST</span>,
<span class="ident">named_values</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">HashMap</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'llvm</span> <span class="ident">str</span>, <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span><span class="op">></span>,
) <span class="op">-</span><span class="op">></span> <span class="ident">CodegenResult</span><span class="op"><</span><span class="ident">FnValue</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">the_function</span> <span class="op">=</span> <span class="kw">match</span> <span class="self">self</span>.<span class="ident">module</span>.<span class="ident">get_fn</span>(<span class="kw-2">&</span><span class="ident">proto</span>.<span class="number">0</span>) {
<span class="prelude-val">Some</span>(<span class="ident">f</span>) <span class="op">=</span><span class="op">></span> <span class="ident">f</span>,
<span class="prelude-val">None</span> <span class="op">=</span><span class="op">></span> <span class="self">self</span>.<span class="ident">codegen_prototype</span>(<span class="ident">proto</span>),
};
<span class="kw">if</span> <span class="ident">the_function</span>.<span class="ident">basic_blocks</span>() <span class="op">></span> <span class="number">0</span> {
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="string">"Function cannot be redefined."</span>.<span class="ident">into</span>());
}
<span class="comment">// Create entry basic block to insert code.</span>
<span class="kw">let</span> <span class="ident">bb</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">module</span>.<span class="ident">append_basic_block</span>(<span class="ident">the_function</span>);
<span class="self">self</span>.<span class="ident">builder</span>.<span class="ident">pos_at_end</span>(<span class="ident">bb</span>);
<span class="comment">// New scope, clear the map with the function args.</span>
<span class="ident">named_values</span>.<span class="ident">clear</span>();
<span class="comment">// Update the map with the current functions args.</span>
<span class="kw">for</span> <span class="ident">idx</span> <span class="kw">in</span> <span class="number">0</span>..<span class="ident">the_function</span>.<span class="ident">args</span>() {
<span class="kw">let</span> <span class="ident">arg</span> <span class="op">=</span> <span class="ident">the_function</span>.<span class="ident">arg</span>(<span class="ident">idx</span>);
<span class="ident">named_values</span>.<span class="ident">insert</span>(<span class="ident">arg</span>.<span class="ident">get_name</span>(), <span class="ident">arg</span>);
}
<span class="comment">// Codegen function body.</span>
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Ok</span>(<span class="ident">ret</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">codegen_expr</span>(<span class="ident">body</span>, <span class="ident">named_values</span>) {
<span class="self">self</span>.<span class="ident">builder</span>.<span class="ident">ret</span>(<span class="ident">ret</span>);
<span class="macro">assert!</span>(<span class="ident">the_function</span>.<span class="ident">verify</span>());
<span class="prelude-val">Ok</span>(<span class="ident">the_function</span>)
} <span class="kw">else</span> {
<span class="macro">todo!</span>(<span class="string">"Failed to codegen function body, erase from module!"</span>);
}
}
}
</pre></div>
</section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="llvm_kaleidoscope_rs" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script></body></html>
|
