xref: /openbmc/qemu/include/migration/vmstate.h (revision 2c21ee769e4674348560480cecc7b20f3750ee84)
1 /*
2  * QEMU migration/snapshot declarations
3  *
4  * Copyright (c) 2009-2011 Red Hat, Inc.
5  *
6  * Original author: Juan Quintela <quintela@redhat.com>
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining a copy
9  * of this software and associated documentation files (the "Software"), to deal
10  * in the Software without restriction, including without limitation the rights
11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12  * copies of the Software, and to permit persons to whom the Software is
13  * furnished to do so, subject to the following conditions:
14  *
15  * The above copyright notice and this permission notice shall be included in
16  * all copies or substantial portions of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24  * THE SOFTWARE.
25  */
26 
27 #ifndef QEMU_VMSTATE_H
28 #define QEMU_VMSTATE_H
29 
30 #ifndef CONFIG_USER_ONLY
31 #include "migration/qemu-file.h"
32 #endif
33 #include "migration/qjson.h"
34 
35 typedef void SaveStateHandler(QEMUFile *f, void *opaque);
36 typedef int LoadStateHandler(QEMUFile *f, void *opaque, int version_id);
37 
38 typedef struct SaveVMHandlers {
39     /* This runs inside the iothread lock.  */
40     void (*set_params)(const MigrationParams *params, void * opaque);
41     SaveStateHandler *save_state;
42 
43     void (*cleanup)(void *opaque);
44     int (*save_live_complete_postcopy)(QEMUFile *f, void *opaque);
45     int (*save_live_complete_precopy)(QEMUFile *f, void *opaque);
46 
47     /* This runs both outside and inside the iothread lock.  */
48     bool (*is_active)(void *opaque);
49 
50     /* This runs outside the iothread lock in the migration case, and
51      * within the lock in the savevm case.  The callback had better only
52      * use data that is local to the migration thread or protected
53      * by other locks.
54      */
55     int (*save_live_iterate)(QEMUFile *f, void *opaque);
56 
57     /* This runs outside the iothread lock!  */
58     int (*save_live_setup)(QEMUFile *f, void *opaque);
59     void (*save_live_pending)(QEMUFile *f, void *opaque, uint64_t max_size,
60                               uint64_t *non_postcopiable_pending,
61                               uint64_t *postcopiable_pending);
62     LoadStateHandler *load_state;
63 } SaveVMHandlers;
64 
65 int register_savevm(DeviceState *dev,
66                     const char *idstr,
67                     int instance_id,
68                     int version_id,
69                     SaveStateHandler *save_state,
70                     LoadStateHandler *load_state,
71                     void *opaque);
72 
73 int register_savevm_live(DeviceState *dev,
74                          const char *idstr,
75                          int instance_id,
76                          int version_id,
77                          SaveVMHandlers *ops,
78                          void *opaque);
79 
80 void unregister_savevm(DeviceState *dev, const char *idstr, void *opaque);
81 
82 typedef struct VMStateInfo VMStateInfo;
83 typedef struct VMStateDescription VMStateDescription;
84 typedef struct VMStateField VMStateField;
85 
86 /* VMStateInfo allows customized migration of objects that don't fit in
87  * any category in VMStateFlags. Additional information is always passed
88  * into get and put in terms of field and vmdesc parameters. However
89  * these two parameters should only be used in cases when customized
90  * handling is needed, such as QTAILQ. For primitive data types such as
91  * integer, field and vmdesc parameters should be ignored inside get/put.
92  */
93 struct VMStateInfo {
94     const char *name;
95     int (*get)(QEMUFile *f, void *pv, size_t size, VMStateField *field);
96     int (*put)(QEMUFile *f, void *pv, size_t size, VMStateField *field,
97                QJSON *vmdesc);
98 };
99 
100 enum VMStateFlags {
101     /* Ignored */
102     VMS_SINGLE           = 0x001,
103 
104     /* The struct member at opaque + VMStateField.offset is a pointer
105      * to the actual field (e.g. struct a { uint8_t *b;
106      * }). Dereference the pointer before using it as basis for
107      * further pointer arithmetic (see e.g. VMS_ARRAY). Does not
108      * affect the meaning of VMStateField.num_offset or
109      * VMStateField.size_offset; see VMS_VARRAY* and VMS_VBUFFER for
110      * those. */
111     VMS_POINTER          = 0x002,
112 
113     /* The field is an array of fixed size. VMStateField.num contains
114      * the number of entries in the array. The size of each entry is
115      * given by VMStateField.size and / or opaque +
116      * VMStateField.size_offset; see VMS_VBUFFER and
117      * VMS_MULTIPLY. Each array entry will be processed individually
118      * (VMStateField.info.get()/put() if VMS_STRUCT is not set,
119      * recursion into VMStateField.vmsd if VMS_STRUCT is set). May not
120      * be combined with VMS_VARRAY*. */
121     VMS_ARRAY            = 0x004,
122 
123     /* The field is itself a struct, containing one or more
124      * fields. Recurse into VMStateField.vmsd. Most useful in
125      * combination with VMS_ARRAY / VMS_VARRAY*, recursing into each
126      * array entry. */
127     VMS_STRUCT           = 0x008,
128 
129     /* The field is an array of variable size. The int32_t at opaque +
130      * VMStateField.num_offset contains the number of entries in the
131      * array. See the VMS_ARRAY description regarding array handling
132      * in general. May not be combined with VMS_ARRAY or any other
133      * VMS_VARRAY*. */
134     VMS_VARRAY_INT32     = 0x010,
135 
136     /* Ignored */
137     VMS_BUFFER           = 0x020,
138 
139     /* The field is a (fixed-size or variable-size) array of pointers
140      * (e.g. struct a { uint8_t *b[]; }). Dereference each array entry
141      * before using it. Note: Does not imply any one of VMS_ARRAY /
142      * VMS_VARRAY*; these need to be set explicitly. */
143     VMS_ARRAY_OF_POINTER = 0x040,
144 
145     /* The field is an array of variable size. The uint16_t at opaque
146      * + VMStateField.num_offset (subject to VMS_MULTIPLY_ELEMENTS)
147      * contains the number of entries in the array. See the VMS_ARRAY
148      * description regarding array handling in general. May not be
149      * combined with VMS_ARRAY or any other VMS_VARRAY*. */
150     VMS_VARRAY_UINT16    = 0x080,
151 
152     /* The size of the individual entries (a single array entry if
153      * VMS_ARRAY or any of VMS_VARRAY* are set, or the field itself if
154      * neither is set) is variable (i.e. not known at compile-time),
155      * but the same for all entries. Use the int32_t at opaque +
156      * VMStateField.size_offset (subject to VMS_MULTIPLY) to determine
157      * the size of each (and every) entry. */
158     VMS_VBUFFER          = 0x100,
159 
160     /* Multiply the entry size given by the int32_t at opaque +
161      * VMStateField.size_offset (see VMS_VBUFFER description) with
162      * VMStateField.size to determine the number of bytes to be
163      * allocated. Only valid in combination with VMS_VBUFFER. */
164     VMS_MULTIPLY         = 0x200,
165 
166     /* The field is an array of variable size. The uint8_t at opaque +
167      * VMStateField.num_offset (subject to VMS_MULTIPLY_ELEMENTS)
168      * contains the number of entries in the array. See the VMS_ARRAY
169      * description regarding array handling in general. May not be
170      * combined with VMS_ARRAY or any other VMS_VARRAY*. */
171     VMS_VARRAY_UINT8     = 0x400,
172 
173     /* The field is an array of variable size. The uint32_t at opaque
174      * + VMStateField.num_offset (subject to VMS_MULTIPLY_ELEMENTS)
175      * contains the number of entries in the array. See the VMS_ARRAY
176      * description regarding array handling in general. May not be
177      * combined with VMS_ARRAY or any other VMS_VARRAY*. */
178     VMS_VARRAY_UINT32    = 0x800,
179 
180     /* Fail loading the serialised VM state if this field is missing
181      * from the input. */
182     VMS_MUST_EXIST       = 0x1000,
183 
184     /* When loading serialised VM state, allocate memory for the
185      * (entire) field. Only valid in combination with
186      * VMS_POINTER. Note: Not all combinations with other flags are
187      * currently supported, e.g. VMS_ALLOC|VMS_ARRAY_OF_POINTER won't
188      * cause the individual entries to be allocated. */
189     VMS_ALLOC            = 0x2000,
190 
191     /* Multiply the number of entries given by the integer at opaque +
192      * VMStateField.num_offset (see VMS_VARRAY*) with VMStateField.num
193      * to determine the number of entries in the array. Only valid in
194      * combination with one of VMS_VARRAY*. */
195     VMS_MULTIPLY_ELEMENTS = 0x4000,
196 };
197 
198 typedef enum {
199     MIG_PRI_DEFAULT = 0,
200     MIG_PRI_IOMMU,              /* Must happen before PCI devices */
201     MIG_PRI_MAX,
202 } MigrationPriority;
203 
204 struct VMStateField {
205     const char *name;
206     size_t offset;
207     size_t size;
208     size_t start;
209     int num;
210     size_t num_offset;
211     size_t size_offset;
212     const VMStateInfo *info;
213     enum VMStateFlags flags;
214     const VMStateDescription *vmsd;
215     int version_id;
216     bool (*field_exists)(void *opaque, int version_id);
217 };
218 
219 struct VMStateDescription {
220     const char *name;
221     int unmigratable;
222     int version_id;
223     int minimum_version_id;
224     int minimum_version_id_old;
225     MigrationPriority priority;
226     LoadStateHandler *load_state_old;
227     int (*pre_load)(void *opaque);
228     int (*post_load)(void *opaque, int version_id);
229     void (*pre_save)(void *opaque);
230     bool (*needed)(void *opaque);
231     VMStateField *fields;
232     const VMStateDescription **subsections;
233 };
234 
235 extern const VMStateDescription vmstate_dummy;
236 
237 extern const VMStateInfo vmstate_info_bool;
238 
239 extern const VMStateInfo vmstate_info_int8;
240 extern const VMStateInfo vmstate_info_int16;
241 extern const VMStateInfo vmstate_info_int32;
242 extern const VMStateInfo vmstate_info_int64;
243 
244 extern const VMStateInfo vmstate_info_uint8_equal;
245 extern const VMStateInfo vmstate_info_uint16_equal;
246 extern const VMStateInfo vmstate_info_int32_equal;
247 extern const VMStateInfo vmstate_info_uint32_equal;
248 extern const VMStateInfo vmstate_info_uint64_equal;
249 extern const VMStateInfo vmstate_info_int32_le;
250 
251 extern const VMStateInfo vmstate_info_uint8;
252 extern const VMStateInfo vmstate_info_uint16;
253 extern const VMStateInfo vmstate_info_uint32;
254 extern const VMStateInfo vmstate_info_uint64;
255 
256 extern const VMStateInfo vmstate_info_float64;
257 extern const VMStateInfo vmstate_info_cpudouble;
258 
259 extern const VMStateInfo vmstate_info_timer;
260 extern const VMStateInfo vmstate_info_buffer;
261 extern const VMStateInfo vmstate_info_unused_buffer;
262 extern const VMStateInfo vmstate_info_bitmap;
263 
264 #define type_check_2darray(t1,t2,n,m) ((t1(*)[n][m])0 - (t2*)0)
265 #define type_check_array(t1,t2,n) ((t1(*)[n])0 - (t2*)0)
266 #define type_check_pointer(t1,t2) ((t1**)0 - (t2*)0)
267 
268 #define vmstate_offset_value(_state, _field, _type)                  \
269     (offsetof(_state, _field) +                                      \
270      type_check(_type, typeof_field(_state, _field)))
271 
272 #define vmstate_offset_pointer(_state, _field, _type)                \
273     (offsetof(_state, _field) +                                      \
274      type_check_pointer(_type, typeof_field(_state, _field)))
275 
276 #define vmstate_offset_array(_state, _field, _type, _num)            \
277     (offsetof(_state, _field) +                                      \
278      type_check_array(_type, typeof_field(_state, _field), _num))
279 
280 #define vmstate_offset_2darray(_state, _field, _type, _n1, _n2)      \
281     (offsetof(_state, _field) +                                      \
282      type_check_2darray(_type, typeof_field(_state, _field), _n1, _n2))
283 
284 #define vmstate_offset_sub_array(_state, _field, _type, _start)      \
285     vmstate_offset_value(_state, _field[_start], _type)
286 
287 #define vmstate_offset_buffer(_state, _field)                        \
288     vmstate_offset_array(_state, _field, uint8_t,                    \
289                          sizeof(typeof_field(_state, _field)))
290 
291 #define VMSTATE_SINGLE_TEST(_field, _state, _test, _version, _info, _type) { \
292     .name         = (stringify(_field)),                             \
293     .version_id   = (_version),                                      \
294     .field_exists = (_test),                                         \
295     .size         = sizeof(_type),                                   \
296     .info         = &(_info),                                        \
297     .flags        = VMS_SINGLE,                                      \
298     .offset       = vmstate_offset_value(_state, _field, _type),     \
299 }
300 
301 /* Validate state using a boolean predicate. */
302 #define VMSTATE_VALIDATE(_name, _test) { \
303     .name         = (_name),                                         \
304     .field_exists = (_test),                                         \
305     .flags        = VMS_ARRAY | VMS_MUST_EXIST,                      \
306     .num          = 0, /* 0 elements: no data, only run _test */     \
307 }
308 
309 #define VMSTATE_POINTER(_field, _state, _version, _info, _type) {    \
310     .name       = (stringify(_field)),                               \
311     .version_id = (_version),                                        \
312     .info       = &(_info),                                          \
313     .size       = sizeof(_type),                                     \
314     .flags      = VMS_SINGLE|VMS_POINTER,                            \
315     .offset     = vmstate_offset_value(_state, _field, _type),       \
316 }
317 
318 #define VMSTATE_POINTER_TEST(_field, _state, _test, _info, _type) {  \
319     .name       = (stringify(_field)),                               \
320     .info       = &(_info),                                          \
321     .field_exists = (_test),                                         \
322     .size       = sizeof(_type),                                     \
323     .flags      = VMS_SINGLE|VMS_POINTER,                            \
324     .offset     = vmstate_offset_value(_state, _field, _type),       \
325 }
326 
327 #define VMSTATE_ARRAY(_field, _state, _num, _version, _info, _type) {\
328     .name       = (stringify(_field)),                               \
329     .version_id = (_version),                                        \
330     .num        = (_num),                                            \
331     .info       = &(_info),                                          \
332     .size       = sizeof(_type),                                     \
333     .flags      = VMS_ARRAY,                                         \
334     .offset     = vmstate_offset_array(_state, _field, _type, _num), \
335 }
336 
337 #define VMSTATE_2DARRAY(_field, _state, _n1, _n2, _version, _info, _type) { \
338     .name       = (stringify(_field)),                                      \
339     .version_id = (_version),                                               \
340     .num        = (_n1) * (_n2),                                            \
341     .info       = &(_info),                                                 \
342     .size       = sizeof(_type),                                            \
343     .flags      = VMS_ARRAY,                                                \
344     .offset     = vmstate_offset_2darray(_state, _field, _type, _n1, _n2),  \
345 }
346 
347 #define VMSTATE_VARRAY_MULTIPLY(_field, _state, _field_num, _multiply, _info, _type) { \
348     .name       = (stringify(_field)),                               \
349     .num_offset = vmstate_offset_value(_state, _field_num, uint32_t),\
350     .num        = (_multiply),                                       \
351     .info       = &(_info),                                          \
352     .size       = sizeof(_type),                                     \
353     .flags      = VMS_VARRAY_UINT32|VMS_MULTIPLY_ELEMENTS,           \
354     .offset     = offsetof(_state, _field),                          \
355 }
356 
357 #define VMSTATE_ARRAY_TEST(_field, _state, _num, _test, _info, _type) {\
358     .name         = (stringify(_field)),                              \
359     .field_exists = (_test),                                          \
360     .num          = (_num),                                           \
361     .info         = &(_info),                                         \
362     .size         = sizeof(_type),                                    \
363     .flags        = VMS_ARRAY,                                        \
364     .offset       = vmstate_offset_array(_state, _field, _type, _num),\
365 }
366 
367 #define VMSTATE_SUB_ARRAY(_field, _state, _start, _num, _version, _info, _type) { \
368     .name       = (stringify(_field)),                               \
369     .version_id = (_version),                                        \
370     .num        = (_num),                                            \
371     .info       = &(_info),                                          \
372     .size       = sizeof(_type),                                     \
373     .flags      = VMS_ARRAY,                                         \
374     .offset     = vmstate_offset_sub_array(_state, _field, _type, _start), \
375 }
376 
377 #define VMSTATE_ARRAY_INT32_UNSAFE(_field, _state, _field_num, _info, _type) {\
378     .name       = (stringify(_field)),                               \
379     .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
380     .info       = &(_info),                                          \
381     .size       = sizeof(_type),                                     \
382     .flags      = VMS_VARRAY_INT32,                                  \
383     .offset     = offsetof(_state, _field),                          \
384 }
385 
386 #define VMSTATE_VARRAY_INT32(_field, _state, _field_num, _version, _info, _type) {\
387     .name       = (stringify(_field)),                               \
388     .version_id = (_version),                                        \
389     .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
390     .info       = &(_info),                                          \
391     .size       = sizeof(_type),                                     \
392     .flags      = VMS_VARRAY_INT32|VMS_POINTER,                      \
393     .offset     = vmstate_offset_pointer(_state, _field, _type),     \
394 }
395 
396 #define VMSTATE_VARRAY_UINT32(_field, _state, _field_num, _version, _info, _type) {\
397     .name       = (stringify(_field)),                               \
398     .version_id = (_version),                                        \
399     .num_offset = vmstate_offset_value(_state, _field_num, uint32_t),\
400     .info       = &(_info),                                          \
401     .size       = sizeof(_type),                                     \
402     .flags      = VMS_VARRAY_UINT32|VMS_POINTER,                     \
403     .offset     = vmstate_offset_pointer(_state, _field, _type),     \
404 }
405 
406 #define VMSTATE_VARRAY_UINT32_ALLOC(_field, _state, _field_num, _version, _info, _type) {\
407     .name       = (stringify(_field)),                               \
408     .version_id = (_version),                                        \
409     .num_offset = vmstate_offset_value(_state, _field_num, uint32_t),\
410     .info       = &(_info),                                          \
411     .size       = sizeof(_type),                                     \
412     .flags      = VMS_VARRAY_UINT32|VMS_POINTER|VMS_ALLOC,           \
413     .offset     = vmstate_offset_pointer(_state, _field, _type),     \
414 }
415 
416 #define VMSTATE_VARRAY_UINT16_UNSAFE(_field, _state, _field_num, _version, _info, _type) {\
417     .name       = (stringify(_field)),                               \
418     .version_id = (_version),                                        \
419     .num_offset = vmstate_offset_value(_state, _field_num, uint16_t),\
420     .info       = &(_info),                                          \
421     .size       = sizeof(_type),                                     \
422     .flags      = VMS_VARRAY_UINT16,                                 \
423     .offset     = offsetof(_state, _field),                          \
424 }
425 
426 #define VMSTATE_STRUCT_TEST(_field, _state, _test, _version, _vmsd, _type) { \
427     .name         = (stringify(_field)),                             \
428     .version_id   = (_version),                                      \
429     .field_exists = (_test),                                         \
430     .vmsd         = &(_vmsd),                                        \
431     .size         = sizeof(_type),                                   \
432     .flags        = VMS_STRUCT,                                      \
433     .offset       = vmstate_offset_value(_state, _field, _type),     \
434 }
435 
436 #define VMSTATE_STRUCT_POINTER_V(_field, _state, _version, _vmsd, _type) { \
437     .name         = (stringify(_field)),                             \
438     .version_id   = (_version),                                        \
439     .vmsd         = &(_vmsd),                                        \
440     .size         = sizeof(_type *),                                 \
441     .flags        = VMS_STRUCT|VMS_POINTER,                          \
442     .offset       = vmstate_offset_pointer(_state, _field, _type),   \
443 }
444 
445 #define VMSTATE_STRUCT_POINTER_TEST_V(_field, _state, _test, _version, _vmsd, _type) { \
446     .name         = (stringify(_field)),                             \
447     .version_id   = (_version),                                        \
448     .field_exists = (_test),                                         \
449     .vmsd         = &(_vmsd),                                        \
450     .size         = sizeof(_type *),                                 \
451     .flags        = VMS_STRUCT|VMS_POINTER,                          \
452     .offset       = vmstate_offset_pointer(_state, _field, _type),   \
453 }
454 
455 #define VMSTATE_ARRAY_OF_POINTER(_field, _state, _num, _version, _info, _type) {\
456     .name       = (stringify(_field)),                               \
457     .version_id = (_version),                                        \
458     .num        = (_num),                                            \
459     .info       = &(_info),                                          \
460     .size       = sizeof(_type),                                     \
461     .flags      = VMS_ARRAY|VMS_ARRAY_OF_POINTER,                    \
462     .offset     = vmstate_offset_array(_state, _field, _type, _num), \
463 }
464 
465 #define VMSTATE_ARRAY_OF_POINTER_TO_STRUCT(_f, _s, _n, _v, _vmsd, _type) { \
466     .name       = (stringify(_f)),                                   \
467     .version_id = (_v),                                              \
468     .num        = (_n),                                              \
469     .vmsd       = &(_vmsd),                                          \
470     .size       = sizeof(_type *),                                    \
471     .flags      = VMS_ARRAY|VMS_STRUCT|VMS_ARRAY_OF_POINTER,         \
472     .offset     = vmstate_offset_array(_s, _f, _type*, _n),          \
473 }
474 
475 #define VMSTATE_STRUCT_SUB_ARRAY(_field, _state, _start, _num, _version, _vmsd, _type) { \
476     .name       = (stringify(_field)),                                     \
477     .version_id = (_version),                                              \
478     .num        = (_num),                                                  \
479     .vmsd       = &(_vmsd),                                                \
480     .size       = sizeof(_type),                                           \
481     .flags      = VMS_STRUCT|VMS_ARRAY,                                    \
482     .offset     = vmstate_offset_sub_array(_state, _field, _type, _start), \
483 }
484 
485 #define VMSTATE_STRUCT_ARRAY_TEST(_field, _state, _num, _test, _version, _vmsd, _type) { \
486     .name         = (stringify(_field)),                             \
487     .num          = (_num),                                          \
488     .field_exists = (_test),                                         \
489     .version_id   = (_version),                                      \
490     .vmsd         = &(_vmsd),                                        \
491     .size         = sizeof(_type),                                   \
492     .flags        = VMS_STRUCT|VMS_ARRAY,                            \
493     .offset       = vmstate_offset_array(_state, _field, _type, _num),\
494 }
495 
496 #define VMSTATE_STRUCT_VARRAY_UINT8(_field, _state, _field_num, _version, _vmsd, _type) { \
497     .name       = (stringify(_field)),                               \
498     .num_offset = vmstate_offset_value(_state, _field_num, uint8_t), \
499     .version_id = (_version),                                        \
500     .vmsd       = &(_vmsd),                                          \
501     .size       = sizeof(_type),                                     \
502     .flags      = VMS_STRUCT|VMS_VARRAY_UINT8,                       \
503     .offset     = offsetof(_state, _field),                          \
504 }
505 
506 /* a variable length array (i.e. _type *_field) but we know the
507  * length
508  */
509 #define VMSTATE_STRUCT_VARRAY_POINTER_KNOWN(_field, _state, _num, _version, _vmsd, _type) { \
510     .name       = (stringify(_field)),                               \
511     .num          = (_num),                                          \
512     .version_id = (_version),                                        \
513     .vmsd       = &(_vmsd),                                          \
514     .size       = sizeof(_type),                                     \
515     .flags      = VMS_STRUCT|VMS_ARRAY|VMS_POINTER,                  \
516     .offset     = offsetof(_state, _field),                          \
517 }
518 
519 #define VMSTATE_STRUCT_VARRAY_POINTER_INT32(_field, _state, _field_num, _vmsd, _type) { \
520     .name       = (stringify(_field)),                               \
521     .version_id = 0,                                                 \
522     .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
523     .size       = sizeof(_type),                                     \
524     .vmsd       = &(_vmsd),                                          \
525     .flags      = VMS_POINTER | VMS_VARRAY_INT32 | VMS_STRUCT,       \
526     .offset     = vmstate_offset_pointer(_state, _field, _type),     \
527 }
528 
529 #define VMSTATE_STRUCT_VARRAY_POINTER_UINT32(_field, _state, _field_num, _vmsd, _type) { \
530     .name       = (stringify(_field)),                               \
531     .version_id = 0,                                                 \
532     .num_offset = vmstate_offset_value(_state, _field_num, uint32_t),\
533     .size       = sizeof(_type),                                     \
534     .vmsd       = &(_vmsd),                                          \
535     .flags      = VMS_POINTER | VMS_VARRAY_INT32 | VMS_STRUCT,       \
536     .offset     = vmstate_offset_pointer(_state, _field, _type),     \
537 }
538 
539 #define VMSTATE_STRUCT_VARRAY_POINTER_UINT16(_field, _state, _field_num, _vmsd, _type) { \
540     .name       = (stringify(_field)),                               \
541     .version_id = 0,                                                 \
542     .num_offset = vmstate_offset_value(_state, _field_num, uint16_t),\
543     .size       = sizeof(_type),                                     \
544     .vmsd       = &(_vmsd),                                          \
545     .flags      = VMS_POINTER | VMS_VARRAY_UINT16 | VMS_STRUCT,      \
546     .offset     = vmstate_offset_pointer(_state, _field, _type),     \
547 }
548 
549 #define VMSTATE_STRUCT_VARRAY_INT32(_field, _state, _field_num, _version, _vmsd, _type) { \
550     .name       = (stringify(_field)),                               \
551     .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
552     .version_id = (_version),                                        \
553     .vmsd       = &(_vmsd),                                          \
554     .size       = sizeof(_type),                                     \
555     .flags      = VMS_STRUCT|VMS_VARRAY_INT32,                       \
556     .offset     = offsetof(_state, _field),                          \
557 }
558 
559 #define VMSTATE_STRUCT_VARRAY_UINT32(_field, _state, _field_num, _version, _vmsd, _type) { \
560     .name       = (stringify(_field)),                               \
561     .num_offset = vmstate_offset_value(_state, _field_num, uint32_t), \
562     .version_id = (_version),                                        \
563     .vmsd       = &(_vmsd),                                          \
564     .size       = sizeof(_type),                                     \
565     .flags      = VMS_STRUCT|VMS_VARRAY_UINT32,                      \
566     .offset     = offsetof(_state, _field),                          \
567 }
568 
569 #define VMSTATE_STRUCT_VARRAY_ALLOC(_field, _state, _field_num, _version, _vmsd, _type) {\
570     .name       = (stringify(_field)),                               \
571     .version_id = (_version),                                        \
572     .vmsd       = &(_vmsd),                                          \
573     .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
574     .size       = sizeof(_type),                                     \
575     .flags      = VMS_STRUCT|VMS_VARRAY_INT32|VMS_ALLOC|VMS_POINTER, \
576     .offset     = vmstate_offset_pointer(_state, _field, _type),     \
577 }
578 
579 #define VMSTATE_STATIC_BUFFER(_field, _state, _version, _test, _start, _size) { \
580     .name         = (stringify(_field)),                             \
581     .version_id   = (_version),                                      \
582     .field_exists = (_test),                                         \
583     .size         = (_size - _start),                                \
584     .info         = &vmstate_info_buffer,                            \
585     .flags        = VMS_BUFFER,                                      \
586     .offset       = vmstate_offset_buffer(_state, _field) + _start,  \
587 }
588 
589 #define VMSTATE_VBUFFER_MULTIPLY(_field, _state, _version, _test, _start, _field_size, _multiply) { \
590     .name         = (stringify(_field)),                             \
591     .version_id   = (_version),                                      \
592     .field_exists = (_test),                                         \
593     .size_offset  = vmstate_offset_value(_state, _field_size, uint32_t),\
594     .size         = (_multiply),                                      \
595     .info         = &vmstate_info_buffer,                            \
596     .flags        = VMS_VBUFFER|VMS_POINTER|VMS_MULTIPLY,            \
597     .offset       = offsetof(_state, _field),                        \
598     .start        = (_start),                                        \
599 }
600 
601 #define VMSTATE_VBUFFER(_field, _state, _version, _test, _start, _field_size) { \
602     .name         = (stringify(_field)),                             \
603     .version_id   = (_version),                                      \
604     .field_exists = (_test),                                         \
605     .size_offset  = vmstate_offset_value(_state, _field_size, int32_t),\
606     .info         = &vmstate_info_buffer,                            \
607     .flags        = VMS_VBUFFER|VMS_POINTER,                         \
608     .offset       = offsetof(_state, _field),                        \
609     .start        = (_start),                                        \
610 }
611 
612 #define VMSTATE_VBUFFER_UINT32(_field, _state, _version, _test, _start, _field_size) { \
613     .name         = (stringify(_field)),                             \
614     .version_id   = (_version),                                      \
615     .field_exists = (_test),                                         \
616     .size_offset  = vmstate_offset_value(_state, _field_size, uint32_t),\
617     .info         = &vmstate_info_buffer,                            \
618     .flags        = VMS_VBUFFER|VMS_POINTER,                         \
619     .offset       = offsetof(_state, _field),                        \
620     .start        = (_start),                                        \
621 }
622 
623 #define VMSTATE_VBUFFER_ALLOC_UINT32(_field, _state, _version, _test, _start, _field_size) { \
624     .name         = (stringify(_field)),                             \
625     .version_id   = (_version),                                      \
626     .field_exists = (_test),                                         \
627     .size_offset  = vmstate_offset_value(_state, _field_size, uint32_t),\
628     .info         = &vmstate_info_buffer,                            \
629     .flags        = VMS_VBUFFER|VMS_POINTER|VMS_ALLOC,               \
630     .offset       = offsetof(_state, _field),                        \
631     .start        = (_start),                                        \
632 }
633 
634 #define VMSTATE_BUFFER_UNSAFE_INFO_TEST(_field, _state, _test, _version, _info, _size) { \
635     .name       = (stringify(_field)),                               \
636     .version_id = (_version),                                        \
637     .field_exists = (_test),                                         \
638     .size       = (_size),                                           \
639     .info       = &(_info),                                          \
640     .flags      = VMS_BUFFER,                                        \
641     .offset     = offsetof(_state, _field),                          \
642 }
643 
644 #define VMSTATE_BUFFER_POINTER_UNSAFE(_field, _state, _version, _size) { \
645     .name       = (stringify(_field)),                               \
646     .version_id = (_version),                                        \
647     .size       = (_size),                                           \
648     .info       = &vmstate_info_buffer,                              \
649     .flags      = VMS_BUFFER|VMS_POINTER,                            \
650     .offset     = offsetof(_state, _field),                          \
651 }
652 
653 #define VMSTATE_UNUSED_BUFFER(_test, _version, _size) {              \
654     .name         = "unused",                                        \
655     .field_exists = (_test),                                         \
656     .version_id   = (_version),                                      \
657     .size         = (_size),                                         \
658     .info         = &vmstate_info_unused_buffer,                     \
659     .flags        = VMS_BUFFER,                                      \
660 }
661 
662 /* _field_size should be a int32_t field in the _state struct giving the
663  * size of the bitmap _field in bits.
664  */
665 #define VMSTATE_BITMAP(_field, _state, _version, _field_size) {      \
666     .name         = (stringify(_field)),                             \
667     .version_id   = (_version),                                      \
668     .size_offset  = vmstate_offset_value(_state, _field_size, int32_t),\
669     .info         = &vmstate_info_bitmap,                            \
670     .flags        = VMS_VBUFFER|VMS_POINTER,                         \
671     .offset       = offsetof(_state, _field),                        \
672 }
673 
674 /* _f : field name
675    _f_n : num of elements field_name
676    _n : num of elements
677    _s : struct state name
678    _v : version
679 */
680 
681 #define VMSTATE_SINGLE(_field, _state, _version, _info, _type)        \
682     VMSTATE_SINGLE_TEST(_field, _state, NULL, _version, _info, _type)
683 
684 #define VMSTATE_STRUCT(_field, _state, _version, _vmsd, _type)        \
685     VMSTATE_STRUCT_TEST(_field, _state, NULL, _version, _vmsd, _type)
686 
687 #define VMSTATE_STRUCT_POINTER(_field, _state, _vmsd, _type)          \
688     VMSTATE_STRUCT_POINTER_V(_field, _state, 0, _vmsd, _type)
689 
690 #define VMSTATE_STRUCT_POINTER_TEST(_field, _state, _test, _vmsd, _type)     \
691     VMSTATE_STRUCT_POINTER_TEST_V(_field, _state, _test, 0, _vmsd, _type)
692 
693 #define VMSTATE_STRUCT_ARRAY(_field, _state, _num, _version, _vmsd, _type) \
694     VMSTATE_STRUCT_ARRAY_TEST(_field, _state, _num, NULL, _version,   \
695             _vmsd, _type)
696 
697 #define VMSTATE_BUFFER_UNSAFE_INFO(_field, _state, _version, _info, _size) \
698     VMSTATE_BUFFER_UNSAFE_INFO_TEST(_field, _state, NULL, _version, _info, \
699             _size)
700 
701 #define VMSTATE_BOOL_V(_f, _s, _v)                                    \
702     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_bool, bool)
703 
704 #define VMSTATE_INT8_V(_f, _s, _v)                                    \
705     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int8, int8_t)
706 #define VMSTATE_INT16_V(_f, _s, _v)                                   \
707     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int16, int16_t)
708 #define VMSTATE_INT32_V(_f, _s, _v)                                   \
709     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int32, int32_t)
710 #define VMSTATE_INT64_V(_f, _s, _v)                                   \
711     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int64, int64_t)
712 
713 #define VMSTATE_UINT8_V(_f, _s, _v)                                   \
714     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint8, uint8_t)
715 #define VMSTATE_UINT16_V(_f, _s, _v)                                  \
716     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint16, uint16_t)
717 #define VMSTATE_UINT32_V(_f, _s, _v)                                  \
718     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint32, uint32_t)
719 #define VMSTATE_UINT64_V(_f, _s, _v)                                  \
720     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint64, uint64_t)
721 
722 #define VMSTATE_BOOL(_f, _s)                                          \
723     VMSTATE_BOOL_V(_f, _s, 0)
724 
725 #define VMSTATE_INT8(_f, _s)                                          \
726     VMSTATE_INT8_V(_f, _s, 0)
727 #define VMSTATE_INT16(_f, _s)                                         \
728     VMSTATE_INT16_V(_f, _s, 0)
729 #define VMSTATE_INT32(_f, _s)                                         \
730     VMSTATE_INT32_V(_f, _s, 0)
731 #define VMSTATE_INT64(_f, _s)                                         \
732     VMSTATE_INT64_V(_f, _s, 0)
733 
734 #define VMSTATE_UINT8(_f, _s)                                         \
735     VMSTATE_UINT8_V(_f, _s, 0)
736 #define VMSTATE_UINT16(_f, _s)                                        \
737     VMSTATE_UINT16_V(_f, _s, 0)
738 #define VMSTATE_UINT32(_f, _s)                                        \
739     VMSTATE_UINT32_V(_f, _s, 0)
740 #define VMSTATE_UINT64(_f, _s)                                        \
741     VMSTATE_UINT64_V(_f, _s, 0)
742 
743 #define VMSTATE_UINT8_EQUAL(_f, _s)                                   \
744     VMSTATE_SINGLE(_f, _s, 0, vmstate_info_uint8_equal, uint8_t)
745 
746 #define VMSTATE_UINT16_EQUAL(_f, _s)                                  \
747     VMSTATE_SINGLE(_f, _s, 0, vmstate_info_uint16_equal, uint16_t)
748 
749 #define VMSTATE_UINT16_EQUAL_V(_f, _s, _v)                            \
750     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint16_equal, uint16_t)
751 
752 #define VMSTATE_INT32_EQUAL(_f, _s)                                   \
753     VMSTATE_SINGLE(_f, _s, 0, vmstate_info_int32_equal, int32_t)
754 
755 #define VMSTATE_UINT32_EQUAL_V(_f, _s, _v)                            \
756     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint32_equal, uint32_t)
757 
758 #define VMSTATE_UINT32_EQUAL(_f, _s)                                  \
759     VMSTATE_UINT32_EQUAL_V(_f, _s, 0)
760 
761 #define VMSTATE_UINT64_EQUAL_V(_f, _s, _v)                            \
762     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint64_equal, uint64_t)
763 
764 #define VMSTATE_UINT64_EQUAL(_f, _s)                                  \
765     VMSTATE_UINT64_EQUAL_V(_f, _s, 0)
766 
767 #define VMSTATE_INT32_POSITIVE_LE(_f, _s)                             \
768     VMSTATE_SINGLE(_f, _s, 0, vmstate_info_int32_le, int32_t)
769 
770 #define VMSTATE_INT8_TEST(_f, _s, _t)                               \
771     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_int8, int8_t)
772 
773 #define VMSTATE_INT16_TEST(_f, _s, _t)                               \
774     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_int16, int16_t)
775 
776 #define VMSTATE_INT32_TEST(_f, _s, _t)                                  \
777     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_int32, int32_t)
778 
779 #define VMSTATE_INT64_TEST(_f, _s, _t)                                  \
780     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_int64, int64_t)
781 
782 #define VMSTATE_UINT8_TEST(_f, _s, _t)                               \
783     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint8, uint8_t)
784 
785 #define VMSTATE_UINT16_TEST(_f, _s, _t)                               \
786     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint16, uint16_t)
787 
788 #define VMSTATE_UINT32_TEST(_f, _s, _t)                                  \
789     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint32, uint32_t)
790 
791 #define VMSTATE_UINT64_TEST(_f, _s, _t)                                  \
792     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint64, uint64_t)
793 
794 
795 #define VMSTATE_FLOAT64_V(_f, _s, _v)                                 \
796     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_float64, float64)
797 
798 #define VMSTATE_FLOAT64(_f, _s)                                       \
799     VMSTATE_FLOAT64_V(_f, _s, 0)
800 
801 #define VMSTATE_TIMER_PTR_TEST(_f, _s, _test)                             \
802     VMSTATE_POINTER_TEST(_f, _s, _test, vmstate_info_timer, QEMUTimer *)
803 
804 #define VMSTATE_TIMER_PTR_V(_f, _s, _v)                                   \
805     VMSTATE_POINTER(_f, _s, _v, vmstate_info_timer, QEMUTimer *)
806 
807 #define VMSTATE_TIMER_PTR(_f, _s)                                         \
808     VMSTATE_TIMER_PTR_V(_f, _s, 0)
809 
810 #define VMSTATE_TIMER_PTR_ARRAY(_f, _s, _n)                              \
811     VMSTATE_ARRAY_OF_POINTER(_f, _s, _n, 0, vmstate_info_timer, QEMUTimer *)
812 
813 #define VMSTATE_TIMER_TEST(_f, _s, _test)                             \
814     VMSTATE_SINGLE_TEST(_f, _s, _test, 0, vmstate_info_timer, QEMUTimer)
815 
816 #define VMSTATE_TIMER_V(_f, _s, _v)                                   \
817     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_timer, QEMUTimer)
818 
819 #define VMSTATE_TIMER(_f, _s)                                         \
820     VMSTATE_TIMER_V(_f, _s, 0)
821 
822 #define VMSTATE_TIMER_ARRAY(_f, _s, _n)                              \
823     VMSTATE_ARRAY(_f, _s, _n, 0, vmstate_info_timer, QEMUTimer)
824 
825 #define VMSTATE_BOOL_ARRAY_V(_f, _s, _n, _v)                         \
826     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_bool, bool)
827 
828 #define VMSTATE_BOOL_ARRAY(_f, _s, _n)                               \
829     VMSTATE_BOOL_ARRAY_V(_f, _s, _n, 0)
830 
831 #define VMSTATE_UINT16_ARRAY_V(_f, _s, _n, _v)                         \
832     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint16, uint16_t)
833 
834 #define VMSTATE_UINT16_2DARRAY_V(_f, _s, _n1, _n2, _v)                \
835     VMSTATE_2DARRAY(_f, _s, _n1, _n2, _v, vmstate_info_uint16, uint16_t)
836 
837 #define VMSTATE_UINT16_ARRAY(_f, _s, _n)                               \
838     VMSTATE_UINT16_ARRAY_V(_f, _s, _n, 0)
839 
840 #define VMSTATE_UINT16_2DARRAY(_f, _s, _n1, _n2)                      \
841     VMSTATE_UINT16_2DARRAY_V(_f, _s, _n1, _n2, 0)
842 
843 #define VMSTATE_UINT8_2DARRAY_V(_f, _s, _n1, _n2, _v)                 \
844     VMSTATE_2DARRAY(_f, _s, _n1, _n2, _v, vmstate_info_uint8, uint8_t)
845 
846 #define VMSTATE_UINT8_ARRAY_V(_f, _s, _n, _v)                         \
847     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint8, uint8_t)
848 
849 #define VMSTATE_UINT8_ARRAY(_f, _s, _n)                               \
850     VMSTATE_UINT8_ARRAY_V(_f, _s, _n, 0)
851 
852 #define VMSTATE_UINT8_SUB_ARRAY(_f, _s, _start, _num)                \
853     VMSTATE_SUB_ARRAY(_f, _s, _start, _num, 0, vmstate_info_uint8, uint8_t)
854 
855 #define VMSTATE_UINT8_2DARRAY(_f, _s, _n1, _n2)                       \
856     VMSTATE_UINT8_2DARRAY_V(_f, _s, _n1, _n2, 0)
857 
858 #define VMSTATE_UINT32_ARRAY_V(_f, _s, _n, _v)                        \
859     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint32, uint32_t)
860 
861 #define VMSTATE_UINT32_2DARRAY_V(_f, _s, _n1, _n2, _v)                \
862     VMSTATE_2DARRAY(_f, _s, _n1, _n2, _v, vmstate_info_uint32, uint32_t)
863 
864 #define VMSTATE_UINT32_ARRAY(_f, _s, _n)                              \
865     VMSTATE_UINT32_ARRAY_V(_f, _s, _n, 0)
866 
867 #define VMSTATE_UINT32_2DARRAY(_f, _s, _n1, _n2)                      \
868     VMSTATE_UINT32_2DARRAY_V(_f, _s, _n1, _n2, 0)
869 
870 #define VMSTATE_UINT64_ARRAY_V(_f, _s, _n, _v)                        \
871     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint64, uint64_t)
872 
873 #define VMSTATE_UINT64_ARRAY(_f, _s, _n)                              \
874     VMSTATE_UINT64_ARRAY_V(_f, _s, _n, 0)
875 
876 #define VMSTATE_UINT64_2DARRAY(_f, _s, _n1, _n2)                      \
877     VMSTATE_UINT64_2DARRAY_V(_f, _s, _n1, _n2, 0)
878 
879 #define VMSTATE_UINT64_2DARRAY_V(_f, _s, _n1, _n2, _v)                 \
880     VMSTATE_2DARRAY(_f, _s, _n1, _n2, _v, vmstate_info_uint64, uint64_t)
881 
882 #define VMSTATE_INT16_ARRAY_V(_f, _s, _n, _v)                         \
883     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int16, int16_t)
884 
885 #define VMSTATE_INT16_ARRAY(_f, _s, _n)                               \
886     VMSTATE_INT16_ARRAY_V(_f, _s, _n, 0)
887 
888 #define VMSTATE_INT32_ARRAY_V(_f, _s, _n, _v)                         \
889     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int32, int32_t)
890 
891 #define VMSTATE_INT32_ARRAY(_f, _s, _n)                               \
892     VMSTATE_INT32_ARRAY_V(_f, _s, _n, 0)
893 
894 #define VMSTATE_UINT32_SUB_ARRAY(_f, _s, _start, _num)                \
895     VMSTATE_SUB_ARRAY(_f, _s, _start, _num, 0, vmstate_info_uint32, uint32_t)
896 
897 #define VMSTATE_INT64_ARRAY_V(_f, _s, _n, _v)                         \
898     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int64, int64_t)
899 
900 #define VMSTATE_INT64_ARRAY(_f, _s, _n)                               \
901     VMSTATE_INT64_ARRAY_V(_f, _s, _n, 0)
902 
903 #define VMSTATE_FLOAT64_ARRAY_V(_f, _s, _n, _v)                       \
904     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_float64, float64)
905 
906 #define VMSTATE_FLOAT64_ARRAY(_f, _s, _n)                             \
907     VMSTATE_FLOAT64_ARRAY_V(_f, _s, _n, 0)
908 
909 #define VMSTATE_CPUDOUBLE_ARRAY_V(_f, _s, _n, _v)                     \
910     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_cpudouble, CPU_DoubleU)
911 
912 #define VMSTATE_CPUDOUBLE_ARRAY(_f, _s, _n)                           \
913     VMSTATE_CPUDOUBLE_ARRAY_V(_f, _s, _n, 0)
914 
915 #define VMSTATE_BUFFER_V(_f, _s, _v)                                  \
916     VMSTATE_STATIC_BUFFER(_f, _s, _v, NULL, 0, sizeof(typeof_field(_s, _f)))
917 
918 #define VMSTATE_BUFFER(_f, _s)                                        \
919     VMSTATE_BUFFER_V(_f, _s, 0)
920 
921 #define VMSTATE_PARTIAL_BUFFER(_f, _s, _size)                         \
922     VMSTATE_STATIC_BUFFER(_f, _s, 0, NULL, 0, _size)
923 
924 #define VMSTATE_BUFFER_START_MIDDLE_V(_f, _s, _start, _v) \
925     VMSTATE_STATIC_BUFFER(_f, _s, _v, NULL, _start, sizeof(typeof_field(_s, _f)))
926 
927 #define VMSTATE_BUFFER_START_MIDDLE(_f, _s, _start) \
928     VMSTATE_BUFFER_START_MIDDLE_V(_f, _s, _start, 0)
929 
930 #define VMSTATE_PARTIAL_VBUFFER(_f, _s, _size)                        \
931     VMSTATE_VBUFFER(_f, _s, 0, NULL, 0, _size)
932 
933 #define VMSTATE_PARTIAL_VBUFFER_UINT32(_f, _s, _size)                        \
934     VMSTATE_VBUFFER_UINT32(_f, _s, 0, NULL, 0, _size)
935 
936 #define VMSTATE_SUB_VBUFFER(_f, _s, _start, _size)                    \
937     VMSTATE_VBUFFER(_f, _s, 0, NULL, _start, _size)
938 
939 #define VMSTATE_BUFFER_TEST(_f, _s, _test)                            \
940     VMSTATE_STATIC_BUFFER(_f, _s, 0, _test, 0, sizeof(typeof_field(_s, _f)))
941 
942 #define VMSTATE_BUFFER_UNSAFE(_field, _state, _version, _size)        \
943     VMSTATE_BUFFER_UNSAFE_INFO(_field, _state, _version, vmstate_info_buffer, _size)
944 
945 #define VMSTATE_UNUSED_V(_v, _size)                                   \
946     VMSTATE_UNUSED_BUFFER(NULL, _v, _size)
947 
948 #define VMSTATE_UNUSED(_size)                                         \
949     VMSTATE_UNUSED_V(0, _size)
950 
951 #define VMSTATE_UNUSED_TEST(_test, _size)                             \
952     VMSTATE_UNUSED_BUFFER(_test, 0, _size)
953 
954 #define VMSTATE_END_OF_LIST()                                         \
955     {}
956 
957 #define SELF_ANNOUNCE_ROUNDS 5
958 
959 void loadvm_free_handlers(MigrationIncomingState *mis);
960 
961 int vmstate_load_state(QEMUFile *f, const VMStateDescription *vmsd,
962                        void *opaque, int version_id);
963 void vmstate_save_state(QEMUFile *f, const VMStateDescription *vmsd,
964                         void *opaque, QJSON *vmdesc);
965 
966 bool vmstate_save_needed(const VMStateDescription *vmsd, void *opaque);
967 
968 int vmstate_register_with_alias_id(DeviceState *dev, int instance_id,
969                                    const VMStateDescription *vmsd,
970                                    void *base, int alias_id,
971                                    int required_for_version);
972 
973 static inline int vmstate_register(DeviceState *dev, int instance_id,
974                                    const VMStateDescription *vmsd,
975                                    void *opaque)
976 {
977     return vmstate_register_with_alias_id(dev, instance_id, vmsd,
978                                           opaque, -1, 0);
979 }
980 
981 void vmstate_unregister(DeviceState *dev, const VMStateDescription *vmsd,
982                         void *opaque);
983 
984 struct MemoryRegion;
985 void vmstate_register_ram(struct MemoryRegion *memory, DeviceState *dev);
986 void vmstate_unregister_ram(struct MemoryRegion *memory, DeviceState *dev);
987 void vmstate_register_ram_global(struct MemoryRegion *memory);
988 
989 static inline
990 int64_t self_announce_delay(int round)
991 {
992     assert(round < SELF_ANNOUNCE_ROUNDS && round > 0);
993     /* delay 50ms, 150ms, 250ms, ... */
994     return 50 + (SELF_ANNOUNCE_ROUNDS - round - 1) * 100;
995 }
996 
997 void dump_vmstate_json_to_file(FILE *out_fp);
998 
999 #endif
1000