edude03 / kvm-bindings

kvm-bindings

Rust FFI bindings to KVM, generated using bindgen. It currently has support for the following target architectures:

• x86
• x86_64
• arm
• arm64

The bindings exported by this crate are statically generated using header files associated with a specific kernel version, and are not automatically synced with the kernel version running on a particular host. The user must ensure that specific structures, members, or constants are supported and valid for the kernel version they are using. For example, the immediate_exit field from the kvm_run structure is only meaningful if the KVM_CAP_IMMEDIATE_EXIT capability is available. Using invalid fields or features may lead to undefined behaviour.

Usage

First, add the following to your Cargo.toml:

kvm-bindings = "0.4"

Next, add this to your crate root:

extern crate kvm_bindings;

By default kvm-bindings will export a wrapper over the latest available kernel version (4.20), but you can select a different version by specifying it in your toml:

kvm-bindings = { version = "0.4", features = ["kvm_v4_20_0"]}

Bindings are generated for each specific Linux kernel version based on the enabled crate features as follows:

• kvm_v4_14_0 contains the bindings for the Linux kernel version 4.14
• kvm_v4_20_0 contains the bindings for the Linux kernel version 4.20

This crate also offers safe wrappers over FAM structs - FFI structs that have a Flexible Array Member in their definition. These safe wrappers can be used if the fam-wrappers feature is enabled for this crate. Example:

kvm-bindings = { version = "0.4", features = ["kvm_v4_20_0", "fam-wrappers"]}

Dependencies

The crate has an optional dependency to vmm-sys-util when enabling the fam-wrappers feature.