include/migration/vmstate.h

   1 /*
   2  * QEMU migration/snapshot declarations
   3  *
   4  * Copyright (c) 2009-2011 Red Hat, Inc.
   5  *
   6  * Original author: Juan Quintela <[email protected]>
   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 extern const VMStateInfo vmstate_info_qtailq;
 264
 265 #define type_check_2darray(t1,t2,n,m) ((t1(*)[n][m])0 - (t2*)0)
 266 #define type_check_array(t1,t2,n) ((t1(*)[n])0 - (t2*)0)
 267 #define type_check_pointer(t1,t2) ((t1**)0 - (t2*)0)
 268
 269 #define vmstate_offset_value(_state, _field, _type)                  \
 270     (offsetof(_state, _field) +                                      \
 271      type_check(_type, typeof_field(_state, _field)))
 272
 273 #define vmstate_offset_pointer(_state, _field, _type)                \
 274     (offsetof(_state, _field) +                                      \
 275      type_check_pointer(_type, typeof_field(_state, _field)))
 276
 277 #define vmstate_offset_array(_state, _field, _type, _num)            \
 278     (offsetof(_state, _field) +                                      \
 279      type_check_array(_type, typeof_field(_state, _field), _num))
 280
 281 #define vmstate_offset_2darray(_state, _field, _type, _n1, _n2)      \
 282     (offsetof(_state, _field) +                                      \
 283      type_check_2darray(_type, typeof_field(_state, _field), _n1, _n2))
 284
 285 #define vmstate_offset_sub_array(_state, _field, _type, _start)      \
 286     vmstate_offset_value(_state, _field[_start], _type)
 287
 288 #define vmstate_offset_buffer(_state, _field)                        \
 289     vmstate_offset_array(_state, _field, uint8_t,                    \
 290                          sizeof(typeof_field(_state, _field)))
 291
 292 #define VMSTATE_SINGLE_TEST(_field, _state, _test, _version, _info, _type) { \
 293     .name         = (stringify(_field)),                             \
 294     .version_id   = (_version),                                      \
 295     .field_exists = (_test),                                         \
 296     .size         = sizeof(_type),                                   \
 297     .info         = &(_info),                                        \
 298     .flags        = VMS_SINGLE,                                      \
 299     .offset       = vmstate_offset_value(_state, _field, _type),     \
 300 }
 301
 302 /* Validate state using a boolean predicate. */
 303 #define VMSTATE_VALIDATE(_name, _test) { \
 304     .name         = (_name),                                         \
 305     .field_exists = (_test),                                         \
 306     .flags        = VMS_ARRAY | VMS_MUST_EXIST,                      \
 307     .num          = 0, /* 0 elements: no data, only run _test */     \
 308 }
 309
 310 #define VMSTATE_POINTER(_field, _state, _version, _info, _type) {    \
 311     .name       = (stringify(_field)),                               \
 312     .version_id = (_version),                                        \
 313     .info       = &(_info),                                          \
 314     .size       = sizeof(_type),                                     \
 315     .flags      = VMS_SINGLE|VMS_POINTER,                            \
 316     .offset     = vmstate_offset_value(_state, _field, _type),       \
 317 }
 318
 319 #define VMSTATE_POINTER_TEST(_field, _state, _test, _info, _type) {  \
 320     .name       = (stringify(_field)),                               \
 321     .info       = &(_info),                                          \
 322     .field_exists = (_test),                                         \
 323     .size       = sizeof(_type),                                     \
 324     .flags      = VMS_SINGLE|VMS_POINTER,                            \
 325     .offset     = vmstate_offset_value(_state, _field, _type),       \
 326 }
 327
 328 #define VMSTATE_ARRAY(_field, _state, _num, _version, _info, _type) {\
 329     .name       = (stringify(_field)),                               \
 330     .version_id = (_version),                                        \
 331     .num        = (_num),                                            \
 332     .info       = &(_info),                                          \
 333     .size       = sizeof(_type),                                     \
 334     .flags      = VMS_ARRAY,                                         \
 335     .offset     = vmstate_offset_array(_state, _field, _type, _num), \
 336 }
 337
 338 #define VMSTATE_2DARRAY(_field, _state, _n1, _n2, _version, _info, _type) { \
 339     .name       = (stringify(_field)),                                      \
 340     .version_id = (_version),                                               \
 341     .num        = (_n1) * (_n2),                                            \
 342     .info       = &(_info),                                                 \
 343     .size       = sizeof(_type),                                            \
 344     .flags      = VMS_ARRAY,                                                \
 345     .offset     = vmstate_offset_2darray(_state, _field, _type, _n1, _n2),  \
 346 }
 347
 348 #define VMSTATE_VARRAY_MULTIPLY(_field, _state, _field_num, _multiply, _info, _type) { \
 349     .name       = (stringify(_field)),                               \
 350     .num_offset = vmstate_offset_value(_state, _field_num, uint32_t),\
 351     .num        = (_multiply),                                       \
 352     .info       = &(_info),                                          \
 353     .size       = sizeof(_type),                                     \
 354     .flags      = VMS_VARRAY_UINT32|VMS_MULTIPLY_ELEMENTS,           \
 355     .offset     = offsetof(_state, _field),                          \
 356 }
 357
 358 #define VMSTATE_ARRAY_TEST(_field, _state, _num, _test, _info, _type) {\
 359     .name         = (stringify(_field)),                              \
 360     .field_exists = (_test),                                          \
 361     .num          = (_num),                                           \
 362     .info         = &(_info),                                         \
 363     .size         = sizeof(_type),                                    \
 364     .flags        = VMS_ARRAY,                                        \
 365     .offset       = vmstate_offset_array(_state, _field, _type, _num),\
 366 }
 367
 368 #define VMSTATE_SUB_ARRAY(_field, _state, _start, _num, _version, _info, _type) { \
 369     .name       = (stringify(_field)),                               \
 370     .version_id = (_version),                                        \
 371     .num        = (_num),                                            \
 372     .info       = &(_info),                                          \
 373     .size       = sizeof(_type),                                     \
 374     .flags      = VMS_ARRAY,                                         \
 375     .offset     = vmstate_offset_sub_array(_state, _field, _type, _start), \
 376 }
 377
 378 #define VMSTATE_ARRAY_INT32_UNSAFE(_field, _state, _field_num, _info, _type) {\
 379     .name       = (stringify(_field)),                               \
 380     .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
 381     .info       = &(_info),                                          \
 382     .size       = sizeof(_type),                                     \
 383     .flags      = VMS_VARRAY_INT32,                                  \
 384     .offset     = offsetof(_state, _field),                          \
 385 }
 386
 387 #define VMSTATE_VARRAY_INT32(_field, _state, _field_num, _version, _info, _type) {\
 388     .name       = (stringify(_field)),                               \
 389     .version_id = (_version),                                        \
 390     .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
 391     .info       = &(_info),                                          \
 392     .size       = sizeof(_type),                                     \
 393     .flags      = VMS_VARRAY_INT32|VMS_POINTER,                      \
 394     .offset     = vmstate_offset_pointer(_state, _field, _type),     \
 395 }
 396
 397 #define VMSTATE_VARRAY_UINT32(_field, _state, _field_num, _version, _info, _type) {\
 398     .name       = (stringify(_field)),                               \
 399     .version_id = (_version),                                        \
 400     .num_offset = vmstate_offset_value(_state, _field_num, uint32_t),\
 401     .info       = &(_info),                                          \
 402     .size       = sizeof(_type),                                     \
 403     .flags      = VMS_VARRAY_UINT32|VMS_POINTER,                     \
 404     .offset     = vmstate_offset_pointer(_state, _field, _type),     \
 405 }
 406
 407 #define VMSTATE_VARRAY_UINT32_ALLOC(_field, _state, _field_num, _version, _info, _type) {\
 408     .name       = (stringify(_field)),                               \
 409     .version_id = (_version),                                        \
 410     .num_offset = vmstate_offset_value(_state, _field_num, uint32_t),\
 411     .info       = &(_info),                                          \
 412     .size       = sizeof(_type),                                     \
 413     .flags      = VMS_VARRAY_UINT32|VMS_POINTER|VMS_ALLOC,           \
 414     .offset     = vmstate_offset_pointer(_state, _field, _type),     \
 415 }
 416
 417 #define VMSTATE_VARRAY_UINT16_UNSAFE(_field, _state, _field_num, _version, _info, _type) {\
 418     .name       = (stringify(_field)),                               \
 419     .version_id = (_version),                                        \
 420     .num_offset = vmstate_offset_value(_state, _field_num, uint16_t),\
 421     .info       = &(_info),                                          \
 422     .size       = sizeof(_type),                                     \
 423     .flags      = VMS_VARRAY_UINT16,                                 \
 424     .offset     = offsetof(_state, _field),                          \
 425 }
 426
 427 #define VMSTATE_STRUCT_TEST(_field, _state, _test, _version, _vmsd, _type) { \
 428     .name         = (stringify(_field)),                             \
 429     .version_id   = (_version),                                      \
 430     .field_exists = (_test),                                         \
 431     .vmsd         = &(_vmsd),                                        \
 432     .size         = sizeof(_type),                                   \
 433     .flags        = VMS_STRUCT,                                      \
 434     .offset       = vmstate_offset_value(_state, _field, _type),     \
 435 }
 436
 437 #define VMSTATE_STRUCT_POINTER_V(_field, _state, _version, _vmsd, _type) { \
 438     .name         = (stringify(_field)),                             \
 439     .version_id   = (_version),                                        \
 440     .vmsd         = &(_vmsd),                                        \
 441     .size         = sizeof(_type *),                                 \
 442     .flags        = VMS_STRUCT|VMS_POINTER,                          \
 443     .offset       = vmstate_offset_pointer(_state, _field, _type),   \
 444 }
 445
 446 #define VMSTATE_STRUCT_POINTER_TEST_V(_field, _state, _test, _version, _vmsd, _type) { \
 447     .name         = (stringify(_field)),                             \
 448     .version_id   = (_version),                                        \
 449     .field_exists = (_test),                                         \
 450     .vmsd         = &(_vmsd),                                        \
 451     .size         = sizeof(_type *),                                 \
 452     .flags        = VMS_STRUCT|VMS_POINTER,                          \
 453     .offset       = vmstate_offset_pointer(_state, _field, _type),   \
 454 }
 455
 456 #define VMSTATE_ARRAY_OF_POINTER(_field, _state, _num, _version, _info, _type) {\
 457     .name       = (stringify(_field)),                               \
 458     .version_id = (_version),                                        \
 459     .num        = (_num),                                            \
 460     .info       = &(_info),                                          \
 461     .size       = sizeof(_type),                                     \
 462     .flags      = VMS_ARRAY|VMS_ARRAY_OF_POINTER,                    \
 463     .offset     = vmstate_offset_array(_state, _field, _type, _num), \
 464 }
 465
 466 #define VMSTATE_ARRAY_OF_POINTER_TO_STRUCT(_f, _s, _n, _v, _vmsd, _type) { \
 467     .name       = (stringify(_f)),                                   \
 468     .version_id = (_v),                                              \
 469     .num        = (_n),                                              \
 470     .vmsd       = &(_vmsd),                                          \
 471     .size       = sizeof(_type *),                                    \
 472     .flags      = VMS_ARRAY|VMS_STRUCT|VMS_ARRAY_OF_POINTER,         \
 473     .offset     = vmstate_offset_array(_s, _f, _type*, _n),          \
 474 }
 475
 476 #define VMSTATE_STRUCT_SUB_ARRAY(_field, _state, _start, _num, _version, _vmsd, _type) { \
 477     .name       = (stringify(_field)),                                     \
 478     .version_id = (_version),                                              \
 479     .num        = (_num),                                                  \
 480     .vmsd       = &(_vmsd),                                                \
 481     .size       = sizeof(_type),                                           \
 482     .flags      = VMS_STRUCT|VMS_ARRAY,                                    \
 483     .offset     = vmstate_offset_sub_array(_state, _field, _type, _start), \
 484 }
 485
 486 #define VMSTATE_STRUCT_ARRAY_TEST(_field, _state, _num, _test, _version, _vmsd, _type) { \
 487     .name         = (stringify(_field)),                             \
 488     .num          = (_num),                                          \
 489     .field_exists = (_test),                                         \
 490     .version_id   = (_version),                                      \
 491     .vmsd         = &(_vmsd),                                        \
 492     .size         = sizeof(_type),                                   \
 493     .flags        = VMS_STRUCT|VMS_ARRAY,                            \
 494     .offset       = vmstate_offset_array(_state, _field, _type, _num),\
 495 }
 496
 497 #define VMSTATE_STRUCT_VARRAY_UINT8(_field, _state, _field_num, _version, _vmsd, _type) { \
 498     .name       = (stringify(_field)),                               \
 499     .num_offset = vmstate_offset_value(_state, _field_num, uint8_t), \
 500     .version_id = (_version),                                        \
 501     .vmsd       = &(_vmsd),                                          \
 502     .size       = sizeof(_type),                                     \
 503     .flags      = VMS_STRUCT|VMS_VARRAY_UINT8,                       \
 504     .offset     = offsetof(_state, _field),                          \
 505 }
 506
 507 /* a variable length array (i.e. _type *_field) but we know the
 508  * length
 509  */
 510 #define VMSTATE_STRUCT_VARRAY_POINTER_KNOWN(_field, _state, _num, _version, _vmsd, _type) { \
 511     .name       = (stringify(_field)),                               \
 512     .num          = (_num),                                          \
 513     .version_id = (_version),                                        \
 514     .vmsd       = &(_vmsd),                                          \
 515     .size       = sizeof(_type),                                     \
 516     .flags      = VMS_STRUCT|VMS_ARRAY|VMS_POINTER,                  \
 517     .offset     = offsetof(_state, _field),                          \
 518 }
 519
 520 #define VMSTATE_STRUCT_VARRAY_POINTER_INT32(_field, _state, _field_num, _vmsd, _type) { \
 521     .name       = (stringify(_field)),                               \
 522     .version_id = 0,                                                 \
 523     .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
 524     .size       = sizeof(_type),                                     \
 525     .vmsd       = &(_vmsd),                                          \
 526     .flags      = VMS_POINTER | VMS_VARRAY_INT32 | VMS_STRUCT,       \
 527     .offset     = vmstate_offset_pointer(_state, _field, _type),     \
 528 }
 529
 530 #define VMSTATE_STRUCT_VARRAY_POINTER_UINT32(_field, _state, _field_num, _vmsd, _type) { \
 531     .name       = (stringify(_field)),                               \
 532     .version_id = 0,                                                 \
 533     .num_offset = vmstate_offset_value(_state, _field_num, uint32_t),\
 534     .size       = sizeof(_type),                                     \
 535     .vmsd       = &(_vmsd),                                          \
 536     .flags      = VMS_POINTER | VMS_VARRAY_INT32 | VMS_STRUCT,       \
 537     .offset     = vmstate_offset_pointer(_state, _field, _type),     \
 538 }
 539
 540 #define VMSTATE_STRUCT_VARRAY_POINTER_UINT16(_field, _state, _field_num, _vmsd, _type) { \
 541     .name       = (stringify(_field)),                               \
 542     .version_id = 0,                                                 \
 543     .num_offset = vmstate_offset_value(_state, _field_num, uint16_t),\
 544     .size       = sizeof(_type),                                     \
 545     .vmsd       = &(_vmsd),                                          \
 546     .flags      = VMS_POINTER | VMS_VARRAY_UINT16 | VMS_STRUCT,      \
 547     .offset     = vmstate_offset_pointer(_state, _field, _type),     \
 548 }
 549
 550 #define VMSTATE_STRUCT_VARRAY_INT32(_field, _state, _field_num, _version, _vmsd, _type) { \
 551     .name       = (stringify(_field)),                               \
 552     .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
 553     .version_id = (_version),                                        \
 554     .vmsd       = &(_vmsd),                                          \
 555     .size       = sizeof(_type),                                     \
 556     .flags      = VMS_STRUCT|VMS_VARRAY_INT32,                       \
 557     .offset     = offsetof(_state, _field),                          \
 558 }
 559
 560 #define VMSTATE_STRUCT_VARRAY_UINT32(_field, _state, _field_num, _version, _vmsd, _type) { \
 561     .name       = (stringify(_field)),                               \
 562     .num_offset = vmstate_offset_value(_state, _field_num, uint32_t), \
 563     .version_id = (_version),                                        \
 564     .vmsd       = &(_vmsd),                                          \
 565     .size       = sizeof(_type),                                     \
 566     .flags      = VMS_STRUCT|VMS_VARRAY_UINT32,                      \
 567     .offset     = offsetof(_state, _field),                          \
 568 }
 569
 570 #define VMSTATE_STRUCT_VARRAY_ALLOC(_field, _state, _field_num, _version, _vmsd, _type) {\
 571     .name       = (stringify(_field)),                               \
 572     .version_id = (_version),                                        \
 573     .vmsd       = &(_vmsd),                                          \
 574     .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
 575     .size       = sizeof(_type),                                     \
 576     .flags      = VMS_STRUCT|VMS_VARRAY_INT32|VMS_ALLOC|VMS_POINTER, \
 577     .offset     = vmstate_offset_pointer(_state, _field, _type),     \
 578 }
 579
 580 #define VMSTATE_STATIC_BUFFER(_field, _state, _version, _test, _start, _size) { \
 581     .name         = (stringify(_field)),                             \
 582     .version_id   = (_version),                                      \
 583     .field_exists = (_test),                                         \
 584     .size         = (_size - _start),                                \
 585     .info         = &vmstate_info_buffer,                            \
 586     .flags        = VMS_BUFFER,                                      \
 587     .offset       = vmstate_offset_buffer(_state, _field) + _start,  \
 588 }
 589
 590 #define VMSTATE_VBUFFER_MULTIPLY(_field, _state, _version, _test,    \
 591                                  _field_size, _multiply) {           \
 592     .name         = (stringify(_field)),                             \
 593     .version_id   = (_version),                                      \
 594     .field_exists = (_test),                                         \
 595     .size_offset  = vmstate_offset_value(_state, _field_size, uint32_t),\
 596     .size         = (_multiply),                                      \
 597     .info         = &vmstate_info_buffer,                            \
 598     .flags        = VMS_VBUFFER|VMS_POINTER|VMS_MULTIPLY,            \
 599     .offset       = offsetof(_state, _field),                        \
 600 }
 601
 602 #define VMSTATE_VBUFFER(_field, _state, _version, _test, _field_size) { \
 603     .name         = (stringify(_field)),                             \
 604     .version_id   = (_version),                                      \
 605     .field_exists = (_test),                                         \
 606     .size_offset  = vmstate_offset_value(_state, _field_size, int32_t),\
 607     .info         = &vmstate_info_buffer,                            \
 608     .flags        = VMS_VBUFFER|VMS_POINTER,                         \
 609     .offset       = offsetof(_state, _field),                        \
 610 }
 611
 612 #define VMSTATE_VBUFFER_UINT32(_field, _state, _version, _test, _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 }
 621
 622 #define VMSTATE_VBUFFER_ALLOC_UINT32(_field, _state, _version,       \
 623                                      _test, _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 }
 632
 633 #define VMSTATE_BUFFER_UNSAFE_INFO_TEST(_field, _state, _test, _version, _info, _size) { \
 634     .name       = (stringify(_field)),                               \
 635     .version_id = (_version),                                        \
 636     .field_exists = (_test),                                         \
 637     .size       = (_size),                                           \
 638     .info       = &(_info),                                          \
 639     .flags      = VMS_BUFFER,                                        \
 640     .offset     = offsetof(_state, _field),                          \
 641 }
 642
 643 #define VMSTATE_BUFFER_POINTER_UNSAFE(_field, _state, _version, _size) { \
 644     .name       = (stringify(_field)),                               \
 645     .version_id = (_version),                                        \
 646     .size       = (_size),                                           \
 647     .info       = &vmstate_info_buffer,                              \
 648     .flags      = VMS_BUFFER|VMS_POINTER,                            \
 649     .offset     = offsetof(_state, _field),                          \
 650 }
 651
 652 #define VMSTATE_UNUSED_BUFFER(_test, _version, _size) {              \
 653     .name         = "unused",                                        \
 654     .field_exists = (_test),                                         \
 655     .version_id   = (_version),                                      \
 656     .size         = (_size),                                         \
 657     .info         = &vmstate_info_unused_buffer,                     \
 658     .flags        = VMS_BUFFER,                                      \
 659 }
 660
 661 /* _field_size should be a int32_t field in the _state struct giving the
 662  * size of the bitmap _field in bits.
 663  */
 664 #define VMSTATE_BITMAP(_field, _state, _version, _field_size) {      \
 665     .name         = (stringify(_field)),                             \
 666     .version_id   = (_version),                                      \
 667     .size_offset  = vmstate_offset_value(_state, _field_size, int32_t),\
 668     .info         = &vmstate_info_bitmap,                            \
 669     .flags        = VMS_VBUFFER|VMS_POINTER,                         \
 670     .offset       = offsetof(_state, _field),                        \
 671 }
 672
 673 /* For migrating a QTAILQ.
 674  * Target QTAILQ needs be properly initialized.
 675  * _type: type of QTAILQ element
 676  * _next: name of QTAILQ entry field in QTAILQ element
 677  * _vmsd: VMSD for QTAILQ element
 678  * size: size of QTAILQ element
 679  * start: offset of QTAILQ entry in QTAILQ element
 680  */
 681 #define VMSTATE_QTAILQ_V(_field, _state, _version, _vmsd, _type, _next)  \
 682 {                                                                        \
 683     .name         = (stringify(_field)),                                 \
 684     .version_id   = (_version),                                          \
 685     .vmsd         = &(_vmsd),                                            \
 686     .size         = sizeof(_type),                                       \
 687     .info         = &vmstate_info_qtailq,                                \
 688     .offset       = offsetof(_state, _field),                            \
 689     .start        = offsetof(_type, _next),                              \
 690 }
 691
 692 /* _f : field name
 693    _f_n : num of elements field_name
 694    _n : num of elements
 695    _s : struct state name
 696    _v : version
 697 */
 698
 699 #define VMSTATE_SINGLE(_field, _state, _version, _info, _type)        \
 700     VMSTATE_SINGLE_TEST(_field, _state, NULL, _version, _info, _type)
 701
 702 #define VMSTATE_STRUCT(_field, _state, _version, _vmsd, _type)        \
 703     VMSTATE_STRUCT_TEST(_field, _state, NULL, _version, _vmsd, _type)
 704
 705 #define VMSTATE_STRUCT_POINTER(_field, _state, _vmsd, _type)          \
 706     VMSTATE_STRUCT_POINTER_V(_field, _state, 0, _vmsd, _type)
 707
 708 #define VMSTATE_STRUCT_POINTER_TEST(_field, _state, _test, _vmsd, _type)     \
 709     VMSTATE_STRUCT_POINTER_TEST_V(_field, _state, _test, 0, _vmsd, _type)
 710
 711 #define VMSTATE_STRUCT_ARRAY(_field, _state, _num, _version, _vmsd, _type) \
 712     VMSTATE_STRUCT_ARRAY_TEST(_field, _state, _num, NULL, _version,   \
 713             _vmsd, _type)
 714
 715 #define VMSTATE_BUFFER_UNSAFE_INFO(_field, _state, _version, _info, _size) \
 716     VMSTATE_BUFFER_UNSAFE_INFO_TEST(_field, _state, NULL, _version, _info, \
 717             _size)
 718
 719 #define VMSTATE_BOOL_V(_f, _s, _v)                                    \
 720     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_bool, bool)
 721
 722 #define VMSTATE_INT8_V(_f, _s, _v)                                    \
 723     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int8, int8_t)
 724 #define VMSTATE_INT16_V(_f, _s, _v)                                   \
 725     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int16, int16_t)
 726 #define VMSTATE_INT32_V(_f, _s, _v)                                   \
 727     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int32, int32_t)
 728 #define VMSTATE_INT64_V(_f, _s, _v)                                   \
 729     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int64, int64_t)
 730
 731 #define VMSTATE_UINT8_V(_f, _s, _v)                                   \
 732     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint8, uint8_t)
 733 #define VMSTATE_UINT16_V(_f, _s, _v)                                  \
 734     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint16, uint16_t)
 735 #define VMSTATE_UINT32_V(_f, _s, _v)                                  \
 736     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint32, uint32_t)
 737 #define VMSTATE_UINT64_V(_f, _s, _v)                                  \
 738     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint64, uint64_t)
 739
 740 #define VMSTATE_BOOL(_f, _s)                                          \
 741     VMSTATE_BOOL_V(_f, _s, 0)
 742
 743 #define VMSTATE_INT8(_f, _s)                                          \
 744     VMSTATE_INT8_V(_f, _s, 0)
 745 #define VMSTATE_INT16(_f, _s)                                         \
 746     VMSTATE_INT16_V(_f, _s, 0)
 747 #define VMSTATE_INT32(_f, _s)                                         \
 748     VMSTATE_INT32_V(_f, _s, 0)
 749 #define VMSTATE_INT64(_f, _s)                                         \
 750     VMSTATE_INT64_V(_f, _s, 0)
 751
 752 #define VMSTATE_UINT8(_f, _s)                                         \
 753     VMSTATE_UINT8_V(_f, _s, 0)
 754 #define VMSTATE_UINT16(_f, _s)                                        \
 755     VMSTATE_UINT16_V(_f, _s, 0)
 756 #define VMSTATE_UINT32(_f, _s)                                        \
 757     VMSTATE_UINT32_V(_f, _s, 0)
 758 #define VMSTATE_UINT64(_f, _s)                                        \
 759     VMSTATE_UINT64_V(_f, _s, 0)
 760
 761 #define VMSTATE_UINT8_EQUAL(_f, _s)                                   \
 762     VMSTATE_SINGLE(_f, _s, 0, vmstate_info_uint8_equal, uint8_t)
 763
 764 #define VMSTATE_UINT16_EQUAL(_f, _s)                                  \
 765     VMSTATE_SINGLE(_f, _s, 0, vmstate_info_uint16_equal, uint16_t)
 766
 767 #define VMSTATE_UINT16_EQUAL_V(_f, _s, _v)                            \
 768     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint16_equal, uint16_t)
 769
 770 #define VMSTATE_INT32_EQUAL(_f, _s)                                   \
 771     VMSTATE_SINGLE(_f, _s, 0, vmstate_info_int32_equal, int32_t)
 772
 773 #define VMSTATE_UINT32_EQUAL_V(_f, _s, _v)                            \
 774     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint32_equal, uint32_t)
 775
 776 #define VMSTATE_UINT32_EQUAL(_f, _s)                                  \
 777     VMSTATE_UINT32_EQUAL_V(_f, _s, 0)
 778
 779 #define VMSTATE_UINT64_EQUAL_V(_f, _s, _v)                            \
 780     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint64_equal, uint64_t)
 781
 782 #define VMSTATE_UINT64_EQUAL(_f, _s)                                  \
 783     VMSTATE_UINT64_EQUAL_V(_f, _s, 0)
 784
 785 #define VMSTATE_INT32_POSITIVE_LE(_f, _s)                             \
 786     VMSTATE_SINGLE(_f, _s, 0, vmstate_info_int32_le, int32_t)
 787
 788 #define VMSTATE_INT8_TEST(_f, _s, _t)                               \
 789     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_int8, int8_t)
 790
 791 #define VMSTATE_INT16_TEST(_f, _s, _t)                               \
 792     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_int16, int16_t)
 793
 794 #define VMSTATE_INT32_TEST(_f, _s, _t)                                  \
 795     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_int32, int32_t)
 796
 797 #define VMSTATE_INT64_TEST(_f, _s, _t)                                  \
 798     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_int64, int64_t)
 799
 800 #define VMSTATE_UINT8_TEST(_f, _s, _t)                               \
 801     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint8, uint8_t)
 802
 803 #define VMSTATE_UINT16_TEST(_f, _s, _t)                               \
 804     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint16, uint16_t)
 805
 806 #define VMSTATE_UINT32_TEST(_f, _s, _t)                                  \
 807     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint32, uint32_t)
 808
 809 #define VMSTATE_UINT64_TEST(_f, _s, _t)                                  \
 810     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint64, uint64_t)
 811
 812
 813 #define VMSTATE_FLOAT64_V(_f, _s, _v)                                 \
 814     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_float64, float64)
 815
 816 #define VMSTATE_FLOAT64(_f, _s)                                       \
 817     VMSTATE_FLOAT64_V(_f, _s, 0)
 818
 819 #define VMSTATE_TIMER_PTR_TEST(_f, _s, _test)                             \
 820     VMSTATE_POINTER_TEST(_f, _s, _test, vmstate_info_timer, QEMUTimer *)
 821
 822 #define VMSTATE_TIMER_PTR_V(_f, _s, _v)                                   \
 823     VMSTATE_POINTER(_f, _s, _v, vmstate_info_timer, QEMUTimer *)
 824
 825 #define VMSTATE_TIMER_PTR(_f, _s)                                         \
 826     VMSTATE_TIMER_PTR_V(_f, _s, 0)
 827
 828 #define VMSTATE_TIMER_PTR_ARRAY(_f, _s, _n)                              \
 829     VMSTATE_ARRAY_OF_POINTER(_f, _s, _n, 0, vmstate_info_timer, QEMUTimer *)
 830
 831 #define VMSTATE_TIMER_TEST(_f, _s, _test)                             \
 832     VMSTATE_SINGLE_TEST(_f, _s, _test, 0, vmstate_info_timer, QEMUTimer)
 833
 834 #define VMSTATE_TIMER_V(_f, _s, _v)                                   \
 835     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_timer, QEMUTimer)
 836
 837 #define VMSTATE_TIMER(_f, _s)                                         \
 838     VMSTATE_TIMER_V(_f, _s, 0)
 839
 840 #define VMSTATE_TIMER_ARRAY(_f, _s, _n)                              \
 841     VMSTATE_ARRAY(_f, _s, _n, 0, vmstate_info_timer, QEMUTimer)
 842
 843 #define VMSTATE_BOOL_ARRAY_V(_f, _s, _n, _v)                         \
 844     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_bool, bool)
 845
 846 #define VMSTATE_BOOL_ARRAY(_f, _s, _n)                               \
 847     VMSTATE_BOOL_ARRAY_V(_f, _s, _n, 0)
 848
 849 #define VMSTATE_UINT16_ARRAY_V(_f, _s, _n, _v)                         \
 850     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint16, uint16_t)
 851
 852 #define VMSTATE_UINT16_2DARRAY_V(_f, _s, _n1, _n2, _v)                \
 853     VMSTATE_2DARRAY(_f, _s, _n1, _n2, _v, vmstate_info_uint16, uint16_t)
 854
 855 #define VMSTATE_UINT16_ARRAY(_f, _s, _n)                               \
 856     VMSTATE_UINT16_ARRAY_V(_f, _s, _n, 0)
 857
 858 #define VMSTATE_UINT16_2DARRAY(_f, _s, _n1, _n2)                      \
 859     VMSTATE_UINT16_2DARRAY_V(_f, _s, _n1, _n2, 0)
 860
 861 #define VMSTATE_UINT8_2DARRAY_V(_f, _s, _n1, _n2, _v)                 \
 862     VMSTATE_2DARRAY(_f, _s, _n1, _n2, _v, vmstate_info_uint8, uint8_t)
 863
 864 #define VMSTATE_UINT8_ARRAY_V(_f, _s, _n, _v)                         \
 865     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint8, uint8_t)
 866
 867 #define VMSTATE_UINT8_ARRAY(_f, _s, _n)                               \
 868     VMSTATE_UINT8_ARRAY_V(_f, _s, _n, 0)
 869
 870 #define VMSTATE_UINT8_SUB_ARRAY(_f, _s, _start, _num)                \
 871     VMSTATE_SUB_ARRAY(_f, _s, _start, _num, 0, vmstate_info_uint8, uint8_t)
 872
 873 #define VMSTATE_UINT8_2DARRAY(_f, _s, _n1, _n2)                       \
 874     VMSTATE_UINT8_2DARRAY_V(_f, _s, _n1, _n2, 0)
 875
 876 #define VMSTATE_UINT32_ARRAY_V(_f, _s, _n, _v)                        \
 877     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint32, uint32_t)
 878
 879 #define VMSTATE_UINT32_2DARRAY_V(_f, _s, _n1, _n2, _v)                \
 880     VMSTATE_2DARRAY(_f, _s, _n1, _n2, _v, vmstate_info_uint32, uint32_t)
 881
 882 #define VMSTATE_UINT32_ARRAY(_f, _s, _n)                              \
 883     VMSTATE_UINT32_ARRAY_V(_f, _s, _n, 0)
 884
 885 #define VMSTATE_UINT32_2DARRAY(_f, _s, _n1, _n2)                      \
 886     VMSTATE_UINT32_2DARRAY_V(_f, _s, _n1, _n2, 0)
 887
 888 #define VMSTATE_UINT64_ARRAY_V(_f, _s, _n, _v)                        \
 889     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint64, uint64_t)
 890
 891 #define VMSTATE_UINT64_ARRAY(_f, _s, _n)                              \
 892     VMSTATE_UINT64_ARRAY_V(_f, _s, _n, 0)
 893
 894 #define VMSTATE_UINT64_2DARRAY(_f, _s, _n1, _n2)                      \
 895     VMSTATE_UINT64_2DARRAY_V(_f, _s, _n1, _n2, 0)
 896
 897 #define VMSTATE_UINT64_2DARRAY_V(_f, _s, _n1, _n2, _v)                 \
 898     VMSTATE_2DARRAY(_f, _s, _n1, _n2, _v, vmstate_info_uint64, uint64_t)
 899
 900 #define VMSTATE_INT16_ARRAY_V(_f, _s, _n, _v)                         \
 901     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int16, int16_t)
 902
 903 #define VMSTATE_INT16_ARRAY(_f, _s, _n)                               \
 904     VMSTATE_INT16_ARRAY_V(_f, _s, _n, 0)
 905
 906 #define VMSTATE_INT32_ARRAY_V(_f, _s, _n, _v)                         \
 907     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int32, int32_t)
 908
 909 #define VMSTATE_INT32_ARRAY(_f, _s, _n)                               \
 910     VMSTATE_INT32_ARRAY_V(_f, _s, _n, 0)
 911
 912 #define VMSTATE_UINT32_SUB_ARRAY(_f, _s, _start, _num)                \
 913     VMSTATE_SUB_ARRAY(_f, _s, _start, _num, 0, vmstate_info_uint32, uint32_t)
 914
 915 #define VMSTATE_INT64_ARRAY_V(_f, _s, _n, _v)                         \
 916     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int64, int64_t)
 917
 918 #define VMSTATE_INT64_ARRAY(_f, _s, _n)                               \
 919     VMSTATE_INT64_ARRAY_V(_f, _s, _n, 0)
 920
 921 #define VMSTATE_FLOAT64_ARRAY_V(_f, _s, _n, _v)                       \
 922     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_float64, float64)
 923
 924 #define VMSTATE_FLOAT64_ARRAY(_f, _s, _n)                             \
 925     VMSTATE_FLOAT64_ARRAY_V(_f, _s, _n, 0)
 926
 927 #define VMSTATE_CPUDOUBLE_ARRAY_V(_f, _s, _n, _v)                     \
 928     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_cpudouble, CPU_DoubleU)
 929
 930 #define VMSTATE_CPUDOUBLE_ARRAY(_f, _s, _n)                           \
 931     VMSTATE_CPUDOUBLE_ARRAY_V(_f, _s, _n, 0)
 932
 933 #define VMSTATE_BUFFER_V(_f, _s, _v)                                  \
 934     VMSTATE_STATIC_BUFFER(_f, _s, _v, NULL, 0, sizeof(typeof_field(_s, _f)))
 935
 936 #define VMSTATE_BUFFER(_f, _s)                                        \
 937     VMSTATE_BUFFER_V(_f, _s, 0)
 938
 939 #define VMSTATE_PARTIAL_BUFFER(_f, _s, _size)                         \
 940     VMSTATE_STATIC_BUFFER(_f, _s, 0, NULL, 0, _size)
 941
 942 #define VMSTATE_BUFFER_START_MIDDLE_V(_f, _s, _start, _v) \
 943     VMSTATE_STATIC_BUFFER(_f, _s, _v, NULL, _start, sizeof(typeof_field(_s, _f)))
 944
 945 #define VMSTATE_BUFFER_START_MIDDLE(_f, _s, _start) \
 946     VMSTATE_BUFFER_START_MIDDLE_V(_f, _s, _start, 0)
 947
 948 #define VMSTATE_PARTIAL_VBUFFER(_f, _s, _size)                        \
 949     VMSTATE_VBUFFER(_f, _s, 0, NULL, _size)
 950
 951 #define VMSTATE_PARTIAL_VBUFFER_UINT32(_f, _s, _size)                        \
 952     VMSTATE_VBUFFER_UINT32(_f, _s, 0, NULL, _size)
 953
 954 #define VMSTATE_BUFFER_TEST(_f, _s, _test)                            \
 955     VMSTATE_STATIC_BUFFER(_f, _s, 0, _test, 0, sizeof(typeof_field(_s, _f)))
 956
 957 #define VMSTATE_BUFFER_UNSAFE(_field, _state, _version, _size)        \
 958     VMSTATE_BUFFER_UNSAFE_INFO(_field, _state, _version, vmstate_info_buffer, _size)
 959
 960 #define VMSTATE_UNUSED_V(_v, _size)                                   \
 961     VMSTATE_UNUSED_BUFFER(NULL, _v, _size)
 962
 963 #define VMSTATE_UNUSED(_size)                                         \
 964     VMSTATE_UNUSED_V(0, _size)
 965
 966 #define VMSTATE_UNUSED_TEST(_test, _size)                             \
 967     VMSTATE_UNUSED_BUFFER(_test, 0, _size)
 968
 969 #define VMSTATE_END_OF_LIST()                                         \
 970     {}
 971
 972 #define SELF_ANNOUNCE_ROUNDS 5
 973
 974 void loadvm_free_handlers(MigrationIncomingState *mis);
 975
 976 int vmstate_load_state(QEMUFile *f, const VMStateDescription *vmsd,
 977                        void *opaque, int version_id);
 978 void vmstate_save_state(QEMUFile *f, const VMStateDescription *vmsd,
 979                         void *opaque, QJSON *vmdesc);
 980
 981 bool vmstate_save_needed(const VMStateDescription *vmsd, void *opaque);
 982
 983 /* Returns: 0 on success, -1 on failure */
 984 int vmstate_register_with_alias_id(DeviceState *dev, int instance_id,
 985                                    const VMStateDescription *vmsd,
 986                                    void *base, int alias_id,
 987                                    int required_for_version,
 988                                    Error **errp);
 989
 990 /* Returns: 0 on success, -1 on failure */
 991 static inline int vmstate_register(DeviceState *dev, int instance_id,
 992                                    const VMStateDescription *vmsd,
 993                                    void *opaque)
 994 {
 995     return vmstate_register_with_alias_id(dev, instance_id, vmsd,
 996                                           opaque, -1, 0, NULL);
 997 }
 998
 999 void vmstate_unregister(DeviceState *dev, const VMStateDescription *vmsd,
1000                         void *opaque);
1001
1002 struct MemoryRegion;
1003 void vmstate_register_ram(struct MemoryRegion *memory, DeviceState *dev);
1004 void vmstate_unregister_ram(struct MemoryRegion *memory, DeviceState *dev);
1005 void vmstate_register_ram_global(struct MemoryRegion *memory);
1006
1007 static inline
1008 int64_t self_announce_delay(int round)
1009 {
1010     assert(round < SELF_ANNOUNCE_ROUNDS && round > 0);
1011     /* delay 50ms, 150ms, 250ms, ... */
1012     return 50 + (SELF_ANNOUNCE_ROUNDS - round - 1) * 100;
1013 }
1014
1015 void dump_vmstate_json_to_file(FILE *out_fp);
1016
1017 #endif