applevisor 1.0.0

Rust bindings for the Apple Silicon Hypervisor Framework
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
51
52
53
54
55
56

#![doc = include_str!("../README.md")]
#![cfg_attr(feature = "simd-nightly", feature(portable_simd), feature(simd_ffi))]

pub mod error;
#[cfg(feature = "macos-15-0")]
pub mod gic;
pub mod memory;
pub mod vcpu;
pub mod vm;

#[cfg(test)]
use std::sync::atomic::{AtomicU64, Ordering};

// -----------------------------------------------------------------------------------------------
// Macros
// -----------------------------------------------------------------------------------------------

/// Macro that calls an ffi hypervisor function and wraps the resulting return value in a
/// [`Result`].
macro_rules! hv_unsafe_call {
    ($x:expr) => {{
        let ret = unsafe { $x };
        match ret {
            x if x == hv_error_t::HV_SUCCESS as i32 => Ok(()),
            code => Err(HypervisorError::from(code)),
        }
    }};
}

pub(crate) use hv_unsafe_call;

// -----------------------------------------------------------------------------------------------
// Prelude
// -----------------------------------------------------------------------------------------------

/// The AppleVisor prelude.
pub mod prelude {
    pub use crate::error::*;
    #[cfg(feature = "macos-15-0")]
    pub use crate::gic::*;
    pub use crate::memory::*;
    pub use crate::vcpu::*;
    pub use crate::vm::*;
}

// -----------------------------------------------------------------------------------------------
// Tests
// -----------------------------------------------------------------------------------------------

#[cfg(test)]
static ALLOC_ID: AtomicU64 = AtomicU64::new(1);

#[cfg(test)]
pub(crate) fn next_mem_addr() -> u64 {
    ALLOC_ID.fetch_add(1, Ordering::Relaxed) * crate::memory::PAGE_SIZE as u64
}