1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
|
<!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="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.js"></script><script defer src="../../main.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script>
<noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../kvm_rs/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"></h2>
</nav>
<nav class="sidebar"><a class="sidebar-logo" href="../../kvm_rs/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
</a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../kvm_rs/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
</pre><pre class="rust"><code><span class="doccomment">//! VCPU system ioctls.</span>
<span class="kw">use</span> <span class="ident">std::fs</span>;
<span class="kw">use</span> <span class="ident">std::io</span>;
<span class="kw">use</span> <span class="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::run`][crate::vcpu::Vcpu::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::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::File</span>, <span class="ident">kvm_run</span>: <span class="ident">KvmRun</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="ident">io::Result</span><span class="op"><</span><span class="ident">kvm_sys::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::kvm_regs::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::KVM_GET_REGS</span>,
<span class="kw-2">&mut</span> <span class="ident">regs</span> <span class="kw">as</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::kvm_regs</span>) -> <span class="ident">io::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::KVM_SET_REGS</span>, <span class="kw-2">&</span><span class="ident">regs</span> <span class="kw">as</span> <span class="kw-2">*const</span> <span class="kw">_</span> <span class="kw">as</span> <span class="ident">u64</span>).<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="ident">io::Result</span><span class="op"><</span><span class="ident">kvm_sys::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::kvm_sregs::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::KVM_GET_SREGS</span>,
<span class="kw-2">&mut</span> <span class="ident">sregs</span> <span class="kw">as</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::kvm_sregs</span>) -> <span class="ident">io::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::KVM_SET_SREGS</span>,
<span class="kw-2">&</span><span class="ident">sregs</span> <span class="kw">as</span> <span class="kw-2">*const</span> <span class="kw">_</span> <span class="kw">as</span> <span class="ident">u64</span>,
)
.<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">&mut</span> <span class="self">self</span>) -> <span class="ident">io::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::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::KVM_EXIT_HLT</span> => <span class="prelude-val">Ok</span>(<span class="ident">KvmExit::Halt</span>),
<span class="ident">kvm_sys::KVM_EXIT_IO</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">*mut</span> <span class="ident">kvm_sys::kvm_run</span> <span class="kw">as</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::slice::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::KVM_EXIT_IO_IN</span> => <span class="prelude-val">Ok</span>(<span class="ident">KvmExit::IoIn</span>(<span class="ident">io</span>.<span class="ident">port</span>, <span class="ident">data</span>)),
<span class="ident">kvm_sys::KVM_EXIT_IO_OUT</span> => <span class="prelude-val">Ok</span>(<span class="ident">KvmExit::IoOut</span>(<span class="ident">io</span>.<span class="ident">port</span>, <span class="ident">data</span>)),
<span class="kw">_</span> => <span class="macro">unreachable!</span>(),
}
}
<span class="ident">kvm_sys::KVM_EXIT_MMIO</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">&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="prelude-val">Ok</span>(<span class="ident">KvmExit::MmioRead</span>(<span class="ident">mmio</span>.<span class="ident">phys_addr</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="prelude-val">Ok</span>(<span class="ident">KvmExit::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="macro">unreachable!</span>(),
}
}
<span class="ident">r</span> @ <span class="kw">_</span> => {
<span class="macro">todo!</span>(<span class="string">"KVM_EXIT_... (exit_reason={}) not implemented!"</span>, <span class="ident">r</span>)
}
}
}
}
</code></pre></div>
</section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="kvm_rs" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.60.0 (7737e0b5c 2022-04-04)" ></div>
</body></html>
|
