aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/kvm_rs/kvm.rs.html
blob: 5e4b2f57a2f536de0bb407d74046b561a2236748 (plain) (blame)
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
<!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="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">&#9776;</button><a class="sidebar-logo" href="../../kvm_rs/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
        </a><h2 class="location"></h2>
    </nav>
    <nav class="sidebar"><a class="sidebar-logo" href="../../kvm_rs/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
        </a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../kvm_rs/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><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>
</pre><pre class="rust"><code><span class="doccomment">//! KVM 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="ident">std::os::unix::io::FromRawFd</span>;

<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::cap</span>::{<span class="ident">CapBool</span>, <span class="ident">CapInt</span>};
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::vm::Vm</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">libcret</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::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>() -&gt; <span class="ident">io::Result</span><span class="op">&lt;</span><span class="ident">Kvm</span><span class="op">&gt;</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::open</span>(<span class="string">&quot;/dev/kvm\0&quot;</span>.<span class="ident">as_ptr</span>().<span class="ident">cast</span>(), <span class="ident">libc::O_RDWR</span> <span class="op">|</span> <span class="ident">libc::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::File::from_raw_fd</span>(<span class="ident">fd</span>) })<span class="question-mark">?</span>;

        <span class="macro">assert_eq!</span>(
            <span class="ident">kvm_sys::KVM_API_VERSION</span>,
            <span class="ident">ioctl</span>(<span class="kw-2">&amp;</span><span class="ident">kvm</span>, <span class="ident">kvm_sys::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">&amp;</span><span class="self">self</span>) -&gt; <span class="ident">io::Result</span><span class="op">&lt;</span><span class="ident">usize</span><span class="op">&gt;</span> {
        <span class="ident">ioctl</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">kvm</span>, <span class="ident">kvm_sys::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">&amp;</span><span class="self">self</span>) -&gt; <span class="ident">io::Result</span><span class="op">&lt;</span><span class="ident">Vm</span><span class="op">&gt;</span> {
        <span class="kw">let</span> <span class="ident">vm</span> <span class="op">=</span> <span class="ident">ioctl</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">kvm</span>, <span class="ident">kvm_sys::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::File::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::new</span>(<span class="ident">vm</span>, <span class="ident">vcpu_mmap_size</span>))
    }

    <span class="doccomment">/// Check availability of an extension with the [`KVM_CHECK_EXTENSION`][kvm-check-extension]</span>
    <span class="doccomment">/// ioctl.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// [kvm-check-extension]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#kvm-check-extension</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">check_extenstion</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">cap</span>: <span class="ident">CapBool</span>) -&gt; <span class="ident">bool</span> {
        <span class="kw">let</span> <span class="ident">ret</span> <span class="op">=</span> <span class="ident">ioctl</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">kvm</span>, <span class="ident">kvm_sys::KVM_CHECK_EXTENSION</span>, <span class="ident">cap</span>.<span class="ident">into</span>());

        <span class="macro">matches!</span>(<span class="ident">ret</span>, <span class="prelude-val">Ok</span>(<span class="ident">ret</span>) <span class="kw">if</span> <span class="ident">ret</span> <span class="op">&gt;</span> <span class="number">0</span>)
    }

    <span class="doccomment">/// Check availability of an extension with the [`KVM_CHECK_EXTENSION`][kvm-check-extension]</span>
    <span class="doccomment">/// ioctl.</span>
    <span class="doccomment">///</span>
    <span class="doccomment">/// [kvm-check-extension]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#kvm-check-extension</span>
    <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">check_extenstion_int</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">cap</span>: <span class="ident">CapInt</span>) -&gt; <span class="ident">i32</span> {
        <span class="kw">let</span> <span class="ident">ret</span> <span class="op">=</span> <span class="ident">ioctl</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">kvm</span>, <span class="ident">kvm_sys::KVM_CHECK_EXTENSION</span>, <span class="ident">cap</span>.<span class="ident">into</span>());

        <span class="ident">ret</span>.<span class="ident">unwrap_or</span>(<span class="number">0</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>