diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/kvm_rs/fmt.rs.html | 265 | ||||
| -rw-r--r-- | src/kvm_rs/kvm.rs.html | 111 | ||||
| -rw-r--r-- | src/kvm_rs/kvm_sys.rs.html | 401 | ||||
| -rw-r--r-- | src/kvm_rs/lib.rs.html | 337 | ||||
| -rw-r--r-- | src/kvm_rs/vcpu.rs.html | 279 | ||||
| -rw-r--r-- | src/kvm_rs/vm.rs.html | 145 | ||||
| -rw-r--r-- | src/kvm_rs/x86_64.rs.html | 315 |
7 files changed, 1853 insertions, 0 deletions
diff --git a/src/kvm_rs/fmt.rs.html b/src/kvm_rs/fmt.rs.html new file mode 100644 index 0000000..ec871ef --- /dev/null +++ b/src/kvm_rs/fmt.rs.html @@ -0,0 +1,265 @@ +<!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/fmt.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>fmt.rs - source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg"> +<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"> +<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../../kvm_rs/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button> + <a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span> +<span id="2"> 2</span> +<span id="3"> 3</span> +<span id="4"> 4</span> +<span id="5"> 5</span> +<span id="6"> 6</span> +<span id="7"> 7</span> +<span id="8"> 8</span> +<span id="9"> 9</span> +<span id="10"> 10</span> +<span id="11"> 11</span> +<span id="12"> 12</span> +<span id="13"> 13</span> +<span id="14"> 14</span> +<span id="15"> 15</span> +<span id="16"> 16</span> +<span id="17"> 17</span> +<span id="18"> 18</span> +<span id="19"> 19</span> +<span id="20"> 20</span> +<span id="21"> 21</span> +<span id="22"> 22</span> +<span id="23"> 23</span> +<span id="24"> 24</span> +<span id="25"> 25</span> +<span id="26"> 26</span> +<span id="27"> 27</span> +<span id="28"> 28</span> +<span id="29"> 29</span> +<span id="30"> 30</span> +<span id="31"> 31</span> +<span id="32"> 32</span> +<span id="33"> 33</span> +<span id="34"> 34</span> +<span id="35"> 35</span> +<span id="36"> 36</span> +<span id="37"> 37</span> +<span id="38"> 38</span> +<span id="39"> 39</span> +<span id="40"> 40</span> +<span id="41"> 41</span> +<span id="42"> 42</span> +<span id="43"> 43</span> +<span id="44"> 44</span> +<span id="45"> 45</span> +<span id="46"> 46</span> +<span id="47"> 47</span> +<span id="48"> 48</span> +<span id="49"> 49</span> +<span id="50"> 50</span> +<span id="51"> 51</span> +<span id="52"> 52</span> +<span id="53"> 53</span> +<span id="54"> 54</span> +<span id="55"> 55</span> +<span id="56"> 56</span> +<span id="57"> 57</span> +<span id="58"> 58</span> +<span id="59"> 59</span> +<span id="60"> 60</span> +<span id="61"> 61</span> +<span id="62"> 62</span> +<span id="63"> 63</span> +<span id="64"> 64</span> +<span id="65"> 65</span> +<span id="66"> 66</span> +<span id="67"> 67</span> +<span id="68"> 68</span> +<span id="69"> 69</span> +<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> +</pre><div class="example-wrap"><pre class="rust "> +<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>; + +<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">kvm_sys</span>::{<span class="ident">kvm_dtable</span>, <span class="ident">kvm_regs</span>, <span class="ident">kvm_segment</span>, <span class="ident">kvm_sregs</span>}; +<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">x86_64</span>::<span class="kw-2">*</span>; + +<span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">kvm_regs</span> { + <span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> { + <span class="macro">write</span><span class="macro">!</span>( + <span class="ident">f</span>, + <span class="string">"rax: {:#018x} rbx: {:#018x} rcx: {:#018x} rdx: {:#018x}\n\ + rsi: {:#018x} rdi: {:#018x}\n\ + r8 : {:#018x} r9 : {:#018x} r10: {:#018x} r11: {:#018x}\n\ + r12: {:#018x} r13: {:#018x} r14: {:#018x} r15: {:#018x}\n\ + rsp: {:#018x} rbp: {:#018x}\n\ + rip: {:#018x} rfl: {:#018x} O({}) D({}) I({}) S({}) Z({}) P({}) C({})"</span>, + <span class="self">self</span>.<span class="ident">rax</span>, + <span class="self">self</span>.<span class="ident">rbx</span>, + <span class="self">self</span>.<span class="ident">rcx</span>, + <span class="self">self</span>.<span class="ident">rdx</span>, + <span class="self">self</span>.<span class="ident">rsi</span>, + <span class="self">self</span>.<span class="ident">rdi</span>, + <span class="self">self</span>.<span class="ident">r8</span>, + <span class="self">self</span>.<span class="ident">r9</span>, + <span class="self">self</span>.<span class="ident">r10</span>, + <span class="self">self</span>.<span class="ident">r11</span>, + <span class="self">self</span>.<span class="ident">r12</span>, + <span class="self">self</span>.<span class="ident">r13</span>, + <span class="self">self</span>.<span class="ident">r14</span>, + <span class="self">self</span>.<span class="ident">r15</span>, + <span class="self">self</span>.<span class="ident">rsp</span>, + <span class="self">self</span>.<span class="ident">rbp</span>, + <span class="self">self</span>.<span class="ident">rip</span>, + <span class="self">self</span>.<span class="ident">rflags</span>, + <span class="ident">rflags_of</span>(<span class="self">self</span>.<span class="ident">rflags</span>), + <span class="ident">rflags_df</span>(<span class="self">self</span>.<span class="ident">rflags</span>), + <span class="ident">rflags_if</span>(<span class="self">self</span>.<span class="ident">rflags</span>), + <span class="ident">rflags_sf</span>(<span class="self">self</span>.<span class="ident">rflags</span>), + <span class="ident">rflags_zf</span>(<span class="self">self</span>.<span class="ident">rflags</span>), + <span class="ident">rflags_pf</span>(<span class="self">self</span>.<span class="ident">rflags</span>), + <span class="ident">rflags_cf</span>(<span class="self">self</span>.<span class="ident">rflags</span>), + ) + } +} + +<span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">kvm_segment</span> { + <span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> { + <span class="kw">if</span> <span class="self">self</span>.<span class="ident">present</span> <span class="op">=</span><span class="op">=</span> <span class="number">0</span> { + <span class="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">"{:#04x} P(0)"</span>, <span class="self">self</span>.<span class="ident">selector</span>) + } <span class="kw">else</span> { + <span class="macro">write</span><span class="macro">!</span>( + <span class="ident">f</span>, + <span class="string">"{:#06x} T({}) RPL({}) BASE({:#010x}) LIMIT({:#07x}) P(1) S({}) DPL({}) DB({}) L({}) TYPE({})"</span>, + <span class="self">self</span>.<span class="ident">selector</span>, + <span class="kw">if</span> <span class="ident">seg_selector_ti</span>(<span class="self">self</span>.<span class="ident">selector</span>) <span class="op">=</span><span class="op">=</span> <span class="number">0</span> { + <span class="string">"GDT"</span> + } <span class="kw">else</span> { + <span class="string">"LDT"</span> + }, + <span class="ident">seg_selector_rpl</span>(<span class="self">self</span>.<span class="ident">selector</span>), + <span class="self">self</span>.<span class="ident">base</span>, + <span class="self">self</span>.<span class="ident">limit</span>, + <span class="self">self</span>.<span class="ident">s</span>, + <span class="self">self</span>.<span class="ident">dpl</span>, + <span class="self">self</span>.<span class="ident">db</span>, + <span class="self">self</span>.<span class="ident">l</span>, + <span class="kw">match</span> <span class="self">self</span>.<span class="ident">type_</span> { + <span class="number">0</span> <span class="op">=</span><span class="op">></span> <span class="string">"D:R---"</span>, + <span class="number">1</span> <span class="op">=</span><span class="op">></span> <span class="string">"D:R-A-"</span>, + <span class="number">2</span> <span class="op">=</span><span class="op">></span> <span class="string">"D:RW--"</span>, + <span class="number">3</span> <span class="op">=</span><span class="op">></span> <span class="string">"D:RWA-"</span>, + <span class="number">4</span> <span class="op">=</span><span class="op">></span> <span class="string">"D:R--E"</span>, + <span class="number">5</span> <span class="op">=</span><span class="op">></span> <span class="string">"D:R-AE"</span>, + <span class="number">6</span> <span class="op">=</span><span class="op">></span> <span class="string">"D:RW-E"</span>, + <span class="number">7</span> <span class="op">=</span><span class="op">></span> <span class="string">"D:RWAE"</span>, + <span class="number">8</span> <span class="op">=</span><span class="op">></span> <span class="string">"C:X---"</span>, + <span class="number">9</span> <span class="op">=</span><span class="op">></span> <span class="string">"C:X-A-"</span>, + <span class="number">10</span> <span class="op">=</span><span class="op">></span> <span class="string">"C:XR--"</span>, + <span class="number">11</span> <span class="op">=</span><span class="op">></span> <span class="string">"C:XRA-"</span>, + <span class="number">12</span> <span class="op">=</span><span class="op">></span> <span class="string">"C:X--C"</span>, + <span class="number">13</span> <span class="op">=</span><span class="op">></span> <span class="string">"C:X-AC"</span>, + <span class="number">14</span> <span class="op">=</span><span class="op">></span> <span class="string">"C:XR-C"</span>, + <span class="number">15</span> <span class="op">=</span><span class="op">></span> <span class="string">"C:XRAC"</span>, + <span class="kw">_</span> <span class="op">=</span><span class="op">></span> <span class="macro">unreachable</span><span class="macro">!</span>(), + } + ) + } + } +} + +<span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">kvm_dtable</span> { + <span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> { + <span class="macro">write</span><span class="macro">!</span>(<span class="ident">f</span>, <span class="string">"BASE({:#018x}) LIMIT({:#07x})"</span>, <span class="self">self</span>.<span class="ident">base</span>, <span class="self">self</span>.<span class="ident">limit</span>) + } +} + +<span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">kvm_sregs</span> { + <span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">fmt</span>::<span class="prelude-ty">Result</span> { + <span class="macro">write</span><span class="macro">!</span>( + <span class="ident">f</span>, + <span class="string">"cs : {}\n\ + ds : {}\n\ + es : {}\n\ + fs : {}\n\ + gs : {}\n\ + ss : {}\n\ + tr : {}\n\ + ldt : {}\n\ + gdt : {}\n\ + idt : {}\n\ + cr0 : {:#018x} cr2: {:#018x} cr3: {:#018x} cr4: {:#018x}\n\ + efer: {:#018x}"</span>, + <span class="self">self</span>.<span class="ident">cs</span>, + <span class="self">self</span>.<span class="ident">ds</span>, + <span class="self">self</span>.<span class="ident">es</span>, + <span class="self">self</span>.<span class="ident">fs</span>, + <span class="self">self</span>.<span class="ident">gs</span>, + <span class="self">self</span>.<span class="ident">ss</span>, + <span class="self">self</span>.<span class="ident">tr</span>, + <span class="self">self</span>.<span class="ident">ldt</span>, + <span class="self">self</span>.<span class="ident">gdt</span>, + <span class="self">self</span>.<span class="ident">idt</span>, + <span class="self">self</span>.<span class="ident">cr0</span>, + <span class="self">self</span>.<span class="ident">cr2</span>, + <span class="self">self</span>.<span class="ident">cr3</span>, + <span class="self">self</span>.<span class="ident">cr4</span>, + <span class="self">self</span>.<span class="ident">efer</span>, + ) + } +} +</pre></div> +</section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="kvm_rs" data-search-js="../../search-index.js"></div> + <script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script></body></html>
\ No newline at end of file diff --git a/src/kvm_rs/kvm.rs.html b/src/kvm_rs/kvm.rs.html new file mode 100644 index 0000000..ccd6c37 --- /dev/null +++ b/src/kvm_rs/kvm.rs.html @@ -0,0 +1,111 @@ +<!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/kvm.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>kvm.rs - source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg"> +<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"> +<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../../kvm_rs/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button> + <a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span> +<span id="2"> 2</span> +<span id="3"> 3</span> +<span id="4"> 4</span> +<span id="5"> 5</span> +<span id="6"> 6</span> +<span id="7"> 7</span> +<span id="8"> 8</span> +<span id="9"> 9</span> +<span id="10">10</span> +<span id="11">11</span> +<span id="12">12</span> +<span id="13">13</span> +<span id="14">14</span> +<span id="15">15</span> +<span id="16">16</span> +<span id="17">17</span> +<span id="18">18</span> +<span id="19">19</span> +<span id="20">20</span> +<span id="21">21</span> +<span id="22">22</span> +<span id="23">23</span> +<span id="24">24</span> +<span id="25">25</span> +<span id="26">26</span> +<span id="27">27</span> +<span id="28">28</span> +<span id="29">29</span> +<span id="30">30</span> +<span id="31">31</span> +<span id="32">32</span> +<span id="33">33</span> +<span id="34">34</span> +<span id="35">35</span> +<span id="36">36</span> +<span id="37">37</span> +<span id="38">38</span> +<span id="39">39</span> +<span id="40">40</span> +<span id="41">41</span> +<span id="42">42</span> +<span id="43">43</span> +<span id="44">44</span> +<span id="45">45</span> +<span id="46">46</span> +<span id="47">47</span> +<span id="48">48</span> +<span id="49">49</span> +<span id="50">50</span> +<span id="51">51</span> +<span id="52">52</span> +</pre><div class="example-wrap"><pre class="rust "> +<span class="doccomment">//! KVM system ioctls.</span> + +<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fs</span>; +<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>; +<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">os</span>::<span class="ident">unix</span>::<span class="ident">io</span>::<span class="ident">FromRawFd</span>; + +<span class="kw">use</span> <span class="kw">crate</span>::{<span class="ident">libcret</span>, <span class="ident">ioctl</span>, <span class="ident">kvm_sys</span>}; +<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">vm</span>::<span class="ident">Vm</span>; + +<span class="doccomment">/// Wrapper for `/dev/kvm` ioctls.</span> +<span class="doccomment">///</span> +<span class="doccomment">/// Representation of the file descriptor obtained by opening `/dev/kvm`.</span> +<span class="doccomment">/// This wrapper provides access to the `system 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="kw">pub</span> <span class="kw">struct</span> <span class="ident">Kvm</span> { + <span class="ident">kvm</span>: <span class="ident">fs</span>::<span class="ident">File</span>, +} + +<span class="kw">impl</span> <span class="ident">Kvm</span> { + <span class="doccomment">/// Open the `/dev/kvm` device.</span> + <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Kvm</span><span class="op">></span> { + <span class="kw">let</span> <span class="ident">kvm</span> <span class="op">=</span> <span class="ident">libcret</span>(<span class="kw">unsafe</span> { + <span class="ident">libc</span>::<span class="ident">open</span>(<span class="string">"/dev/kvm\0"</span>.<span class="ident">as_ptr</span>().<span class="ident">cast</span>(), <span class="ident">libc</span>::<span class="ident">O_RDWR</span> <span class="op">|</span> <span class="ident">libc</span>::<span class="ident">O_CLOEXEC</span>) + }) + .<span class="ident">map</span>(<span class="op">|</span><span class="ident">fd</span><span class="op">|</span> <span class="kw">unsafe</span> { <span class="ident">fs</span>::<span class="ident">File</span>::<span class="ident">from_raw_fd</span>(<span class="ident">fd</span>) })<span class="question-mark">?</span>; + + <span class="macro">assert_eq</span><span class="macro">!</span>( + <span class="ident">kvm_sys</span>::<span class="ident">KVM_API_VERSION</span>, + <span class="ident">ioctl</span>(<span class="kw-2">&</span><span class="ident">kvm</span>, <span class="ident">kvm_sys</span>::<span class="ident">KVM_GET_API_VERSION</span>, <span class="number">0</span>)<span class="question-mark">?</span> + ); + + <span class="prelude-val">Ok</span>(<span class="ident">Kvm</span> { <span class="ident">kvm</span> }) + } + + <span class="kw">fn</span> <span class="ident">get_vpcu_mmap_size</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span> { + <span class="ident">ioctl</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">kvm</span>, <span class="ident">kvm_sys</span>::<span class="ident">KVM_GET_VCPU_MMAP_SIZE</span>, <span class="number">0</span>).<span class="ident">map</span>(<span class="op">|</span><span class="ident">size</span><span class="op">|</span> <span class="ident">size</span> <span class="kw">as</span> <span class="ident">usize</span>) + } + + <span class="doccomment">/// Create a new virtual machine with the [`KVM_CREATE_VM`][kvm-create-vm] ioctl.</span> + <span class="doccomment">/// Returns a wrapper [`vm::Vm`][crate::vm::Vm] representing the VM.</span> + <span class="doccomment">///</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">fn</span> <span class="ident">create_vm</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Vm</span><span class="op">></span> { + <span class="kw">let</span> <span class="ident">vm</span> <span class="op">=</span> <span class="ident">ioctl</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">kvm</span>, <span class="ident">kvm_sys</span>::<span class="ident">KVM_CREATE_VM</span>, <span class="number">0</span> <span class="comment">/* machine id */</span>) + .<span class="ident">map</span>(<span class="op">|</span><span class="ident">fd</span><span class="op">|</span> <span class="kw">unsafe</span> { <span class="ident">fs</span>::<span class="ident">File</span>::<span class="ident">from_raw_fd</span>(<span class="ident">fd</span>) })<span class="question-mark">?</span>; + + <span class="kw">let</span> <span class="ident">vcpu_mmap_size</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">get_vpcu_mmap_size</span>()<span class="question-mark">?</span>; + + <span class="prelude-val">Ok</span>(<span class="ident">Vm</span>::<span class="ident">new</span>(<span class="ident">vm</span>, <span class="ident">vcpu_mmap_size</span>)) + } +} +</pre></div> +</section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="kvm_rs" data-search-js="../../search-index.js"></div> + <script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script></body></html>
\ No newline at end of file diff --git a/src/kvm_rs/kvm_sys.rs.html b/src/kvm_rs/kvm_sys.rs.html new file mode 100644 index 0000000..44136b6 --- /dev/null +++ b/src/kvm_rs/kvm_sys.rs.html @@ -0,0 +1,401 @@ +<!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/kvm_sys.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>kvm_sys.rs - source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg"> +<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"> +<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../../kvm_rs/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button> + <a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span> +<span id="2"> 2</span> +<span id="3"> 3</span> +<span id="4"> 4</span> +<span id="5"> 5</span> +<span id="6"> 6</span> +<span id="7"> 7</span> +<span id="8"> 8</span> +<span id="9"> 9</span> +<span id="10"> 10</span> +<span id="11"> 11</span> +<span id="12"> 12</span> +<span id="13"> 13</span> +<span id="14"> 14</span> +<span id="15"> 15</span> +<span id="16"> 16</span> +<span id="17"> 17</span> +<span id="18"> 18</span> +<span id="19"> 19</span> +<span id="20"> 20</span> +<span id="21"> 21</span> +<span id="22"> 22</span> +<span id="23"> 23</span> +<span id="24"> 24</span> +<span id="25"> 25</span> +<span id="26"> 26</span> +<span id="27"> 27</span> +<span id="28"> 28</span> +<span id="29"> 29</span> +<span id="30"> 30</span> +<span id="31"> 31</span> +<span id="32"> 32</span> +<span id="33"> 33</span> +<span id="34"> 34</span> +<span id="35"> 35</span> +<span id="36"> 36</span> +<span id="37"> 37</span> +<span id="38"> 38</span> +<span id="39"> 39</span> +<span id="40"> 40</span> +<span id="41"> 41</span> +<span id="42"> 42</span> +<span id="43"> 43</span> +<span id="44"> 44</span> +<span id="45"> 45</span> +<span id="46"> 46</span> +<span id="47"> 47</span> +<span id="48"> 48</span> +<span id="49"> 49</span> +<span id="50"> 50</span> +<span id="51"> 51</span> +<span id="52"> 52</span> +<span id="53"> 53</span> +<span id="54"> 54</span> +<span id="55"> 55</span> +<span id="56"> 56</span> +<span id="57"> 57</span> +<span id="58"> 58</span> +<span id="59"> 59</span> +<span id="60"> 60</span> +<span id="61"> 61</span> +<span id="62"> 62</span> +<span id="63"> 63</span> +<span id="64"> 64</span> +<span id="65"> 65</span> +<span id="66"> 66</span> +<span id="67"> 67</span> +<span id="68"> 68</span> +<span id="69"> 69</span> +<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> +<span id="167">167</span> +<span id="168">168</span> +<span id="169">169</span> +<span id="170">170</span> +<span id="171">171</span> +<span id="172">172</span> +<span id="173">173</span> +<span id="174">174</span> +<span id="175">175</span> +<span id="176">176</span> +<span id="177">177</span> +<span id="178">178</span> +<span id="179">179</span> +<span id="180">180</span> +<span id="181">181</span> +<span id="182">182</span> +<span id="183">183</span> +<span id="184">184</span> +<span id="185">185</span> +<span id="186">186</span> +<span id="187">187</span> +<span id="188">188</span> +<span id="189">189</span> +<span id="190">190</span> +<span id="191">191</span> +<span id="192">192</span> +<span id="193">193</span> +<span id="194">194</span> +<span id="195">195</span> +<span id="196">196</span> +<span id="197">197</span> +</pre><div class="example-wrap"><pre class="rust "> +<span class="doccomment">//! Definitions of the system header [`<linux/kvm.h>`][kvm-h].</span> +<span class="doccomment">//!</span> +<span class="doccomment">//! [kvm-h]: https://elixir.bootlin.com/linux/latest/source/include/uapi/linux/kvm.h</span> + +<span class="attribute">#![<span class="ident">allow</span>(<span class="ident">non_snake_case</span>)]</span> +<span class="attribute">#![<span class="ident">allow</span>(<span class="ident">non_camel_case_types</span>)]</span> +<span class="attribute">#![<span class="ident">allow</span>(<span class="ident">dead_code</span>)]</span> + +<span class="comment">// Generated by `build.rs`.</span> +<span class="macro">include</span><span class="macro">!</span>(<span class="macro">concat</span><span class="macro">!</span>(<span class="macro">env</span><span class="macro">!</span>(<span class="string">"OUT_DIR"</span>), <span class="string">"/kvm_constants.rs"</span>)); + +<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">C</span>)]</span> +<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Default</span>, <span class="ident">Debug</span>)]</span> +<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">kvm_regs</span> { + <span class="kw">pub</span> <span class="ident">rax</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">rbx</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">rcx</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">rdx</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">rsi</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">rdi</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">rsp</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">rbp</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">r8</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">r9</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">r10</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">r11</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">r12</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">r13</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">r14</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">r15</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">rip</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">rflags</span>: <span class="ident">u64</span>, +} + +<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">C</span>)]</span> +<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Default</span>, <span class="ident">Debug</span>)]</span> +<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">kvm_segment</span> { + <span class="kw">pub</span> <span class="ident">base</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">limit</span>: <span class="ident">u32</span>, + <span class="kw">pub</span> <span class="ident">selector</span>: <span class="ident">u16</span>, + <span class="kw">pub</span> <span class="ident">type_</span>: <span class="ident">u8</span>, + <span class="kw">pub</span> <span class="ident">present</span>: <span class="ident">u8</span>, + <span class="kw">pub</span> <span class="ident">dpl</span>: <span class="ident">u8</span>, + <span class="kw">pub</span> <span class="ident">db</span>: <span class="ident">u8</span>, + <span class="kw">pub</span> <span class="ident">s</span>: <span class="ident">u8</span>, + <span class="kw">pub</span> <span class="ident">l</span>: <span class="ident">u8</span>, + <span class="kw">pub</span> <span class="ident">g</span>: <span class="ident">u8</span>, + <span class="kw">pub</span> <span class="ident">avl</span>: <span class="ident">u8</span>, + <span class="ident">unusable</span>: <span class="ident">u8</span>, + <span class="ident">_padding</span>: <span class="ident">u8</span>, +} + +<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">C</span>)]</span> +<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Default</span>, <span class="ident">Debug</span>)]</span> +<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">kvm_dtable</span> { + <span class="kw">pub</span> <span class="ident">base</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">limit</span>: <span class="ident">u16</span>, + <span class="ident">_padding</span>: [<span class="ident">u16</span>; <span class="number">3</span>], +} + +<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">C</span>)]</span> +<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Default</span>, <span class="ident">Debug</span>)]</span> +<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">kvm_sregs</span> { + <span class="kw">pub</span> <span class="ident">cs</span>: <span class="ident">kvm_segment</span>, + <span class="kw">pub</span> <span class="ident">ds</span>: <span class="ident">kvm_segment</span>, + <span class="kw">pub</span> <span class="ident">es</span>: <span class="ident">kvm_segment</span>, + <span class="kw">pub</span> <span class="ident">fs</span>: <span class="ident">kvm_segment</span>, + <span class="kw">pub</span> <span class="ident">gs</span>: <span class="ident">kvm_segment</span>, + <span class="kw">pub</span> <span class="ident">ss</span>: <span class="ident">kvm_segment</span>, + <span class="kw">pub</span> <span class="ident">tr</span>: <span class="ident">kvm_segment</span>, + <span class="kw">pub</span> <span class="ident">ldt</span>: <span class="ident">kvm_segment</span>, + <span class="kw">pub</span> <span class="ident">gdt</span>: <span class="ident">kvm_dtable</span>, + <span class="kw">pub</span> <span class="ident">idt</span>: <span class="ident">kvm_dtable</span>, + <span class="kw">pub</span> <span class="ident">cr0</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">cr2</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">cr3</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">cr4</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">cr8</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">efer</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">apic_base</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">interrupt_bitmap</span>: [<span class="ident">u64</span>; <span class="number">4</span>], +} + +<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">C</span>)]</span> +<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Default</span>, <span class="ident">Debug</span>)]</span> +<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct</span> <span class="ident">kvm_userspace_memory_region</span> { + <span class="kw">pub</span> <span class="ident">slot</span>: <span class="ident">u32</span>, + <span class="kw">pub</span> <span class="ident">flags</span>: <span class="ident">u32</span>, + <span class="kw">pub</span> <span class="ident">guest_phys_addr</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">memory_size</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">userspace_addr</span>: <span class="ident">u64</span>, +} + +<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">C</span>)]</span> +<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct</span> <span class="ident">kvm_run</span> { + <span class="ident">request_interrupt_window</span>: <span class="ident">u8</span>, + <span class="ident">immediate_exit</span>: <span class="ident">u8</span>, + <span class="ident">padding1</span>: [<span class="ident">u8</span>; <span class="number">6</span>], + <span class="kw">pub</span> <span class="ident">exit_reason</span>: <span class="ident">u32</span>, + <span class="ident">ready_for_interrupt_injection</span>: <span class="ident">u8</span>, + <span class="ident">if_flag</span>: <span class="ident">u8</span>, + <span class="ident">flags</span>: <span class="ident">u16</span>, + <span class="ident">cr8</span>: <span class="ident">u64</span>, + <span class="ident">apic_base</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">inner</span>: <span class="ident">kvm_run_union</span>, + <span class="ident">kvm_valid_regs</span>: <span class="ident">u64</span>, + <span class="ident">kvm_dirty_regs</span>: <span class="ident">u64</span>, + <span class="ident">s</span>: <span class="ident">kvm_run_union_s</span>, +} + +<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">C</span>)]</span> +<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Copy</span>, <span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span> +<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct</span> <span class="ident">kvm_run_io</span> { + <span class="kw">pub</span> <span class="ident">direction</span>: <span class="ident">u8</span>, + <span class="kw">pub</span> <span class="ident">size</span>: <span class="ident">u8</span>, + <span class="kw">pub</span> <span class="ident">port</span>: <span class="ident">u16</span>, + <span class="kw">pub</span> <span class="ident">count</span>: <span class="ident">u32</span>, + <span class="kw">pub</span> <span class="ident">data_offset</span>: <span class="ident">u64</span>, +} + +<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">C</span>)]</span> +<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Copy</span>, <span class="ident">Clone</span>, <span class="ident">Debug</span>)]</span> +<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct</span> <span class="ident">kvm_run_mmio</span> { + <span class="kw">pub</span> <span class="ident">phys_addr</span>: <span class="ident">u64</span>, + <span class="kw">pub</span> <span class="ident">data</span>: [<span class="ident">u8</span>; <span class="number">8</span>], + <span class="kw">pub</span> <span class="ident">len</span>: <span class="ident">u32</span>, + <span class="kw">pub</span> <span class="ident">is_write</span>: <span class="ident">u8</span>, +} + +<span class="comment">// Only add the union fields used here.</span> +<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">C</span>)]</span> +<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">union</span> <span class="ident">kvm_run_union</span> { + <span class="kw">pub</span> <span class="ident">io</span>: <span class="ident">kvm_run_io</span>, + <span class="kw">pub</span> <span class="ident">mmio</span>: <span class="ident">kvm_run_mmio</span>, + <span class="ident">padding</span>: [<span class="ident">u8</span>; <span class="number">256</span>], +} + +<span class="comment">// Only add the union fields used here.</span> +<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">C</span>)]</span> +<span class="ident">union</span> <span class="ident">kvm_run_union_s</span> { + <span class="ident">padding</span>: [<span class="ident">u8</span>; <span class="number">2048</span>], +} + +<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span> +<span class="kw">mod</span> <span class="ident">tests</span> { + <span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>; + <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">mem</span>; + + <span class="attribute">#[<span class="ident">test</span>]</span> + <span class="kw">fn</span> <span class="ident">check_kvm_regs</span>() { + <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">mem</span>::<span class="ident">size_of</span>::<span class="op"><</span><span class="ident">kvm_regs</span><span class="op">></span>(), <span class="ident">TEST_KVM_REGS_SIZE</span>); + <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">mem</span>::<span class="ident">align_of</span>::<span class="op"><</span><span class="ident">kvm_regs</span><span class="op">></span>(), <span class="ident">TEST_KVM_REGS_ALIGN</span>); + } + + <span class="attribute">#[<span class="ident">test</span>]</span> + <span class="kw">fn</span> <span class="ident">check_kvm_segment</span>() { + <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">mem</span>::<span class="ident">size_of</span>::<span class="op"><</span><span class="ident">kvm_segment</span><span class="op">></span>(), <span class="ident">TEST_KVM_SEGMENT_SIZE</span>); + <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">mem</span>::<span class="ident">align_of</span>::<span class="op"><</span><span class="ident">kvm_segment</span><span class="op">></span>(), <span class="ident">TEST_KVM_SEGMENT_ALIGN</span>); + } + + <span class="attribute">#[<span class="ident">test</span>]</span> + <span class="kw">fn</span> <span class="ident">check_kvm_dtable</span>() { + <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">mem</span>::<span class="ident">size_of</span>::<span class="op"><</span><span class="ident">kvm_dtable</span><span class="op">></span>(), <span class="ident">TEST_KVM_DTABLE_SIZE</span>); + <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">mem</span>::<span class="ident">align_of</span>::<span class="op"><</span><span class="ident">kvm_dtable</span><span class="op">></span>(), <span class="ident">TEST_KVM_DTABLE_ALIGN</span>); + } + + <span class="attribute">#[<span class="ident">test</span>]</span> + <span class="kw">fn</span> <span class="ident">check_kvm_sregs</span>() { + <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">mem</span>::<span class="ident">size_of</span>::<span class="op"><</span><span class="ident">kvm_sregs</span><span class="op">></span>(), <span class="ident">TEST_KVM_SREGS_SIZE</span>); + <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">mem</span>::<span class="ident">align_of</span>::<span class="op"><</span><span class="ident">kvm_sregs</span><span class="op">></span>(), <span class="ident">TEST_KVM_SREGS_ALIGN</span>); + <span class="macro">assert_eq</span><span class="macro">!</span>( + <span class="ident">mem</span>::<span class="ident">size_of_val</span>(<span class="kw-2">&</span><span class="ident">kvm_sregs</span>::<span class="ident">default</span>().<span class="ident">interrupt_bitmap</span>), + <span class="ident">TEST_KVM_SREGS_INTERRTUP_BITMAP_SIZE</span> + ); + } + + <span class="attribute">#[<span class="ident">test</span>]</span> + <span class="kw">fn</span> <span class="ident">check_kvm_userspace_memory_region</span>() { + <span class="macro">assert_eq</span><span class="macro">!</span>( + <span class="ident">mem</span>::<span class="ident">size_of</span>::<span class="op"><</span><span class="ident">kvm_userspace_memory_region</span><span class="op">></span>(), + <span class="ident">TEST_KVM_USERSPACE_MEMORY_REGION_SIZE</span> + ); + <span class="macro">assert_eq</span><span class="macro">!</span>( + <span class="ident">mem</span>::<span class="ident">align_of</span>::<span class="op"><</span><span class="ident">kvm_userspace_memory_region</span><span class="op">></span>(), + <span class="ident">TEST_KVM_USERSPACE_MEMORY_REGION_ALIGN</span> + ); + } + + <span class="attribute">#[<span class="ident">test</span>]</span> + <span class="kw">fn</span> <span class="ident">check_kvm_run</span>() { + <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">mem</span>::<span class="ident">size_of</span>::<span class="op"><</span><span class="ident">kvm_run</span><span class="op">></span>(), <span class="ident">TEST_KVM_RUN_SIZE</span>); + <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">mem</span>::<span class="ident">align_of</span>::<span class="op"><</span><span class="ident">kvm_run</span><span class="op">></span>(), <span class="ident">TEST_KVM_RUN_ALIGN</span>); + <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">mem</span>::<span class="ident">size_of</span>::<span class="op"><</span><span class="ident">kvm_run_io</span><span class="op">></span>(), <span class="ident">TEST_KVM_RUN_IO_SIZE</span>); + <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">mem</span>::<span class="ident">size_of</span>::<span class="op"><</span><span class="ident">kvm_run_mmio</span><span class="op">></span>(), <span class="ident">TEST_KVM_RUN_MMIO_SIZE</span>); + <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">mem</span>::<span class="ident">size_of</span>::<span class="op"><</span><span class="ident">kvm_run_union_s</span><span class="op">></span>(), <span class="ident">TEST_KVM_RUN_UNION_S_SIZE</span>); + } +} +</pre></div> +</section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="kvm_rs" data-search-js="../../search-index.js"></div> + <script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script></body></html>
\ No newline at end of file diff --git a/src/kvm_rs/lib.rs.html b/src/kvm_rs/lib.rs.html new file mode 100644 index 0000000..8d74487 --- /dev/null +++ b/src/kvm_rs/lib.rs.html @@ -0,0 +1,337 @@ +<!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="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg"> +<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"> +<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../../kvm_rs/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button> + <a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span> +<span id="2"> 2</span> +<span id="3"> 3</span> +<span id="4"> 4</span> +<span id="5"> 5</span> +<span id="6"> 6</span> +<span id="7"> 7</span> +<span id="8"> 8</span> +<span id="9"> 9</span> +<span id="10"> 10</span> +<span id="11"> 11</span> +<span id="12"> 12</span> +<span id="13"> 13</span> +<span id="14"> 14</span> +<span id="15"> 15</span> +<span id="16"> 16</span> +<span id="17"> 17</span> +<span id="18"> 18</span> +<span id="19"> 19</span> +<span id="20"> 20</span> +<span id="21"> 21</span> +<span id="22"> 22</span> +<span id="23"> 23</span> +<span id="24"> 24</span> +<span id="25"> 25</span> +<span id="26"> 26</span> +<span id="27"> 27</span> +<span id="28"> 28</span> +<span id="29"> 29</span> +<span id="30"> 30</span> +<span id="31"> 31</span> +<span id="32"> 32</span> +<span id="33"> 33</span> +<span id="34"> 34</span> +<span id="35"> 35</span> +<span id="36"> 36</span> +<span id="37"> 37</span> +<span id="38"> 38</span> +<span id="39"> 39</span> +<span id="40"> 40</span> +<span id="41"> 41</span> +<span id="42"> 42</span> +<span id="43"> 43</span> +<span id="44"> 44</span> +<span id="45"> 45</span> +<span id="46"> 46</span> +<span id="47"> 47</span> +<span id="48"> 48</span> +<span id="49"> 49</span> +<span id="50"> 50</span> +<span id="51"> 51</span> +<span id="52"> 52</span> +<span id="53"> 53</span> +<span id="54"> 54</span> +<span id="55"> 55</span> +<span id="56"> 56</span> +<span id="57"> 57</span> +<span id="58"> 58</span> +<span id="59"> 59</span> +<span id="60"> 60</span> +<span id="61"> 61</span> +<span id="62"> 62</span> +<span id="63"> 63</span> +<span id="64"> 64</span> +<span id="65"> 65</span> +<span id="66"> 66</span> +<span id="67"> 67</span> +<span id="68"> 68</span> +<span id="69"> 69</span> +<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> +</pre><div class="example-wrap"><pre class="rust "> +<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">convert</span>::{<span class="ident">AsMut</span>, <span class="ident">AsRef</span>}; +<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>; +<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ops</span>; +<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">os</span>::<span class="ident">unix</span>::<span class="ident">io</span>::<span class="ident">AsRawFd</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 < 0`.</span> +<span class="kw">fn</span> <span class="ident">libcret</span>(<span class="ident">ret</span>: <span class="ident">libc</span>::<span class="ident">c_int</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">libc</span>::<span class="ident">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</span>::<span class="ident">Error</span>::<span class="ident">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"><</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="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">libc</span>::<span class="ident">c_int</span><span class="op">></span> { + <span class="ident">libcret</span>(<span class="kw">unsafe</span> { <span class="ident">libc</span>::<span class="ident">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">*</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>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">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</span>::<span class="ident">mmap</span>( + <span class="ident">std</span>::<span class="ident">ptr</span>::<span class="ident">null_mut</span>(), + <span class="ident">len</span>, + <span class="ident">libc</span>::<span class="ident">PROT_READ</span> <span class="op">|</span> <span class="ident">libc</span>::<span class="ident">PROT_WRITE</span>, + <span class="ident">libc</span>::<span class="ident">MAP_PRIVATE</span> <span class="op">|</span> <span class="ident">libc</span>::<span class="ident">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="op">=</span> <span class="ident">libc</span>::<span class="ident">MAP_FAILED</span> { + <span class="prelude-val">Err</span>(<span class="ident">io</span>::<span class="ident">Error</span>::<span class="ident">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">&</span>[<span class="ident">u8</span>]) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">UserMem</span><span class="op">></span> { + <span class="macro">assert</span><span class="macro">!</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="kw">let</span> <span class="kw-2">mut</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">UserMem</span>::<span class="ident">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">&</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="macro">!</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="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</span>::<span class="ident">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">&</span><span class="kw-2">mut</span> <span class="self">self</span>) { + <span class="kw">unsafe</span> { <span class="ident">libc</span>::<span class="ident">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"><</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="op">-</span><span class="op">></span> <span class="kw-2">&</span>[<span class="ident">u8</span>] { + <span class="kw">unsafe</span> { <span class="ident">std</span>::<span class="ident">slice</span>::<span class="ident">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"><</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">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="ident">u8</span>] { + <span class="kw">unsafe</span> { <span class="ident">std</span>::<span class="ident">slice</span>::<span class="ident">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">*</span><span class="kw-2">mut</span> <span class="ident">kvm_sys</span>::<span class="ident">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"><</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="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">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</span>::<span class="ident">mmap</span>( + <span class="ident">std</span>::<span class="ident">ptr</span>::<span class="ident">null_mut</span>(), + <span class="ident">len</span>, + <span class="ident">libc</span>::<span class="ident">PROT_READ</span> <span class="op">|</span> <span class="ident">libc</span>::<span class="ident">PROT_WRITE</span>, + <span class="ident">libc</span>::<span class="ident">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="op">=</span> <span class="ident">libc</span>::<span class="ident">MAP_FAILED</span> { + <span class="prelude-val">Err</span>(<span class="ident">io</span>::<span class="ident">Error</span>::<span class="ident">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</span>::<span class="ident">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">&</span><span class="kw-2">mut</span> <span class="self">self</span>) { + <span class="kw">unsafe</span> { <span class="ident">libc</span>::<span class="ident">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"><</span><span class="ident">kvm_sys</span>::<span class="ident">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="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="ident">kvm_sys</span>::<span class="ident">kvm_run</span> { + <span class="kw">unsafe</span> { <span class="op">&</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">*</span><span class="kw">const</span> <span class="ident">kvm_sys</span>::<span class="ident">kvm_run</span>) } + } +} + +<span class="kw">impl</span> <span class="ident">AsMut</span><span class="op"><</span><span class="ident">kvm_sys</span>::<span class="ident">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">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">kvm_sys</span>::<span class="ident">kvm_run</span> { + <span class="kw">unsafe</span> { <span class="kw-2">&</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">*</span><span class="kw-2">mut</span> <span class="ident">kvm_sys</span>::<span class="ident">kvm_run</span>) } + } +} +</pre></div> +</section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="kvm_rs" data-search-js="../../search-index.js"></div> + <script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script></body></html>
\ No newline at end of file diff --git a/src/kvm_rs/vcpu.rs.html b/src/kvm_rs/vcpu.rs.html new file mode 100644 index 0000000..df4a7bc --- /dev/null +++ b/src/kvm_rs/vcpu.rs.html @@ -0,0 +1,279 @@ +<!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/vcpu.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>vcpu.rs - source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg"> +<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"> +<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../../kvm_rs/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button> + <a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span> +<span id="2"> 2</span> +<span id="3"> 3</span> +<span id="4"> 4</span> +<span id="5"> 5</span> +<span id="6"> 6</span> +<span id="7"> 7</span> +<span id="8"> 8</span> +<span id="9"> 9</span> +<span id="10"> 10</span> +<span id="11"> 11</span> +<span id="12"> 12</span> +<span id="13"> 13</span> +<span id="14"> 14</span> +<span id="15"> 15</span> +<span id="16"> 16</span> +<span id="17"> 17</span> +<span id="18"> 18</span> +<span id="19"> 19</span> +<span id="20"> 20</span> +<span id="21"> 21</span> +<span id="22"> 22</span> +<span id="23"> 23</span> +<span id="24"> 24</span> +<span id="25"> 25</span> +<span id="26"> 26</span> +<span id="27"> 27</span> +<span id="28"> 28</span> +<span id="29"> 29</span> +<span id="30"> 30</span> +<span id="31"> 31</span> +<span id="32"> 32</span> +<span id="33"> 33</span> +<span id="34"> 34</span> +<span id="35"> 35</span> +<span id="36"> 36</span> +<span id="37"> 37</span> +<span id="38"> 38</span> +<span id="39"> 39</span> +<span id="40"> 40</span> +<span id="41"> 41</span> +<span id="42"> 42</span> +<span id="43"> 43</span> +<span id="44"> 44</span> +<span id="45"> 45</span> +<span id="46"> 46</span> +<span id="47"> 47</span> +<span id="48"> 48</span> +<span id="49"> 49</span> +<span id="50"> 50</span> +<span id="51"> 51</span> +<span id="52"> 52</span> +<span id="53"> 53</span> +<span id="54"> 54</span> +<span id="55"> 55</span> +<span id="56"> 56</span> +<span id="57"> 57</span> +<span id="58"> 58</span> +<span id="59"> 59</span> +<span id="60"> 60</span> +<span id="61"> 61</span> +<span id="62"> 62</span> +<span id="63"> 63</span> +<span id="64"> 64</span> +<span id="65"> 65</span> +<span id="66"> 66</span> +<span id="67"> 67</span> +<span id="68"> 68</span> +<span id="69"> 69</span> +<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> +</pre><div class="example-wrap"><pre class="rust "> +<span class="doccomment">//! VCPU system ioctls.</span> + +<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fs</span>; +<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>; + +<span class="kw">use</span> <span class="kw">crate</span>::{<span class="ident">ioctl</span>, <span class="ident">kvm_sys</span>, <span class="ident">KvmRun</span>}; + +<span class="doccomment">/// Exit reasons for the [`Vcpu::kvm_run`][crate::vcpu::Vcpu::kvm_run] function.</span> +<span class="doccomment">///</span> +<span class="doccomment">/// Details for the different exit reasons can be found in the [`kvm_run`</span> +<span class="doccomment">/// structure][kvm-run-struct] description.</span> +<span class="doccomment">///</span> +<span class="doccomment">/// [kvm-run]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#kvm-run</span> +<span class="doccomment">/// [kvm-run-struct]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#the-kvm-run-structure</span> +<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">KvmExit</span><span class="op"><</span><span class="lifetime">'cpu</span><span class="op">></span> { + <span class="ident">Halt</span>, + <span class="ident">IoIn</span>(<span class="ident">u16</span>, <span class="kw-2">&</span><span class="lifetime">'cpu</span> <span class="kw-2">mut</span> [<span class="ident">u8</span>]), + <span class="ident">IoOut</span>(<span class="ident">u16</span>, <span class="kw-2">&</span><span class="lifetime">'cpu</span> [<span class="ident">u8</span>]), + <span class="ident">MmioRead</span>(<span class="ident">u64</span>, <span class="kw-2">&</span><span class="lifetime">'cpu</span> <span class="kw-2">mut</span> [<span class="ident">u8</span>]), + <span class="ident">MmioWrite</span>(<span class="ident">u64</span>, <span class="kw-2">&</span><span class="lifetime">'cpu</span> [<span class="ident">u8</span>]), +} + +<span class="doccomment">/// Wrapper for VCPU ioctls.</span> +<span class="doccomment">///</span> +<span class="doccomment">/// Representation of the file descriptor obtained by the [`KVM_CREATE_VCPU`][kvm-create-vcpu] ioctl.</span> +<span class="doccomment">/// This wrapper provides access to the `VCPU 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-vcpu]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#kvm-create-vcpu</span> +<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Vcpu</span> { + <span class="ident">vcpu</span>: <span class="ident">fs</span>::<span class="ident">File</span>, + <span class="ident">kvm_run</span>: <span class="ident">KvmRun</span>, +} + +<span class="kw">impl</span> <span class="ident">Vcpu</span> { + <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">vcpu</span>: <span class="ident">fs</span>::<span class="ident">File</span>, <span class="ident">kvm_run</span>: <span class="ident">KvmRun</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Vcpu</span> { + <span class="ident">Vcpu</span> { <span class="ident">vcpu</span>, <span class="ident">kvm_run</span> } + } + + <span class="doccomment">/// Get the general purpose registers with the [`KVM_GET_REGS`][kvm-get-regs] ioctl in form of</span> + <span class="doccomment">/// [`kvm_regs`](crate::kvm_sys::kvm_regs).</span> + <span class="doccomment">///</span> + <span class="doccomment">/// [kvm-get-regs]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#kvm-get-regs</span> + <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_regs</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">kvm_sys</span>::<span class="ident">kvm_regs</span><span class="op">></span> { + <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">regs</span> <span class="op">=</span> <span class="ident">kvm_sys</span>::<span class="ident">kvm_regs</span>::<span class="ident">default</span>(); + <span class="ident">ioctl</span>( + <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">vcpu</span>, + <span class="ident">kvm_sys</span>::<span class="ident">KVM_GET_REGS</span>, + <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">regs</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="kw">_</span> <span class="kw">as</span> <span class="ident">u64</span>, + )<span class="question-mark">?</span>; + <span class="prelude-val">Ok</span>(<span class="ident">regs</span>) + } + + <span class="doccomment">/// Set the general purpose registers with the [`KVM_SET_REGS`][kvm-set-regs] ioctl in form of</span> + <span class="doccomment">/// [`kvm_regs`](crate::kvm_sys::kvm_regs).</span> + <span class="doccomment">///</span> + <span class="doccomment">/// [kvm-set-regs]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#kvm-set-regs</span> + <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_regs</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">regs</span>: <span class="ident">kvm_sys</span>::<span class="ident">kvm_regs</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> { + <span class="ident">ioctl</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">vcpu</span>, <span class="ident">kvm_sys</span>::<span class="ident">KVM_SET_REGS</span>, <span class="kw-2">&</span><span class="ident">regs</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="kw">_</span> <span class="kw">as</span> <span class="ident">u64</span>).<span class="ident">map</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> ()) + } + + <span class="doccomment">/// Get the special registers with the [`KVM_GET_SREGS`][kvm-get-sregs] ioctl in form of</span> + <span class="doccomment">/// [`kvm_sregs`](crate::kvm_sys::kvm_sregs).</span> + <span class="doccomment">///</span> + <span class="doccomment">/// [kvm-get-sregs]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#kvm-get-sregs</span> + <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_sregs</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">kvm_sys</span>::<span class="ident">kvm_sregs</span><span class="op">></span> { + <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">sregs</span> <span class="op">=</span> <span class="ident">kvm_sys</span>::<span class="ident">kvm_sregs</span>::<span class="ident">default</span>(); + <span class="ident">ioctl</span>( + <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">vcpu</span>, + <span class="ident">kvm_sys</span>::<span class="ident">KVM_GET_SREGS</span>, + <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">sregs</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="kw">_</span> <span class="kw">as</span> <span class="ident">u64</span>, + )<span class="question-mark">?</span>; + <span class="prelude-val">Ok</span>(<span class="ident">sregs</span>) + } + + <span class="doccomment">/// Set the special registers with the [`KVM_SET_SREGS`][kvm-set-sregs] ioctl in form of</span> + <span class="doccomment">/// [`kvm_sregs`](crate::kvm_sys::kvm_sregs).</span> + <span class="doccomment">///</span> + <span class="doccomment">/// [kvm-set-sregs]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#kvm-set-sregs</span> + <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_sregs</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">sregs</span>: <span class="ident">kvm_sys</span>::<span class="ident">kvm_sregs</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> { + <span class="ident">ioctl</span>( + <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">vcpu</span>, + <span class="ident">kvm_sys</span>::<span class="ident">KVM_SET_SREGS</span>, + <span class="kw-2">&</span><span class="ident">sregs</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="kw">_</span> <span class="kw">as</span> <span class="ident">u64</span>, + ) + .<span class="ident">map</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> ()) + } + + <span class="doccomment">/// Run the guest VCPU with the [`KVM_RUN`][kvm-run] ioctl until it exits with one of the exit</span> + <span class="doccomment">/// reasons described in [`KvmExit`](crate::vcpu::KvmExit).</span> + <span class="doccomment">///</span> + <span class="doccomment">/// [kvm-run]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#kvm-run</span> + <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">run</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">KvmExit</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span><span class="op">></span> { + <span class="ident">ioctl</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">vcpu</span>, <span class="ident">kvm_sys</span>::<span class="ident">KVM_RUN</span>, <span class="number">0</span>)<span class="question-mark">?</span>; + + <span class="kw">let</span> <span class="ident">kvm_run</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">kvm_run</span>.<span class="ident">as_mut</span>(); + + <span class="kw">match</span> <span class="ident">kvm_run</span>.<span class="ident">exit_reason</span> <span class="kw">as</span> <span class="ident">u64</span> { + <span class="ident">kvm_sys</span>::<span class="ident">KVM_EXIT_HLT</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(<span class="ident">KvmExit</span>::<span class="ident">Halt</span>), + <span class="ident">kvm_sys</span>::<span class="ident">KVM_EXIT_IO</span> <span class="op">=</span><span class="op">></span> { + <span class="comment">// Safe to use union `io` field, as Kernel instructed us to.</span> + <span class="kw">let</span> <span class="ident">io</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">kvm_run</span>.<span class="ident">inner</span>.<span class="ident">io</span> }; + + <span class="kw">let</span> <span class="ident">kvm_run_ptr</span> <span class="op">=</span> <span class="ident">kvm_run</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">kvm_sys</span>::<span class="ident">kvm_run</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">u8</span>; + + <span class="comment">// Create IO buffer located at `kvm_run + io.offset`.</span> + <span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="kw">unsafe</span> { + <span class="ident">std</span>::<span class="ident">slice</span>::<span class="ident">from_raw_parts_mut</span>( + <span class="ident">kvm_run_ptr</span>.<span class="ident">offset</span>(<span class="ident">io</span>.<span class="ident">data_offset</span> <span class="kw">as</span> <span class="ident">isize</span>), + <span class="ident">io</span>.<span class="ident">count</span> <span class="comment">/* num blocks */</span> <span class="kw">as</span> <span class="ident">usize</span> <span class="op">*</span> <span class="ident">io</span>.<span class="ident">size</span> <span class="comment">/* bytes per block */</span> <span class="kw">as</span> <span class="ident">usize</span>, + ) + }; + + <span class="kw">match</span> <span class="ident">io</span>.<span class="ident">direction</span> <span class="kw">as</span> <span class="ident">u64</span> { + <span class="ident">kvm_sys</span>::<span class="ident">KVM_EXIT_IO_IN</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(<span class="ident">KvmExit</span>::<span class="ident">IoIn</span>(<span class="ident">io</span>.<span class="ident">port</span>, <span class="ident">data</span>)), + <span class="ident">kvm_sys</span>::<span class="ident">KVM_EXIT_IO_OUT</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(<span class="ident">KvmExit</span>::<span class="ident">IoOut</span>(<span class="ident">io</span>.<span class="ident">port</span>, <span class="ident">data</span>)), + <span class="kw">_</span> <span class="op">=</span><span class="op">></span> <span class="macro">unreachable</span><span class="macro">!</span>(), + } + } + <span class="ident">kvm_sys</span>::<span class="ident">KVM_EXIT_MMIO</span> <span class="op">=</span><span class="op">></span> { + <span class="comment">// Safe to use union `mmio` filed, as Kernel instructed us to.</span> + <span class="kw">let</span> <span class="ident">mmio</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">kvm_run</span>.<span class="ident">inner</span>.<span class="ident">mmio</span> }; + <span class="kw">let</span> <span class="ident">len</span> <span class="op">=</span> <span class="ident">mmio</span>.<span class="ident">len</span> <span class="kw">as</span> <span class="ident">usize</span>; + + <span class="kw">match</span> <span class="ident">mmio</span>.<span class="ident">is_write</span> { + <span class="number">0</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(<span class="ident">KvmExit</span>::<span class="ident">MmioRead</span>(<span class="ident">mmio</span>.<span class="ident">phys_addr</span>, <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">mmio</span>.<span class="ident">data</span>[..<span class="ident">len</span>])), + <span class="number">1</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(<span class="ident">KvmExit</span>::<span class="ident">MmioWrite</span>(<span class="ident">mmio</span>.<span class="ident">phys_addr</span>, <span class="kw-2">&</span><span class="ident">mmio</span>.<span class="ident">data</span>[..<span class="ident">len</span>])), + <span class="kw">_</span> <span class="op">=</span><span class="op">></span> <span class="macro">unreachable</span><span class="macro">!</span>(), + } + } + <span class="ident">r</span> @ <span class="kw">_</span> <span class="op">=</span><span class="op">></span> { + <span class="macro">todo</span><span class="macro">!</span>(<span class="string">"KVM_EXIT_... (exit_reason={}) not implemented!"</span>, <span class="ident">r</span>) + } + } + } +} +</pre></div> +</section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="kvm_rs" data-search-js="../../search-index.js"></div> + <script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script></body></html>
\ No newline at end of file diff --git a/src/kvm_rs/vm.rs.html b/src/kvm_rs/vm.rs.html new file mode 100644 index 0000000..94f2c10 --- /dev/null +++ b/src/kvm_rs/vm.rs.html @@ -0,0 +1,145 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/vm.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>vm.rs - source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg"> +<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"> +<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../../kvm_rs/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button> + <a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span> +<span id="2"> 2</span> +<span id="3"> 3</span> +<span id="4"> 4</span> +<span id="5"> 5</span> +<span id="6"> 6</span> +<span id="7"> 7</span> +<span id="8"> 8</span> +<span id="9"> 9</span> +<span id="10">10</span> +<span id="11">11</span> +<span id="12">12</span> +<span id="13">13</span> +<span id="14">14</span> +<span id="15">15</span> +<span id="16">16</span> +<span id="17">17</span> +<span id="18">18</span> +<span id="19">19</span> +<span id="20">20</span> +<span id="21">21</span> +<span id="22">22</span> +<span id="23">23</span> +<span id="24">24</span> +<span id="25">25</span> +<span id="26">26</span> +<span id="27">27</span> +<span id="28">28</span> +<span id="29">29</span> +<span id="30">30</span> +<span id="31">31</span> +<span id="32">32</span> +<span id="33">33</span> +<span id="34">34</span> +<span id="35">35</span> +<span id="36">36</span> +<span id="37">37</span> +<span id="38">38</span> +<span id="39">39</span> +<span id="40">40</span> +<span id="41">41</span> +<span id="42">42</span> +<span id="43">43</span> +<span id="44">44</span> +<span id="45">45</span> +<span id="46">46</span> +<span id="47">47</span> +<span id="48">48</span> +<span id="49">49</span> +<span id="50">50</span> +<span id="51">51</span> +<span id="52">52</span> +<span id="53">53</span> +<span id="54">54</span> +<span id="55">55</span> +<span id="56">56</span> +<span id="57">57</span> +<span id="58">58</span> +<span id="59">59</span> +<span id="60">60</span> +<span id="61">61</span> +<span id="62">62</span> +<span id="63">63</span> +<span id="64">64</span> +<span id="65">65</span> +<span id="66">66</span> +<span id="67">67</span> +<span id="68">68</span> +<span id="69">69</span> +</pre><div class="example-wrap"><pre class="rust "> +<span class="doccomment">//! VM system ioctls.</span> + +<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fs</span>; +<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>; +<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">os</span>::<span class="ident">unix</span>::<span class="ident">io</span>::<span class="ident">FromRawFd</span>; + +<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">vcpu</span>::<span class="ident">Vcpu</span>; +<span class="kw">use</span> <span class="kw">crate</span>::{<span class="ident">ioctl</span>, <span class="ident">kvm_sys</span>, <span class="ident">KvmRun</span>, <span class="ident">PhysAddr</span>, <span class="ident">UserMem</span>}; + +<span class="doccomment">/// Wrapper for VM ioctls.</span> +<span class="doccomment">///</span> +<span class="doccomment">/// Representation of the file descriptor obtained by the [`KVM_CREATE_VM`][kvm-create-vm] ioctl.</span> +<span class="doccomment">/// This wrapper provides access to the `VM ioctls` as described in [KVM API][kvm].</span> +<span class="doccomment">///</span> +<span class="doccomment">/// [kvm]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#general-description</span> +<span class="doccomment">/// [kvm-create-vm]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#kvm-create-vm</span> +<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Vm</span> { + <span class="ident">vm</span>: <span class="ident">fs</span>::<span class="ident">File</span>, + <span class="ident">vcpu_mmap_size</span>: <span class="ident">usize</span>, +} + +<span class="kw">impl</span> <span class="ident">Vm</span> { + <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">vm</span>: <span class="ident">fs</span>::<span class="ident">File</span>, <span class="ident">vcpu_mmap_size</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Vm</span> { + <span class="ident">Vm</span> { <span class="ident">vm</span>, <span class="ident">vcpu_mmap_size</span> } + } + + <span class="doccomment">/// Map memory from userspace into the VM as `guest physical` memory starting at address</span> + <span class="doccomment">/// `phys_addr`.</span> + <span class="doccomment">/// The underlying operation is the [`KVM_SET_USER_MEMORY_REGION`][kmv-set-user-memory-region]</span> + <span class="doccomment">/// ioctl.</span> + <span class="doccomment">///</span> + <span class="doccomment">/// # Safety</span> + <span class="doccomment">///</span> + <span class="doccomment">/// The `mem: &UserMem` argument passed to this function must at least live as long the `Vcpu`</span> + <span class="doccomment">/// instance.</span> + <span class="doccomment">///</span> + <span class="doccomment">/// [kvm-set-user-memory-region]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#kvm-set-user-memory-region</span> + <span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">set_user_memory_region</span>( + <span class="kw-2">&</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="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">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</span>::<span class="ident">kvm_userspace_memory_region</span>::<span class="ident">default</span>(); + <span class="ident">kvm_mem</span>.<span class="ident">userspace_addr</span> <span class="op">=</span> <span class="ident">mem</span>.<span class="ident">ptr</span> <span class="kw">as</span> <span class="ident">u64</span>; + <span class="ident">kvm_mem</span>.<span class="ident">memory_size</span> <span class="op">=</span> <span class="ident">mem</span>.<span class="ident">len</span> <span class="kw">as</span> <span class="ident">u64</span>; + <span class="ident">kvm_mem</span>.<span class="ident">guest_phys_addr</span> <span class="op">=</span> <span class="ident">phys_addr</span>.<span class="number">0</span>; + + <span class="ident">ioctl</span>( + <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">vm</span>, + <span class="ident">kvm_sys</span>::<span class="ident">KVM_SET_USER_MEMORY_REGION</span>, + <span class="kw-2">&</span><span class="ident">kvm_mem</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="kw">_</span> <span class="kw">as</span> <span class="ident">u64</span>, + ) + .<span class="ident">map</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> ()) + } + + <span class="doccomment">/// Create a new virtual cpu with the [`KVM_CREATE_VCPU`][kvm-create-vcpu] ioctl.</span> + <span class="doccomment">/// Returns a wrapper [`vcpu::Vcpu`][crate::vcpu::Vcpu] representing the VCPU.</span> + <span class="doccomment">///</span> + <span class="doccomment">/// [kvm-create-vcpu]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#kvm-create-vcpu</span> + <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">create_vpcu</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">id</span>: <span class="ident">u64</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io</span>::<span class="prelude-ty">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</span>::<span class="ident">KVM_CREATE_VCPU</span>, <span class="ident">id</span>) + .<span class="ident">map</span>(<span class="op">|</span><span class="ident">fd</span><span class="op">|</span> <span class="kw">unsafe</span> { <span class="ident">fs</span>::<span class="ident">File</span>::<span class="ident">from_raw_fd</span>(<span class="ident">fd</span>) })<span class="question-mark">?</span>; + + <span class="kw">let</span> <span class="ident">kvm_run</span> <span class="op">=</span> <span class="ident">KvmRun</span>::<span class="ident">new</span>(<span class="kw-2">&</span><span class="ident">vcpu</span>, <span class="self">self</span>.<span class="ident">vcpu_mmap_size</span>)<span class="question-mark">?</span>; + + <span class="prelude-val">Ok</span>(<span class="ident">Vcpu</span>::<span class="ident">new</span>(<span class="ident">vcpu</span>, <span class="ident">kvm_run</span>)) + } +} +</pre></div> +</section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="kvm_rs" data-search-js="../../search-index.js"></div> + <script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script></body></html>
\ No newline at end of file diff --git a/src/kvm_rs/x86_64.rs.html b/src/kvm_rs/x86_64.rs.html new file mode 100644 index 0000000..5671eba --- /dev/null +++ b/src/kvm_rs/x86_64.rs.html @@ -0,0 +1,315 @@ +<!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/x86_64.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>x86_64.rs - source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg"> +<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"> +<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../../kvm_rs/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button> + <a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span> +<span id="2"> 2</span> +<span id="3"> 3</span> +<span id="4"> 4</span> +<span id="5"> 5</span> +<span id="6"> 6</span> +<span id="7"> 7</span> +<span id="8"> 8</span> +<span id="9"> 9</span> +<span id="10"> 10</span> +<span id="11"> 11</span> +<span id="12"> 12</span> +<span id="13"> 13</span> +<span id="14"> 14</span> +<span id="15"> 15</span> +<span id="16"> 16</span> +<span id="17"> 17</span> +<span id="18"> 18</span> +<span id="19"> 19</span> +<span id="20"> 20</span> +<span id="21"> 21</span> +<span id="22"> 22</span> +<span id="23"> 23</span> +<span id="24"> 24</span> +<span id="25"> 25</span> +<span id="26"> 26</span> +<span id="27"> 27</span> +<span id="28"> 28</span> +<span id="29"> 29</span> +<span id="30"> 30</span> +<span id="31"> 31</span> +<span id="32"> 32</span> +<span id="33"> 33</span> +<span id="34"> 34</span> +<span id="35"> 35</span> +<span id="36"> 36</span> +<span id="37"> 37</span> +<span id="38"> 38</span> +<span id="39"> 39</span> +<span id="40"> 40</span> +<span id="41"> 41</span> +<span id="42"> 42</span> +<span id="43"> 43</span> +<span id="44"> 44</span> +<span id="45"> 45</span> +<span id="46"> 46</span> +<span id="47"> 47</span> +<span id="48"> 48</span> +<span id="49"> 49</span> +<span id="50"> 50</span> +<span id="51"> 51</span> +<span id="52"> 52</span> +<span id="53"> 53</span> +<span id="54"> 54</span> +<span id="55"> 55</span> +<span id="56"> 56</span> +<span id="57"> 57</span> +<span id="58"> 58</span> +<span id="59"> 59</span> +<span id="60"> 60</span> +<span id="61"> 61</span> +<span id="62"> 62</span> +<span id="63"> 63</span> +<span id="64"> 64</span> +<span id="65"> 65</span> +<span id="66"> 66</span> +<span id="67"> 67</span> +<span id="68"> 68</span> +<span id="69"> 69</span> +<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> +</pre><div class="example-wrap"><pre class="rust "> +<span class="doccomment">//! `x86_64` flags and bitfields.</span> + +<span class="comment">/* Rflags Register */</span> + +<span class="doccomment">/// Carry flag.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">RFLAGS_CF</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">0</span>; +<span class="doccomment">/// Parity flag.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">RFLAGS_PF</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">2</span>; +<span class="doccomment">/// Adjust flag.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">RFLAGS_AF</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">4</span>; +<span class="doccomment">/// Zero flag.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">RFLAGS_ZF</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">6</span>; +<span class="doccomment">/// Sign flag.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">RFLAGS_SF</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">7</span>; +<span class="doccomment">/// Sign flag.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">RFLAGS_IF</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">9</span>; +<span class="doccomment">/// Direction flag.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">RFLAGS_DF</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">10</span>; +<span class="doccomment">/// Overflow flag.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">RFLAGS_OF</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">11</span>; +<span class="doccomment">/// I/O privilege level.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">RFLAGS_IOPL</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">0b11</span> <span class="op"><</span><span class="op"><</span> <span class="number">12</span>; +<span class="doccomment">/// Alignment check.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">RFLAGS_AC</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">18</span>; + +<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">rflags_cf</span>(<span class="ident">r</span>: <span class="ident">u64</span>) <span class="op">-</span><span class="op">></span> <span class="ident">u64</span> { (<span class="ident">r</span> <span class="op">&</span> <span class="ident">RFLAGS_CF</span>) <span class="op">></span><span class="op">></span> <span class="number">0</span> } +<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">rflags_pf</span>(<span class="ident">r</span>: <span class="ident">u64</span>) <span class="op">-</span><span class="op">></span> <span class="ident">u64</span> { (<span class="ident">r</span> <span class="op">&</span> <span class="ident">RFLAGS_PF</span>) <span class="op">></span><span class="op">></span> <span class="number">2</span> } +<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">rflags_af</span>(<span class="ident">r</span>: <span class="ident">u64</span>) <span class="op">-</span><span class="op">></span> <span class="ident">u64</span> { (<span class="ident">r</span> <span class="op">&</span> <span class="ident">RFLAGS_AF</span>) <span class="op">></span><span class="op">></span> <span class="number">4</span> } +<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">rflags_zf</span>(<span class="ident">r</span>: <span class="ident">u64</span>) <span class="op">-</span><span class="op">></span> <span class="ident">u64</span> { (<span class="ident">r</span> <span class="op">&</span> <span class="ident">RFLAGS_ZF</span>) <span class="op">></span><span class="op">></span> <span class="number">6</span> } +<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">rflags_sf</span>(<span class="ident">r</span>: <span class="ident">u64</span>) <span class="op">-</span><span class="op">></span> <span class="ident">u64</span> { (<span class="ident">r</span> <span class="op">&</span> <span class="ident">RFLAGS_SF</span>) <span class="op">></span><span class="op">></span> <span class="number">7</span> } +<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">rflags_if</span>(<span class="ident">r</span>: <span class="ident">u64</span>) <span class="op">-</span><span class="op">></span> <span class="ident">u64</span> { (<span class="ident">r</span> <span class="op">&</span> <span class="ident">RFLAGS_IF</span>) <span class="op">></span><span class="op">></span> <span class="number">9</span> } +<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">rflags_df</span>(<span class="ident">r</span>: <span class="ident">u64</span>) <span class="op">-</span><span class="op">></span> <span class="ident">u64</span> { (<span class="ident">r</span> <span class="op">&</span> <span class="ident">RFLAGS_DF</span>) <span class="op">></span><span class="op">></span> <span class="number">10</span> } +<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">rflags_of</span>(<span class="ident">r</span>: <span class="ident">u64</span>) <span class="op">-</span><span class="op">></span> <span class="ident">u64</span> { (<span class="ident">r</span> <span class="op">&</span> <span class="ident">RFLAGS_OF</span>) <span class="op">></span><span class="op">></span> <span class="number">11</span> } +<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">rflags_iopl</span>(<span class="ident">r</span>: <span class="ident">u64</span>) <span class="op">-</span><span class="op">></span> <span class="ident">u64</span> { (<span class="ident">r</span> <span class="op">&</span> <span class="ident">RFLAGS_IOPL</span>) <span class="op">></span><span class="op">></span> <span class="number">12</span> } +<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">rflags_ac</span>(<span class="ident">r</span>: <span class="ident">u64</span>) <span class="op">-</span><span class="op">></span> <span class="ident">u64</span> { (<span class="ident">r</span> <span class="op">&</span> <span class="ident">RFLAGS_AC</span>) <span class="op">></span><span class="op">></span> <span class="number">18</span> } + +<span class="comment">/* Segment Selector */</span> + +<span class="doccomment">/// Requested privilege level.</span> +<span class="doccomment">///</span> +<span class="doccomment">/// Privilege level of the segment selector, where `0` is the most privileged mode and `3` the</span> +<span class="doccomment">/// least.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">SEG_SELECTOR_RPL</span> : <span class="ident">u16</span> <span class="op">=</span> <span class="number">0b11</span> <span class="op"><</span><span class="op"><</span> <span class="number">0</span>; +<span class="doccomment">/// Table indicator.</span> +<span class="doccomment">///</span> +<span class="doccomment">/// | TI | Table |</span> +<span class="doccomment">/// |----|-------|</span> +<span class="doccomment">/// | 0 | GDT |</span> +<span class="doccomment">/// | 1 | LDT |</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">SEG_SELECTOR_TI</span> : <span class="ident">u16</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">2</span>; +<span class="doccomment">/// Table index.</span> +<span class="doccomment">///</span> +<span class="doccomment">/// Index into the `GDT` or `LDT` table to select the segment descriptor. `GDT.base + 8 * index`</span> +<span class="doccomment">/// gives the address of the segment descriptor (times `8` because every segment descriptor is `8</span> +<span class="doccomment">/// byte`).</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">SEG_SELECTOR_INDEX</span> : <span class="ident">u16</span> <span class="op">=</span> <span class="number">0x1fff</span> <span class="op"><</span><span class="op"><</span> <span class="number">3</span>; + +<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">seg_selector_rpl</span>(<span class="ident">s</span> : <span class="ident">u16</span>) <span class="op">-</span><span class="op">></span> <span class="ident">u16</span> { (<span class="ident">s</span> <span class="op">&</span> <span class="ident">SEG_SELECTOR_RPL</span>) <span class="op">></span><span class="op">></span> <span class="number">0</span> } +<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">seg_selector_ti</span>(<span class="ident">s</span> : <span class="ident">u16</span>) <span class="op">-</span><span class="op">></span> <span class="ident">u16</span> { (<span class="ident">s</span> <span class="op">&</span> <span class="ident">SEG_SELECTOR_TI</span>) <span class="op">></span><span class="op">></span> <span class="number">2</span> } +<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">seg_selector_index</span>(<span class="ident">s</span> : <span class="ident">u16</span>) <span class="op">-</span><span class="op">></span> <span class="ident">u16</span> { (<span class="ident">s</span> <span class="op">&</span> <span class="ident">SEG_SELECTOR_INDEX</span>) <span class="op">></span><span class="op">></span> <span class="number">3</span> } + +<span class="comment">/* Control Register CR0 (operation mode & state of the processor) */</span> + +<span class="doccomment">/// Protection Enable.</span> +<span class="doccomment">///</span> +<span class="doccomment">/// Enables `protected mode` when set and `real-address mode` when cleared. This enables</span> +<span class="doccomment">/// `segment-level protection` not paging.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CR0_PE</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">0</span>; +<span class="doccomment">/// Monitor Coprocessor.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CR0_MP</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">1</span>; +<span class="doccomment">/// Emulation.</span> +<span class="doccomment">///</span> +<span class="doccomment">/// When set indicates the process does not have a FPU. FPU instructions will generate an exception</span> +<span class="doccomment">/// that software can emulate the instruction.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CR0_EM</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">2</span>; +<span class="doccomment">/// Task Switched.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CR0_TS</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">3</span>; +<span class="doccomment">/// Extension Type.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CR0_ET</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">4</span>; +<span class="doccomment">/// Numeric Error.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CR0_NE</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">5</span>; +<span class="doccomment">/// Write Protect.</span> +<span class="doccomment">///</span> +<span class="doccomment">/// When set supervisor-level procedures can't write to read-only pages.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CR0_WP</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">16</span>; +<span class="doccomment">/// Alignment Mask.</span> +<span class="doccomment">///</span> +<span class="doccomment">/// Enables alignment check for `CPL=3`, check is only done if the [AC</span> +<span class="doccomment">/// bit](crate::x86_64::RFLAGS_AC) of the `rflags` register ist set.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CR0_AM</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">18</span>; +<span class="doccomment">/// Not Write-Torugh.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CR0_NW</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">29</span>; +<span class="doccomment">/// Cachine disable.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CR0_CD</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">30</span>; +<span class="doccomment">/// Paging.</span> +<span class="doccomment">///</span> +<span class="doccomment">/// Enables paging when set, requires [CR0_PE](crate::x86_64::CR0_PE) to be set as well.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CR0_PG</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">31</span>; + +<span class="comment">/* Control Register CR3 (paging information) + * + * Holds the physical base address of the first paging structure. The 12 lower bytes of the base + * address are assumed to be 0 and hence the first paging structure must be aligned to a 4K + * boundary. + */</span> + +<span class="doccomment">/// Mask for physical base address of paging structure.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CR3_PAGE_BASE_MASK</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">0xffff_ffff_ffff_0000</span>; + +<span class="doccomment">/// Page-level Write-Through.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CR3_PWT</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">3</span>; +<span class="doccomment">/// Page-level Cache Disable.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CR3_PCD</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">4</span>; + +<span class="comment">/* Control Register CR4 (flags for arch extenstions processor capabilities) */</span> + +<span class="doccomment">/// Physical Address Extenstion.</span> +<span class="doccomment">///</span> +<span class="doccomment">/// When set enables paging to produce physicall addresses with more than 32 bits. Required before</span> +<span class="doccomment">/// entering `long mode`.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CR4_PAE</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">5</span>; +<span class="doccomment">/// 57-bit Linear Addresses.</span> +<span class="doccomment">///</span> +<span class="doccomment">/// When set in `long mode` enables `5-level` paging to translate `57-bit` linear addresses. When</span> +<span class="doccomment">/// cleared use `4-level` paging to translate `48-bit` linear addresses.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CR4_LA57</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">5</span>; + +<span class="comment">/* Extended Feature Enable Register (EFER) */</span> + +<span class="doccomment">/// Extended Feature Enable Register MSR number.</span> +<span class="doccomment">///</span> +<span class="doccomment">/// MSR number used with the [`rdmsr`][msr] and [`wrmsr`][msr] instructions to read/write the</span> +<span class="doccomment">/// `EFER` model specific register.</span> +<span class="doccomment">///</span> +<span class="doccomment">/// [msr]: https://johannst.github.io/notes/arch/x86_64.html#model-specific-register-msr</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">MSR_EFER</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">0xc000_0080</span>; + +<span class="doccomment">/// Long Mode Enable.</span> +<span class="doccomment">///</span> +<span class="doccomment">/// When set enables long mode operations.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">EFER_LME</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">8</span>; +<span class="doccomment">/// Long Mode Active (readonly).</span> +<span class="doccomment">///</span> +<span class="doccomment">/// When set indicates long mode is active.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">EFER_LMA</span>: <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">10</span>; + +<span class="comment">/* Paging */</span> + +<span class="doccomment">/// Page entry present.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">PAGE_ENTRY_PRESENT</span> : <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">0</span>; +<span class="doccomment">/// Page region read/write.</span> +<span class="doccomment">///</span> +<span class="doccomment">/// If set, region reference by paging entry is writeable.</span> +<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">PAGE_RENTRY_RW</span> : <span class="ident">u64</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">1</span>; +</pre></div> +</section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="kvm_rs" data-search-js="../../search-index.js"></div> + <script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script></body></html>
\ No newline at end of file |