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
|
<!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/lljit.rs`."><title>lljit.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>
</pre></div><pre class="rust"><code><span class="kw">use </span>llvm_sys::orc2::{
lljit::{
LLVMOrcCreateLLJIT, LLVMOrcLLJITAddLLVMIRModuleWithRT, LLVMOrcLLJITGetGlobalPrefix,
LLVMOrcLLJITGetMainJITDylib, LLVMOrcLLJITLookup, LLVMOrcLLJITRef,
},
LLVMOrcCreateDynamicLibrarySearchGeneratorForProcess, LLVMOrcDefinitionGeneratorRef,
LLVMOrcJITDylibAddGenerator, LLVMOrcJITDylibCreateResourceTracker, LLVMOrcJITDylibRef,
LLVMOrcReleaseResourceTracker, LLVMOrcResourceTrackerRef, LLVMOrcResourceTrackerRemove,
};
<span class="kw">use </span>std::convert::TryFrom;
<span class="kw">use </span>std::marker::PhantomData;
<span class="kw">use super</span>::{Error, Module};
<span class="kw">use </span><span class="kw">crate</span>::SmallCStr;
<span class="doccomment">/// Marker trait to constrain function signatures that can be looked up in the JIT.
</span><span class="kw">pub trait </span>JitFn {}
<span class="kw">impl </span>JitFn <span class="kw">for unsafe extern </span><span class="string">"C" </span><span class="kw">fn</span>() -> f64 {}
<span class="doccomment">/// Wrapper for a LLVM [LLJIT](https://www.llvm.org/docs/ORCv2.html#lljit-and-lllazyjit).
</span><span class="kw">pub struct </span>LLJit {
jit: LLVMOrcLLJITRef,
dylib: LLVMOrcJITDylibRef,
}
<span class="kw">impl </span>LLJit {
<span class="doccomment">/// Create a new LLJit instance.
///
/// # Panics
///
/// Panics if LLVM API returns a `null` pointer or an error.
</span><span class="kw">pub fn </span>new() -> LLJit {
<span class="kw">let </span>(jit, dylib) = <span class="kw">unsafe </span>{
<span class="kw">let </span><span class="kw-2">mut </span>jit = std::ptr::null_mut();
<span class="kw">let </span>err = LLVMOrcCreateLLJIT(
<span class="kw-2">&mut </span>jit <span class="kw">as _</span>,
std::ptr::null_mut(), <span class="comment">/* builder: nullptr -> default */
</span>);
<span class="kw">if let </span><span class="prelude-val">Some</span>(err) = Error::from(err) {
<span class="macro">panic!</span>(<span class="string">"Error: {}"</span>, err.as_str());
}
<span class="kw">let </span>dylib = LLVMOrcLLJITGetMainJITDylib(jit);
<span class="macro">assert!</span>(!dylib.is_null());
(jit, dylib)
};
LLJit { jit, dylib }
}
<span class="doccomment">/// Add an LLVM IR module to the JIT. Return a [`ResourceTracker`], which when dropped, will
/// remove the code of the LLVM IR module from the JIT.
///
/// # Panics
///
/// Panics if LLVM API returns a `null` pointer or an error.
</span><span class="kw">pub fn </span>add_module(<span class="kw-2">&</span><span class="self">self</span>, module: Module) -> ResourceTracker<<span class="lifetime">'_</span>> {
<span class="kw">let </span>tsmod = module.into_raw_thread_safe_module();
<span class="kw">let </span>rt = <span class="kw">unsafe </span>{
<span class="kw">let </span>rt = LLVMOrcJITDylibCreateResourceTracker(<span class="self">self</span>.dylib);
<span class="kw">let </span>err = LLVMOrcLLJITAddLLVMIRModuleWithRT(<span class="self">self</span>.jit, rt, tsmod);
<span class="kw">if let </span><span class="prelude-val">Some</span>(err) = Error::from(err) {
<span class="macro">panic!</span>(<span class="string">"Error: {}"</span>, err.as_str());
}
rt
};
ResourceTracker::new(rt)
}
<span class="doccomment">/// Find the symbol with the name `sym` in the JIT.
///
/// # Panics
///
/// Panics if the symbol is not found in the JIT.
</span><span class="kw">pub fn </span>find_symbol<F: JitFn>(<span class="kw-2">&</span><span class="self">self</span>, sym: <span class="kw-2">&</span>str) -> F {
<span class="kw">let </span>sym =
SmallCStr::try_from(sym).expect(<span class="string">"Failed to convert 'sym' argument to small C string!"</span>);
<span class="kw">unsafe </span>{
<span class="kw">let </span><span class="kw-2">mut </span>addr = <span class="number">0u64</span>;
<span class="kw">let </span>err = LLVMOrcLLJITLookup(<span class="self">self</span>.jit, <span class="kw-2">&mut </span>addr <span class="kw">as _</span>, sym.as_ptr());
<span class="kw">if let </span><span class="prelude-val">Some</span>(err) = Error::from(err) {
<span class="macro">panic!</span>(<span class="string">"Error: {}"</span>, err.as_str());
}
<span class="macro">debug_assert_eq!</span>(core::mem::size_of_val(<span class="kw-2">&</span>addr), core::mem::size_of::<F>());
std::mem::transmute_copy(<span class="kw-2">&</span>addr)
}
}
<span class="doccomment">/// Enable lookup of dynamic symbols available in the current process from the JIT.
///
/// # Panics
///
/// Panics if LLVM API returns an error.
</span><span class="kw">pub fn </span>enable_process_symbols(<span class="kw-2">&</span><span class="self">self</span>) {
<span class="kw">unsafe </span>{
<span class="kw">let </span><span class="kw-2">mut </span>proc_syms_gen: LLVMOrcDefinitionGeneratorRef = std::ptr::null_mut();
<span class="kw">let </span>err = LLVMOrcCreateDynamicLibrarySearchGeneratorForProcess(
<span class="kw-2">&mut </span>proc_syms_gen <span class="kw">as _</span>,
<span class="self">self</span>.global_prefix(),
<span class="prelude-val">None</span>, <span class="comment">/* filter */
</span>std::ptr::null_mut(), <span class="comment">/* filter ctx */
</span>);
<span class="kw">if let </span><span class="prelude-val">Some</span>(err) = Error::from(err) {
<span class="macro">panic!</span>(<span class="string">"Error: {}"</span>, err.as_str());
}
LLVMOrcJITDylibAddGenerator(<span class="self">self</span>.dylib, proc_syms_gen);
}
}
<span class="doccomment">/// Return the global prefix character according to the LLJITs data layout.
</span><span class="kw">fn </span>global_prefix(<span class="kw-2">&</span><span class="self">self</span>) -> libc::c_char {
<span class="kw">unsafe </span>{ LLVMOrcLLJITGetGlobalPrefix(<span class="self">self</span>.jit) }
}
}
<span class="doccomment">/// A resource handle for code added to an [`LLJit`] instance.
///
/// When a `ResourceTracker` handle is dropped, the code corresponding to the handle will be
/// removed from the JIT.
</span><span class="kw">pub struct </span>ResourceTracker<<span class="lifetime">'jit</span>>(LLVMOrcResourceTrackerRef, PhantomData<<span class="kw-2">&</span><span class="lifetime">'jit </span>()>);
<span class="kw">impl</span><<span class="lifetime">'jit</span>> ResourceTracker<<span class="lifetime">'jit</span>> {
<span class="kw">fn </span>new(rt: LLVMOrcResourceTrackerRef) -> ResourceTracker<<span class="lifetime">'jit</span>> {
<span class="macro">assert!</span>(!rt.is_null());
ResourceTracker(rt, PhantomData)
}
}
<span class="kw">impl </span>Drop <span class="kw">for </span>ResourceTracker<<span class="lifetime">'_</span>> {
<span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) {
<span class="kw">unsafe </span>{
<span class="kw">let </span>err = LLVMOrcResourceTrackerRemove(<span class="self">self</span>.<span class="number">0</span>);
<span class="kw">if let </span><span class="prelude-val">Some</span>(err) = Error::from(err) {
<span class="macro">panic!</span>(<span class="string">"Error: {}"</span>, err.as_str());
}
LLVMOrcReleaseResourceTracker(<span class="self">self</span>.<span class="number">0</span>);
};
}
}
</code></pre></div></section></main></body></html>
|
