diff options
Diffstat (limited to 'src/kvm.rs')
| -rw-r--r-- | src/kvm.rs | 13 |
1 files changed, 13 insertions, 0 deletions
@@ -1,3 +1,5 @@ +//! KVM system ioctls. + use std::fs; use std::io; use std::os::unix::io::FromRawFd; @@ -5,11 +7,18 @@ use std::os::unix::io::FromRawFd; use crate::{libcret, ioctl, kvm_sys}; use crate::vm::Vm; +/// 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 pub struct Kvm { kvm: fs::File, } impl Kvm { + /// Open the `/dev/kvm` device. pub fn new() -> io::Result<Kvm> { let kvm = libcret(unsafe { libc::open("/dev/kvm\0".as_ptr().cast(), libc::O_RDWR | libc::O_CLOEXEC) @@ -28,6 +37,10 @@ impl Kvm { ioctl(&self.kvm, kvm_sys::KVM_GET_VCPU_MMAP_SIZE, 0).map(|size| size as usize) } + /// 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 pub fn create_vm(&self) -> io::Result<Vm> { let vm = ioctl(&self.kvm, kvm_sys::KVM_CREATE_VM, 0 /* machine id */) .map(|fd| unsafe { fs::File::from_raw_fd(fd) })?; |