Expand description
Unsafe Rust bindings for the Apple Silicon Hypervisor.framework
These unsafe bindings provide access to the Apple Silicon Hypervisor.framework
from Rust
programs. It is recommended to use the safe version of this library available at the following
locations:
Structs§
- hv_
vcpu_ exit_ exception_ t - The structure that describes information about an exit from the virtual CPU (vCPU) to the host.
- hv_
vcpu_ exit_ t - Information about an exit from the vCPU to the host.
Enums§
- hv_
cache_ type_ t - The structure that describes an instruction or data cache element.
- hv_
error_ t - Errors returned by Hypervisor functions.
- hv_
exit_ reason_ t - The type that describes the event that triggered a guest exit to the host.
- hv_
feature_ reg_ t - The type that defines feature registers.
- hv_
interrupt_ type_ t - The type that defines the vCPU’s interrupts.
- hv_
reg_ t - The type that defines general registers.
- hv_
simd_ fp_ reg_ t - The type that defines SIMD and floating-point registers.
- hv_
sys_ reg_ t - The type of system registers.
Constants§
- HV_
MEMORY_ EXEC - The value that represents the memory-execute permission.
- HV_
MEMORY_ READ - The value that represents the memory-read permission.
- HV_
MEMORY_ WRITE - The value that represents the memory-write permission.
Functions§
- hv_
vcpu_ ⚠config_ create - Creates a vCPU configuration object.
- hv_
vcpu_ ⚠config_ get_ ccsidr_ el1_ sys_ reg_ values - Returns the Cache Size ID Register (CCSIDR_EL1) values for the vCPU configuration and cache type you specify.
- hv_
vcpu_ ⚠config_ get_ feature_ reg - Gets the value of a feature register.
- hv_
vcpu_ ⚠create - Creates a vCPU instance for the current thread.
- hv_
vcpu_ ⚠destroy - Destroys the vCPU instance associated with the current thread.
- hv_
vcpu_ ⚠get_ exec_ time - Returns, by reference, the cumulative execution time of a vCPU, in nanoseconds.
- hv_
vcpu_ ⚠get_ pending_ interrupt - Gets pending interrupts for a vCPU.
- hv_
vcpu_ ⚠get_ reg - Gets the current value of a vCPU register.
- hv_
vcpu_ ⚠get_ simd_ fp_ reg - Gets the current value of a vCPU SIMD and FP register.
- hv_
vcpu_ ⚠get_ sys_ reg - Gets the current value of a vCPU system register.
- hv_
vcpu_ ⚠get_ trap_ debug_ exceptions - Gets whether debug exceptions exit the guest.
- hv_
vcpu_ ⚠get_ trap_ debug_ reg_ accesses - Gets whether debug-register accesses exit the guest.
- hv_
vcpu_ ⚠get_ vtimer_ mask - Gets the virtual timer mask.
- hv_
vcpu_ ⚠get_ vtimer_ offset - Returns the vTimer offset for the vCPU ID you specify.
- hv_
vcpu_ ⚠run - Starts the execution of a vCPU.
- hv_
vcpu_ ⚠set_ pending_ interrupt - Sets pending interrupts for a vCPU.
- hv_
vcpu_ ⚠set_ reg - Sets the value of a vCPU register.
- hv_
vcpu_ ⚠set_ simd_ fp_ reg - Sets the value of a vCPU SIMD&FP register.
- hv_
vcpu_ ⚠set_ sys_ reg - Sets the value of a vCPU system register.
- hv_
vcpu_ ⚠set_ trap_ debug_ exceptions - Sets whether debug exceptions exit the guest.
- hv_
vcpu_ ⚠set_ trap_ debug_ reg_ accesses - Sets whether debug-register accesses exit the guest.
- hv_
vcpu_ ⚠set_ vtimer_ mask - Sets or clears the virtual timer mask.
- hv_
vcpu_ ⚠set_ vtimer_ offset - Sets the vTimer offset to a value that you provide.
- hv_
vcpus_ ⚠exit - Forces an immediate exit of a set of vCPUs of the VM.
- hv_
vm_ ⚠create - Creates a VM instance for the current process.
- hv_
vm_ ⚠destroy - Destroys the VM instance associated with the current process.
- hv_
vm_ ⚠get_ max_ vcpu_ count - Returns the maximum number of vCPUs that the hypervisor supports.
- hv_
vm_ ⚠map - Maps a region in the virtual address space of the current process into the guest physical address space of the VM.
- hv_
vm_ ⚠protect - Modifies the permissions of a region in the guest physical address space of the VM.
- hv_
vm_ ⚠unmap - Unmaps a region in the guest physical address space of the VM.
Type Aliases§
- hv_
ipa_ t - The type of an intermediate physical address, which is a guest physical address space of the VM.
- hv_
memory_ flags_ t - The permissions for guest physical memory regions.
- hv_
return_ t - The return type of framework functions.
- hv_
simd_ fp_ uchar16_ t - hv_
vcpu_ config_ t - The type that defines a vCPU configuration.
- hv_
vcpu_ t - An opaque value that represents a vCPU instance.
- hv_
vm_ config_ t - The type that defines a virtual-machine configuration.