qemu-rust.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Zhao Liu <zhao1.liu@intel.com>
To: Paolo Bonzini <pbonzini@redhat.com>,
	Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
Cc: qemu-devel@nongnu.org, qemu-rust@nongnu.org,
	Zhao Liu <zhao1.liu@intel.com>
Subject: [PATCH v2 06/12] rust/qdev: Refine the documentation for QDevProp trait
Date: Sun, 21 Sep 2025 00:05:14 +0800	[thread overview]
Message-ID: <20250920160520.3699591-7-zhao1.liu@intel.com> (raw)
In-Reply-To: <20250920160520.3699591-1-zhao1.liu@intel.com>

From: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>

Refine the documentation to clarify:
 * `unsfae` requires that `VALUE` must be valid.
 * using `*const` instead of `&` because the latter will cause compiler
   error.

Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
Signed-off-by: Zhao Liu <zhao1.liu@intel.com>
---
 rust/hw/core/src/qdev.rs | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/rust/hw/core/src/qdev.rs b/rust/hw/core/src/qdev.rs
index d8113238e513..89c21e7c6b50 100644
--- a/rust/hw/core/src/qdev.rs
+++ b/rust/hw/core/src/qdev.rs
@@ -109,9 +109,16 @@ pub trait ResettablePhasesImpl {
 ///
 /// # Safety
 ///
-/// This trait is marked as `unsafe` because currently having a `const` refer to
-/// an `extern static` as a reference instead of a raw pointer results in this
-/// compiler error:
+/// This trait is marked as `unsafe` because `VALUE` must be a valid raw
+/// reference to a [`bindings::PropertyInfo`].
+///
+/// Note we could not use a regular reference:
+///
+/// ```text
+/// const VALUE: &bindings::PropertyInfo = ...
+/// ```
+///
+/// because this results in the following compiler error:
 ///
 /// ```text
 /// constructing invalid value: encountered reference to `extern` static in `const`
@@ -119,7 +126,7 @@ pub trait ResettablePhasesImpl {
 ///
 /// This is because the compiler generally might dereference a normal reference
 /// during const evaluation, but not in this case (if it did, it'd need to
-/// dereference the raw pointer so this would fail to compile).
+/// dereference the raw pointer so using a `*const` would also fail to compile).
 ///
 /// It is the implementer's responsibility to provide a valid
 /// [`bindings::PropertyInfo`] pointer for the trait implementation to be safe.
-- 
2.34.1



  parent reply	other threads:[~2025-09-20 15:45 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-09-20 16:05 [PATCH v2 00/12] rust: miscellaneous cleanup & HPET #property conversion Zhao Liu
2025-09-20 16:05 ` [PATCH v2 01/12] subprojects: Update .gitignore for proc-macro2 and syn Zhao Liu
2025-09-20 16:05 ` [PATCH v2 02/12] subprojects: Ignore .wraplock file generated by meson v1.9.0 Zhao Liu
2025-09-20 16:05 ` [PATCH v2 03/12] rust/qemu-macros: Fix Clippy's complaints about lambda parameter naming Zhao Liu
2025-09-20 16:05 ` [PATCH v2 04/12] rust/common/uninit: Fix Clippy's complaints about lifetime Zhao Liu
2025-09-20 16:05 ` [PATCH v2 05/12] rust/qdev: use addr_of! in QDevProp Zhao Liu
2025-09-20 16:05 ` Zhao Liu [this message]
2025-09-23 21:02   ` [PATCH v2 06/12] rust/qdev: Refine the documentation for QDevProp trait Stefan Zabka
2025-09-20 16:05 ` [PATCH v2 07/12] rust/qdev: Support property info for more common types Zhao Liu
2025-09-20 16:05 ` [PATCH v2 08/12] rust/qdev: Support bit property in #property macro Zhao Liu
2025-09-20 16:05 ` [PATCH v2 09/12] rust/qdev: Test bit property for #property Zhao Liu
2025-09-20 16:05 ` [PATCH v2 10/12] rust/hpet: Clean up type mismatch for num_timers property Zhao Liu
2025-09-20 16:05 ` [PATCH v2 11/12] rust/hpet: Convert qdev properties to #property macro Zhao Liu
2025-09-20 16:05 ` [PATCH v2 12/12] rust/qdev: Drop declare_properties & define_property macros Zhao Liu
2025-09-23  7:51 ` [PATCH v2 00/12] rust: miscellaneous cleanup & HPET #property conversion Paolo Bonzini

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250920160520.3699591-7-zhao1.liu@intel.com \
    --to=zhao1.liu@intel.com \
    --cc=manos.pitsidianakis@linaro.org \
    --cc=pbonzini@redhat.com \
    --cc=qemu-devel@nongnu.org \
    --cc=qemu-rust@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).