migration/vmstate: Add VMState support to safely migrate GByteArray
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.
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 | 37 +++++++++++++++++++++++++++++++++++++ ui/vdagent.c | 13 +------------ 3 files changed, 48 insertions(+), 12 deletions(-)
Signature · 1 line
2.53.0
PATCH 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 | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 47 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 | VMS_POINTER, \ + .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 +37 -0
@@ -942,3 +942,40 @@ 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 = pv; +uint32_t len =qemu_get_be32 (f); + +if (!byte_array) { + byte_array =g_byte_array_new (); + } + +g_byte_array_set_size (byte_array, len); +if (len >0 ) { +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 = pv; +uint32_t len = byte_array ? byte_array->len :0 ; + +qemu_put_be32 (f, len); +if (len >0 ) { +qemu_put_buffer (f, byte_array->data, 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
Re: [PATCH 1/2] migration/vmstate: Add VMState support for GByteArray
Hi
Quoted 16 lines · Arun Menon
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, seevmstate_vdbainui/vdagent.cQEMU cannot pretend that GByteArray is a C struct and simply use
VMS_ALLOCtog_malloc()the buffer. This is because,VMS_ALLOCblindly 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 subsequentg_byte_array_append()calls.
Quoted 3 lines
This commit introduces
VMSTATE_GBYTEARRAYwhich uses specific library API calls (g_byte_array_set_size()) to safely resize and populate the buffer.
Looks ok to me, although it's easy to miss something here given all the casting, compatibility, etc.
My understanding is that this VMState code should safely replace the existing vdagent bytearray struct (done in the next patch):
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()
}
};
some testing before<->after seems to work,
Quoted 44 lines
Signed-off-by Arun Menon <[email protected]>Fix-Suggested-by Marc-André Lureau <[email protected]>Signed-off-by Arun Menon <[email protected]>--- include/migration/vmstate.h | 10 ++++++++++ migration/vmstate-types.c | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 47 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 | VMS_POINTER, \ + .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 +0
-0@@ -942,3 +942,40 @@ const VMStateInfo vmstate_info_qlist = { .get = get_qlist, .put = put_qlist,
migration/vmstate-types.c const VMStateInfo vmstate_info_qlist = { · line 953
Quoted 10 lines
migration/vmstate-types.c +9
-0}; + +static int get_g_byte_array (QEMUFile *f,void *pv,size_t size, +const VMStateField *field) +{ +GByteArray *byte_array = pv; +uint32_t len =qemu_get_be32 (f); + +if (!byte_array) { + byte_array =g_byte_array_new ();
You'd need to update *pv too (*(void **)pv = .. or something)
Quoted 31 lines
migration/vmstate-types.c +28
-1+ } + +g_byte_array_set_size (byte_array, len); +if (len >0 ) { +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 = pv; +uint32_t len = byte_array ? byte_array->len :0 ; + +qemu_put_be32 (f, len); +if (len >0 ) { +qemu_put_buffer (f, byte_array->data, len); + } + +return 0 ; +} + +const VMStateInfo vmstate_info_g_byte_array = { + .name ="GByteArray" , + .get = get_g_byte_array, + .put = put_g_byte_array, +}; --2.53.0
Re: [PATCH 1/2] migration/vmstate: Add VMState support for GByteArray
Hi Marc-André,
Thanks for the review.
Quoted 19 lines · Marc-André Lureau
Hi
Quoted 16 lines · Arun Menon
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, seevmstate_vdbainui/vdagent.cQEMU cannot pretend that GByteArray is a C struct and simply use
VMS_ALLOCtog_malloc()the buffer. This is because,VMS_ALLOCblindly 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 subsequentg_byte_array_append()calls.
Quoted 6 lines
Quoted 3 lines
This commit introduces
VMSTATE_GBYTEARRAYwhich uses specific library API calls (g_byte_array_set_size()) to safely resize and populate the buffer.Looks ok to me, although it's easy to miss something here given all the casting, compatibility, etc.
Yes, looks like I missed it. In order to update the device state itself, I will have to pass a pointer to GByteArray pointer. struct CRBState
{
GByteArray *command_buffer;
};Currently VMS_POINTER flag does the job of dereferencing and then it passes the value in pv. My bad, I misunderstood it. I am removing it, and I shall change the get and put functions.
Quoted 65 lines
My understanding is that this VMState code should safely replace the existing vdagent bytearray struct (done in the next patch):
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()
}
};some testing before<->after seems to work,
Quoted 48 lines
Signed-off-by Arun Menon <[email protected]>Fix-Suggested-by Marc-André Lureau <[email protected]>Signed-off-by Arun Menon <[email protected]>--- include/migration/vmstate.h | 10 ++++++++++ migration/vmstate-types.c | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 47 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 | VMS_POINTER, \ + .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 +3
-0@@ -942,3 +942,40 @@ 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)
Quoted 8 lines
migration/vmstate-types.c const VMStateInfo vmstate_info_qlist = { · line 953
Quoted 6 lines
migration/vmstate-types.c +6
-0+{ +GByteArray *byte_array = pv; +uint32_t len =qemu_get_be32 (f); + +if (!byte_array) { + byte_array =g_byte_array_new ();You'd need to update *pv too (*(void **)pv = .. or something)
Yes, changed in v2.
Quoted 24 lines
Quoted 24 lines
migration/vmstate-types.c +23
-0+ } + +g_byte_array_set_size (byte_array, len); +if (len >0 ) { +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 = pv; +uint32_t len = byte_array ? byte_array->len :0 ; + +qemu_put_be32 (f, len); +if (len >0 ) { +qemu_put_buffer (f, byte_array->data, len); + } + +return 0 ; +} +
Quoted 9 lines
Quoted 8 lines
migration/vmstate-types.c +5
-1+const VMStateInfo vmstate_info_g_byte_array = { + .name ="GByteArray" , + .get = get_g_byte_array, + .put = put_g_byte_array, +}; --2.53.0
Regards,
Arun Menon
PATCH 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 vdaagent 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
Re: [PATCH 2/2] ui/vdagent: Use VMSTATE_GBYTEARRAY to safely migrate outbuf
Hi
Quoted 9 lines · Arun Menon
From: 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_GBYTEARRAYin vdaagent
vdagent
Quoted 4 lines
to store the outbuf variable.
Signed-off-by Arun Menon <[email protected]>Fix-Suggested-by Marc-André Lureau <[email protected]>
It seems to be produce compatible migration streams, so
Quoted 38 lines
--- ui/vdagent.c | 13 +------------ 1 file changed, 1 insertion(+), 12 deletions(-)ui/vdagent.c +1
-13@@ -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), --2.53.0