diff options
Diffstat (limited to 'src/llvm_kaleidoscope_rs/llvm.rs.html')
| -rw-r--r-- | src/llvm_kaleidoscope_rs/llvm.rs.html | 1073 |
1 files changed, 0 insertions, 1073 deletions
diff --git a/src/llvm_kaleidoscope_rs/llvm.rs.html b/src/llvm_kaleidoscope_rs/llvm.rs.html deleted file mode 100644 index 2da418a..0000000 --- a/src/llvm_kaleidoscope_rs/llvm.rs.html +++ /dev/null @@ -1,1073 +0,0 @@ -<!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.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>llvm.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 src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></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 src="../../wheel.svg" width="18" height="18" alt="Change settings"></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> -<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> -<span id="211">211</span> -<span id="212">212</span> -<span id="213">213</span> -<span id="214">214</span> -<span id="215">215</span> -<span id="216">216</span> -<span id="217">217</span> -<span id="218">218</span> -<span id="219">219</span> -<span id="220">220</span> -<span id="221">221</span> -<span id="222">222</span> -<span id="223">223</span> -<span id="224">224</span> -<span id="225">225</span> -<span id="226">226</span> -<span id="227">227</span> -<span id="228">228</span> -<span id="229">229</span> -<span id="230">230</span> -<span id="231">231</span> -<span id="232">232</span> -<span id="233">233</span> -<span id="234">234</span> -<span id="235">235</span> -<span id="236">236</span> -<span id="237">237</span> -<span id="238">238</span> -<span id="239">239</span> -<span id="240">240</span> -<span id="241">241</span> -<span id="242">242</span> -<span id="243">243</span> -<span id="244">244</span> -<span id="245">245</span> -<span id="246">246</span> -<span id="247">247</span> -<span id="248">248</span> -<span id="249">249</span> -<span id="250">250</span> -<span id="251">251</span> -<span id="252">252</span> -<span id="253">253</span> -<span id="254">254</span> -<span id="255">255</span> -<span id="256">256</span> -<span id="257">257</span> -<span id="258">258</span> -<span id="259">259</span> -<span id="260">260</span> -<span id="261">261</span> -<span id="262">262</span> -<span id="263">263</span> -<span id="264">264</span> -<span id="265">265</span> -<span id="266">266</span> -<span id="267">267</span> -<span id="268">268</span> -<span id="269">269</span> -<span id="270">270</span> -<span id="271">271</span> -<span id="272">272</span> -<span id="273">273</span> -<span id="274">274</span> -<span id="275">275</span> -<span id="276">276</span> -<span id="277">277</span> -<span id="278">278</span> -<span id="279">279</span> -<span id="280">280</span> -<span id="281">281</span> -<span id="282">282</span> -<span id="283">283</span> -<span id="284">284</span> -<span id="285">285</span> -<span id="286">286</span> -<span id="287">287</span> -<span id="288">288</span> -<span id="289">289</span> -<span id="290">290</span> -<span id="291">291</span> -<span id="292">292</span> -<span id="293">293</span> -<span id="294">294</span> -<span id="295">295</span> -<span id="296">296</span> -<span id="297">297</span> -<span id="298">298</span> -<span id="299">299</span> -<span id="300">300</span> -<span id="301">301</span> -<span id="302">302</span> -<span id="303">303</span> -<span id="304">304</span> -<span id="305">305</span> -<span id="306">306</span> -<span id="307">307</span> -<span id="308">308</span> -<span id="309">309</span> -<span id="310">310</span> -<span id="311">311</span> -<span id="312">312</span> -<span id="313">313</span> -<span id="314">314</span> -<span id="315">315</span> -<span id="316">316</span> -<span id="317">317</span> -<span id="318">318</span> -<span id="319">319</span> -<span id="320">320</span> -<span id="321">321</span> -<span id="322">322</span> -<span id="323">323</span> -<span id="324">324</span> -<span id="325">325</span> -<span id="326">326</span> -<span id="327">327</span> -<span id="328">328</span> -<span id="329">329</span> -<span id="330">330</span> -<span id="331">331</span> -<span id="332">332</span> -<span id="333">333</span> -<span id="334">334</span> -<span id="335">335</span> -<span id="336">336</span> -<span id="337">337</span> -<span id="338">338</span> -<span id="339">339</span> -<span id="340">340</span> -<span id="341">341</span> -<span id="342">342</span> -<span id="343">343</span> -<span id="344">344</span> -<span id="345">345</span> -<span id="346">346</span> -<span id="347">347</span> -<span id="348">348</span> -<span id="349">349</span> -<span id="350">350</span> -<span id="351">351</span> -<span id="352">352</span> -<span id="353">353</span> -<span id="354">354</span> -<span id="355">355</span> -<span id="356">356</span> -<span id="357">357</span> -<span id="358">358</span> -<span id="359">359</span> -<span id="360">360</span> -<span id="361">361</span> -<span id="362">362</span> -<span id="363">363</span> -<span id="364">364</span> -<span id="365">365</span> -<span id="366">366</span> -<span id="367">367</span> -<span id="368">368</span> -<span id="369">369</span> -<span id="370">370</span> -<span id="371">371</span> -<span id="372">372</span> -<span id="373">373</span> -<span id="374">374</span> -<span id="375">375</span> -<span id="376">376</span> -<span id="377">377</span> -<span id="378">378</span> -<span id="379">379</span> -<span id="380">380</span> -<span id="381">381</span> -<span id="382">382</span> -<span id="383">383</span> -<span id="384">384</span> -<span id="385">385</span> -<span id="386">386</span> -<span id="387">387</span> -<span id="388">388</span> -<span id="389">389</span> -<span id="390">390</span> -<span id="391">391</span> -<span id="392">392</span> -<span id="393">393</span> -<span id="394">394</span> -<span id="395">395</span> -<span id="396">396</span> -<span id="397">397</span> -<span id="398">398</span> -<span id="399">399</span> -<span id="400">400</span> -<span id="401">401</span> -<span id="402">402</span> -<span id="403">403</span> -<span id="404">404</span> -<span id="405">405</span> -<span id="406">406</span> -<span id="407">407</span> -<span id="408">408</span> -<span id="409">409</span> -<span id="410">410</span> -<span id="411">411</span> -<span id="412">412</span> -<span id="413">413</span> -<span id="414">414</span> -<span id="415">415</span> -<span id="416">416</span> -<span id="417">417</span> -<span id="418">418</span> -<span id="419">419</span> -<span id="420">420</span> -<span id="421">421</span> -<span id="422">422</span> -<span id="423">423</span> -<span id="424">424</span> -<span id="425">425</span> -<span id="426">426</span> -<span id="427">427</span> -<span id="428">428</span> -<span id="429">429</span> -<span id="430">430</span> -<span id="431">431</span> -<span id="432">432</span> -<span id="433">433</span> -<span id="434">434</span> -<span id="435">435</span> -<span id="436">436</span> -<span id="437">437</span> -<span id="438">438</span> -<span id="439">439</span> -<span id="440">440</span> -<span id="441">441</span> -<span id="442">442</span> -<span id="443">443</span> -<span id="444">444</span> -<span id="445">445</span> -<span id="446">446</span> -<span id="447">447</span> -<span id="448">448</span> -<span id="449">449</span> -<span id="450">450</span> -<span id="451">451</span> -<span id="452">452</span> -<span id="453">453</span> -<span id="454">454</span> -<span id="455">455</span> -<span id="456">456</span> -<span id="457">457</span> -<span id="458">458</span> -<span id="459">459</span> -<span id="460">460</span> -<span id="461">461</span> -<span id="462">462</span> -<span id="463">463</span> -<span id="464">464</span> -<span id="465">465</span> -<span id="466">466</span> -<span id="467">467</span> -<span id="468">468</span> -<span id="469">469</span> -<span id="470">470</span> -<span id="471">471</span> -<span id="472">472</span> -<span id="473">473</span> -<span id="474">474</span> -<span id="475">475</span> -<span id="476">476</span> -<span id="477">477</span> -<span id="478">478</span> -<span id="479">479</span> -<span id="480">480</span> -<span id="481">481</span> -<span id="482">482</span> -<span id="483">483</span> -<span id="484">484</span> -<span id="485">485</span> -<span id="486">486</span> -<span id="487">487</span> -<span id="488">488</span> -<span id="489">489</span> -<span id="490">490</span> -<span id="491">491</span> -<span id="492">492</span> -<span id="493">493</span> -<span id="494">494</span> -<span id="495">495</span> -<span id="496">496</span> -<span id="497">497</span> -<span id="498">498</span> -<span id="499">499</span> -<span id="500">500</span> -<span id="501">501</span> -<span id="502">502</span> -<span id="503">503</span> -<span id="504">504</span> -<span id="505">505</span> -<span id="506">506</span> -<span id="507">507</span> -<span id="508">508</span> -<span id="509">509</span> -<span id="510">510</span> -<span id="511">511</span> -<span id="512">512</span> -<span id="513">513</span> -<span id="514">514</span> -<span id="515">515</span> -<span id="516">516</span> -<span id="517">517</span> -<span id="518">518</span> -<span id="519">519</span> -<span id="520">520</span> -<span id="521">521</span> -<span id="522">522</span> -<span id="523">523</span> -<span id="524">524</span> -<span id="525">525</span> -<span id="526">526</span> -<span id="527">527</span> -<span id="528">528</span> -<span id="529">529</span> -<span id="530">530</span> -<span id="531">531</span> -<span id="532">532</span> -<span id="533">533</span> -<span id="534">534</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 `'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="kw">use</span> <span class="ident">llvm_sys::analysis</span>::{<span class="ident">LLVMVerifierFailureAction</span>, <span class="ident">LLVMVerifyFunction</span>}; -<span class="kw">use</span> <span class="ident">llvm_sys::core</span>::{ - <span class="ident">LLVMAddFunction</span>, <span class="ident">LLVMAppendBasicBlockInContext</span>, <span class="ident">LLVMBuildFAdd</span>, <span class="ident">LLVMBuildFCmp</span>, <span class="ident">LLVMBuildFMul</span>, - <span class="ident">LLVMBuildFSub</span>, <span class="ident">LLVMBuildRet</span>, <span class="ident">LLVMBuildUIToFP</span>, <span class="ident">LLVMConstReal</span>, <span class="ident">LLVMContextCreate</span>, - <span class="ident">LLVMContextDispose</span>, <span class="ident">LLVMCountBasicBlocks</span>, <span class="ident">LLVMCountParams</span>, <span class="ident">LLVMCreateBuilderInContext</span>, - <span class="ident">LLVMDisposeBuilder</span>, <span class="ident">LLVMDisposeModule</span>, <span class="ident">LLVMDoubleTypeInContext</span>, <span class="ident">LLVMDumpModule</span>, <span class="ident">LLVMDumpType</span>, - <span class="ident">LLVMDumpValue</span>, <span class="ident">LLVMGetNamedFunction</span>, <span class="ident">LLVMGetParam</span>, <span class="ident">LLVMGetReturnType</span>, <span class="ident">LLVMGetTypeKind</span>, - <span class="ident">LLVMGetValueKind</span>, <span class="ident">LLVMGetValueName2</span>, <span class="ident">LLVMModuleCreateWithNameInContext</span>, - <span class="ident">LLVMPositionBuilderAtEnd</span>, <span class="ident">LLVMSetValueName2</span>, <span class="ident">LLVMTypeOf</span>, -}; -<span class="kw">use</span> <span class="ident">llvm_sys::prelude</span>::{ - <span class="ident">LLVMBasicBlockRef</span>, <span class="ident">LLVMBool</span>, <span class="ident">LLVMBuilderRef</span>, <span class="ident">LLVMContextRef</span>, <span class="ident">LLVMModuleRef</span>, <span class="ident">LLVMTypeRef</span>, - <span class="ident">LLVMValueRef</span>, -}; -<span class="kw">use</span> <span class="ident">llvm_sys</span>::{<span class="ident">LLVMRealPredicate</span>, <span class="ident">LLVMTypeKind</span>, <span class="ident">LLVMValueKind</span>}; - -<span class="kw">use</span> <span class="ident">std::convert::TryFrom</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">use</span> <span class="ident">std::ops::Deref</span>; - -<span class="kw">use</span> <span class="kw">crate</span><span class="ident">::SmallCStr</span>; - -<span class="comment">// Definition of LLVM C API functions using our `repr(transparent)` types.</span> -<span class="kw">extern</span> <span class="string">"C"</span> { - <span class="kw">fn</span> <span class="ident">LLVMFunctionType</span>( - <span class="ident">ReturnType</span>: <span class="ident">Type</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>, - <span class="ident">ParamTypes</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">Type</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>, - <span class="ident">ParamCount</span>: <span class="ident">::libc::c_uint</span>, - <span class="ident">IsVarArg</span>: <span class="ident">LLVMBool</span>, - ) <span class="op">-</span><span class="op">></span> <span class="ident">LLVMTypeRef</span>; - <span class="kw">fn</span> <span class="ident">LLVMBuildCall2</span>( - <span class="ident">arg1</span>: <span class="ident">LLVMBuilderRef</span>, - <span class="ident">arg2</span>: <span class="ident">Type</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>, - <span class="ident">Fn</span>: <span class="ident">FnValue</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>, - <span class="ident">Args</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>, - <span class="ident">NumArgs</span>: <span class="ident">::libc::c_uint</span>, - <span class="ident">Name</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">::libc::c_char</span>, - ) <span class="op">-</span><span class="op">></span> <span class="ident">LLVMValueRef</span>; -} - -<span class="comment">// ====================</span> -<span class="comment">// Module / Context</span> -<span class="comment">// ====================</span> - -<span class="doccomment">/// Wrapper for a LLVM Module with its own LLVM Context.</span> -<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Module</span> { - <span class="ident">ctx</span>: <span class="ident">LLVMContextRef</span>, - <span class="ident">module</span>: <span class="ident">LLVMModuleRef</span>, -} - -<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> <span class="ident">Module</span> { - <span class="doccomment">/// Create a new Module instance.</span> - <span class="doccomment">///</span> - <span class="doccomment">/// # Panics</span> - <span class="doccomment">///</span> - <span class="doccomment">/// Panics if creating the context or the module fails.</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="self">Self</span> { - <span class="kw">let</span> (<span class="ident">ctx</span>, <span class="ident">module</span>) <span class="op">=</span> <span class="kw">unsafe</span> { - <span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">LLVMContextCreate</span>(); - <span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">LLVMModuleCreateWithNameInContext</span>(<span class="string">b"module\0"</span>.<span class="ident">as_ptr</span>().<span class="ident">cast</span>(), <span class="ident">c</span>); - <span class="macro">assert!</span>(<span class="op">!</span><span class="ident">c</span>.<span class="ident">is_null</span>() <span class="op">&&</span> <span class="op">!</span><span class="ident">m</span>.<span class="ident">is_null</span>()); - (<span class="ident">c</span>, <span class="ident">m</span>) - }; - - <span class="ident">Module</span> { <span class="ident">ctx</span>, <span class="ident">module</span> } - } - - <span class="doccomment">/// Dump LLVM IR emitted into the Module to stdout.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">dump</span>(<span class="kw-2">&</span><span class="self">self</span>) { - <span class="kw">unsafe</span> { <span class="ident">LLVMDumpModule</span>(<span class="self">self</span>.<span class="ident">module</span>) }; - } - - <span class="doccomment">/// Get a type reference representing a `f64` float.</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.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">type_f64</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Type</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> { - <span class="kw">let</span> <span class="ident">type_ref</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">LLVMDoubleTypeInContext</span>(<span class="self">self</span>.<span class="ident">ctx</span>) }; - <span class="ident">Type::new</span>(<span class="ident">type_ref</span>) - } - - <span class="doccomment">/// Get a type reference representing a `fn(args) -> ret` function.</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.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">type_fn</span>(<span class="kw-2">&</span><span class="lifetime">'llvm</span> <span class="self">self</span>, <span class="ident">args</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="ident">Type</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>], <span class="ident">ret</span>: <span class="ident">Type</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">Type</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> { - <span class="kw">let</span> <span class="ident">type_ref</span> <span class="op">=</span> <span class="kw">unsafe</span> { - <span class="ident">LLVMFunctionType</span>( - <span class="ident">ret</span>, - <span class="ident">args</span>.<span class="ident">as_mut_ptr</span>(), - <span class="ident">args</span>.<span class="ident">len</span>() <span class="kw">as</span> <span class="ident">libc::c_uint</span>, - <span class="number">0</span>, <span class="comment">/* IsVarArg */</span> - ) - }; - <span class="ident">Type::new</span>(<span class="ident">type_ref</span>) - } - - <span class="doccomment">/// Add a function with the given `name` and `fn_type` to the module and return a value</span> - <span class="doccomment">/// reference representing the function.</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 `name` could not be converted to a</span> - <span class="doccomment">/// [`SmallCStr`].</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">add_fn</span>(<span class="kw-2">&</span><span class="lifetime">'llvm</span> <span class="self">self</span>, <span class="ident">name</span>: <span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">fn_type</span>: <span class="ident">Type</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">FnValue</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> { - <span class="macro">debug_assert_eq!</span>( - <span class="ident">fn_type</span>.<span class="ident">kind</span>(), - <span class="ident">LLVMTypeKind::LLVMFunctionTypeKind</span>, - <span class="string">"Expected a function type when adding a function!"</span> - ); - - <span class="kw">let</span> <span class="ident">name</span> <span class="op">=</span> <span class="ident">SmallCStr::try_from</span>(<span class="ident">name</span>) - .<span class="ident">expect</span>(<span class="string">"Failed to convert 'name' argument to small C string!"</span>); - - <span class="kw">let</span> <span class="ident">value_ref</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">LLVMAddFunction</span>(<span class="self">self</span>.<span class="ident">module</span>, <span class="ident">name</span>.<span class="ident">as_ptr</span>(), <span class="ident">fn_type</span>.<span class="number">0</span>) }; - <span class="ident">FnValue::new</span>(<span class="ident">value_ref</span>) - } - - <span class="doccomment">/// Get a function value reference to the function with the given `name` if it was previously</span> - <span class="doccomment">/// added to the module with [`add_fn`][Module::add_fn].</span> - <span class="doccomment">///</span> - <span class="doccomment">/// # Panics</span> - <span class="doccomment">///</span> - <span class="doccomment">/// Panics if `name` could not be converted to a [`SmallCStr`].</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_fn</span>(<span class="kw-2">&</span><span class="lifetime">'llvm</span> <span class="self">self</span>, <span class="ident">name</span>: <span class="kw-2">&</span><span class="ident">str</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">FnValue</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span><span class="op">></span> { - <span class="kw">let</span> <span class="ident">name</span> <span class="op">=</span> <span class="ident">SmallCStr::try_from</span>(<span class="ident">name</span>) - .<span class="ident">expect</span>(<span class="string">"Failed to convert 'name' argument to small C string!"</span>); - - <span class="kw">let</span> <span class="ident">value_ref</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">LLVMGetNamedFunction</span>(<span class="self">self</span>.<span class="ident">module</span>, <span class="ident">name</span>.<span class="ident">as_ptr</span>()) }; - - (<span class="op">!</span><span class="ident">value_ref</span>.<span class="ident">is_null</span>()).<span class="ident">then</span>(<span class="op">|</span><span class="op">|</span> <span class="ident">FnValue::new</span>(<span class="ident">value_ref</span>)) - } - - <span class="doccomment">/// Append a Basic Block to the end of the function referenced by the value reference</span> - <span class="doccomment">/// `fn_value`.</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.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">append_basic_block</span>(<span class="kw-2">&</span><span class="lifetime">'llvm</span> <span class="self">self</span>, <span class="ident">fn_value</span>: <span class="ident">FnValue</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">BasicBlock</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> { - <span class="kw">let</span> <span class="ident">block</span> <span class="op">=</span> <span class="kw">unsafe</span> { - <span class="ident">LLVMAppendBasicBlockInContext</span>( - <span class="self">self</span>.<span class="ident">ctx</span>, - <span class="ident">fn_value</span>.<span class="ident">value_ref</span>(), - <span class="string">b"block\0"</span>.<span class="ident">as_ptr</span>().<span class="ident">cast</span>(), - ) - }; - <span class="macro">assert!</span>(<span class="op">!</span><span class="ident">block</span>.<span class="ident">is_null</span>()); - - <span class="ident">BasicBlock</span>(<span class="ident">block</span>, <span class="ident">PhantomData</span>) - } -} - -<span class="kw">impl</span> <span class="ident">Drop</span> <span class="kw">for</span> <span class="ident">Module</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="ident">LLVMDisposeModule</span>(<span class="self">self</span>.<span class="ident">module</span>); - <span class="ident">LLVMContextDispose</span>(<span class="self">self</span>.<span class="ident">ctx</span>); - } - } -} - -<span class="comment">// ===========</span> -<span class="comment">// Builder</span> -<span class="comment">// ===========</span> - -<span class="doccomment">/// Wrapper for a LLVM IR Builder.</span> -<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Builder</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> { - <span class="ident">builder</span>: <span class="ident">LLVMBuilderRef</span>, - <span class="ident">_ctx</span>: <span class="ident">PhantomData</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'llvm</span> ()<span class="op">></span>, -} - -<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> <span class="ident">Builder</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> { - <span class="doccomment">/// Create a new LLVM IR Builder with the `module`s context.</span> - <span class="doccomment">///</span> - <span class="doccomment">/// # Panics</span> - <span class="doccomment">///</span> - <span class="doccomment">/// Panics if creating the IR Builder fails.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_ctx</span>(<span class="ident">module</span>: <span class="kw-2">&</span><span class="lifetime">'llvm</span> <span class="ident">Module</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Builder</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> { - <span class="kw">let</span> <span class="ident">builder</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">LLVMCreateBuilderInContext</span>(<span class="ident">module</span>.<span class="ident">ctx</span>) }; - <span class="macro">assert!</span>(<span class="op">!</span><span class="ident">builder</span>.<span class="ident">is_null</span>()); - - <span class="ident">Builder</span> { - <span class="ident">builder</span>, - <span class="ident">_ctx</span>: <span class="ident">PhantomData</span>, - } - } - - <span class="doccomment">/// Position the IR Builder at the end of the given Basic Block.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">pos_at_end</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">bb</span>: <span class="ident">BasicBlock</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>) { - <span class="kw">unsafe</span> { - <span class="ident">LLVMPositionBuilderAtEnd</span>(<span class="self">self</span>.<span class="ident">builder</span>, <span class="ident">bb</span>.<span class="number">0</span>); - } - } - - <span class="doccomment">/// Emit a [fadd](https://llvm.org/docs/LangRef.html#fadd-instruction) instruction.</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.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">fadd</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">lhs</span>: <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>, <span class="ident">rhs</span>: <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> { - <span class="macro">debug_assert!</span>(<span class="ident">lhs</span>.<span class="ident">is_f64</span>(), <span class="string">"fadd: Expected f64 as lhs operand!"</span>); - <span class="macro">debug_assert!</span>(<span class="ident">rhs</span>.<span class="ident">is_f64</span>(), <span class="string">"fadd: Expected f64 as rhs operand!"</span>); - - <span class="kw">let</span> <span class="ident">value_ref</span> <span class="op">=</span> <span class="kw">unsafe</span> { - <span class="ident">LLVMBuildFAdd</span>( - <span class="self">self</span>.<span class="ident">builder</span>, - <span class="ident">lhs</span>.<span class="ident">value_ref</span>(), - <span class="ident">rhs</span>.<span class="ident">value_ref</span>(), - <span class="string">b"fadd\0"</span>.<span class="ident">as_ptr</span>().<span class="ident">cast</span>(), - ) - }; - <span class="ident">Value::new</span>(<span class="ident">value_ref</span>) - } - - <span class="doccomment">/// Emit a [fsub](https://llvm.org/docs/LangRef.html#fsub-instruction) instruction.</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.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">fsub</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">lhs</span>: <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>, <span class="ident">rhs</span>: <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> { - <span class="macro">debug_assert!</span>(<span class="ident">lhs</span>.<span class="ident">is_f64</span>(), <span class="string">"fsub: Expected f64 as lhs operand!"</span>); - <span class="macro">debug_assert!</span>(<span class="ident">rhs</span>.<span class="ident">is_f64</span>(), <span class="string">"fsub: Expected f64 as rhs operand!"</span>); - - <span class="kw">let</span> <span class="ident">value_ref</span> <span class="op">=</span> <span class="kw">unsafe</span> { - <span class="ident">LLVMBuildFSub</span>( - <span class="self">self</span>.<span class="ident">builder</span>, - <span class="ident">lhs</span>.<span class="ident">value_ref</span>(), - <span class="ident">rhs</span>.<span class="ident">value_ref</span>(), - <span class="string">b"fsub\0"</span>.<span class="ident">as_ptr</span>().<span class="ident">cast</span>(), - ) - }; - <span class="ident">Value::new</span>(<span class="ident">value_ref</span>) - } - - <span class="doccomment">/// Emit a [fmul](https://llvm.org/docs/LangRef.html#fmul-instruction) instruction.</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.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">fmul</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">lhs</span>: <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>, <span class="ident">rhs</span>: <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> { - <span class="macro">debug_assert!</span>(<span class="ident">lhs</span>.<span class="ident">is_f64</span>(), <span class="string">"fmul: Expected f64 as lhs operand!"</span>); - <span class="macro">debug_assert!</span>(<span class="ident">rhs</span>.<span class="ident">is_f64</span>(), <span class="string">"fmul: Expected f64 as rhs operand!"</span>); - - <span class="kw">let</span> <span class="ident">value_ref</span> <span class="op">=</span> <span class="kw">unsafe</span> { - <span class="ident">LLVMBuildFMul</span>( - <span class="self">self</span>.<span class="ident">builder</span>, - <span class="ident">lhs</span>.<span class="ident">value_ref</span>(), - <span class="ident">rhs</span>.<span class="ident">value_ref</span>(), - <span class="string">b"fmul\0"</span>.<span class="ident">as_ptr</span>().<span class="ident">cast</span>(), - ) - }; - <span class="ident">Value::new</span>(<span class="ident">value_ref</span>) - } - - <span class="doccomment">/// Emit a [fcmult](https://llvm.org/docs/LangRef.html#fcmp-instruction) instruction.</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.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">fcmpult</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">lhs</span>: <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>, <span class="ident">rhs</span>: <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> { - <span class="macro">debug_assert!</span>(<span class="ident">lhs</span>.<span class="ident">is_f64</span>(), <span class="string">"fcmplt: Expected f64 as lhs operand!"</span>); - <span class="macro">debug_assert!</span>(<span class="ident">rhs</span>.<span class="ident">is_f64</span>(), <span class="string">"fcmplt: Expected f64 as rhs operand!"</span>); - - <span class="kw">let</span> <span class="ident">value_ref</span> <span class="op">=</span> <span class="kw">unsafe</span> { - <span class="ident">LLVMBuildFCmp</span>( - <span class="self">self</span>.<span class="ident">builder</span>, - <span class="ident">LLVMRealPredicate::LLVMRealULT</span>, - <span class="ident">lhs</span>.<span class="ident">value_ref</span>(), - <span class="ident">rhs</span>.<span class="ident">value_ref</span>(), - <span class="string">b"fcmplt\0"</span>.<span class="ident">as_ptr</span>().<span class="ident">cast</span>(), - ) - }; - <span class="ident">Value::new</span>(<span class="ident">value_ref</span>) - } - - <span class="doccomment">/// Emit a [uitofp](https://llvm.org/docs/LangRef.html#uitofp-to-instruction) instruction.</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.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">uitofp</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">val</span>: <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>, <span class="ident">dest_type</span>: <span class="ident">Type</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> { - <span class="macro">debug_assert!</span>(<span class="ident">val</span>.<span class="ident">is_int</span>(), <span class="string">"uitofp: Expected integer operand!"</span>); - - <span class="kw">let</span> <span class="ident">value_ref</span> <span class="op">=</span> <span class="kw">unsafe</span> { - <span class="ident">LLVMBuildUIToFP</span>( - <span class="self">self</span>.<span class="ident">builder</span>, - <span class="ident">val</span>.<span class="ident">value_ref</span>(), - <span class="ident">dest_type</span>.<span class="number">0</span>, - <span class="string">b"uitofp\0"</span>.<span class="ident">as_ptr</span>().<span class="ident">cast</span>(), - ) - }; - <span class="ident">Value::new</span>(<span class="ident">value_ref</span>) - } - - <span class="doccomment">/// Emit a [call](https://llvm.org/docs/LangRef.html#call-instruction) instruction.</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.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">call</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">fn_value</span>: <span class="ident">FnValue</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>, <span class="ident">args</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>]) <span class="op">-</span><span class="op">></span> <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> { - <span class="kw">let</span> <span class="ident">value_ref</span> <span class="op">=</span> <span class="kw">unsafe</span> { - <span class="ident">LLVMBuildCall2</span>( - <span class="self">self</span>.<span class="ident">builder</span>, - <span class="ident">fn_value</span>.<span class="ident">ret_type</span>(), - <span class="ident">fn_value</span>, - <span class="ident">args</span>.<span class="ident">as_mut_ptr</span>(), - <span class="ident">args</span>.<span class="ident">len</span>() <span class="kw">as</span> <span class="ident">libc::c_uint</span>, - <span class="string">b"call\0"</span>.<span class="ident">as_ptr</span>().<span class="ident">cast</span>(), - ) - }; - <span class="ident">Value::new</span>(<span class="ident">value_ref</span>) - } - - <span class="doccomment">/// Emit a [ret](https://llvm.org/docs/LangRef.html#ret-instruction) instruction.</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.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">ret</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">ret</span>: <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>) { - <span class="kw">let</span> <span class="ident">ret</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">LLVMBuildRet</span>(<span class="self">self</span>.<span class="ident">builder</span>, <span class="ident">ret</span>.<span class="ident">value_ref</span>()) }; - <span class="macro">assert!</span>(<span class="op">!</span><span class="ident">ret</span>.<span class="ident">is_null</span>()); - } -} - -<span class="kw">impl</span> <span class="ident">Drop</span> <span class="kw">for</span> <span class="ident">Builder</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="ident">LLVMDisposeBuilder</span>(<span class="self">self</span>.<span class="ident">builder</span>) } - } -} - -<span class="comment">// ==============</span> -<span class="comment">// BasicBlock</span> -<span class="comment">// ==============</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"><</span><span class="lifetime">'llvm</span><span class="op">></span>(<span class="ident">LLVMBasicBlockRef</span>, <span class="ident">PhantomData</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'llvm</span> ()<span class="op">></span>); - -<span class="comment">// ========</span> -<span class="comment">// Type</span> -<span class="comment">// ========</span> - -<span class="doccomment">/// Wrapper for a LLVM Type Reference.</span> -<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Copy</span>, <span class="ident">Clone</span>)]</span> -<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">transparent</span>)]</span> -<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Type</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>(<span class="ident">LLVMTypeRef</span>, <span class="ident">PhantomData</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'llvm</span> ()<span class="op">></span>); - -<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> <span class="ident">Type</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> { - <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">type_ref</span>: <span class="ident">LLVMTypeRef</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> { - <span class="macro">assert!</span>(<span class="op">!</span><span class="ident">type_ref</span>.<span class="ident">is_null</span>()); - <span class="ident">Type</span>(<span class="ident">type_ref</span>, <span class="ident">PhantomData</span>) - } - - <span class="kw">fn</span> <span class="ident">kind</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">LLVMTypeKind</span> { - <span class="kw">unsafe</span> { <span class="ident">LLVMGetTypeKind</span>(<span class="self">self</span>.<span class="number">0</span>) } - } - - <span class="doccomment">/// Dump the LLVM Type to stdout.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">dump</span>(<span class="kw-2">&</span><span class="self">self</span>) { - <span class="kw">unsafe</span> { <span class="ident">LLVMDumpType</span>(<span class="self">self</span>.<span class="number">0</span>) }; - } - - <span class="doccomment">/// Get a value reference representing the const `f64` value.</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.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">const_f64</span>(<span class="self">self</span>, <span class="ident">n</span>: <span class="ident">f64</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> { - <span class="macro">debug_assert_eq!</span>( - <span class="self">self</span>.<span class="ident">kind</span>(), - <span class="ident">LLVMTypeKind::LLVMDoubleTypeKind</span>, - <span class="string">"Expected a double type when creating const f64 value!"</span> - ); - - <span class="kw">let</span> <span class="ident">value_ref</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">LLVMConstReal</span>(<span class="self">self</span>.<span class="number">0</span>, <span class="ident">n</span>) }; - <span class="ident">Value::new</span>(<span class="ident">value_ref</span>) - } -} - -<span class="comment">// =========</span> -<span class="comment">// Value</span> -<span class="comment">// =========</span> - -<span class="doccomment">/// Wrapper for a LLVM Value Reference.</span> -<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Copy</span>, <span class="ident">Clone</span>)]</span> -<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">transparent</span>)]</span> -<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>(<span class="ident">LLVMValueRef</span>, <span class="ident">PhantomData</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'llvm</span> ()<span class="op">></span>); - -<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> { - <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">value_ref</span>: <span class="ident">LLVMValueRef</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> { - <span class="macro">assert!</span>(<span class="op">!</span><span class="ident">value_ref</span>.<span class="ident">is_null</span>()); - <span class="ident">Value</span>(<span class="ident">value_ref</span>, <span class="ident">PhantomData</span>) - } - - <span class="attribute">#[<span class="ident">inline</span>]</span> - <span class="kw">fn</span> <span class="ident">value_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">LLVMValueRef</span> { - <span class="self">self</span>.<span class="number">0</span> - } - - <span class="kw">fn</span> <span class="ident">kind</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">LLVMValueKind</span> { - <span class="kw">unsafe</span> { <span class="ident">LLVMGetValueKind</span>(<span class="self">self</span>.<span class="ident">value_ref</span>()) } - } - - <span class="doccomment">/// Dump the LLVM Value to stdout.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">dump</span>(<span class="kw-2">&</span><span class="self">self</span>) { - <span class="kw">unsafe</span> { <span class="ident">LLVMDumpValue</span>(<span class="self">self</span>.<span class="ident">value_ref</span>()) }; - } - - <span class="doccomment">/// Get a type reference representing for the given value reference.</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.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">type_of</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Type</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> { - <span class="kw">let</span> <span class="ident">type_ref</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">LLVMTypeOf</span>(<span class="self">self</span>.<span class="ident">value_ref</span>()) }; - <span class="ident">Type::new</span>(<span class="ident">type_ref</span>) - } - - <span class="doccomment">/// Set the name for the given value reference.</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.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_name</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">name</span>: <span class="kw-2">&</span><span class="ident">str</span>) { - <span class="kw">unsafe</span> { <span class="ident">LLVMSetValueName2</span>(<span class="self">self</span>.<span class="ident">value_ref</span>(), <span class="ident">name</span>.<span class="ident">as_ptr</span>().<span class="ident">cast</span>(), <span class="ident">name</span>.<span class="ident">len</span>()) }; - } - - <span class="doccomment">/// Get the name for the given value reference.</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.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_name</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="lifetime">'llvm</span> <span class="ident">str</span> { - <span class="kw">let</span> <span class="ident">name</span> <span class="op">=</span> <span class="kw">unsafe</span> { - <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">len</span>: <span class="ident">libc::size_t</span> <span class="op">=</span> <span class="number">0</span>; - <span class="kw">let</span> <span class="ident">name</span> <span class="op">=</span> <span class="ident">LLVMGetValueName2</span>(<span class="self">self</span>.<span class="number">0</span>, <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">len</span> <span class="kw">as</span> <span class="kw">_</span>); - <span class="macro">assert!</span>(<span class="op">!</span><span class="ident">name</span>.<span class="ident">is_null</span>()); - - <span class="ident">CStr::from_ptr</span>(<span class="ident">name</span>) - }; - - <span class="comment">// TODO: Does this string live for the time of the LLVM context?!</span> - <span class="ident">name</span>.<span class="ident">to_str</span>() - .<span class="ident">expect</span>(<span class="string">"Expected valid UTF8 string from LLVM API"</span>) - } - - <span class="doccomment">/// Check if value is of `f64` type.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_f64</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> { - <span class="self">self</span>.<span class="ident">type_of</span>().<span class="ident">kind</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">LLVMTypeKind::LLVMDoubleTypeKind</span> - } - - <span class="doccomment">/// Check if value is of integer type.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">is_int</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> { - <span class="self">self</span>.<span class="ident">type_of</span>().<span class="ident">kind</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">LLVMTypeKind::LLVMIntegerTypeKind</span> - } -} - -<span class="doccomment">/// Wrapper for a LLVM Value Reference specialized for contexts where function values are needed.</span> -<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Copy</span>, <span class="ident">Clone</span>)]</span> -<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">transparent</span>)]</span> -<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">FnValue</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>(<span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>); - -<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> <span class="ident">Deref</span> <span class="kw">for</span> <span class="ident">FnValue</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> { - <span class="kw">type</span> <span class="ident">Target</span> <span class="op">=</span> <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span>; - <span class="kw">fn</span> <span class="ident">deref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="self">Self</span><span class="ident">::Target</span> { - <span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span> - } -} - -<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> <span class="ident">FnValue</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> { - <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">value_ref</span>: <span class="ident">LLVMValueRef</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> { - <span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="ident">Value::new</span>(<span class="ident">value_ref</span>); - <span class="macro">debug_assert_eq!</span>( - <span class="ident">value</span>.<span class="ident">kind</span>(), - <span class="ident">LLVMValueKind::LLVMFunctionValueKind</span>, - <span class="string">"Expected a fn value when constructing FnValue!"</span> - ); - - <span class="ident">FnValue</span>(<span class="ident">value</span>) - } - - <span class="doccomment">/// Get a type reference representing the return value of the given function value.</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.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">ret_type</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Type</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> { - <span class="kw">let</span> <span class="ident">type_ref</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">LLVMGetReturnType</span>(<span class="ident">LLVMTypeOf</span>(<span class="self">self</span>.<span class="ident">value_ref</span>())) }; - <span class="ident">Type::new</span>(<span class="ident">type_ref</span>) - } - - <span class="doccomment">/// Get the number of function arguments for the given function value.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">args</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">usize</span> { - <span class="kw">unsafe</span> { <span class="ident">LLVMCountParams</span>(<span class="self">self</span>.<span class="ident">value_ref</span>()) <span class="kw">as</span> <span class="ident">usize</span> } - } - - <span class="doccomment">/// Get a value reference for the function argument at index `idx`.</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 indexed out of bounds.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">arg</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">idx</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Value</span><span class="op"><</span><span class="lifetime">'llvm</span><span class="op">></span> { - <span class="macro">assert!</span>(<span class="ident">idx</span> <span class="op"><</span> <span class="self">self</span>.<span class="ident">args</span>()); - - <span class="kw">let</span> <span class="ident">value_ref</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">LLVMGetParam</span>(<span class="self">self</span>.<span class="ident">value_ref</span>(), <span class="ident">idx</span> <span class="kw">as</span> <span class="ident">libc::c_uint</span>) }; - <span class="ident">Value::new</span>(<span class="ident">value_ref</span>) - } - - <span class="doccomment">/// Get the number of Basic Blocks for the given function value.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">basic_blocks</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">usize</span> { - <span class="kw">unsafe</span> { <span class="ident">LLVMCountBasicBlocks</span>(<span class="self">self</span>.<span class="ident">value_ref</span>()) <span class="kw">as</span> <span class="ident">usize</span> } - } - - <span class="doccomment">/// Verify that the given function is valid.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">verify</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> { - <span class="kw">unsafe</span> { - <span class="ident">LLVMVerifyFunction</span>( - <span class="self">self</span>.<span class="ident">value_ref</span>(), - <span class="ident">LLVMVerifierFailureAction::LLVMPrintMessageAction</span>, - ) <span class="op">=</span><span class="op">=</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 |