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