aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/llvm_kaleidoscope_rs/llvm/mod.rs.html
diff options
context:
space:
mode:
authorjohannst <johannst@users.noreply.github.com>2021-09-24 22:49:57 +0000
committerjohannst <johannst@users.noreply.github.com>2021-09-24 22:49:57 +0000
commit4b1a7d8a1d315090fb808ba4695bbacdc91e1aff (patch)
treebefae4a33b331e0e8c322a4c3ea5587b4c94898e /src/llvm_kaleidoscope_rs/llvm/mod.rs.html
parentbb721dfa28499d340baeec1dd730ec1cd771fdcf (diff)
downloadllvm-kaleidoscope-rs-4b1a7d8a1d315090fb808ba4695bbacdc91e1aff.tar.gz
llvm-kaleidoscope-rs-4b1a7d8a1d315090fb808ba4695bbacdc91e1aff.zip
deploy: 6eb6ad9f574c783d471f6a863299af25b6f5a8c7
Diffstat (limited to 'src/llvm_kaleidoscope_rs/llvm/mod.rs.html')
-rw-r--r--src/llvm_kaleidoscope_rs/llvm/mod.rs.html161
1 files changed, 161 insertions, 0 deletions
diff --git a/src/llvm_kaleidoscope_rs/llvm/mod.rs.html b/src/llvm_kaleidoscope_rs/llvm/mod.rs.html
new file mode 100644
index 0000000..d6eb8b2
--- /dev/null
+++ b/src/llvm_kaleidoscope_rs/llvm/mod.rs.html
@@ -0,0 +1,161 @@
+<!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&#x2F;llvm&#x2F;mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.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">&#9776;</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>
+</pre><pre class="rust">
+<span class="doccomment">//! Safe wrapper around the LLVM C API.</span>
+<span class="doccomment">//!</span>
+<span class="doccomment">//! References returned from the LLVM API are tied to the `&#39;llvm` lifetime which is bound to the</span>
+<span class="doccomment">//! context where the objects are created in.</span>
+<span class="doccomment">//! We do not offer wrappers to remove or delete any objects in the context and therefore all the</span>
+<span class="doccomment">//! references will be valid for the liftime of the context.</span>
+<span class="doccomment">//!</span>
+<span class="doccomment">//! For the scope of this tutorial we mainly use assertions to validate the results from the LLVM</span>
+<span class="doccomment">//! API calls.</span>
+
+<span class="kw">use</span> <span class="ident">llvm_sys</span>::{
+ <span class="ident">core::LLVMShutdown</span>,
+ <span class="ident">error</span>::{<span class="ident">LLVMDisposeErrorMessage</span>, <span class="ident">LLVMErrorRef</span>, <span class="ident">LLVMGetErrorMessage</span>},
+ <span class="ident">prelude::LLVMBasicBlockRef</span>,
+ <span class="ident">target</span>::{
+ <span class="ident">LLVM_InitializeNativeAsmParser</span>, <span class="ident">LLVM_InitializeNativeAsmPrinter</span>,
+ <span class="ident">LLVM_InitializeNativeTarget</span>,
+ },
+};
+
+<span class="kw">use</span> <span class="ident">std::ffi::CStr</span>;
+<span class="kw">use</span> <span class="ident">std::marker::PhantomData</span>;
+
+<span class="kw">mod</span> <span class="ident">builder</span>;
+<span class="kw">mod</span> <span class="ident">lljit</span>;
+<span class="kw">mod</span> <span class="ident">module</span>;
+<span class="kw">mod</span> <span class="ident">pass_manager</span>;
+<span class="kw">mod</span> <span class="ident">type_</span>;
+<span class="kw">mod</span> <span class="ident">value</span>;
+
+<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">builder::IRBuilder</span>;
+<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">lljit</span>::{<span class="ident">LLJit</span>, <span class="ident">ResourceTracker</span>};
+<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">module::Module</span>;
+<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">pass_manager::FunctionPassManager</span>;
+<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">type_::Type</span>;
+<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">value</span>::{<span class="ident">FnValue</span>, <span class="ident">Value</span>};
+
+<span class="doccomment">/// Wrapper for a LLVM Basic Block.</span>
+<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Copy</span>, <span class="ident">Clone</span>)]</span>
+<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">BasicBlock</span><span class="op">&lt;</span><span class="lifetime">&#39;llvm</span><span class="op">&gt;</span>(<span class="ident">LLVMBasicBlockRef</span>, <span class="ident">PhantomData</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="lifetime">&#39;llvm</span> ()<span class="op">&gt;</span>);
+
+<span class="kw">struct</span> <span class="ident">Error</span><span class="op">&lt;</span><span class="lifetime">&#39;llvm</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="lifetime">&#39;llvm</span> <span class="kw-2">mut</span> <span class="ident">libc::c_char</span>);
+
+<span class="kw">impl</span><span class="op">&lt;</span><span class="lifetime">&#39;llvm</span><span class="op">&gt;</span> <span class="ident">Error</span><span class="op">&lt;</span><span class="lifetime">&#39;llvm</span><span class="op">&gt;</span> {
+ <span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">err</span>: <span class="ident">LLVMErrorRef</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident">Error</span><span class="op">&lt;</span><span class="lifetime">&#39;llvm</span><span class="op">&gt;</span><span class="op">&gt;</span> {
+ (<span class="op">!</span><span class="ident">err</span>.<span class="ident">is_null</span>()).<span class="ident">then</span>(<span class="op">|</span><span class="op">|</span> <span class="ident">Error</span>(<span class="kw">unsafe</span> { <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="kw-2">*</span><span class="ident">LLVMGetErrorMessage</span>(<span class="ident">err</span>) }))
+ }
+
+ <span class="kw">fn</span> <span class="ident">as_str</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="kw-2">&amp;</span><span class="ident">str</span> {
+ <span class="kw">unsafe</span> { <span class="ident">CStr::from_ptr</span>(<span class="self">self</span>.<span class="number">0</span>) }
+ .<span class="ident">to_str</span>()
+ .<span class="ident">expect</span>(<span class="string">&quot;Expected valid UTF8 string from LLVM API&quot;</span>)
+ }
+}
+
+<span class="kw">impl</span> <span class="ident">Drop</span> <span class="kw">for</span> <span class="ident">Error</span><span class="op">&lt;</span><span class="lifetime">&#39;_</span><span class="op">&gt;</span> {
+ <span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>) {
+ <span class="kw">unsafe</span> {
+ <span class="ident">LLVMDisposeErrorMessage</span>(<span class="self">self</span>.<span class="number">0</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">libc::c_char</span>);
+ }
+ }
+}
+
+<span class="doccomment">/// Initialize native target for corresponding to host (useful for jitting).</span>
+<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">initialize_native_taget</span>() {
+ <span class="kw">unsafe</span> {
+ <span class="macro">assert_eq!</span>(<span class="ident">LLVM_InitializeNativeTarget</span>(), <span class="number">0</span>);
+ <span class="macro">assert_eq!</span>(<span class="ident">LLVM_InitializeNativeAsmParser</span>(), <span class="number">0</span>);
+ <span class="macro">assert_eq!</span>(<span class="ident">LLVM_InitializeNativeAsmPrinter</span>(), <span class="number">0</span>);
+ }
+}
+
+<span class="doccomment">/// Deallocate and destroy all &quot;ManagedStatic&quot; variables.</span>
+<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">shutdown</span>() {
+ <span class="kw">unsafe</span> {
+ <span class="ident">LLVMShutdown</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
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-22 09:25:13 +0000