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