aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/juicebox_asm/rt.rs.html
blob: 244be8bfd85b7c2d94b1868009338252f5821062 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
<!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/rt.rs`."><title>rt.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>
</pre></div><pre class="rust"><code><span class="doccomment">//! A simple runtime which can be used to execute emitted instructions.

</span><span class="kw">use </span>core::slice;
<span class="kw">use </span>nix::sys::mman::{mmap, mprotect, munmap, MapFlags, ProtFlags};

<span class="doccomment">/// A simple `mmap`ed runtime with executable pages.
</span><span class="kw">pub struct </span>Runtime {
    buf: <span class="kw-2">*mut </span>u8,
    len: usize,
    idx: usize,
}

<span class="kw">impl </span>Runtime {
    <span class="doccomment">/// Create a new [Runtime].
    </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 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,
                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
        };

        Runtime {
            buf,
            len: len.get(),
            idx: <span class="number">0</span>,
        }
    }

    <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><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 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="kw">unsafe </span>{ std::ptr::copy_nonoverlapping(code.as_ptr(), fn_start, code.len()) };

        <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 class="doccomment">/// Reinterpret the block of code 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="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="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>);
        }
    }
}
</code></pre></div></section></main></body></html>