hv 0.1.2

High level Rust bidings to Hypervisor Framework
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

use crate::{call, sys, Error, Vm};
use std::sync::Arc;

/// The type that describes a vCPU ID on Intel.
#[cfg(target_arch = "x86_64")]
pub type Id = sys::hv_vcpuid_t;

/// The type that describes a vCPU ID on Apple Silicon.
#[cfg(target_arch = "aarch64")]
pub type Id = sys::hv_vcpu_t;

/// Represents a single virtual CPU.
///
/// [Vcpu] object is not thread safe, all calls must be performed from
/// the owning thread.
pub struct Vcpu {
    #[allow(dead_code)] // VM instance must outlive CPU in order to deallocate things properly.
    vm: Arc<Vm>,
    pub(crate) id: Id,
    #[cfg(target_arch = "aarch64")]
    /// The pointer to the vCPU exit information.
    /// The function `hv_vcpu_run` updates this structure on return.
    /// Apple silicon only.
    pub(crate) exit: *const sys::hv_vcpu_exit_t,
}

impl Vcpu {
    /// Creates a vCPU instance for the current thread.
    pub(crate) fn new(vm: Arc<Vm>) -> Result<Vcpu, Error> {
        #[cfg(target_arch = "x86_64")]
        {
            let mut id = 0;
            call!(sys::hv_vcpu_create(&mut id, 0))?;
            Ok(Vcpu { vm, id })
        }

        #[cfg(target_arch = "aarch64")]
        {
            let mut id = 0;
            let mut exit = std::ptr::null_mut();
            call!(sys::hv_vcpu_create(
                &mut id,
                &mut exit,
                std::ptr::null_mut()
            ))?;
            Ok(Vcpu { vm, id, exit })
        }
    }

    /// Executes a vCPU.
    ///
    /// Call blocks until the next exit of the vCPU [1].
    /// The owning thread must call this function.
    ///
    /// # Intel
    /// On an Intel-based Mac, `hv_vcpu_run` exits from causes external to the guest.
    /// To avoid the overhead of spurious exits use `hv_vcpu_run_until` with the deadline `HV_DEADLINE_FOREVER`.
    ///
    /// # Apple Silicon
    /// If the exit is of type `HV_EXIT_REASON_VTIMER_ACTIVATED`, the VTimer is automatically masked.
    /// As a result, no timer fires until the timer is unmasked with `hv_vcpu_set_vtimer_mask`.
    ///
    /// [1]: https://developer.apple.com/documentation/hypervisor/1441231-hv_vcpu_run
    pub fn run(&self) -> Result<(), Error> {
        call!(sys::hv_vcpu_run(self.id))
    }

    /// Returns the cumulative execution time of a vCPU in nanoseconds.
    pub fn exec_time(&self) -> Result<u64, Error> {
        let mut out = 0_u64;
        call!(sys::hv_vcpu_get_exec_time(self.id, &mut out))?;
        Ok(out)
    }

    /// Returns the underlying vCPU ID.
    #[inline]
    pub fn id(&self) -> Id {
        self.id
    }
}

/// Destroys the vCPU instance associated with the current thread.
impl Drop for Vcpu {
    fn drop(&mut self) {
        call!(sys::hv_vcpu_destroy(self.id)).unwrap()
    }
}