migration/vmstate: Add VMState support to safely migrate GByteArray
v4 cover migration/vmstate: Add VMState support to safely migrate GByteArray
In GLib, GByteArray is an object managed by the library. Currently, migrating a GByteArray requires treating it as a raw C struct and using VMSTATE_VBUFFER_ALLOC_UINT32. For example, see vmstate_vdba in ui/vdagent.c
QEMU cannot pretend that GByteArray is a C struct and simply use VMS_ALLOC to g_malloc() the buffer. This is because, VMS_ALLOC blindly overwrites the data pointer with a newly allocated buffer, thereby leaking the previous memory. Besides, GLib tracks the array's capacity in a hidden alloc field. Bypassing GLib APIs leave this capacity out of sync with the newly allocated buffer, potentially leading to heap buffer overflows during subsequent g_byte_array_append() calls.
This series adds a new VMState called VMSTATE_GBYTEARRAY, which will directly use GLib library API calls to create, or resize the object. This is then used in ui/vdaagent.c replacing the use of VMSTATE_VBUFFER_ALLOC_UINT32.
Changes in v4:
- Applied Peter Xu's feedback: unwrapped GByteArray pointer immediately.
- Removed redundant assert() and ternary logic.
- Removed unneeded len>0 check around qemu_get_buffer and qemu_put_buffer.
Changes in v3:
- Add assert() checks to get and put functions to prevent NULL pointer dereferences, as suggested by Peter Xu.
Changes in v2:
- Marc-André pointed out the problem of not updating the device state itself. To do that we should essentially pass a pointer to the GByteArray pointer. Remove VMS_POINTER from VMSTATE_GBYTEARRAY. This changes 'pv' to be the address of the pointer field (GByteArray **) instead of the pointer's value.
- Update get_g_byte_array and put_g_byte_array to handle this additional level of indirection, allowing safe allocation and updating device state.
- Link to v1: https://lore.kernel.org/all/[email protected]/
Arun Menon (2):
migration/vmstate: Add VMState support for GByteArray ui/vdagent: Use VMSTATE_GBYTEARRAY to safely migrate outbuf
include/migration/vmstate.h | 10 ++++++++++ migration/vmstate-types.c | 28 ++++++++++++++++++++++++++++ ui/vdagent.c | 13 +------------ 3 files changed, 39 insertions(+), 12 deletions(-)
Signature · 1 line
2.53.0
PATCH v4 1/2 migration/vmstate: Add VMState support for GByteArray
From: Arun Menon <[email protected]>
In GLib, GByteArray is an object managed by the library. Currently, migrating a GByteArray requires treating it as a raw C struct and using VMSTATE_VBUFFER_ALLOC_UINT32. For example, see vmstate_vdba in ui/vdagent.c
QEMU cannot pretend that GByteArray is a C struct and simply use VMS_ALLOC to g_malloc() the buffer. This is because, VMS_ALLOC blindly overwrites the data pointer with a newly allocated buffer, thereby leaking the previous memory. Besides, GLib tracks the array's capacity in a hidden alloc field. Bypassing GLib APIs leave this capacity out of sync with the newly allocated buffer, potentially leading to heap buffer overflows during subsequent g_byte_array_append() calls.
This commit introduces VMSTATE_GBYTEARRAY which uses specific library API calls (g_byte_array_set_size()) to safely resize and populate the buffer.
--- include/migration/vmstate.h | 10 ++++++++++ migration/vmstate-types.c | 28 ++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+)
include/migration/vmstate.h +10 -0
@@ -265,6 +265,7 @@ extern const VMStateInfo vmstate_info_bitmap;extern const VMStateInfo vmstate_info_qtailq;extern const VMStateInfo vmstate_info_gtree;extern const VMStateInfo vmstate_info_qlist; +extern const VMStateInfo vmstate_info_g_byte_array;#define type_check_2darray (t1,t2,n,m) ((t1(*)[n][m])0 - (t2*)0)/*
@@ -892,6 +893,15 @@ extern const VMStateInfo vmstate_info_qlist; .start = offsetof(_type, _next), \ } +#define VMSTATE_GBYTEARRAY (_field, _state, _version) { \ + .name = (stringify(_field)), \ + .version_id = (_version), \ + .size = sizeof(GByteArray), \ + .info = &vmstate_info_g_byte_array, \ + .flags = VMS_SINGLE, \ + .offset = vmstate_offset_pointer(_state, _field, GByteArray), \ +} +/* _f : field name _f_n : num of elements field_name _n : num of elements
migration/vmstate-types.c +28 -0
@@ -942,3 +942,31 @@ const VMStateInfo vmstate_info_qlist = { .get = get_qlist, .put = put_qlist, }; + +static int get_g_byte_array (QEMUFile *f,void *pv,size_t size, +const VMStateField *field) +{ +GByteArray *byte_array = *(GByteArray **)pv; +uint32_t len =qemu_get_be32 (f); + +g_byte_array_set_size (byte_array, len); +qemu_get_buffer (f, byte_array->data, len); +return 0 ; +} + +static int put_g_byte_array (QEMUFile *f,void *pv,size_t size, +const VMStateField *field,JSONWriter *vmdesc) +{ +GByteArray *byte_array = *(GByteArray **)pv; + +qemu_put_be32 (f, byte_array->len); +qemu_put_buffer (f, byte_array->data, byte_array->len); + +return 0 ; +} + +const VMStateInfo vmstate_info_g_byte_array = { + .name ="GByteArray" , + .get = get_g_byte_array, + .put = put_g_byte_array, +};
Signature · 1 line
2.53.0
PATCH v4 2/2 ui/vdagent: Use VMSTATE_GBYTEARRAY to safely migrate outbuf
In reply to Arun MenonFrom: Arun Menon <[email protected]>
Migrating a GLib GByteArray is now possible directly using the newly introduced VMSTATE_GBYTEARRAY. It uses the standard GLib API calls to create the array, or resize it.
This is safer than implementing a C struct and manually updating the data and len fields. This commit uses the VMSTATE_GBYTEARRAY in vdagent to store the outbuf variable.
--- ui/vdagent.c | 13 +------------ 1 file changed, 1 insertion(+), 12 deletions(-)
ui/vdagent.c +1 -12
@@ -967,17 +967,6 @@ static const VMStateDescription vmstate_chunk = { } }; -static const VMStateDescription vmstate_vdba = { - .name ="vdagent/bytearray" , - .version_id =0 , - .minimum_version_id =0 , - .fields = (const VMStateField []) { -VMSTATE_UINT32 (len, GByteArray), -VMSTATE_VBUFFER_ALLOC_UINT32 (data, GByteArray,0 ,0 , len), -VMSTATE_END_OF_LIST () - } -}; -struct CBInfoArray {uint32_t n;QemuClipboardInfo cbinfo[QEMU_CLIPBOARD_SELECTION__COUNT ];
@@ -1067,7 +1056,7 @@ static const VMStateDescription vmstate_vdagent = {VMSTATE_UINT32 (xsize, VDAgentChardev),VMSTATE_UINT32 (xoff, VDAgentChardev),VMSTATE_VBUFFER_ALLOC_UINT32 (xbuf, VDAgentChardev,0 ,0 , xsize), -VMSTATE_STRUCT_POINTER (outbuf, VDAgentChardev, vmstate_vdba, GByteArray), +VMSTATE_GBYTEARRAY (outbuf, VDAgentChardev,0 ),VMSTATE_UINT32 (mouse_x, VDAgentChardev),VMSTATE_UINT32 (mouse_y, VDAgentChardev), VMSTATE_UINT32(mouse_btn, VDAgentChardev),
Signature · 1 line
2.53.0