xhypervisor 0.3.0

Hardware-accelerated virtualization on OS X
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
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185

/*
Copyright (c) 2016 Saurav Sachidanand

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/

//! Bindings to the Hypervisor Framework

use libc::*;

/// Hypervisor Framework return code
pub type hv_return_t = u32;

// Hypervisor Framework return codes
pub const HV_SUCCESS: hv_return_t = 0;
pub const HV_ERROR: hv_return_t = 0xfae94001;
pub const HV_BUSY: hv_return_t = 0xfae94002;
pub const HV_BAD_ARGUMENT: hv_return_t = 0xfae94003;
pub const HV_NO_RESOURCES: hv_return_t = 0xfae94005;
pub const HV_NO_DEVICE: hv_return_t = 0xfae94006;
pub const HV_UNSUPPORTED: hv_return_t = 0xfae9400f;

/// Options for hv_vcpu_create()
pub type hv_vm_options_t = u64;
pub const HV_VM_DEFAULT: hv_vm_options_t = 0 << 0;

// Creating and Destroying VM Instances
extern "C" {
	/// Creates a VM instance for the current Mach task
	pub fn hv_vm_create(flags: hv_vm_options_t) -> hv_return_t;

	/// Destroys the VM instance associated with the current Mach task
	pub fn hv_vm_destroy() -> hv_return_t;
}

/// Type of a vCPU ID
pub type hv_vcpuid_t = c_uint;

// Option for hv_vcpu_create()
pub const HV_VCPU_DEFAULT: u64 = 0;

// Creating and Managing vCPU Instances
extern "C" {
	/// Creates a vCPU instance for the current thread
	pub fn hv_vcpu_create(vcpu: *mut hv_vcpuid_t, flags: hv_vm_options_t) -> hv_return_t;

	/// Executes a vCPU
	pub fn hv_vcpu_run(vcpu: hv_vcpuid_t) -> hv_return_t;

	/// Forces an immediate VMEXIT of a set of vCPUs of the VM
	pub fn hv_vcpu_interrupt(vcpu: *const hv_vcpuid_t, vcpu_count: c_uint) -> hv_return_t;

	/// Returns the cumulative execution time of a vCPU in nanoseconds
	pub fn hv_vcpu_get_exec_time(vcpu: hv_vcpuid_t, time: *mut u64) -> hv_return_t;

	/// Forces flushing of cached vCPU state
	pub fn hv_vcpu_flush(vcpu: hv_vcpuid_t) -> hv_return_t;

	/// Invalidates the TLB of a vCPU
	pub fn hv_vcpu_invalidate_tlb(vcpu: hv_vcpuid_t) -> hv_return_t;

	/// Destroys the vCPU instance associated with the current thread
	pub fn hv_vcpu_destroy(vcpu: hv_vcpuid_t) -> hv_return_t;
}

// Accessing Registers
extern "C" {
	/// Returns the current value of an architectural x86 register
	/// of a vCPU
	pub fn hv_vcpu_read_register(
		vcpu: hv_vcpuid_t,
		reg: super::Register,
		value: *mut u64,
	) -> hv_return_t;

	/// Sets the value of an architectural x86 register of a vCPU
	pub fn hv_vcpu_write_register(
		vcpu: hv_vcpuid_t,
		reg: super::Register,
		value: u64,
	) -> hv_return_t;
}

// Accessing Floating Point (FP) State
extern "C" {
	/// Returns the current architectural x86 floating point and
	/// SIMD state of a vCPU
	pub fn hv_vcpu_read_fpstate(
		vcpu: hv_vcpuid_t,
		buffer: *mut c_void,
		size: size_t,
	) -> hv_return_t;

	/// Sets the architectural x86 floating point and SIMD state of
	/// a vCPU
	pub fn hv_vcpu_write_fpstate(
		vcpu: hv_vcpuid_t,
		buffer: *const c_void,
		size: size_t,
	) -> hv_return_t;
}

// Accessing Machine Specific Registers (MSRs)
extern "C" {
	/// Enables an MSR to be used natively by the VM
	pub fn hv_vcpu_enable_native_msr(vcpu: hv_vcpuid_t, msr: u32, enable: bool) -> hv_return_t;

	/// Returns the current value of an MSR of a vCPU
	pub fn hv_vcpu_read_msr(vcpu: hv_vcpuid_t, msr: u32, value: *mut u64) -> hv_return_t;

	/// Set the value of an MSR of a vCPU
	pub fn hv_vcpu_write_msr(vcpu: hv_vcpuid_t, msr: u32, value: *const u64) -> hv_return_t;
}

// Managing Timestamp-Counters (TSC)
extern "C" {
	/// Synchronizes guest Timestamp-Counters (TSC) across all vCPUs
	pub fn hv_vm_sync_tsc(tsc: u64) -> hv_return_t;
}

/// Type of a user virtual address
pub type hv_uvaddr_t = *const c_void;

/// Guest physical memory region permissions for hv_vm_map()
/// and hv_vm_protect()
pub type hv_memory_flags_t = u64;

/// Type of a guest physical address
pub type hv_gpaddr_t = u64;

// Guest physical memory region permissions for hv_vm_map() and hv_vm_protect()
pub const HV_MEMORY_READ: hv_memory_flags_t = 1 << 0;
pub const HV_MEMORY_WRITE: hv_memory_flags_t = 1 << 1;
pub const HV_MEMORY_EXEC: hv_memory_flags_t = 1 << 2;

// Managing Memory Regions
extern "C" {
	/// Maps a region in the virtual address space of the current
	/// task into the guest physical address space of the VM
	pub fn hv_vm_map(
		uva: hv_uvaddr_t,
		gpa: hv_gpaddr_t,
		size: size_t,
		flags: hv_memory_flags_t,
	) -> hv_return_t;

	/// Unmaps a region in the guest physical address space of the VM
	pub fn hv_vm_unmap(gpa: hv_gpaddr_t, size: size_t) -> hv_return_t;

	/// Modifies the permissions of a region in the guest physical
	/// address space of the VM
	pub fn hv_vm_protect(gpa: hv_gpaddr_t, size: size_t, flags: hv_memory_flags_t) -> hv_return_t;
}

// Managing Virtual Machine Control Structure (VMCS)
extern "C" {
	/// Returns the current value of a VMCS field of a vCPU
	pub fn hv_vmx_vcpu_read_vmcs(vcpu: hv_vcpuid_t, field: u32, value: *mut u64) -> hv_return_t;

	/// Sets the value of a VMCS field of a vCPU
	pub fn hv_vmx_vcpu_write_vmcs(vcpu: hv_vcpuid_t, field: u32, value: u64) -> hv_return_t;

	/// Returns the VMX capabilities of the host processor
	pub fn hv_vmx_read_capability(field: super::VMXCap, value: *mut u64) -> hv_return_t;

	/// Sets the address of the guest APIC for a vCPU in the
	/// guest physical address space of the VM
	pub fn hv_vmx_vcpu_set_apic_address(vcpu: hv_vcpuid_t, gpa: hv_gpaddr_t) -> hv_return_t;
}