From patchwork Tue Dec 31 00:23:33 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paolo Bonzini X-Patchwork-Id: 13923558 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 79370E77188 for ; Tue, 31 Dec 2024 00:25:16 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tSQ3K-0003TN-5e; Mon, 30 Dec 2024 19:24:06 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tSQ3H-0003Ru-Eg for qemu-devel@nongnu.org; Mon, 30 Dec 2024 19:24:03 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tSQ3F-0001zl-QM for qemu-devel@nongnu.org; Mon, 30 Dec 2024 19:24:03 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1735604638; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=VaU78OtHlJWbowYJ8XZBMHDaIpSDaRcsvAM49uU4qxs=; b=BbyD1s6i7GsWNfpf/nUP5eVLFbRDUKhQHwNpgEaqxKlraj8uFtaGliUISVVhWGTtpMjquU nZxdecL9XICb+nXf6FJPZLM5+mua7+2yDUWI7kJCAg1Qy+HINwMmRZqG1+8gcyyzq8bJo7 vb0jvqefi2bnhVqlfOMtfZx7PQFSyLo= Received: from mail-wm1-f72.google.com (mail-wm1-f72.google.com [209.85.128.72]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-208-3z9yWGs_Mp6SwHgJgH1E9w-1; Mon, 30 Dec 2024 19:23:57 -0500 X-MC-Unique: 3z9yWGs_Mp6SwHgJgH1E9w-1 X-Mimecast-MFC-AGG-ID: 3z9yWGs_Mp6SwHgJgH1E9w Received: by mail-wm1-f72.google.com with SMTP id 5b1f17b1804b1-4359206e1e4so75214175e9.2 for ; Mon, 30 Dec 2024 16:23:56 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1735604635; x=1736209435; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=VaU78OtHlJWbowYJ8XZBMHDaIpSDaRcsvAM49uU4qxs=; b=K0Adh/h/KSphLR55kz9sni1m91yJ7w4Lm+twcD6VFuqvkymIXhe6EXBx2djhMTcSQ1 qpEJTJgNWxG9xCgL2n+JAW2/rer9ReAhsJQu2/bJ+gpmFTziPFDCrZbtVgd3o+W7lU7P 7Ph/Mthq7lifcQS1q+u68aoJGMtaeA6wHh9yNtDFrR7mN42siK4wrGRL2VUBp93alvhT a18qGa31OLwalUXV+9849kvuwo1Zwu3kPCUERoo59ewTnFGcQlwHMNfkKTL0kpeZBgRc 8N72aSLysa1mUegvSh50svTVa9DV7joLChi18GDTBHO+9MqouDUEB6Q0McW7+sOFcchS 4wAQ== X-Gm-Message-State: AOJu0YwDsqSt36PWHAEaP/OX5T4q7PXS/R7sPGA7yobL2991Ttnr2Sk9 s2DXbXLqBTkvyIh3XNhL0k9TYJcTydFGcxLyFa3E94L1R6/dMHPJe/b48ZG1e+vdjQG3fMqwAni iA+dHcbVbWpBQgFn0mcx+FxwLC9pwgnqQAhQkCbLLKgtQaPllPgEUuuyxC/11eqS7YjA8c1g4BZ eBemYvAA5CJHOxN0NjnksBeBWjunhnoacPcbwFhOU= X-Gm-Gg: ASbGncuY6Hg3xwrD5DdR6rj+VTPJm8i7w4+dEseaw4GtGQz3rkUo2I31tcV6ejelOLe vmqo9GF0t/VjX2in+8TTW4EYsqQUFk2cCn+etA7XMpManSRC2+oORmu9XLN+99DGNhOywKEj0Lu BFRb6AJtD0qKWyx9S0HEWeZKHlCSQ7w6wmkoltUrImKMJftnKcwuThDrjj0ewpKjpHUlcayc8H6 QeHmdUakkcQMfchz5cgrZrReVROUTyiqBFD13pIGQ+MNr4LOLTaF8sopuQ= X-Received: by 2002:a05:600c:474d:b0:436:18d0:aa6e with SMTP id 5b1f17b1804b1-4366835c14fmr318088355e9.5.1735604635030; Mon, 30 Dec 2024 16:23:55 -0800 (PST) X-Google-Smtp-Source: AGHT+IGv6MHM4uX/eSI1Yj4SlGnN6UDDzvj8TAuWNjWh6ZA6/Px/vud18hBBxDwj2WuqBsSw1WX/rA== X-Received: by 2002:a05:600c:474d:b0:436:18d0:aa6e with SMTP id 5b1f17b1804b1-4366835c14fmr318088235e9.5.1735604634600; Mon, 30 Dec 2024 16:23:54 -0800 (PST) Received: from [192.168.10.3] ([151.62.105.73]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-436612008b1sm367949045e9.15.2024.12.30.16.23.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 30 Dec 2024 16:23:52 -0800 (PST) From: Paolo Bonzini To: qemu-devel@nongnu.org Cc: qemu-rust@nongnu.org, zhao1.liu@intel.com, junjie.mao@hotmail.com Subject: [RFC PATCH 6/9] rust: vmstate: add public utility macros to implement VMState Date: Tue, 31 Dec 2024 01:23:33 +0100 Message-ID: <20241231002336.25931-7-pbonzini@redhat.com> X-Mailer: git-send-email 2.47.1 In-Reply-To: <20241231002336.25931-1-pbonzini@redhat.com> References: <20241231002336.25931-1-pbonzini@redhat.com> MIME-Version: 1.0 Received-SPF: pass client-ip=170.10.133.124; envelope-from=pbonzini@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -42 X-Spam_score: -4.3 X-Spam_bar: ---- X-Spam_report: (-4.3 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-2.187, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=unavailable autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Signed-off-by: Paolo Bonzini --- rust/qemu-api/src/vmstate.rs | 61 ++++++++++++++++++++++++++++++++++-- 1 file changed, 58 insertions(+), 3 deletions(-) diff --git a/rust/qemu-api/src/vmstate.rs b/rust/qemu-api/src/vmstate.rs index edd0cbff162..b59a4b66339 100644 --- a/rust/qemu-api/src/vmstate.rs +++ b/rust/qemu-api/src/vmstate.rs @@ -4,13 +4,18 @@ //! Helper macros to declare migration state for device models. //! -//! This module includes three families of macros: +//! This module includes four families of macros: //! //! * [`vmstate_unused!`](crate::vmstate_unused) and //! [`vmstate_of!`](crate::vmstate_of), which are used to express the //! migration format for a struct. This is based on the [`VMState`] trait, //! which is defined by all migrateable types. //! +//! * [`impl_vmstate_forward`](crate::impl_vmstate_forward) and +//! [`impl_vmstate_bitsized`](crate::impl_vmstate_bitsized), which help with +//! the definition of the [`VMState`] trait (respectively for transparent +//! structs and for `bilge`-defined types) +//! //! * helper macros to declare a device model state struct, in particular //! [`vmstate_subsections`](crate::vmstate_subsections) and //! [`vmstate_fields`](crate::vmstate_fields). @@ -131,7 +136,9 @@ macro_rules! info_enum_to_ref { /// # Safety /// /// The contents of this trait go straight into structs that are parsed by C -/// code and used to introspect into other structs. Be careful. +/// code and used to introspect into other structs. Generally, you don't need +/// to implement it except via macros that do it for you, such as +/// `impl_vmstate_bitsized!`. pub unsafe trait VMState { /// The `info` member of a `VMStateField` is a pointer and as such cannot /// yet be included in the [`BASE`](VMState::BASE) associated constant; @@ -185,7 +192,9 @@ pub const fn vmstate_varray_flag(_: PhantomData) -> VMStateField /// * an array of any of the above /// /// In order to support other types, the trait `VMState` must be implemented -/// for them. +/// for them. The macros +/// [`impl_vmstate_bitsized!`](crate::impl_vmstate_bitsized) +/// and [`impl_vmstate_forward!`](crate::impl_vmstate_forward) help with this. #[macro_export] macro_rules! vmstate_of { ($struct_name:ty, $field_name:ident $([0 .. $num:tt $(* $factor:expr)?])? $(,)?) => { @@ -263,6 +272,32 @@ pub const fn with_varray_multiply(mut self, num: u32) -> VMStateField { } } +/// This macro can be used (by just passing it a type) to forward the `VMState` +/// trait to the first field of a tuple. This is a workaround for lack of +/// support of nested [`offset_of`](core::mem::offset_of) until Rust 1.82.0. +/// +/// # Examples +/// +/// ``` +/// # use qemu_api::vmstate::impl_vmstate_forward; +/// pub struct Fifo([u8; 16]); +/// impl_vmstate_forward!(Fifo); +/// ``` +#[macro_export] +macro_rules! impl_vmstate_forward { + // This is similar to impl_vmstate_transparent below, but it + // uses the same trick as vmstate_of! to obtain the type of + // the first field of the tuple + ($tuple:ty) => { + unsafe impl $crate::vmstate::VMState for $tuple { + const SCALAR_TYPE: $crate::vmstate::VMStateFieldType = + $crate::call_func_with_field!($crate::vmstate::vmstate_scalar_type, $tuple, 0); + const BASE: $crate::bindings::VMStateField = + $crate::call_func_with_field!($crate::vmstate::vmstate_base, $tuple, 0); + } + }; +} + // Transparent wrappers: just use the internal type macro_rules! impl_vmstate_transparent { @@ -283,6 +318,26 @@ unsafe impl<$base> VMState for $type where $base: VMState $($where)* { impl_vmstate_transparent!(crate::cell::BqlCell where T: VMState); impl_vmstate_transparent!(crate::cell::BqlRefCell where T: VMState); +#[macro_export] +macro_rules! impl_vmstate_bitsized { + ($type:ty) => { + unsafe impl $crate::vmstate::VMState for $type { + const SCALAR_TYPE: $crate::vmstate::VMStateFieldType = + <<<$type as ::bilge::prelude::Bitsized>::ArbitraryInt + as ::bilge::prelude::Number>::UnderlyingType + as $crate::vmstate::VMState>::SCALAR_TYPE; + const BASE: $crate::bindings::VMStateField = + <<<$type as ::bilge::prelude::Bitsized>::ArbitraryInt + as ::bilge::prelude::Number>::UnderlyingType + as $crate::vmstate::VMState>::BASE; + const VARRAY_FLAG: $crate::bindings::VMStateFlags = + <<<$type as ::bilge::prelude::Bitsized>::ArbitraryInt + as ::bilge::prelude::Number>::UnderlyingType + as $crate::vmstate::VMState>::VARRAY_FLAG; + } + }; +} + // Scalar types using predefined VMStateInfos macro_rules! impl_vmstate_scalar {