docs/devel/rust.rst

3 Rust in QEMU
6 Rust in QEMU is a project to enable using the Rust programming language
10 from ``SysBusDevice`` in `*safe*`__ Rust.  Later, it may become possible
14 __ https://doc.rust-lang.org/nomicon/meet-safe-and-unsafe.html
16 Building the Rust in QEMU code
19 The Rust in QEMU code is included in the emulators via Meson.  Meson
29   comes from the ``rust/Cargo.toml`` workspace file
31 * it is also possible to use ``cargo`` for common Rust-specific coding
36 output directory (typically ``rust/target/``).  A vanilla invocation
46 A target for ``rustfmt`` is also declared in ``rust/meson.build``:
53     pyvenv/bin/meson devenv -w ../rust cargo clippy --tests
54     pyvenv/bin/meson devenv -w ../rust cargo fmt
62   tree.  This third method is useful if you are using ``rust-analyzer``;
64   ``rust-analyzer.cargo.extraEnv`` setting.
71    make check-rust
108 __ https://github.com/rust-lang/rust/pull/125258
115 Writing Rust code in QEMU
125 * ``pl011`` (under ``rust/hw/char/pl011``) and ``hpet`` (under ``rust/hw/timer/hpet``)
148   Rust
187 Generally speaking, these are all removed in the corresponding Rust functions:
228 Rust has very strict rules with respect to how you get an exclusive (``&mut``)
253 __ https://github.com/rust-lang/miri
255 Almost all Rust code in QEMU will involve QOM objects, and pointers to these
274 to a Rust mutable reference, and use a shared reference instead.  The
276 Rust compiler about interior mutability, and optionally to enforce locking
311   Rust bindings.  If the C code uses ``offsetof``, look at qdev properties
323   for the fields of a Rust ``struct``.
329   in Rust, they can be stored in traits and then turned into ``static``
332 **Document limitations due to old Rust versions**
334   supported set of Rust versions, document it in the source and in this
390 * Extracting information from Rust source code into traits, typically based
428 The versions specified in ``rust/Cargo.lock`` must be the same as the
429 subprojects; note that the ``rust/`` directory forms a Cargo `workspace`__,
432 __ https://doc.rust-lang.org/cargo/reference/workspaces.html#virtual-workspace
435 Rust version (|msrv|).
448 * a ``static_library`` or ``rust.proc_macro`` line to perform the actual build