hw/hw.h

   1 /* Declarations for use by hardware emulation.  */
   2 #ifndef QEMU_HW_H
   3 #define QEMU_HW_H
   4
   5 #include "qemu-common.h"
   6
   7 #if defined(TARGET_PHYS_ADDR_BITS) && !defined(NEED_CPU_H)
   8 #include "cpu-common.h"
   9 #endif
  10
  11 #include <stdbool.h>
  12 #include "ioport.h"
  13 #include "irq.h"
  14
  15 /* VM Load/Save */
  16
  17 /* This function writes a chunk of data to a file at the given position.
  18  * The pos argument can be ignored if the file is only being used for
  19  * streaming.  The handler should try to write all of the data it can.
  20  */
  21 typedef int (QEMUFilePutBufferFunc)(void *opaque, const uint8_t *buf,
  22                                     int64_t pos, int size);
  23
  24 /* Read a chunk of data from a file at the given position.  The pos argument
  25  * can be ignored if the file is only be used for streaming.  The number of
  26  * bytes actually read should be returned.
  27  */
  28 typedef int (QEMUFileGetBufferFunc)(void *opaque, uint8_t *buf,
  29                                     int64_t pos, int size);
  30
  31 /* Close a file and return an error code */
  32 typedef int (QEMUFileCloseFunc)(void *opaque);
  33
  34 /* Called to determine if the file has exceeded it's bandwidth allocation.  The
  35  * bandwidth capping is a soft limit, not a hard limit.
  36  */
  37 typedef int (QEMUFileRateLimit)(void *opaque);
  38
  39 /* Called to change the current bandwidth allocation. This function must return
  40  * the new actual bandwidth. It should be new_rate if everything goes ok, and
  41  * the old rate otherwise
  42  */
  43 typedef size_t (QEMUFileSetRateLimit)(void *opaque, size_t new_rate);
  44 typedef size_t (QEMUFileGetRateLimit)(void *opaque);
  45
  46 QEMUFile *qemu_fopen_ops(void *opaque, QEMUFilePutBufferFunc *put_buffer,
  47                          QEMUFileGetBufferFunc *get_buffer,
  48                          QEMUFileCloseFunc *close,
  49                          QEMUFileRateLimit *rate_limit,
  50                          QEMUFileSetRateLimit *set_rate_limit,
  51                          QEMUFileGetRateLimit *get_rate_limit);
  52 QEMUFile *qemu_fopen(const char *filename, const char *mode);
  53 QEMUFile *qemu_fdopen(int fd, const char *mode);
  54 QEMUFile *qemu_fopen_socket(int fd);
  55 QEMUFile *qemu_popen(FILE *popen_file, const char *mode);
  56 QEMUFile *qemu_popen_cmd(const char *command, const char *mode);
  57 int qemu_stdio_fd(QEMUFile *f);
  58 void qemu_fflush(QEMUFile *f);
  59 int qemu_fclose(QEMUFile *f);
  60 void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, int size);
  61 void qemu_put_byte(QEMUFile *f, int v);
  62
  63 static inline void qemu_put_ubyte(QEMUFile *f, unsigned int v)
  64 {
  65     qemu_put_byte(f, (int)v);
  66 }
  67
  68 #define qemu_put_sbyte qemu_put_byte
  69
  70 void qemu_put_be16(QEMUFile *f, unsigned int v);
  71 void qemu_put_be32(QEMUFile *f, unsigned int v);
  72 void qemu_put_be64(QEMUFile *f, uint64_t v);
  73 int qemu_get_buffer(QEMUFile *f, uint8_t *buf, int size);
  74 int qemu_get_byte(QEMUFile *f);
  75
  76 static inline unsigned int qemu_get_ubyte(QEMUFile *f)
  77 {
  78     return (unsigned int)qemu_get_byte(f);
  79 }
  80
  81 #define qemu_get_sbyte qemu_get_byte
  82
  83 unsigned int qemu_get_be16(QEMUFile *f);
  84 unsigned int qemu_get_be32(QEMUFile *f);
  85 uint64_t qemu_get_be64(QEMUFile *f);
  86 int qemu_file_rate_limit(QEMUFile *f);
  87 size_t qemu_file_set_rate_limit(QEMUFile *f, size_t new_rate);
  88 size_t qemu_file_get_rate_limit(QEMUFile *f);
  89 int qemu_file_has_error(QEMUFile *f);
  90 void qemu_file_set_error(QEMUFile *f);
  91
  92 /* Try to send any outstanding data.  This function is useful when output is
  93  * halted due to rate limiting or EAGAIN errors occur as it can be used to
  94  * resume output. */
  95 void qemu_file_put_notify(QEMUFile *f);
  96
  97 static inline void qemu_put_be64s(QEMUFile *f, const uint64_t *pv)
  98 {
  99     qemu_put_be64(f, *pv);
 100 }
 101
 102 static inline void qemu_put_be32s(QEMUFile *f, const uint32_t *pv)
 103 {
 104     qemu_put_be32(f, *pv);
 105 }
 106
 107 static inline void qemu_put_be16s(QEMUFile *f, const uint16_t *pv)
 108 {
 109     qemu_put_be16(f, *pv);
 110 }
 111
 112 static inline void qemu_put_8s(QEMUFile *f, const uint8_t *pv)
 113 {
 114     qemu_put_byte(f, *pv);
 115 }
 116
 117 static inline void qemu_get_be64s(QEMUFile *f, uint64_t *pv)
 118 {
 119     *pv = qemu_get_be64(f);
 120 }
 121
 122 static inline void qemu_get_be32s(QEMUFile *f, uint32_t *pv)
 123 {
 124     *pv = qemu_get_be32(f);
 125 }
 126
 127 static inline void qemu_get_be16s(QEMUFile *f, uint16_t *pv)
 128 {
 129     *pv = qemu_get_be16(f);
 130 }
 131
 132 static inline void qemu_get_8s(QEMUFile *f, uint8_t *pv)
 133 {
 134     *pv = qemu_get_byte(f);
 135 }
 136
 137 // Signed versions for type safety
 138 static inline void qemu_put_sbuffer(QEMUFile *f, const int8_t *buf, int size)
 139 {
 140     qemu_put_buffer(f, (const uint8_t *)buf, size);
 141 }
 142
 143 static inline void qemu_put_sbe16(QEMUFile *f, int v)
 144 {
 145     qemu_put_be16(f, (unsigned int)v);
 146 }
 147
 148 static inline void qemu_put_sbe32(QEMUFile *f, int v)
 149 {
 150     qemu_put_be32(f, (unsigned int)v);
 151 }
 152
 153 static inline void qemu_put_sbe64(QEMUFile *f, int64_t v)
 154 {
 155     qemu_put_be64(f, (uint64_t)v);
 156 }
 157
 158 static inline size_t qemu_get_sbuffer(QEMUFile *f, int8_t *buf, int size)
 159 {
 160     return qemu_get_buffer(f, (uint8_t *)buf, size);
 161 }
 162
 163 static inline int qemu_get_sbe16(QEMUFile *f)
 164 {
 165     return (int)qemu_get_be16(f);
 166 }
 167
 168 static inline int qemu_get_sbe32(QEMUFile *f)
 169 {
 170     return (int)qemu_get_be32(f);
 171 }
 172
 173 static inline int64_t qemu_get_sbe64(QEMUFile *f)
 174 {
 175     return (int64_t)qemu_get_be64(f);
 176 }
 177
 178 static inline void qemu_put_s8s(QEMUFile *f, const int8_t *pv)
 179 {
 180     qemu_put_8s(f, (const uint8_t *)pv);
 181 }
 182
 183 static inline void qemu_put_sbe16s(QEMUFile *f, const int16_t *pv)
 184 {
 185     qemu_put_be16s(f, (const uint16_t *)pv);
 186 }
 187
 188 static inline void qemu_put_sbe32s(QEMUFile *f, const int32_t *pv)
 189 {
 190     qemu_put_be32s(f, (const uint32_t *)pv);
 191 }
 192
 193 static inline void qemu_put_sbe64s(QEMUFile *f, const int64_t *pv)
 194 {
 195     qemu_put_be64s(f, (const uint64_t *)pv);
 196 }
 197
 198 static inline void qemu_get_s8s(QEMUFile *f, int8_t *pv)
 199 {
 200     qemu_get_8s(f, (uint8_t *)pv);
 201 }
 202
 203 static inline void qemu_get_sbe16s(QEMUFile *f, int16_t *pv)
 204 {
 205     qemu_get_be16s(f, (uint16_t *)pv);
 206 }
 207
 208 static inline void qemu_get_sbe32s(QEMUFile *f, int32_t *pv)
 209 {
 210     qemu_get_be32s(f, (uint32_t *)pv);
 211 }
 212
 213 static inline void qemu_get_sbe64s(QEMUFile *f, int64_t *pv)
 214 {
 215     qemu_get_be64s(f, (uint64_t *)pv);
 216 }
 217
 218 #ifdef NEED_CPU_H
 219 #if TARGET_LONG_BITS == 64
 220 #define qemu_put_betl qemu_put_be64
 221 #define qemu_get_betl qemu_get_be64
 222 #define qemu_put_betls qemu_put_be64s
 223 #define qemu_get_betls qemu_get_be64s
 224 #define qemu_put_sbetl qemu_put_sbe64
 225 #define qemu_get_sbetl qemu_get_sbe64
 226 #define qemu_put_sbetls qemu_put_sbe64s
 227 #define qemu_get_sbetls qemu_get_sbe64s
 228 #else
 229 #define qemu_put_betl qemu_put_be32
 230 #define qemu_get_betl qemu_get_be32
 231 #define qemu_put_betls qemu_put_be32s
 232 #define qemu_get_betls qemu_get_be32s
 233 #define qemu_put_sbetl qemu_put_sbe32
 234 #define qemu_get_sbetl qemu_get_sbe32
 235 #define qemu_put_sbetls qemu_put_sbe32s
 236 #define qemu_get_sbetls qemu_get_sbe32s
 237 #endif
 238 #endif
 239
 240 int64_t qemu_ftell(QEMUFile *f);
 241 int64_t qemu_fseek(QEMUFile *f, int64_t pos, int whence);
 242
 243 typedef void SaveSetParamsHandler(int blk_enable, int shared, void * opaque);
 244 typedef void SaveStateHandler(QEMUFile *f, void *opaque);
 245 typedef int SaveLiveStateHandler(Monitor *mon, QEMUFile *f, int stage,
 246                                  void *opaque);
 247 typedef int LoadStateHandler(QEMUFile *f, void *opaque, int version_id);
 248
 249 int register_savevm(const char *idstr,
 250                     int instance_id,
 251                     int version_id,
 252                     SaveStateHandler *save_state,
 253                     LoadStateHandler *load_state,
 254                     void *opaque);
 255
 256 int register_savevm_live(const char *idstr,
 257                          int instance_id,
 258                          int version_id,
 259                          SaveSetParamsHandler *set_params,
 260                          SaveLiveStateHandler *save_live_state,
 261                          SaveStateHandler *save_state,
 262                          LoadStateHandler *load_state,
 263                          void *opaque);
 264
 265 void unregister_savevm(const char *idstr, void *opaque);
 266
 267 typedef void QEMUResetHandler(void *opaque);
 268
 269 void qemu_register_reset(QEMUResetHandler *func, void *opaque);
 270 void qemu_unregister_reset(QEMUResetHandler *func, void *opaque);
 271
 272 /* handler to set the boot_device order for a specific type of QEMUMachine */
 273 /* return 0 if success */
 274 typedef int QEMUBootSetHandler(void *opaque, const char *boot_devices);
 275 void qemu_register_boot_set(QEMUBootSetHandler *func, void *opaque);
 276 int qemu_boot_set(const char *boot_devices);
 277
 278 typedef struct VMStateInfo VMStateInfo;
 279 typedef struct VMStateDescription VMStateDescription;
 280
 281 struct VMStateInfo {
 282     const char *name;
 283     int (*get)(QEMUFile *f, void *pv, size_t size);
 284     void (*put)(QEMUFile *f, void *pv, size_t size);
 285 };
 286
 287 enum VMStateFlags {
 288     VMS_SINGLE           = 0x001,
 289     VMS_POINTER          = 0x002,
 290     VMS_ARRAY            = 0x004,
 291     VMS_STRUCT           = 0x008,
 292     VMS_VARRAY_INT32     = 0x010,  /* Array with size in int32_t field*/
 293     VMS_BUFFER           = 0x020,  /* static sized buffer */
 294     VMS_ARRAY_OF_POINTER = 0x040,
 295     VMS_VARRAY_UINT16    = 0x080,  /* Array with size in uint16_t field */
 296     VMS_VBUFFER          = 0x100,  /* Buffer with size in int32_t field */
 297     VMS_MULTIPLY         = 0x200,  /* multiply "size" field by field_size */
 298 };
 299
 300 typedef struct {
 301     const char *name;
 302     size_t offset;
 303     size_t size;
 304     size_t start;
 305     int num;
 306     size_t num_offset;
 307     size_t size_offset;
 308     const VMStateInfo *info;
 309     enum VMStateFlags flags;
 310     const VMStateDescription *vmsd;
 311     int version_id;
 312     bool (*field_exists)(void *opaque, int version_id);
 313 } VMStateField;
 314
 315 struct VMStateDescription {
 316     const char *name;
 317     int version_id;
 318     int minimum_version_id;
 319     int minimum_version_id_old;
 320     LoadStateHandler *load_state_old;
 321     int (*pre_load)(void *opaque);
 322     int (*post_load)(void *opaque, int version_id);
 323     void (*pre_save)(void *opaque);
 324     VMStateField *fields;
 325 };
 326
 327 extern const VMStateInfo vmstate_info_int8;
 328 extern const VMStateInfo vmstate_info_int16;
 329 extern const VMStateInfo vmstate_info_int32;
 330 extern const VMStateInfo vmstate_info_int64;
 331
 332 extern const VMStateInfo vmstate_info_uint8_equal;
 333 extern const VMStateInfo vmstate_info_uint16_equal;
 334 extern const VMStateInfo vmstate_info_int32_equal;
 335 extern const VMStateInfo vmstate_info_int32_le;
 336
 337 extern const VMStateInfo vmstate_info_uint8;
 338 extern const VMStateInfo vmstate_info_uint16;
 339 extern const VMStateInfo vmstate_info_uint32;
 340 extern const VMStateInfo vmstate_info_uint64;
 341
 342 extern const VMStateInfo vmstate_info_timer;
 343 extern const VMStateInfo vmstate_info_ptimer;
 344 extern const VMStateInfo vmstate_info_buffer;
 345 extern const VMStateInfo vmstate_info_unused_buffer;
 346
 347 #define type_check_array(t1,t2,n) ((t1(*)[n])0 - (t2*)0)
 348 #define type_check_pointer(t1,t2) ((t1**)0 - (t2*)0)
 349
 350 #define vmstate_offset_value(_state, _field, _type)                  \
 351     (offsetof(_state, _field) +                                      \
 352      type_check(_type, typeof_field(_state, _field)))
 353
 354 #define vmstate_offset_pointer(_state, _field, _type)                \
 355     (offsetof(_state, _field) +                                      \
 356      type_check_pointer(_type, typeof_field(_state, _field)))
 357
 358 #define vmstate_offset_array(_state, _field, _type, _num)            \
 359     (offsetof(_state, _field) +                                      \
 360      type_check_array(_type, typeof_field(_state, _field), _num))
 361
 362 #define vmstate_offset_sub_array(_state, _field, _type, _start)      \
 363     (offsetof(_state, _field[_start]))
 364
 365 #define vmstate_offset_buffer(_state, _field)                        \
 366     vmstate_offset_array(_state, _field, uint8_t,                    \
 367                          sizeof(typeof_field(_state, _field)))
 368
 369 #define VMSTATE_SINGLE_TEST(_field, _state, _test, _version, _info, _type) { \
 370     .name         = (stringify(_field)),                             \
 371     .version_id   = (_version),                                      \
 372     .field_exists = (_test),                                         \
 373     .size         = sizeof(_type),                                   \
 374     .info         = &(_info),                                        \
 375     .flags        = VMS_SINGLE,                                      \
 376     .offset       = vmstate_offset_value(_state, _field, _type),     \
 377 }
 378
 379 #define VMSTATE_POINTER(_field, _state, _version, _info, _type) {    \
 380     .name       = (stringify(_field)),                               \
 381     .version_id = (_version),                                        \
 382     .info       = &(_info),                                          \
 383     .size       = sizeof(_type),                                     \
 384     .flags      = VMS_SINGLE|VMS_POINTER,                            \
 385     .offset     = vmstate_offset_value(_state, _field, _type),       \
 386 }
 387
 388 #define VMSTATE_ARRAY(_field, _state, _num, _version, _info, _type) {\
 389     .name       = (stringify(_field)),                               \
 390     .version_id = (_version),                                        \
 391     .num        = (_num),                                            \
 392     .info       = &(_info),                                          \
 393     .size       = sizeof(_type),                                     \
 394     .flags      = VMS_ARRAY,                                         \
 395     .offset     = vmstate_offset_array(_state, _field, _type, _num), \
 396 }
 397
 398 #define VMSTATE_ARRAY_TEST(_field, _state, _num, _test, _info, _type) {\
 399     .name         = (stringify(_field)),                              \
 400     .field_exists = (_test),                                          \
 401     .num          = (_num),                                           \
 402     .info         = &(_info),                                         \
 403     .size         = sizeof(_type),                                    \
 404     .flags        = VMS_ARRAY,                                        \
 405     .offset       = vmstate_offset_array(_state, _field, _type, _num),\
 406 }
 407
 408 #define VMSTATE_SUB_ARRAY(_field, _state, _start, _num, _version, _info, _type) { \
 409     .name       = (stringify(_field)),                               \
 410     .version_id = (_version),                                        \
 411     .num        = (_num),                                            \
 412     .info       = &(_info),                                          \
 413     .size       = sizeof(_type),                                     \
 414     .flags      = VMS_ARRAY,                                         \
 415     .offset     = vmstate_offset_sub_array(_state, _field, _type, _start), \
 416 }
 417
 418 #define VMSTATE_VARRAY_INT32(_field, _state, _field_num, _version, _info, _type) {\
 419     .name       = (stringify(_field)),                               \
 420     .version_id = (_version),                                        \
 421     .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
 422     .info       = &(_info),                                          \
 423     .size       = sizeof(_type),                                     \
 424     .flags      = VMS_VARRAY_INT32|VMS_POINTER,                      \
 425     .offset     = vmstate_offset_pointer(_state, _field, _type),     \
 426 }
 427
 428 #define VMSTATE_VARRAY_UINT16_UNSAFE(_field, _state, _field_num, _version, _info, _type) {\
 429     .name       = (stringify(_field)),                               \
 430     .version_id = (_version),                                        \
 431     .num_offset = vmstate_offset_value(_state, _field_num, uint16_t),\
 432     .info       = &(_info),                                          \
 433     .size       = sizeof(_type),                                     \
 434     .flags      = VMS_VARRAY_UINT16,                                 \
 435     .offset     = offsetof(_state, _field),                          \
 436 }
 437
 438 #define VMSTATE_STRUCT_TEST(_field, _state, _test, _version, _vmsd, _type) { \
 439     .name         = (stringify(_field)),                             \
 440     .version_id   = (_version),                                      \
 441     .field_exists = (_test),                                         \
 442     .vmsd         = &(_vmsd),                                        \
 443     .size         = sizeof(_type),                                   \
 444     .flags        = VMS_STRUCT,                                      \
 445     .offset       = vmstate_offset_value(_state, _field, _type),     \
 446 }
 447
 448 #define VMSTATE_STRUCT_POINTER_TEST(_field, _state, _test, _vmsd, _type) { \
 449     .name         = (stringify(_field)),                             \
 450     .field_exists = (_test),                                         \
 451     .vmsd         = &(_vmsd),                                        \
 452     .size         = sizeof(_type),                                   \
 453     .flags        = VMS_STRUCT|VMS_POINTER,                          \
 454     .offset       = vmstate_offset_value(_state, _field, _type),     \
 455 }
 456
 457 #define VMSTATE_ARRAY_OF_POINTER(_field, _state, _num, _version, _info, _type) {\
 458     .name       = (stringify(_field)),                               \
 459     .version_id = (_version),                                        \
 460     .num        = (_num),                                            \
 461     .info       = &(_info),                                          \
 462     .size       = sizeof(_type),                                     \
 463     .flags      = VMS_ARRAY|VMS_ARRAY_OF_POINTER,                    \
 464     .offset     = vmstate_offset_array(_state, _field, _type, _num), \
 465 }
 466
 467 #define VMSTATE_STRUCT_ARRAY(_field, _state, _num, _version, _vmsd, _type) { \
 468     .name       = (stringify(_field)),                               \
 469     .num        = (_num),                                            \
 470     .version_id = (_version),                                        \
 471     .vmsd       = &(_vmsd),                                          \
 472     .size       = sizeof(_type),                                     \
 473     .flags      = VMS_STRUCT|VMS_ARRAY,                              \
 474     .offset     = vmstate_offset_array(_state, _field, _type, _num), \
 475 }
 476
 477 #define VMSTATE_STATIC_BUFFER(_field, _state, _version, _test, _start, _size) { \
 478     .name         = (stringify(_field)),                             \
 479     .version_id   = (_version),                                      \
 480     .field_exists = (_test),                                         \
 481     .size         = (_size - _start),                                \
 482     .info         = &vmstate_info_buffer,                            \
 483     .flags        = VMS_BUFFER,                                      \
 484     .offset       = vmstate_offset_buffer(_state, _field) + _start,  \
 485 }
 486
 487 #define VMSTATE_BUFFER_MULTIPLY(_field, _state, _version, _test, _start, _field_size, _multiply) { \
 488     .name         = (stringify(_field)),                             \
 489     .version_id   = (_version),                                      \
 490     .field_exists = (_test),                                         \
 491     .size_offset  = vmstate_offset_value(_state, _field_size, uint32_t),\
 492     .size         = (_multiply),                                      \
 493     .info         = &vmstate_info_buffer,                            \
 494     .flags        = VMS_VBUFFER|VMS_MULTIPLY,                        \
 495     .offset       = offsetof(_state, _field),                        \
 496     .start        = (_start),                                        \
 497 }
 498
 499 #define VMSTATE_VBUFFER(_field, _state, _version, _test, _start, _field_size) { \
 500     .name         = (stringify(_field)),                             \
 501     .version_id   = (_version),                                      \
 502     .field_exists = (_test),                                         \
 503     .size_offset  = vmstate_offset_value(_state, _field_size, int32_t),\
 504     .info         = &vmstate_info_buffer,                            \
 505     .flags        = VMS_VBUFFER|VMS_POINTER,                         \
 506     .offset       = offsetof(_state, _field),                        \
 507     .start        = (_start),                                        \
 508 }
 509
 510 #define VMSTATE_BUFFER_UNSAFE_INFO(_field, _state, _version, _info, _size) { \
 511     .name       = (stringify(_field)),                               \
 512     .version_id = (_version),                                        \
 513     .size       = (_size),                                           \
 514     .info       = &(_info),                                          \
 515     .flags      = VMS_BUFFER,                                        \
 516     .offset     = offsetof(_state, _field),                          \
 517 }
 518
 519 #define VMSTATE_UNUSED_BUFFER(_test, _version, _size) {              \
 520     .name         = "unused",                                        \
 521     .field_exists = (_test),                                         \
 522     .version_id   = (_version),                                      \
 523     .size         = (_size),                                         \
 524     .info         = &vmstate_info_unused_buffer,                     \
 525     .flags        = VMS_BUFFER,                                      \
 526 }
 527 extern const VMStateDescription vmstate_pci_device;
 528
 529 #define VMSTATE_PCI_DEVICE(_field, _state) {                         \
 530     .name       = (stringify(_field)),                               \
 531     .size       = sizeof(PCIDevice),                                 \
 532     .vmsd       = &vmstate_pci_device,                               \
 533     .flags      = VMS_STRUCT,                                        \
 534     .offset     = vmstate_offset_value(_state, _field, PCIDevice),   \
 535 }
 536
 537 extern const VMStateDescription vmstate_pcie_device;
 538
 539 #define VMSTATE_PCIE_DEVICE(_field, _state) {                        \
 540     .name       = (stringify(_field)),                               \
 541     .version_id = 2,                                                 \
 542     .size       = sizeof(PCIDevice),                                 \
 543     .vmsd       = &vmstate_pcie_device,                              \
 544     .flags      = VMS_STRUCT,                                        \
 545     .offset     = vmstate_offset_value(_state, _field, PCIDevice),   \
 546 }
 547
 548 extern const VMStateDescription vmstate_i2c_slave;
 549
 550 #define VMSTATE_I2C_SLAVE(_field, _state) {                          \
 551     .name       = (stringify(_field)),                               \
 552     .size       = sizeof(i2c_slave),                                 \
 553     .vmsd       = &vmstate_i2c_slave,                                \
 554     .flags      = VMS_STRUCT,                                        \
 555     .offset     = vmstate_offset_value(_state, _field, i2c_slave),   \
 556 }
 557
 558 #define vmstate_offset_macaddr(_state, _field)                       \
 559     vmstate_offset_array(_state, _field.a, uint8_t,                \
 560                          sizeof(typeof_field(_state, _field)))
 561
 562 #define VMSTATE_MACADDR(_field, _state) {                            \
 563     .name       = (stringify(_field)),                               \
 564     .size       = sizeof(MACAddr),                                   \
 565     .info       = &vmstate_info_buffer,                              \
 566     .flags      = VMS_BUFFER,                                        \
 567     .offset     = vmstate_offset_macaddr(_state, _field),            \
 568 }
 569
 570 /* _f : field name
 571    _f_n : num of elements field_name
 572    _n : num of elements
 573    _s : struct state name
 574    _v : version
 575 */
 576
 577 #define VMSTATE_SINGLE(_field, _state, _version, _info, _type)        \
 578     VMSTATE_SINGLE_TEST(_field, _state, NULL, _version, _info, _type)
 579
 580 #define VMSTATE_STRUCT(_field, _state, _version, _vmsd, _type)        \
 581     VMSTATE_STRUCT_TEST(_field, _state, NULL, _version, _vmsd, _type)
 582
 583 #define VMSTATE_STRUCT_POINTER(_field, _state, _vmsd, _type)          \
 584     VMSTATE_STRUCT_POINTER_TEST(_field, _state, NULL, _vmsd, _type)
 585
 586 #define VMSTATE_INT8_V(_f, _s, _v)                                    \
 587     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int8, int8_t)
 588 #define VMSTATE_INT16_V(_f, _s, _v)                                   \
 589     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int16, int16_t)
 590 #define VMSTATE_INT32_V(_f, _s, _v)                                   \
 591     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int32, int32_t)
 592 #define VMSTATE_INT64_V(_f, _s, _v)                                   \
 593     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int64, int64_t)
 594
 595 #define VMSTATE_UINT8_V(_f, _s, _v)                                   \
 596     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint8, uint8_t)
 597 #define VMSTATE_UINT16_V(_f, _s, _v)                                  \
 598     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint16, uint16_t)
 599 #define VMSTATE_UINT32_V(_f, _s, _v)                                  \
 600     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint32, uint32_t)
 601 #define VMSTATE_UINT64_V(_f, _s, _v)                                  \
 602     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint64, uint64_t)
 603
 604 #define VMSTATE_INT8(_f, _s)                                          \
 605     VMSTATE_INT8_V(_f, _s, 0)
 606 #define VMSTATE_INT16(_f, _s)                                         \
 607     VMSTATE_INT16_V(_f, _s, 0)
 608 #define VMSTATE_INT32(_f, _s)                                         \
 609     VMSTATE_INT32_V(_f, _s, 0)
 610 #define VMSTATE_INT64(_f, _s)                                         \
 611     VMSTATE_INT64_V(_f, _s, 0)
 612
 613 #define VMSTATE_UINT8(_f, _s)                                         \
 614     VMSTATE_UINT8_V(_f, _s, 0)
 615 #define VMSTATE_UINT16(_f, _s)                                        \
 616     VMSTATE_UINT16_V(_f, _s, 0)
 617 #define VMSTATE_UINT32(_f, _s)                                        \
 618     VMSTATE_UINT32_V(_f, _s, 0)
 619 #define VMSTATE_UINT64(_f, _s)                                        \
 620     VMSTATE_UINT64_V(_f, _s, 0)
 621
 622 #define VMSTATE_UINT8_EQUAL(_f, _s)                                   \
 623     VMSTATE_SINGLE(_f, _s, 0, vmstate_info_uint8_equal, uint8_t)
 624
 625 #define VMSTATE_UINT16_EQUAL(_f, _s)                                  \
 626     VMSTATE_SINGLE(_f, _s, 0, vmstate_info_uint16_equal, uint16_t)
 627
 628 #define VMSTATE_UINT16_EQUAL_V(_f, _s, _v)                            \
 629     VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint16_equal, uint16_t)
 630
 631 #define VMSTATE_INT32_EQUAL(_f, _s)                                   \
 632     VMSTATE_SINGLE(_f, _s, 0, vmstate_info_int32_equal, int32_t)
 633
 634 #define VMSTATE_INT32_LE(_f, _s)                                   \
 635     VMSTATE_SINGLE(_f, _s, 0, vmstate_info_int32_le, int32_t)
 636
 637 #define VMSTATE_UINT16_TEST(_f, _s, _t)                               \
 638     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint16, uint16_t)
 639
 640 #define VMSTATE_UINT32_TEST(_f, _s, _t)                                  \
 641     VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint32, uint32_t)
 642
 643 #define VMSTATE_TIMER_V(_f, _s, _v)                                   \
 644     VMSTATE_POINTER(_f, _s, _v, vmstate_info_timer, QEMUTimer *)
 645
 646 #define VMSTATE_TIMER(_f, _s)                                         \
 647     VMSTATE_TIMER_V(_f, _s, 0)
 648
 649 #define VMSTATE_TIMER_ARRAY(_f, _s, _n)                              \
 650     VMSTATE_ARRAY_OF_POINTER(_f, _s, _n, 0, vmstate_info_timer, QEMUTimer *)
 651
 652 #define VMSTATE_PTIMER_V(_f, _s, _v)                                  \
 653     VMSTATE_POINTER(_f, _s, _v, vmstate_info_ptimer, ptimer_state *)
 654
 655 #define VMSTATE_PTIMER(_f, _s)                                        \
 656     VMSTATE_PTIMER_V(_f, _s, 0)
 657
 658 #define VMSTATE_UINT16_ARRAY_V(_f, _s, _n, _v)                         \
 659     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint16, uint16_t)
 660
 661 #define VMSTATE_UINT16_ARRAY(_f, _s, _n)                               \
 662     VMSTATE_UINT16_ARRAY_V(_f, _s, _n, 0)
 663
 664 #define VMSTATE_UINT8_ARRAY_V(_f, _s, _n, _v)                         \
 665     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint8, uint8_t)
 666
 667 #define VMSTATE_UINT8_ARRAY(_f, _s, _n)                               \
 668     VMSTATE_UINT8_ARRAY_V(_f, _s, _n, 0)
 669
 670 #define VMSTATE_UINT32_ARRAY_V(_f, _s, _n, _v)                        \
 671     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint32, uint32_t)
 672
 673 #define VMSTATE_UINT32_ARRAY(_f, _s, _n)                              \
 674     VMSTATE_UINT32_ARRAY_V(_f, _s, _n, 0)
 675
 676 #define VMSTATE_UINT64_ARRAY_V(_f, _s, _n, _v)                        \
 677     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint64, uint64_t)
 678
 679 #define VMSTATE_UINT64_ARRAY(_f, _s, _n)                              \
 680     VMSTATE_UINT64_ARRAY_V(_f, _s, _n, 0)
 681
 682 #define VMSTATE_INT16_ARRAY_V(_f, _s, _n, _v)                         \
 683     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int16, int16_t)
 684
 685 #define VMSTATE_INT16_ARRAY(_f, _s, _n)                               \
 686     VMSTATE_INT16_ARRAY_V(_f, _s, _n, 0)
 687
 688 #define VMSTATE_INT32_ARRAY_V(_f, _s, _n, _v)                         \
 689     VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int32, int32_t)
 690
 691 #define VMSTATE_INT32_ARRAY(_f, _s, _n)                               \
 692     VMSTATE_INT32_ARRAY_V(_f, _s, _n, 0)
 693
 694 #define VMSTATE_UINT32_SUB_ARRAY(_f, _s, _start, _num)                \
 695     VMSTATE_SUB_ARRAY(_f, _s, _start, _num, 0, vmstate_info_uint32, uint32_t)
 696
 697 #define VMSTATE_UINT32_ARRAY(_f, _s, _n)                              \
 698     VMSTATE_UINT32_ARRAY_V(_f, _s, _n, 0)
 699
 700 #define VMSTATE_BUFFER_V(_f, _s, _v)                                  \
 701     VMSTATE_STATIC_BUFFER(_f, _s, _v, NULL, 0, sizeof(typeof_field(_s, _f)))
 702
 703 #define VMSTATE_BUFFER(_f, _s)                                        \
 704     VMSTATE_BUFFER_V(_f, _s, 0)
 705
 706 #define VMSTATE_PARTIAL_BUFFER(_f, _s, _size)                         \
 707     VMSTATE_STATIC_BUFFER(_f, _s, 0, NULL, 0, _size)
 708
 709 #define VMSTATE_BUFFER_START_MIDDLE(_f, _s, _start) \
 710     VMSTATE_STATIC_BUFFER(_f, _s, 0, NULL, _start, sizeof(typeof_field(_s, _f)))
 711
 712 #define VMSTATE_PARTIAL_VBUFFER(_f, _s, _size)                        \
 713     VMSTATE_VBUFFER(_f, _s, 0, NULL, 0, _size)
 714
 715 #define VMSTATE_SUB_VBUFFER(_f, _s, _start, _size)                    \
 716     VMSTATE_VBUFFER(_f, _s, 0, NULL, _start, _size)
 717
 718 #define VMSTATE_BUFFER_TEST(_f, _s, _test)                            \
 719     VMSTATE_STATIC_BUFFER(_f, _s, 0, _test, 0, sizeof(typeof_field(_s, _f)))
 720
 721 #define VMSTATE_BUFFER_UNSAFE(_field, _state, _version, _size)        \
 722     VMSTATE_BUFFER_UNSAFE_INFO(_field, _state, _version, vmstate_info_buffer, _size)
 723
 724 #define VMSTATE_UNUSED_V(_v, _size)                                   \
 725     VMSTATE_UNUSED_BUFFER(NULL, _v, _size)
 726
 727 #define VMSTATE_UNUSED(_size)                                         \
 728     VMSTATE_UNUSED_V(0, _size)
 729
 730 #define VMSTATE_UNUSED_TEST(_test, _size)                             \
 731     VMSTATE_UNUSED_BUFFER(_test, 0, _size)
 732
 733 #ifdef NEED_CPU_H
 734 #if TARGET_LONG_BITS == 64
 735 #define VMSTATE_UINTTL_V(_f, _s, _v)                                  \
 736     VMSTATE_UINT64_V(_f, _s, _v)
 737 #define VMSTATE_UINTTL_ARRAY_V(_f, _s, _n, _v)                        \
 738     VMSTATE_UINT64_ARRAY_V(_f, _s, _n, _v)
 739 #else
 740 #define VMSTATE_UINTTL_V(_f, _s, _v)                                  \
 741     VMSTATE_UINT32_V(_f, _s, _v)
 742 #define VMSTATE_UINTTL_ARRAY_V(_f, _s, _n, _v)                        \
 743     VMSTATE_UINT32_ARRAY_V(_f, _s, _n, _v)
 744 #endif
 745 #define VMSTATE_UINTTL(_f, _s)                                        \
 746     VMSTATE_UINTTL_V(_f, _s, 0)
 747 #define VMSTATE_UINTTL_ARRAY(_f, _s, _n)                              \
 748     VMSTATE_UINTTL_ARRAY_V(_f, _s, _n, 0)
 749
 750 #endif
 751
 752 #define VMSTATE_END_OF_LIST()                                         \
 753     {}
 754
 755 extern int vmstate_load_state(QEMUFile *f, const VMStateDescription *vmsd,
 756                               void *opaque, int version_id);
 757 extern void vmstate_save_state(QEMUFile *f, const VMStateDescription *vmsd,
 758                                void *opaque);
 759 extern int vmstate_register(int instance_id, const VMStateDescription *vmsd,
 760                             void *base);
 761 extern int vmstate_register_with_alias_id(int instance_id,
 762                                           const VMStateDescription *vmsd,
 763                                           void *base, int alias_id,
 764                                           int required_for_version);
 765 void vmstate_unregister(const VMStateDescription *vmsd, void *opaque);
 766 #endif