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/lib.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/lib.rs.html')
| -rw-r--r-- | src/kvm_rs/lib.rs.html | 568 |
1 files changed, 280 insertions, 288 deletions
diff --git a/src/kvm_rs/lib.rs.html b/src/kvm_rs/lib.rs.html index 51825a9..8f5cba9 100644 --- a/src/kvm_rs/lib.rs.html +++ b/src/kvm_rs/lib.rs.html @@ -1,341 +1,333 @@ -<!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">☰</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>; +<!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`."><title>lib.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> +<a href="#70" id="70">70</a> +<a href="#71" id="71">71</a> +<a href="#72" id="72">72</a> +<a href="#73" id="73">73</a> +<a href="#74" id="74">74</a> +<a href="#75" id="75">75</a> +<a href="#76" id="76">76</a> +<a href="#77" id="77">77</a> +<a href="#78" id="78">78</a> +<a href="#79" id="79">79</a> +<a href="#80" id="80">80</a> +<a href="#81" id="81">81</a> +<a href="#82" id="82">82</a> +<a href="#83" id="83">83</a> +<a href="#84" id="84">84</a> +<a href="#85" id="85">85</a> +<a href="#86" id="86">86</a> +<a href="#87" id="87">87</a> +<a href="#88" id="88">88</a> +<a href="#89" id="89">89</a> +<a href="#90" id="90">90</a> +<a href="#91" id="91">91</a> +<a href="#92" id="92">92</a> +<a href="#93" id="93">93</a> +<a href="#94" id="94">94</a> +<a href="#95" id="95">95</a> +<a href="#96" id="96">96</a> +<a href="#97" id="97">97</a> +<a href="#98" id="98">98</a> +<a href="#99" id="99">99</a> +<a href="#100" id="100">100</a> +<a href="#101" id="101">101</a> +<a href="#102" id="102">102</a> +<a href="#103" id="103">103</a> +<a href="#104" id="104">104</a> +<a href="#105" id="105">105</a> +<a href="#106" id="106">106</a> +<a href="#107" id="107">107</a> +<a href="#108" id="108">108</a> +<a href="#109" id="109">109</a> +<a href="#110" id="110">110</a> +<a href="#111" id="111">111</a> +<a href="#112" id="112">112</a> +<a href="#113" id="113">113</a> +<a href="#114" id="114">114</a> +<a href="#115" id="115">115</a> +<a href="#116" id="116">116</a> +<a href="#117" id="117">117</a> +<a href="#118" id="118">118</a> +<a href="#119" id="119">119</a> +<a href="#120" id="120">120</a> +<a href="#121" id="121">121</a> +<a href="#122" id="122">122</a> +<a href="#123" id="123">123</a> +<a href="#124" id="124">124</a> +<a href="#125" id="125">125</a> +<a href="#126" id="126">126</a> +<a href="#127" id="127">127</a> +<a href="#128" id="128">128</a> +<a href="#129" id="129">129</a> +<a href="#130" id="130">130</a> +<a href="#131" id="131">131</a> +<a href="#132" id="132">132</a> +<a href="#133" id="133">133</a> +<a href="#134" id="134">134</a> +<a href="#135" id="135">135</a> +<a href="#136" id="136">136</a> +<a href="#137" id="137">137</a> +<a href="#138" id="138">138</a> +<a href="#139" id="139">139</a> +<a href="#140" id="140">140</a> +<a href="#141" id="141">141</a> +<a href="#142" id="142">142</a> +<a href="#143" id="143">143</a> +<a href="#144" id="144">144</a> +<a href="#145" id="145">145</a> +<a href="#146" id="146">146</a> +<a href="#147" id="147">147</a> +<a href="#148" id="148">148</a> +<a href="#149" id="149">149</a> +<a href="#150" id="150">150</a> +<a href="#151" id="151">151</a> +<a href="#152" id="152">152</a> +<a href="#153" id="153">153</a> +<a href="#154" id="154">154</a> +<a href="#155" id="155">155</a> +<a href="#156" id="156">156</a> +<a href="#157" id="157">157</a> +<a href="#158" id="158">158</a> +<a href="#159" id="159">159</a> +<a href="#160" id="160">160</a> +<a href="#161" id="161">161</a> +<a href="#162" id="162">162</a> +<a href="#163" id="163">163</a> +<a href="#164" id="164">164</a> +<a href="#165" id="165">165</a> +<a href="#166" id="166">166</a> +</pre></div><pre class="rust"><code><span class="kw">use </span>std::convert::{AsMut, AsRef}; +<span class="kw">use </span>std::io; +<span class="kw">use </span>std::ops; +<span class="kw">use </span>std::os::unix::io::AsRawFd; -<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="kw">pub mod </span>cap; +<span class="kw">mod </span>fmt; +<span class="kw">pub mod </span>kvm; +<span class="kw">pub mod </span>kvm_sys; +<span class="kw">pub mod </span>vcpu; +<span class="kw">pub mod </span>vm; +<span class="kw">pub mod </span>x86_64; -<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">/// Strong type representing physical addresses. +</span><span class="kw">pub struct </span>PhysAddr(<span class="kw">pub </span>u64); -<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 < 0`.</span> -<span class="kw">fn</span> <span class="ident">libcret</span>(<span class="ident">ret</span>: <span class="ident">libc::c_int</span>) -> <span class="ident">io::Result</span><span class="op"><</span><span class="ident">libc::c_int</span><span class="op">></span> { - <span class="kw">if</span> <span class="ident">ret</span> <span class="op"><</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">/// Helper to turn libc return values into an [io::Result](std::io::Result). Returns +/// [`Error::last_os_error`](std::io::Error::last_os_error) if `ret < 0`. +</span><span class="kw">fn </span>libcret(ret: libc::c_int) -> io::Result<libc::c_int> { + <span class="kw">if </span>ret < <span class="number">0 </span>{ + <span class="prelude-val">Err</span>(io::Error::last_os_error()) + } <span class="kw">else </span>{ + <span class="prelude-val">Ok</span>(ret) } } -<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"><</span><span class="ident">F</span>: <span class="ident">AsRawFd</span><span class="op">></span>(<span class="ident">fd</span>: <span class="kw-2">&</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>) -> <span class="ident">io::Result</span><span class="op"><</span><span class="ident">libc::c_int</span><span class="op">></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 of `libc::ioctl` for KVM ioctls with one argument and returning an +/// [`io::Result`](std::io::Result). +</span><span class="kw">fn </span>ioctl<F: AsRawFd>(fd: <span class="kw-2">&</span>F, cmd: u64, arg: u64) -> io::Result<libc::c_int> { + libcret(<span class="kw">unsafe </span>{ libc::ioctl(fd.as_raw_fd(), cmd, arg) }) } -<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="doccomment">/// Wrapper to safely allocate memory for guest VMs. +/// +/// The underlying memory is freed automatically once the `UserMem` instance is dropped. +/// +/// Memory can be mapped into a guest VM with +/// [`Vm::set_user_memory_region`](crate::vm::Vm::set_user_memory_region). +</span><span class="kw">pub struct </span>UserMem { + ptr: <span class="kw-2">*mut </span>u8, + len: usize, } -<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>) -> <span class="ident">io::Result</span><span class="op"><</span><span class="ident">UserMem</span><span class="op">></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="kw">impl </span>UserMem { + <span class="doccomment">/// Allocate a zero-initialized memory region of `len` bytes. + </span><span class="kw">pub fn </span>new(len: usize) -> io::Result<UserMem> { + <span class="kw">let </span>ptr = <span class="kw">unsafe </span>{ + libc::mmap( + std::ptr::null_mut(), + len, + libc::PROT_READ | libc::PROT_WRITE, + libc::MAP_PRIVATE | libc::MAP_ANONYMOUS, + -<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="kw">if </span>ptr == libc::MAP_FAILED { + <span class="prelude-val">Err</span>(io::Error::last_os_error()) + } <span class="kw">else </span>{ + <span class="prelude-val">Ok</span>(UserMem { + ptr: ptr.cast(), + len, }) } } - <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">&</span>[<span class="ident">u8</span>]) -> <span class="ident">io::Result</span><span class="op"><</span><span class="ident">UserMem</span><span class="op">></span> { - <span class="macro">assert!</span>(<span class="ident">len</span> <span class="op">></span><span class="op">=</span> <span class="ident">init_from</span>.<span class="ident">len</span>()); + <span class="doccomment">/// Allocate a zero-initialized memory region of `len` bytes and initialize the first bytes + /// with `init_from`. + /// + /// # Panics + /// + /// Panics if `init_from` is larger than the memory size `len`. + </span><span class="kw">pub fn </span>with_init(len: usize, init_from: <span class="kw-2">&</span>[u8]) -> io::Result<UserMem> { + <span class="macro">assert!</span>(len >= init_from.len()); - <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="kw">let </span><span class="kw-2">mut </span>m = UserMem::new(len)<span class="question-mark">?</span>; + m.load(PhysAddr(<span class="number">0</span>), init_from); + <span class="prelude-val">Ok</span>(m) } - <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">&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">&</span>[<span class="ident">u8</span>]) { - <span class="macro">assert!</span>(<span class="self">self</span>.<span class="ident">len</span> <span class="op">></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="doccomment">/// Load the bytes stored in `data` into memory at physical address `addr`. + /// + /// # Panics + /// + /// Panics if `addr + data.len` is larger than the memory size `len`. + </span><span class="kw">pub fn </span>load(<span class="kw-2">&mut </span><span class="self">self</span>, addr: PhysAddr, data: <span class="kw-2">&</span>[u8]) { + <span class="macro">assert!</span>(<span class="self">self</span>.len >= addr.<span class="number">0 </span><span class="kw">as </span>usize + data.len()); - <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">let </span>addr = addr.<span class="number">0 </span><span class="kw">as </span>usize; + <span class="self">self</span>.as_mut()[addr..addr + data.len()].copy_from_slice(data); } } -<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">&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>ops::Drop <span class="kw">for </span>UserMem { + <span class="doccomment">/// Free underlying memory. + </span><span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { + <span class="kw">unsafe </span>{ libc::munmap(<span class="self">self</span>.ptr.cast(), <span class="self">self</span>.len) }; } } -<span class="kw">impl</span> <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">u8</span>]<span class="op">></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">&</span><span class="self">self</span>) -> <span class="kw-2">&</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>AsRef<[u8]> <span class="kw">for </span>UserMem { + <span class="kw">fn </span>as_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[u8] { + <span class="kw">unsafe </span>{ std::slice::from_raw_parts(<span class="self">self</span>.ptr, <span class="self">self</span>.len) } } } -<span class="kw">impl</span> <span class="ident">AsMut</span><span class="op"><</span>[<span class="ident">u8</span>]<span class="op">></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">&mut</span> <span class="self">self</span>) -> <span class="kw-2">&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="kw">impl </span>AsMut<[u8]> <span class="kw">for </span>UserMem { + <span class="kw">fn </span>as_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>[u8] { + <span class="kw">unsafe </span>{ std::slice::from_raw_parts_mut(<span class="self">self</span>.ptr, <span class="self">self</span>.len) } } } -<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="doccomment">/// Internal wrapper to automatically `mmap` and `munmap` the the [`struct kvm_run`][kvm_run] +/// for a given VPCU. +/// +/// [kvm_run]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#the-kvm-run-structure +</span><span class="kw">struct </span>KvmRun { + ptr: <span class="kw-2">*mut </span>kvm_sys::kvm_run, + len: usize, } -<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"><</span><span class="ident">F</span>: <span class="ident">AsRawFd</span><span class="op">></span>(<span class="ident">vcpu</span>: <span class="kw-2">&</span><span class="ident">F</span>, <span class="ident">len</span>: <span class="ident">usize</span>) -> <span class="ident">io::Result</span><span class="op"><</span><span class="ident">KvmRun</span><span class="op">></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="kw">impl </span>KvmRun { + <span class="doccomment">/// Mmap the `struct kvm_run` for a given `VCPU` referenced by the argument file descriptor + /// `vcpu`. + </span><span class="kw">fn </span>new<F: AsRawFd>(vcpu: <span class="kw-2">&</span>F, len: usize) -> io::Result<KvmRun> { + <span class="kw">let </span>ptr = <span class="kw">unsafe </span>{ + libc::mmap( + std::ptr::null_mut(), + len, + libc::PROT_READ | libc::PROT_WRITE, + libc::MAP_SHARED, + vcpu.as_raw_fd(), <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">if </span>ptr == libc::MAP_FAILED { + <span class="prelude-val">Err</span>(io::Error::last_os_error()) + } <span class="kw">else </span>{ + <span class="prelude-val">Ok</span>(KvmRun { + ptr: ptr.cast(), + len, }) } } } -<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">&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>ops::Drop <span class="kw">for </span>KvmRun { + <span class="doccomment">/// Munmap the mmaped `struct kvm_run`. + </span><span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { + <span class="kw">unsafe </span>{ libc::munmap(<span class="self">self</span>.ptr.cast(), <span class="self">self</span>.len) }; } } -<span class="kw">impl</span> <span class="ident">AsRef</span><span class="op"><</span><span class="ident">kvm_sys::kvm_run</span><span class="op">></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">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">kvm_sys::kvm_run</span> { - <span class="kw">unsafe</span> { <span class="kw-2">&</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>AsRef<kvm_sys::kvm_run> <span class="kw">for </span>KvmRun { + <span class="kw">fn </span>as_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>kvm_sys::kvm_run { + <span class="kw">unsafe </span>{ <span class="kw-2">&*</span>(<span class="self">self</span>.ptr <span class="kw">as </span><span class="kw-2">*const </span>kvm_sys::kvm_run) } } } -<span class="kw">impl</span> <span class="ident">AsMut</span><span class="op"><</span><span class="ident">kvm_sys::kvm_run</span><span class="op">></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">&mut</span> <span class="self">self</span>) -> <span class="kw-2">&mut</span> <span class="ident">kvm_sys::kvm_run</span> { - <span class="kw">unsafe</span> { <span class="kw-2">&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>) } +<span class="kw">impl </span>AsMut<kvm_sys::kvm_run> <span class="kw">for </span>KvmRun { + <span class="kw">fn </span>as_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>kvm_sys::kvm_run { + <span class="kw">unsafe </span>{ <span class="kw-2">&mut *</span>(<span class="self">self</span>.ptr <span class="kw">as </span><span class="kw-2">*mut </span>kvm_sys::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 |