diff options
Diffstat (limited to 'src/kvm_rs/kvm.rs.html')
| -rw-r--r-- | src/kvm_rs/kvm.rs.html | 82 |
1 files changed, 62 insertions, 20 deletions
diff --git a/src/kvm_rs/kvm.rs.html b/src/kvm_rs/kvm.rs.html index ccd6c37..43a3f1e 100644 --- a/src/kvm_rs/kvm.rs.html +++ b/src/kvm_rs/kvm.rs.html @@ -1,6 +1,6 @@ <!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> +<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 11]><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><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> @@ -53,15 +53,37 @@ <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><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="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="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="kw">use</span> <span class="kw">crate</span><span class="ident">::cap</span>::{<span class="ident">CapBool</span>, <span class="ident">CapInt</span>}; +<span class="kw">use</span> <span class="kw">crate</span><span class="ident">::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> @@ -70,42 +92,62 @@ <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="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>() <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">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-</span><span class="op">></span> <span class="ident">io::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">libc::open</span>(<span class="string">"/dev/kvm\0"</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</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="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="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="macro">assert_eq!</span>( + <span class="ident">kvm_sys::KVM_API_VERSION</span>, + <span class="ident">ioctl</span>(<span class="kw-2">&</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">&</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="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::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::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">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::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::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</span>::<span class="ident">new</span>(<span class="ident">vm</span>, <span class="ident">vcpu_mmap_size</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">&</span><span class="self">self</span>, <span class="ident">cap</span>: <span class="ident">CapBool</span>) <span class="op">-</span><span class="op">></span> <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">&</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">></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">&</span><span class="self">self</span>, <span class="ident">cap</span>: <span class="ident">CapInt</span>) <span class="op">-</span><span class="op">></span> <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">&</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>) } } </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> +</section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="kvm_rs" data-search-index-js="../../search-index.js" data-search-js="../../search.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 |