aboutsummaryrefslogblamecommitdiffhomepage
path: root/src/kvm_rs/kvm.rs.html
blob: 557c8d0621403978e8395ce33606d5f37224a0f4 (plain) (tree)









































































                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          
 


                                                         
 


                                                                                  
 







                                                                                       

 




                                                                                                                          
          
                                                                                                                    
 
                                              


                                                                                                                                               
 
                                                        

     

                                                                                                                                                                                                  

     






                                                                                                                                                                                                                      
 
                                                                                                                                             
 
                                                                        

     





                                                                                                                                                             
 
                                                                                                                                                            

     





                                                                                                                                                             
 
                                                    

     
                                                 
<!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`."><title>kvm.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-cb6f1f67f1bcd037.css" id="mainThemeStyle"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="kvm_rs" data-themes="" data-resource-suffix="" data-rustdoc-version="1.73.0 (cc66ad468 2023-10-03)" data-channel="1.73.0" data-search-js="search-6dfdfced5eff6596.js" data-settings-js="settings-de11bff964e9d4e5.js" data-settings-css="settings-8c76f75bfb6bd192.css" data-theme-light-css="light-1596385f77d47ef2.css" data-theme-dark-css="dark-0a43001d3fc2282c.css" data-theme-ayu-css="ayu-fd19013d6ce078bf.css" ><script src="../../static.files/storage-db41da1a38ea3cb8.js"></script><script defer src="../../static.files/src-script-3280b574d94e47b4.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-0795b7d26be81095.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../../static.files/light-1596385f77d47ef2.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../../static.files/dark-0a43001d3fc2282c.css"><link rel="stylesheet" href="../../static.files/noscript-cffde32267a19fd6.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><nav class="sub"><a class="sub-logo-container" href="../../kvm_rs/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
</pre></div><pre class="rust"><code><span class="doccomment">//! KVM system ioctls.

</span><span class="kw">use </span>std::fs;
<span class="kw">use </span>std::io;
<span class="kw">use </span>std::os::unix::io::FromRawFd;

<span class="kw">use </span><span class="kw">crate</span>::cap::{CapBool, CapInt};
<span class="kw">use </span><span class="kw">crate</span>::vm::Vm;
<span class="kw">use crate</span>::{ioctl, kvm_sys, libcret};

<span class="doccomment">/// Wrapper for `/dev/kvm` ioctls.
///
/// Representation of the file descriptor obtained by opening `/dev/kvm`.
/// This wrapper provides access to the `system ioctls` as described in [KVM API][kvm].
///
/// [kvm]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#general-description
</span><span class="kw">pub struct </span>Kvm {
    kvm: fs::File,
}

<span class="kw">impl </span>Kvm {
    <span class="doccomment">/// Open the `/dev/kvm` device.
    </span><span class="kw">pub fn </span>new() -&gt; io::Result&lt;Kvm&gt; {
        <span class="kw">let </span>kvm = libcret(<span class="kw">unsafe </span>{
            libc::open(<span class="string">&quot;/dev/kvm\0&quot;</span>.as_ptr().cast(), libc::O_RDWR | libc::O_CLOEXEC)
        })
        .map(|fd| <span class="kw">unsafe </span>{ fs::File::from_raw_fd(fd) })<span class="question-mark">?</span>;

        <span class="macro">assert_eq!</span>(
            kvm_sys::KVM_API_VERSION,
            ioctl(<span class="kw-2">&amp;</span>kvm, kvm_sys::KVM_GET_API_VERSION, <span class="number">0</span>)<span class="question-mark">?
        </span>);

        <span class="prelude-val">Ok</span>(Kvm { kvm })
    }

    <span class="kw">fn </span>get_vpcu_mmap_size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;usize&gt; {
        ioctl(<span class="kw-2">&amp;</span><span class="self">self</span>.kvm, kvm_sys::KVM_GET_VCPU_MMAP_SIZE, <span class="number">0</span>).map(|size| size <span class="kw">as </span>usize)
    }

    <span class="doccomment">/// Create a new virtual machine with the [`KVM_CREATE_VM`][kvm-create-vm] ioctl.
    /// Returns a wrapper [`vm::Vm`][crate::vm::Vm] representing the VM.
    ///
    /// [kvm-create-vm]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#kvm-create-vm
    </span><span class="kw">pub fn </span>create_vm(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;Vm&gt; {
        <span class="kw">let </span>vm = ioctl(<span class="kw-2">&amp;</span><span class="self">self</span>.kvm, kvm_sys::KVM_CREATE_VM, <span class="number">0 </span><span class="comment">/* machine id */</span>)
            .map(|fd| <span class="kw">unsafe </span>{ fs::File::from_raw_fd(fd) })<span class="question-mark">?</span>;

        <span class="kw">let </span>vcpu_mmap_size = <span class="self">self</span>.get_vpcu_mmap_size()<span class="question-mark">?</span>;

        <span class="prelude-val">Ok</span>(Vm::new(vm, vcpu_mmap_size))
    }

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

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

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

        ret.unwrap_or(<span class="number">0</span>)
    }
}
</code></pre></div></section></main></body></html>