rust: vmstate: add varray support to vmstate_of!

Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
This commit is contained in:
Paolo Bonzini 2024-12-19 18:05:23 +01:00
parent 80aa3045bd
commit 5b024b4e73

View file

@ -72,6 +72,15 @@ pub unsafe trait VMState {
/// The base contents of a `VMStateField` (minus the name and offset) for /// The base contents of a `VMStateField` (minus the name and offset) for
/// the type that is implementing the trait. /// the type that is implementing the trait.
const BASE: VMStateField; const BASE: VMStateField;
/// A flag that is added to another field's `VMStateField` to specify the
/// length's type in a variable-sized array. If this is not a supported
/// type for the length (i.e. if it is not `u8`, `u16`, `u32`), using it
/// in a call to [`vmstate_of!`](crate::vmstate_of) will cause a
/// compile-time error.
const VARRAY_FLAG: VMStateFlags = {
panic!("invalid type for variable-sized array");
};
} }
/// Internal utility function to retrieve a type's `VMStateField`; /// Internal utility function to retrieve a type's `VMStateField`;
@ -80,6 +89,13 @@ pub const fn vmstate_base<T: VMState>(_: PhantomData<T>) -> VMStateField {
T::BASE T::BASE
} }
/// Internal utility function to retrieve a type's `VMStateFlags` when it
/// is used as the element count of a `VMSTATE_VARRAY`; used by
/// [`vmstate_of!`](crate::vmstate_of).
pub const fn vmstate_varray_flag<T: VMState>(_: PhantomData<T>) -> VMStateFlags {
T::VARRAY_FLAG
}
/// Return the `VMStateField` for a field of a struct. The field must be /// Return the `VMStateField` for a field of a struct. The field must be
/// visible in the current scope. /// visible in the current scope.
/// ///
@ -87,18 +103,23 @@ pub const fn vmstate_base<T: VMState>(_: PhantomData<T>) -> VMStateField {
/// for them. /// for them.
#[macro_export] #[macro_export]
macro_rules! vmstate_of { macro_rules! vmstate_of {
($struct_name:ty, $field_name:ident $(,)?) => { ($struct_name:ty, $field_name:ident $([0 .. $num:ident $(* $factor:expr)?])? $(,)?) => {
$crate::bindings::VMStateField { $crate::bindings::VMStateField {
name: ::core::concat!(::core::stringify!($field_name), "\0") name: ::core::concat!(::core::stringify!($field_name), "\0")
.as_bytes() .as_bytes()
.as_ptr() as *const ::std::os::raw::c_char, .as_ptr() as *const ::std::os::raw::c_char,
offset: $crate::offset_of!($struct_name, $field_name), offset: $crate::offset_of!($struct_name, $field_name),
// Compute most of the VMStateField from the type of the field. // Compute most of the VMStateField from the type of the field.
$(.num_offset: $crate::offset_of!($struct_name, $num),)?
..$crate::call_func_with_field!( ..$crate::call_func_with_field!(
$crate::vmstate::vmstate_base, $crate::vmstate::vmstate_base,
$struct_name, $struct_name,
$field_name $field_name
) )$(.with_varray_flag($crate::call_func_with_field!(
$crate::vmstate::vmstate_varray_flag,
$struct_name,
$num))
$(.with_varray_multiply($factor))?)?
} }
}; };
} }
@ -143,6 +164,22 @@ impl VMStateField {
self.flags = VMStateFlags(self.flags.0 | VMStateFlags::VMS_POINTER.0); self.flags = VMStateFlags(self.flags.0 | VMStateFlags::VMS_POINTER.0);
self self
} }
#[must_use]
pub const fn with_varray_flag<T: VMState>(mut self, flag: VMStateFlags) -> VMStateField {
assert!((self.flags.0 & VMStateFlags::VMS_ARRAY.0) != 0);
self.flags = VMStateFlags(self.flags.0 & !VMStateFlags::VMS_ARRAY.0);
self.flags = VMStateFlags(self.flags.0 | flag.0);
self
}
#[must_use]
pub const fn with_varray_multiply(mut self, num: u32) -> VMStateField {
assert!(num <= 0x7FFF_FFFFu32);
self.flags = VMStateFlags(self.flags.0 | VMStateFlags::VMS_MULTIPLY_ELEMENTS.0);
self.num = num as i32;
self
}
} }
// Transparent wrappers: just use the internal type // Transparent wrappers: just use the internal type
@ -154,6 +191,7 @@ macro_rules! impl_vmstate_transparent {
size: mem::size_of::<$type>(), size: mem::size_of::<$type>(),
..<$base as VMState>::BASE ..<$base as VMState>::BASE
}; };
const VARRAY_FLAG: VMStateFlags = <$base as VMState>::VARRAY_FLAG;
} }
}; };
} }