RustInQemu: Difference between revisions

From QEMU
No edit summary
 
(32 intermediate revisions by 2 users not shown)
Line 3: Line 3:
== Active effort ==
== Active effort ==


* [Current state|ChangeLog/9.2#Rust]
* [[ChangeLog/10.0#Rust|Current state]]
* [https://lore.kernel.org/all/cc40943e-dec1-4890-a1d9-579350ce296f@pbonzini.local/ December 2024 Roadmap]
* [https://www.qemu.org/docs/master/devel/rust.html Documentation]
!--
* Roadmap: [https://lore.kernel.org/all/cc40943e-dec1-4890-a1d9-579350ce296f@pbonzini.local/ November 2024] | [https://lore.kernel.org/qemu-devel/17ad81c3-98fc-44c2-8f65-f5e2cc07030b@gnu.org/ January 2025]
* <code>Subject: [RFC 0/6] scripts: Rewrite simpletrace printer in Rust</code><br /><code>Date: Mon, 27 May 2024 16:14:15 +0800</code><br />[https://lore.kernel.org/qemu-devel/20240527081421.2258624-1-zhao1.liu@intel.com/ RFC v1]
* ARM PL011 UART device model in Rust<br /><code>Subject: [RFC PATCH v1 0/6] Implement ARM PL011 in Rust</code><br /><code>Date: Mon, 10 Jun 2024 21:22:35 +0300</code><br />[https://lore.kernel.org/qemu-devel/cover.rust-pl011-rfc-v1.git.manos.pitsidianakis@linaro.org/ RFC v1] [https://lore.kernel.org/qemu-devel/rust-pl011-rfc-v6.git.manos.pitsidianakis@linaro.org/ 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 <tt>method = cargo</tt> 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.
* <code>Subject: [RFC 0/6] scripts: Rewrite simpletrace printer in Rust</code><br /><code>Date: Mon, 27 May 2024 16:14:15 +0800</code><br />[https://lore.kernel.org/qemu-devel/20240527081421.2258624-1-zhao1.liu@intel.com/ RFC v1]
-->
-->


Line 20: Line 16:
* <code>[RFC v3 00/32] Rust binding for QAPI and qemu-ga QMP handler examples</code><br />[https://patchew.org/QEMU/20210907121943.3498701-1-marcandre.lureau@redhat.com/ on patchew] [https://lore.kernel.org/qemu-devel/20210907121943.3498701-1-marcandre.lureau@redhat.com/ on lore]
* <code>[RFC v3 00/32] Rust binding for QAPI and qemu-ga QMP handler examples</code><br />[https://patchew.org/QEMU/20210907121943.3498701-1-marcandre.lureau@redhat.com/ on patchew] [https://lore.kernel.org/qemu-devel/20210907121943.3498701-1-marcandre.lureau@redhat.com/ on lore]


== Minimum supported versions ==
Required versions:
* 1.59.0 has const <tt>CStr::from_bytes_with_nul_unchecked</tt>, not really possible to go below that. Of the supported distributions only Debian bullseye has an older version.
* 1.63.0 is available on Debian bookworm (though it also rustc-web, which is 1.70.0 on mips64el and 1.78.0 on all other platforms).
* 1.75.0 is available on Ubuntu 22.04 and 24.04.  It can return "impl Trait" in traits. This is important when using the pinned_init crate in traits (e.g. to implement QOM instance_init).
* 1.83.0 will allow const_refs_statics and nested offset_of (useful to make vmstate type-safe).
Bindgen 0.60.x has --allowlist-file. Of the supported distributions only Ubuntu 22.04 has an older version (0.59.x).
== Done ==
* 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 (<tt>native: true</tt> for deps of procedural macro crates)
* fix licenses for Rust subprojects
* 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
* feature parity for pl011
** [https://lore.kernel.org/qemu-devel/CAFEAcA9X5iBFMEw3dxsgBPZo7FBuNYp3dK5gf7v+cEyVa+pErA@mail.gmail.com/T/ support pl011-luminary]
** migration
* clean up Cargo usage via workspace
== Posted ==
* [https://lore.kernel.org/qemu-devel/20241108180139.117112-1-pbonzini@redhat.com/T/ improved integration with cargo]
** automatically generate rustc flags from Cargo.toml
** Perform clippy checks and reformat code ("ninja clippy", "ninja rustfmt") - TODO: rustfmt configuration currently requires nightly due to use of unstable features
** Rustfmt, clippy, rustdoc in CI
* [https://lore.kernel.org/qemu-devel/20241104085159.76841-1-pbonzini@redhat.com/T/ qemu_irq + interior mutability]
== Work in progress ==
== Work in progress ==
=== Paolo ===
=== Paolo ===
* [https://gitlab.com/bonzini/qemu/-/commits/rust-next irq + errno + chardev + doctests]
* Posted: Opaque<> (to split crates and also first step for annotated pinning)
* [https://gitlab.com/bonzini/qemu/-/commits/rust-qom QOM] (defining QOM classes entirely without macros, QOM casts and reference counting)
* Planned: chardev
** also documentation for public APIs in qemu-api and qemu-api-macros
* Later: pinned_init... maybe use MaybeUninit as a first step?
* Upstream Meson support for clippy, rustfmt, rustdoc
* Upstream Meson: "objects:", rustdoc, <tt>-C prefer-dynamic</tt>


=== Manos ===
=== Manos ===
* [https://lore.kernel.org/qemu-devel/ml0lj.kelxgd4xtqc7@linaro.org/raw Fix functional tests]
* Documentation
* Documentation
=== Kevin ===
* Executing async code
* Block driver implementations


=== pl011 breakage ===
=== Zhao ===
reproducer:
* HPET live migration.


wget https://archives.fedoraproject.org/pub/archive/fedora/linux/releases/29/Everything/armhfp/os/images/pxeboot/vmlinuz
=== Kevin ===
./qemu-system-arm -kernel vmlinuz -append 'printk.time=0 console=ttyAMA0' -M virt -nographic
* Executing async code, block driver implementations
** https://lore.kernel.org/qemu-devel/20250211214328.640374-1-kwolf@redhat.com/


== Work in progress ==
== TODO ==
* hpet timer device
=== Bugs ===
** timer/bitops/memattrs bindings
* Integration tests are linked with libqemuutil as link_whole, which does not work when modules are enabled
** [https://github.com/mesonbuild/meson/pull/14031 meson seems to be buggy and does not allow using link_with instead?]
** probably best to require meson 1.8.0 anyway as it has nicer integration with clippy, and possibly rustdoc
* Add BQL abstraction for tests - avoid running them with "--test-threads 1"
* [https://github.com/mesonbuild/meson/issues/8828 Distros would prefer to link libstd dynamically]; Rust-enabled QEMU binaries are huge


== TODO ==
=== Nice things to have ===
* [https://github.com/mesonbuild/meson/pull/13933 run doctests with meson test]
* Remove need for manual "meson subprojects update --reset" when updating packagefiles/
* Remove need for manual "meson subprojects update --reset" when updating packagefiles/
* Improve tool integration
* Improve tool integration
Line 93: Line 48:
* rustfmt currently requires nightly, decide what to do about it
* rustfmt currently requires nightly, decide what to do about it
* Place rustdoc output for master somewhere?
* Place rustdoc output for master somewhere?
* split qemu_api into multiple crates
* more QOM procedural macros
** generate qdev properties
** generate parts of TypeInfo?
** monomorphization of <tt>T: IsA&lt;Class&gt;</tt> to <tt>&T</tt> (like the momo crate)
* distros need dynamically linked libstd
** rewrite all main()s in Rust and use [https://github.com/mesonbuild/meson/issues/14224 -C prefer-dynamic]?
** or should Meson be able to link C programs with rlibs?
=== New code to write===
* feature parity for pl011
* feature parity for pl011
** check for new commits
* safe object creation with [https://docs.rs/pinned-init/ pinned_init, originating from Linux])
* bindings
* complete vmstate bindings
** MemoryRegion (callbacks)
* Generic Rust<->C interop, Error (https://github.com/bonzini/rust-qemu)
** Chardev (callbacks, functions)
* DMA (investigate vm-memory?)
** DMA (investigate vm-memory?)
* Trace/log
* other experiments
** https://github.com/bonzini/rust-qemu (Generic Rust<->C interop, Error)
** safe object creation: use MaybeUninit in instance_init? (long-term investigate [https://docs.rs/pinned-init/ pinned_init crate, originating from Linux])
* more QOM procedural macros (currently <tt>#[derive(Object)]</tt>)
** generate qdev properties?
** generate parts of TypeInfo?
* For hpet device
** need error/irq/trace bindings.


== Ideas for lints without breaking CI ==
== Ideas for lints without breaking CI ==
Line 118: Line 75:
=== Miscellanea  ===
=== Miscellanea  ===


- <code>qemu-bridge-helper.c</code> Re-write SUID C executable with useful features.
* <code>qemu-bridge-helper.c</code> Re-write SUID C executable with useful features.
 
=== Bindings ===


* visitors/QOM properties, could be interesting for <code>hw/sensor/tmp105.c</code>...
=== Devices  ===
=== Devices  ===


* <code>hw/block/pflash_cfi01.c</code>, <code>hw/block/pflash_cfi02.c</code> (claimed, WIP)
* <code>hw/block/pflash_cfi01.c</code>, <code>hw/block/pflash_cfi02.c</code> (claimed, WIP)
** needs block bindings
** needs block bindings
* <code>hw/timer/hpet.c, hw/timer/i8254.c</code> (claimed, WIP)
* <code>hw/timer/i8254.c</code> (claimed, WIP)
** needs timer/memattrs/bitops/error/irq/trace bindgings
* <code>hw/mem/nvdimm.c</code> (suggested by [[User:Manos|Manos]])
* <code>hw/mem/nvdimm.c</code> (suggested by [[User:Manos|Manos]])


[[Category:RustInQemu]]
[[Category:RustInQemu]]

Latest revision as of 14:12, 27 February 2025

For the old RustInQemu page, see RustInQemu/2022

Active effort


Past efforts

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

Work in progress

Paolo

  • Posted: Opaque<> (to split crates and also first step for annotated pinning)
  • Planned: chardev
  • Later: pinned_init... maybe use MaybeUninit as a first step?
  • Upstream Meson: "objects:", rustdoc, -C prefer-dynamic

Manos

  • Documentation

Zhao

  • HPET live migration.

Kevin

TODO

Bugs

Nice things to have

  • run doctests with meson test
  • Remove need for manual "meson subprojects update --reset" when updating packagefiles/
  • Improve tool integration
    • Run code checks a la "meson test --suite codecheck"? (clippy and rustfmt)
  • rustfmt currently requires nightly, decide what to do about it
  • Place rustdoc output for master somewhere?
  • split qemu_api into multiple crates
  • more QOM procedural macros
    • generate qdev properties
    • generate parts of TypeInfo?
    • monomorphization of T: IsA<Class> to &T (like the momo crate)
  • distros need dynamically linked libstd
    • rewrite all main()s in Rust and use -C prefer-dynamic?
    • or should Meson be able to link C programs with rlibs?

New code to write

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.

Bindings

  • visitors/QOM properties, could be interesting for hw/sensor/tmp105.c...

Devices

  • hw/block/pflash_cfi01.c, hw/block/pflash_cfi02.c (claimed, WIP)
    • needs block bindings
  • hw/timer/i8254.c (claimed, WIP)
  • hw/mem/nvdimm.c (suggested by Manos)
Retrieved from "https://wiki.qemu.org/index.php?title=RustInQemu&oldid=12157"