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 <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 #ifndef QEMU_VMSTATE_H
  27 #define QEMU_VMSTATE_H 1
  28
  29 #ifndef CONFIG_USER_ONLY
  30 #include <migration/qemu-file.h>
  31 #endif
  32 #include <qjson.h>
  33
  34 typedef void SaveStateHandler(QEMUFile *f, void *opaque);
  35 typedef int LoadStateHandler(QEMUFile *f, void *opaque, int version_id);
  36
  37 typedef struct SaveVMHandlers {
  38     /* This runs inside the iothread lock.  */
  39     void (*set_params)(const MigrationParams *params, void * opaque);
  40     SaveStateHandler *save_state;
  41
  42     void (*cancel)(void *opaque);
  43     int (*save_live_complete)(QEMUFile *f, void *opaque);
  44
  45     /* This runs both outside and inside the iothread lock.  */
  46     bool (*is_active)(void *opaque);
  47
  48     /* This runs outside the iothread lock in the migration case, and
  49      * within the lock in the savevm case.  The callback had better only
  50      * use data that is local to the migration thread or protected
  51      * by other locks.
  52      */
  53     int (*save_live_iterate)(QEMUFile *f, void *opaque);
  54
  55     /* This runs outside the iothread lock!  */
  56     int (*save_live_setup)(QEMUFile *f, void *opaque);
  57     uint64_t (*save_live_pending)(QEMUFile *f, void *opaque, uint64_t max_size);
  58
  59     LoadStateHandler *load_state;
  60 } SaveVMHandlers;
  61
  62 int register_savevm(DeviceState *dev,
  63                     const char *idstr,
  64                     int instance_id,
  65                     int version_id,
  66                     SaveStateHandler *save_state,
  67                     LoadStateHandler *load_state,
  68                     void *opaque);
  69
  70 int register_savevm_live(DeviceState *dev,
  71                          const char *idstr,
  72                          int instance_id,
  73                          int version_id,
  74                          SaveVMHandlers *ops,
  75                          void *opaque);
  76
  77 void unregister_savevm(DeviceState *dev, const char *idstr, void *opaque);
  78 void register_device_unmigratable(DeviceState *dev, const char *idstr,
  79                                                                 void *opaque);
  80
  81
  82 typedef struct VMStateInfo VMStateInfo;
  83 typedef struct VMStateDescription VMStateDescription;
  84
  85 struct VMStateInfo {
  86     const char *name;
  87     int (*get)(QEMUFile *f, void *pv, size_t size);
  88     void (*put)(QEMUFile *f, void *pv, size_t size);
  89 };
  90
  91 enum VMStateFlags {
  92     VMS_SINGLE           = 0x001,
  93     VMS_POINTER          = 0x002,
  94     VMS_ARRAY            = 0x004,
  95     VMS_STRUCT           = 0x008,
  96     VMS_VARRAY_INT32     = 0x010,  /* Array with size in int32_t field*/
  97     VMS_BUFFER           = 0x020,  /* static sized buffer */
  98     VMS_ARRAY_OF_POINTER = 0x040,
  99     VMS_VARRAY_UINT16    = 0x080,  /* Array with size in uint16_t field */
 100     VMS_VBUFFER          = 0x100,  /* Buffer with size in int32_t field */
 101     VMS_MULTIPLY         = 0x200,  /* multiply "size" field by field_size */
 102     VMS_VARRAY_UINT8     = 0x400,  /* Array with size in uint8_t field*/
 103     VMS_VARRAY_UINT32    = 0x800,  /* Array with size in uint32_t field*/
 104     VMS_MUST_EXIST       = 0x1000, /* Field must exist in input */
 105     VMS_ALLOC            = 0x2000, /* Alloc a buffer on the destination */
 106 };
 107
 108 typedef struct {
 109     const char *name;
 110     size_t offset;
 111     size_t size;
 112     size_t start;
 113     int num;
 114     size_t num_offset;
 115     size_t size_offset;
 116     const VMStateInfo *info;
 117     enum VMStateFlags flags;
 118     const VMStateDescription *vmsd;
 119     int version_id;
 120     bool (*field_exists)(void *opaque, int version_id);
 121 } VMStateField;
 122
 123 struct VMStateDescription {
 124     const char *name;
 125     int unmigratable;
 126     int version_id;
 127     int minimum_version_id;
 128     int minimum_version_id_old;
 129     LoadStateHandler *load_state_old;
 130     int (*pre_load)(void *opaque);
 131     int (*post_load)(void *opaque, int version_id);
 132     void (*pre_save)(void *opaque);
 133     bool (*needed)(void *opaque);
 134     VMStateField *fields;
 135     const VMStateDescription **subsections;
 136 };
 137
 138 extern const VMStateDescription vmstate_dummy;
 139
 140 extern const VMStateInfo vmstate_info_bool;
 141
 142 extern const VMStateInfo vmstate_info_int8;
 143 extern const VMStateInfo vmstate_info_int16;
 144 extern const VMStateInfo vmstate_info_int32;
 145 extern const VMStateInfo vmstate_info_int64;
 146
 147 extern const VMStateInfo vmstate_info_uint8_equal;
 148 extern const VMStateInfo vmstate_info_uint16_equal;
 149 extern const VMStateInfo vmstate_info_int32_equal;
 150 extern const VMStateInfo vmstate_info_uint32_equal;
 151 extern const VMStateInfo vmstate_info_uint64_equal;
 152 extern const VMStateInfo vmstate_info_int32_le;
 153
 154 extern const VMStateInfo vmstate_info_uint8;
 155 extern const VMStateInfo vmstate_info_uint16;
 156 extern const VMStateInfo vmstate_info_uint32;
 157 extern const VMStateInfo vmstate_info_uint64;
 158
 159 extern const VMStateInfo vmstate_info_float64;
 160
 161 extern const VMStateInfo vmstate_info_timer;
 162 extern const VMStateInfo vmstate_info_buffer;
 163 extern const VMStateInfo vmstate_info_unused_buffer;
 164 extern const VMStateInfo vmstate_info_bitmap;
 165
 166 #define type_check_2darray(t1,t2,n,m) ((t1(*)[n][m])0 - (t2*)0)
 167 #define type_check_array(t1,t2,n) ((t1(*)[n])0 - (t2*)0)
 168 #define type_check_pointer(t1,t2) ((t1**)0 - (t2*)0)
 169
 170 #define vmstate_offset_value(_state, _field, _type)                  \
 171     (offsetof(_state, _field) +                                      \
 172      type_check(_type, typeof_field(_state, _field)))
 173
 174 #define vmstate_offset_pointer(_state, _field, _type)                \
 175     (offsetof(_state, _field) +                                      \
 176      type_check_pointer(_type, typeof_field(_state, _field)))
 177
 178 #define vmstate_offset_array(_state, _field, _type, _num)            \
 179     (offsetof(_state, _field) +                                      \
 180      type_check_array(_type, typeof_field(_state, _field), _num))
 181
 182 #define vmstate_offset_2darray(_state, _field, _type, _n1, _n2)      \
 183     (offsetof(_state, _field) +                                      \
 184      type_check_2darray(_type, typeof_field(_state, _field), _n1, _n2))
 185
 186 #define vmstate_offset_sub_array(_state, _field, _type, _start)      \
 187     vmstate_offset_value(_state, _field[_start], _type)
 188
 189 #define vmstate_offset_buffer(_state, _field)                        \
 190     vmstate_offset_array(_state, _field, uint8_t,                    \
 191                          sizeof(typeof_field(_state, _field)))
 192
 193 #define VMSTATE_SINGLE_TEST(_field, _state, _test, _version, _info, _type) { \
 194     .name         = (stringify(_field)),                             \
 195     .version_id   = (_version),                                      \
 196     .field_exists = (_test),                                         \
 197     .size         = sizeof(_type),                                   \
 198     .info         = &(_info),                                        \
 199     .flags        = VMS_SINGLE,                                      \
 200     .offset       = vmstate_offset_value(_state, _field, _type),     \
 201 }
 202
 203 /* Validate state using a boolean predicate. */
 204 #define VMSTATE_VALIDATE(_name, _test) { \
 205     .name         = (_name),                                         \
 206     .field_exists = (_test),                                         \
 207     .flags        = VMS_ARRAY | VMS_MUST_EXIST,                      \
 208     .num          = 0, /* 0 elements: no data, only run _test */     \
 209 }
 210
 211 #define VMSTATE_POINTER(_field, _state, _version, _info, _type) {    \
 212     .name       = (stringify(_field)),                               \
 213     .version_id = (_version),                                        \
 214     .info       = &(_info),                                          \
 215     .size       = sizeof(_type),                                     \
 216     .flags      = VMS_SINGLE|VMS_POINTER,                            \
 217     .offset     = vmstate_offset_value(_state, _field, _type),       \
 218 }
 219
 220 #define VMSTATE_POINTER_TEST(_field, _state, _test, _info, _type) {  \
 221     .name       = (stringify(_field)),                               \
 222     .info       = &(_info),                                          \
 223     .field_exists = (_test),                                         \
 224     .size       = sizeof(_type),                                     \
 225     .flags      = VMS_SINGLE|VMS_POINTER,                            \
 226     .offset     = vmstate_offset_value(_state, _field, _type),       \
 227 }
 228
 229 #define VMSTATE_ARRAY(_field, _state, _num, _version, _info, _type) {\
 230     .name       = (stringify(_field)),                               \
 231     .version_id = (_version),                                        \
 232     .num        = (_num),                                            \
 233     .info       = &(_info),                                          \
 234     .size       = sizeof(_type),                                     \
 235     .flags      = VMS_ARRAY,                                         \
 236     .offset     = vmstate_offset_array(_state, _field, _type, _num), \
 237 }
 238
 239 #define VMSTATE_2DARRAY(_field, _state, _n1, _n2, _version, _info, _type) { \
 240     .name       = (stringify(_field)),                                      \
 241     .version_id = (_version),                                               \
 242     .num        = (_n1) * (_n2),                                            \
 243     .info       = &(_info),                                                 \
 244     .size       = sizeof(_type),                                            \
 245     .flags      = VMS_ARRAY,                                                \
 246     .offset     = vmstate_offset_2darray(_state, _field, _type, _n1, _n2),  \
 247 }
 248
 249 #define VMSTATE_ARRAY_TEST(_field, _state, _num, _test, _info, _type) {\
 250     .name         = (stringify(_field)),                              \
 251     .field_exists = (_test),                                          \
 252     .num          = (_num),                                           \
 253     .info         = &(_info),                                         \
 254     .size         = sizeof(_type),                                    \
 255     .flags        = VMS_ARRAY,                                        \
 256     .offset       = vmstate_offset_array(_state, _field, _type, _num),\
 257 }
 258
 259 #define VMSTATE_SUB_ARRAY(_field, _state, _start, _num, _version, _info, _type) { \
 260     .name       = (stringify(_field)),                               \
 261     .version_id = (_version),                                        \
 262     .num        = (_num),                                            \
 263     .info       = &(_info),                                          \
 264     .size       = sizeof(_type),                                     \
 265     .flags      = VMS_ARRAY,                                         \
 266     .offset     = vmstate_offset_sub_array(_state, _field, _type, _start), \
 267 }
 268
 269 #define VMSTATE_ARRAY_INT32_UNSAFE(_field, _state, _field_num, _info, _type) {\
 270     .name       = (stringify(_field)),                               \
 271     .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
 272     .info       = &(_info),                                          \
 273     .size       = sizeof(_type),                                     \
 274     .flags      = VMS_VARRAY_INT32,                                  \
 275     .offset     = offsetof(_state, _field),                          \
 276 }
 277
 278 #define VMSTATE_VARRAY_INT32(_field, _state, _field_num, _version, _info, _type) {\
 279     .name       = (stringify(_field)),                               \
 280     .version_id = (_version),                                        \
 281     .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
 282     .info       = &(_info),                                          \
 283     .size       = sizeof(_type),                                     \
 284     .flags      = VMS_VARRAY_INT32|VMS_POINTER,                      \
 285     .offset     = vmstate_offset_pointer(_state, _field, _type),     \
 286 }
 287
 288 #define VMSTATE_VARRAY_UINT32(_field, _state, _field_num, _version, _info, _type) {\
 289     .name       = (stringify(_field)),                               \
 290     .version_id = (_version),                                        \
 291     .num_offset = vmstate_offset_value(_state, _field_num, uint32_t),\
 292     .info       = &(_info),                                          \
 293     .size       = sizeof(_type),                                     \
 294     .flags      = VMS_VARRAY_UINT32|VMS_POINTER,                     \
 295     .offset     = vmstate_offset_pointer(_state, _field, _type),     \
 296 }
 297
 298 #define VMSTATE_VARRAY_UINT16_UNSAFE(_field, _state, _field_num, _version, _info, _type) {\
 299     .name       = (stringify(_field)),                               \
 300     .version_id = (_version),                                        \
 301     .num_offset = vmstate_offset_value(_state, _field_num, uint16_t),\
 302     .info       = &(_info),                                          \
 303     .size       = sizeof(_type),                                     \
 304     .flags      = VMS_VARRAY_UINT16,                                 \
 305     .offset     = offsetof(_state, _field),                          \
 306 }
 307
 308 #define VMSTATE_STRUCT_TEST(_field, _state, _test, _version, _vmsd, _type) { \
 309     .name         = (stringify(_field)),                             \
 310     .version_id   = (_version),                                      \
 311     .field_exists = (_test),                                         \
 312     .vmsd         = &(_vmsd),                                        \
 313     .size         = sizeof(_type),                                   \
 314     .flags        = VMS_STRUCT,                                      \
 315     .offset       = vmstate_offset_value(_state, _field, _type),     \
 316 }
 317
 318 #define VMSTATE_STRUCT_POINTER_V(_field, _state, _version, _vmsd, _type) { \
 319     .name         = (stringify(_field)),                             \
 320     .version_id   = (_version),                                        \
 321     .vmsd         = &(_vmsd),                                        \
 322     .size         = sizeof(_type *),                                 \
 323     .flags        = VMS_STRUCT|VMS_POINTER,                          \
 324     .offset       = vmstate_offset_pointer(_state, _field, _type),   \
 325 }
 326
 327 #define VMSTATE_STRUCT_POINTER_TEST_V(_field, _state, _test, _version, _vmsd, _type) { \
 328     .name         = (stringify(_field)),                             \
 329     .version_id   = (_version),                                        \
 330     .field_exists = (_test),                                         \
 331     .vmsd         = &(_vmsd),                                        \
 332     .size         = sizeof(_type *),                                 \
 333     .flags        = VMS_STRUCT|VMS_POINTER,                          \
 334     .offset       = vmstate_offset_pointer(_state, _field, _type),   \
 335 }
 336
 337 #define VMSTATE_ARRAY_OF_POINTER(_field, _state, _num, _version, _info, _type) {\
 338     .name       = (stringify(_field)),                               \
 339     .version_id = (_version),                                        \
 340     .num        = (_num),                                            \
 341     .info       = &(_info),                                          \
 342     .size       = sizeof(_type),                                     \
 343     .flags      = VMS_ARRAY|VMS_ARRAY_OF_POINTER,                    \
 344     .offset     = vmstate_offset_array(_state, _field, _type, _num), \
 345 }
 346
 347 #define VMSTATE_ARRAY_OF_POINTER_TO_STRUCT(_f, _s, _n, _v, _vmsd, _type) { \
 348     .name       = (stringify(_f)),                                   \
 349     .version_id = (_v),                                              \
 350     .num        = (_n),                                              \
 351     .vmsd       = &(_vmsd),                                          \
 352     .size       = sizeof(_type *),                                    \
 353     .flags      = VMS_ARRAY|VMS_STRUCT|VMS_ARRAY_OF_POINTER,         \
 354     .offset     = vmstate_offset_array(_s, _f, _type*, _n),          \
 355 }
 356
 357 #define VMSTATE_STRUCT_SUB_ARRAY(_field, _state, _start, _num, _version, _vmsd, _type) { \
 358     .name       = (stringify(_field)),                                     \
 359     .version_id = (_version),                                              \
 360     .num        = (_num),                                                  \
 361     .vmsd       = &(_vmsd),                                                \
 362     .size       = sizeof(_type),                                           \
 363     .flags      = VMS_STRUCT|VMS_ARRAY,                                    \
 364     .offset     = vmstate_offset_sub_array(_state, _field, _type, _start), \
 365 }
 366
 367 #define VMSTATE_STRUCT_ARRAY_TEST(_field, _state, _num, _test, _version, _vmsd, _type) { \
 368     .name         = (stringify(_field)),                             \
 369     .num          = (_num),                                          \
 370     .field_exists = (_test),                                         \
 371     .version_id   = (_version),                                      \
 372     .vmsd         = &(_vmsd),                                        \
 373     .size         = sizeof(_type),                                   \
 374     .flags        = VMS_STRUCT|VMS_ARRAY,                            \
 375     .offset       = vmstate_offset_array(_state, _field, _type, _num),\
 376 }
 377
 378 #define VMSTATE_STRUCT_VARRAY_UINT8(_field, _state, _field_num, _version, _vmsd, _type) { \
 379     .name       = (stringify(_field)),                               \
 380     .num_offset = vmstate_offset_value(_state, _field_num, uint8_t), \
 381     .version_id = (_version),                                        \
 382     .vmsd       = &(_vmsd),                                          \
 383     .size       = sizeof(_type),                                     \
 384     .flags      = VMS_STRUCT|VMS_VARRAY_UINT8,                       \
 385     .offset     = offsetof(_state, _field),                          \
 386 }
 387
 388 #define VMSTATE_STRUCT_VARRAY_POINTER_INT32(_field, _state, _field_num, _vmsd, _type) { \
 389     .name       = (stringify(_field)),                               \
 390     .version_id = 0,                                                 \
 391     .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
 392     .size       = sizeof(_type),                                     \
 393     .vmsd       = &(_vmsd),                                          \
 394     .flags      = VMS_POINTER | VMS_VARRAY_INT32 | VMS_STRUCT,       \
 395     .offset     = vmstate_offset_pointer(_state, _field, _type),     \
 396 }
 397
 398 #define VMSTATE_STRUCT_VARRAY_POINTER_UINT32(_field, _state, _field_num, _vmsd, _type) { \
 399     .name       = (stringify(_field)),                               \
 400     .version_id = 0,                                                 \
 401     .num_offset = vmstate_offset_value(_state, _field_num, uint32_t),\
 402     .size       = sizeof(_type),                                     \
 403     .vmsd       = &(_vmsd),                                          \
 404     .flags      = VMS_POINTER | VMS_VARRAY_INT32 | VMS_STRUCT,       \
 405     .offset     = vmstate_offset_pointer(_state, _field, _type),     \
 406 }
 407
 408 #define VMSTATE_STRUCT_VARRAY_POINTER_UINT16(_field, _state, _field_num, _vmsd, _type) { \
 409     .name       = (stringify(_field)),                               \
 410     .version_id = 0,                                                 \
 411     .num_offset = vmstate_offset_value(_state, _field_num, uint16_t),\
 412     .size       = sizeof(_type),                                     \
 413     .vmsd       = &(_vmsd),                                          \
 414     .flags      = VMS_POINTER | VMS_VARRAY_UINT16 | VMS_STRUCT,      \
 415     .offset     = vmstate_offset_pointer(_state, _field, _type),     \
 416 }
 417
 418 #define VMSTATE_STRUCT_VARRAY_INT32(_field, _state, _field_num, _version, _vmsd, _type) { \
 419     .name       = (stringify(_field)),                               \
 420     .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
 421     .version_id = (_version),                                        \
 422     .vmsd       = &(_vmsd),                                          \
 423     .size       = sizeof(_type),                                     \
 424     .flags      = VMS_STRUCT|VMS_VARRAY_INT32,                       \
 425     .offset     = offsetof(_state, _field),                          \
 426 }
 427
 428 #define VMSTATE_STRUCT_VARRAY_UINT32(_field, _state, _field_num, _version, _vmsd, _type) { \
 429     .name       = (stringify(_field)),                               \
 430     .num_offset = vmstate_offset_value(_state, _field_num, uint32_t), \
 431     .version_id = (_version),                                        \
 432     .vmsd       = &(_vmsd),                                          \
 433     .size       = sizeof(_type),                                     \
 434     .flags      = VMS_STRUCT|VMS_VARRAY_UINT32,                      \
 435     .offset     = offsetof(_state, _field),                          \
 436 }
 437
 438 #define VMSTATE_STRUCT_VARRAY_ALLOC(_field, _state, _field_num, _version, _vmsd, _type) {\
 439     .name       = (stringify(_field)),                               \
 440     .version_id = (_version),                                        \
 441     .vmsd       = &(_vmsd),                                          \
 442     .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
 443     .size       = sizeof(_type),                                     \
 444     .flags      = VMS_STRUCT|VMS_VARRAY_INT32|VMS_ALLOC|VMS_POINTER, \
 445     .offset     = vmstate_offset_pointer(_state, _field, _type),     \
 446 }
 447
 448 #define VMSTATE_STATIC_BUFFER(_field, _state, _version, _test, _start, _size) { \
 449     .name         = (stringify(_field)),                             \
 450     .version_id   = (_version),                                      \
 451     .field_exists = (_test),                                         \
 452     .size         = (_size - _start),                                \
 453     .info         = &vmstate_info_buffer,                            \
 454     .flags        = VMS_BUFFER,                                      \
 455     .offset       = vmstate_offset_buffer(_state, _field) + _start,  \
 456 }
 457
 458 #define VMSTATE_VBUFFER_MULTIPLY(_field, _state, _version, _test, _start, _field_size, _multiply) { \
 459     .name         = (stringify(_field)),                             \
 460     .version_id   = (_version),                                      \
 461     .field_exists = (_test),                                         \
 462     .size_offset  = vmstate_offset_value(_state, _field_size, uint32_t),\
 463     .size         = (_multiply),                                      \
 464     .info         = &vmstate_info_buffer,                            \
 465     .flags        = VMS_VBUFFER|VMS_POINTER|VMS_MULTIPLY,            \
 466     .offset       = offsetof(_state, _field),                        \
 467     .start        = (_start),                                        \
 468 }
 469
 470 #define VMSTATE_VBUFFER(_field, _state, _version, _test, _start, _field_size) { \
 471     .name         = (stringify(_field)),                             \
 472     .version_id   = (_version),                                      \
 473     .field_exists = (_test),                                         \
 474     .size_offset  = vmstate_offset_value(_state, _field_size, int32_t),\
 475     .info         = &vmstate_info_buffer,                            \
 476     .flags        = VMS_VBUFFER|VMS_POINTER,                         \
 477     .offset       = offsetof(_state, _field),                        \
 478     .start        = (_start),                                        \
 479 }
 480
 481 #define VMSTATE_VBUFFER_UINT32(_field, _state, _version, _test, _start, _field_size) { \
 482     .name         = (stringify(_field)),                             \
 483     .version_id   = (_version),                                      \
 484     .field_exists = (_test),                                         \
 485     .size_offset  = vmstate_offset_value(_state, _field_size, uint32_t),\
 486     .info         = &vmstate_info_buffer,                            \
 487     .flags        = VMS_VBUFFER|VMS_POINTER,                         \
 488     .offset       = offsetof(_state, _field),                        \
 489     .start        = (_start),                                        \
 490 }
 491
 492 #define VMSTATE_VBUFFER_ALLOC_UINT32(_field, _state, _version, _test, _start, _field_size) { \
 493     .name         = (stringify(_field)),                             \
 494     .version_id   = (_version),                                      \
 495     .field_exists = (_test),                                         \
 496     .size_offset  = vmstate_offset_value(_state, _field_size, uint32_t),\
 497     .info         = &vmstate_info_buffer,                            \
 498     .flags        = VMS_VBUFFER|VMS_POINTER|VMS_ALLOC,               \
 499     .offset       = offsetof(_state, _field),                        \
 500     .start        = (_start),                                        \
 501 }
 502
 503 #define VMSTATE_BUFFER_UNSAFE_INFO_TEST(_field, _state, _test, _version, _info, _size) { \
 504     .name       = (stringify(_field)),                               \
 505     .version_id = (_version),                                        \
 506     .field_exists = (_test),                                         \
 507     .size       = (_size),                                           \
 508     .info       = &(_info),                                          \
 509     .flags      = VMS_BUFFER,                                        \
 510     .offset     = offsetof(_state, _field),                          \
 511 }
 512
 513 #define VMSTATE_BUFFER_POINTER_UNSAFE(_field, _state, _version, _size) { \
 514     .name       = (stringify(_field)),                               \
 515     .version_id = (_version),                                        \
 516     .size       = (_size),                                           \
 517     .info       = &vmstate_info_buffer,                              \
 518     .flags      = VMS_BUFFER|VMS_POINTER,                            \
 519     .offset     = offsetof(_state, _field),                          \
 520 }
 521
 522 #define VMSTATE_UNUSED_BUFFER(_test, _version, _size) {              \
 523     .name         = "unused",                                        \
 524     .field_exists = (_test),                                         \
 525     .version_id   = (_version),                                      \
 526     .size         = (_size),                                         \
 527     .info         = &vmstate_info_unused_buffer,                     \
 528     .flags        = VMS_BUFFER,                                      \
 529 }
 530
 531 /* _field_size should be a int32_t field in the _state struct giving the
 532  * size of the bitmap _field in bits.
 533  */
 534 #define VMSTATE_BITMAP(_field, _state, _version, _field_size) {      \
 535     .name         = (stringify(_field)),                             \
 536     .version_id   = (_version),                                      \
 537     .size_offset  = vmstate_offset_value(_state, _field_size, int32_t),\
 538     .info         = &vmstate_info_bitmap,                            \
 539     .flags        = VMS_VBUFFER|VMS_POINTER,                         \
 540     .offset       = offsetof(_state, _field),                        \
 541 }
 542
 543 /* _f : field name
 544    _f_n : num of elements field_name
 545    _n : num of elements
 546    _s : struct state name
 547    _v : version
 548 */
 549
 550 #define VMSTATE_SINGLE(_field, _state, _version, _info, _type)        \
 551     VMSTATE_SINGLE_TEST(_field, _state, NULL, _version, _info, _type)
 552
 553 #define VMSTATE_STRUCT(_field, _state, _version, _vmsd, _type)        \
 554     VMSTATE_STRUCT_TEST(_field, _state, NULL, _version, _vmsd, _type)
 555
 556 #define VMSTATE_STRUCT_POINTER(_field, _state, _vmsd, _type)          \
 557     VMSTATE_STRUCT_POINTER_V(_field, _state, 0, _vmsd, _type)
 558
 559 #define VMSTATE_STRUCT_POINTER_TEST(_field, _state, _test, _vmsd, _type)     \
 560     VMSTATE_STRUCT_POINTER_TEST_V(_field, _state, _test, 0, _vmsd, _type)
 561
 562 #define VMSTATE_STRUCT_ARRAY(_field, _state, _num, _version, _vmsd, _type) \
 563     VMSTATE_STRUCT_ARRAY_TEST(_field, _state, _num, NULL, _version,   \
 564             _vmsd, _type)
 565
 566 #define VMSTATE_BUFFER_UNSAFE_INFO(_field, _state, _version, _info, _size) \
 567     VMSTATE_BUFFER_UNSAFE_INFO_TEST(_field, _state, NULL, _version, _info, \
 568             _size)
 569
 570 #define VMSTATE_BOOL_V(_f, _s, _v)                                    \
 571     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_bool, bool)
 572
 573 #define VMSTATE_INT8_V(_f, _s, _v)                                    \
 574     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int8, int8_t)
 575 #define VMSTATE_INT16_V(_f, _s, _v)                                   \
 576     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int16, int16_t)
 577 #define VMSTATE_INT32_V(_f, _s, _v)                                   \
 578     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int32, int32_t)
 579 #define VMSTATE_INT64_V(_f, _s, _v)                                   \
 580     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int64, int64_t)
 581
 582 #define VMSTATE_UINT8_V(_f, _s, _v)                                   \
 583     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint8, uint8_t)
 584 #define VMSTATE_UINT16_V(_f, _s, _v)                                  \
 585     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint16, uint16_t)
 586 #define VMSTATE_UINT32_V(_f, _s, _v)                                  \
 587     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint32, uint32_t)
 588 #define VMSTATE_UINT64_V(_f, _s, _v)                                  \
 589     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint64, uint64_t)
 590
 591 #define VMSTATE_BOOL(_f, _s)                                          \
 592     VMSTATE_BOOL_V(_f, _s, 0)
 593
 594 #define VMSTATE_INT8(_f, _s)                                          \
 595     VMSTATE_INT8_V(_f, _s, 0)
 596 #define VMSTATE_INT16(_f, _s)                                         \
 597     VMSTATE_INT16_V(_f, _s, 0)
 598 #define VMSTATE_INT32(_f, _s)                                         \
 599     VMSTATE_INT32_V(_f, _s, 0)
 600 #define VMSTATE_INT64(_f, _s)                                         \
 601     VMSTATE_INT64_V(_f, _s, 0)
 602
 603 #define VMSTATE_UINT8(_f, _s)                                         \
 604     VMSTATE_UINT8_V(_f, _s, 0)
 605 #define VMSTATE_UINT16(_f, _s)                                        \
 606     VMSTATE_UINT16_V(_f, _s, 0)
 607 #define VMSTATE_UINT32(_f, _s)                                        \
 608     VMSTATE_UINT32_V(_f, _s, 0)
 609 #define VMSTATE_UINT64(_f, _s)                                        \
 610     VMSTATE_UINT64_V(_f, _s, 0)
 611
 612 #define VMSTATE_UINT8_EQUAL(_f, _s)                                   \
 613     VMSTATE_SINGLE(_f, _s, 0, vmstate_info_uint8_equal, uint8_t)
 614
 615 #define VMSTATE_UINT16_EQUAL(_f, _s)                                  \
 616     VMSTATE_SINGLE(_f, _s, 0, vmstate_info_uint16_equal, uint16_t)
 617
 618 #define VMSTATE_UINT16_EQUAL_V(_f, _s, _v)                            \
 619     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint16_equal, uint16_t)
 620
 621 #define VMSTATE_INT32_EQUAL(_f, _s)                                   \
 622     VMSTATE_SINGLE(_f, _s, 0, vmstate_info_int32_equal, int32_t)
 623
 624 #define VMSTATE_UINT32_EQUAL_V(_f, _s, _v)                            \
 625     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint32_equal, uint32_t)
 626
 627 #define VMSTATE_UINT32_EQUAL(_f, _s)                                  \
 628     VMSTATE_UINT32_EQUAL_V(_f, _s, 0)
 629
 630 #define VMSTATE_UINT64_EQUAL_V(_f, _s, _v)                            \
 631     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint64_equal, uint64_t)
 632
 633 #define VMSTATE_UINT64_EQUAL(_f, _s)                                  \
 634     VMSTATE_UINT64_EQUAL_V(_f, _s, 0)
 635
 636 #define VMSTATE_INT32_POSITIVE_LE(_f, _s)                             \
 637     VMSTATE_SINGLE(_f, _s, 0, vmstate_info_int32_le, int32_t)
 638
 639 #define VMSTATE_INT8_TEST(_f, _s, _t)                               \
 640     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_int8, int8_t)
 641
 642 #define VMSTATE_INT16_TEST(_f, _s, _t)                               \
 643     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_int16, int16_t)
 644
 645 #define VMSTATE_INT32_TEST(_f, _s, _t)                                  \
 646     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_int32, int32_t)
 647
 648 #define VMSTATE_INT64_TEST(_f, _s, _t)                                  \
 649     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_int64, int64_t)
 650
 651 #define VMSTATE_UINT8_TEST(_f, _s, _t)                               \
 652     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint8, uint8_t)
 653
 654 #define VMSTATE_UINT16_TEST(_f, _s, _t)                               \
 655     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint16, uint16_t)
 656
 657 #define VMSTATE_UINT32_TEST(_f, _s, _t)                                  \
 658     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint32, uint32_t)
 659
 660 #define VMSTATE_UINT64_TEST(_f, _s, _t)                                  \
 661     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint64, uint64_t)
 662
 663
 664 #define VMSTATE_FLOAT64_V(_f, _s, _v)                                 \
 665     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_float64, float64)
 666
 667 #define VMSTATE_FLOAT64(_f, _s)                                       \
 668     VMSTATE_FLOAT64_V(_f, _s, 0)
 669
 670 #define VMSTATE_TIMER_PTR_TEST(_f, _s, _test)                             \
 671     VMSTATE_POINTER_TEST(_f, _s, _test, vmstate_info_timer, QEMUTimer *)
 672
 673 #define VMSTATE_TIMER_PTR_V(_f, _s, _v)                                   \
 674     VMSTATE_POINTER(_f, _s, _v, vmstate_info_timer, QEMUTimer *)
 675
 676 #define VMSTATE_TIMER_PTR(_f, _s)                                         \
 677     VMSTATE_TIMER_PTR_V(_f, _s, 0)
 678
 679 #define VMSTATE_TIMER_PTR_ARRAY(_f, _s, _n)                              \
 680     VMSTATE_ARRAY_OF_POINTER(_f, _s, _n, 0, vmstate_info_timer, QEMUTimer *)
 681
 682 #define VMSTATE_TIMER_TEST(_f, _s, _test)                             \
 683     VMSTATE_SINGLE_TEST(_f, _s, _test, 0, vmstate_info_timer, QEMUTimer)
 684
 685 #define VMSTATE_TIMER_V(_f, _s, _v)                                   \
 686     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_timer, QEMUTimer)
 687
 688 #define VMSTATE_TIMER(_f, _s)                                         \
 689     VMSTATE_TIMER_V(_f, _s, 0)
 690
 691 #define VMSTATE_TIMER_ARRAY(_f, _s, _n)                              \
 692     VMSTATE_ARRAY(_f, _s, _n, 0, vmstate_info_timer, QEMUTimer)
 693
 694 #define VMSTATE_BOOL_ARRAY_V(_f, _s, _n, _v)                         \
 695     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_bool, bool)
 696
 697 #define VMSTATE_BOOL_ARRAY(_f, _s, _n)                               \
 698     VMSTATE_BOOL_ARRAY_V(_f, _s, _n, 0)
 699
 700 #define VMSTATE_UINT16_ARRAY_V(_f, _s, _n, _v)                         \
 701     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint16, uint16_t)
 702
 703 #define VMSTATE_UINT16_2DARRAY_V(_f, _s, _n1, _n2, _v)                \
 704     VMSTATE_2DARRAY(_f, _s, _n1, _n2, _v, vmstate_info_uint16, uint16_t)
 705
 706 #define VMSTATE_UINT16_ARRAY(_f, _s, _n)                               \
 707     VMSTATE_UINT16_ARRAY_V(_f, _s, _n, 0)
 708
 709 #define VMSTATE_UINT16_2DARRAY(_f, _s, _n1, _n2)                      \
 710     VMSTATE_UINT16_2DARRAY_V(_f, _s, _n1, _n2, 0)
 711
 712 #define VMSTATE_UINT8_2DARRAY_V(_f, _s, _n1, _n2, _v)                 \
 713     VMSTATE_2DARRAY(_f, _s, _n1, _n2, _v, vmstate_info_uint8, uint8_t)
 714
 715 #define VMSTATE_UINT8_ARRAY_V(_f, _s, _n, _v)                         \
 716     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint8, uint8_t)
 717
 718 #define VMSTATE_UINT8_ARRAY(_f, _s, _n)                               \
 719     VMSTATE_UINT8_ARRAY_V(_f, _s, _n, 0)
 720
 721 #define VMSTATE_UINT8_SUB_ARRAY(_f, _s, _start, _num)                \
 722     VMSTATE_SUB_ARRAY(_f, _s, _start, _num, 0, vmstate_info_uint8, uint8_t)
 723
 724 #define VMSTATE_UINT8_2DARRAY(_f, _s, _n1, _n2)                       \
 725     VMSTATE_UINT8_2DARRAY_V(_f, _s, _n1, _n2, 0)
 726
 727 #define VMSTATE_UINT32_ARRAY_V(_f, _s, _n, _v)                        \
 728     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint32, uint32_t)
 729
 730 #define VMSTATE_UINT32_2DARRAY_V(_f, _s, _n1, _n2, _v)                \
 731     VMSTATE_2DARRAY(_f, _s, _n1, _n2, _v, vmstate_info_uint32, uint32_t)
 732
 733 #define VMSTATE_UINT32_ARRAY(_f, _s, _n)                              \
 734     VMSTATE_UINT32_ARRAY_V(_f, _s, _n, 0)
 735
 736 #define VMSTATE_UINT32_2DARRAY(_f, _s, _n1, _n2)                      \
 737     VMSTATE_UINT32_2DARRAY_V(_f, _s, _n1, _n2, 0)
 738
 739 #define VMSTATE_UINT64_ARRAY_V(_f, _s, _n, _v)                        \
 740     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint64, uint64_t)
 741
 742 #define VMSTATE_UINT64_ARRAY(_f, _s, _n)                              \
 743     VMSTATE_UINT64_ARRAY_V(_f, _s, _n, 0)
 744
 745 #define VMSTATE_INT16_ARRAY_V(_f, _s, _n, _v)                         \
 746     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int16, int16_t)
 747
 748 #define VMSTATE_INT16_ARRAY(_f, _s, _n)                               \
 749     VMSTATE_INT16_ARRAY_V(_f, _s, _n, 0)
 750
 751 #define VMSTATE_INT32_ARRAY_V(_f, _s, _n, _v)                         \
 752     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int32, int32_t)
 753
 754 #define VMSTATE_INT32_ARRAY(_f, _s, _n)                               \
 755     VMSTATE_INT32_ARRAY_V(_f, _s, _n, 0)
 756
 757 #define VMSTATE_UINT32_SUB_ARRAY(_f, _s, _start, _num)                \
 758     VMSTATE_SUB_ARRAY(_f, _s, _start, _num, 0, vmstate_info_uint32, uint32_t)
 759
 760 #define VMSTATE_UINT32_ARRAY(_f, _s, _n)                              \
 761     VMSTATE_UINT32_ARRAY_V(_f, _s, _n, 0)
 762
 763 #define VMSTATE_INT64_ARRAY_V(_f, _s, _n, _v)                         \
 764     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int64, int64_t)
 765
 766 #define VMSTATE_INT64_ARRAY(_f, _s, _n)                               \
 767     VMSTATE_INT64_ARRAY_V(_f, _s, _n, 0)
 768
 769 #define VMSTATE_FLOAT64_ARRAY_V(_f, _s, _n, _v)                       \
 770     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_float64, float64)
 771
 772 #define VMSTATE_FLOAT64_ARRAY(_f, _s, _n)                             \
 773     VMSTATE_FLOAT64_ARRAY_V(_f, _s, _n, 0)
 774
 775 #define VMSTATE_BUFFER_V(_f, _s, _v)                                  \
 776     VMSTATE_STATIC_BUFFER(_f, _s, _v, NULL, 0, sizeof(typeof_field(_s, _f)))
 777
 778 #define VMSTATE_BUFFER(_f, _s)                                        \
 779     VMSTATE_BUFFER_V(_f, _s, 0)
 780
 781 #define VMSTATE_PARTIAL_BUFFER(_f, _s, _size)                         \
 782     VMSTATE_STATIC_BUFFER(_f, _s, 0, NULL, 0, _size)
 783
 784 #define VMSTATE_BUFFER_START_MIDDLE(_f, _s, _start) \
 785     VMSTATE_STATIC_BUFFER(_f, _s, 0, NULL, _start, sizeof(typeof_field(_s, _f)))
 786
 787 #define VMSTATE_PARTIAL_VBUFFER(_f, _s, _size)                        \
 788     VMSTATE_VBUFFER(_f, _s, 0, NULL, 0, _size)
 789
 790 #define VMSTATE_PARTIAL_VBUFFER_UINT32(_f, _s, _size)                        \
 791     VMSTATE_VBUFFER_UINT32(_f, _s, 0, NULL, 0, _size)
 792
 793 #define VMSTATE_SUB_VBUFFER(_f, _s, _start, _size)                    \
 794     VMSTATE_VBUFFER(_f, _s, 0, NULL, _start, _size)
 795
 796 #define VMSTATE_BUFFER_TEST(_f, _s, _test)                            \
 797     VMSTATE_STATIC_BUFFER(_f, _s, 0, _test, 0, sizeof(typeof_field(_s, _f)))
 798
 799 #define VMSTATE_BUFFER_UNSAFE(_field, _state, _version, _size)        \
 800     VMSTATE_BUFFER_UNSAFE_INFO(_field, _state, _version, vmstate_info_buffer, _size)
 801
 802 #define VMSTATE_UNUSED_V(_v, _size)                                   \
 803     VMSTATE_UNUSED_BUFFER(NULL, _v, _size)
 804
 805 #define VMSTATE_UNUSED(_size)                                         \
 806     VMSTATE_UNUSED_V(0, _size)
 807
 808 #define VMSTATE_UNUSED_TEST(_test, _size)                             \
 809     VMSTATE_UNUSED_BUFFER(_test, 0, _size)
 810
 811 #define VMSTATE_END_OF_LIST()                                         \
 812     {}
 813
 814 #define SELF_ANNOUNCE_ROUNDS 5
 815
 816 void loadvm_free_handlers(MigrationIncomingState *mis);
 817
 818 int vmstate_load_state(QEMUFile *f, const VMStateDescription *vmsd,
 819                        void *opaque, int version_id);
 820 void vmstate_save_state(QEMUFile *f, const VMStateDescription *vmsd,
 821                         void *opaque, QJSON *vmdesc);
 822
 823 int vmstate_register_with_alias_id(DeviceState *dev, int instance_id,
 824                                    const VMStateDescription *vmsd,
 825                                    void *base, int alias_id,
 826                                    int required_for_version);
 827
 828 static inline int vmstate_register(DeviceState *dev, int instance_id,
 829                                    const VMStateDescription *vmsd,
 830                                    void *opaque)
 831 {
 832     return vmstate_register_with_alias_id(dev, instance_id, vmsd,
 833                                           opaque, -1, 0);
 834 }
 835
 836 void vmstate_unregister(DeviceState *dev, const VMStateDescription *vmsd,
 837                         void *opaque);
 838
 839 struct MemoryRegion;
 840 void vmstate_register_ram(struct MemoryRegion *memory, DeviceState *dev);
 841 void vmstate_unregister_ram(struct MemoryRegion *memory, DeviceState *dev);
 842 void vmstate_register_ram_global(struct MemoryRegion *memory);
 843
 844 static inline
 845 int64_t self_announce_delay(int round)
 846 {
 847     assert(round < SELF_ANNOUNCE_ROUNDS && round > 0);
 848     /* delay 50ms, 150ms, 250ms, ... */
 849     return 50 + (SELF_ANNOUNCE_ROUNDS - round - 1) * 100;
 850 }
 851
 852 void dump_vmstate_json_to_file(FILE *out_fp);
 853
 854 #endif