1 #include "qemu-common.h"
2 #include "migration/migration.h"
3 #include "migration/qemu-file.h"
4 #include "migration/vmstate.h"
5 #include "qemu/bitops.h"
6 #include "qemu/error-report.h"
10 static void vmstate_subsection_save(QEMUFile
*f
, const VMStateDescription
*vmsd
,
11 void *opaque
, QJSON
*vmdesc
);
12 static int vmstate_subsection_load(QEMUFile
*f
, const VMStateDescription
*vmsd
,
15 static int vmstate_n_elems(void *opaque
, VMStateField
*field
)
19 if (field
->flags
& VMS_ARRAY
) {
21 } else if (field
->flags
& VMS_VARRAY_INT32
) {
22 n_elems
= *(int32_t *)(opaque
+field
->num_offset
);
23 } else if (field
->flags
& VMS_VARRAY_UINT32
) {
24 n_elems
= *(uint32_t *)(opaque
+field
->num_offset
);
25 } else if (field
->flags
& VMS_VARRAY_UINT16
) {
26 n_elems
= *(uint16_t *)(opaque
+field
->num_offset
);
27 } else if (field
->flags
& VMS_VARRAY_UINT8
) {
28 n_elems
= *(uint8_t *)(opaque
+field
->num_offset
);
34 static int vmstate_size(void *opaque
, VMStateField
*field
)
36 int size
= field
->size
;
38 if (field
->flags
& VMS_VBUFFER
) {
39 size
= *(int32_t *)(opaque
+field
->size_offset
);
40 if (field
->flags
& VMS_MULTIPLY
) {
48 static void *vmstate_base_addr(void *opaque
, VMStateField
*field
, bool alloc
)
50 void *base_addr
= opaque
+ field
->offset
;
52 if (field
->flags
& VMS_POINTER
) {
53 if (alloc
&& (field
->flags
& VMS_ALLOC
)) {
55 if (field
->flags
& VMS_VBUFFER
) {
56 size
= vmstate_size(opaque
, field
);
58 int n_elems
= vmstate_n_elems(opaque
, field
);
60 size
= n_elems
* field
->size
;
64 *((void **)base_addr
+ field
->start
) = g_malloc(size
);
67 base_addr
= *(void **)base_addr
+ field
->start
;
73 int vmstate_load_state(QEMUFile
*f
, const VMStateDescription
*vmsd
,
74 void *opaque
, int version_id
)
76 VMStateField
*field
= vmsd
->fields
;
79 trace_vmstate_load_state(vmsd
->name
, version_id
);
80 if (version_id
> vmsd
->version_id
) {
81 trace_vmstate_load_state_end(vmsd
->name
, "too new", -EINVAL
);
84 if (version_id
< vmsd
->minimum_version_id
) {
85 if (vmsd
->load_state_old
&&
86 version_id
>= vmsd
->minimum_version_id_old
) {
87 ret
= vmsd
->load_state_old(f
, opaque
, version_id
);
88 trace_vmstate_load_state_end(vmsd
->name
, "old path", ret
);
91 trace_vmstate_load_state_end(vmsd
->name
, "too old", -EINVAL
);
95 int ret
= vmsd
->pre_load(opaque
);
100 while (field
->name
) {
101 trace_vmstate_load_state_field(vmsd
->name
, field
->name
);
102 if ((field
->field_exists
&&
103 field
->field_exists(opaque
, version_id
)) ||
104 (!field
->field_exists
&&
105 field
->version_id
<= version_id
)) {
106 void *base_addr
= vmstate_base_addr(opaque
, field
, true);
107 int i
, n_elems
= vmstate_n_elems(opaque
, field
);
108 int size
= vmstate_size(opaque
, field
);
110 for (i
= 0; i
< n_elems
; i
++) {
111 void *addr
= base_addr
+ size
* i
;
113 if (field
->flags
& VMS_ARRAY_OF_POINTER
) {
114 addr
= *(void **)addr
;
116 if (field
->flags
& VMS_STRUCT
) {
117 ret
= vmstate_load_state(f
, field
->vmsd
, addr
,
118 field
->vmsd
->version_id
);
120 ret
= field
->info
->get(f
, addr
, size
);
124 ret
= qemu_file_get_error(f
);
127 qemu_file_set_error(f
, ret
);
128 trace_vmstate_load_field_error(field
->name
, ret
);
132 } else if (field
->flags
& VMS_MUST_EXIST
) {
133 error_report("Input validation failed: %s/%s",
134 vmsd
->name
, field
->name
);
139 ret
= vmstate_subsection_load(f
, vmsd
, opaque
);
143 if (vmsd
->post_load
) {
144 ret
= vmsd
->post_load(opaque
, version_id
);
146 trace_vmstate_load_state_end(vmsd
->name
, "end", ret
);
150 static int vmfield_name_num(VMStateField
*start
, VMStateField
*search
)
155 for (field
= start
; field
->name
; field
++) {
156 if (!strcmp(field
->name
, search
->name
)) {
157 if (field
== search
) {
167 static bool vmfield_name_is_unique(VMStateField
*start
, VMStateField
*search
)
172 for (field
= start
; field
->name
; field
++) {
173 if (!strcmp(field
->name
, search
->name
)) {
175 /* name found more than once, so it's not unique */
185 static const char *vmfield_get_type_name(VMStateField
*field
)
187 const char *type
= "unknown";
189 if (field
->flags
& VMS_STRUCT
) {
191 } else if (field
->info
->name
) {
192 type
= field
->info
->name
;
198 static bool vmsd_can_compress(VMStateField
*field
)
200 if (field
->field_exists
) {
201 /* Dynamically existing fields mess up compression */
205 if (field
->flags
& VMS_STRUCT
) {
206 VMStateField
*sfield
= field
->vmsd
->fields
;
207 while (sfield
->name
) {
208 if (!vmsd_can_compress(sfield
)) {
209 /* Child elements can't compress, so can't we */
215 if (field
->vmsd
->subsections
) {
216 /* Subsections may come and go, better don't compress */
224 static void vmsd_desc_field_start(const VMStateDescription
*vmsd
, QJSON
*vmdesc
,
225 VMStateField
*field
, int i
, int max
)
227 char *name
, *old_name
;
228 bool is_array
= max
> 1;
229 bool can_compress
= vmsd_can_compress(field
);
235 name
= g_strdup(field
->name
);
237 /* Field name is not unique, need to make it unique */
238 if (!vmfield_name_is_unique(vmsd
->fields
, field
)) {
239 int num
= vmfield_name_num(vmsd
->fields
, field
);
241 name
= g_strdup_printf("%s[%d]", name
, num
);
245 json_start_object(vmdesc
, NULL
);
246 json_prop_str(vmdesc
, "name", name
);
249 json_prop_int(vmdesc
, "array_len", max
);
251 json_prop_int(vmdesc
, "index", i
);
254 json_prop_str(vmdesc
, "type", vmfield_get_type_name(field
));
256 if (field
->flags
& VMS_STRUCT
) {
257 json_start_object(vmdesc
, "struct");
263 static void vmsd_desc_field_end(const VMStateDescription
*vmsd
, QJSON
*vmdesc
,
264 VMStateField
*field
, size_t size
, int i
)
270 if (field
->flags
& VMS_STRUCT
) {
271 /* We printed a struct in between, close its child object */
272 json_end_object(vmdesc
);
275 json_prop_int(vmdesc
, "size", size
);
276 json_end_object(vmdesc
);
279 void vmstate_save_state(QEMUFile
*f
, const VMStateDescription
*vmsd
,
280 void *opaque
, QJSON
*vmdesc
)
282 VMStateField
*field
= vmsd
->fields
;
284 if (vmsd
->pre_save
) {
285 vmsd
->pre_save(opaque
);
289 json_prop_str(vmdesc
, "vmsd_name", vmsd
->name
);
290 json_prop_int(vmdesc
, "version", vmsd
->version_id
);
291 json_start_array(vmdesc
, "fields");
294 while (field
->name
) {
295 if (!field
->field_exists
||
296 field
->field_exists(opaque
, vmsd
->version_id
)) {
297 void *base_addr
= vmstate_base_addr(opaque
, field
, false);
298 int i
, n_elems
= vmstate_n_elems(opaque
, field
);
299 int size
= vmstate_size(opaque
, field
);
300 int64_t old_offset
, written_bytes
;
301 QJSON
*vmdesc_loop
= vmdesc
;
303 for (i
= 0; i
< n_elems
; i
++) {
304 void *addr
= base_addr
+ size
* i
;
306 vmsd_desc_field_start(vmsd
, vmdesc_loop
, field
, i
, n_elems
);
307 old_offset
= qemu_ftell_fast(f
);
309 if (field
->flags
& VMS_ARRAY_OF_POINTER
) {
310 addr
= *(void **)addr
;
312 if (field
->flags
& VMS_STRUCT
) {
313 vmstate_save_state(f
, field
->vmsd
, addr
, vmdesc_loop
);
315 field
->info
->put(f
, addr
, size
);
318 written_bytes
= qemu_ftell_fast(f
) - old_offset
;
319 vmsd_desc_field_end(vmsd
, vmdesc_loop
, field
, written_bytes
, i
);
321 /* Compressed arrays only care about the first element */
322 if (vmdesc_loop
&& vmsd_can_compress(field
)) {
327 if (field
->flags
& VMS_MUST_EXIST
) {
328 error_report("Output state validation failed: %s/%s",
329 vmsd
->name
, field
->name
);
330 assert(!(field
->flags
& VMS_MUST_EXIST
));
337 json_end_array(vmdesc
);
340 vmstate_subsection_save(f
, vmsd
, opaque
, vmdesc
);
343 static const VMStateDescription
*
344 vmstate_get_subsection(const VMStateDescription
**sub
, char *idstr
)
346 while (sub
&& *sub
&& (*sub
)->needed
) {
347 if (strcmp(idstr
, (*sub
)->name
) == 0) {
355 static int vmstate_subsection_load(QEMUFile
*f
, const VMStateDescription
*vmsd
,
358 trace_vmstate_subsection_load(vmsd
->name
);
360 while (qemu_peek_byte(f
, 0) == QEMU_VM_SUBSECTION
) {
361 char idstr
[256], *idstr_ret
;
363 uint8_t version_id
, len
, size
;
364 const VMStateDescription
*sub_vmsd
;
366 len
= qemu_peek_byte(f
, 1);
367 if (len
< strlen(vmsd
->name
) + 1) {
368 /* subsection name has be be "section_name/a" */
369 trace_vmstate_subsection_load_bad(vmsd
->name
, "(short)");
372 size
= qemu_peek_buffer(f
, (uint8_t **)&idstr_ret
, len
, 2);
374 trace_vmstate_subsection_load_bad(vmsd
->name
, "(peek fail)");
377 memcpy(idstr
, idstr_ret
, size
);
380 if (strncmp(vmsd
->name
, idstr
, strlen(vmsd
->name
)) != 0) {
381 trace_vmstate_subsection_load_bad(vmsd
->name
, idstr
);
382 /* it don't have a valid subsection name */
385 sub_vmsd
= vmstate_get_subsection(vmsd
->subsections
, idstr
);
386 if (sub_vmsd
== NULL
) {
387 trace_vmstate_subsection_load_bad(vmsd
->name
, "(lookup)");
390 qemu_file_skip(f
, 1); /* subsection */
391 qemu_file_skip(f
, 1); /* len */
392 qemu_file_skip(f
, len
); /* idstr */
393 version_id
= qemu_get_be32(f
);
395 ret
= vmstate_load_state(f
, sub_vmsd
, opaque
, version_id
);
397 trace_vmstate_subsection_load_bad(vmsd
->name
, "(child)");
402 trace_vmstate_subsection_load_good(vmsd
->name
);
406 static void vmstate_subsection_save(QEMUFile
*f
, const VMStateDescription
*vmsd
,
407 void *opaque
, QJSON
*vmdesc
)
409 const VMStateDescription
**sub
= vmsd
->subsections
;
410 bool subsection_found
= false;
412 while (sub
&& *sub
&& (*sub
)->needed
) {
413 if ((*sub
)->needed(opaque
)) {
414 const VMStateDescription
*vmsd
= *sub
;
418 /* Only create subsection array when we have any */
419 if (!subsection_found
) {
420 json_start_array(vmdesc
, "subsections");
421 subsection_found
= true;
424 json_start_object(vmdesc
, NULL
);
427 qemu_put_byte(f
, QEMU_VM_SUBSECTION
);
428 len
= strlen(vmsd
->name
);
429 qemu_put_byte(f
, len
);
430 qemu_put_buffer(f
, (uint8_t *)vmsd
->name
, len
);
431 qemu_put_be32(f
, vmsd
->version_id
);
432 vmstate_save_state(f
, vmsd
, opaque
, vmdesc
);
435 json_end_object(vmdesc
);
441 if (vmdesc
&& subsection_found
) {
442 json_end_array(vmdesc
);
448 static int get_bool(QEMUFile
*f
, void *pv
, size_t size
)
451 *v
= qemu_get_byte(f
);
455 static void put_bool(QEMUFile
*f
, void *pv
, size_t size
)
458 qemu_put_byte(f
, *v
);
461 const VMStateInfo vmstate_info_bool
= {
469 static int get_int8(QEMUFile
*f
, void *pv
, size_t size
)
476 static void put_int8(QEMUFile
*f
, void *pv
, size_t size
)
482 const VMStateInfo vmstate_info_int8
= {
490 static int get_int16(QEMUFile
*f
, void *pv
, size_t size
)
493 qemu_get_sbe16s(f
, v
);
497 static void put_int16(QEMUFile
*f
, void *pv
, size_t size
)
500 qemu_put_sbe16s(f
, v
);
503 const VMStateInfo vmstate_info_int16
= {
511 static int get_int32(QEMUFile
*f
, void *pv
, size_t size
)
514 qemu_get_sbe32s(f
, v
);
518 static void put_int32(QEMUFile
*f
, void *pv
, size_t size
)
521 qemu_put_sbe32s(f
, v
);
524 const VMStateInfo vmstate_info_int32
= {
530 /* 32 bit int. See that the received value is the same than the one
533 static int get_int32_equal(QEMUFile
*f
, void *pv
, size_t size
)
537 qemu_get_sbe32s(f
, &v2
);
545 const VMStateInfo vmstate_info_int32_equal
= {
546 .name
= "int32 equal",
547 .get
= get_int32_equal
,
551 /* 32 bit int. Check that the received value is non-negative
552 * and less than or equal to the one in the field.
555 static int get_int32_le(QEMUFile
*f
, void *pv
, size_t size
)
559 qemu_get_sbe32s(f
, &loaded
);
561 if (loaded
>= 0 && loaded
<= *cur
) {
568 const VMStateInfo vmstate_info_int32_le
= {
576 static int get_int64(QEMUFile
*f
, void *pv
, size_t size
)
579 qemu_get_sbe64s(f
, v
);
583 static void put_int64(QEMUFile
*f
, void *pv
, size_t size
)
586 qemu_put_sbe64s(f
, v
);
589 const VMStateInfo vmstate_info_int64
= {
595 /* 8 bit unsigned int */
597 static int get_uint8(QEMUFile
*f
, void *pv
, size_t size
)
604 static void put_uint8(QEMUFile
*f
, void *pv
, size_t size
)
610 const VMStateInfo vmstate_info_uint8
= {
616 /* 16 bit unsigned int */
618 static int get_uint16(QEMUFile
*f
, void *pv
, size_t size
)
621 qemu_get_be16s(f
, v
);
625 static void put_uint16(QEMUFile
*f
, void *pv
, size_t size
)
628 qemu_put_be16s(f
, v
);
631 const VMStateInfo vmstate_info_uint16
= {
637 /* 32 bit unsigned int */
639 static int get_uint32(QEMUFile
*f
, void *pv
, size_t size
)
642 qemu_get_be32s(f
, v
);
646 static void put_uint32(QEMUFile
*f
, void *pv
, size_t size
)
649 qemu_put_be32s(f
, v
);
652 const VMStateInfo vmstate_info_uint32
= {
658 /* 32 bit uint. See that the received value is the same than the one
661 static int get_uint32_equal(QEMUFile
*f
, void *pv
, size_t size
)
665 qemu_get_be32s(f
, &v2
);
673 const VMStateInfo vmstate_info_uint32_equal
= {
674 .name
= "uint32 equal",
675 .get
= get_uint32_equal
,
679 /* 64 bit unsigned int */
681 static int get_uint64(QEMUFile
*f
, void *pv
, size_t size
)
684 qemu_get_be64s(f
, v
);
688 static void put_uint64(QEMUFile
*f
, void *pv
, size_t size
)
691 qemu_put_be64s(f
, v
);
694 const VMStateInfo vmstate_info_uint64
= {
700 /* 64 bit unsigned int. See that the received value is the same than the one
703 static int get_uint64_equal(QEMUFile
*f
, void *pv
, size_t size
)
707 qemu_get_be64s(f
, &v2
);
715 const VMStateInfo vmstate_info_uint64_equal
= {
716 .name
= "int64 equal",
717 .get
= get_uint64_equal
,
721 /* 8 bit int. See that the received value is the same than the one
724 static int get_uint8_equal(QEMUFile
*f
, void *pv
, size_t size
)
736 const VMStateInfo vmstate_info_uint8_equal
= {
737 .name
= "uint8 equal",
738 .get
= get_uint8_equal
,
742 /* 16 bit unsigned int int. See that the received value is the same than the one
745 static int get_uint16_equal(QEMUFile
*f
, void *pv
, size_t size
)
749 qemu_get_be16s(f
, &v2
);
757 const VMStateInfo vmstate_info_uint16_equal
= {
758 .name
= "uint16 equal",
759 .get
= get_uint16_equal
,
765 static int get_float64(QEMUFile
*f
, void *pv
, size_t size
)
769 *v
= make_float64(qemu_get_be64(f
));
773 static void put_float64(QEMUFile
*f
, void *pv
, size_t size
)
777 qemu_put_be64(f
, float64_val(*v
));
780 const VMStateInfo vmstate_info_float64
= {
786 /* uint8_t buffers */
788 static int get_buffer(QEMUFile
*f
, void *pv
, size_t size
)
791 qemu_get_buffer(f
, v
, size
);
795 static void put_buffer(QEMUFile
*f
, void *pv
, size_t size
)
798 qemu_put_buffer(f
, v
, size
);
801 const VMStateInfo vmstate_info_buffer
= {
807 /* unused buffers: space that was used for some fields that are
808 not useful anymore */
810 static int get_unused_buffer(QEMUFile
*f
, void *pv
, size_t size
)
816 block_len
= MIN(sizeof(buf
), size
);
818 qemu_get_buffer(f
, buf
, block_len
);
823 static void put_unused_buffer(QEMUFile
*f
, void *pv
, size_t size
)
825 static const uint8_t buf
[1024];
829 block_len
= MIN(sizeof(buf
), size
);
831 qemu_put_buffer(f
, buf
, block_len
);
835 const VMStateInfo vmstate_info_unused_buffer
= {
836 .name
= "unused_buffer",
837 .get
= get_unused_buffer
,
838 .put
= put_unused_buffer
,
841 /* bitmaps (as defined by bitmap.h). Note that size here is the size
842 * of the bitmap in bits. The on-the-wire format of a bitmap is 64
843 * bit words with the bits in big endian order. The in-memory format
844 * is an array of 'unsigned long', which may be either 32 or 64 bits.
846 /* This is the number of 64 bit words sent over the wire */
847 #define BITS_TO_U64S(nr) DIV_ROUND_UP(nr, 64)
848 static int get_bitmap(QEMUFile
*f
, void *pv
, size_t size
)
850 unsigned long *bmp
= pv
;
852 for (i
= 0; i
< BITS_TO_U64S(size
); i
++) {
853 uint64_t w
= qemu_get_be64(f
);
855 if (sizeof(unsigned long) == 4 && idx
< BITS_TO_LONGS(size
)) {
856 bmp
[idx
++] = w
>> 32;
862 static void put_bitmap(QEMUFile
*f
, void *pv
, size_t size
)
864 unsigned long *bmp
= pv
;
866 for (i
= 0; i
< BITS_TO_U64S(size
); i
++) {
867 uint64_t w
= bmp
[idx
++];
868 if (sizeof(unsigned long) == 4 && idx
< BITS_TO_LONGS(size
)) {
869 w
|= ((uint64_t)bmp
[idx
++]) << 32;
875 const VMStateInfo vmstate_info_bitmap
= {