Skip to content

Latest commit

 

History

History
44 lines (41 loc) · 1.57 KB

README.md

File metadata and controls

44 lines (41 loc) · 1.57 KB
Raw

Build Status Crates.io

kvm-bindings

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

  • x86
  • x86_64
  • arm
  • arm64

Usage

First, add the following to your Cargo.toml:

kvm-bindings = "0.1"

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.1", 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.1", features = ["kvm_v4_20_0", "fam-wrappers"]}

Dependencies

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