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
|
<!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><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-b0742ba02757f159.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.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-0111fcff984fae8f.css"></noscript><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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../tiny_vm/index.html">tiny_vm</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>tiny_vm</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/tiny_vm/tiny_vm.rs.html#1-705">source</a> </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 a simple 16 bit virtual machine the <a href="struct.TinyVm.html" title="struct tiny_vm::TinyVm"><code>TinyVm</code></a>. The VM consists 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>instruction</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
Fibonacci 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="section-header">Structs<a href="#structs" class="anchor">§</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">Phys<wbr>Addr</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="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.TinyInsn.html" title="enum tiny_vm::TinyInsn">Tiny<wbr>Insn</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="section-header">Functions<a href="#functions" class="anchor">§</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_<wbr>tinyvm_<wbr>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_<wbr>tinyvm_<wbr>jit_<wbr>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_<wbr>tinyvm_<wbr>jit_<wbr>test</a></div><div class="desc docblock-short">Generate a test program for the jit.</div></li></ul></section></div></main></body></html>
|
