linux-kvm 0.7.0

Safe API to the Linux KVM API.
Documentation 
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

use linux_io::fd::ioctl::{
    ioctl_const_arg, ioctl_write, IoctlReqConstArg, IoctlReqWrite, _IO, _IOW,
};
use linux_io::File;
use linux_unsafe::{int, ulong};

/// The device type marker for the main KVM file descriptor, typically obtained
/// by opening `/dev/kvm`.
#[derive(Debug)]
pub struct KvmSystem;

impl linux_io::fd::ioctl::IoDevice for KvmSystem {}

pub(crate) const KVMIO: ulong = 0xAE;

/// Identifies the version of the KVM API used by the current kernel.
///
/// The stable API always returns version 12. The kernel documentation suggests
/// that applications should always call this and refuse to run if it returns
/// any value other than that; the version number is not expected to change
/// in the future because future API additions will use [`KVM_CHECK_EXTENSION`]
/// instead.
pub const KVM_GET_API_VERSION: IoctlReqConstArg<KvmSystem, int, 0> =
    unsafe { ioctl_const_arg(_IO(KVMIO, 0x00)) };

/// Create a new virtual machine and obtain the file that represents it.
///
/// The resulting file accepts the `ioctl` requests defined in [`super::vm`].
pub const KVM_CREATE_VM: IoctlReqConstArg<KvmSystem, File<super::vm::KvmVm>, 0> =
    unsafe { ioctl_const_arg(_IO(KVMIO, 0x01)) };

/// Query whether the KVM subsystem in the current kernel supports a particular
/// extension.
///
/// A result of zero indicates a lack of support while nonzero indicates
/// support. The nonzero value may carry additional meanings for some
/// extensions.
///
/// This is also supported for virtual machine file descriptors, but you must
/// use [`super::vm::KVM_CHECK_EXTENSION`] instead for those.
pub const KVM_CHECK_EXTENSION: IoctlReqWrite<KvmSystem, int, int> =
    unsafe { ioctl_write(_IOW(KVMIO, 0x03, core::mem::size_of::<int>() as ulong)) };

/// Returns the size of the shared memory region that will be used to
/// communicate with userspace for each VCPU.
///
/// The [`super::vcpu::KVM_RUN`] ioctl request communicates with userspace via
/// a shared memory region. This ioctl request returns the size of that region.
pub const KVM_GET_VCPU_MMAP_SIZE: IoctlReqConstArg<KvmSystem, int, 0> =
    unsafe { ioctl_const_arg(_IO(KVMIO, 0x04)) };