path: root/src/kvm_rs/lib.rs.html

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  

<!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/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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">&#9776;</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>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">std::convert</span>::{<span class="ident">AsMut</span>, <span class="ident">AsRef</span>};
<span class="kw">use</span> <span class="ident">std::io</span>;
<span class="kw">use</span> <span class="ident">std::ops</span>;
<span class="kw">use</span> <span class="ident">std::os::unix::io::AsRawFd</span>;

<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">cap</span>;
<span class="kw">mod</span> <span class="ident">fmt</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">kvm</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">kvm_sys</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">vcpu</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">vm</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">x86_64</span>;

<span class="doccomment">/// Strong type representing physical addresses.</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">PhysAddr</span>(<span class="kw">pub</span> <span class="ident">u64</span>);

<span class="doccomment">/// Helper to turn libc return values into an [io::Result](std::io::Result). Returns</span>
<span class="doccomment">/// [`Error::last_os_error`](std::io::Error::last_os_error) if `ret &lt; 0`.</span>
<span class="kw">fn</span> <span class="ident">libcret</span>(<span class="ident">ret</span>: <span class="ident">libc::c_int</span>) -&gt; <span class="ident">io::Result</span><span class="op">&lt;</span><span class="ident">libc::c_int</span><span class="op">&gt;</span> {
    <span class="kw">if</span> <span class="ident">ret</span> <span class="op">&lt;</span> <span class="number">0</span> {
        <span class="prelude-val">Err</span>(<span class="ident">io::Error::last_os_error</span>())
    } <span class="kw">else</span> {
        <span class="prelude-val">Ok</span>(<span class="ident">ret</span>)
    }
}

<span class="doccomment">/// Wrapper of `libc::ioctl` for KVM ioctls with one argument and returning an</span>
<span class="doccomment">/// [`io::Result`](std::io::Result).</span>
<span class="kw">fn</span> <span class="ident">ioctl</span><span class="op">&lt;</span><span class="ident">F</span>: <span class="ident">AsRawFd</span><span class="op">&gt;</span>(<span class="ident">fd</span>: <span class="kw-2">&amp;</span><span class="ident">F</span>, <span class="ident">cmd</span>: <span class="ident">u64</span>, <span class="ident">arg</span>: <span class="ident">u64</span>) -&gt; <span class="ident">io::Result</span><span class="op">&lt;</span><span class="ident">libc::c_int</span><span class="op">&gt;</span> {
    <span class="ident">libcret</span>(<span class="kw">unsafe</span> { <span class="ident">libc::ioctl</span>(<span class="ident">fd</span>.<span class="ident">as_raw_fd</span>(), <span class="ident">cmd</span>, <span class="ident">arg</span>) })
}

<span class="doccomment">/// Wrapper to safely allocate memory for guest VMs.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The underlying memory is freed automatically once the `UserMem` instance is dropped.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Memory can be mapped into a guest VM with</span>
<span class="doccomment">/// [`Vm::set_user_memory_region`](crate::vm::Vm::set_user_memory_region).</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">UserMem</span> {
    <span class="ident">ptr</span>: <span class="kw-2">*mut</span> <span class="ident">u8</span>,
    <span class="ident">len</span>: <span class="ident">usize</span>,
}

<span class="kw">impl</span> <span class="ident">UserMem</span> {
    <span class="doccomment">/// Allocate a zero-initialized memory region of `len` bytes.</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">len</span>: <span class="ident">usize</span>) -&gt; <span class="ident">io::Result</span><span class="op">&lt;</span><span class="ident">UserMem</span><span class="op">&gt;</span> {
        <span class="kw">let</span> <span class="ident">ptr</span> <span class="op">=</span> <span class="kw">unsafe</span> {
            <span class="ident">libc::mmap</span>(
                <span class="ident">std::ptr::null_mut</span>(),
                <span class="ident">len</span>,
                <span class="ident">libc::PROT_READ</span> <span class="op">|</span> <span class="ident">libc::PROT_WRITE</span>,
                <span class="ident">libc::MAP_PRIVATE</span> <span class="op">|</span> <span class="ident">libc::MAP_ANONYMOUS</span>,
                <span class="op">-</span><span class="number">1</span>,
                <span class="number">0</span>,
            )
        };

        <span class="kw">if</span> <span class="ident">ptr</span> <span class="op">==</span> <span class="ident">libc::MAP_FAILED</span> {
            <span class="prelude-val">Err</span>(<span class="ident">io::Error::last_os_error</span>())
        } <span class="kw">else</span> {
            <span class="prelude-val">Ok</span>(<span class="ident">UserMem</span> {
                <span class="ident">ptr</span>: <span class="ident">ptr</span>.<span class="ident">cast</span>(),
                <span class="ident">len</span>,
            })
        }
    }

    <span class="doccomment">/// Allocate a zero-initialized memory region of `len` bytes and initialize the first bytes</span>
    <span class="doccomment">/// with `init_from`.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Panics</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Panics if `init_from` is larger than the memory size `len`.</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_init</span>(<span class="ident">len</span>: <span class="ident">usize</span>, <span class="ident">init_from</span>: <span class="kw-2">&amp;</span>[<span class="ident">u8</span>]) -&gt; <span class="ident">io::Result</span><span class="op">&lt;</span><span class="ident">UserMem</span><span class="op">&gt;</span> {
        <span class="macro">assert!</span>(<span class="ident">len</span> <span class="op">&gt;</span><span class="op">=</span> <span class="ident">init_from</span>.<span class="ident">len</span>());

        <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">UserMem::new</span>(<span class="ident">len</span>)<span class="question-mark">?</span>;
        <span class="ident">m</span>.<span class="ident">load</span>(<span class="ident">PhysAddr</span>(<span class="number">0</span>), <span class="ident">init_from</span>);
        <span class="prelude-val">Ok</span>(<span class="ident">m</span>)
    }

    <span class="doccomment">/// Load the bytes stored in `data` into memory at physical address `addr`.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Panics</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Panics if `addr + data.len` is larger than the memory size `len`.</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">load</span>(<span class="kw-2">&amp;mut</span> <span class="self">self</span>, <span class="ident">addr</span>: <span class="ident">PhysAddr</span>, <span class="ident">data</span>: <span class="kw-2">&amp;</span>[<span class="ident">u8</span>]) {
        <span class="macro">assert!</span>(<span class="self">self</span>.<span class="ident">len</span> <span class="op">&gt;</span><span class="op">=</span> <span class="ident">addr</span>.<span class="number">0</span> <span class="kw">as</span> <span class="ident">usize</span> <span class="op">+</span> <span class="ident">data</span>.<span class="ident">len</span>());

        <span class="kw">let</span> <span class="ident">addr</span> <span class="op">=</span> <span class="ident">addr</span>.<span class="number">0</span> <span class="kw">as</span> <span class="ident">usize</span>;
        <span class="self">self</span>.<span class="ident">as_mut</span>()[<span class="ident">addr</span>..<span class="ident">addr</span> <span class="op">+</span> <span class="ident">data</span>.<span class="ident">len</span>()].<span class="ident">copy_from_slice</span>(<span class="ident">data</span>);
    }
}

<span class="kw">impl</span> <span class="ident">ops::Drop</span> <span class="kw">for</span> <span class="ident">UserMem</span> {
    <span class="doccomment">/// Free underlying memory.</span>
    <span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&amp;mut</span> <span class="self">self</span>) {
        <span class="kw">unsafe</span> { <span class="ident">libc::munmap</span>(<span class="self">self</span>.<span class="ident">ptr</span>.<span class="ident">cast</span>(), <span class="self">self</span>.<span class="ident">len</span>) };
    }
}

<span class="kw">impl</span> <span class="ident">AsRef</span><span class="op">&lt;</span>[<span class="ident">u8</span>]<span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">UserMem</span> {
    <span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>[<span class="ident">u8</span>] {
        <span class="kw">unsafe</span> { <span class="ident">std::slice::from_raw_parts</span>(<span class="self">self</span>.<span class="ident">ptr</span>, <span class="self">self</span>.<span class="ident">len</span>) }
    }
}

<span class="kw">impl</span> <span class="ident">AsMut</span><span class="op">&lt;</span>[<span class="ident">u8</span>]<span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">UserMem</span> {
    <span class="kw">fn</span> <span class="ident">as_mut</span>(<span class="kw-2">&amp;mut</span> <span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut</span> [<span class="ident">u8</span>] {
        <span class="kw">unsafe</span> { <span class="ident">std::slice::from_raw_parts_mut</span>(<span class="self">self</span>.<span class="ident">ptr</span>, <span class="self">self</span>.<span class="ident">len</span>) }
    }
}

<span class="doccomment">/// Internal wrapper to automatically `mmap` and `munmap` the the [`struct kvm_run`][kvm_run]</span>
<span class="doccomment">/// for a given VPCU.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [kvm_run]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#the-kvm-run-structure</span>
<span class="kw">struct</span> <span class="ident">KvmRun</span> {
    <span class="ident">ptr</span>: <span class="kw-2">*mut</span> <span class="ident">kvm_sys::kvm_run</span>,
    <span class="ident">len</span>: <span class="ident">usize</span>,
}

<span class="kw">impl</span> <span class="ident">KvmRun</span> {
    <span class="doccomment">/// Mmap the `struct kvm_run` for a given `VCPU` referenced by the argument file descriptor</span>
    <span class="doccomment">/// `vcpu`.</span>
    <span class="kw">fn</span> <span class="ident">new</span><span class="op">&lt;</span><span class="ident">F</span>: <span class="ident">AsRawFd</span><span class="op">&gt;</span>(<span class="ident">vcpu</span>: <span class="kw-2">&amp;</span><span class="ident">F</span>, <span class="ident">len</span>: <span class="ident">usize</span>) -&gt; <span class="ident">io::Result</span><span class="op">&lt;</span><span class="ident">KvmRun</span><span class="op">&gt;</span> {
        <span class="kw">let</span> <span class="ident">ptr</span> <span class="op">=</span> <span class="kw">unsafe</span> {
            <span class="ident">libc::mmap</span>(
                <span class="ident">std::ptr::null_mut</span>(),
                <span class="ident">len</span>,
                <span class="ident">libc::PROT_READ</span> <span class="op">|</span> <span class="ident">libc::PROT_WRITE</span>,
                <span class="ident">libc::MAP_SHARED</span>,
                <span class="ident">vcpu</span>.<span class="ident">as_raw_fd</span>(),
                <span class="number">0</span>,
            )
        };

        <span class="kw">if</span> <span class="ident">ptr</span> <span class="op">==</span> <span class="ident">libc::MAP_FAILED</span> {
            <span class="prelude-val">Err</span>(<span class="ident">io::Error::last_os_error</span>())
        } <span class="kw">else</span> {
            <span class="prelude-val">Ok</span>(<span class="ident">KvmRun</span> {
                <span class="ident">ptr</span>: <span class="ident">ptr</span>.<span class="ident">cast</span>(),
                <span class="ident">len</span>,
            })
        }
    }
}

<span class="kw">impl</span> <span class="ident">ops::Drop</span> <span class="kw">for</span> <span class="ident">KvmRun</span> {
    <span class="doccomment">/// Munmap the mmaped `struct kvm_run`.</span>
    <span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&amp;mut</span> <span class="self">self</span>) {
        <span class="kw">unsafe</span> { <span class="ident">libc::munmap</span>(<span class="self">self</span>.<span class="ident">ptr</span>.<span class="ident">cast</span>(), <span class="self">self</span>.<span class="ident">len</span>) };
    }
}

<span class="kw">impl</span> <span class="ident">AsRef</span><span class="op">&lt;</span><span class="ident">kvm_sys::kvm_run</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">KvmRun</span> {
    <span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="ident">kvm_sys::kvm_run</span> {
        <span class="kw">unsafe</span> { <span class="kw-2">&amp;</span><span class="kw-2">*</span>(<span class="self">self</span>.<span class="ident">ptr</span> <span class="kw">as</span> <span class="kw-2">*const</span> <span class="ident">kvm_sys::kvm_run</span>) }
    }
}

<span class="kw">impl</span> <span class="ident">AsMut</span><span class="op">&lt;</span><span class="ident">kvm_sys::kvm_run</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">KvmRun</span> {
    <span class="kw">fn</span> <span class="ident">as_mut</span>(<span class="kw-2">&amp;mut</span> <span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut</span> <span class="ident">kvm_sys::kvm_run</span> {
        <span class="kw">unsafe</span> { <span class="kw-2">&amp;mut</span> <span class="kw-2">*</span>(<span class="self">self</span>.<span class="ident">ptr</span> <span class="kw">as</span> <span class="kw-2">*mut</span> <span class="ident">kvm_sys::kvm_run</span>) }
    }
}
</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>
<!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/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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">&#9776;</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>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">std::convert</span>::{<span class="ident">AsMut</span>, <span class="ident">AsRef</span>};
<span class="kw">use</span> <span class="ident">std::io</span>;
<span class="kw">use</span> <span class="ident">std::ops</span>;
<span class="kw">use</span> <span class="ident">std::os::unix::io::AsRawFd</span>;

<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">cap</span>;
<span class="kw">mod</span> <span class="ident">fmt</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">kvm</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">kvm_sys</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">vcpu</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">vm</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">x86_64</span>;

<span class="doccomment">/// Strong type representing physical addresses.</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">PhysAddr</span>(<span class="kw">pub</span> <span class="ident">u64</span>);

<span class="doccomment">/// Helper to turn libc return values into an [io::Result](std::io::Result). Returns</span>
<span class="doccomment">/// [`Error::last_os_error`](std::io::Error::last_os_error) if `ret &lt; 0`.</span>
<span class="kw">fn</span> <span class="ident">libcret</span>(<span class="ident">ret</span>: <span class="ident">libc::c_int</span>) -&gt; <span class="ident">io::Result</span><span class="op">&lt;</span><span class="ident">libc::c_int</span><span class="op">&gt;</span> {
    <span class="kw">if</span> <span class="ident">ret</span> <span class="op">&lt;</span> <span class="number">0</span> {
        <span class="prelude-val">Err</span>(<span class="ident">io::Error::last_os_error</span>())
    } <span class="kw">else</span> {
        <span class="prelude-val">Ok</span>(<span class="ident">ret</span>)
    }
}

<span class="doccomment">/// Wrapper of `libc::ioctl` for KVM ioctls with one argument and returning an</span>
<span class="doccomment">/// [`io::Result`](std::io::Result).</span>
<span class="kw">fn</span> <span class="ident">ioctl</span><span class="op">&lt;</span><span class="ident">F</span>: <span class="ident">AsRawFd</span><span class="op">&gt;</span>(<span class="ident">fd</span>: <span class="kw-2">&amp;</span><span class="ident">F</span>, <span class="ident">cmd</span>: <span class="ident">u64</span>, <span class="ident">arg</span>: <span class="ident">u64</span>) -&gt; <span class="ident">io::Result</span><span class="op">&lt;</span><span class="ident">libc::c_int</span><span class="op">&gt;</span> {
    <span class="ident">libcret</span>(<span class="kw">unsafe</span> { <span class="ident">libc::ioctl</span>(<span class="ident">fd</span>.<span class="ident">as_raw_fd</span>(), <span class="ident">cmd</span>, <span class="ident">arg</span>) })
}

<span class="doccomment">/// Wrapper to safely allocate memory for guest VMs.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The underlying memory is freed automatically once the `UserMem` instance is dropped.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Memory can be mapped into a guest VM with</span>
<span class="doccomment">/// [`Vm::set_user_memory_region`](crate::vm::Vm::set_user_memory_region).</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">UserMem</span> {
    <span class="ident">ptr</span>: <span class="kw-2">*mut</span> <span class="ident">u8</span>,
    <span class="ident">len</span>: <span class="ident">usize</span>,
}

<span class="kw">impl</span> <span class="ident">UserMem</span> {
    <span class="doccomment">/// Allocate a zero-initialized memory region of `len` bytes.</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">len</span>: <span class="ident">usize</span>) -&gt; <span class="ident">io::Result</span><span class="op">&lt;</span><span class="ident">UserMem</span><span class="op">&gt;</span> {
        <span class="kw">let</span> <span class="ident">ptr</span> <span class="op">=</span> <span class="kw">unsafe</span> {
            <span class="ident">libc::mmap</span>(
                <span class="ident">std::ptr::null_mut</span>(),
                <span class="ident">len</span>,
                <span class="ident">libc::PROT_READ</span> <span class="op">|</span> <span class="ident">libc::PROT_WRITE</span>,
                <span class="ident">libc::MAP_PRIVATE</span> <span class="op">|</span> <span class="ident">libc::MAP_ANONYMOUS</span>,
                <span class="op">-</span><span class="number">1</span>,
                <span class="number">0</span>,
            )
        };

        <span class="kw">if</span> <span class="ident">ptr</span> <span class="op">==</span> <span class="ident">libc::MAP_FAILED</span> {
            <span class="prelude-val">Err</span>(<span class="ident">io::Error::last_os_error</span>())
        } <span class="kw">else</span> {
            <span class="prelude-val">Ok</span>(<span class="ident">UserMem</span> {
                <span class="ident">ptr</span>: <span class="ident">ptr</span>.<span class="ident">cast</span>(),
                <span class="ident">len</span>,
            })
        }
    }

    <span class="doccomment">/// Allocate a zero-initialized memory region of `len` bytes and initialize the first bytes</span>
    <span class="doccomment">/// with `init_from`.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Panics</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Panics if `init_from` is larger than the memory size `len`.</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_init</span>(<span class="ident">len</span>: <span class="ident">usize</span>, <span class="ident">init_from</span>: <span class="kw-2">&amp;</span>[<span class="ident">u8</span>]) -&gt; <span class="ident">io::Result</span><span class="op">&lt;</span><span class="ident">UserMem</span><span class="op">&gt;</span> {
        <span class="macro">assert!</span>(<span class="ident">len</span> <span class="op">&gt;</span><span class="op">=</span> <span class="ident">init_from</span>.<span class="ident">len</span>());

        <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">UserMem::new</span>(<span class="ident">len</span>)<span class="question-mark">?</span>;
        <span class="ident">m</span>.<span class="ident">load</span>(<span class="ident">PhysAddr</span>(<span class="number">0</span>), <span class="ident">init_from</span>);
        <span class="prelude-val">Ok</span>(<span class="ident">m</span>)
    }

    <span class="doccomment">/// Load the bytes stored in `data` into memory at physical address `addr`.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// # Panics</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// Panics if `addr + data.len` is larger than the memory size `len`.</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">load</span>(<span class="kw-2">&amp;mut</span> <span class="self">self</span>, <span class="ident">addr</span>: <span class="ident">PhysAddr</span>, <span class="ident">data</span>: <span class="kw-2">&amp;</span>[<span class="ident">u8</span>]) {
        <span class="macro">assert!</span>(<span class="self">self</span>.<span class="ident">len</span> <span class="op">&gt;</span><span class="op">=</span> <span class="ident">addr</span>.<span class="number">0</span> <span class="kw">as</span> <span class="ident">usize</span> <span class="op">+</span> <span class="ident">data</span>.<span class="ident">len</span>());

        <span class="kw">let</span> <span class="ident">addr</span> <span class="op">=</span> <span class="ident">addr</span>.<span class="number">0</span> <span class="kw">as</span> <span class="ident">usize</span>;
        <span class="self">self</span>.<span class="ident">as_mut</span>()[<span class="ident">addr</span>..<span class="ident">addr</span> <span class="op">+</span> <span class="ident">data</span>.<span class="ident">len</span>()].<span class="ident">copy_from_slice</span>(<span class="ident">data</span>);
    }
}

<span class="kw">impl</span> <span class="ident">ops::Drop</span> <span class="kw">for</span> <span class="ident">UserMem</span> {
    <span class="doccomment">/// Free underlying memory.</span>
    <span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&amp;mut</span> <span class="self">self</span>) {
        <span class="kw">unsafe</span> { <span class="ident">libc::munmap</span>(<span class="self">self</span>.<span class="ident">ptr</span>.<span class="ident">cast</span>(), <span class="self">self</span>.<span class="ident">len</span>) };
    }
}

<span class="kw">impl</span> <span class="ident">AsRef</span><span class="op">&lt;</span>[<span class="ident">u8</span>]<span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">UserMem</span> {
    <span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>[<span class="ident">u8</span>] {
        <span class="kw">unsafe</span> { <span class="ident">std::slice::from_raw_parts</span>(<span class="self">self</span>.<span class="ident">ptr</span>, <span class="self">self</span>.<span class="ident">len</span>) }
    }
}

<span class="kw">impl</span> <span class="ident">AsMut</span><span class="op">&lt;</span>[<span class="ident">u8</span>]<span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">UserMem</span> {
    <span class="kw">fn</span> <span class="ident">as_mut</span>(<span class="kw-2">&amp;mut</span> <span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut</span> [<span class="ident">u8</span>] {
        <span class="kw">unsafe</span> { <span class="ident">std::slice::from_raw_parts_mut</span>(<span class="self">self</span>.<span class="ident">ptr</span>, <span class="self">self</span>.<span class="ident">len</span>) }
    }
}

<span class="doccomment">/// Internal wrapper to automatically `mmap` and `munmap` the the [`struct kvm_run`][kvm_run]</span>
<span class="doccomment">/// for a given VPCU.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [kvm_run]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#the-kvm-run-structure</span>
<span class="kw">struct</span> <span class="ident">KvmRun</span> {
    <span class="ident">ptr</span>: <span class="kw-2">*mut</span> <span class="ident">kvm_sys::kvm_run</span>,
    <span class="ident">len</span>: <span class="ident">usize</span>,
}

<span class="kw">impl</span> <span class="ident">KvmRun</span> {
    <span class="doccomment">/// Mmap the `struct kvm_run` for a given `VCPU` referenced by the argument file descriptor</span>
    <span class="doccomment">/// `vcpu`.</span>
    <span class="kw">fn</span> <span class="ident">new</span><span class="op">&lt;</span><span class="ident">F</span>: <span class="ident">AsRawFd</span><span class="op">&gt;</span>(<span class="ident">vcpu</span>: <span class="kw-2">&amp;</span><span class="ident">F</span>, <span class="ident">len</span>: <span class="ident">usize</span>) -&gt; <span class="ident">io::Result</span><span class="op">&lt;</span><span class="ident">KvmRun</span><span class="op">&gt;</span> {
        <span class="kw">let</span> <span class="ident">ptr</span> <span class="op">=</span> <span class="kw">unsafe</span> {
            <span class="ident">libc::mmap</span>(
                <span class="ident">std::ptr::null_mut</span>(),
                <span class="ident">len</span>,
                <span class="ident">libc::PROT_READ</span> <span class="op">|</span> <span class="ident">libc::PROT_WRITE</span>,
                <span class="ident">libc::MAP_SHARED</span>,
                <span class="ident">vcpu</span>.<span class="ident">as_raw_fd</span>(),
                <span class="number">0</span>,
            )
        };

        <span class="kw">if</span> <span class="ident">ptr</span> <span class="op">==</span> <span class="ident">libc::MAP_FAILED</span> {
            <span class="prelude-val">Err</span>(<span class="ident">io::Error::last_os_error</span>())
        } <span class="kw">else</span> {
            <span class="prelude-val">Ok</span>(<span class="ident">KvmRun</span> {
                <span class="ident">ptr</span>: <span class="ident">ptr</span>.<span class="ident">cast</span>(),
                <span class="ident">len</span>,
            })
        }
    }
}

<span class="kw">impl</span> <span class="ident">ops::Drop</span> <span class="kw">for</span> <span class="ident">KvmRun</span> {
    <span class="doccomment">/// Munmap the mmaped `struct kvm_run`.</span>
    <span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&amp;mut</span> <span class="self">self</span>) {
        <span class="kw">unsafe</span> { <span class="ident">libc::munmap</span>(<span class="self">self</span>.<span class="ident">ptr</span>.<span class="ident">cast</span>(), <span class="self">self</span>.<span class="ident">len</span>) };
    }
}

<span class="kw">impl</span> <span class="ident">AsRef</span><span class="op">&lt;</span><span class="ident">kvm_sys::kvm_run</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">KvmRun</span> {
    <span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="ident">kvm_sys::kvm_run</span> {
        <span class="kw">unsafe</span> { <span class="kw-2">&amp;</span><span class="kw-2">*</span>(<span class="self">self</span>.<span class="ident">ptr</span> <span class="kw">as</span> <span class="kw-2">*const</span> <span class="ident">kvm_sys::kvm_run</span>) }
    }
}

<span class="kw">impl</span> <span class="ident">AsMut</span><span class="op">&lt;</span><span class="ident">kvm_sys::kvm_run</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">KvmRun</span> {
    <span class="kw">fn</span> <span class="ident">as_mut</span>(<span class="kw-2">&amp;mut</span> <span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut</span> <span class="ident">kvm_sys::kvm_run</span> {
        <span class="kw">unsafe</span> { <span class="kw-2">&amp;mut</span> <span class="kw-2">*</span>(<span class="self">self</span>.<span class="ident">ptr</span> <span class="kw">as</span> <span class="kw-2">*mut</span> <span class="ident">kvm_sys::kvm_run</span>) }
    }
}
</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>