RustInQemu: Difference between revisions

From QEMU
Line 24: Line 24:
**alternative: cstr crate, [https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=10a22a9b8393abd7b541d8fc844bc0df with_offsets macro]
**alternative: cstr crate, [https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=10a22a9b8393abd7b541d8fc844bc0df with_offsets macro]


== TODO ==
[https://patchew.org/QEMU/rust-pl011-rfc-v4.git.manos.pitsidianakis@linaro.org/ Done]:
* module structure should resemble the C part of the tree?
* only generate bindings.rs.inc once
* only generate bindings.rs.inc once
* disabling the cast_ptr_alignment lint is too broad
* disabling the cast_ptr_alignment lint is too broad
[https://lore.kernel.org/qemu-devel/9a83a260-4f4c-477b-a6e1-c8d78d1f3039@redhat.com/ To do (patch available)]:
* update bundled meson to 1.5.0
* update bundled meson to 1.5.0
* add support for --rustc and RUSTC environment variables
* add support for --rustc and RUSTC environment variables
Line 37: Line 32:
* add support for cross compilation of Rust subprojects (<tt>native: true</tt> for deps of procedural macro crates)
* add support for cross compilation of Rust subprojects (<tt>native: true</tt> for deps of procedural macro crates)
* fix licenses for Rust subprojects
* fix licenses for Rust subprojects
* fix cfgs so that proc-macro2 can be compiled with 1.63.0
* demonstrate patching of subprojects (needed for bilge-impl to support 1.63.0)


After commit:
== Posted ==
* add more safety docs
* Enable use of rustc 1.63.0
* trait to generate all-zero structs without having to type "unsafe { MaybeUninit::zeroed().assume_init() }"
** fix cfgs for proc-macro2
* use ctor instead of non-portable linker magic, and the cstr crate instead of CStr statics or c""
** core::ffi (stable in 1.64.0)
* TODO comments when the code is doing potential undefined behavior
** "if let" usage in bilge-impl needs to be patched out (stable in 1.65.0)
* single cargo workspace for clippy etc.?
** std::sync::OnceLock (stable in 1.70.0)
* CI integration
** MaybeUninit::zeroed() (stable in 1.75.0 in const context)
** clean up lints (see below)
** c"" literals (stable in 1.77.0)
* lower minimum supported version in QEMU code too (Debian needs 1.63.0)
** offset_of! (stable in 1.77.0)
* eliminate undefined behavior:
* Enable use of older bindgen
** no aliasing of &mut
** What to do about Ubuntu 22.04? Bindgen 0.59.x does not have --allowlist-file
** use MaybeUninit in instance_init (long-term: investigate [https://docs.rs/pinned-init/ pinned_init crate, originating from Linux])
* Install rustc/bindgen in all containers


other experiments at https://github.com/bonzini/rust-qemu
== TODO ==
* Generic Rust<->C interop, Error, QOM reference counting
* Easy integration with clippy
* Chardev
* Easy integration with rustfmt
* MemoryRegion, SysbusDevice
* More CI
** Rustfmt checks?
** Run nightly clippy
* use MaybeUninit in instance_init (long-term: investigate [https://docs.rs/pinned-init/ pinned_init crate, originating from Linux])
** MemoryRegion (creation)
* module structure should resemble the C part of the tree?
* bindings
** MemoryRegion (callbacks)
** Chardev (callbacks, functions)
** DMA (investigate vm-memory?)
* other experiments at https://github.com/bonzini/rust-qemu
** Generic Rust<->C interop, Error, QOM reference counting
* more QOM procedural macros (currently <tt>#[derive(Object)]</tt>)
** generate qdev properties?
** generate class_init methods?


== Ideas for lints without breaking CI ==
== Ideas for lints without breaking CI ==

Revision as of 09:14, 16 October 2024

For the old RustInQemu page, see RustInQemu/2022

Active efforts in 2024

  • Subject: [RFC 0/6] scripts: Rewrite simpletrace printer in Rust
    Date: Mon, 27 May 2024 16:14:15 +0800
    RFC v1
  • ARM PL011 UART device model in Rust
    Subject: [RFC PATCH v1 0/6] Implement ARM PL011 in Rust
    Date: Mon, 10 Jun 2024 21:22:35 +0300
    RFC v1 v6
    • Meson and configure integration
    • Bindings generation

After some discussion we decided to use rustc directly without going through cargo and each external crate becomes a Meson subproject. Meson 1.5.0+'s support for method = cargo is pretty good for host-compiled packages, but it doesn't work for dependencies of build-compiled packages (i.e. dependencies of procedural macros). This is tracked by https://github.com/mesonbuild/meson/issues/11121. Until then, meson.build files for procedural macros and their dependencies have to be written by hand. (Currently _all_ dependencies use hand-written meson.build).

While cargo would be fine as an interim solution, using Meson to compile the Rust code removes some moving parts. The extra cost of writing meson.build files for dependencies is expected to be small and will mostly happen upfront.

Past efforts

  • [RFC v3 00/32] Rust binding for QAPI and qemu-ga QMP handler examples
    on patchew on lore

Minimum supported version

  • 1.56.0: 2021 edition
  • 1.59.0: const CStr::from_bytes_with_nul_unchecked (needed by cstr crate, see below)
  • 1.64.0: std::ffi::c_* (can use libc or std::os::raw)
  • 1.74.0: Clippy can be configured in Cargo.toml
  • 1.77.0: C string literals, offset_of!
  • only generate bindings.rs.inc once
  • disabling the cast_ptr_alignment lint is too broad
  • update bundled meson to 1.5.0
  • add support for --rustc and RUSTC environment variables
  • remove --no-include-path-detection from bindgen invocation
  • rename subprojects to use Meson 1.5.0+ convention and add meson.override_dependency() call
  • add support for cross compilation of Rust subprojects (native: true for deps of procedural macro crates)
  • fix licenses for Rust subprojects

Posted

  • Enable use of rustc 1.63.0
    • fix cfgs for proc-macro2
    • core::ffi (stable in 1.64.0)
    • "if let" usage in bilge-impl needs to be patched out (stable in 1.65.0)
    • std::sync::OnceLock (stable in 1.70.0)
    • MaybeUninit::zeroed() (stable in 1.75.0 in const context)
    • c"" literals (stable in 1.77.0)
    • offset_of! (stable in 1.77.0)
  • Enable use of older bindgen
    • What to do about Ubuntu 22.04? Bindgen 0.59.x does not have --allowlist-file
  • Install rustc/bindgen in all containers

TODO

  • Easy integration with clippy
  • Easy integration with rustfmt
  • More CI
    • Rustfmt checks?
    • Run nightly clippy
  • use MaybeUninit in instance_init (long-term: investigate pinned_init crate, originating from Linux)
    • MemoryRegion (creation)
  • module structure should resemble the C part of the tree?
  • bindings
    • MemoryRegion (callbacks)
    • Chardev (callbacks, functions)
    • DMA (investigate vm-memory?)
  • other experiments at https://github.com/bonzini/rust-qemu
    • Generic Rust<->C interop, Error, QOM reference counting
  • more QOM procedural macros (currently #[derive(Object)])
    • generate qdev properties?
    • generate class_init methods?

Ideas for lints without breaking CI

See https://github.com/bonzini/rust-qemu/commit/95b25f7c5f4e2694a85a5503050cc98da7562c7c

  • run clippy as part of "make check", possibly only if Rust is newer than some version (1.74.0 so that clippy can be configured in Cargo.toml?)
  • deny many individual lints, do not deny groups (complexity, perf, style, suspicious) on regular builds. allow unknown_lints.
  • add to CI a fallible job that runs on nightly clippy with -Dclippy::complexity -Dclippy::perf -Dclippy::suspicious -Dclippy::style -Dunknown_lints. the job should generally pass, and if a new lint triggers it probably should be added to Cargo.toml as either "allow" (rare) or "deny" (possibly after adding #[allow()] to the source).

Possible project targets

Miscellanea

- qemu-bridge-helper.c Re-write SUID C executable with useful features.

Devices

- hw/block/pflash_cfi01.c, hw/block/pflash_cfi02.c (claimed, WIP)

- hw/mem/nvdimm.c (suggested by Manos)

- hw/timer/i8254.c (claimed, WIP)