path: root/src/llvm_kaleidoscope_rs/llvm/lljit.rs.html

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

<!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="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>
</pre><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">&quot;C&quot; </span><span class="kw">fn</span>() -&gt; 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() -&gt; 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">&amp;mut </span>jit <span class="kw">as _</span>,
                std::ptr::null_mut(), <span class="comment">/* builder: nullptr -&gt; 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">&quot;Error: {}&quot;</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">&amp;</span><span class="self">self</span>, module: Module) -&gt; ResourceTracker&lt;<span class="lifetime">&#39;_</span>&gt; {
        <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">&quot;Error: {}&quot;</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&lt;F: JitFn&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, sym: <span class="kw-2">&amp;</span>str) -&gt; F {
        <span class="kw">let </span>sym =
            SmallCStr::try_from(sym).expect(<span class="string">&quot;Failed to convert &#39;sym&#39; argument to small C string!&quot;</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">&amp;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">&quot;Error: {}&quot;</span>, err.as_str());
            }

            <span class="macro">debug_assert_eq!</span>(core::mem::size_of_val(<span class="kw-2">&amp;</span>addr), core::mem::size_of::&lt;F&gt;());
            std::mem::transmute_copy(<span class="kw-2">&amp;</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">&amp;</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">&amp;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">&quot;Error: {}&quot;</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">&amp;</span><span class="self">self</span>) -&gt; 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&lt;<span class="lifetime">&#39;jit</span>&gt;(LLVMOrcResourceTrackerRef, PhantomData&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;jit </span>()&gt;);

<span class="kw">impl</span>&lt;<span class="lifetime">&#39;jit</span>&gt; ResourceTracker&lt;<span class="lifetime">&#39;jit</span>&gt; {
    <span class="kw">fn </span>new(rt: LLVMOrcResourceTrackerRef) -&gt; ResourceTracker&lt;<span class="lifetime">&#39;jit</span>&gt; {
        <span class="macro">assert!</span>(!rt.is_null());
        ResourceTracker(rt, PhantomData)
    }
}

<span class="kw">impl </span>Drop <span class="kw">for </span>ResourceTracker&lt;<span class="lifetime">&#39;_</span>&gt; {
    <span class="kw">fn </span>drop(<span class="kw-2">&amp;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">&quot;Error: {}&quot;</span>, err.as_str());
            }

            LLVMOrcReleaseResourceTracker(<span class="self">self</span>.<span class="number">0</span>);
        };
    }
}
</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>
<!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="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>
</pre><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">&quot;C&quot; </span><span class="kw">fn</span>() -&gt; 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() -&gt; 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">&amp;mut </span>jit <span class="kw">as _</span>,
                std::ptr::null_mut(), <span class="comment">/* builder: nullptr -&gt; 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">&quot;Error: {}&quot;</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">&amp;</span><span class="self">self</span>, module: Module) -&gt; ResourceTracker&lt;<span class="lifetime">&#39;_</span>&gt; {
        <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">&quot;Error: {}&quot;</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&lt;F: JitFn&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, sym: <span class="kw-2">&amp;</span>str) -&gt; F {
        <span class="kw">let </span>sym =
            SmallCStr::try_from(sym).expect(<span class="string">&quot;Failed to convert &#39;sym&#39; argument to small C string!&quot;</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">&amp;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">&quot;Error: {}&quot;</span>, err.as_str());
            }

            <span class="macro">debug_assert_eq!</span>(core::mem::size_of_val(<span class="kw-2">&amp;</span>addr), core::mem::size_of::&lt;F&gt;());
            std::mem::transmute_copy(<span class="kw-2">&amp;</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">&amp;</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">&amp;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">&quot;Error: {}&quot;</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">&amp;</span><span class="self">self</span>) -&gt; 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&lt;<span class="lifetime">&#39;jit</span>&gt;(LLVMOrcResourceTrackerRef, PhantomData&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;jit </span>()&gt;);

<span class="kw">impl</span>&lt;<span class="lifetime">&#39;jit</span>&gt; ResourceTracker&lt;<span class="lifetime">&#39;jit</span>&gt; {
    <span class="kw">fn </span>new(rt: LLVMOrcResourceTrackerRef) -&gt; ResourceTracker&lt;<span class="lifetime">&#39;jit</span>&gt; {
        <span class="macro">assert!</span>(!rt.is_null());
        ResourceTracker(rt, PhantomData)
    }
}

<span class="kw">impl </span>Drop <span class="kw">for </span>ResourceTracker&lt;<span class="lifetime">&#39;_</span>&gt; {
    <span class="kw">fn </span>drop(<span class="kw-2">&amp;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">&quot;Error: {}&quot;</span>, err.as_str());
            }

            LLVMOrcReleaseResourceTracker(<span class="self">self</span>.<span class="number">0</span>);
        };
    }
}
</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>