diff options
| author | johannst <johannst@users.noreply.github.com> | 2023-03-05 20:47:28 +0000 |
|---|---|---|
| committer | johannst <johannst@users.noreply.github.com> | 2023-03-05 20:47:28 +0000 |
| commit | 865c1d3231fd57c648121d961be91793d0bfe690 (patch) | |
| tree | a9dc81103d1e9d38b6a7ffe1f728d5f0e4959610 /juicebox_asm/index.html | |
| parent | 872cf6d06f4d77637b4627fdc583bab79ee2372f (diff) | |
| download | juicebox-asm-865c1d3231fd57c648121d961be91793d0bfe690.tar.gz juicebox-asm-865c1d3231fd57c648121d961be91793d0bfe690.zip | |
deploy: 1ea7de2ba46b58b4afe3e65b95d8a45160218a5c
Diffstat (limited to 'juicebox_asm/index.html')
| -rw-r--r-- | juicebox_asm/index.html | 73 |
1 files changed, 72 insertions, 1 deletions
diff --git a/juicebox_asm/index.html b/juicebox_asm/index.html index a58f940..226978d 100644 --- a/juicebox_asm/index.html +++ b/juicebox_asm/index.html @@ -1 +1,72 @@ -<!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="API documentation for the Rust `juicebox_asm` crate."><meta name="keywords" content="rust, rustlang, rust-lang, juicebox_asm"><title>juicebox_asm - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-1f7d512b176f0f72.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-124a1ca42af929b6.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-6827029ac823cab7.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../static.files/light-ebce58d0a40c3431.css"><link rel="stylesheet" disabled href="../static.files/dark-f23faae4a2daf9a6.css"><link rel="stylesheet" disabled href="../static.files/ayu-8af5e100b21cd173.css"><script id="default-settings" ></script><script src="../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-c55e1eb52e1886b4.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-13285aec31fa243e.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 mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../juicebox_asm/index.html"><div class="logo-container"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../juicebox_asm/index.html"><div class="logo-container"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate juicebox_asm</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.1.0</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><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-5ec35bf9ca753509.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">juicebox_asm</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/juicebox_asm/lib.rs.html#1-304">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="prelude/index.html" title="juicebox_asm::prelude mod">prelude</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="rt/index.html" title="juicebox_asm::rt mod">rt</a></div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Asm.html" title="juicebox_asm::Asm struct">Asm</a></div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.MemOp.html" title="juicebox_asm::MemOp enum">MemOp</a></div></div></div></section></div></main><div id="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.67.1 (d5a82bbd2 2023-02-07)" data-search-js="search-444266647c4dba98.js" data-settings-js="settings-bebeae96e00e4617.js" data-settings-css="settings-af96d9e2fc13e081.css" ></div></body></html>
\ No newline at end of file +<!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="A simple `x64` jit assembler with a minimal runtime to execute emitted code for fun."><meta name="keywords" content="rust, rustlang, rust-lang, juicebox_asm"><title>juicebox_asm - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-1f7d512b176f0f72.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-124a1ca42af929b6.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-6827029ac823cab7.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../static.files/light-ebce58d0a40c3431.css"><link rel="stylesheet" disabled href="../static.files/dark-f23faae4a2daf9a6.css"><link rel="stylesheet" disabled href="../static.files/ayu-8af5e100b21cd173.css"><script id="default-settings" ></script><script src="../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-c55e1eb52e1886b4.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-13285aec31fa243e.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 mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../juicebox_asm/index.html"><div class="logo-container"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../juicebox_asm/index.html"><div class="logo-container"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate juicebox_asm</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.1.0</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><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-5ec35bf9ca753509.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">juicebox_asm</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/juicebox_asm/lib.rs.html#1-410">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A simple <code>x64</code> jit assembler with a minimal runtime to execute emitted code for fun.</p> +<p>The following is an fibonacci example implementation.</p> + +<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>juicebox_asm::prelude::<span class="kw-2">*</span>; +<span class="kw">use </span>juicebox_asm::Runtime; + +<span class="kw">const fn </span>fib_rs(n: u64) -> u64 { + <span class="kw">match </span>n { + <span class="number">0 </span>=> <span class="number">0</span>, + <span class="number">1 </span>=> <span class="number">1</span>, + <span class="kw">_ </span>=> fib_rs(n - <span class="number">2</span>) + fib_rs(n - <span class="number">1</span>), + } +} + +<span class="kw">fn </span>main() { + <span class="kw">let </span><span class="kw-2">mut </span>asm = Asm::new(); + + <span class="kw">let </span><span class="kw-2">mut </span>lp = Label::new(); + <span class="kw">let </span><span class="kw-2">mut </span>end = Label::new(); + + <span class="comment">// Reference implementation: + // + // int fib(int n) { + // int tmp = 0; + // int prv = 1; + // int sum = 0; + // loop: + // if (n == 0) goto end; + // tmp = sum; + // sum += prv; + // prv = tmp; + // --n; + // goto loop; + // end: + // return sum; + // } + + // SystemV abi: + // rdi -> first argument + // rax -> return value + </span><span class="kw">let </span>n = Reg64::rdi; + <span class="kw">let </span>sum = Reg64::rax; + + <span class="kw">let </span>tmp = Reg64::rcx; + <span class="kw">let </span>prv = Reg64::rbx; + + asm.mov(tmp, Imm64::from(<span class="number">0</span>)); + asm.mov(prv, Imm64::from(<span class="number">1</span>)); + asm.mov(sum, Imm64::from(<span class="number">0</span>)); + + asm.bind(<span class="kw-2">&mut </span>lp); + asm.test(n, n); + asm.jz(<span class="kw-2">&mut </span>end); + asm.mov(tmp, sum); + asm.add(sum, prv); + asm.mov(prv, tmp); + asm.dec(n); + asm.jmp(<span class="kw-2">&mut </span>lp); + asm.bind(<span class="kw-2">&mut </span>end); + asm.ret(); + + <span class="comment">// Move code into executable page and get function pointer to it. + </span><span class="kw">let </span>rt = Runtime::new(<span class="kw-2">&</span>asm.into_code()); + <span class="kw">let </span>fib = <span class="kw">unsafe </span>{ rt.as_fn::<<span class="kw">extern </span><span class="string">"C" </span><span class="kw">fn</span>(u64) -> u64>() }; + + <span class="kw">for </span>n <span class="kw">in </span><span class="number">0</span>..<span class="number">15 </span>{ + <span class="kw">let </span>fib_jit = fib(n); + <span class="macro">println!</span>(<span class="string">"fib({}) = {}"</span>, n, fib_jit); + <span class="macro">assert_eq!</span>(fib_jit, fib_rs(n)); + } +}</code></pre></div> +</div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="prelude/index.html" title="juicebox_asm::prelude mod">prelude</a></div><div class="item-right docblock-short">Crate prelude, which can be used to import the most important types at once.</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Asm.html" title="juicebox_asm::Asm struct">Asm</a></div><div class="item-right docblock-short"><code>x64</code> jit assembler.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Imm8.html" title="juicebox_asm::Imm8 struct">Imm8</a></div><div class="item-right docblock-short">Type representing an 8 bit immediate.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Imm16.html" title="juicebox_asm::Imm16 struct">Imm16</a></div><div class="item-right docblock-short">Type representing a 16 bit immediate.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Imm32.html" title="juicebox_asm::Imm32 struct">Imm32</a></div><div class="item-right docblock-short">Type representing a 32 bit immediate.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Imm64.html" title="juicebox_asm::Imm64 struct">Imm64</a></div><div class="item-right docblock-short">Type representing a 64 bit immediate.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Label.html" title="juicebox_asm::Label struct">Label</a></div><div class="item-right docblock-short">A label which is used as target for jump instructions.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Runtime.html" title="juicebox_asm::Runtime struct">Runtime</a></div><div class="item-right docblock-short">A simple <code>mmap</code>ed runtime with executable pages.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.MemOp.html" title="juicebox_asm::MemOp enum">MemOp</a></div><div class="item-right docblock-short">Type representing a memory operand.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Reg8.html" title="juicebox_asm::Reg8 enum">Reg8</a></div><div class="item-right docblock-short">Definition of 8 bit registers.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Reg16.html" title="juicebox_asm::Reg16 enum">Reg16</a></div><div class="item-right docblock-short">Definition of 16 bit registers.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Reg32.html" title="juicebox_asm::Reg32 enum">Reg32</a></div><div class="item-right docblock-short">Definition of 32 bit registers.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Reg64.html" title="juicebox_asm::Reg64 enum">Reg64</a></div><div class="item-right docblock-short">Definition of 64 bit registers.</div></div></div></section></div></main><div id="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.67.1 (d5a82bbd2 2023-02-07)" data-search-js="search-444266647c4dba98.js" data-settings-js="settings-bebeae96e00e4617.js" data-settings-css="settings-af96d9e2fc13e081.css" ></div></body></html>
\ No newline at end of file |