<!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`."><title>vm.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-46132b98.css"><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.85.0 (4d91de4e4 2025-02-17)" data-channel="1.85.0" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../../static.files/src-script-56102188.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">kvm_rs/</div>vm.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><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></pre></div><pre class="rust"><code><span class="doccomment">//! VM 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>::vcpu::Vcpu;
<span class="kw">use crate</span>::{ioctl, kvm_sys, KvmRun, PhysAddr, UserMem};
<span class="doccomment">/// Wrapper for VM ioctls.
///
/// Representation of the file descriptor obtained by the [`KVM_CREATE_VM`][kvm-create-vm] ioctl.
/// This wrapper provides access to the `VM ioctls` as described in [KVM API][kvm].
///
/// [kvm]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#general-description
/// [kvm-create-vm]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#kvm-create-vm
</span><span class="kw">pub struct </span>Vm {
vm: fs::File,
vcpu_mmap_size: usize,
}
<span class="kw">impl </span>Vm {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(vm: fs::File, vcpu_mmap_size: usize) -> Vm {
Vm { vm, vcpu_mmap_size }
}
<span class="doccomment">/// Map memory from userspace into the VM as `guest physical` memory starting at address
/// `phys_addr`.
/// The underlying operation is the [`KVM_SET_USER_MEMORY_REGION`][kvm-set-user-memory-region]
/// ioctl.
///
/// # Safety
///
/// The `mem: &UserMem` argument passed to this function must at least live as long the `Vcpu`
/// instance.
///
/// [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 unsafe fn </span>set_user_memory_region(
<span class="kw-2">&</span><span class="self">self</span>,
phys_addr: PhysAddr,
mem: <span class="kw-2">&</span>UserMem,
) -> io::Result<()> {
<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>kvm_mem = kvm_sys::kvm_userspace_memory_region::default();
kvm_mem.userspace_addr = mem.ptr <span class="kw">as </span>u64;
kvm_mem.memory_size = mem.len <span class="kw">as </span>u64;
kvm_mem.guest_phys_addr = phys_addr.<span class="number">0</span>;
ioctl(
<span class="kw-2">&</span><span class="self">self</span>.vm,
kvm_sys::KVM_SET_USER_MEMORY_REGION,
<span class="kw-2">&</span>kvm_mem <span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_ as </span>u64,
)
.map(|<span class="kw">_</span>| ())
}
<span class="doccomment">/// Create a new virtual cpu with the [`KVM_CREATE_VCPU`][kvm-create-vcpu] ioctl.
/// Returns a wrapper [`vcpu::Vcpu`][crate::vcpu::Vcpu] representing the VCPU.
///
/// [kvm-create-vcpu]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#kvm-create-vcpu
</span><span class="kw">pub fn </span>create_vpcu(<span class="kw-2">&</span><span class="self">self</span>, id: u64) -> io::Result<Vcpu> {
<span class="kw">let </span>vcpu = ioctl(<span class="kw-2">&</span><span class="self">self</span>.vm, kvm_sys::KVM_CREATE_VCPU, id)
.map(|fd| <span class="kw">unsafe </span>{ fs::File::from_raw_fd(fd) })<span class="question-mark">?</span>;
<span class="kw">let </span>kvm_run = KvmRun::new(<span class="kw-2">&</span>vcpu, <span class="self">self</span>.vcpu_mmap_size)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(Vcpu::new(vcpu, kvm_run))
}
}
</code></pre></div></section></main></body></html>