aboutsummaryrefslogtreecommitdiffhomepage
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/add/add.rs.html8
-rw-r--r--src/fib/fib.rs.html4
-rw-r--r--src/juicebox_asm/asm.rs.html689
-rw-r--r--src/juicebox_asm/imm.rs.html28
-rw-r--r--src/juicebox_asm/insn.rs.html44
-rw-r--r--src/juicebox_asm/insn/add.rs.html4
-rw-r--r--src/juicebox_asm/insn/call.rs.html4
-rw-r--r--src/juicebox_asm/insn/cmp.rs.html4
-rw-r--r--src/juicebox_asm/insn/dec.rs.html4
-rw-r--r--src/juicebox_asm/insn/jmp.rs.html4
-rw-r--r--src/juicebox_asm/insn/jnz.rs.html4
-rw-r--r--src/juicebox_asm/insn/jz.rs.html4
-rw-r--r--src/juicebox_asm/insn/mov.rs.html4
-rw-r--r--src/juicebox_asm/insn/nop.rs.html4
-rw-r--r--src/juicebox_asm/insn/ret.rs.html4
-rw-r--r--src/juicebox_asm/insn/test.rs.html4
-rw-r--r--src/juicebox_asm/label.rs.html4
-rw-r--r--src/juicebox_asm/lib.rs.html736
-rw-r--r--src/juicebox_asm/prelude.rs.html21
-rw-r--r--src/juicebox_asm/reg.rs.html98
-rw-r--r--src/juicebox_asm/rt.rs.html290
-rw-r--r--src/tiny_vm/tiny_vm.rs.html4
22 files changed, 1080 insertions, 890 deletions
diff --git a/src/add/add.rs.html b/src/add/add.rs.html
index 112d0f1..dc8c566 100644
--- a/src/add/add.rs.html
+++ b/src/add/add.rs.html
@@ -44,9 +44,9 @@
</span><span class="attr">#[cfg(not(any(target_arch = <span class="string">&quot;x86_64&quot;</span>, target_os = <span class="string">&quot;linux&quot;</span>)))]
</span><span class="macro">compile_error!</span>(<span class="string">&quot;Only supported on x86_64 with SystemV abi&quot;</span>);
-<span class="kw">use </span>juicebox_asm::prelude::<span class="kw-2">*</span>;
+<span class="kw">use </span>juicebox_asm::insn::<span class="kw-2">*</span>;
<span class="kw">use </span>juicebox_asm::Runtime;
-<span class="kw">use </span>Reg64::<span class="kw-2">*</span>;
+<span class="kw">use </span>juicebox_asm::{Asm, Imm64, Reg64::<span class="kw-2">*</span>};
<span class="kw">extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn </span>add(a: u32, b: u32) -&gt; u32 {
a + b
@@ -59,9 +59,9 @@
// rdi -&gt; first argument
// rsi -&gt; second argument
// rax -&gt; return value
- //
+
</span>asm.mov(rsi, Imm64::from(<span class="number">42</span>));
- asm.mov(rax, Imm64::from(add <span class="kw">as </span>u64));
+ asm.mov(rax, Imm64::from(add <span class="kw">as </span>usize));
asm.call(rax);
asm.ret();
diff --git a/src/fib/fib.rs.html b/src/fib/fib.rs.html
index 87a1bbf..f7b4aa6 100644
--- a/src/fib/fib.rs.html
+++ b/src/fib/fib.rs.html
@@ -76,13 +76,15 @@
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
+<a href="#79" id="79">79</a>
</pre></div><pre class="rust"><code><span class="doccomment">//! Fibonacci example.
//!
//! Jit compile a function at runtime (generate native host code) to compute the fibonacci sequence
//! to demonstrate the [`juicebox_asm`] crate.
-</span><span class="kw">use </span>juicebox_asm::prelude::<span class="kw-2">*</span>;
+</span><span class="kw">use </span>juicebox_asm::insn::<span class="kw-2">*</span>;
<span class="kw">use </span>juicebox_asm::Runtime;
+<span class="kw">use </span>juicebox_asm::{Asm, Imm64, Label, Reg64};
<span class="kw">const fn </span>fib_rs(n: u64) -&gt; u64 {
<span class="kw">match </span>n {
diff --git a/src/juicebox_asm/asm.rs.html b/src/juicebox_asm/asm.rs.html
new file mode 100644
index 0000000..fd5f0d5
--- /dev/null
+++ b/src/juicebox_asm/asm.rs.html
@@ -0,0 +1,689 @@
+<!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/asm.rs`."><title>asm.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-fa3bb1812debf86c.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="juicebox_asm" data-themes="" data-resource-suffix="" data-rustdoc-version="1.74.0 (79e9716c9 2023-11-13)" data-channel="1.74.0" data-search-js="search-8be46b629f5f14a8.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="../../static.files/src-script-3280b574d94e47b4.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-c5bd66d33317d69f.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><nav class="sub"><a class="sub-logo-container" href="../../juicebox_asm/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
+<a href="#2" id="2">2</a>
+<a href="#3" id="3">3</a>
+<a href="#4" id="4">4</a>
+<a href="#5" id="5">5</a>
+<a href="#6" id="6">6</a>
+<a href="#7" id="7">7</a>
+<a href="#8" id="8">8</a>
+<a href="#9" id="9">9</a>
+<a href="#10" id="10">10</a>
+<a href="#11" id="11">11</a>
+<a href="#12" id="12">12</a>
+<a href="#13" id="13">13</a>
+<a href="#14" id="14">14</a>
+<a href="#15" id="15">15</a>
+<a href="#16" id="16">16</a>
+<a href="#17" id="17">17</a>
+<a href="#18" id="18">18</a>
+<a href="#19" id="19">19</a>
+<a href="#20" id="20">20</a>
+<a href="#21" id="21">21</a>
+<a href="#22" id="22">22</a>
+<a href="#23" id="23">23</a>
+<a href="#24" id="24">24</a>
+<a href="#25" id="25">25</a>
+<a href="#26" id="26">26</a>
+<a href="#27" id="27">27</a>
+<a href="#28" id="28">28</a>
+<a href="#29" id="29">29</a>
+<a href="#30" id="30">30</a>
+<a href="#31" id="31">31</a>
+<a href="#32" id="32">32</a>
+<a href="#33" id="33">33</a>
+<a href="#34" id="34">34</a>
+<a href="#35" id="35">35</a>
+<a href="#36" id="36">36</a>
+<a href="#37" id="37">37</a>
+<a href="#38" id="38">38</a>
+<a href="#39" id="39">39</a>
+<a href="#40" id="40">40</a>
+<a href="#41" id="41">41</a>
+<a href="#42" id="42">42</a>
+<a href="#43" id="43">43</a>
+<a href="#44" id="44">44</a>
+<a href="#45" id="45">45</a>
+<a href="#46" id="46">46</a>
+<a href="#47" id="47">47</a>
+<a href="#48" id="48">48</a>
+<a href="#49" id="49">49</a>
+<a href="#50" id="50">50</a>
+<a href="#51" id="51">51</a>
+<a href="#52" id="52">52</a>
+<a href="#53" id="53">53</a>
+<a href="#54" id="54">54</a>
+<a href="#55" id="55">55</a>
+<a href="#56" id="56">56</a>
+<a href="#57" id="57">57</a>
+<a href="#58" id="58">58</a>
+<a href="#59" id="59">59</a>
+<a href="#60" id="60">60</a>
+<a href="#61" id="61">61</a>
+<a href="#62" id="62">62</a>
+<a href="#63" id="63">63</a>
+<a href="#64" id="64">64</a>
+<a href="#65" id="65">65</a>
+<a href="#66" id="66">66</a>
+<a href="#67" id="67">67</a>
+<a href="#68" id="68">68</a>
+<a href="#69" id="69">69</a>
+<a href="#70" id="70">70</a>
+<a href="#71" id="71">71</a>
+<a href="#72" id="72">72</a>
+<a href="#73" id="73">73</a>
+<a href="#74" id="74">74</a>
+<a href="#75" id="75">75</a>
+<a href="#76" id="76">76</a>
+<a href="#77" id="77">77</a>
+<a href="#78" id="78">78</a>
+<a href="#79" id="79">79</a>
+<a href="#80" id="80">80</a>
+<a href="#81" id="81">81</a>
+<a href="#82" id="82">82</a>
+<a href="#83" id="83">83</a>
+<a href="#84" id="84">84</a>
+<a href="#85" id="85">85</a>
+<a href="#86" id="86">86</a>
+<a href="#87" id="87">87</a>
+<a href="#88" id="88">88</a>
+<a href="#89" id="89">89</a>
+<a href="#90" id="90">90</a>
+<a href="#91" id="91">91</a>
+<a href="#92" id="92">92</a>
+<a href="#93" id="93">93</a>
+<a href="#94" id="94">94</a>
+<a href="#95" id="95">95</a>
+<a href="#96" id="96">96</a>
+<a href="#97" id="97">97</a>
+<a href="#98" id="98">98</a>
+<a href="#99" id="99">99</a>
+<a href="#100" id="100">100</a>
+<a href="#101" id="101">101</a>
+<a href="#102" id="102">102</a>
+<a href="#103" id="103">103</a>
+<a href="#104" id="104">104</a>
+<a href="#105" id="105">105</a>
+<a href="#106" id="106">106</a>
+<a href="#107" id="107">107</a>
+<a href="#108" id="108">108</a>
+<a href="#109" id="109">109</a>
+<a href="#110" id="110">110</a>
+<a href="#111" id="111">111</a>
+<a href="#112" id="112">112</a>
+<a href="#113" id="113">113</a>
+<a href="#114" id="114">114</a>
+<a href="#115" id="115">115</a>
+<a href="#116" id="116">116</a>
+<a href="#117" id="117">117</a>
+<a href="#118" id="118">118</a>
+<a href="#119" id="119">119</a>
+<a href="#120" id="120">120</a>
+<a href="#121" id="121">121</a>
+<a href="#122" id="122">122</a>
+<a href="#123" id="123">123</a>
+<a href="#124" id="124">124</a>
+<a href="#125" id="125">125</a>
+<a href="#126" id="126">126</a>
+<a href="#127" id="127">127</a>
+<a href="#128" id="128">128</a>
+<a href="#129" id="129">129</a>
+<a href="#130" id="130">130</a>
+<a href="#131" id="131">131</a>
+<a href="#132" id="132">132</a>
+<a href="#133" id="133">133</a>
+<a href="#134" id="134">134</a>
+<a href="#135" id="135">135</a>
+<a href="#136" id="136">136</a>
+<a href="#137" id="137">137</a>
+<a href="#138" id="138">138</a>
+<a href="#139" id="139">139</a>
+<a href="#140" id="140">140</a>
+<a href="#141" id="141">141</a>
+<a href="#142" id="142">142</a>
+<a href="#143" id="143">143</a>
+<a href="#144" id="144">144</a>
+<a href="#145" id="145">145</a>
+<a href="#146" id="146">146</a>
+<a href="#147" id="147">147</a>
+<a href="#148" id="148">148</a>
+<a href="#149" id="149">149</a>
+<a href="#150" id="150">150</a>
+<a href="#151" id="151">151</a>
+<a href="#152" id="152">152</a>
+<a href="#153" id="153">153</a>
+<a href="#154" id="154">154</a>
+<a href="#155" id="155">155</a>
+<a href="#156" id="156">156</a>
+<a href="#157" id="157">157</a>
+<a href="#158" id="158">158</a>
+<a href="#159" id="159">159</a>
+<a href="#160" id="160">160</a>
+<a href="#161" id="161">161</a>
+<a href="#162" id="162">162</a>
+<a href="#163" id="163">163</a>
+<a href="#164" id="164">164</a>
+<a href="#165" id="165">165</a>
+<a href="#166" id="166">166</a>
+<a href="#167" id="167">167</a>
+<a href="#168" id="168">168</a>
+<a href="#169" id="169">169</a>
+<a href="#170" id="170">170</a>
+<a href="#171" id="171">171</a>
+<a href="#172" id="172">172</a>
+<a href="#173" id="173">173</a>
+<a href="#174" id="174">174</a>
+<a href="#175" id="175">175</a>
+<a href="#176" id="176">176</a>
+<a href="#177" id="177">177</a>
+<a href="#178" id="178">178</a>
+<a href="#179" id="179">179</a>
+<a href="#180" id="180">180</a>
+<a href="#181" id="181">181</a>
+<a href="#182" id="182">182</a>
+<a href="#183" id="183">183</a>
+<a href="#184" id="184">184</a>
+<a href="#185" id="185">185</a>
+<a href="#186" id="186">186</a>
+<a href="#187" id="187">187</a>
+<a href="#188" id="188">188</a>
+<a href="#189" id="189">189</a>
+<a href="#190" id="190">190</a>
+<a href="#191" id="191">191</a>
+<a href="#192" id="192">192</a>
+<a href="#193" id="193">193</a>
+<a href="#194" id="194">194</a>
+<a href="#195" id="195">195</a>
+<a href="#196" id="196">196</a>
+<a href="#197" id="197">197</a>
+<a href="#198" id="198">198</a>
+<a href="#199" id="199">199</a>
+<a href="#200" id="200">200</a>
+<a href="#201" id="201">201</a>
+<a href="#202" id="202">202</a>
+<a href="#203" id="203">203</a>
+<a href="#204" id="204">204</a>
+<a href="#205" id="205">205</a>
+<a href="#206" id="206">206</a>
+<a href="#207" id="207">207</a>
+<a href="#208" id="208">208</a>
+<a href="#209" id="209">209</a>
+<a href="#210" id="210">210</a>
+<a href="#211" id="211">211</a>
+<a href="#212" id="212">212</a>
+<a href="#213" id="213">213</a>
+<a href="#214" id="214">214</a>
+<a href="#215" id="215">215</a>
+<a href="#216" id="216">216</a>
+<a href="#217" id="217">217</a>
+<a href="#218" id="218">218</a>
+<a href="#219" id="219">219</a>
+<a href="#220" id="220">220</a>
+<a href="#221" id="221">221</a>
+<a href="#222" id="222">222</a>
+<a href="#223" id="223">223</a>
+<a href="#224" id="224">224</a>
+<a href="#225" id="225">225</a>
+<a href="#226" id="226">226</a>
+<a href="#227" id="227">227</a>
+<a href="#228" id="228">228</a>
+<a href="#229" id="229">229</a>
+<a href="#230" id="230">230</a>
+<a href="#231" id="231">231</a>
+<a href="#232" id="232">232</a>
+<a href="#233" id="233">233</a>
+<a href="#234" id="234">234</a>
+<a href="#235" id="235">235</a>
+<a href="#236" id="236">236</a>
+<a href="#237" id="237">237</a>
+<a href="#238" id="238">238</a>
+<a href="#239" id="239">239</a>
+<a href="#240" id="240">240</a>
+<a href="#241" id="241">241</a>
+<a href="#242" id="242">242</a>
+<a href="#243" id="243">243</a>
+<a href="#244" id="244">244</a>
+<a href="#245" id="245">245</a>
+<a href="#246" id="246">246</a>
+<a href="#247" id="247">247</a>
+<a href="#248" id="248">248</a>
+<a href="#249" id="249">249</a>
+<a href="#250" id="250">250</a>
+<a href="#251" id="251">251</a>
+<a href="#252" id="252">252</a>
+<a href="#253" id="253">253</a>
+<a href="#254" id="254">254</a>
+<a href="#255" id="255">255</a>
+<a href="#256" id="256">256</a>
+<a href="#257" id="257">257</a>
+<a href="#258" id="258">258</a>
+<a href="#259" id="259">259</a>
+<a href="#260" id="260">260</a>
+<a href="#261" id="261">261</a>
+<a href="#262" id="262">262</a>
+<a href="#263" id="263">263</a>
+<a href="#264" id="264">264</a>
+<a href="#265" id="265">265</a>
+<a href="#266" id="266">266</a>
+<a href="#267" id="267">267</a>
+<a href="#268" id="268">268</a>
+<a href="#269" id="269">269</a>
+<a href="#270" id="270">270</a>
+<a href="#271" id="271">271</a>
+<a href="#272" id="272">272</a>
+<a href="#273" id="273">273</a>
+<a href="#274" id="274">274</a>
+<a href="#275" id="275">275</a>
+<a href="#276" id="276">276</a>
+<a href="#277" id="277">277</a>
+<a href="#278" id="278">278</a>
+<a href="#279" id="279">279</a>
+<a href="#280" id="280">280</a>
+<a href="#281" id="281">281</a>
+<a href="#282" id="282">282</a>
+<a href="#283" id="283">283</a>
+<a href="#284" id="284">284</a>
+<a href="#285" id="285">285</a>
+<a href="#286" id="286">286</a>
+<a href="#287" id="287">287</a>
+<a href="#288" id="288">288</a>
+<a href="#289" id="289">289</a>
+<a href="#290" id="290">290</a>
+<a href="#291" id="291">291</a>
+<a href="#292" id="292">292</a>
+<a href="#293" id="293">293</a>
+<a href="#294" id="294">294</a>
+<a href="#295" id="295">295</a>
+<a href="#296" id="296">296</a>
+<a href="#297" id="297">297</a>
+<a href="#298" id="298">298</a>
+<a href="#299" id="299">299</a>
+<a href="#300" id="300">300</a>
+<a href="#301" id="301">301</a>
+<a href="#302" id="302">302</a>
+<a href="#303" id="303">303</a>
+<a href="#304" id="304">304</a>
+<a href="#305" id="305">305</a>
+<a href="#306" id="306">306</a>
+<a href="#307" id="307">307</a>
+<a href="#308" id="308">308</a>
+<a href="#309" id="309">309</a>
+<a href="#310" id="310">310</a>
+<a href="#311" id="311">311</a>
+<a href="#312" id="312">312</a>
+<a href="#313" id="313">313</a>
+<a href="#314" id="314">314</a>
+<a href="#315" id="315">315</a>
+<a href="#316" id="316">316</a>
+<a href="#317" id="317">317</a>
+<a href="#318" id="318">318</a>
+<a href="#319" id="319">319</a>
+<a href="#320" id="320">320</a>
+<a href="#321" id="321">321</a>
+<a href="#322" id="322">322</a>
+<a href="#323" id="323">323</a>
+<a href="#324" id="324">324</a>
+<a href="#325" id="325">325</a>
+<a href="#326" id="326">326</a>
+<a href="#327" id="327">327</a>
+<a href="#328" id="328">328</a>
+<a href="#329" id="329">329</a>
+<a href="#330" id="330">330</a>
+<a href="#331" id="331">331</a>
+<a href="#332" id="332">332</a>
+<a href="#333" id="333">333</a>
+<a href="#334" id="334">334</a>
+<a href="#335" id="335">335</a>
+<a href="#336" id="336">336</a>
+<a href="#337" id="337">337</a>
+<a href="#338" id="338">338</a>
+<a href="#339" id="339">339</a>
+<a href="#340" id="340">340</a>
+<a href="#341" id="341">341</a>
+<a href="#342" id="342">342</a>
+<a href="#343" id="343">343</a>
+<a href="#344" id="344">344</a>
+</pre></div><pre class="rust"><code><span class="doccomment">//! The `x64` jit assembler.
+
+</span><span class="kw">use crate</span>::<span class="kw-2">*</span>;
+<span class="kw">use </span>imm::Imm;
+<span class="kw">use </span>reg::Reg;
+
+<span class="doccomment">/// Encode the `REX` byte.
+</span><span class="kw">const fn </span>rex(w: bool, r: u8, x: u8, b: u8) -&gt; u8 {
+ <span class="kw">let </span>w = <span class="kw">if </span>w { <span class="number">1 </span>} <span class="kw">else </span>{ <span class="number">0 </span>};
+ <span class="kw">let </span>r = (r &gt;&gt; <span class="number">3</span>) &amp; <span class="number">1</span>;
+ <span class="kw">let </span>x = (x &gt;&gt; <span class="number">3</span>) &amp; <span class="number">1</span>;
+ <span class="kw">let </span>b = (b &gt;&gt; <span class="number">3</span>) &amp; <span class="number">1</span>;
+ <span class="number">0b0100_0000 </span>| ((w &amp; <span class="number">1</span>) &lt;&lt; <span class="number">3</span>) | (r &lt;&lt; <span class="number">2</span>) | (x &lt;&lt; <span class="number">1</span>) | b
+}
+
+<span class="doccomment">/// Encode the `ModR/M` byte.
+</span><span class="kw">const fn </span>modrm(mod_: u8, reg: u8, rm: u8) -&gt; u8 {
+ ((mod_ &amp; <span class="number">0b11</span>) &lt;&lt; <span class="number">6</span>) | ((reg &amp; <span class="number">0b111</span>) &lt;&lt; <span class="number">3</span>) | (rm &amp; <span class="number">0b111</span>)
+}
+
+<span class="doccomment">/// `x64` jit assembler.
+</span><span class="kw">pub struct </span>Asm {
+ buf: Vec&lt;u8&gt;,
+}
+
+<span class="kw">impl </span>Asm {
+ <span class="doccomment">/// Create a new `x64` jit assembler.
+ </span><span class="kw">pub fn </span>new() -&gt; Asm {
+ <span class="comment">// Some random default capacity.
+ </span><span class="kw">let </span>buf = Vec::with_capacity(<span class="number">1024</span>);
+ Asm { buf }
+ }
+
+ <span class="doccomment">/// Consume the assembler and get the emitted code.
+ </span><span class="kw">pub fn </span>into_code(<span class="self">self</span>) -&gt; Vec&lt;u8&gt; {
+ <span class="self">self</span>.buf
+ }
+
+ <span class="doccomment">/// Emit a slice of bytes.
+ </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>emit(<span class="kw-2">&amp;mut </span><span class="self">self</span>, bytes: <span class="kw-2">&amp;</span>[u8]) {
+ <span class="self">self</span>.buf.extend_from_slice(bytes);
+ }
+
+ <span class="doccomment">/// Emit a slice of optional bytes.
+ </span><span class="kw">fn </span>emit_optional(<span class="kw-2">&amp;mut </span><span class="self">self</span>, bytes: <span class="kw-2">&amp;</span>[<span class="prelude-ty">Option</span>&lt;u8&gt;]) {
+ <span class="kw">for </span>byte <span class="kw">in </span>bytes.iter().filter_map(|<span class="kw-2">&amp;</span>b| b) {
+ <span class="self">self</span>.buf.push(byte);
+ }
+ }
+
+ <span class="doccomment">/// Emit a slice of bytes at `pos`.
+ ///
+ /// # Panics
+ ///
+ /// Panics if [pos..pos+len] indexes out of bound of the underlying code buffer.
+ </span><span class="kw">fn </span>emit_at(<span class="kw-2">&amp;mut </span><span class="self">self</span>, pos: usize, bytes: <span class="kw-2">&amp;</span>[u8]) {
+ <span class="kw">if let </span><span class="prelude-val">Some</span>(buf) = <span class="self">self</span>.buf.get_mut(pos..pos + bytes.len()) {
+ buf.copy_from_slice(bytes);
+ } <span class="kw">else </span>{
+ <span class="macro">unimplemented!</span>();
+ }
+ }
+
+ <span class="doccomment">/// Bind the [Label] to the current location.
+ </span><span class="kw">pub fn </span>bind(<span class="kw-2">&amp;mut </span><span class="self">self</span>, label: <span class="kw-2">&amp;mut </span>Label) {
+ <span class="comment">// Bind the label to the current offset.
+ </span>label.bind(<span class="self">self</span>.buf.len());
+
+ <span class="comment">// Resolve any pending relocations for the label.
+ </span><span class="self">self</span>.resolve(label);
+ }
+
+ <span class="doccomment">/// If the [Label] is bound, patch any pending relocation.
+ </span><span class="kw">fn </span>resolve(<span class="kw-2">&amp;mut </span><span class="self">self</span>, label: <span class="kw-2">&amp;mut </span>Label) {
+ <span class="kw">if let </span><span class="prelude-val">Some</span>(loc) = label.location() {
+ <span class="comment">// For now we only support disp32 as label location.
+ </span><span class="kw">let </span>loc = i32::try_from(loc).expect(<span class="string">&quot;Label location did not fit into i32.&quot;</span>);
+
+ <span class="comment">// Resolve any pending relocations for the label.
+ </span><span class="kw">for </span>off <span class="kw">in </span>label.offsets_mut().drain() {
+ <span class="comment">// Displacement is relative to the next instruction following the jump.
+ // We record the offset to patch at the first byte of the disp32 therefore we need
+ // to account for that in the disp computation.
+ </span><span class="kw">let </span>disp32 = loc - i32::try_from(off).expect(<span class="string">&quot;Label offset did not fit into i32&quot;</span>) - <span class="number">4 </span><span class="comment">/* account for the disp32 */</span>;
+
+ <span class="comment">// Patch the relocation with the disp32.
+ </span><span class="self">self</span>.emit_at(off, <span class="kw-2">&amp;</span>disp32.to_ne_bytes());
+ }
+ }
+ }
+
+ <span class="comment">// -- Encode utilities.
+
+ </span><span class="doccomment">/// Encode an register-register instruction.
+ </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>encode_rr&lt;T: Reg&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, opc: u8, op1: T, op2: T)
+ <span class="kw">where
+ </span><span class="self">Self</span>: EncodeRR&lt;T&gt;,
+ {
+ <span class="comment">// MR operand encoding.
+ // op1 -&gt; modrm.rm
+ // op2 -&gt; modrm.reg
+ </span><span class="kw">let </span>modrm = modrm(
+ <span class="number">0b11</span>, <span class="comment">/* mod */
+ </span>op2.idx(), <span class="comment">/* reg */
+ </span>op1.idx(), <span class="comment">/* rm */
+ </span>);
+
+ <span class="kw">let </span>prefix = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeRR&lt;T&gt;&gt;::legacy_prefix();
+ <span class="kw">let </span>rex = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeRR&lt;T&gt;&gt;::rex(op1, op2);
+
+ <span class="self">self</span>.emit_optional(<span class="kw-2">&amp;</span>[prefix, rex]);
+ <span class="self">self</span>.emit(<span class="kw-2">&amp;</span>[opc, modrm]);
+ }
+
+ <span class="doccomment">/// Encode an offset-immediate instruction.
+ /// Register idx is encoded in the opcode.
+ </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>encode_oi&lt;T: Reg, U: Imm&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, opc: u8, op1: T, op2: U)
+ <span class="kw">where
+ </span><span class="self">Self</span>: EncodeR&lt;T&gt;,
+ {
+ <span class="kw">let </span>opc = opc + (op1.idx() &amp; <span class="number">0b111</span>);
+ <span class="kw">let </span>prefix = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeR&lt;T&gt;&gt;::legacy_prefix();
+ <span class="kw">let </span>rex = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeR&lt;T&gt;&gt;::rex(op1);
+
+ <span class="self">self</span>.emit_optional(<span class="kw-2">&amp;</span>[prefix, rex]);
+ <span class="self">self</span>.emit(<span class="kw-2">&amp;</span>[opc]);
+ <span class="self">self</span>.emit(op2.bytes());
+ }
+
+ <span class="doccomment">/// Encode a register instruction.
+ </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>encode_r&lt;T: Reg&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, opc: u8, opc_ext: u8, op1: T)
+ <span class="kw">where
+ </span><span class="self">Self</span>: EncodeR&lt;T&gt;,
+ {
+ <span class="comment">// M operand encoding.
+ // op1 -&gt; modrm.rm
+ // opc extension -&gt; modrm.reg
+ </span><span class="kw">let </span>modrm = modrm(
+ <span class="number">0b11</span>, <span class="comment">/* mod */
+ </span>opc_ext, <span class="comment">/* reg */
+ </span>op1.idx(), <span class="comment">/* rm */
+ </span>);
+
+ <span class="kw">let </span>prefix = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeR&lt;T&gt;&gt;::legacy_prefix();
+ <span class="kw">let </span>rex = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeR&lt;T&gt;&gt;::rex(op1);
+
+ <span class="self">self</span>.emit_optional(<span class="kw-2">&amp;</span>[prefix, rex]);
+ <span class="self">self</span>.emit(<span class="kw-2">&amp;</span>[opc, modrm]);
+ }
+
+ <span class="doccomment">/// Encode a memory-immediate instruction.
+ </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>encode_mi&lt;T: Imm&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, opc: u8, opc_ext: u8, op1: MemOp, op2: T)
+ <span class="kw">where
+ </span><span class="self">Self</span>: EncodeMI&lt;T&gt;,
+ {
+ <span class="comment">// MI operand encoding.
+ // op1 -&gt; modrm.rm
+ // op2 -&gt; imm
+ </span><span class="kw">let </span>mode = <span class="kw">match </span>op1 {
+ MemOp::Indirect(..) =&gt; {
+ <span class="macro">assert!</span>(!op1.base().need_sib() &amp;&amp; !op1.base().is_pc_rel());
+ <span class="number">0b00
+ </span>}
+ MemOp::IndirectDisp(..) =&gt; {
+ <span class="macro">assert!</span>(!op1.base().need_sib());
+ <span class="number">0b10
+ </span>}
+ };
+
+ <span class="kw">let </span>modrm = modrm(
+ mode, <span class="comment">/* mode */
+ </span>opc_ext, <span class="comment">/* reg */
+ </span>op1.base().idx(), <span class="comment">/* rm */
+ </span>);
+
+ <span class="kw">let </span>prefix = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeMI&lt;T&gt;&gt;::legacy_prefix();
+ <span class="kw">let </span>rex = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeMI&lt;T&gt;&gt;::rex(<span class="kw-2">&amp;</span>op1);
+
+ <span class="self">self</span>.emit_optional(<span class="kw-2">&amp;</span>[prefix, rex]);
+ <span class="self">self</span>.emit(<span class="kw-2">&amp;</span>[opc, modrm]);
+ <span class="kw">if let </span>MemOp::IndirectDisp(<span class="kw">_</span>, disp) = op1 {
+ <span class="self">self</span>.emit(<span class="kw-2">&amp;</span>disp.to_ne_bytes());
+ }
+ <span class="self">self</span>.emit(op2.bytes());
+ }
+
+ <span class="doccomment">/// Encode a memory-register instruction.
+ </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>encode_mr&lt;T: Reg&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, opc: u8, op1: MemOp, op2: T)
+ <span class="kw">where
+ </span><span class="self">Self</span>: EncodeMR&lt;T&gt;,
+ {
+ <span class="comment">// MR operand encoding.
+ // op1 -&gt; modrm.rm
+ // op2 -&gt; modrm.reg
+ </span><span class="kw">let </span>mode = <span class="kw">match </span>op1 {
+ MemOp::Indirect(..) =&gt; {
+ <span class="macro">assert!</span>(!op1.base().need_sib() &amp;&amp; !op1.base().is_pc_rel());
+ <span class="number">0b00
+ </span>}
+ MemOp::IndirectDisp(..) =&gt; {
+ <span class="macro">assert!</span>(!op1.base().need_sib());
+ <span class="number">0b10
+ </span>}
+ };
+
+ <span class="kw">let </span>modrm = modrm(
+ mode, <span class="comment">/* mode */
+ </span>op2.idx(), <span class="comment">/* reg */
+ </span>op1.base().idx(), <span class="comment">/* rm */
+ </span>);
+ <span class="kw">let </span>prefix = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeMR&lt;T&gt;&gt;::legacy_prefix();
+ <span class="kw">let </span>rex = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeMR&lt;T&gt;&gt;::rex(<span class="kw-2">&amp;</span>op1, op2);
+
+ <span class="self">self</span>.emit_optional(<span class="kw-2">&amp;</span>[prefix, rex]);
+ <span class="self">self</span>.emit(<span class="kw-2">&amp;</span>[opc, modrm]);
+ <span class="kw">if let </span>MemOp::IndirectDisp(<span class="kw">_</span>, disp) = op1 {
+ <span class="self">self</span>.emit(<span class="kw-2">&amp;</span>disp.to_ne_bytes());
+ }
+ }
+
+ <span class="doccomment">/// Encode a register-memory instruction.
+ </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>encode_rm&lt;T: Reg&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, opc: u8, op1: T, op2: MemOp)
+ <span class="kw">where
+ </span><span class="self">Self</span>: EncodeMR&lt;T&gt;,
+ {
+ <span class="comment">// RM operand encoding.
+ // op1 -&gt; modrm.reg
+ // op2 -&gt; modrm.rm
+ </span><span class="self">self</span>.encode_mr(opc, op2, op1);
+ }
+
+ <span class="doccomment">/// Encode a jump to label instruction.
+ </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>encode_jmp_label(<span class="kw-2">&amp;mut </span><span class="self">self</span>, opc: <span class="kw-2">&amp;</span>[u8], op1: <span class="kw-2">&amp;mut </span>Label) {
+ <span class="comment">// Emit the opcode.
+ </span><span class="self">self</span>.emit(opc);
+
+ <span class="comment">// Record relocation offset starting at the first byte of the disp32.
+ </span>op1.record_offset(<span class="self">self</span>.buf.len());
+
+ <span class="comment">// Emit a zeroed disp32, which serves as placeholder for the relocation.
+ // We currently only support disp32 jump targets.
+ </span><span class="self">self</span>.emit(<span class="kw-2">&amp;</span>[<span class="number">0u8</span>; <span class="number">4</span>]);
+
+ <span class="comment">// Resolve any pending relocations for the label.
+ </span><span class="self">self</span>.resolve(op1);
+ }
+}
+
+<span class="comment">// -- Encoder helper.
+
+</span><span class="doccomment">/// Encode helper for register-register instructions.
+</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">trait </span>EncodeRR&lt;T: Reg&gt; {
+ <span class="kw">fn </span>legacy_prefix() -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
+ <span class="prelude-val">None
+ </span>}
+
+ <span class="kw">fn </span>rex(op1: T, op2: T) -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
+ <span class="kw">if </span>op1.need_rex() || op2.need_rex() {
+ <span class="prelude-val">Some</span>(rex(op1.rexw(), op2.idx(), <span class="number">0</span>, op1.idx()))
+ } <span class="kw">else </span>{
+ <span class="prelude-val">None
+ </span>}
+ }
+}
+
+<span class="kw">impl </span>EncodeRR&lt;Reg8&gt; <span class="kw">for </span>Asm {}
+<span class="kw">impl </span>EncodeRR&lt;Reg32&gt; <span class="kw">for </span>Asm {}
+<span class="kw">impl </span>EncodeRR&lt;Reg16&gt; <span class="kw">for </span>Asm {
+ <span class="kw">fn </span>legacy_prefix() -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
+ <span class="prelude-val">Some</span>(<span class="number">0x66</span>)
+ }
+}
+<span class="kw">impl </span>EncodeRR&lt;Reg64&gt; <span class="kw">for </span>Asm {}
+
+<span class="doccomment">/// Encode helper for register instructions.
+</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">trait </span>EncodeR&lt;T: Reg&gt; {
+ <span class="kw">fn </span>legacy_prefix() -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
+ <span class="prelude-val">None
+ </span>}
+
+ <span class="kw">fn </span>rex(op1: T) -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
+ <span class="kw">if </span>op1.need_rex() {
+ <span class="prelude-val">Some</span>(rex(op1.rexw(), <span class="number">0</span>, <span class="number">0</span>, op1.idx()))
+ } <span class="kw">else </span>{
+ <span class="prelude-val">None
+ </span>}
+ }
+}
+
+<span class="kw">impl </span>EncodeR&lt;Reg8&gt; <span class="kw">for </span>Asm {}
+<span class="kw">impl </span>EncodeR&lt;Reg32&gt; <span class="kw">for </span>Asm {}
+<span class="kw">impl </span>EncodeR&lt;Reg16&gt; <span class="kw">for </span>Asm {
+ <span class="kw">fn </span>legacy_prefix() -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
+ <span class="prelude-val">Some</span>(<span class="number">0x66</span>)
+ }
+}
+<span class="kw">impl </span>EncodeR&lt;Reg64&gt; <span class="kw">for </span>Asm {}
+
+<span class="doccomment">/// Encode helper for memory-register instructions.
+</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">trait </span>EncodeMR&lt;T: Reg&gt; {
+ <span class="kw">fn </span>legacy_prefix() -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
+ <span class="prelude-val">None
+ </span>}
+
+ <span class="kw">fn </span>rex(op1: <span class="kw-2">&amp;</span>MemOp, op2: T) -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
+ <span class="kw">if </span>op2.need_rex() || (op1.base().is_ext()) {
+ <span class="prelude-val">Some</span>(rex(op2.rexw(), op2.idx(), <span class="number">0</span>, op1.base().idx()))
+ } <span class="kw">else </span>{
+ <span class="prelude-val">None
+ </span>}
+ }
+}
+
+<span class="kw">impl </span>EncodeMR&lt;Reg8&gt; <span class="kw">for </span>Asm {}
+<span class="kw">impl </span>EncodeMR&lt;Reg16&gt; <span class="kw">for </span>Asm {
+ <span class="kw">fn </span>legacy_prefix() -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
+ <span class="prelude-val">Some</span>(<span class="number">0x66</span>)
+ }
+}
+<span class="kw">impl </span>EncodeMR&lt;Reg32&gt; <span class="kw">for </span>Asm {}
+<span class="kw">impl </span>EncodeMR&lt;Reg64&gt; <span class="kw">for </span>Asm {}
+
+<span class="doccomment">/// Encode helper for memory-immediate instructions.
+</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">trait </span>EncodeMI&lt;T: Imm&gt; {
+ <span class="kw">fn </span>legacy_prefix() -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
+ <span class="prelude-val">None
+ </span>}
+
+ <span class="kw">fn </span>rex(op1: <span class="kw-2">&amp;</span>MemOp) -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
+ <span class="kw">if </span>op1.base().is_ext() {
+ <span class="prelude-val">Some</span>(rex(<span class="bool-val">false</span>, <span class="number">0</span>, <span class="number">0</span>, op1.base().idx()))
+ } <span class="kw">else </span>{
+ <span class="prelude-val">None
+ </span>}
+ }
+}
+
+<span class="kw">impl </span>EncodeMI&lt;Imm8&gt; <span class="kw">for </span>Asm {}
+<span class="kw">impl </span>EncodeMI&lt;Imm16&gt; <span class="kw">for </span>Asm {
+ <span class="kw">fn </span>legacy_prefix() -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
+ <span class="prelude-val">Some</span>(<span class="number">0x66</span>)
+ }
+}
+<span class="kw">impl </span>EncodeMI&lt;Imm32&gt; <span class="kw">for </span>Asm {}
+</code></pre></div></section></main></body></html> \ No newline at end of file
diff --git a/src/juicebox_asm/imm.rs.html b/src/juicebox_asm/imm.rs.html
index 78f4a8b..e0b6592 100644
--- a/src/juicebox_asm/imm.rs.html
+++ b/src/juicebox_asm/imm.rs.html
@@ -48,6 +48,19 @@
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
+<a href="#51" id="51">51</a>
+<a href="#52" id="52">52</a>
+<a href="#53" id="53">53</a>
+<a href="#54" id="54">54</a>
+<a href="#55" id="55">55</a>
+<a href="#56" id="56">56</a>
+<a href="#57" id="57">57</a>
+<a href="#58" id="58">58</a>
+<a href="#59" id="59">59</a>
+<a href="#60" id="60">60</a>
+<a href="#61" id="61">61</a>
+<a href="#62" id="62">62</a>
+<a href="#63" id="63">63</a>
</pre></div><pre class="rust"><code><span class="doccomment">//! Definition of different immediate types which are used as input operands for various
//! instructions.
@@ -96,6 +109,19 @@
);
<span class="macro">impl_imm!</span>(
<span class="doccomment">/// Type representing a 64 bit immediate.
- </span>Imm64, <span class="number">8</span>, from: { u64, i64, u32, i32, u16, i16, u8, i8 }
+ </span>Imm64, <span class="number">8</span>, from: { u64, i64, u32, i32, u16, i16, u8, i8, usize, isize }
);
+
+<span class="attr">#[cfg(test)]
+</span><span class="kw">mod </span>test {
+ <span class="kw">use super</span>::<span class="kw-2">*</span>;
+ <span class="kw">use </span>std::mem::size_of;
+
+ <span class="attr">#[test]
+ </span><span class="kw">fn </span>test_usize_isize() {
+ <span class="comment">// Imm64 should not implementd from usize/isize if this fails.
+ </span><span class="macro">assert_eq!</span>(size_of::&lt;usize&gt;(), size_of::&lt;Imm64&gt;());
+ <span class="macro">assert_eq!</span>(size_of::&lt;isize&gt;(), size_of::&lt;Imm64&gt;());
+ }
+}
</code></pre></div></section></main></body></html> \ No newline at end of file
diff --git a/src/juicebox_asm/insn.rs.html b/src/juicebox_asm/insn.rs.html
index 550a4ab..a367feb 100644
--- a/src/juicebox_asm/insn.rs.html
+++ b/src/juicebox_asm/insn.rs.html
@@ -59,6 +59,18 @@
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
+<a href="#62" id="62">62</a>
+<a href="#63" id="63">63</a>
+<a href="#64" id="64">64</a>
+<a href="#65" id="65">65</a>
+<a href="#66" id="66">66</a>
+<a href="#67" id="67">67</a>
+<a href="#68" id="68">68</a>
+<a href="#69" id="69">69</a>
+<a href="#70" id="70">70</a>
+<a href="#71" id="71">71</a>
+<a href="#72" id="72">72</a>
+<a href="#73" id="73">73</a>
</pre></div><pre class="rust"><code><span class="doccomment">//! Trait definitions of various instructions.
</span><span class="kw">mod </span>add;
@@ -73,47 +85,59 @@
<span class="kw">mod </span>ret;
<span class="kw">mod </span>test;
-<span class="kw">pub trait </span>Add&lt;T, U&gt; {
+<span class="doccomment">/// Trait for [`add`](https://www.felixcloutier.com/x86/add) instruction kinds.
+</span><span class="kw">pub trait </span>Add&lt;T, U&gt; {
<span class="doccomment">/// Emit an add instruction.
</span><span class="kw">fn </span>add(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: T, op2: U);
}
-<span class="kw">pub trait </span>Call&lt;T&gt; {
+<span class="doccomment">/// Trait for [`call`](https://www.felixcloutier.com/x86/call) instruction kinds.
+</span><span class="kw">pub trait </span>Call&lt;T&gt; {
<span class="doccomment">/// Emit a call instruction.
</span><span class="kw">fn </span>call(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: T);
}
-<span class="kw">pub trait </span>Cmp&lt;T, U&gt; {
- <span class="doccomment">/// Emit a compare call instruction.
+<span class="doccomment">/// Trait for [`cmp`](https://www.felixcloutier.com/x86/cmp) instruction kinds.
+</span><span class="kw">pub trait </span>Cmp&lt;T, U&gt; {
+ <span class="doccomment">/// Emit a compare instruction.
+ ///
+ /// Computes `op2 - op1` and sets the status flags in the same way as the `sub` instruction,
+ /// the result is discarded.
</span><span class="kw">fn </span>cmp(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: T, op2: U);
}
-<span class="kw">pub trait </span>Dec&lt;T&gt; {
+<span class="doccomment">/// Trait for [`dec`](https://www.felixcloutier.com/x86/dec) instruction kinds.
+</span><span class="kw">pub trait </span>Dec&lt;T&gt; {
<span class="doccomment">/// Emit a decrement instruction.
</span><span class="kw">fn </span>dec(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: T);
}
-<span class="kw">pub trait </span>Jmp&lt;T&gt; {
+<span class="doccomment">/// Trait for [`jmp`](https://www.felixcloutier.com/x86/jmp) instruction kinds.
+</span><span class="kw">pub trait </span>Jmp&lt;T&gt; {
<span class="doccomment">/// Emit an unconditional jump instruction.
</span><span class="kw">fn </span>jmp(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: T);
}
-<span class="kw">pub trait </span>Jnz&lt;T&gt; {
+<span class="doccomment">/// Trait for [`jnz`](https://www.felixcloutier.com/x86/jcc) instruction kinds.
+</span><span class="kw">pub trait </span>Jnz&lt;T&gt; {
<span class="doccomment">/// Emit a conditional jump if not zero instruction (`ZF = 0`).
</span><span class="kw">fn </span>jnz(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: T);
}
-<span class="kw">pub trait </span>Jz&lt;T&gt; {
+<span class="doccomment">/// Trait for [`jz`](https://www.felixcloutier.com/x86/jcc) instruction kinds.
+</span><span class="kw">pub trait </span>Jz&lt;T&gt; {
<span class="doccomment">/// Emit a conditional jump if zero instruction (`ZF = 1`).
</span><span class="kw">fn </span>jz(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: T);
}
-<span class="kw">pub trait </span>Mov&lt;T, U&gt; {
+<span class="doccomment">/// Trait for [`mov`](https://www.felixcloutier.com/x86/mov) instruction kinds.
+</span><span class="kw">pub trait </span>Mov&lt;T, U&gt; {
<span class="doccomment">/// Emit an move instruction.
</span><span class="kw">fn </span>mov(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: T, op2: U);
}
-<span class="kw">pub trait </span>Test&lt;T, U&gt; {
+<span class="doccomment">/// Trait for [`test`](https://www.felixcloutier.com/x86/test) instruction kinds.
+</span><span class="kw">pub trait </span>Test&lt;T, U&gt; {
<span class="doccomment">/// Emit a logical compare instruction.
///
/// Computes the bit-wise logical AND of first operand and the second operand and sets the
diff --git a/src/juicebox_asm/insn/add.rs.html b/src/juicebox_asm/insn/add.rs.html
index d7f968a..d7d8c39 100644
--- a/src/juicebox_asm/insn/add.rs.html
+++ b/src/juicebox_asm/insn/add.rs.html
@@ -23,7 +23,9 @@
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
-</pre></div><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::prelude::<span class="kw-2">*</span>;
+<a href="#26" id="26">26</a>
+</pre></div><pre class="rust"><code><span class="kw">use </span><span class="kw">super</span>::Add;
+<span class="kw">use crate</span>::{Asm, Imm16, MemOp, Reg16, Reg32, Reg64};
<span class="kw">impl </span>Add&lt;Reg64, Reg64&gt; <span class="kw">for </span>Asm {
<span class="kw">fn </span>add(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: Reg64, op2: Reg64) {
diff --git a/src/juicebox_asm/insn/call.rs.html b/src/juicebox_asm/insn/call.rs.html
index f9649ed..e88996d 100644
--- a/src/juicebox_asm/insn/call.rs.html
+++ b/src/juicebox_asm/insn/call.rs.html
@@ -5,7 +5,9 @@
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
-</pre></div><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::prelude::<span class="kw-2">*</span>;
+<a href="#8" id="8">8</a>
+</pre></div><pre class="rust"><code><span class="kw">use </span><span class="kw">super</span>::Call;
+<span class="kw">use crate</span>::{Asm, Reg64};
<span class="kw">impl </span>Call&lt;Reg64&gt; <span class="kw">for </span>Asm {
<span class="kw">fn </span>call(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: Reg64) {
diff --git a/src/juicebox_asm/insn/cmp.rs.html b/src/juicebox_asm/insn/cmp.rs.html
index b50d90d..4e28818 100644
--- a/src/juicebox_asm/insn/cmp.rs.html
+++ b/src/juicebox_asm/insn/cmp.rs.html
@@ -5,7 +5,9 @@
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
-</pre></div><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::prelude::<span class="kw-2">*</span>;
+<a href="#8" id="8">8</a>
+</pre></div><pre class="rust"><code><span class="kw">use </span><span class="kw">super</span>::Cmp;
+<span class="kw">use crate</span>::{Asm, Imm16, MemOp};
<span class="kw">impl </span>Cmp&lt;MemOp, Imm16&gt; <span class="kw">for </span>Asm {
<span class="kw">fn </span>cmp(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: MemOp, op2: Imm16) {
diff --git a/src/juicebox_asm/insn/dec.rs.html b/src/juicebox_asm/insn/dec.rs.html
index 2afecd2..5a10063 100644
--- a/src/juicebox_asm/insn/dec.rs.html
+++ b/src/juicebox_asm/insn/dec.rs.html
@@ -11,7 +11,9 @@
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
-</pre></div><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::prelude::<span class="kw-2">*</span>;
+<a href="#14" id="14">14</a>
+</pre></div><pre class="rust"><code><span class="kw">use </span><span class="kw">super</span>::Dec;
+<span class="kw">use crate</span>::{Asm, Reg32, Reg64};
<span class="kw">impl </span>Dec&lt;Reg64&gt; <span class="kw">for </span>Asm {
<span class="kw">fn </span>dec(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: Reg64) {
diff --git a/src/juicebox_asm/insn/jmp.rs.html b/src/juicebox_asm/insn/jmp.rs.html
index 55da0e3..e0167e3 100644
--- a/src/juicebox_asm/insn/jmp.rs.html
+++ b/src/juicebox_asm/insn/jmp.rs.html
@@ -5,7 +5,9 @@
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
-</pre></div><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::prelude::<span class="kw-2">*</span>;
+<a href="#8" id="8">8</a>
+</pre></div><pre class="rust"><code><span class="kw">use </span><span class="kw">super</span>::Jmp;
+<span class="kw">use crate</span>::{Asm, Label};
<span class="kw">impl </span>Jmp&lt;<span class="kw-2">&amp;mut </span>Label&gt; <span class="kw">for </span>Asm {
<span class="kw">fn </span>jmp(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: <span class="kw-2">&amp;mut </span>Label) {
diff --git a/src/juicebox_asm/insn/jnz.rs.html b/src/juicebox_asm/insn/jnz.rs.html
index 45fb92d..be0062d 100644
--- a/src/juicebox_asm/insn/jnz.rs.html
+++ b/src/juicebox_asm/insn/jnz.rs.html
@@ -5,7 +5,9 @@
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
-</pre></div><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::prelude::<span class="kw-2">*</span>;
+<a href="#8" id="8">8</a>
+</pre></div><pre class="rust"><code><span class="kw">use </span><span class="kw">super</span>::Jnz;
+<span class="kw">use crate</span>::{Asm, Label};
<span class="kw">impl </span>Jnz&lt;<span class="kw-2">&amp;mut </span>Label&gt; <span class="kw">for </span>Asm {
<span class="kw">fn </span>jnz(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: <span class="kw-2">&amp;mut </span>Label) {
diff --git a/src/juicebox_asm/insn/jz.rs.html b/src/juicebox_asm/insn/jz.rs.html
index 4b17a71..e4197af 100644
--- a/src/juicebox_asm/insn/jz.rs.html
+++ b/src/juicebox_asm/insn/jz.rs.html
@@ -5,7 +5,9 @@
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
-</pre></div><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::prelude::<span class="kw-2">*</span>;
+<a href="#8" id="8">8</a>
+</pre></div><pre class="rust"><code><span class="kw">use </span><span class="kw">super</span>::Jz;
+<span class="kw">use crate</span>::{Asm, Label};
<span class="kw">impl </span>Jz&lt;<span class="kw-2">&amp;mut </span>Label&gt; <span class="kw">for </span>Asm {
<span class="kw">fn </span>jz(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: <span class="kw-2">&amp;mut </span>Label) {
diff --git a/src/juicebox_asm/insn/mov.rs.html b/src/juicebox_asm/insn/mov.rs.html
index 7be5d09..1e672a1 100644
--- a/src/juicebox_asm/insn/mov.rs.html
+++ b/src/juicebox_asm/insn/mov.rs.html
@@ -111,7 +111,9 @@
<a href="#111" id="111">111</a>
<a href="#112" id="112">112</a>
<a href="#113" id="113">113</a>
-</pre></div><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::prelude::<span class="kw-2">*</span>;
+<a href="#114" id="114">114</a>
+</pre></div><pre class="rust"><code><span class="kw">use </span><span class="kw">super</span>::Mov;
+<span class="kw">use crate</span>::{Asm, Imm16, Imm32, Imm64, Imm8, MemOp, Reg16, Reg32, Reg64, Reg8};
<span class="comment">// -- MOV : reg reg
diff --git a/src/juicebox_asm/insn/nop.rs.html b/src/juicebox_asm/insn/nop.rs.html
index accc13a..c3c264b 100644
--- a/src/juicebox_asm/insn/nop.rs.html
+++ b/src/juicebox_asm/insn/nop.rs.html
@@ -5,10 +5,12 @@
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
+<a href="#8" id="8">8</a>
</pre></div><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::Asm;
<span class="kw">impl </span>Asm {
- <span class="kw">pub fn </span>nop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
+ <span class="doccomment">/// Emit a [`nop`](https://www.felixcloutier.com/x86/nop) instruction.
+ </span><span class="kw">pub fn </span>nop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="self">self</span>.emit(<span class="kw-2">&amp;</span>[<span class="number">0x90</span>]);
}
}
diff --git a/src/juicebox_asm/insn/ret.rs.html b/src/juicebox_asm/insn/ret.rs.html
index 97070e8..26e3a47 100644
--- a/src/juicebox_asm/insn/ret.rs.html
+++ b/src/juicebox_asm/insn/ret.rs.html
@@ -5,10 +5,12 @@
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
+<a href="#8" id="8">8</a>
</pre></div><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::Asm;
<span class="kw">impl </span>Asm {
- <span class="kw">pub fn </span>ret(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
+ <span class="doccomment">/// Emit a [`ret`](https://www.felixcloutier.com/x86/ret) instruction.
+ </span><span class="kw">pub fn </span>ret(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="self">self</span>.emit(<span class="kw-2">&amp;</span>[<span class="number">0xc3</span>]);
}
}
diff --git a/src/juicebox_asm/insn/test.rs.html b/src/juicebox_asm/insn/test.rs.html
index d636920..0f1d8da 100644
--- a/src/juicebox_asm/insn/test.rs.html
+++ b/src/juicebox_asm/insn/test.rs.html
@@ -17,7 +17,9 @@
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
-</pre></div><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::prelude::<span class="kw-2">*</span>;
+<a href="#20" id="20">20</a>
+</pre></div><pre class="rust"><code><span class="kw">use </span><span class="kw">super</span>::Test;
+<span class="kw">use crate</span>::{Asm, Imm16, MemOp, Reg32, Reg64};
<span class="kw">impl </span>Test&lt;Reg64, Reg64&gt; <span class="kw">for </span>Asm {
<span class="kw">fn </span>test(<span class="kw-2">&amp;mut </span><span class="self">self</span>, op1: Reg64, op2: Reg64) {
diff --git a/src/juicebox_asm/label.rs.html b/src/juicebox_asm/label.rs.html
index e209289..29d236e 100644
--- a/src/juicebox_asm/label.rs.html
+++ b/src/juicebox_asm/label.rs.html
@@ -80,6 +80,7 @@
<a href="#80" id="80">80</a>
<a href="#81" id="81">81</a>
<a href="#82" id="82">82</a>
+<a href="#83" id="83">83</a>
</pre></div><pre class="rust"><code><span class="doccomment">//! Definition of the lable type which can be used as jump target and can be bound to a location in
//! the emitted code.
@@ -88,7 +89,8 @@
<span class="doccomment">/// A label which is used as target for jump instructions.
///
/// ```rust
-/// use juicebox_asm::prelude::*;
+/// use juicebox_asm::{Asm, Label, Reg64};
+/// use juicebox_asm::insn::{Mov, Jmp};
///
/// let mut lbl = Label::new();
/// let mut asm = Asm::new();
diff --git a/src/juicebox_asm/lib.rs.html b/src/juicebox_asm/lib.rs.html
index 83c8f81..7d1bc0c 100644
--- a/src/juicebox_asm/lib.rs.html
+++ b/src/juicebox_asm/lib.rs.html
@@ -105,373 +105,12 @@
<a href="#105" id="105">105</a>
<a href="#106" id="106">106</a>
<a href="#107" id="107">107</a>
-<a href="#108" id="108">108</a>
-<a href="#109" id="109">109</a>
-<a href="#110" id="110">110</a>
-<a href="#111" id="111">111</a>
-<a href="#112" id="112">112</a>
-<a href="#113" id="113">113</a>
-<a href="#114" id="114">114</a>
-<a href="#115" id="115">115</a>
-<a href="#116" id="116">116</a>
-<a href="#117" id="117">117</a>
-<a href="#118" id="118">118</a>
-<a href="#119" id="119">119</a>
-<a href="#120" id="120">120</a>
-<a href="#121" id="121">121</a>
-<a href="#122" id="122">122</a>
-<a href="#123" id="123">123</a>
-<a href="#124" id="124">124</a>
-<a href="#125" id="125">125</a>
-<a href="#126" id="126">126</a>
-<a href="#127" id="127">127</a>
-<a href="#128" id="128">128</a>
-<a href="#129" id="129">129</a>
-<a href="#130" id="130">130</a>
-<a href="#131" id="131">131</a>
-<a href="#132" id="132">132</a>
-<a href="#133" id="133">133</a>
-<a href="#134" id="134">134</a>
-<a href="#135" id="135">135</a>
-<a href="#136" id="136">136</a>
-<a href="#137" id="137">137</a>
-<a href="#138" id="138">138</a>
-<a href="#139" id="139">139</a>
-<a href="#140" id="140">140</a>
-<a href="#141" id="141">141</a>
-<a href="#142" id="142">142</a>
-<a href="#143" id="143">143</a>
-<a href="#144" id="144">144</a>
-<a href="#145" id="145">145</a>
-<a href="#146" id="146">146</a>
-<a href="#147" id="147">147</a>
-<a href="#148" id="148">148</a>
-<a href="#149" id="149">149</a>
-<a href="#150" id="150">150</a>
-<a href="#151" id="151">151</a>
-<a href="#152" id="152">152</a>
-<a href="#153" id="153">153</a>
-<a href="#154" id="154">154</a>
-<a href="#155" id="155">155</a>
-<a href="#156" id="156">156</a>
-<a href="#157" id="157">157</a>
-<a href="#158" id="158">158</a>
-<a href="#159" id="159">159</a>
-<a href="#160" id="160">160</a>
-<a href="#161" id="161">161</a>
-<a href="#162" id="162">162</a>
-<a href="#163" id="163">163</a>
-<a href="#164" id="164">164</a>
-<a href="#165" id="165">165</a>
-<a href="#166" id="166">166</a>
-<a href="#167" id="167">167</a>
-<a href="#168" id="168">168</a>
-<a href="#169" id="169">169</a>
-<a href="#170" id="170">170</a>
-<a href="#171" id="171">171</a>
-<a href="#172" id="172">172</a>
-<a href="#173" id="173">173</a>
-<a href="#174" id="174">174</a>
-<a href="#175" id="175">175</a>
-<a href="#176" id="176">176</a>
-<a href="#177" id="177">177</a>
-<a href="#178" id="178">178</a>
-<a href="#179" id="179">179</a>
-<a href="#180" id="180">180</a>
-<a href="#181" id="181">181</a>
-<a href="#182" id="182">182</a>
-<a href="#183" id="183">183</a>
-<a href="#184" id="184">184</a>
-<a href="#185" id="185">185</a>
-<a href="#186" id="186">186</a>
-<a href="#187" id="187">187</a>
-<a href="#188" id="188">188</a>
-<a href="#189" id="189">189</a>
-<a href="#190" id="190">190</a>
-<a href="#191" id="191">191</a>
-<a href="#192" id="192">192</a>
-<a href="#193" id="193">193</a>
-<a href="#194" id="194">194</a>
-<a href="#195" id="195">195</a>
-<a href="#196" id="196">196</a>
-<a href="#197" id="197">197</a>
-<a href="#198" id="198">198</a>
-<a href="#199" id="199">199</a>
-<a href="#200" id="200">200</a>
-<a href="#201" id="201">201</a>
-<a href="#202" id="202">202</a>
-<a href="#203" id="203">203</a>
-<a href="#204" id="204">204</a>
-<a href="#205" id="205">205</a>
-<a href="#206" id="206">206</a>
-<a href="#207" id="207">207</a>
-<a href="#208" id="208">208</a>
-<a href="#209" id="209">209</a>
-<a href="#210" id="210">210</a>
-<a href="#211" id="211">211</a>
-<a href="#212" id="212">212</a>
-<a href="#213" id="213">213</a>
-<a href="#214" id="214">214</a>
-<a href="#215" id="215">215</a>
-<a href="#216" id="216">216</a>
-<a href="#217" id="217">217</a>
-<a href="#218" id="218">218</a>
-<a href="#219" id="219">219</a>
-<a href="#220" id="220">220</a>
-<a href="#221" id="221">221</a>
-<a href="#222" id="222">222</a>
-<a href="#223" id="223">223</a>
-<a href="#224" id="224">224</a>
-<a href="#225" id="225">225</a>
-<a href="#226" id="226">226</a>
-<a href="#227" id="227">227</a>
-<a href="#228" id="228">228</a>
-<a href="#229" id="229">229</a>
-<a href="#230" id="230">230</a>
-<a href="#231" id="231">231</a>
-<a href="#232" id="232">232</a>
-<a href="#233" id="233">233</a>
-<a href="#234" id="234">234</a>
-<a href="#235" id="235">235</a>
-<a href="#236" id="236">236</a>
-<a href="#237" id="237">237</a>
-<a href="#238" id="238">238</a>
-<a href="#239" id="239">239</a>
-<a href="#240" id="240">240</a>
-<a href="#241" id="241">241</a>
-<a href="#242" id="242">242</a>
-<a href="#243" id="243">243</a>
-<a href="#244" id="244">244</a>
-<a href="#245" id="245">245</a>
-<a href="#246" id="246">246</a>
-<a href="#247" id="247">247</a>
-<a href="#248" id="248">248</a>
-<a href="#249" id="249">249</a>
-<a href="#250" id="250">250</a>
-<a href="#251" id="251">251</a>
-<a href="#252" id="252">252</a>
-<a href="#253" id="253">253</a>
-<a href="#254" id="254">254</a>
-<a href="#255" id="255">255</a>
-<a href="#256" id="256">256</a>
-<a href="#257" id="257">257</a>
-<a href="#258" id="258">258</a>
-<a href="#259" id="259">259</a>
-<a href="#260" id="260">260</a>
-<a href="#261" id="261">261</a>
-<a href="#262" id="262">262</a>
-<a href="#263" id="263">263</a>
-<a href="#264" id="264">264</a>
-<a href="#265" id="265">265</a>
-<a href="#266" id="266">266</a>
-<a href="#267" id="267">267</a>
-<a href="#268" id="268">268</a>
-<a href="#269" id="269">269</a>
-<a href="#270" id="270">270</a>
-<a href="#271" id="271">271</a>
-<a href="#272" id="272">272</a>
-<a href="#273" id="273">273</a>
-<a href="#274" id="274">274</a>
-<a href="#275" id="275">275</a>
-<a href="#276" id="276">276</a>
-<a href="#277" id="277">277</a>
-<a href="#278" id="278">278</a>
-<a href="#279" id="279">279</a>
-<a href="#280" id="280">280</a>
-<a href="#281" id="281">281</a>
-<a href="#282" id="282">282</a>
-<a href="#283" id="283">283</a>
-<a href="#284" id="284">284</a>
-<a href="#285" id="285">285</a>
-<a href="#286" id="286">286</a>
-<a href="#287" id="287">287</a>
-<a href="#288" id="288">288</a>
-<a href="#289" id="289">289</a>
-<a href="#290" id="290">290</a>
-<a href="#291" id="291">291</a>
-<a href="#292" id="292">292</a>
-<a href="#293" id="293">293</a>
-<a href="#294" id="294">294</a>
-<a href="#295" id="295">295</a>
-<a href="#296" id="296">296</a>
-<a href="#297" id="297">297</a>
-<a href="#298" id="298">298</a>
-<a href="#299" id="299">299</a>
-<a href="#300" id="300">300</a>
-<a href="#301" id="301">301</a>
-<a href="#302" id="302">302</a>
-<a href="#303" id="303">303</a>
-<a href="#304" id="304">304</a>
-<a href="#305" id="305">305</a>
-<a href="#306" id="306">306</a>
-<a href="#307" id="307">307</a>
-<a href="#308" id="308">308</a>
-<a href="#309" id="309">309</a>
-<a href="#310" id="310">310</a>
-<a href="#311" id="311">311</a>
-<a href="#312" id="312">312</a>
-<a href="#313" id="313">313</a>
-<a href="#314" id="314">314</a>
-<a href="#315" id="315">315</a>
-<a href="#316" id="316">316</a>
-<a href="#317" id="317">317</a>
-<a href="#318" id="318">318</a>
-<a href="#319" id="319">319</a>
-<a href="#320" id="320">320</a>
-<a href="#321" id="321">321</a>
-<a href="#322" id="322">322</a>
-<a href="#323" id="323">323</a>
-<a href="#324" id="324">324</a>
-<a href="#325" id="325">325</a>
-<a href="#326" id="326">326</a>
-<a href="#327" id="327">327</a>
-<a href="#328" id="328">328</a>
-<a href="#329" id="329">329</a>
-<a href="#330" id="330">330</a>
-<a href="#331" id="331">331</a>
-<a href="#332" id="332">332</a>
-<a href="#333" id="333">333</a>
-<a href="#334" id="334">334</a>
-<a href="#335" id="335">335</a>
-<a href="#336" id="336">336</a>
-<a href="#337" id="337">337</a>
-<a href="#338" id="338">338</a>
-<a href="#339" id="339">339</a>
-<a href="#340" id="340">340</a>
-<a href="#341" id="341">341</a>
-<a href="#342" id="342">342</a>
-<a href="#343" id="343">343</a>
-<a href="#344" id="344">344</a>
-<a href="#345" id="345">345</a>
-<a href="#346" id="346">346</a>
-<a href="#347" id="347">347</a>
-<a href="#348" id="348">348</a>
-<a href="#349" id="349">349</a>
-<a href="#350" id="350">350</a>
-<a href="#351" id="351">351</a>
-<a href="#352" id="352">352</a>
-<a href="#353" id="353">353</a>
-<a href="#354" id="354">354</a>
-<a href="#355" id="355">355</a>
-<a href="#356" id="356">356</a>
-<a href="#357" id="357">357</a>
-<a href="#358" id="358">358</a>
-<a href="#359" id="359">359</a>
-<a href="#360" id="360">360</a>
-<a href="#361" id="361">361</a>
-<a href="#362" id="362">362</a>
-<a href="#363" id="363">363</a>
-<a href="#364" id="364">364</a>
-<a href="#365" id="365">365</a>
-<a href="#366" id="366">366</a>
-<a href="#367" id="367">367</a>
-<a href="#368" id="368">368</a>
-<a href="#369" id="369">369</a>
-<a href="#370" id="370">370</a>
-<a href="#371" id="371">371</a>
-<a href="#372" id="372">372</a>
-<a href="#373" id="373">373</a>
-<a href="#374" id="374">374</a>
-<a href="#375" id="375">375</a>
-<a href="#376" id="376">376</a>
-<a href="#377" id="377">377</a>
-<a href="#378" id="378">378</a>
-<a href="#379" id="379">379</a>
-<a href="#380" id="380">380</a>
-<a href="#381" id="381">381</a>
-<a href="#382" id="382">382</a>
-<a href="#383" id="383">383</a>
-<a href="#384" id="384">384</a>
-<a href="#385" id="385">385</a>
-<a href="#386" id="386">386</a>
-<a href="#387" id="387">387</a>
-<a href="#388" id="388">388</a>
-<a href="#389" id="389">389</a>
-<a href="#390" id="390">390</a>
-<a href="#391" id="391">391</a>
-<a href="#392" id="392">392</a>
-<a href="#393" id="393">393</a>
-<a href="#394" id="394">394</a>
-<a href="#395" id="395">395</a>
-<a href="#396" id="396">396</a>
-<a href="#397" id="397">397</a>
-<a href="#398" id="398">398</a>
-<a href="#399" id="399">399</a>
-<a href="#400" id="400">400</a>
-<a href="#401" id="401">401</a>
-<a href="#402" id="402">402</a>
-<a href="#403" id="403">403</a>
-<a href="#404" id="404">404</a>
-<a href="#405" id="405">405</a>
-<a href="#406" id="406">406</a>
-<a href="#407" id="407">407</a>
-<a href="#408" id="408">408</a>
-<a href="#409" id="409">409</a>
-<a href="#410" id="410">410</a>
-<a href="#411" id="411">411</a>
-<a href="#412" id="412">412</a>
-<a href="#413" id="413">413</a>
-<a href="#414" id="414">414</a>
-<a href="#415" id="415">415</a>
-<a href="#416" id="416">416</a>
-<a href="#417" id="417">417</a>
-<a href="#418" id="418">418</a>
-<a href="#419" id="419">419</a>
-<a href="#420" id="420">420</a>
-<a href="#421" id="421">421</a>
-<a href="#422" id="422">422</a>
-<a href="#423" id="423">423</a>
-<a href="#424" id="424">424</a>
-<a href="#425" id="425">425</a>
-<a href="#426" id="426">426</a>
-<a href="#427" id="427">427</a>
-<a href="#428" id="428">428</a>
-<a href="#429" id="429">429</a>
-<a href="#430" id="430">430</a>
-<a href="#431" id="431">431</a>
-<a href="#432" id="432">432</a>
-<a href="#433" id="433">433</a>
-<a href="#434" id="434">434</a>
-<a href="#435" id="435">435</a>
-<a href="#436" id="436">436</a>
-<a href="#437" id="437">437</a>
-<a href="#438" id="438">438</a>
-<a href="#439" id="439">439</a>
-<a href="#440" id="440">440</a>
-<a href="#441" id="441">441</a>
-<a href="#442" id="442">442</a>
-<a href="#443" id="443">443</a>
-<a href="#444" id="444">444</a>
-<a href="#445" id="445">445</a>
-<a href="#446" id="446">446</a>
-<a href="#447" id="447">447</a>
-<a href="#448" id="448">448</a>
-<a href="#449" id="449">449</a>
-<a href="#450" id="450">450</a>
-<a href="#451" id="451">451</a>
-<a href="#452" id="452">452</a>
-<a href="#453" id="453">453</a>
-<a href="#454" id="454">454</a>
-<a href="#455" id="455">455</a>
-<a href="#456" id="456">456</a>
-<a href="#457" id="457">457</a>
-<a href="#458" id="458">458</a>
-<a href="#459" id="459">459</a>
-<a href="#460" id="460">460</a>
-<a href="#461" id="461">461</a>
-<a href="#462" id="462">462</a>
-<a href="#463" id="463">463</a>
-<a href="#464" id="464">464</a>
-<a href="#465" id="465">465</a>
-<a href="#466" id="466">466</a>
-<a href="#467" id="467">467</a>
-<a href="#468" id="468">468</a>
-<a href="#469" id="469">469</a>
</pre></div><pre class="rust"><code><span class="doccomment">//! A simple `x64` jit assembler with a minimal runtime to execute emitted code for fun.
//!
//! The following is an fibonacci example implementation.
//! ```rust
-//! use juicebox_asm::prelude::*;
+//! use juicebox_asm::{Asm, Reg64, Imm64, Label};
+//! use juicebox_asm::insn::*;
//! use juicebox_asm::Runtime;
//!
//! const fn fib_rs(n: u64) -&gt; u64 {
@@ -541,22 +180,20 @@
//! }
//! ```
-</span><span class="kw">pub mod </span>prelude;
-
+</span><span class="kw">mod </span>asm;
<span class="kw">mod </span>imm;
-<span class="kw">mod </span>insn;
<span class="kw">mod </span>label;
<span class="kw">mod </span>reg;
<span class="kw">mod </span>rt;
+<span class="kw">pub mod </span>insn;
+
+<span class="kw">pub use </span>asm::Asm;
<span class="kw">pub use </span>imm::{Imm16, Imm32, Imm64, Imm8};
<span class="kw">pub use </span>label::Label;
<span class="kw">pub use </span>reg::{Reg16, Reg32, Reg64, Reg8};
<span class="kw">pub use </span>rt::Runtime;
-<span class="kw">use </span>imm::Imm;
-<span class="kw">use </span>reg::Reg;
-
<span class="doccomment">/// Type representing a memory operand.
</span><span class="kw">pub enum </span>MemOp {
<span class="doccomment">/// An indirect memory operand, eg `mov [rax], rcx`.
@@ -575,365 +212,4 @@
}
}
}
-
-<span class="doccomment">/// Encode the `REX` byte.
-</span><span class="kw">const fn </span>rex(w: bool, r: u8, x: u8, b: u8) -&gt; u8 {
- <span class="kw">let </span>w = <span class="kw">if </span>w { <span class="number">1 </span>} <span class="kw">else </span>{ <span class="number">0 </span>};
- <span class="kw">let </span>r = (r &gt;&gt; <span class="number">3</span>) &amp; <span class="number">1</span>;
- <span class="kw">let </span>x = (x &gt;&gt; <span class="number">3</span>) &amp; <span class="number">1</span>;
- <span class="kw">let </span>b = (b &gt;&gt; <span class="number">3</span>) &amp; <span class="number">1</span>;
- <span class="number">0b0100_0000 </span>| ((w &amp; <span class="number">1</span>) &lt;&lt; <span class="number">3</span>) | (r &lt;&lt; <span class="number">2</span>) | (x &lt;&lt; <span class="number">1</span>) | b
-}
-
-<span class="doccomment">/// Encode the `ModR/M` byte.
-</span><span class="kw">const fn </span>modrm(mod_: u8, reg: u8, rm: u8) -&gt; u8 {
- ((mod_ &amp; <span class="number">0b11</span>) &lt;&lt; <span class="number">6</span>) | ((reg &amp; <span class="number">0b111</span>) &lt;&lt; <span class="number">3</span>) | (rm &amp; <span class="number">0b111</span>)
-}
-
-<span class="doccomment">/// `x64` jit assembler.
-</span><span class="kw">pub struct </span>Asm {
- buf: Vec&lt;u8&gt;,
-}
-
-<span class="kw">impl </span>Asm {
- <span class="doccomment">/// Create a new `x64` jit assembler.
- </span><span class="kw">pub fn </span>new() -&gt; Asm {
- <span class="comment">// Some random default capacity.
- </span><span class="kw">let </span>buf = Vec::with_capacity(<span class="number">1024</span>);
- Asm { buf }
- }
-
- <span class="doccomment">/// Consume the assembler and get the emitted code.
- </span><span class="kw">pub fn </span>into_code(<span class="self">self</span>) -&gt; Vec&lt;u8&gt; {
- <span class="self">self</span>.buf
- }
-
- <span class="doccomment">/// Emit a slice of bytes.
- </span><span class="kw">fn </span>emit(<span class="kw-2">&amp;mut </span><span class="self">self</span>, bytes: <span class="kw-2">&amp;</span>[u8]) {
- <span class="self">self</span>.buf.extend_from_slice(bytes);
- }
-
- <span class="doccomment">/// Emit a slice of optional bytes.
- </span><span class="kw">fn </span>emit_optional(<span class="kw-2">&amp;mut </span><span class="self">self</span>, bytes: <span class="kw-2">&amp;</span>[<span class="prelude-ty">Option</span>&lt;u8&gt;]) {
- <span class="kw">for </span>byte <span class="kw">in </span>bytes.iter().filter_map(|<span class="kw-2">&amp;</span>b| b) {
- <span class="self">self</span>.buf.push(byte);
- }
- }
-
- <span class="doccomment">/// Emit a slice of bytes at `pos`.
- ///
- /// # Panics
- ///
- /// Panics if [pos..pos+len] indexes out of bound of the underlying code buffer.
- </span><span class="kw">fn </span>emit_at(<span class="kw-2">&amp;mut </span><span class="self">self</span>, pos: usize, bytes: <span class="kw-2">&amp;</span>[u8]) {
- <span class="kw">if let </span><span class="prelude-val">Some</span>(buf) = <span class="self">self</span>.buf.get_mut(pos..pos + bytes.len()) {
- buf.copy_from_slice(bytes);
- } <span class="kw">else </span>{
- <span class="macro">unimplemented!</span>();
- }
- }
-
- <span class="doccomment">/// Bind the [Label] to the current location.
- </span><span class="kw">pub fn </span>bind(<span class="kw-2">&amp;mut </span><span class="self">self</span>, label: <span class="kw-2">&amp;mut </span>Label) {
- <span class="comment">// Bind the label to the current offset.
- </span>label.bind(<span class="self">self</span>.buf.len());
-
- <span class="comment">// Resolve any pending relocations for the label.
- </span><span class="self">self</span>.resolve(label);
- }
-
- <span class="doccomment">/// If the [Label] is bound, patch any pending relocation.
- </span><span class="kw">pub fn </span>resolve(<span class="kw-2">&amp;mut </span><span class="self">self</span>, label: <span class="kw-2">&amp;mut </span>Label) {
- <span class="kw">if let </span><span class="prelude-val">Some</span>(loc) = label.location() {
- <span class="comment">// For now we only support disp32 as label location.
- </span><span class="kw">let </span>loc = i32::try_from(loc).expect(<span class="string">&quot;Label location did not fit into i32.&quot;</span>);
-
- <span class="comment">// Resolve any pending relocations for the label.
- </span><span class="kw">for </span>off <span class="kw">in </span>label.offsets_mut().drain() {
- <span class="comment">// Displacement is relative to the next instruction following the jump.
- // We record the offset to patch at the first byte of the disp32 therefore we need
- // to account for that in the disp computation.
- </span><span class="kw">let </span>disp32 = loc - i32::try_from(off).expect(<span class="string">&quot;Label offset did not fit into i32&quot;</span>) - <span class="number">4 </span><span class="comment">/* account for the disp32 */</span>;
-
- <span class="comment">// Patch the relocation with the disp32.
- </span><span class="self">self</span>.emit_at(off, <span class="kw-2">&amp;</span>disp32.to_ne_bytes());
- }
- }
- }
-
- <span class="comment">// -- Encode utilities.
-
- </span><span class="doccomment">/// Encode an register-register instruction.
- </span><span class="kw">fn </span>encode_rr&lt;T: Reg&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, opc: u8, op1: T, op2: T)
- <span class="kw">where
- </span><span class="self">Self</span>: EncodeRR&lt;T&gt;,
- {
- <span class="comment">// MR operand encoding.
- // op1 -&gt; modrm.rm
- // op2 -&gt; modrm.reg
- </span><span class="kw">let </span>modrm = modrm(
- <span class="number">0b11</span>, <span class="comment">/* mod */
- </span>op2.idx(), <span class="comment">/* reg */
- </span>op1.idx(), <span class="comment">/* rm */
- </span>);
-
- <span class="kw">let </span>prefix = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeRR&lt;T&gt;&gt;::legacy_prefix();
- <span class="kw">let </span>rex = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeRR&lt;T&gt;&gt;::rex(op1, op2);
-
- <span class="self">self</span>.emit_optional(<span class="kw-2">&amp;</span>[prefix, rex]);
- <span class="self">self</span>.emit(<span class="kw-2">&amp;</span>[opc, modrm]);
- }
-
- <span class="doccomment">/// Encode an offset-immediate instruction.
- /// Register idx is encoded in the opcode.
- </span><span class="kw">fn </span>encode_oi&lt;T: Reg, U: Imm&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, opc: u8, op1: T, op2: U)
- <span class="kw">where
- </span><span class="self">Self</span>: EncodeR&lt;T&gt;,
- {
- <span class="kw">let </span>opc = opc + (op1.idx() &amp; <span class="number">0b111</span>);
- <span class="kw">let </span>prefix = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeR&lt;T&gt;&gt;::legacy_prefix();
- <span class="kw">let </span>rex = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeR&lt;T&gt;&gt;::rex(op1);
-
- <span class="self">self</span>.emit_optional(<span class="kw-2">&amp;</span>[prefix, rex]);
- <span class="self">self</span>.emit(<span class="kw-2">&amp;</span>[opc]);
- <span class="self">self</span>.emit(op2.bytes());
- }
-
- <span class="doccomment">/// Encode a register-immediate instruction.
- </span><span class="kw">fn </span>encode_ri&lt;T: Reg, U: Imm&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, opc: u8, opc_ext: u8, op1: T, op2: U)
- <span class="kw">where
- </span><span class="self">Self</span>: EncodeR&lt;T&gt;,
- {
- <span class="comment">// MI operand encoding.
- // op1 -&gt; modrm.rm
- // opc extension -&gt; modrm.reg
- </span><span class="kw">let </span>modrm = modrm(
- <span class="number">0b11</span>, <span class="comment">/* mod */
- </span>opc_ext, <span class="comment">/* reg */
- </span>op1.idx(), <span class="comment">/* rm */
- </span>);
-
- <span class="kw">let </span>prefix = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeR&lt;T&gt;&gt;::legacy_prefix();
- <span class="kw">let </span>rex = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeR&lt;T&gt;&gt;::rex(op1);
-
- <span class="self">self</span>.emit_optional(<span class="kw-2">&amp;</span>[prefix, rex]);
- <span class="self">self</span>.emit(<span class="kw-2">&amp;</span>[opc, modrm]);
- <span class="self">self</span>.emit(op2.bytes());
- }
-
- <span class="doccomment">/// Encode a register instruction.
- </span><span class="kw">fn </span>encode_r&lt;T: Reg&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, opc: u8, opc_ext: u8, op1: T)
- <span class="kw">where
- </span><span class="self">Self</span>: EncodeR&lt;T&gt;,
- {
- <span class="comment">// M operand encoding.
- // op1 -&gt; modrm.rm
- // opc extension -&gt; modrm.reg
- </span><span class="kw">let </span>modrm = modrm(
- <span class="number">0b11</span>, <span class="comment">/* mod */
- </span>opc_ext, <span class="comment">/* reg */
- </span>op1.idx(), <span class="comment">/* rm */
- </span>);
-
- <span class="kw">let </span>prefix = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeR&lt;T&gt;&gt;::legacy_prefix();
- <span class="kw">let </span>rex = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeR&lt;T&gt;&gt;::rex(op1);
-
- <span class="self">self</span>.emit_optional(<span class="kw-2">&amp;</span>[prefix, rex]);
- <span class="self">self</span>.emit(<span class="kw-2">&amp;</span>[opc, modrm]);
- }
-
- <span class="doccomment">/// Encode a memory-immediate instruction.
- </span><span class="kw">fn </span>encode_mi&lt;T: Imm&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, opc: u8, opc_ext: u8, op1: MemOp, op2: T)
- <span class="kw">where
- </span><span class="self">Self</span>: EncodeMI&lt;T&gt;,
- {
- <span class="comment">// MI operand encoding.
- // op1 -&gt; modrm.rm
- // op2 -&gt; imm
- </span><span class="kw">let </span>mode = <span class="kw">match </span>op1 {
- MemOp::Indirect(..) =&gt; {
- <span class="macro">assert!</span>(!op1.base().need_sib() &amp;&amp; !op1.base().is_pc_rel());
- <span class="number">0b00
- </span>}
- MemOp::IndirectDisp(..) =&gt; {
- <span class="macro">assert!</span>(!op1.base().need_sib());
- <span class="number">0b10
- </span>}
- };
-
- <span class="kw">let </span>modrm = modrm(
- mode, <span class="comment">/* mode */
- </span>opc_ext, <span class="comment">/* reg */
- </span>op1.base().idx(), <span class="comment">/* rm */
- </span>);
-
- <span class="kw">let </span>prefix = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeMI&lt;T&gt;&gt;::legacy_prefix();
- <span class="kw">let </span>rex = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeMI&lt;T&gt;&gt;::rex(<span class="kw-2">&amp;</span>op1);
-
- <span class="self">self</span>.emit_optional(<span class="kw-2">&amp;</span>[prefix, rex]);
- <span class="self">self</span>.emit(<span class="kw-2">&amp;</span>[opc, modrm]);
- <span class="kw">if let </span>MemOp::IndirectDisp(<span class="kw">_</span>, disp) = op1 {
- <span class="self">self</span>.emit(<span class="kw-2">&amp;</span>disp.to_ne_bytes());
- }
- <span class="self">self</span>.emit(op2.bytes());
- }
-
- <span class="doccomment">/// Encode a memory-register instruction.
- </span><span class="kw">fn </span>encode_mr&lt;T: Reg&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, opc: u8, op1: MemOp, op2: T)
- <span class="kw">where
- </span><span class="self">Self</span>: EncodeMR&lt;T&gt;,
- {
- <span class="comment">// MR operand encoding.
- // op1 -&gt; modrm.rm
- // op2 -&gt; modrm.reg
- </span><span class="kw">let </span>mode = <span class="kw">match </span>op1 {
- MemOp::Indirect(..) =&gt; {
- <span class="macro">assert!</span>(!op1.base().need_sib() &amp;&amp; !op1.base().is_pc_rel());
- <span class="number">0b00
- </span>}
- MemOp::IndirectDisp(..) =&gt; {
- <span class="macro">assert!</span>(!op1.base().need_sib());
- <span class="number">0b10
- </span>}
- };
-
- <span class="kw">let </span>modrm = modrm(
- mode, <span class="comment">/* mode */
- </span>op2.idx(), <span class="comment">/* reg */
- </span>op1.base().idx(), <span class="comment">/* rm */
- </span>);
- <span class="kw">let </span>prefix = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeMR&lt;T&gt;&gt;::legacy_prefix();
- <span class="kw">let </span>rex = &lt;<span class="self">Self </span><span class="kw">as </span>EncodeMR&lt;T&gt;&gt;::rex(<span class="kw-2">&amp;</span>op1, op2);
-
- <span class="self">self</span>.emit_optional(<span class="kw-2">&amp;</span>[prefix, rex]);
- <span class="self">self</span>.emit(<span class="kw-2">&amp;</span>[opc, modrm]);
- <span class="kw">if let </span>MemOp::IndirectDisp(<span class="kw">_</span>, disp) = op1 {
- <span class="self">self</span>.emit(<span class="kw-2">&amp;</span>disp.to_ne_bytes());
- }
- }
-
- <span class="doccomment">/// Encode a register-memory instruction.
- </span><span class="kw">fn </span>encode_rm&lt;T: Reg&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, opc: u8, op1: T, op2: MemOp)
- <span class="kw">where
- </span><span class="self">Self</span>: EncodeMR&lt;T&gt;,
- {
- <span class="comment">// RM operand encoding.
- // op1 -&gt; modrm.reg
- // op2 -&gt; modrm.rm
- </span><span class="self">self</span>.encode_mr(opc, op2, op1);
- }
-
- <span class="doccomment">/// Encode a jump to label instruction.
- </span><span class="kw">fn </span>encode_jmp_label(<span class="kw-2">&amp;mut </span><span class="self">self</span>, opc: <span class="kw-2">&amp;</span>[u8], op1: <span class="kw-2">&amp;mut </span>Label) {
- <span class="comment">// Emit the opcode.
- </span><span class="self">self</span>.emit(opc);
-
- <span class="comment">// Record relocation offset starting at the first byte of the disp32.
- </span>op1.record_offset(<span class="self">self</span>.buf.len());
-
- <span class="comment">// Emit a zeroed disp32, which serves as placeholder for the relocation.
- // We currently only support disp32 jump targets.
- </span><span class="self">self</span>.emit(<span class="kw-2">&amp;</span>[<span class="number">0u8</span>; <span class="number">4</span>]);
-
- <span class="comment">// Resolve any pending relocations for the label.
- </span><span class="self">self</span>.resolve(op1);
- }
-}
-
-<span class="comment">// -- Encoder helper.
-
-</span><span class="doccomment">/// Encode helper for register-register instructions.
-</span><span class="kw">trait </span>EncodeRR&lt;T: Reg&gt; {
- <span class="kw">fn </span>legacy_prefix() -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
- <span class="prelude-val">None
- </span>}
-
- <span class="kw">fn </span>rex(op1: T, op2: T) -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
- <span class="kw">if </span>op1.need_rex() || op2.need_rex() {
- <span class="prelude-val">Some</span>(rex(op1.rexw(), op2.idx(), <span class="number">0</span>, op1.idx()))
- } <span class="kw">else </span>{
- <span class="prelude-val">None
- </span>}
- }
-}
-
-<span class="kw">impl </span>EncodeRR&lt;Reg8&gt; <span class="kw">for </span>Asm {}
-<span class="kw">impl </span>EncodeRR&lt;Reg32&gt; <span class="kw">for </span>Asm {}
-<span class="kw">impl </span>EncodeRR&lt;Reg16&gt; <span class="kw">for </span>Asm {
- <span class="kw">fn </span>legacy_prefix() -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
- <span class="prelude-val">Some</span>(<span class="number">0x66</span>)
- }
-}
-<span class="kw">impl </span>EncodeRR&lt;Reg64&gt; <span class="kw">for </span>Asm {}
-
-<span class="doccomment">/// Encode helper for register instructions.
-</span><span class="kw">trait </span>EncodeR&lt;T: Reg&gt; {
- <span class="kw">fn </span>legacy_prefix() -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
- <span class="prelude-val">None
- </span>}
-
- <span class="kw">fn </span>rex(op1: T) -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
- <span class="kw">if </span>op1.need_rex() {
- <span class="prelude-val">Some</span>(rex(op1.rexw(), <span class="number">0</span>, <span class="number">0</span>, op1.idx()))
- } <span class="kw">else </span>{
- <span class="prelude-val">None
- </span>}
- }
-}
-
-<span class="kw">impl </span>EncodeR&lt;Reg8&gt; <span class="kw">for </span>Asm {}
-<span class="kw">impl </span>EncodeR&lt;Reg32&gt; <span class="kw">for </span>Asm {}
-<span class="kw">impl </span>EncodeR&lt;Reg16&gt; <span class="kw">for </span>Asm {
- <span class="kw">fn </span>legacy_prefix() -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
- <span class="prelude-val">Some</span>(<span class="number">0x66</span>)
- }
-}
-<span class="kw">impl </span>EncodeR&lt;Reg64&gt; <span class="kw">for </span>Asm {}
-
-<span class="doccomment">/// Encode helper for memory-register instructions.
-</span><span class="kw">trait </span>EncodeMR&lt;T: Reg&gt; {
- <span class="kw">fn </span>legacy_prefix() -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
- <span class="prelude-val">None
- </span>}
-
- <span class="kw">fn </span>rex(op1: <span class="kw-2">&amp;</span>MemOp, op2: T) -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
- <span class="kw">if </span>op2.need_rex() || (op1.base().is_ext()) {
- <span class="prelude-val">Some</span>(rex(op2.rexw(), op2.idx(), <span class="number">0</span>, op1.base().idx()))
- } <span class="kw">else </span>{
- <span class="prelude-val">None
- </span>}
- }
-}
-
-<span class="kw">impl </span>EncodeMR&lt;Reg8&gt; <span class="kw">for </span>Asm {}
-<span class="kw">impl </span>EncodeMR&lt;Reg16&gt; <span class="kw">for </span>Asm {
- <span class="kw">fn </span>legacy_prefix() -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
- <span class="prelude-val">Some</span>(<span class="number">0x66</span>)
- }
-}
-<span class="kw">impl </span>EncodeMR&lt;Reg32&gt; <span class="kw">for </span>Asm {}
-<span class="kw">impl </span>EncodeMR&lt;Reg64&gt; <span class="kw">for </span>Asm {}
-
-<span class="doccomment">/// Encode helper for memory-immediate instructions.
-</span><span class="kw">trait </span>EncodeMI&lt;T: Imm&gt; {
- <span class="kw">fn </span>legacy_prefix() -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
- <span class="prelude-val">None
- </span>}
-
- <span class="kw">fn </span>rex(op1: <span class="kw-2">&amp;</span>MemOp) -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
- <span class="kw">if </span>op1.base().is_ext() {
- <span class="prelude-val">Some</span>(rex(<span class="bool-val">false</span>, <span class="number">0</span>, <span class="number">0</span>, op1.base().idx()))
- } <span class="kw">else </span>{
- <span class="prelude-val">None
- </span>}
- }
-}
-
-<span class="kw">impl </span>EncodeMI&lt;Imm8&gt; <span class="kw">for </span>Asm {}
-<span class="kw">impl </span>EncodeMI&lt;Imm16&gt; <span class="kw">for </span>Asm {
- <span class="kw">fn </span>legacy_prefix() -&gt; <span class="prelude-ty">Option</span>&lt;u8&gt; {
- <span class="prelude-val">Some</span>(<span class="number">0x66</span>)
- }
-}
-<span class="kw">impl </span>EncodeMI&lt;Imm32&gt; <span class="kw">for </span>Asm {}
</code></pre></div></section></main></body></html> \ No newline at end of file
diff --git a/src/juicebox_asm/prelude.rs.html b/src/juicebox_asm/prelude.rs.html
deleted file mode 100644
index e877286..0000000
--- a/src/juicebox_asm/prelude.rs.html
+++ /dev/null
@@ -1,21 +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/prelude.rs`."><title>prelude.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-fa3bb1812debf86c.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="juicebox_asm" data-themes="" data-resource-suffix="" data-rustdoc-version="1.74.0 (79e9716c9 2023-11-13)" data-channel="1.74.0" data-search-js="search-8be46b629f5f14a8.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="../../static.files/src-script-3280b574d94e47b4.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-c5bd66d33317d69f.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><nav class="sub"><a class="sub-logo-container" href="../../juicebox_asm/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
-<a href="#2" id="2">2</a>
-<a href="#3" id="3">3</a>
-<a href="#4" id="4">4</a>
-<a href="#5" id="5">5</a>
-<a href="#6" id="6">6</a>
-<a href="#7" id="7">7</a>
-<a href="#8" id="8">8</a>
-<a href="#9" id="9">9</a>
-<a href="#10" id="10">10</a>
-</pre></div><pre class="rust"><code><span class="doccomment">//! Crate prelude, which can be used to import the most important types at once.
-
-</span><span class="kw">pub use </span><span class="kw">crate</span>::Asm;
-<span class="kw">pub use </span><span class="kw">crate</span>::MemOp;
-
-<span class="kw">pub use </span><span class="kw">crate</span>::imm::{Imm16, Imm32, Imm64, Imm8};
-<span class="kw">pub use </span><span class="kw">crate</span>::label::Label;
-<span class="kw">pub use </span><span class="kw">crate</span>::reg::{Reg16, Reg32, Reg64, Reg8};
-
-<span class="kw">pub use </span><span class="kw">crate</span>::insn::{Add, Call, Cmp, Dec, Jmp, Jnz, Jz, Mov, Test};
-</code></pre></div></section></main></body></html> \ No newline at end of file
diff --git a/src/juicebox_asm/reg.rs.html b/src/juicebox_asm/reg.rs.html
index a511005..fe4b50c 100644
--- a/src/juicebox_asm/reg.rs.html
+++ b/src/juicebox_asm/reg.rs.html
@@ -302,36 +302,6 @@
<a href="#302" id="302">302</a>
<a href="#303" id="303">303</a>
<a href="#304" id="304">304</a>
-<a href="#305" id="305">305</a>
-<a href="#306" id="306">306</a>
-<a href="#307" id="307">307</a>
-<a href="#308" id="308">308</a>
-<a href="#309" id="309">309</a>
-<a href="#310" id="310">310</a>
-<a href="#311" id="311">311</a>
-<a href="#312" id="312">312</a>
-<a href="#313" id="313">313</a>
-<a href="#314" id="314">314</a>
-<a href="#315" id="315">315</a>
-<a href="#316" id="316">316</a>
-<a href="#317" id="317">317</a>
-<a href="#318" id="318">318</a>
-<a href="#319" id="319">319</a>
-<a href="#320" id="320">320</a>
-<a href="#321" id="321">321</a>
-<a href="#322" id="322">322</a>
-<a href="#323" id="323">323</a>
-<a href="#324" id="324">324</a>
-<a href="#325" id="325">325</a>
-<a href="#326" id="326">326</a>
-<a href="#327" id="327">327</a>
-<a href="#328" id="328">328</a>
-<a href="#329" id="329">329</a>
-<a href="#330" id="330">330</a>
-<a href="#331" id="331">331</a>
-<a href="#332" id="332">332</a>
-<a href="#333" id="333">333</a>
-<a href="#334" id="334">334</a>
</pre></div><pre class="rust"><code><span class="doccomment">//! Definition of registers which are used as input operands for various instructions.
/// Trait to interact with register operands.
@@ -489,27 +459,21 @@
<span class="macro">assert_eq!</span>(r.idx(), idx);
<span class="comment">// Check REX.W bit.
- </span><span class="macro">assert_eq!</span>(r.rexw(), <span class="bool-val">false</span>);
+ </span><span class="macro">assert!</span>(!r.rexw());
<span class="comment">// Check need REX byte.
- </span><span class="kw">let </span>rex = <span class="kw">match </span>r {
- r8l | r9l | r10l | r11l | r12l | r13l | r14l | r15l | spl | bpl | sil | dil =&gt; <span class="bool-val">true</span>,
- <span class="kw">_ </span>=&gt; <span class="bool-val">false</span>,
- };
+ </span><span class="kw">let </span>rex = <span class="macro">matches!</span>(
+ r,
+ r8l | r9l | r10l | r11l | r12l | r13l | r14l | r15l | spl | bpl | sil | dil
+ );
<span class="macro">assert_eq!</span>(r.need_rex(), rex);
<span class="comment">// Check need SIB byte.
- </span><span class="kw">let </span>sib = <span class="kw">match </span>r {
- spl | r12l | ah =&gt; <span class="bool-val">true</span>,
- <span class="kw">_ </span>=&gt; <span class="bool-val">false</span>,
- };
+ </span><span class="kw">let </span>sib = <span class="macro">matches!</span>(r, spl | r12l | ah);
<span class="macro">assert_eq!</span>(r.need_sib(), sib);
<span class="comment">// Check if is PC relative addressing.
- </span><span class="kw">let </span>rel = <span class="kw">match </span>r {
- bpl | r13l | ch =&gt; <span class="bool-val">true</span>,
- <span class="kw">_ </span>=&gt; <span class="bool-val">false</span>,
- };
+ </span><span class="kw">let </span>rel = <span class="macro">matches!</span>(r, bpl | r13l | ch);
<span class="macro">assert_eq!</span>(r.is_pc_rel(), rel);
}
}
@@ -541,27 +505,18 @@
<span class="macro">assert_eq!</span>(r.idx(), idx);
<span class="comment">// Check REX.W bit.
- </span><span class="macro">assert_eq!</span>(r.rexw(), <span class="bool-val">false</span>);
+ </span><span class="macro">assert!</span>(!r.rexw());
<span class="comment">// Check need REX byte.
- </span><span class="kw">let </span>rex = <span class="kw">match </span>r {
- r8w | r9w | r10w | r11w | r12w | r13w | r14w | r15w =&gt; <span class="bool-val">true</span>,
- <span class="kw">_ </span>=&gt; <span class="bool-val">false</span>,
- };
+ </span><span class="kw">let </span>rex = <span class="macro">matches!</span>(r, r8w | r9w | r10w | r11w | r12w | r13w | r14w | r15w);
<span class="macro">assert_eq!</span>(r.need_rex(), rex);
<span class="comment">// Check need SIB byte.
- </span><span class="kw">let </span>sib = <span class="kw">match </span>r {
- sp | r12w =&gt; <span class="bool-val">true</span>,
- <span class="kw">_ </span>=&gt; <span class="bool-val">false</span>,
- };
+ </span><span class="kw">let </span>sib = <span class="macro">matches!</span>(r, sp | r12w);
<span class="macro">assert_eq!</span>(r.need_sib(), sib);
<span class="comment">// Check if is PC relative addressing.
- </span><span class="kw">let </span>rel = <span class="kw">match </span>r {
- bp | r13w =&gt; <span class="bool-val">true</span>,
- <span class="kw">_ </span>=&gt; <span class="bool-val">false</span>,
- };
+ </span><span class="kw">let </span>rel = <span class="macro">matches!</span>(r, bp | r13w);
<span class="macro">assert_eq!</span>(r.is_pc_rel(), rel);
}
}
@@ -593,27 +548,18 @@
<span class="macro">assert_eq!</span>(r.idx(), idx);
<span class="comment">// Check REX.W bit.
- </span><span class="macro">assert_eq!</span>(r.rexw(), <span class="bool-val">false</span>);
+ </span><span class="macro">assert!</span>(!r.rexw());
<span class="comment">// Check need REX byte.
- </span><span class="kw">let </span>rex = <span class="kw">match </span>r {
- r8d | r9d | r10d | r11d | r12d | r13d | r14d | r15d =&gt; <span class="bool-val">true</span>,
- <span class="kw">_ </span>=&gt; <span class="bool-val">false</span>,
- };
+ </span><span class="kw">let </span>rex = <span class="macro">matches!</span>(r, r8d | r9d | r10d | r11d | r12d | r13d | r14d | r15d);
<span class="macro">assert_eq!</span>(r.need_rex(), rex);
<span class="comment">// Check need SIB byte.
- </span><span class="kw">let </span>sib = <span class="kw">match </span>r {
- esp | r12d =&gt; <span class="bool-val">true</span>,
- <span class="kw">_ </span>=&gt; <span class="bool-val">false</span>,
- };
+ </span><span class="kw">let </span>sib = <span class="macro">matches!</span>(r, esp | r12d);
<span class="macro">assert_eq!</span>(r.need_sib(), sib);
<span class="comment">// Check if is PC relative addressing.
- </span><span class="kw">let </span>rel = <span class="kw">match </span>r {
- ebp | r13d =&gt; <span class="bool-val">true</span>,
- <span class="kw">_ </span>=&gt; <span class="bool-val">false</span>,
- };
+ </span><span class="kw">let </span>rel = <span class="macro">matches!</span>(r, ebp | r13d);
<span class="macro">assert_eq!</span>(r.is_pc_rel(), rel);
}
}
@@ -645,23 +591,17 @@
<span class="macro">assert_eq!</span>(r.idx(), idx);
<span class="comment">// Check REX.W bit.
- </span><span class="macro">assert_eq!</span>(r.rexw(), <span class="bool-val">true</span>);
+ </span><span class="macro">assert!</span>(r.rexw());
<span class="comment">// Check need REX byte.
- </span><span class="macro">assert_eq!</span>(r.need_rex(), <span class="bool-val">true</span>);
+ </span><span class="macro">assert!</span>(r.need_rex());
<span class="comment">// Check need SIB byte.
- </span><span class="kw">let </span>sib = <span class="kw">match </span>r {
- rsp | r12 =&gt; <span class="bool-val">true</span>,
- <span class="kw">_ </span>=&gt; <span class="bool-val">false</span>,
- };
+ </span><span class="kw">let </span>sib = <span class="macro">matches!</span>(r, rsp | r12);
<span class="macro">assert_eq!</span>(r.need_sib(), sib);
<span class="comment">// Check if is PC relative addressing.
- </span><span class="kw">let </span>rel = <span class="kw">match </span>r {
- rbp | r13 =&gt; <span class="bool-val">true</span>,
- <span class="kw">_ </span>=&gt; <span class="bool-val">false</span>,
- };
+ </span><span class="kw">let </span>rel = <span class="macro">matches!</span>(r, rbp | r13);
<span class="macro">assert_eq!</span>(r.is_pc_rel(), rel);
}
}
diff --git a/src/juicebox_asm/rt.rs.html b/src/juicebox_asm/rt.rs.html
index 244be8b..efc55d3 100644
--- a/src/juicebox_asm/rt.rs.html
+++ b/src/juicebox_asm/rt.rs.html
@@ -86,10 +86,129 @@
<a href="#86" id="86">86</a>
<a href="#87" id="87">87</a>
<a href="#88" id="88">88</a>
-</pre></div><pre class="rust"><code><span class="doccomment">//! A simple runtime which can be used to execute emitted instructions.
+<a href="#89" id="89">89</a>
+<a href="#90" id="90">90</a>
+<a href="#91" id="91">91</a>
+<a href="#92" id="92">92</a>
+<a href="#93" id="93">93</a>
+<a href="#94" id="94">94</a>
+<a href="#95" id="95">95</a>
+<a href="#96" id="96">96</a>
+<a href="#97" id="97">97</a>
+<a href="#98" id="98">98</a>
+<a href="#99" id="99">99</a>
+<a href="#100" id="100">100</a>
+<a href="#101" id="101">101</a>
+<a href="#102" id="102">102</a>
+<a href="#103" id="103">103</a>
+<a href="#104" id="104">104</a>
+<a href="#105" id="105">105</a>
+<a href="#106" id="106">106</a>
+<a href="#107" id="107">107</a>
+<a href="#108" id="108">108</a>
+<a href="#109" id="109">109</a>
+<a href="#110" id="110">110</a>
+<a href="#111" id="111">111</a>
+<a href="#112" id="112">112</a>
+<a href="#113" id="113">113</a>
+<a href="#114" id="114">114</a>
+<a href="#115" id="115">115</a>
+<a href="#116" id="116">116</a>
+<a href="#117" id="117">117</a>
+<a href="#118" id="118">118</a>
+<a href="#119" id="119">119</a>
+<a href="#120" id="120">120</a>
+<a href="#121" id="121">121</a>
+<a href="#122" id="122">122</a>
+<a href="#123" id="123">123</a>
+<a href="#124" id="124">124</a>
+<a href="#125" id="125">125</a>
+<a href="#126" id="126">126</a>
+<a href="#127" id="127">127</a>
+<a href="#128" id="128">128</a>
+<a href="#129" id="129">129</a>
+<a href="#130" id="130">130</a>
+<a href="#131" id="131">131</a>
+<a href="#132" id="132">132</a>
+<a href="#133" id="133">133</a>
+<a href="#134" id="134">134</a>
+<a href="#135" id="135">135</a>
+<a href="#136" id="136">136</a>
+<a href="#137" id="137">137</a>
+<a href="#138" id="138">138</a>
+<a href="#139" id="139">139</a>
+<a href="#140" id="140">140</a>
+<a href="#141" id="141">141</a>
+<a href="#142" id="142">142</a>
+<a href="#143" id="143">143</a>
+<a href="#144" id="144">144</a>
+<a href="#145" id="145">145</a>
+<a href="#146" id="146">146</a>
+<a href="#147" id="147">147</a>
+<a href="#148" id="148">148</a>
+<a href="#149" id="149">149</a>
+<a href="#150" id="150">150</a>
+<a href="#151" id="151">151</a>
+<a href="#152" id="152">152</a>
+<a href="#153" id="153">153</a>
+<a href="#154" id="154">154</a>
+<a href="#155" id="155">155</a>
+<a href="#156" id="156">156</a>
+<a href="#157" id="157">157</a>
+<a href="#158" id="158">158</a>
+<a href="#159" id="159">159</a>
+<a href="#160" id="160">160</a>
+<a href="#161" id="161">161</a>
+<a href="#162" id="162">162</a>
+<a href="#163" id="163">163</a>
+<a href="#164" id="164">164</a>
+<a href="#165" id="165">165</a>
+<a href="#166" id="166">166</a>
+<a href="#167" id="167">167</a>
+<a href="#168" id="168">168</a>
+<a href="#169" id="169">169</a>
+<a href="#170" id="170">170</a>
+<a href="#171" id="171">171</a>
+<a href="#172" id="172">172</a>
+<a href="#173" id="173">173</a>
+<a href="#174" id="174">174</a>
+<a href="#175" id="175">175</a>
+<a href="#176" id="176">176</a>
+<a href="#177" id="177">177</a>
+<a href="#178" id="178">178</a>
+<a href="#179" id="179">179</a>
+<a href="#180" id="180">180</a>
+<a href="#181" id="181">181</a>
+<a href="#182" id="182">182</a>
+<a href="#183" id="183">183</a>
+<a href="#184" id="184">184</a>
+<a href="#185" id="185">185</a>
+<a href="#186" id="186">186</a>
+<a href="#187" id="187">187</a>
+<a href="#188" id="188">188</a>
+<a href="#189" id="189">189</a>
+<a href="#190" id="190">190</a>
+<a href="#191" id="191">191</a>
+<a href="#192" id="192">192</a>
+<a href="#193" id="193">193</a>
+<a href="#194" id="194">194</a>
+<a href="#195" id="195">195</a>
+<a href="#196" id="196">196</a>
+<a href="#197" id="197">197</a>
+<a href="#198" id="198">198</a>
+<a href="#199" id="199">199</a>
+<a href="#200" id="200">200</a>
+<a href="#201" id="201">201</a>
+<a href="#202" id="202">202</a>
+</pre></div><pre class="rust"><code><span class="doccomment">//! Simple `mmap`ed runtime.
+//!
+//! This runtime supports adding code to executable pages and turn the added code into user
+//! specified function pointer.
-</span><span class="kw">use </span>core::slice;
-<span class="kw">use </span>nix::sys::mman::{mmap, mprotect, munmap, MapFlags, ProtFlags};
+</span><span class="kw">use </span>nix::sys::mman::{mmap, mprotect, munmap, MapFlags, ProtFlags};
+
+<span class="attr">#[cfg(not(target_os = <span class="string">&quot;linux&quot;</span>))]
+</span><span class="macro">compile_error!</span>(<span class="string">&quot;This runtime is only supported on linux&quot;</span>);
<span class="doccomment">/// A simple `mmap`ed runtime with executable pages.
</span><span class="kw">pub struct </span>Runtime {
@@ -100,19 +219,23 @@
<span class="kw">impl </span>Runtime {
<span class="doccomment">/// Create a new [Runtime].
+ ///
+ /// # Panics
+ ///
+ /// Panics if the `mmap` call fails.
</span><span class="kw">pub fn </span>new() -&gt; Runtime {
<span class="comment">// Allocate a single page.
- </span><span class="kw">let </span>len = core::num::NonZeroUsize::new(<span class="number">4096</span>).unwrap();
+ </span><span class="kw">let </span>len = core::num::NonZeroUsize::new(<span class="number">4096</span>).expect(<span class="string">&quot;Value is non zero&quot;</span>);
<span class="kw">let </span>buf = <span class="kw">unsafe </span>{
mmap(
<span class="prelude-val">None</span>,
len,
- ProtFlags::PROT_WRITE | ProtFlags::PROT_READ | ProtFlags::PROT_EXEC,
+ ProtFlags::PROT_NONE,
MapFlags::MAP_PRIVATE | MapFlags::MAP_ANONYMOUS,
<span class="number">0</span>, <span class="comment">/* fd */
</span><span class="number">0</span>, <span class="comment">/* off */
</span>)
- .unwrap() <span class="kw">as </span><span class="kw-2">*mut </span>u8
+ .expect(<span class="string">&quot;Failed to mmap runtime code page&quot;</span>) <span class="kw">as </span><span class="kw-2">*mut </span>u8
};
Runtime {
@@ -122,55 +245,160 @@
}
}
- <span class="doccomment">/// Write protect the underlying code page(s).
- </span><span class="kw">pub fn </span>protect(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
- <span class="kw">unsafe </span>{
- <span class="comment">// Remove write permissions from code buffer and allow to read-execute from it.
- </span>mprotect(
- <span class="self">self</span>.buf.cast(),
- <span class="self">self</span>.len,
- ProtFlags::PROT_READ | ProtFlags::PROT_EXEC,
- )
- .expect(<span class="string">&quot;Failed to RX mprotect Runtime code buffer&quot;</span>);
- }
- }
-
- <span class="doccomment">/// Add block of code to the runtime and get function pointer back.
+ <span class="doccomment">/// Add the block of `code` to the runtime and a get function pointer of type `F`.
+ ///
+ /// # Panics
+ ///
+ /// Panics if the `code` does not fit on the `mmap`ed pages or is empty.
+ ///
+ /// # Safety
+ ///
+ /// The code added must fulfill the ABI of the specified function `F` and the returned function
+ /// pointer is only valid until the [`Runtime`] is dropped.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// let mut rt = juicebox_asm::Runtime::new();
+ ///
+ /// let code = [ 0x90 /* nop */, 0xc3 /* ret */ ];
+ /// let nop = unsafe { rt.add_code::&lt;extern &quot;C&quot; fn()&gt;(&amp;code) };
+ ///
+ /// nop();
+ /// ```
</span><span class="kw">pub unsafe fn </span>add_code&lt;F&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, code: <span class="kw">impl </span>AsRef&lt;[u8]&gt;) -&gt; F {
<span class="comment">// Get pointer to start of next free byte.
- </span><span class="macro">assert!</span>(<span class="self">self</span>.idx &lt; <span class="self">self</span>.len);
+ </span><span class="macro">assert!</span>(<span class="self">self</span>.idx &lt; <span class="self">self</span>.len, <span class="string">&quot;Runtime code page full&quot;</span>);
<span class="kw">let </span>fn_start = <span class="self">self</span>.buf.add(<span class="self">self</span>.idx);
<span class="comment">// Copy over code.
</span><span class="kw">let </span>code = code.as_ref();
- <span class="macro">assert!</span>(code.len() &lt; (<span class="self">self</span>.len - <span class="self">self</span>.idx));
+ <span class="macro">assert!</span>(!code.is_empty(), <span class="string">&quot;Adding empty code not supported&quot;</span>);
+ <span class="macro">assert!</span>(
+ code.len() &lt;= (<span class="self">self</span>.len - <span class="self">self</span>.idx),
+ <span class="string">&quot;Code does not fit on the runtime code page&quot;
+ </span>);
+ <span class="self">self</span>.unprotect();
<span class="kw">unsafe </span>{ std::ptr::copy_nonoverlapping(code.as_ptr(), fn_start, code.len()) };
+ <span class="self">self</span>.protect();
<span class="comment">// Increment index to next free byte.
</span><span class="self">self</span>.idx += code.len();
<span class="comment">// Return function to newly added code.
- </span><span class="self">Self</span>::as_fn::&lt;F&gt;(fn_start)
+ </span><span class="kw">unsafe </span>{ <span class="self">Self</span>::as_fn::&lt;F&gt;(fn_start) }
}
- <span class="doccomment">/// Reinterpret the block of code as `F`.
+ <span class="doccomment">/// Dump the code added so far to the runtime into a file called `jit.asm` in the processes
+ /// current working directory.
+ ///
+ /// The code can be inspected with a disassembler as for example `ndiasm` from
+ /// [nasm.us](https://nasm.us/index.php).
+ /// ```sh
+ /// ndisasm -b 64 jit.asm
+ /// ```
+ ///
+ /// # Panics
+ ///
+ /// Panics if writing the file failed.
+ </span><span class="kw">pub fn </span>dump(<span class="kw-2">&amp;</span><span class="self">self</span>) {
+ <span class="macro">assert!</span>(<span class="self">self</span>.idx &lt;= <span class="self">self</span>.len);
+ <span class="kw">let </span>code = <span class="kw">unsafe </span>{ core::slice::from_raw_parts(<span class="self">self</span>.buf, <span class="self">self</span>.idx) };
+ std::fs::write(<span class="string">&quot;jit.asm&quot;</span>, code).expect(<span class="string">&quot;Failed to write file&quot;</span>);
+ }
+
+ <span class="doccomment">/// Reinterpret the block of code pointed to by `fn_start` as `F`.
</span><span class="attr">#[inline]
</span><span class="kw">unsafe fn </span>as_fn&lt;F&gt;(fn_start: <span class="kw-2">*mut </span>u8) -&gt; F {
<span class="kw">unsafe </span>{ std::mem::transmute_copy(<span class="kw-2">&amp;</span>fn_start) }
}
- <span class="doccomment">/// Dump the currently added code to a file called `jit.asm`. The disassembly can be inspected
- /// as `ndisasm -b 64 jit.asm`.
- </span><span class="kw">pub fn </span>dump(<span class="kw-2">&amp;</span><span class="self">self</span>) {
- <span class="kw">let </span>code = <span class="kw">unsafe </span>{ slice::from_raw_parts(<span class="self">self</span>.buf, <span class="self">self</span>.idx) };
- std::fs::write(<span class="string">&quot;jit.asm&quot;</span>, code).unwrap();
+ <span class="doccomment">/// Add write protection the underlying code page(s).
+ ///
+ /// # Panics
+ ///
+ /// Panics if the `mprotect` call fails.
+ </span><span class="kw">fn </span>protect(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
+ <span class="kw">unsafe </span>{
+ <span class="comment">// Remove write permissions from code page and allow to read-execute from it.
+ </span>mprotect(
+ <span class="self">self</span>.buf.cast(),
+ <span class="self">self</span>.len,
+ ProtFlags::PROT_READ | ProtFlags::PROT_EXEC,
+ )
+ .expect(<span class="string">&quot;Failed to RX mprotect runtime code page&quot;</span>);
+ }
+ }
+
+ <span class="doccomment">/// Remove write protection the underlying code page(s).
+ ///
+ /// # Panics
+ ///
+ /// Panics if the `mprotect` call fails.
+ </span><span class="kw">fn </span>unprotect(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
+ <span class="kw">unsafe </span>{
+ <span class="comment">// Add write permissions to code page.
+ </span>mprotect(<span class="self">self</span>.buf.cast(), <span class="self">self</span>.len, ProtFlags::PROT_WRITE)
+ .expect(<span class="string">&quot;Failed to W mprotect runtime code page&quot;</span>);
+ }
}
}
<span class="kw">impl </span>Drop <span class="kw">for </span>Runtime {
- <span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
+ <span class="doccomment">/// Unmaps the code page. This invalidates all the function pointer returned by
+ /// [`Runtime::add_code`].
+ </span><span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
+ <span class="kw">unsafe </span>{
+ munmap(<span class="self">self</span>.buf.cast(), <span class="self">self</span>.len).expect(<span class="string">&quot;Failed to munmap runtime&quot;</span>);
+ }
+ }
+}
+
+<span class="attr">#[cfg(test)]
+</span><span class="kw">mod </span>test {
+ <span class="kw">use super</span>::<span class="kw-2">*</span>;
+
+ <span class="attr">#[test]
+ </span><span class="kw">fn </span>test_code_max_size() {
+ <span class="kw">let </span><span class="kw-2">mut </span>rt = Runtime::new();
+ <span class="kw">let </span>code = [<span class="number">0u8</span>; <span class="number">4096</span>];
+ <span class="kw">unsafe </span>{
+ rt.add_code::&lt;<span class="kw">extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn</span>()&gt;(code);
+ }
+ }
+
+ <span class="attr">#[test]
+ #[should_panic]
+ </span><span class="kw">fn </span>test_code_max_size_plus_1() {
+ <span class="kw">let </span><span class="kw-2">mut </span>rt = Runtime::new();
+ <span class="kw">let </span>code = [<span class="number">0u8</span>; <span class="number">4097</span>];
+ <span class="kw">unsafe </span>{
+ rt.add_code::&lt;<span class="kw">extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn</span>()&gt;(code);
+ }
+ }
+
+ <span class="attr">#[test]
+ #[should_panic]
+ </span><span class="kw">fn </span>test_code_max_size_plus_1_2() {
+ <span class="kw">let </span><span class="kw-2">mut </span>rt = Runtime::new();
+ <span class="kw">let </span>code = [<span class="number">0u8</span>; <span class="number">4096</span>];
+ <span class="kw">unsafe </span>{
+ rt.add_code::&lt;<span class="kw">extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn</span>()&gt;(code);
+ }
+
+ <span class="kw">let </span>code = [<span class="number">0u8</span>; <span class="number">1</span>];
+ <span class="kw">unsafe </span>{
+ rt.add_code::&lt;<span class="kw">extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn</span>()&gt;(code);
+ }
+ }
+
+ <span class="attr">#[test]
+ #[should_panic]
+ </span><span class="kw">fn </span>test_empty_code() {
+ <span class="kw">let </span><span class="kw-2">mut </span>rt = Runtime::new();
+ <span class="kw">let </span>code = [<span class="number">0u8</span>; <span class="number">0</span>];
<span class="kw">unsafe </span>{
- munmap(<span class="self">self</span>.buf.cast(), <span class="self">self</span>.len).expect(<span class="string">&quot;Failed to munmap Runtime&quot;</span>);
+ rt.add_code::&lt;<span class="kw">extern </span><span class="string">&quot;C&quot; </span><span class="kw">fn</span>()&gt;(code);
}
}
}
diff --git a/src/tiny_vm/tiny_vm.rs.html b/src/tiny_vm/tiny_vm.rs.html
index b986ed6..7de10c9 100644
--- a/src/tiny_vm/tiny_vm.rs.html
+++ b/src/tiny_vm/tiny_vm.rs.html
@@ -695,6 +695,7 @@
<a href="#695" id="695">695</a>
<a href="#696" id="696">696</a>
<a href="#697" id="697">697</a>
+<a href="#698" id="698">698</a>
</pre></div><pre class="rust"><code><span class="doccomment">//! TinyVm example.
//!
//! This example introduces as simple 16 bit virtual machine the [`TinyVm`]. The VM consits of
@@ -736,8 +737,9 @@
</span><span class="attr">#[cfg(not(any(target_arch = <span class="string">&quot;x86_64&quot;</span>, target_os = <span class="string">&quot;linux&quot;</span>)))]
</span><span class="macro">compile_error!</span>(<span class="string">&quot;Only supported on x86_64 with SystemV abi&quot;</span>);
-<span class="kw">use </span>juicebox_asm::prelude::<span class="kw-2">*</span>;
+<span class="kw">use </span>juicebox_asm::insn::<span class="kw-2">*</span>;
<span class="kw">use </span>juicebox_asm::Runtime;
+<span class="kw">use </span>juicebox_asm::{Asm, Imm16, Imm64, Label, MemOp, Reg16, Reg64};
<span class="doccomment">/// A guest physical address.
</span><span class="kw">pub struct </span>PhysAddr(<span class="kw">pub </span>u16);