[v3,00/15] rust/vmstate: Clean up, fix, enhance & test

Message

Zhao Liu March 18, 2025, 1:02 p.m. UTC

Hi,

This is my v3, based on aa90f1161bb17 ("Merge tag 'migration-20250314-pull
-request' of https://gitlab.com/farosas/qemu into staging") at master
branch.

Compared with v2:
 * the patch 10 drops `with_exist_check()` and `with_validate_flag()`.
 * patch 15 is newly added to clen up VMStateFlags in vmstate_clock
   (which is inspired by setting flags in vmstate_validate).


Patch Summary
=============

Patch 1-9: Clean up & fix for vmstate_of & vmstate_struct, where the
           issues are catched by unit tests.

Patch 10: Add vmstate_validate support, and vmstate_validate can accept
          safe "test" callback.

Patch 11-14: Add unit test to cover as much as possible cases to be
             compatible with C version macros.

             * Note while in principle Rust's vmstate pattern doesn't
               have to match the C version, the C vmstate macros are
               rich enough to cover as much logic as possible. So
               checking against the C version is the most effective way
               to detect the error.


Change Log
==========

Changes since v2:
 * Drop `with_exist_check()` and `with_validate_flag()`.
 * Clean up incomplete crate path of VMStateFlags in vmstate_clock.

Changes since v1:
 * Drop the patch about prefix separator ", " before [0 .. num] in
   vmstate macros.
 * Drop the pacth which changed "vmsd" to "ident" type in macros.
 * Drop the pacth about adding "version" argument.
 * Add a `with_exist_check()` method to help add callback in future.
 * Drop addr_of & public VMStateFlags API in unit test.
 * Clean up TODO comment.

Best Regards,
Zhao
---
Zhao Liu (15):
  rust/vmstate: Remove unnecessary unsafe
  rust/vmstate: Fix num_offset in vmstate macros
  rust/vmstate: Fix num field when varray flags are set
  rust/vmstate: Fix size field of VMStateField with VMS_ARRAY_OF_POINTER
    flag
  rust/vmstate: Fix type check for varray in vmstate_struct
  rust/vmstate: Fix "cannot infer type" error in vmstate_struct
  rust/vmstate: Fix unnecessary VMState bound of with_varray_flag()
  rust/vmstate: Relax array check when build varray in vmstate_struct
  rust/vmstate: Re-implement VMState trait for timer binding
  rust/vmstate: Support vmstate_validate
  rust/vmstate: Add unit test for vmstate_of macro
  rust/vmstate: Add unit test for vmstate_{of|struct} macro
  rust/vmstate: Add unit test for pointer case
  rust/vmstate: Add unit test for vmstate_validate
  rust/vmstate: Include complete crate path of VMStateFlags in
    vmstate_clock

 rust/hw/char/pl011/src/device_class.rs |   8 +-
 rust/qemu-api/meson.build              |   5 +-
 rust/qemu-api/src/assertions.rs        |  15 +
 rust/qemu-api/src/vmstate.rs           | 100 ++++--
 rust/qemu-api/tests/tests.rs           |   2 +
 rust/qemu-api/tests/vmstate_tests.rs   | 447 +++++++++++++++++++++++++
 6 files changed, 554 insertions(+), 23 deletions(-)
 create mode 100644 rust/qemu-api/tests/vmstate_tests.rs