https://github.com/marysaka/ahv
Bindings for Apple Silicon Hypervisor
https://github.com/marysaka/ahv
apple-silicon macos nostd virtualization
Last synced: 27 days ago
JSON representation
Bindings for Apple Silicon Hypervisor
- Host: GitHub
- URL: https://github.com/marysaka/ahv
- Owner: marysaka
- License: apache-2.0
- Created: 2020-12-26T15:49:13.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-02-16T09:15:54.000Z (8 months ago)
- Last Synced: 2025-09-13T07:31:14.542Z (about 1 month ago)
- Topics: apple-silicon, macos, nostd, virtualization
- Language: Rust
- Homepage:
- Size: 58.6 KB
- Stars: 64
- Watchers: 4
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# ahv
Bindings for Apple Silicon Hypervisor.
## Usage
To use `ahv`, add this to your `Cargo.toml`:
```toml
[dependencies]
ahv = "0.3.0"
```
## Example
The following example execute a move of the immediate value 2 to register x0 at EL1 and then call HVC 0.
```rust
use ahv::*;
fn main() -> Result<()> {
let el1_user_payload = [
0x40, 0x00, 0x80, 0xD2, // mov x0, #2
0x02, 0x00, 0x00, 0xD4, // hvc #0
];
const EL1_USER_PAYLOAD_ADDRESS: hv_ipa_t = 0x20000;
let mut virtual_machine: VirtualMachine = VirtualMachine::new(None)?;
let el1_user_payload_allocation_handle = virtual_machine.allocate_from(&el1_user_payload)?;
virtual_machine.map(el1_user_payload_allocation_handle,
EL1_USER_PAYLOAD_ADDRESS,
MemoryPermission::READ_WRITE_EXECUTE)?;
{
// vCPU scope
let mut vcpu = virtual_machine.create_vcpu(None)?;
vcpu.set_register(Register::CPSR, 0x3c4)?;
vcpu.set_register(Register::PC, EL1_USER_PAYLOAD_ADDRESS)?;
vcpu.set_trap_debug_exceptions(true)?;
loop {
let result = vcpu.run()?;
match result {
VirtualCpuExitReason::Exception { exception } => {
let ec = (exception.syndrome >> 26) & 0x3f;
if ec == 0x16 {
println!("HVC executed! x0 is {}", vcpu.get_register(Register::X0)?);
break;
} else {
println!("Unknown exception class 0x{:x}", ec);
break;
}
}
reason => {
println!("Unexpected exit! Reason: {:?}", reason);
break;
}
}
}
}
// VirtualMachine will unmap and deallocate on drop.
Ok(())
}
```
**To run this example make sure to give the built binary the ``com.apple.security.hypervisor`` entitlement.**
## MSRV
Current MSRV is 1.65.0.
## License
ahv is distributed under the terms of either the MIT license or the Apache
License (Version 2.0), at the user's choice.
See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT).