diff options
author | johannst <johannst@users.noreply.github.com> | 2021-09-24 22:49:57 +0000 |
---|---|---|
committer | johannst <johannst@users.noreply.github.com> | 2021-09-24 22:49:57 +0000 |
commit | 4b1a7d8a1d315090fb808ba4695bbacdc91e1aff (patch) | |
tree | befae4a33b331e0e8c322a4c3ea5587b4c94898e /src/llvm_kaleidoscope_rs/llvm/lljit.rs.html | |
parent | bb721dfa28499d340baeec1dd730ec1cd771fdcf (diff) | |
download | llvm-kaleidoscope-rs-4b1a7d8a1d315090fb808ba4695bbacdc91e1aff.tar.gz llvm-kaleidoscope-rs-4b1a7d8a1d315090fb808ba4695bbacdc91e1aff.zip |
deploy: 6eb6ad9f574c783d471f6a863299af25b6f5a8c7
Diffstat (limited to 'src/llvm_kaleidoscope_rs/llvm/lljit.rs.html')
-rw-r--r-- | src/llvm_kaleidoscope_rs/llvm/lljit.rs.html | 307 |
1 files changed, 307 insertions, 0 deletions
diff --git a/src/llvm_kaleidoscope_rs/llvm/lljit.rs.html b/src/llvm_kaleidoscope_rs/llvm/lljit.rs.html new file mode 100644 index 0000000..20420f8 --- /dev/null +++ b/src/llvm_kaleidoscope_rs/llvm/lljit.rs.html @@ -0,0 +1,307 @@ +<!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`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lljit.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 width="18" height="18" alt="Pick another theme!" src="../../../brush.svg"></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 width="18" height="18" alt="Change settings" src="../../../wheel.svg"></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> +<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> +</pre><pre class="rust"> +<span class="kw">use</span> <span class="ident">llvm_sys::orc2</span>::{ + <span class="ident">lljit</span>::{ + <span class="ident">LLVMOrcCreateLLJIT</span>, <span class="ident">LLVMOrcLLJITAddLLVMIRModuleWithRT</span>, <span class="ident">LLVMOrcLLJITGetGlobalPrefix</span>, + <span class="ident">LLVMOrcLLJITGetMainJITDylib</span>, <span class="ident">LLVMOrcLLJITLookup</span>, <span class="ident">LLVMOrcLLJITRef</span>, + }, + <span class="ident">LLVMOrcCreateDynamicLibrarySearchGeneratorForProcess</span>, <span class="ident">LLVMOrcDefinitionGeneratorRef</span>, + <span class="ident">LLVMOrcJITDylibAddGenerator</span>, <span class="ident">LLVMOrcJITDylibCreateResourceTracker</span>, <span class="ident">LLVMOrcJITDylibRef</span>, + <span class="ident">LLVMOrcReleaseResourceTracker</span>, <span class="ident">LLVMOrcResourceTrackerRef</span>, <span class="ident">LLVMOrcResourceTrackerRemove</span>, +}; + +<span class="kw">use</span> <span class="ident">std::convert::TryFrom</span>; +<span class="kw">use</span> <span class="ident">std::marker::PhantomData</span>; + +<span class="kw">use</span> <span class="kw">super</span>::{<span class="ident">Error</span>, <span class="ident">Module</span>}; +<span class="kw">use</span> <span class="kw">crate</span><span class="ident">::SmallCStr</span>; + +<span class="doccomment">/// Marker trait to constrain function signatures that can be looked up in the JIT.</span> +<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">JitFn</span> {} + +<span class="kw">impl</span> <span class="ident">JitFn</span> <span class="kw">for</span> <span class="kw">unsafe</span> <span class="kw">extern</span> <span class="string">"C"</span> <span class="kw">fn</span>() <span class="op">-</span><span class="op">></span> <span class="ident">f64</span> {} + +<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">LLJit</span> { + <span class="ident">jit</span>: <span class="ident">LLVMOrcLLJITRef</span>, + <span class="ident">dylib</span>: <span class="ident">LLVMOrcJITDylibRef</span>, +} + +<span class="kw">impl</span> <span class="ident">LLJit</span> { + <span class="doccomment">/// Create a new LLJit instance.</span> + <span class="doccomment">///</span> + <span class="doccomment">/// # Panics</span> + <span class="doccomment">///</span> + <span class="doccomment">/// Panics if LLVM API returns a `null` pointer or an error.</span> + <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-</span><span class="op">></span> <span class="ident">LLJit</span> { + <span class="kw">let</span> (<span class="ident">jit</span>, <span class="ident">dylib</span>) <span class="op">=</span> <span class="kw">unsafe</span> { + <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">jit</span> <span class="op">=</span> <span class="ident">std::ptr::null_mut</span>(); + <span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">LLVMOrcCreateLLJIT</span>( + <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">jit</span> <span class="kw">as</span> <span class="kw">_</span>, + <span class="ident">std::ptr::null_mut</span>(), <span class="comment">/* builder: nullptr -> default */</span> + ); + + <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">err</span>) <span class="op">=</span> <span class="ident">Error::from</span>(<span class="ident">err</span>) { + <span class="macro">panic!</span>(<span class="string">"Error: {}"</span>, <span class="ident">err</span>.<span class="ident">as_str</span>()); + } + + <span class="kw">let</span> <span class="ident">dylib</span> <span class="op">=</span> <span class="ident">LLVMOrcLLJITGetMainJITDylib</span>(<span class="ident">jit</span>); + <span class="macro">assert!</span>(<span class="op">!</span><span class="ident">dylib</span>.<span class="ident">is_null</span>()); + + (<span class="ident">jit</span>, <span class="ident">dylib</span>) + }; + + <span class="ident">LLJit</span> { <span class="ident">jit</span>, <span class="ident">dylib</span> } + } + + <span class="doccomment">/// Add an LLVM IR module to the JIT. Return a [`ResourceTracker`], which when dropped, will</span> + <span class="doccomment">/// remove the code of the LLVM IR module from the JIT.</span> + <span class="doccomment">///</span> + <span class="doccomment">/// # Panics</span> + <span class="doccomment">///</span> + <span class="doccomment">/// Panics if LLVM API returns a `null` pointer or an error.</span> + <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">add_module</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">module</span>: <span class="ident">Module</span>) <span class="op">-</span><span class="op">></span> <span class="ident">ResourceTracker</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span> { + <span class="kw">let</span> <span class="ident">tsmod</span> <span class="op">=</span> <span class="ident">module</span>.<span class="ident">into_raw_thread_safe_module</span>(); + + <span class="kw">let</span> <span class="ident">rt</span> <span class="op">=</span> <span class="kw">unsafe</span> { + <span class="kw">let</span> <span class="ident">rt</span> <span class="op">=</span> <span class="ident">LLVMOrcJITDylibCreateResourceTracker</span>(<span class="self">self</span>.<span class="ident">dylib</span>); + <span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">LLVMOrcLLJITAddLLVMIRModuleWithRT</span>(<span class="self">self</span>.<span class="ident">jit</span>, <span class="ident">rt</span>, <span class="ident">tsmod</span>); + + <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">err</span>) <span class="op">=</span> <span class="ident">Error::from</span>(<span class="ident">err</span>) { + <span class="macro">panic!</span>(<span class="string">"Error: {}"</span>, <span class="ident">err</span>.<span class="ident">as_str</span>()); + } + + <span class="ident">rt</span> + }; + + <span class="ident">ResourceTracker::new</span>(<span class="ident">rt</span>) + } + + <span class="doccomment">/// Find the symbol with the name `sym` in the JIT.</span> + <span class="doccomment">///</span> + <span class="doccomment">/// # Panics</span> + <span class="doccomment">///</span> + <span class="doccomment">/// Panics if the symbol is not found in the JIT.</span> + <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">find_symbol</span><span class="op"><</span><span class="ident">F</span>: <span class="ident">JitFn</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">sym</span>: <span class="kw-2">&</span><span class="ident">str</span>) <span class="op">-</span><span class="op">></span> <span class="ident">F</span> { + <span class="kw">let</span> <span class="ident">sym</span> <span class="op">=</span> + <span class="ident">SmallCStr::try_from</span>(<span class="ident">sym</span>).<span class="ident">expect</span>(<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> <span class="ident">addr</span> <span class="op">=</span> <span class="number">0u64</span>; + <span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">LLVMOrcLLJITLookup</span>(<span class="self">self</span>.<span class="ident">jit</span>, <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">addr</span> <span class="kw">as</span> <span class="kw">_</span>, <span class="ident">sym</span>.<span class="ident">as_ptr</span>()); + + <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">err</span>) <span class="op">=</span> <span class="ident">Error::from</span>(<span class="ident">err</span>) { + <span class="macro">panic!</span>(<span class="string">"Error: {}"</span>, <span class="ident">err</span>.<span class="ident">as_str</span>()); + } + + <span class="macro">debug_assert_eq!</span>(<span class="ident">core::mem::size_of_val</span>(<span class="kw-2">&</span><span class="ident">addr</span>), <span class="ident">core::mem::size_of</span>::<span class="op"><</span><span class="ident">F</span><span class="op">></span>()); + <span class="ident">std::mem::transmute_copy</span>(<span class="kw-2">&</span><span class="ident">addr</span>) + } + } + + <span class="doccomment">/// Enable lookup of dynamic symbols available in the current process from the JIT.</span> + <span class="doccomment">///</span> + <span class="doccomment">/// # Panics</span> + <span class="doccomment">///</span> + <span class="doccomment">/// Panics if LLVM API returns an error.</span> + <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">enable_process_symbols</span>(<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> <span class="ident">proc_syms_gen</span>: <span class="ident">LLVMOrcDefinitionGeneratorRef</span> <span class="op">=</span> <span class="ident">std::ptr::null_mut</span>(); + <span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">LLVMOrcCreateDynamicLibrarySearchGeneratorForProcess</span>( + <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">proc_syms_gen</span> <span class="kw">as</span> <span class="kw">_</span>, + <span class="self">self</span>.<span class="ident">global_prefix</span>(), + <span class="prelude-val">None</span>, <span class="comment">/* filter */</span> + <span class="ident">std::ptr::null_mut</span>(), <span class="comment">/* filter ctx */</span> + ); + + <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">err</span>) <span class="op">=</span> <span class="ident">Error::from</span>(<span class="ident">err</span>) { + <span class="macro">panic!</span>(<span class="string">"Error: {}"</span>, <span class="ident">err</span>.<span class="ident">as_str</span>()); + } + + <span class="ident">LLVMOrcJITDylibAddGenerator</span>(<span class="self">self</span>.<span class="ident">dylib</span>, <span class="ident">proc_syms_gen</span>); + } + } + + <span class="doccomment">/// Return the global prefix character according to the LLJITs data layout.</span> + <span class="kw">fn</span> <span class="ident">global_prefix</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">libc::c_char</span> { + <span class="kw">unsafe</span> { <span class="ident">LLVMOrcLLJITGetGlobalPrefix</span>(<span class="self">self</span>.<span class="ident">jit</span>) } + } +} + +<span class="doccomment">/// A resource handle to code added to an [`LLJit`] instance. When a `ResourceTracker` handle is</span> +<span class="doccomment">/// dropped, the code corresponding to the handle will be removed from the JIT.</span> +<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">ResourceTracker</span><span class="op"><</span><span class="lifetime">'jit</span><span class="op">></span>(<span class="ident">LLVMOrcResourceTrackerRef</span>, <span class="ident">PhantomData</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'jit</span> ()<span class="op">></span>); + +<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'jit</span><span class="op">></span> <span class="ident">ResourceTracker</span><span class="op"><</span><span class="lifetime">'jit</span><span class="op">></span> { + <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">rt</span>: <span class="ident">LLVMOrcResourceTrackerRef</span>) <span class="op">-</span><span class="op">></span> <span class="ident">ResourceTracker</span><span class="op"><</span><span class="lifetime">'jit</span><span class="op">></span> { + <span class="macro">assert!</span>(<span class="op">!</span><span class="ident">rt</span>.<span class="ident">is_null</span>()); + <span class="ident">ResourceTracker</span>(<span class="ident">rt</span>, <span class="ident">PhantomData</span>) + } +} + +<span class="kw">impl</span> <span class="ident">Drop</span> <span class="kw">for</span> <span class="ident">ResourceTracker</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span> { + <span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) { + <span class="kw">unsafe</span> { + <span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">LLVMOrcResourceTrackerRemove</span>(<span class="self">self</span>.<span class="number">0</span>); + + <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">err</span>) <span class="op">=</span> <span class="ident">Error::from</span>(<span class="ident">err</span>) { + <span class="macro">panic!</span>(<span class="string">"Error: {}"</span>, <span class="ident">err</span>.<span class="ident">as_str</span>()); + } + + <span class="ident">LLVMOrcReleaseResourceTracker</span>(<span class="self">self</span>.<span class="number">0</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>
\ No newline at end of file |