diff options
Diffstat (limited to 'src/juicebox_asm/rt.rs.html')
| -rw-r--r-- | src/juicebox_asm/rt.rs.html | 98 |
1 files changed, 78 insertions, 20 deletions
diff --git a/src/juicebox_asm/rt.rs.html b/src/juicebox_asm/rt.rs.html index 46597b0..244be8b 100644 --- a/src/juicebox_asm/rt.rs.html +++ b/src/juicebox_asm/rt.rs.html @@ -1,4 +1,4 @@ -<!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-cb6f1f67f1bcd037.css" id="mainThemeStyle"><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.73.0 (cc66ad468 2023-10-03)" data-channel="1.73.0" data-search-js="search-6dfdfced5eff6596.js" data-settings-js="settings-de11bff964e9d4e5.js" data-settings-css="settings-8c76f75bfb6bd192.css" data-theme-light-css="light-1596385f77d47ef2.css" data-theme-dark-css="dark-0a43001d3fc2282c.css" data-theme-ayu-css="ayu-fd19013d6ce078bf.css" ><script src="../../static.files/storage-db41da1a38ea3cb8.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-0795b7d26be81095.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../../static.files/light-1596385f77d47ef2.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../../static.files/dark-0a43001d3fc2282c.css"><link rel="stylesheet" href="../../static.files/noscript-cffde32267a19fd6.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> +<!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> @@ -57,62 +57,120 @@ <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::ffi::c_void; +</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>c_void, + 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(code: <span class="kw">impl </span>AsRef<[u8]>) -> Runtime { + </span><span class="kw">pub fn </span>new() -> 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_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() + .unwrap() <span class="kw">as </span><span class="kw-2">*mut </span>u8 }; - { - <span class="comment">// Copy over code. - </span><span class="kw">let </span>code = code.as_ref(); - <span class="macro">assert!</span>(code.len() < len.get()); - <span class="kw">unsafe </span>{ std::ptr::copy_nonoverlapping(code.as_ptr(), buf.cast(), len.get()) }; - } - <span class="kw">unsafe </span>{ - <span class="comment">// Remove write permissions from code buffer and allow to read-execute from it. - </span>mprotect(buf, len.get(), ProtFlags::PROT_READ | ProtFlags::PROT_EXEC) - .expect(<span class="string">"Failed to RX mprotect Runtime code buffer"</span>); - } 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">&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">"Failed to RX mprotect Runtime code buffer"</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<F>(<span class="kw-2">&mut </span><span class="self">self</span>, code: <span class="kw">impl </span>AsRef<[u8]>) -> F { + <span class="comment">// Get pointer to start of next free byte. + </span><span class="macro">assert!</span>(<span class="self">self</span>.idx < <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() < (<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::<F>(fn_start) + } + <span class="doccomment">/// Reinterpret the block of code as `F`. </span><span class="attr">#[inline] - </span><span class="kw">pub unsafe fn </span>as_fn<F>(<span class="kw-2">&</span><span class="self">self</span>) -> F { - <span class="kw">unsafe </span>{ std::mem::transmute_copy(<span class="kw-2">&</span><span class="self">self</span>.buf) } + </span><span class="kw">unsafe fn </span>as_fn<F>(fn_start: <span class="kw-2">*mut </span>u8) -> F { + <span class="kw">unsafe </span>{ std::mem::transmute_copy(<span class="kw-2">&</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">&</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">"jit.asm"</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">&mut </span><span class="self">self</span>) { <span class="kw">unsafe </span>{ - munmap(<span class="self">self</span>.buf, <span class="self">self</span>.len).expect(<span class="string">"Failed to munmap Runtime"</span>); + munmap(<span class="self">self</span>.buf.cast(), <span class="self">self</span>.len).expect(<span class="string">"Failed to munmap Runtime"</span>); } } } |