path: root/src/llvm_kaleidoscope_rs/llvm/module.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/module.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>module.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>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
</pre><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">&quot;C&quot; </span>{
    <span class="kw">fn </span>LLVMFunctionType(
        ReturnType: Type&lt;<span class="lifetime">&#39;_</span>&gt;,
        ParamTypes: <span class="kw-2">*mut </span>Type&lt;<span class="lifetime">&#39;_</span>&gt;,
        ParamCount: ::libc::c_uint,
        IsVarArg: LLVMBool,
    ) -&gt; 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>&lt;<span class="lifetime">&#39;llvm</span>&gt; 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() -&gt; <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&quot;module\0&quot;</span>.as_ptr().cast(), c);
            <span class="macro">assert!</span>(!c.is_null() &amp;&amp; !m.is_null());
            (tc, c, m)
        };

        Module { tsctx, ctx, module }
    }

    <span class="doccomment">/// Get the raw LLVM context reference.
    </span><span class="attribute">#[inline]
    </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>ctx(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; LLVMContextRef {
        <span class="self">self</span>.ctx
    }

    <span class="doccomment">/// Get the raw LLVM module reference.
    </span><span class="attribute">#[inline]
    </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>module(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; 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="attribute">#[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>) -&gt; LLVMOrcThreadSafeModuleRef {
        <span class="kw">let </span>m = std::mem::replace(<span class="kw-2">&amp;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">&amp;</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">&amp;</span><span class="self">self</span>) -&gt; Type&lt;<span class="lifetime">&#39;llvm</span>&gt; {
        <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) -&gt; ret` function.
    ///
    /// # Panics
    ///
    /// Panics if LLVM API returns a `null` pointer.
    </span><span class="kw">pub fn </span>type_fn(<span class="kw-2">&amp;</span><span class="lifetime">&#39;llvm </span><span class="self">self</span>, args: <span class="kw-2">&amp;mut </span>[Type&lt;<span class="lifetime">&#39;llvm</span>&gt;], ret: Type&lt;<span class="lifetime">&#39;llvm</span>&gt;) -&gt; Type&lt;<span class="lifetime">&#39;llvm</span>&gt; {
        <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">&amp;</span><span class="lifetime">&#39;llvm </span><span class="self">self</span>, name: <span class="kw-2">&amp;</span>str, fn_type: Type&lt;<span class="lifetime">&#39;llvm</span>&gt;) -&gt; FnValue&lt;<span class="lifetime">&#39;llvm</span>&gt; {
        <span class="macro">debug_assert_eq!</span>(
            fn_type.kind(),
            LLVMTypeKind::LLVMFunctionTypeKind,
            <span class="string">&quot;Expected a function type when adding a function!&quot;
        </span>);

        <span class="kw">let </span>name = SmallCStr::try_from(name)
            .expect(<span class="string">&quot;Failed to convert &#39;name&#39; argument to small C string!&quot;</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">&amp;</span><span class="lifetime">&#39;llvm </span><span class="self">self</span>, name: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Option</span>&lt;FnValue&lt;<span class="lifetime">&#39;llvm</span>&gt;&gt; {
        <span class="kw">let </span>name = SmallCStr::try_from(name)
            .expect(<span class="string">&quot;Failed to convert &#39;name&#39; argument to small C string!&quot;</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">&amp;</span><span class="lifetime">&#39;llvm </span><span class="self">self</span>, fn_value: FnValue&lt;<span class="lifetime">&#39;llvm</span>&gt;) -&gt; BasicBlock&lt;<span class="lifetime">&#39;llvm</span>&gt; {
        <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&quot;block\0&quot;</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">&amp;</span><span class="self">self</span>) -&gt; BasicBlock&lt;<span class="lifetime">&#39;llvm</span>&gt; {
        <span class="kw">let </span>block = <span class="kw">unsafe </span>{ LLVMCreateBasicBlockInContext(<span class="self">self</span>.ctx, <span class="string">b&quot;block\0&quot;</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">&amp;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></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/module.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>module.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>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
</pre><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">&quot;C&quot; </span>{
    <span class="kw">fn </span>LLVMFunctionType(
        ReturnType: Type&lt;<span class="lifetime">&#39;_</span>&gt;,
        ParamTypes: <span class="kw-2">*mut </span>Type&lt;<span class="lifetime">&#39;_</span>&gt;,
        ParamCount: ::libc::c_uint,
        IsVarArg: LLVMBool,
    ) -&gt; 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>&lt;<span class="lifetime">&#39;llvm</span>&gt; 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() -&gt; <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&quot;module\0&quot;</span>.as_ptr().cast(), c);
            <span class="macro">assert!</span>(!c.is_null() &amp;&amp; !m.is_null());
            (tc, c, m)
        };

        Module { tsctx, ctx, module }
    }

    <span class="doccomment">/// Get the raw LLVM context reference.
    </span><span class="attribute">#[inline]
    </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>ctx(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; LLVMContextRef {
        <span class="self">self</span>.ctx
    }

    <span class="doccomment">/// Get the raw LLVM module reference.
    </span><span class="attribute">#[inline]
    </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>module(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; 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="attribute">#[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>) -&gt; LLVMOrcThreadSafeModuleRef {
        <span class="kw">let </span>m = std::mem::replace(<span class="kw-2">&amp;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">&amp;</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">&amp;</span><span class="self">self</span>) -&gt; Type&lt;<span class="lifetime">&#39;llvm</span>&gt; {
        <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) -&gt; ret` function.
    ///
    /// # Panics
    ///
    /// Panics if LLVM API returns a `null` pointer.
    </span><span class="kw">pub fn </span>type_fn(<span class="kw-2">&amp;</span><span class="lifetime">&#39;llvm </span><span class="self">self</span>, args: <span class="kw-2">&amp;mut </span>[Type&lt;<span class="lifetime">&#39;llvm</span>&gt;], ret: Type&lt;<span class="lifetime">&#39;llvm</span>&gt;) -&gt; Type&lt;<span class="lifetime">&#39;llvm</span>&gt; {
        <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">&amp;</span><span class="lifetime">&#39;llvm </span><span class="self">self</span>, name: <span class="kw-2">&amp;</span>str, fn_type: Type&lt;<span class="lifetime">&#39;llvm</span>&gt;) -&gt; FnValue&lt;<span class="lifetime">&#39;llvm</span>&gt; {
        <span class="macro">debug_assert_eq!</span>(
            fn_type.kind(),
            LLVMTypeKind::LLVMFunctionTypeKind,
            <span class="string">&quot;Expected a function type when adding a function!&quot;
        </span>);

        <span class="kw">let </span>name = SmallCStr::try_from(name)
            .expect(<span class="string">&quot;Failed to convert &#39;name&#39; argument to small C string!&quot;</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">&amp;</span><span class="lifetime">&#39;llvm </span><span class="self">self</span>, name: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Option</span>&lt;FnValue&lt;<span class="lifetime">&#39;llvm</span>&gt;&gt; {
        <span class="kw">let </span>name = SmallCStr::try_from(name)
            .expect(<span class="string">&quot;Failed to convert &#39;name&#39; argument to small C string!&quot;</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">&amp;</span><span class="lifetime">&#39;llvm </span><span class="self">self</span>, fn_value: FnValue&lt;<span class="lifetime">&#39;llvm</span>&gt;) -&gt; BasicBlock&lt;<span class="lifetime">&#39;llvm</span>&gt; {
        <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&quot;block\0&quot;</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">&amp;</span><span class="self">self</span>) -&gt; BasicBlock&lt;<span class="lifetime">&#39;llvm</span>&gt; {
        <span class="kw">let </span>block = <span class="kw">unsafe </span>{ LLVMCreateBasicBlockInContext(<span class="self">self</span>.ctx, <span class="string">b&quot;block\0&quot;</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">&amp;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></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>