14 releases (9 breaking)
0.10.0 | Nov 11, 2022 |
---|---|
0.8.0 | Apr 7, 2022 |
0.7.0 | Oct 20, 2021 |
0.5.0 | Feb 10, 2021 |
0.2.0 | Mar 19, 2020 |
#12 in Memory management
52,150 downloads per month
Used in 22 crates
(20 directly)
295KB
5K
SLoC
vm-memory
Design
In a typical Virtual Machine Monitor (VMM) there are several components, such
as boot loader, virtual device drivers, virtio backend drivers and vhost
drivers, that need to access the VM physical memory. The vm-memory
crate
provides a set of traits to decouple VM memory consumers from VM memory
providers. Based on these traits, VM memory consumers can access the physical
memory of the VM without knowing the implementation details of the VM memory
provider. Thus VMM components based on these traits can be shared and reused by
multiple virtualization solutions.
The detailed design of the vm-memory
crate can be found here.
Platform Support
- Arch: x86, AMD64, ARM64
- OS: Linux/Unix/Windows
Usage
Add vm-memory
as a dependency in Cargo.toml
[dependencies]
vm-memory = "*"
Then add extern crate vm-memory;
to your crate root.
Examples
- Creating a VM physical memory object in hypervisor specific ways using the
GuestMemoryMmap
implementation of theGuestMemory
trait:
fn provide_mem_to_virt_dev() {
let gm = GuestMemoryMmap::from_ranges(&[
(GuestAddress(0), 0x1000),
(GuestAddress(0x1000), 0x1000)
]).unwrap();
virt_device_io(&gm);
}
- Consumers accessing the VM's physical memory:
fn virt_device_io<T: GuestMemory>(mem: &T) {
let sample_buf = &[1, 2, 3, 4, 5];
assert_eq!(mem.write(sample_buf, GuestAddress(0xffc)).unwrap(), 5);
let buf = &mut [0u8; 5];
assert_eq!(mem.read(buf, GuestAddress(0xffc)).unwrap(), 5);
assert_eq!(buf, sample_buf);
}
License
This project is licensed under either of
- Apache License, Version 2.0
- BSD-3-Clause License
Dependencies
~110KB