diff options
Diffstat (limited to 'tiny_vm/index.html')
| -rw-r--r-- | tiny_vm/index.html | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/tiny_vm/index.html b/tiny_vm/index.html new file mode 100644 index 0000000..38f37bd --- /dev/null +++ b/tiny_vm/index.html @@ -0,0 +1,34 @@ +<!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="TinyVm example."><title>tiny_vm - Rust</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="tiny_vm" 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="../crates.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 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="logo-container" href="../tiny_vm/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a></nav><nav class="sidebar"><a class="logo-container" href="../tiny_vm/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Crate tiny_vm</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="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</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-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">tiny_vm</a><button id="copy-path" 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="src" href="../src/tiny_vm/tiny_vm.rs.html#1-697">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>TinyVm example.</p> +<p>This example introduces as simple 16 bit virtual machine the <a href="struct.TinyVm.html" title="struct tiny_vm::TinyVm"><code>TinyVm</code></a>. The VM consits of +three registers defined in <a href="enum.TinyReg.html" title="enum tiny_vm::TinyReg"><code>TinyReg</code></a>, a separate <em>data</em> and <em>insutrction</em> memory and a small +set of instructions <a href="enum.TinyInsn.html" title="enum tiny_vm::TinyInsn"><code>TinyInsn</code></a>, sufficient to implement a guest program to compute the +fiibonacci sequence.</p> +<p>The <code>TinyVm</code> implements a simple <em>just-in-time (JIT)</em> compiler to demonstrate the +<a href="../juicebox_asm/index.html" title="mod juicebox_asm"><code>juicebox_asm</code></a> crate. Additionally, it implements a reference <em>interpreter</em>.</p> + +<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">fn </span>main() { + <span class="kw">let </span><span class="kw-2">mut </span>prog = Vec::new(); + prog.push(TinyInsn::LoadImm(TinyReg::A, <span class="number">100</span>)); + prog.push(TinyInsn::Add(TinyReg::B, TinyReg::A)); + prog.push(TinyInsn::Addi(TinyReg::C, <span class="number">100</span>)); + prog.push(TinyInsn::Halt); + + <span class="kw">let </span><span class="kw-2">mut </span>vm = TinyVm::new(prog); + vm.interp(); + + <span class="macro">assert_eq!</span>(<span class="number">100</span>, vm.read_reg(TinyReg::A)); + <span class="macro">assert_eq!</span>(<span class="number">100</span>, vm.read_reg(TinyReg::B)); + <span class="macro">assert_eq!</span>(<span class="number">100</span>, vm.read_reg(TinyReg::C)); + <span class="macro">assert_eq!</span>(<span class="number">4</span>, vm.icnt); + <span class="macro">assert_eq!</span>(<span class="number">4</span>, vm.pc); + + vm.pc = <span class="number">0</span>; + vm.jit(); + + <span class="macro">assert_eq!</span>(<span class="number">100</span>, vm.read_reg(TinyReg::A)); + <span class="macro">assert_eq!</span>(<span class="number">200</span>, vm.read_reg(TinyReg::B)); + <span class="macro">assert_eq!</span>(<span class="number">200</span>, vm.read_reg(TinyReg::C)); + <span class="macro">assert_eq!</span>(<span class="number">8</span>, vm.icnt); + <span class="macro">assert_eq!</span>(<span class="number">4</span>, vm.pc); +}</code></pre></div> +</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Fixup.html" title="struct tiny_vm::Fixup">Fixup</a></div><div class="desc docblock-short">A minial fixup utility to implement jump labels when constructing guest programs.</div></li><li><div class="item-name"><a class="struct" href="struct.PhysAddr.html" title="struct tiny_vm::PhysAddr">PhysAddr</a></div><div class="desc docblock-short">A guest physical address.</div></li><li><div class="item-name"><a class="struct" href="struct.TinyVm.html" title="struct tiny_vm::TinyVm">TinyVm</a></div><div class="desc docblock-short">The <code>TinyVm</code> virtual machine state.</div></li></ul><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.TinyInsn.html" title="enum tiny_vm::TinyInsn">TinyInsn</a></div><div class="desc docblock-short">The instructions for the <a href="struct.TinyVm.html" title="struct tiny_vm::TinyVm"><code>TinyVm</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.TinyReg.html" title="enum tiny_vm::TinyReg">TinyReg</a></div><div class="desc docblock-short">The registers for the <a href="struct.TinyVm.html" title="struct tiny_vm::TinyVm"><code>TinyVm</code></a>.</div></li></ul><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.make_tinyvm_fib.html" title="fn tiny_vm::make_tinyvm_fib">make_tinyvm_fib</a></div><div class="desc docblock-short">Generate a guest program to compute the fiibonacci sequence for <code>n</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.make_tinyvm_jit_perf.html" title="fn tiny_vm::make_tinyvm_jit_perf">make_tinyvm_jit_perf</a></div><div class="desc docblock-short">Generate a simple count down loop to crunch some instructions.</div></li><li><div class="item-name"><a class="fn" href="fn.make_tinyvm_jit_test.html" title="fn tiny_vm::make_tinyvm_jit_test">make_tinyvm_jit_test</a></div><div class="desc docblock-short">Generate a test program for the jit.</div></li></ul></section></div></main></body></html>
\ No newline at end of file |