aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/kvm_rs/vm.rs.html
diff options
context:
space:
mode:
authorjohannst <johannst@users.noreply.github.com>2021-06-02 22:38:57 +0000
committerjohannst <johannst@users.noreply.github.com>2021-06-02 22:38:57 +0000
commitd2d2ba7c6602e73dc2e3dbd0aa4215e4c412a688 (patch)
tree360d361f769b79d9af2c02758eaa05fb887bf679 /src/kvm_rs/vm.rs.html
downloadmini-kvm-rs-d2d2ba7c6602e73dc2e3dbd0aa4215e4c412a688.tar.gz
mini-kvm-rs-d2d2ba7c6602e73dc2e3dbd0aa4215e4c412a688.zip
deploy: d2e2063cb2b5a82709e9c5188602a9fc0f7dadbd
Diffstat (limited to 'src/kvm_rs/vm.rs.html')
-rw-r--r--src/kvm_rs/vm.rs.html145
1 files changed, 145 insertions, 0 deletions
diff --git a/src/kvm_rs/vm.rs.html b/src/kvm_rs/vm.rs.html
new file mode 100644
index 0000000..94f2c10
--- /dev/null
+++ b/src/kvm_rs/vm.rs.html
@@ -0,0 +1,145 @@
+<!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/vm.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>vm.rs - source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
+<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
+<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">&#9776;</div><a href='../../kvm_rs/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
+ <a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span>
+<span id="2"> 2</span>
+<span id="3"> 3</span>
+<span id="4"> 4</span>
+<span id="5"> 5</span>
+<span id="6"> 6</span>
+<span id="7"> 7</span>
+<span id="8"> 8</span>
+<span id="9"> 9</span>
+<span id="10">10</span>
+<span id="11">11</span>
+<span id="12">12</span>
+<span id="13">13</span>
+<span id="14">14</span>
+<span id="15">15</span>
+<span id="16">16</span>
+<span id="17">17</span>
+<span id="18">18</span>
+<span id="19">19</span>
+<span id="20">20</span>
+<span id="21">21</span>
+<span id="22">22</span>
+<span id="23">23</span>
+<span id="24">24</span>
+<span id="25">25</span>
+<span id="26">26</span>
+<span id="27">27</span>
+<span id="28">28</span>
+<span id="29">29</span>
+<span id="30">30</span>
+<span id="31">31</span>
+<span id="32">32</span>
+<span id="33">33</span>
+<span id="34">34</span>
+<span id="35">35</span>
+<span id="36">36</span>
+<span id="37">37</span>
+<span id="38">38</span>
+<span id="39">39</span>
+<span id="40">40</span>
+<span id="41">41</span>
+<span id="42">42</span>
+<span id="43">43</span>
+<span id="44">44</span>
+<span id="45">45</span>
+<span id="46">46</span>
+<span id="47">47</span>
+<span id="48">48</span>
+<span id="49">49</span>
+<span id="50">50</span>
+<span id="51">51</span>
+<span id="52">52</span>
+<span id="53">53</span>
+<span id="54">54</span>
+<span id="55">55</span>
+<span id="56">56</span>
+<span id="57">57</span>
+<span id="58">58</span>
+<span id="59">59</span>
+<span id="60">60</span>
+<span id="61">61</span>
+<span id="62">62</span>
+<span id="63">63</span>
+<span id="64">64</span>
+<span id="65">65</span>
+<span id="66">66</span>
+<span id="67">67</span>
+<span id="68">68</span>
+<span id="69">69</span>
+</pre><div class="example-wrap"><pre class="rust ">
+<span class="doccomment">//! VM system ioctls.</span>
+
+<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fs</span>;
+<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>;
+<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">os</span>::<span class="ident">unix</span>::<span class="ident">io</span>::<span class="ident">FromRawFd</span>;
+
+<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">vcpu</span>::<span class="ident">Vcpu</span>;
+<span class="kw">use</span> <span class="kw">crate</span>::{<span class="ident">ioctl</span>, <span class="ident">kvm_sys</span>, <span class="ident">KvmRun</span>, <span class="ident">PhysAddr</span>, <span class="ident">UserMem</span>};
+
+<span class="doccomment">/// Wrapper for VM ioctls.</span>
+<span class="doccomment">///</span>
+<span class="doccomment">/// Representation of the file descriptor obtained by the [`KVM_CREATE_VM`][kvm-create-vm] ioctl.</span>
+<span class="doccomment">/// This wrapper provides access to the `VM ioctls` as described in [KVM API][kvm].</span>
+<span class="doccomment">///</span>
+<span class="doccomment">/// [kvm]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#general-description</span>
+<span class="doccomment">/// [kvm-create-vm]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#kvm-create-vm</span>
+<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Vm</span> {
+ <span class="ident">vm</span>: <span class="ident">fs</span>::<span class="ident">File</span>,
+ <span class="ident">vcpu_mmap_size</span>: <span class="ident">usize</span>,
+}
+
+<span class="kw">impl</span> <span class="ident">Vm</span> {
+ <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">vm</span>: <span class="ident">fs</span>::<span class="ident">File</span>, <span class="ident">vcpu_mmap_size</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">Vm</span> {
+ <span class="ident">Vm</span> { <span class="ident">vm</span>, <span class="ident">vcpu_mmap_size</span> }
+ }
+
+ <span class="doccomment">/// Map memory from userspace into the VM as `guest physical` memory starting at address</span>
+ <span class="doccomment">/// `phys_addr`.</span>
+ <span class="doccomment">/// The underlying operation is the [`KVM_SET_USER_MEMORY_REGION`][kmv-set-user-memory-region]</span>
+ <span class="doccomment">/// ioctl.</span>
+ <span class="doccomment">///</span>
+ <span class="doccomment">/// # Safety</span>
+ <span class="doccomment">///</span>
+ <span class="doccomment">/// The `mem: &amp;UserMem` argument passed to this function must at least live as long the `Vcpu`</span>
+ <span class="doccomment">/// instance.</span>
+ <span class="doccomment">///</span>
+ <span class="doccomment">/// [kvm-set-user-memory-region]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#kvm-set-user-memory-region</span>
+ <span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">set_user_memory_region</span>(
+ <span class="kw-2">&amp;</span><span class="self">self</span>,
+ <span class="ident">phys_addr</span>: <span class="ident">PhysAddr</span>,
+ <span class="ident">mem</span>: <span class="kw-2">&amp;</span><span class="ident">UserMem</span>,
+ ) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
+ <span class="comment">// Create guest physical memory mapping for `slot : 0` at guest `phys_addr`.</span>
+ <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">kvm_mem</span> <span class="op">=</span> <span class="ident">kvm_sys</span>::<span class="ident">kvm_userspace_memory_region</span>::<span class="ident">default</span>();
+ <span class="ident">kvm_mem</span>.<span class="ident">userspace_addr</span> <span class="op">=</span> <span class="ident">mem</span>.<span class="ident">ptr</span> <span class="kw">as</span> <span class="ident">u64</span>;
+ <span class="ident">kvm_mem</span>.<span class="ident">memory_size</span> <span class="op">=</span> <span class="ident">mem</span>.<span class="ident">len</span> <span class="kw">as</span> <span class="ident">u64</span>;
+ <span class="ident">kvm_mem</span>.<span class="ident">guest_phys_addr</span> <span class="op">=</span> <span class="ident">phys_addr</span>.<span class="number">0</span>;
+
+ <span class="ident">ioctl</span>(
+ <span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">vm</span>,
+ <span class="ident">kvm_sys</span>::<span class="ident">KVM_SET_USER_MEMORY_REGION</span>,
+ <span class="kw-2">&amp;</span><span class="ident">kvm_mem</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="kw">_</span> <span class="kw">as</span> <span class="ident">u64</span>,
+ )
+ .<span class="ident">map</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> ())
+ }
+
+ <span class="doccomment">/// Create a new virtual cpu with the [`KVM_CREATE_VCPU`][kvm-create-vcpu] ioctl.</span>
+ <span class="doccomment">/// Returns a wrapper [`vcpu::Vcpu`][crate::vcpu::Vcpu] representing the VCPU.</span>
+ <span class="doccomment">///</span>
+ <span class="doccomment">/// [kvm-create-vcpu]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#kvm-create-vcpu</span>
+ <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">create_vpcu</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">id</span>: <span class="ident">u64</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">Vcpu</span><span class="op">&gt;</span> {
+ <span class="kw">let</span> <span class="ident">vcpu</span> <span class="op">=</span> <span class="ident">ioctl</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">vm</span>, <span class="ident">kvm_sys</span>::<span class="ident">KVM_CREATE_VCPU</span>, <span class="ident">id</span>)
+ .<span class="ident">map</span>(<span class="op">|</span><span class="ident">fd</span><span class="op">|</span> <span class="kw">unsafe</span> { <span class="ident">fs</span>::<span class="ident">File</span>::<span class="ident">from_raw_fd</span>(<span class="ident">fd</span>) })<span class="question-mark">?</span>;
+
+ <span class="kw">let</span> <span class="ident">kvm_run</span> <span class="op">=</span> <span class="ident">KvmRun</span>::<span class="ident">new</span>(<span class="kw-2">&amp;</span><span class="ident">vcpu</span>, <span class="self">self</span>.<span class="ident">vcpu_mmap_size</span>)<span class="question-mark">?</span>;
+
+ <span class="prelude-val">Ok</span>(<span class="ident">Vcpu</span>::<span class="ident">new</span>(<span class="ident">vcpu</span>, <span class="ident">kvm_run</span>))
+ }
+}
+</pre></div>
+</section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="kvm_rs" data-search-js="../../search-index.js"></div>
+ <script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script></body></html> \ No newline at end of file
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-22 01:35:26 +0000