diff options
Diffstat (limited to 'src/kvm_rs/lib.rs.html')
| -rw-r--r-- | src/kvm_rs/lib.rs.html | 53 |
1 files changed, 28 insertions, 25 deletions
diff --git a/src/kvm_rs/lib.rs.html b/src/kvm_rs/lib.rs.html index da6a425..7124c68 100644 --- a/src/kvm_rs/lib.rs.html +++ b/src/kvm_rs/lib.rs.html @@ -1,6 +1,9 @@ -<!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/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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 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" title="themes"><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" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1"> 1</span> +<!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/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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> @@ -166,8 +169,7 @@ <span id="164">164</span> <span id="165">165</span> <span id="166">166</span> -</pre><pre class="rust"> -<span class="kw">use</span> <span class="ident">std::convert</span>::{<span class="ident">AsMut</span>, <span class="ident">AsRef</span>}; +</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">std::convert</span>::{<span class="ident">AsMut</span>, <span class="ident">AsRef</span>}; <span class="kw">use</span> <span class="ident">std::io</span>; <span class="kw">use</span> <span class="ident">std::ops</span>; <span class="kw">use</span> <span class="ident">std::os::unix::io::AsRawFd</span>; @@ -185,7 +187,7 @@ <span class="doccomment">/// Helper to turn libc return values into an [io::Result](std::io::Result). Returns</span> <span class="doccomment">/// [`Error::last_os_error`](std::io::Error::last_os_error) if `ret < 0`.</span> -<span class="kw">fn</span> <span class="ident">libcret</span>(<span class="ident">ret</span>: <span class="ident">libc::c_int</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io::Result</span><span class="op"><</span><span class="ident">libc::c_int</span><span class="op">></span> { +<span class="kw">fn</span> <span class="ident">libcret</span>(<span class="ident">ret</span>: <span class="ident">libc::c_int</span>) -> <span class="ident">io::Result</span><span class="op"><</span><span class="ident">libc::c_int</span><span class="op">></span> { <span class="kw">if</span> <span class="ident">ret</span> <span class="op"><</span> <span class="number">0</span> { <span class="prelude-val">Err</span>(<span class="ident">io::Error::last_os_error</span>()) } <span class="kw">else</span> { @@ -195,7 +197,7 @@ <span class="doccomment">/// Wrapper of `libc::ioctl` for KVM ioctls with one argument and returning an</span> <span class="doccomment">/// [`io::Result`](std::io::Result).</span> -<span class="kw">fn</span> <span class="ident">ioctl</span><span class="op"><</span><span class="ident">F</span>: <span class="ident">AsRawFd</span><span class="op">></span>(<span class="ident">fd</span>: <span class="kw-2">&</span><span class="ident">F</span>, <span class="ident">cmd</span>: <span class="ident">u64</span>, <span class="ident">arg</span>: <span class="ident">u64</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io::Result</span><span class="op"><</span><span class="ident">libc::c_int</span><span class="op">></span> { +<span class="kw">fn</span> <span class="ident">ioctl</span><span class="op"><</span><span class="ident">F</span>: <span class="ident">AsRawFd</span><span class="op">></span>(<span class="ident">fd</span>: <span class="kw-2">&</span><span class="ident">F</span>, <span class="ident">cmd</span>: <span class="ident">u64</span>, <span class="ident">arg</span>: <span class="ident">u64</span>) -> <span class="ident">io::Result</span><span class="op"><</span><span class="ident">libc::c_int</span><span class="op">></span> { <span class="ident">libcret</span>(<span class="kw">unsafe</span> { <span class="ident">libc::ioctl</span>(<span class="ident">fd</span>.<span class="ident">as_raw_fd</span>(), <span class="ident">cmd</span>, <span class="ident">arg</span>) }) } @@ -206,13 +208,13 @@ <span class="doccomment">/// Memory can be mapped into a guest VM with</span> <span class="doccomment">/// [`Vm::set_user_memory_region`](crate::vm::Vm::set_user_memory_region).</span> <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">UserMem</span> { - <span class="ident">ptr</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">u8</span>, + <span class="ident">ptr</span>: <span class="kw-2">*mut</span> <span class="ident">u8</span>, <span class="ident">len</span>: <span class="ident">usize</span>, } <span class="kw">impl</span> <span class="ident">UserMem</span> { <span class="doccomment">/// Allocate a zero-initialized memory region of `len` bytes.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">len</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io::Result</span><span class="op"><</span><span class="ident">UserMem</span><span class="op">></span> { + <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">len</span>: <span class="ident">usize</span>) -> <span class="ident">io::Result</span><span class="op"><</span><span class="ident">UserMem</span><span class="op">></span> { <span class="kw">let</span> <span class="ident">ptr</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">libc::mmap</span>( <span class="ident">std::ptr::null_mut</span>(), @@ -224,7 +226,7 @@ ) }; - <span class="kw">if</span> <span class="ident">ptr</span> <span class="op">=</span><span class="op">=</span> <span class="ident">libc::MAP_FAILED</span> { + <span class="kw">if</span> <span class="ident">ptr</span> <span class="op">==</span> <span class="ident">libc::MAP_FAILED</span> { <span class="prelude-val">Err</span>(<span class="ident">io::Error::last_os_error</span>()) } <span class="kw">else</span> { <span class="prelude-val">Ok</span>(<span class="ident">UserMem</span> { @@ -240,7 +242,7 @@ <span class="doccomment">/// # Panics</span> <span class="doccomment">///</span> <span class="doccomment">/// Panics if `init_from` is larger than the memory size `len`.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_init</span>(<span class="ident">len</span>: <span class="ident">usize</span>, <span class="ident">init_from</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>]) <span class="op">-</span><span class="op">></span> <span class="ident">io::Result</span><span class="op"><</span><span class="ident">UserMem</span><span class="op">></span> { + <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_init</span>(<span class="ident">len</span>: <span class="ident">usize</span>, <span class="ident">init_from</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>]) -> <span class="ident">io::Result</span><span class="op"><</span><span class="ident">UserMem</span><span class="op">></span> { <span class="macro">assert!</span>(<span class="ident">len</span> <span class="op">></span><span class="op">=</span> <span class="ident">init_from</span>.<span class="ident">len</span>()); <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">m</span> <span class="op">=</span> <span class="ident">UserMem::new</span>(<span class="ident">len</span>)<span class="question-mark">?</span>; @@ -253,7 +255,7 @@ <span class="doccomment">/// # Panics</span> <span class="doccomment">///</span> <span class="doccomment">/// Panics if `addr + data.len` is larger than the memory size `len`.</span> - <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">load</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">addr</span>: <span class="ident">PhysAddr</span>, <span class="ident">data</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>]) { + <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">load</span>(<span class="kw-2">&mut</span> <span class="self">self</span>, <span class="ident">addr</span>: <span class="ident">PhysAddr</span>, <span class="ident">data</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>]) { <span class="macro">assert!</span>(<span class="self">self</span>.<span class="ident">len</span> <span class="op">></span><span class="op">=</span> <span class="ident">addr</span>.<span class="number">0</span> <span class="kw">as</span> <span class="ident">usize</span> <span class="op">+</span> <span class="ident">data</span>.<span class="ident">len</span>()); <span class="kw">let</span> <span class="ident">addr</span> <span class="op">=</span> <span class="ident">addr</span>.<span class="number">0</span> <span class="kw">as</span> <span class="ident">usize</span>; @@ -263,19 +265,19 @@ <span class="kw">impl</span> <span class="ident">ops::Drop</span> <span class="kw">for</span> <span class="ident">UserMem</span> { <span class="doccomment">/// Free underlying memory.</span> - <span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) { + <span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&mut</span> <span class="self">self</span>) { <span class="kw">unsafe</span> { <span class="ident">libc::munmap</span>(<span class="self">self</span>.<span class="ident">ptr</span>.<span class="ident">cast</span>(), <span class="self">self</span>.<span class="ident">len</span>) }; } } <span class="kw">impl</span> <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">u8</span>]<span class="op">></span> <span class="kw">for</span> <span class="ident">UserMem</span> { - <span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span>[<span class="ident">u8</span>] { + <span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[<span class="ident">u8</span>] { <span class="kw">unsafe</span> { <span class="ident">std::slice::from_raw_parts</span>(<span class="self">self</span>.<span class="ident">ptr</span>, <span class="self">self</span>.<span class="ident">len</span>) } } } <span class="kw">impl</span> <span class="ident">AsMut</span><span class="op"><</span>[<span class="ident">u8</span>]<span class="op">></span> <span class="kw">for</span> <span class="ident">UserMem</span> { - <span class="kw">fn</span> <span class="ident">as_mut</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="ident">u8</span>] { + <span class="kw">fn</span> <span class="ident">as_mut</span>(<span class="kw-2">&mut</span> <span class="self">self</span>) -> <span class="kw-2">&mut</span> [<span class="ident">u8</span>] { <span class="kw">unsafe</span> { <span class="ident">std::slice::from_raw_parts_mut</span>(<span class="self">self</span>.<span class="ident">ptr</span>, <span class="self">self</span>.<span class="ident">len</span>) } } } @@ -285,14 +287,14 @@ <span class="doccomment">///</span> <span class="doccomment">/// [kvm_run]: https://www.kernel.org/doc/html/latest/virt/kvm/api.html#the-kvm-run-structure</span> <span class="kw">struct</span> <span class="ident">KvmRun</span> { - <span class="ident">ptr</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">kvm_sys::kvm_run</span>, + <span class="ident">ptr</span>: <span class="kw-2">*mut</span> <span class="ident">kvm_sys::kvm_run</span>, <span class="ident">len</span>: <span class="ident">usize</span>, } <span class="kw">impl</span> <span class="ident">KvmRun</span> { <span class="doccomment">/// Mmap the `struct kvm_run` for a given `VCPU` referenced by the argument file descriptor</span> <span class="doccomment">/// `vcpu`.</span> - <span class="kw">fn</span> <span class="ident">new</span><span class="op"><</span><span class="ident">F</span>: <span class="ident">AsRawFd</span><span class="op">></span>(<span class="ident">vcpu</span>: <span class="kw-2">&</span><span class="ident">F</span>, <span class="ident">len</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="ident">io::Result</span><span class="op"><</span><span class="ident">KvmRun</span><span class="op">></span> { + <span class="kw">fn</span> <span class="ident">new</span><span class="op"><</span><span class="ident">F</span>: <span class="ident">AsRawFd</span><span class="op">></span>(<span class="ident">vcpu</span>: <span class="kw-2">&</span><span class="ident">F</span>, <span class="ident">len</span>: <span class="ident">usize</span>) -> <span class="ident">io::Result</span><span class="op"><</span><span class="ident">KvmRun</span><span class="op">></span> { <span class="kw">let</span> <span class="ident">ptr</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">libc::mmap</span>( <span class="ident">std::ptr::null_mut</span>(), @@ -304,7 +306,7 @@ ) }; - <span class="kw">if</span> <span class="ident">ptr</span> <span class="op">=</span><span class="op">=</span> <span class="ident">libc::MAP_FAILED</span> { + <span class="kw">if</span> <span class="ident">ptr</span> <span class="op">==</span> <span class="ident">libc::MAP_FAILED</span> { <span class="prelude-val">Err</span>(<span class="ident">io::Error::last_os_error</span>()) } <span class="kw">else</span> { <span class="prelude-val">Ok</span>(<span class="ident">KvmRun</span> { @@ -317,21 +319,22 @@ <span class="kw">impl</span> <span class="ident">ops::Drop</span> <span class="kw">for</span> <span class="ident">KvmRun</span> { <span class="doccomment">/// Munmap the mmaped `struct kvm_run`.</span> - <span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) { + <span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&mut</span> <span class="self">self</span>) { <span class="kw">unsafe</span> { <span class="ident">libc::munmap</span>(<span class="self">self</span>.<span class="ident">ptr</span>.<span class="ident">cast</span>(), <span class="self">self</span>.<span class="ident">len</span>) }; } } <span class="kw">impl</span> <span class="ident">AsRef</span><span class="op"><</span><span class="ident">kvm_sys::kvm_run</span><span class="op">></span> <span class="kw">for</span> <span class="ident">KvmRun</span> { - <span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="ident">kvm_sys::kvm_run</span> { - <span class="kw">unsafe</span> { <span class="kw-2">&</span><span class="kw-2">*</span>(<span class="self">self</span>.<span class="ident">ptr</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">kvm_sys::kvm_run</span>) } + <span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">kvm_sys::kvm_run</span> { + <span class="kw">unsafe</span> { <span class="kw-2">&</span><span class="kw-2">*</span>(<span class="self">self</span>.<span class="ident">ptr</span> <span class="kw">as</span> <span class="kw-2">*const</span> <span class="ident">kvm_sys::kvm_run</span>) } } } <span class="kw">impl</span> <span class="ident">AsMut</span><span class="op"><</span><span class="ident">kvm_sys::kvm_run</span><span class="op">></span> <span class="kw">for</span> <span class="ident">KvmRun</span> { - <span class="kw">fn</span> <span class="ident">as_mut</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">kvm_sys::kvm_run</span> { - <span class="kw">unsafe</span> { <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="kw-2">*</span>(<span class="self">self</span>.<span class="ident">ptr</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">kvm_sys::kvm_run</span>) } + <span class="kw">fn</span> <span class="ident">as_mut</span>(<span class="kw-2">&mut</span> <span class="self">self</span>) -> <span class="kw-2">&mut</span> <span class="ident">kvm_sys::kvm_run</span> { + <span class="kw">unsafe</span> { <span class="kw-2">&mut</span> <span class="kw-2">*</span>(<span class="self">self</span>.<span class="ident">ptr</span> <span class="kw">as</span> <span class="kw-2">*mut</span> <span class="ident">kvm_sys::kvm_run</span>) } } } -</pre></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 +</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>
\ No newline at end of file |