diff options
| author | johannst <johannst@users.noreply.github.com> | 2023-11-15 21:40:27 +0000 |
|---|---|---|
| committer | johannst <johannst@users.noreply.github.com> | 2023-11-15 21:40:27 +0000 |
| commit | 091d408a87d0f73f1c4e0166849ca9a566f005e0 (patch) | |
| tree | 894908b3a5fd80c94bc33e832d4168d73b4f2ba1 /src/kvm_rs/vm.rs.html | |
| parent | c44661b4d904f8be227faef8f84ddb22934a01e8 (diff) | |
| download | mini-kvm-rs-gh-pages.tar.gz mini-kvm-rs-gh-pages.zip | |
deploy: f52d556e0e1bf2350b3b42cff198550a267ceb0bgh-pages
Diffstat (limited to 'src/kvm_rs/vm.rs.html')
| -rw-r--r-- | src/kvm_rs/vm.rs.html | 254 |
1 files changed, 123 insertions, 131 deletions
diff --git a/src/kvm_rs/vm.rs.html b/src/kvm_rs/vm.rs.html index 7e99ae1..f633afe 100644 --- a/src/kvm_rs/vm.rs.html +++ b/src/kvm_rs/vm.rs.html @@ -1,147 +1,139 @@ -<!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="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[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="../../kvm_rs/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div> - </a><h2 class="location"></h2> - </nav> - <nav class="sidebar"><a class="sidebar-logo" href="../../kvm_rs/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div> - </a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../kvm_rs/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><button type="button" id="help-button" title="help">?</button><div id="settings-menu" tabindex="-1"> - <a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div> - </div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><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><pre class="rust"><code><span class="doccomment">//! VM system ioctls.</span> +<!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`."><title>vm.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="kvm_rs" 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="../../kvm_rs/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> +<a href="#5" id="5">5</a> +<a href="#6" id="6">6</a> +<a href="#7" id="7">7</a> +<a href="#8" id="8">8</a> +<a href="#9" id="9">9</a> +<a href="#10" id="10">10</a> +<a href="#11" id="11">11</a> +<a href="#12" id="12">12</a> +<a href="#13" id="13">13</a> +<a href="#14" id="14">14</a> +<a href="#15" id="15">15</a> +<a href="#16" id="16">16</a> +<a href="#17" id="17">17</a> +<a href="#18" id="18">18</a> +<a href="#19" id="19">19</a> +<a href="#20" id="20">20</a> +<a href="#21" id="21">21</a> +<a href="#22" id="22">22</a> +<a href="#23" id="23">23</a> +<a href="#24" id="24">24</a> +<a href="#25" id="25">25</a> +<a href="#26" id="26">26</a> +<a href="#27" id="27">27</a> +<a href="#28" id="28">28</a> +<a href="#29" id="29">29</a> +<a href="#30" id="30">30</a> +<a href="#31" id="31">31</a> +<a href="#32" id="32">32</a> +<a href="#33" id="33">33</a> +<a href="#34" id="34">34</a> +<a href="#35" id="35">35</a> +<a href="#36" id="36">36</a> +<a href="#37" id="37">37</a> +<a href="#38" id="38">38</a> +<a href="#39" id="39">39</a> +<a href="#40" id="40">40</a> +<a href="#41" id="41">41</a> +<a href="#42" id="42">42</a> +<a href="#43" id="43">43</a> +<a href="#44" id="44">44</a> +<a href="#45" id="45">45</a> +<a href="#46" id="46">46</a> +<a href="#47" id="47">47</a> +<a href="#48" id="48">48</a> +<a href="#49" id="49">49</a> +<a href="#50" id="50">50</a> +<a href="#51" id="51">51</a> +<a href="#52" id="52">52</a> +<a href="#53" id="53">53</a> +<a href="#54" id="54">54</a> +<a href="#55" id="55">55</a> +<a href="#56" id="56">56</a> +<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> +</pre></div><pre class="rust"><code><span class="doccomment">//! VM system ioctls. -<span class="kw">use</span> <span class="ident">std::fs</span>; -<span class="kw">use</span> <span class="ident">std::io</span>; -<span class="kw">use</span> <span class="ident">std::os::unix::io::FromRawFd</span>; +</span><span class="kw">use </span>std::fs; +<span class="kw">use </span>std::io; +<span class="kw">use </span>std::os::unix::io::FromRawFd; -<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::vcpu::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="kw">use </span><span class="kw">crate</span>::vcpu::Vcpu; +<span class="kw">use crate</span>::{ioctl, kvm_sys, KvmRun, PhysAddr, UserMem}; -<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::File</span>, - <span class="ident">vcpu_mmap_size</span>: <span class="ident">usize</span>, +<span class="doccomment">/// Wrapper for VM ioctls. +/// +/// Representation of the file descriptor obtained by the [`KVM_CREATE_VM`][kvm-create-vm] ioctl. +/// This wrapper provides access to the `VM ioctls` as described in [KVM API][kvm]. +/// +/// [kvm]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#general-description +/// [kvm-create-vm]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#kvm-create-vm +</span><span class="kw">pub struct </span>Vm { + vm: fs::File, + vcpu_mmap_size: usize, } -<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::File</span>, <span class="ident">vcpu_mmap_size</span>: <span class="ident">usize</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="kw">impl </span>Vm { + <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(vm: fs::File, vcpu_mmap_size: usize) -> Vm { + Vm { vm, vcpu_mmap_size } } - <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`][kvm-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: &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="doccomment">/// Map memory from userspace into the VM as `guest physical` memory starting at address + /// `phys_addr`. + /// The underlying operation is the [`KVM_SET_USER_MEMORY_REGION`][kvm-set-user-memory-region] + /// ioctl. + /// + /// # Safety + /// + /// The `mem: &UserMem` argument passed to this function must at least live as long the `Vcpu` + /// instance. + /// + /// [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 unsafe fn </span>set_user_memory_region( <span class="kw-2">&</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">&</span><span class="ident">UserMem</span>, - ) -> <span class="ident">io::Result</span><span class="op"><</span>()<span class="op">></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::kvm_userspace_memory_region::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>; + phys_addr: PhysAddr, + mem: <span class="kw-2">&</span>UserMem, + ) -> io::Result<()> { + <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>kvm_mem = kvm_sys::kvm_userspace_memory_region::default(); + kvm_mem.userspace_addr = mem.ptr <span class="kw">as </span>u64; + kvm_mem.memory_size = mem.len <span class="kw">as </span>u64; + kvm_mem.guest_phys_addr = phys_addr.<span class="number">0</span>; - <span class="ident">ioctl</span>( - <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">vm</span>, - <span class="ident">kvm_sys::KVM_SET_USER_MEMORY_REGION</span>, - <span class="kw-2">&</span><span class="ident">kvm_mem</span> <span class="kw">as</span> <span class="kw-2">*const</span> <span class="kw">_</span> <span class="kw">as</span> <span class="ident">u64</span>, + ioctl( + <span class="kw-2">&</span><span class="self">self</span>.vm, + kvm_sys::KVM_SET_USER_MEMORY_REGION, + <span class="kw-2">&</span>kvm_mem <span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_ as </span>u64, ) - .<span class="ident">map</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> ()) + .map(|<span class="kw">_</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">&</span><span class="self">self</span>, <span class="ident">id</span>: <span class="ident">u64</span>) -> <span class="ident">io::Result</span><span class="op"><</span><span class="ident">Vcpu</span><span class="op">></span> { - <span class="kw">let</span> <span class="ident">vcpu</span> <span class="op">=</span> <span class="ident">ioctl</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">vm</span>, <span class="ident">kvm_sys::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::File::from_raw_fd</span>(<span class="ident">fd</span>) })<span class="question-mark">?</span>; + <span class="doccomment">/// Create a new virtual cpu with the [`KVM_CREATE_VCPU`][kvm-create-vcpu] ioctl. + /// Returns a wrapper [`vcpu::Vcpu`][crate::vcpu::Vcpu] representing the VCPU. + /// + /// [kvm-create-vcpu]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#kvm-create-vcpu + </span><span class="kw">pub fn </span>create_vpcu(<span class="kw-2">&</span><span class="self">self</span>, id: u64) -> io::Result<Vcpu> { + <span class="kw">let </span>vcpu = ioctl(<span class="kw-2">&</span><span class="self">self</span>.vm, kvm_sys::KVM_CREATE_VCPU, id) + .map(|fd| <span class="kw">unsafe </span>{ fs::File::from_raw_fd(fd) })<span class="question-mark">?</span>; - <span class="kw">let</span> <span class="ident">kvm_run</span> <span class="op">=</span> <span class="ident">KvmRun::new</span>(<span class="kw-2">&</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="kw">let </span>kvm_run = KvmRun::new(<span class="kw-2">&</span>vcpu, <span class="self">self</span>.vcpu_mmap_size)<span class="question-mark">?</span>; - <span class="prelude-val">Ok</span>(<span class="ident">Vcpu::new</span>(<span class="ident">vcpu</span>, <span class="ident">kvm_run</span>)) + <span class="prelude-val">Ok</span>(Vcpu::new(vcpu, kvm_run)) } } -</code></pre></div> -</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="kvm_rs" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.63.0 (4b91a6ea7 2022-08-08)" ></div> -</body></html>
\ No newline at end of file +</code></pre></div></section></main></body></html>
\ No newline at end of file |