Merge branch 'main' into main

Author: priyasiddharth

rust-vmm-ci

@@ -1,5 +1,14 @@
 # Upcoming Release
 
+# v0.2.6
+
+## Changed
+
+- Bindings are now once again distributed with the crate, rather than
+  generated at build time.
+- Regenerate bindings with Linux 6.15.
+- Remove unused feature flags and build dependencies.
+
 # v0.2.5
 
 ## Changed

virtio-bindings/CHANGELOG.md

@@ -1,47 +1,28 @@
 # Contributing to virtio-bindings
 
-## Overview
+## Dependencies
 
-virtio-bindings is periodically updated with imported virtio headers from the
-Linux kernel. The Linux header files have kernel header dependencies that are
-removed during import so that bindgen can process them in isolation without a
-full set of kernel headers. This is also necessary because the licenses of
-individual kernel header files varies and we only want to distribute
-BSD-licensed virtio headers.
+### Bindgen
+The bindings are currently generated using
+[bindgen](https://rust-lang.github.io/rust-bindgen/) version 0.71.1:
+```bash
+cargo install bindgen-cli --vers 0.71.1
+```
 
-## Importing kernel headers
+### Linux Kernel
 Generating bindings depends on the Linux kernel, so you need to have the
 repository on your machine:
 
 ```bash
 git clone https://github.com/torvalds/linux.git
 ```
 
-Install the headers so they can be used for import:
-```bash
-cd linux
-git checkout <linux-version>
-make headers_install INSTALL_HDR_PATH=headers-<linux-version>
-```
+## Example for updating to a new kernel version
 
-Import kernel headers into `include/`:
-```bash
-cd ~/vm-virtio/virtio-bindings
-./import-linux-headers.sh path/to/headers-<linux-version>
-```
+For this example we assume that you have both linux and virtio-bindings
+repositories in your home directory.
 
-Test that the build still works:
 ```bash
-cargo build
+cd ~/vm-virtio/virtio-bindings
+scripts/generate-bindings.sh ~/linux
 ```
-
-## Adding bindings for new header files
-New kernel headers can be added as follows:
-1. Add the new file to import-linux-headers.sh so it is imported from the Linux
-   kernel header directory into include/.
-2. Add the new file to build.rs so bindgen generates bindings.
-3. Add the new module to src/lib.rs so the generated bindings are exposed in
-   the crate.
-4. Check if `cargo build` still succeeds. If the header has new kernel header
-   dependencies then you need to add them (if they are BSD licensed) or stub
-   them out (if they are not BSD licensed).

virtio-bindings/CONTRIBUTING.md

@@ -1,6 +1,6 @@
 [package]
 name = "virtio-bindings"
-version = "0.2.5"
+version = "0.2.6"
 authors = ["Sergio Lopez <[email protected]>"]
 description = "Rust FFI bindings to virtio generated using bindgen."
 repository = "https://github.com/rust-vmm/vm-virtio"
@@ -10,12 +10,5 @@ keywords = ["virtio"]
 license = "BSD-3-Clause OR Apache-2.0"
 
 [features]
-# Kernel version features are deprecated and no longer have any effect,
-# as the kernel headers are backwards compatible.
-virtio-v4_14_0 = []
-virtio-v5_0_0 = []
-
-[build-dependencies]
-bindgen = "0.72.0"
 
 [dependencies]