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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
|
<!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/llvm/module.rs`."><title>module.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-17e279919966e8e4.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="llvm_kaleidoscope_rs" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0 (82e1608df 2023-12-21) (built from a source tarball)" data-channel="1.75.0" data-search-js="search-8fbf244ebcf71464.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../../../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="../../../static.files/src-script-3280b574d94e47b4.js"></script><script defer src="../../../src-files.js"></script><script defer src="../../../static.files/main-9dd44ab47b99a0fb.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
<a href="#74" id="74">74</a>
<a href="#75" id="75">75</a>
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
<a href="#79" id="79">79</a>
<a href="#80" id="80">80</a>
<a href="#81" id="81">81</a>
<a href="#82" id="82">82</a>
<a href="#83" id="83">83</a>
<a href="#84" id="84">84</a>
<a href="#85" id="85">85</a>
<a href="#86" id="86">86</a>
<a href="#87" id="87">87</a>
<a href="#88" id="88">88</a>
<a href="#89" id="89">89</a>
<a href="#90" id="90">90</a>
<a href="#91" id="91">91</a>
<a href="#92" id="92">92</a>
<a href="#93" id="93">93</a>
<a href="#94" id="94">94</a>
<a href="#95" id="95">95</a>
<a href="#96" id="96">96</a>
<a href="#97" id="97">97</a>
<a href="#98" id="98">98</a>
<a href="#99" id="99">99</a>
<a href="#100" id="100">100</a>
<a href="#101" id="101">101</a>
<a href="#102" id="102">102</a>
<a href="#103" id="103">103</a>
<a href="#104" id="104">104</a>
<a href="#105" id="105">105</a>
<a href="#106" id="106">106</a>
<a href="#107" id="107">107</a>
<a href="#108" id="108">108</a>
<a href="#109" id="109">109</a>
<a href="#110" id="110">110</a>
<a href="#111" id="111">111</a>
<a href="#112" id="112">112</a>
<a href="#113" id="113">113</a>
<a href="#114" id="114">114</a>
<a href="#115" id="115">115</a>
<a href="#116" id="116">116</a>
<a href="#117" id="117">117</a>
<a href="#118" id="118">118</a>
<a href="#119" id="119">119</a>
<a href="#120" id="120">120</a>
<a href="#121" id="121">121</a>
<a href="#122" id="122">122</a>
<a href="#123" id="123">123</a>
<a href="#124" id="124">124</a>
<a href="#125" id="125">125</a>
<a href="#126" id="126">126</a>
<a href="#127" id="127">127</a>
<a href="#128" id="128">128</a>
<a href="#129" id="129">129</a>
<a href="#130" id="130">130</a>
<a href="#131" id="131">131</a>
<a href="#132" id="132">132</a>
<a href="#133" id="133">133</a>
<a href="#134" id="134">134</a>
<a href="#135" id="135">135</a>
<a href="#136" id="136">136</a>
<a href="#137" id="137">137</a>
<a href="#138" id="138">138</a>
<a href="#139" id="139">139</a>
<a href="#140" id="140">140</a>
<a href="#141" id="141">141</a>
<a href="#142" id="142">142</a>
<a href="#143" id="143">143</a>
<a href="#144" id="144">144</a>
<a href="#145" id="145">145</a>
<a href="#146" id="146">146</a>
<a href="#147" id="147">147</a>
<a href="#148" id="148">148</a>
<a href="#149" id="149">149</a>
<a href="#150" id="150">150</a>
<a href="#151" id="151">151</a>
<a href="#152" id="152">152</a>
<a href="#153" id="153">153</a>
<a href="#154" id="154">154</a>
<a href="#155" id="155">155</a>
<a href="#156" id="156">156</a>
<a href="#157" id="157">157</a>
<a href="#158" id="158">158</a>
<a href="#159" id="159">159</a>
<a href="#160" id="160">160</a>
<a href="#161" id="161">161</a>
<a href="#162" id="162">162</a>
<a href="#163" id="163">163</a>
<a href="#164" id="164">164</a>
<a href="#165" id="165">165</a>
<a href="#166" id="166">166</a>
<a href="#167" id="167">167</a>
<a href="#168" id="168">168</a>
<a href="#169" id="169">169</a>
<a href="#170" id="170">170</a>
<a href="#171" id="171">171</a>
<a href="#172" id="172">172</a>
<a href="#173" id="173">173</a>
<a href="#174" id="174">174</a>
<a href="#175" id="175">175</a>
<a href="#176" id="176">176</a>
<a href="#177" id="177">177</a>
<a href="#178" id="178">178</a>
<a href="#179" id="179">179</a>
<a href="#180" id="180">180</a>
<a href="#181" id="181">181</a>
<a href="#182" id="182">182</a>
<a href="#183" id="183">183</a>
<a href="#184" id="184">184</a>
<a href="#185" id="185">185</a>
<a href="#186" id="186">186</a>
<a href="#187" id="187">187</a>
<a href="#188" id="188">188</a>
<a href="#189" id="189">189</a>
<a href="#190" id="190">190</a>
<a href="#191" id="191">191</a>
<a href="#192" id="192">192</a>
<a href="#193" id="193">193</a>
<a href="#194" id="194">194</a>
<a href="#195" id="195">195</a>
<a href="#196" id="196">196</a>
<a href="#197" id="197">197</a>
<a href="#198" id="198">198</a>
<a href="#199" id="199">199</a>
<a href="#200" id="200">200</a>
<a href="#201" id="201">201</a>
<a href="#202" id="202">202</a>
<a href="#203" id="203">203</a>
<a href="#204" id="204">204</a>
<a href="#205" id="205">205</a>
<a href="#206" id="206">206</a>
<a href="#207" id="207">207</a>
<a href="#208" id="208">208</a>
<a href="#209" id="209">209</a>
<a href="#210" id="210">210</a>
</pre></div><pre class="rust"><code><span class="kw">use </span>llvm_sys::{
core::{
LLVMAddFunction, LLVMAppendBasicBlockInContext, LLVMCreateBasicBlockInContext,
LLVMDisposeModule, LLVMDoubleTypeInContext, LLVMDumpModule, LLVMGetNamedFunction,
LLVMModuleCreateWithNameInContext,
},
orc2::{
LLVMOrcCreateNewThreadSafeContext, LLVMOrcCreateNewThreadSafeModule,
LLVMOrcDisposeThreadSafeContext, LLVMOrcThreadSafeContextGetContext,
LLVMOrcThreadSafeContextRef, LLVMOrcThreadSafeModuleRef,
},
prelude::{LLVMBool, LLVMContextRef, LLVMModuleRef, LLVMTypeRef},
LLVMTypeKind,
};
<span class="kw">use </span>std::convert::TryFrom;
<span class="kw">use super</span>::{BasicBlock, FnValue, Type};
<span class="kw">use </span><span class="kw">crate</span>::SmallCStr;
<span class="comment">// Definition of LLVM C API functions using our `repr(transparent)` types.
</span><span class="kw">extern </span><span class="string">"C" </span>{
<span class="kw">fn </span>LLVMFunctionType(
ReturnType: Type<<span class="lifetime">'_</span>>,
ParamTypes: <span class="kw-2">*mut </span>Type<<span class="lifetime">'_</span>>,
ParamCount: ::libc::c_uint,
IsVarArg: LLVMBool,
) -> LLVMTypeRef;
}
<span class="doccomment">/// Wrapper for a LLVM Module with its own LLVM Context.
</span><span class="kw">pub struct </span>Module {
tsctx: LLVMOrcThreadSafeContextRef,
ctx: LLVMContextRef,
module: LLVMModuleRef,
}
<span class="kw">impl</span><<span class="lifetime">'llvm</span>> Module {
<span class="doccomment">/// Create a new Module instance.
///
/// # Panics
///
/// Panics if creating the context or the module fails.
</span><span class="kw">pub fn </span>new() -> <span class="self">Self </span>{
<span class="kw">let </span>(tsctx, ctx, module) = <span class="kw">unsafe </span>{
<span class="comment">// We generate a thread safe context because we are going to jit this IR module and
// there is no method to create a thread safe context wrapper from an existing context
// reference (at the time of writing this).
//
// ThreadSafeContext has shared ownership (start with ref count 1).
// We must explicitly dispose our reference (dec ref count).
</span><span class="kw">let </span>tc = LLVMOrcCreateNewThreadSafeContext();
<span class="macro">assert!</span>(!tc.is_null());
<span class="kw">let </span>c = LLVMOrcThreadSafeContextGetContext(tc);
<span class="kw">let </span>m = LLVMModuleCreateWithNameInContext(<span class="string">b"module\0"</span>.as_ptr().cast(), c);
<span class="macro">assert!</span>(!c.is_null() && !m.is_null());
(tc, c, m)
};
Module { tsctx, ctx, module }
}
<span class="doccomment">/// Get the raw LLVM context reference.
</span><span class="attr">#[inline]
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>ctx(<span class="kw-2">&</span><span class="self">self</span>) -> LLVMContextRef {
<span class="self">self</span>.ctx
}
<span class="doccomment">/// Get the raw LLVM module reference.
</span><span class="attr">#[inline]
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>module(<span class="kw-2">&</span><span class="self">self</span>) -> LLVMModuleRef {
<span class="self">self</span>.module
}
<span class="doccomment">/// Consume the module and turn in into a raw LLVM ThreadSafeModule reference.
///
/// If ownership of the raw reference is not transferred (eg to the JIT), memory will be leaked
/// in case the reference is disposed explicitly with LLVMOrcDisposeThreadSafeModule.
</span><span class="attr">#[inline]
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>into_raw_thread_safe_module(<span class="kw-2">mut </span><span class="self">self</span>) -> LLVMOrcThreadSafeModuleRef {
<span class="kw">let </span>m = std::mem::replace(<span class="kw-2">&mut </span><span class="self">self</span>.module, std::ptr::null_mut());
<span class="comment">// ThreadSafeModule has unique ownership.
// Takes ownership of module and increments ThreadSafeContext ref count.
//
// We must not reference/dispose `m` after this call, but we need to dispose our `tsctx`
// reference.
</span><span class="kw">let </span>tm = <span class="kw">unsafe </span>{ LLVMOrcCreateNewThreadSafeModule(m, <span class="self">self</span>.tsctx) };
<span class="macro">assert!</span>(!tm.is_null());
tm
}
<span class="doccomment">/// Dump LLVM IR emitted into the Module to stdout.
</span><span class="kw">pub fn </span>dump(<span class="kw-2">&</span><span class="self">self</span>) {
<span class="kw">unsafe </span>{ LLVMDumpModule(<span class="self">self</span>.module) };
}
<span class="doccomment">/// Get a type reference representing a `f64` float.
///
/// # Panics
///
/// Panics if LLVM API returns a `null` pointer.
</span><span class="kw">pub fn </span>type_f64(<span class="kw-2">&</span><span class="self">self</span>) -> Type<<span class="lifetime">'llvm</span>> {
<span class="kw">let </span>type_ref = <span class="kw">unsafe </span>{ LLVMDoubleTypeInContext(<span class="self">self</span>.ctx) };
Type::new(type_ref)
}
<span class="doccomment">/// Get a type reference representing a `fn(args) -> ret` function.
///
/// # Panics
///
/// Panics if LLVM API returns a `null` pointer.
</span><span class="kw">pub fn </span>type_fn(<span class="kw-2">&</span><span class="lifetime">'llvm </span><span class="self">self</span>, args: <span class="kw-2">&mut </span>[Type<<span class="lifetime">'llvm</span>>], ret: Type<<span class="lifetime">'llvm</span>>) -> Type<<span class="lifetime">'llvm</span>> {
<span class="kw">let </span>type_ref = <span class="kw">unsafe </span>{
LLVMFunctionType(
ret,
args.as_mut_ptr(),
args.len() <span class="kw">as </span>libc::c_uint,
<span class="number">0</span>, <span class="comment">/* IsVarArg */
</span>)
};
Type::new(type_ref)
}
<span class="doccomment">/// Add a function with the given `name` and `fn_type` to the module and return a value
/// reference representing the function.
///
/// # Panics
///
/// Panics if LLVM API returns a `null` pointer or `name` could not be converted to a
/// [`SmallCStr`].
</span><span class="kw">pub fn </span>add_fn(<span class="kw-2">&</span><span class="lifetime">'llvm </span><span class="self">self</span>, name: <span class="kw-2">&</span>str, fn_type: Type<<span class="lifetime">'llvm</span>>) -> FnValue<<span class="lifetime">'llvm</span>> {
<span class="macro">debug_assert_eq!</span>(
fn_type.kind(),
LLVMTypeKind::LLVMFunctionTypeKind,
<span class="string">"Expected a function type when adding a function!"
</span>);
<span class="kw">let </span>name = SmallCStr::try_from(name)
.expect(<span class="string">"Failed to convert 'name' argument to small C string!"</span>);
<span class="kw">let </span>value_ref = <span class="kw">unsafe </span>{ LLVMAddFunction(<span class="self">self</span>.module, name.as_ptr(), fn_type.type_ref()) };
FnValue::new(value_ref)
}
<span class="doccomment">/// Get a function value reference to the function with the given `name` if it was previously
/// added to the module with [`add_fn`][Module::add_fn].
///
/// # Panics
///
/// Panics if `name` could not be converted to a [`SmallCStr`].
</span><span class="kw">pub fn </span>get_fn(<span class="kw-2">&</span><span class="lifetime">'llvm </span><span class="self">self</span>, name: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Option</span><FnValue<<span class="lifetime">'llvm</span>>> {
<span class="kw">let </span>name = SmallCStr::try_from(name)
.expect(<span class="string">"Failed to convert 'name' argument to small C string!"</span>);
<span class="kw">let </span>value_ref = <span class="kw">unsafe </span>{ LLVMGetNamedFunction(<span class="self">self</span>.module, name.as_ptr()) };
(!value_ref.is_null()).then(|| FnValue::new(value_ref))
}
<span class="doccomment">/// Append a Basic Block to the end of the function referenced by the value reference
/// `fn_value`.
///
/// # Panics
///
/// Panics if LLVM API returns a `null` pointer.
</span><span class="kw">pub fn </span>append_basic_block(<span class="kw-2">&</span><span class="lifetime">'llvm </span><span class="self">self</span>, fn_value: FnValue<<span class="lifetime">'llvm</span>>) -> BasicBlock<<span class="lifetime">'llvm</span>> {
<span class="kw">let </span>block = <span class="kw">unsafe </span>{
LLVMAppendBasicBlockInContext(
<span class="self">self</span>.ctx,
fn_value.value_ref(),
<span class="string">b"block\0"</span>.as_ptr().cast(),
)
};
<span class="macro">assert!</span>(!block.is_null());
BasicBlock::new(block)
}
<span class="doccomment">/// Create a free-standing Basic Block without adding it to a function.
/// This can be added to a function at a later point in time with
/// [`FnValue::append_basic_block`].
///
/// # Panics
///
/// Panics if LLVM API returns a `null` pointer.
</span><span class="kw">pub fn </span>create_basic_block(<span class="kw-2">&</span><span class="self">self</span>) -> BasicBlock<<span class="lifetime">'llvm</span>> {
<span class="kw">let </span>block = <span class="kw">unsafe </span>{ LLVMCreateBasicBlockInContext(<span class="self">self</span>.ctx, <span class="string">b"block\0"</span>.as_ptr().cast()) };
<span class="macro">assert!</span>(!block.is_null());
BasicBlock::new(block)
}
}
<span class="kw">impl </span>Drop <span class="kw">for </span>Module {
<span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) {
<span class="kw">unsafe </span>{
<span class="comment">// In case we turned the module into a ThreadSafeModule, we must not dispose the module
// reference because ThreadSafeModule took ownership!
</span><span class="kw">if </span>!<span class="self">self</span>.module.is_null() {
LLVMDisposeModule(<span class="self">self</span>.module);
}
<span class="comment">// Dispose ThreadSafeContext reference (dec ref count) in any case.
</span>LLVMOrcDisposeThreadSafeContext(<span class="self">self</span>.tsctx);
}
}
}
</code></pre></div></section></main></body></html>
|
