]> git.proxmox.com Git - mirror_qemu.git/blob - hw/hw.h
projects / mirror_qemu.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
QEMUFileCloseFunc: add return value documentation (v2)
[mirror_qemu.git] / 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 "ioport.h"
12 #include "irq.h"
13
14 /* VM Load/Save */
15
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 */
20 typedef int (QEMUFilePutBufferFunc)(void *opaque, const uint8_t *buf,
21 int64_t pos, int size);
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 */
27 typedef int (QEMUFileGetBufferFunc)(void *opaque, uint8_t *buf,
28 int64_t pos, int size);
29
30 /* Close a file
31 *
32 * Return negative error number on error, 0 or positive value on success.
33 *
34 * The meaning of return value on success depends on the specific back-end being
35 * used.
36 */
37 typedef int (QEMUFileCloseFunc)(void *opaque);
38
39 /* Called to determine if the file has exceeded it's bandwidth allocation. The
40 * bandwidth capping is a soft limit, not a hard limit.
41 */
42 typedef int (QEMUFileRateLimit)(void *opaque);
43
44 /* Called to change the current bandwidth allocation. This function must return
45 * the new actual bandwidth. It should be new_rate if everything goes ok, and
46 * the old rate otherwise
47 */
48 typedef int64_t (QEMUFileSetRateLimit)(void *opaque, int64_t new_rate);
49 typedef int64_t (QEMUFileGetRateLimit)(void *opaque);
50
51 QEMUFile *qemu_fopen_ops(void *opaque, QEMUFilePutBufferFunc *put_buffer,
52 QEMUFileGetBufferFunc *get_buffer,
53 QEMUFileCloseFunc *close,
54 QEMUFileRateLimit *rate_limit,
55 QEMUFileSetRateLimit *set_rate_limit,
56 QEMUFileGetRateLimit *get_rate_limit);
57 QEMUFile *qemu_fopen(const char *filename, const char *mode);
58 QEMUFile *qemu_fdopen(int fd, const char *mode);
59 QEMUFile *qemu_fopen_socket(int fd);
60 QEMUFile *qemu_popen(FILE *popen_file, const char *mode);
61 QEMUFile *qemu_popen_cmd(const char *command, const char *mode);
62 int qemu_stdio_fd(QEMUFile *f);
63 void qemu_fflush(QEMUFile *f);
64 int qemu_fclose(QEMUFile *f);
65 void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, int size);
66 void qemu_put_byte(QEMUFile *f, int v);
67
68 static inline void qemu_put_ubyte(QEMUFile *f, unsigned int v)
69 {
70 qemu_put_byte(f, (int)v);
71 }
72
73 #define qemu_put_sbyte qemu_put_byte
74
75 void qemu_put_be16(QEMUFile *f, unsigned int v);
76 void qemu_put_be32(QEMUFile *f, unsigned int v);
77 void qemu_put_be64(QEMUFile *f, uint64_t v);
78 int qemu_get_buffer(QEMUFile *f, uint8_t *buf, int size);
79 int qemu_get_byte(QEMUFile *f);
80
81 static inline unsigned int qemu_get_ubyte(QEMUFile *f)
82 {
83 return (unsigned int)qemu_get_byte(f);
84 }
85
86 #define qemu_get_sbyte qemu_get_byte
87
88 unsigned int qemu_get_be16(QEMUFile *f);
89 unsigned int qemu_get_be32(QEMUFile *f);
90 uint64_t qemu_get_be64(QEMUFile *f);
91 int qemu_file_rate_limit(QEMUFile *f);
92 int64_t qemu_file_set_rate_limit(QEMUFile *f, int64_t new_rate);
93 int64_t qemu_file_get_rate_limit(QEMUFile *f);
94 int qemu_file_get_error(QEMUFile *f);
95 void qemu_file_set_error(QEMUFile *f, int error);
96
97 /* Try to send any outstanding data. This function is useful when output is
98 * halted due to rate limiting or EAGAIN errors occur as it can be used to
99 * resume output. */
100 void qemu_file_put_notify(QEMUFile *f);
101
102 static inline void qemu_put_be64s(QEMUFile *f, const uint64_t *pv)
103 {
104 qemu_put_be64(f, *pv);
105 }
106
107 static inline void qemu_put_be32s(QEMUFile *f, const uint32_t *pv)
108 {
109 qemu_put_be32(f, *pv);
110 }
111
112 static inline void qemu_put_be16s(QEMUFile *f, const uint16_t *pv)
113 {
114 qemu_put_be16(f, *pv);
115 }
116
117 static inline void qemu_put_8s(QEMUFile *f, const uint8_t *pv)
118 {
119 qemu_put_byte(f, *pv);
120 }
121
122 static inline void qemu_get_be64s(QEMUFile *f, uint64_t *pv)
123 {
124 *pv = qemu_get_be64(f);
125 }
126
127 static inline void qemu_get_be32s(QEMUFile *f, uint32_t *pv)
128 {
129 *pv = qemu_get_be32(f);
130 }
131
132 static inline void qemu_get_be16s(QEMUFile *f, uint16_t *pv)
133 {
134 *pv = qemu_get_be16(f);
135 }
136
137 static inline void qemu_get_8s(QEMUFile *f, uint8_t *pv)
138 {
139 *pv = qemu_get_byte(f);
140 }
141
142 // Signed versions for type safety
143 static inline void qemu_put_sbuffer(QEMUFile *f, const int8_t *buf, int size)
144 {
145 qemu_put_buffer(f, (const uint8_t *)buf, size);
146 }
147
148 static inline void qemu_put_sbe16(QEMUFile *f, int v)
149 {
150 qemu_put_be16(f, (unsigned int)v);
151 }
152
153 static inline void qemu_put_sbe32(QEMUFile *f, int v)
154 {
155 qemu_put_be32(f, (unsigned int)v);
156 }
157
158 static inline void qemu_put_sbe64(QEMUFile *f, int64_t v)
159 {
160 qemu_put_be64(f, (uint64_t)v);
161 }
162
163 static inline size_t qemu_get_sbuffer(QEMUFile *f, int8_t *buf, int size)
164 {
165 return qemu_get_buffer(f, (uint8_t *)buf, size);
166 }
167
168 static inline int qemu_get_sbe16(QEMUFile *f)
169 {
170 return (int)qemu_get_be16(f);
171 }
172
173 static inline int qemu_get_sbe32(QEMUFile *f)
174 {
175 return (int)qemu_get_be32(f);
176 }
177
178 static inline int64_t qemu_get_sbe64(QEMUFile *f)
179 {
180 return (int64_t)qemu_get_be64(f);
181 }
182
183 static inline void qemu_put_s8s(QEMUFile *f, const int8_t *pv)
184 {
185 qemu_put_8s(f, (const uint8_t *)pv);
186 }
187
188 static inline void qemu_put_sbe16s(QEMUFile *f, const int16_t *pv)
189 {
190 qemu_put_be16s(f, (const uint16_t *)pv);
191 }
192
193 static inline void qemu_put_sbe32s(QEMUFile *f, const int32_t *pv)
194 {
195 qemu_put_be32s(f, (const uint32_t *)pv);
196 }
197
198 static inline void qemu_put_sbe64s(QEMUFile *f, const int64_t *pv)
199 {
200 qemu_put_be64s(f, (const uint64_t *)pv);
201 }
202
203 static inline void qemu_get_s8s(QEMUFile *f, int8_t *pv)
204 {
205 qemu_get_8s(f, (uint8_t *)pv);
206 }
207
208 static inline void qemu_get_sbe16s(QEMUFile *f, int16_t *pv)
209 {
210 qemu_get_be16s(f, (uint16_t *)pv);
211 }
212
213 static inline void qemu_get_sbe32s(QEMUFile *f, int32_t *pv)
214 {
215 qemu_get_be32s(f, (uint32_t *)pv);
216 }
217
218 static inline void qemu_get_sbe64s(QEMUFile *f, int64_t *pv)
219 {
220 qemu_get_be64s(f, (uint64_t *)pv);
221 }
222
223 #ifdef NEED_CPU_H
224 #if TARGET_LONG_BITS == 64
225 #define qemu_put_betl qemu_put_be64
226 #define qemu_get_betl qemu_get_be64
227 #define qemu_put_betls qemu_put_be64s
228 #define qemu_get_betls qemu_get_be64s
229 #define qemu_put_sbetl qemu_put_sbe64
230 #define qemu_get_sbetl qemu_get_sbe64
231 #define qemu_put_sbetls qemu_put_sbe64s
232 #define qemu_get_sbetls qemu_get_sbe64s
233 #else
234 #define qemu_put_betl qemu_put_be32
235 #define qemu_get_betl qemu_get_be32
236 #define qemu_put_betls qemu_put_be32s
237 #define qemu_get_betls qemu_get_be32s
238 #define qemu_put_sbetl qemu_put_sbe32
239 #define qemu_get_sbetl qemu_get_sbe32
240 #define qemu_put_sbetls qemu_put_sbe32s
241 #define qemu_get_sbetls qemu_get_sbe32s
242 #endif
243 #endif
244
245 int64_t qemu_ftell(QEMUFile *f);
246 int64_t qemu_fseek(QEMUFile *f, int64_t pos, int whence);
247
248 typedef void SaveSetParamsHandler(int blk_enable, int shared, void * opaque);
249 typedef void SaveStateHandler(QEMUFile *f, void *opaque);
250 typedef int SaveLiveStateHandler(Monitor *mon, QEMUFile *f, int stage,
251 void *opaque);
252 typedef int LoadStateHandler(QEMUFile *f, void *opaque, int version_id);
253
254 int register_savevm(DeviceState *dev,
255 const char *idstr,
256 int instance_id,
257 int version_id,
258 SaveStateHandler *save_state,
259 LoadStateHandler *load_state,
260 void *opaque);
261
262 int register_savevm_live(DeviceState *dev,
263 const char *idstr,
264 int instance_id,
265 int version_id,
266 SaveSetParamsHandler *set_params,
267 SaveLiveStateHandler *save_live_state,
268 SaveStateHandler *save_state,
269 LoadStateHandler *load_state,
270 void *opaque);
271
272 void unregister_savevm(DeviceState *dev, const char *idstr, void *opaque);
273 void register_device_unmigratable(DeviceState *dev, const char *idstr,
274 void *opaque);
275
276 typedef void QEMUResetHandler(void *opaque);
277
278 void qemu_register_reset(QEMUResetHandler *func, void *opaque);
279 void qemu_unregister_reset(QEMUResetHandler *func, void *opaque);
280
281 /* handler to set the boot_device order for a specific type of QEMUMachine */
282 /* return 0 if success */
283 typedef int QEMUBootSetHandler(void *opaque, const char *boot_devices);
284 void qemu_register_boot_set(QEMUBootSetHandler *func, void *opaque);
285 int qemu_boot_set(const char *boot_devices);
286
287 typedef struct VMStateInfo VMStateInfo;
288 typedef struct VMStateDescription VMStateDescription;
289
290 struct VMStateInfo {
291 const char *name;
292 int (*get)(QEMUFile *f, void *pv, size_t size);
293 void (*put)(QEMUFile *f, void *pv, size_t size);
294 };
295
296 enum VMStateFlags {
297 VMS_SINGLE = 0x001,
298 VMS_POINTER = 0x002,
299 VMS_ARRAY = 0x004,
300 VMS_STRUCT = 0x008,
301 VMS_VARRAY_INT32 = 0x010, /* Array with size in int32_t field*/
302 VMS_BUFFER = 0x020, /* static sized buffer */
303 VMS_ARRAY_OF_POINTER = 0x040,
304 VMS_VARRAY_UINT16 = 0x080, /* Array with size in uint16_t field */
305 VMS_VBUFFER = 0x100, /* Buffer with size in int32_t field */
306 VMS_MULTIPLY = 0x200, /* multiply "size" field by field_size */
307 VMS_VARRAY_UINT8 = 0x400, /* Array with size in uint8_t field*/
308 VMS_VARRAY_UINT32 = 0x800, /* Array with size in uint32_t field*/
309 };
310
311 typedef struct {
312 const char *name;
313 size_t offset;
314 size_t size;
315 size_t start;
316 int num;
317 size_t num_offset;
318 size_t size_offset;
319 const VMStateInfo *info;
320 enum VMStateFlags flags;
321 const VMStateDescription *vmsd;
322 int version_id;
323 bool (*field_exists)(void *opaque, int version_id);
324 } VMStateField;
325
326 typedef struct VMStateSubsection {
327 const VMStateDescription *vmsd;
328 bool (*needed)(void *opaque);
329 } VMStateSubsection;
330
331 struct VMStateDescription {
332 const char *name;
333 int unmigratable;
334 int version_id;
335 int minimum_version_id;
336 int minimum_version_id_old;
337 LoadStateHandler *load_state_old;
338 int (*pre_load)(void *opaque);
339 int (*post_load)(void *opaque, int version_id);
340 void (*pre_save)(void *opaque);
341 VMStateField *fields;
342 const VMStateSubsection *subsections;
343 };
344
345 extern const VMStateInfo vmstate_info_bool;
346
347 extern const VMStateInfo vmstate_info_int8;
348 extern const VMStateInfo vmstate_info_int16;
349 extern const VMStateInfo vmstate_info_int32;
350 extern const VMStateInfo vmstate_info_int64;
351
352 extern const VMStateInfo vmstate_info_uint8_equal;
353 extern const VMStateInfo vmstate_info_uint16_equal;
354 extern const VMStateInfo vmstate_info_int32_equal;
355 extern const VMStateInfo vmstate_info_uint32_equal;
356 extern const VMStateInfo vmstate_info_int32_le;
357
358 extern const VMStateInfo vmstate_info_uint8;
359 extern const VMStateInfo vmstate_info_uint16;
360 extern const VMStateInfo vmstate_info_uint32;
361 extern const VMStateInfo vmstate_info_uint64;
362
363 extern const VMStateInfo vmstate_info_timer;
364 extern const VMStateInfo vmstate_info_ptimer;
365 extern const VMStateInfo vmstate_info_buffer;
366 extern const VMStateInfo vmstate_info_unused_buffer;
367
368 #define type_check_array(t1,t2,n) ((t1(*)[n])0 - (t2*)0)
369 #define type_check_pointer(t1,t2) ((t1**)0 - (t2*)0)
370
371 #define vmstate_offset_value(_state, _field, _type) \
372 (offsetof(_state, _field) + \
373 type_check(_type, typeof_field(_state, _field)))
374
375 #define vmstate_offset_pointer(_state, _field, _type) \
376 (offsetof(_state, _field) + \
377 type_check_pointer(_type, typeof_field(_state, _field)))
378
379 #define vmstate_offset_array(_state, _field, _type, _num) \
380 (offsetof(_state, _field) + \
381 type_check_array(_type, typeof_field(_state, _field), _num))
382
383 #define vmstate_offset_sub_array(_state, _field, _type, _start) \
384 (offsetof(_state, _field[_start]))
385
386 #define vmstate_offset_buffer(_state, _field) \
387 vmstate_offset_array(_state, _field, uint8_t, \
388 sizeof(typeof_field(_state, _field)))
389
390 #define VMSTATE_SINGLE_TEST(_field, _state, _test, _version, _info, _type) { \
391 .name = (stringify(_field)), \
392 .version_id = (_version), \
393 .field_exists = (_test), \
394 .size = sizeof(_type), \
395 .info = &(_info), \
396 .flags = VMS_SINGLE, \
397 .offset = vmstate_offset_value(_state, _field, _type), \
398 }
399
400 #define VMSTATE_POINTER(_field, _state, _version, _info, _type) { \
401 .name = (stringify(_field)), \
402 .version_id = (_version), \
403 .info = &(_info), \
404 .size = sizeof(_type), \
405 .flags = VMS_SINGLE|VMS_POINTER, \
406 .offset = vmstate_offset_value(_state, _field, _type), \
407 }
408
409 #define VMSTATE_POINTER_TEST(_field, _state, _test, _info, _type) { \
410 .name = (stringify(_field)), \
411 .info = &(_info), \
412 .field_exists = (_test), \
413 .size = sizeof(_type), \
414 .flags = VMS_SINGLE|VMS_POINTER, \
415 .offset = vmstate_offset_value(_state, _field, _type), \
416 }
417
418 #define VMSTATE_ARRAY(_field, _state, _num, _version, _info, _type) {\
419 .name = (stringify(_field)), \
420 .version_id = (_version), \
421 .num = (_num), \
422 .info = &(_info), \
423 .size = sizeof(_type), \
424 .flags = VMS_ARRAY, \
425 .offset = vmstate_offset_array(_state, _field, _type, _num), \
426 }
427
428 #define VMSTATE_ARRAY_TEST(_field, _state, _num, _test, _info, _type) {\
429 .name = (stringify(_field)), \
430 .field_exists = (_test), \
431 .num = (_num), \
432 .info = &(_info), \
433 .size = sizeof(_type), \
434 .flags = VMS_ARRAY, \
435 .offset = vmstate_offset_array(_state, _field, _type, _num),\
436 }
437
438 #define VMSTATE_SUB_ARRAY(_field, _state, _start, _num, _version, _info, _type) { \
439 .name = (stringify(_field)), \
440 .version_id = (_version), \
441 .num = (_num), \
442 .info = &(_info), \
443 .size = sizeof(_type), \
444 .flags = VMS_ARRAY, \
445 .offset = vmstate_offset_sub_array(_state, _field, _type, _start), \
446 }
447
448 #define VMSTATE_ARRAY_INT32_UNSAFE(_field, _state, _field_num, _info, _type) {\
449 .name = (stringify(_field)), \
450 .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
451 .info = &(_info), \
452 .size = sizeof(_type), \
453 .flags = VMS_VARRAY_INT32, \
454 .offset = offsetof(_state, _field), \
455 }
456
457 #define VMSTATE_VARRAY_INT32(_field, _state, _field_num, _version, _info, _type) {\
458 .name = (stringify(_field)), \
459 .version_id = (_version), \
460 .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
461 .info = &(_info), \
462 .size = sizeof(_type), \
463 .flags = VMS_VARRAY_INT32|VMS_POINTER, \
464 .offset = vmstate_offset_pointer(_state, _field, _type), \
465 }
466
467 #define VMSTATE_VARRAY_UINT32(_field, _state, _field_num, _version, _info, _type) {\
468 .name = (stringify(_field)), \
469 .version_id = (_version), \
470 .num_offset = vmstate_offset_value(_state, _field_num, uint32_t),\
471 .info = &(_info), \
472 .size = sizeof(_type), \
473 .flags = VMS_VARRAY_UINT32|VMS_POINTER, \
474 .offset = vmstate_offset_pointer(_state, _field, _type), \
475 }
476
477 #define VMSTATE_VARRAY_UINT16_UNSAFE(_field, _state, _field_num, _version, _info, _type) {\
478 .name = (stringify(_field)), \
479 .version_id = (_version), \
480 .num_offset = vmstate_offset_value(_state, _field_num, uint16_t),\
481 .info = &(_info), \
482 .size = sizeof(_type), \
483 .flags = VMS_VARRAY_UINT16, \
484 .offset = offsetof(_state, _field), \
485 }
486
487 #define VMSTATE_STRUCT_TEST(_field, _state, _test, _version, _vmsd, _type) { \
488 .name = (stringify(_field)), \
489 .version_id = (_version), \
490 .field_exists = (_test), \
491 .vmsd = &(_vmsd), \
492 .size = sizeof(_type), \
493 .flags = VMS_STRUCT, \
494 .offset = vmstate_offset_value(_state, _field, _type), \
495 }
496
497 #define VMSTATE_STRUCT_POINTER_TEST(_field, _state, _test, _vmsd, _type) { \
498 .name = (stringify(_field)), \
499 .field_exists = (_test), \
500 .vmsd = &(_vmsd), \
501 .size = sizeof(_type), \
502 .flags = VMS_STRUCT|VMS_POINTER, \
503 .offset = vmstate_offset_value(_state, _field, _type), \
504 }
505
506 #define VMSTATE_ARRAY_OF_POINTER(_field, _state, _num, _version, _info, _type) {\
507 .name = (stringify(_field)), \
508 .version_id = (_version), \
509 .num = (_num), \
510 .info = &(_info), \
511 .size = sizeof(_type), \
512 .flags = VMS_ARRAY|VMS_ARRAY_OF_POINTER, \
513 .offset = vmstate_offset_array(_state, _field, _type, _num), \
514 }
515
516 #define VMSTATE_STRUCT_ARRAY_TEST(_field, _state, _num, _test, _version, _vmsd, _type) { \
517 .name = (stringify(_field)), \
518 .num = (_num), \
519 .field_exists = (_test), \
520 .version_id = (_version), \
521 .vmsd = &(_vmsd), \
522 .size = sizeof(_type), \
523 .flags = VMS_STRUCT|VMS_ARRAY, \
524 .offset = vmstate_offset_array(_state, _field, _type, _num),\
525 }
526
527 #define VMSTATE_STRUCT_VARRAY_UINT8(_field, _state, _field_num, _version, _vmsd, _type) { \
528 .name = (stringify(_field)), \
529 .num_offset = vmstate_offset_value(_state, _field_num, uint8_t), \
530 .version_id = (_version), \
531 .vmsd = &(_vmsd), \
532 .size = sizeof(_type), \
533 .flags = VMS_STRUCT|VMS_VARRAY_UINT8, \
534 .offset = offsetof(_state, _field), \
535 }
536
537 #define VMSTATE_STRUCT_VARRAY_POINTER_INT32(_field, _state, _field_num, _vmsd, _type) { \
538 .name = (stringify(_field)), \
539 .version_id = 0, \
540 .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
541 .size = sizeof(_type), \
542 .vmsd = &(_vmsd), \
543 .flags = VMS_POINTER | VMS_VARRAY_INT32 | VMS_STRUCT, \
544 .offset = vmstate_offset_pointer(_state, _field, _type), \
545 }
546
547 #define VMSTATE_STRUCT_VARRAY_POINTER_UINT16(_field, _state, _field_num, _vmsd, _type) { \
548 .name = (stringify(_field)), \
549 .version_id = 0, \
550 .num_offset = vmstate_offset_value(_state, _field_num, uint16_t),\
551 .size = sizeof(_type), \
552 .vmsd = &(_vmsd), \
553 .flags = VMS_POINTER | VMS_VARRAY_UINT16 | VMS_STRUCT, \
554 .offset = vmstate_offset_pointer(_state, _field, _type), \
555 }
556
557 #define VMSTATE_STRUCT_VARRAY_INT32(_field, _state, _field_num, _version, _vmsd, _type) { \
558 .name = (stringify(_field)), \
559 .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
560 .version_id = (_version), \
561 .vmsd = &(_vmsd), \
562 .size = sizeof(_type), \
563 .flags = VMS_STRUCT|VMS_VARRAY_INT32, \
564 .offset = offsetof(_state, _field), \
565 }
566
567 #define VMSTATE_STRUCT_VARRAY_UINT32(_field, _state, _field_num, _version, _vmsd, _type) { \
568 .name = (stringify(_field)), \
569 .num_offset = vmstate_offset_value(_state, _field_num, uint32_t), \
570 .version_id = (_version), \
571 .vmsd = &(_vmsd), \
572 .size = sizeof(_type), \
573 .flags = VMS_STRUCT|VMS_VARRAY_UINT32, \
574 .offset = offsetof(_state, _field), \
575 }
576
577 #define VMSTATE_STATIC_BUFFER(_field, _state, _version, _test, _start, _size) { \
578 .name = (stringify(_field)), \
579 .version_id = (_version), \
580 .field_exists = (_test), \
581 .size = (_size - _start), \
582 .info = &vmstate_info_buffer, \
583 .flags = VMS_BUFFER, \
584 .offset = vmstate_offset_buffer(_state, _field) + _start, \
585 }
586
587 #define VMSTATE_BUFFER_MULTIPLY(_field, _state, _version, _test, _start, _field_size, _multiply) { \
588 .name = (stringify(_field)), \
589 .version_id = (_version), \
590 .field_exists = (_test), \
591 .size_offset = vmstate_offset_value(_state, _field_size, uint32_t),\
592 .size = (_multiply), \
593 .info = &vmstate_info_buffer, \
594 .flags = VMS_VBUFFER|VMS_MULTIPLY, \
595 .offset = offsetof(_state, _field), \
596 .start = (_start), \
597 }
598
599 #define VMSTATE_VBUFFER(_field, _state, _version, _test, _start, _field_size) { \
600 .name = (stringify(_field)), \
601 .version_id = (_version), \
602 .field_exists = (_test), \
603 .size_offset = vmstate_offset_value(_state, _field_size, int32_t),\
604 .info = &vmstate_info_buffer, \
605 .flags = VMS_VBUFFER|VMS_POINTER, \
606 .offset = offsetof(_state, _field), \
607 .start = (_start), \
608 }
609
610 #define VMSTATE_VBUFFER_UINT32(_field, _state, _version, _test, _start, _field_size) { \
611 .name = (stringify(_field)), \
612 .version_id = (_version), \
613 .field_exists = (_test), \
614 .size_offset = vmstate_offset_value(_state, _field_size, uint32_t),\
615 .info = &vmstate_info_buffer, \
616 .flags = VMS_VBUFFER|VMS_POINTER, \
617 .offset = offsetof(_state, _field), \
618 .start = (_start), \
619 }
620
621 #define VMSTATE_BUFFER_UNSAFE_INFO(_field, _state, _version, _info, _size) { \
622 .name = (stringify(_field)), \
623 .version_id = (_version), \
624 .size = (_size), \
625 .info = &(_info), \
626 .flags = VMS_BUFFER, \
627 .offset = offsetof(_state, _field), \
628 }
629
630 #define VMSTATE_UNUSED_BUFFER(_test, _version, _size) { \
631 .name = "unused", \
632 .field_exists = (_test), \
633 .version_id = (_version), \
634 .size = (_size), \
635 .info = &vmstate_info_unused_buffer, \
636 .flags = VMS_BUFFER, \
637 }
638 extern const VMStateDescription vmstate_pci_device;
639
640 #define VMSTATE_PCI_DEVICE(_field, _state) { \
641 .name = (stringify(_field)), \
642 .size = sizeof(PCIDevice), \
643 .vmsd = &vmstate_pci_device, \
644 .flags = VMS_STRUCT, \
645 .offset = vmstate_offset_value(_state, _field, PCIDevice), \
646 }
647
648 #define VMSTATE_PCI_DEVICE_POINTER(_field, _state) { \
649 .name = (stringify(_field)), \
650 .size = sizeof(PCIDevice), \
651 .vmsd = &vmstate_pci_device, \
652 .flags = VMS_STRUCT|VMS_POINTER, \
653 .offset = vmstate_offset_pointer(_state, _field, PCIDevice), \
654 }
655
656 extern const VMStateDescription vmstate_pcie_device;
657
658 #define VMSTATE_PCIE_DEVICE(_field, _state) { \
659 .name = (stringify(_field)), \
660 .version_id = 2, \
661 .size = sizeof(PCIDevice), \
662 .vmsd = &vmstate_pcie_device, \
663 .flags = VMS_STRUCT, \
664 .offset = vmstate_offset_value(_state, _field, PCIDevice), \
665 }
666
667 extern const VMStateDescription vmstate_i2c_slave;
668
669 #define VMSTATE_I2C_SLAVE(_field, _state) { \
670 .name = (stringify(_field)), \
671 .size = sizeof(i2c_slave), \
672 .vmsd = &vmstate_i2c_slave, \
673 .flags = VMS_STRUCT, \
674 .offset = vmstate_offset_value(_state, _field, i2c_slave), \
675 }
676
677 extern const VMStateDescription vmstate_usb_device;
678
679 #define VMSTATE_USB_DEVICE(_field, _state) { \
680 .name = (stringify(_field)), \
681 .size = sizeof(USBDevice), \
682 .vmsd = &vmstate_usb_device, \
683 .flags = VMS_STRUCT, \
684 .offset = vmstate_offset_value(_state, _field, USBDevice), \
685 }
686
687 #define vmstate_offset_macaddr(_state, _field) \
688 vmstate_offset_array(_state, _field.a, uint8_t, \
689 sizeof(typeof_field(_state, _field)))
690
691 #define VMSTATE_MACADDR(_field, _state) { \
692 .name = (stringify(_field)), \
693 .size = sizeof(MACAddr), \
694 .info = &vmstate_info_buffer, \
695 .flags = VMS_BUFFER, \
696 .offset = vmstate_offset_macaddr(_state, _field), \
697 }
698
699 extern const VMStateDescription vmstate_ptimer;
700
701 #define VMSTATE_PTIMER(_field, _state) { \
702 .name = (stringify(_field)), \
703 .version_id = (1), \
704 .vmsd = &vmstate_ptimer, \
705 .size = sizeof(ptimer_state *), \
706 .flags = VMS_STRUCT|VMS_POINTER, \
707 .offset = vmstate_offset_pointer(_state, _field, ptimer_state), \
708 }
709
710 extern const VMStateDescription vmstate_hid_keyboard_device;
711
712 #define VMSTATE_HID_KEYBOARD_DEVICE(_field, _state) { \
713 .name = (stringify(_field)), \
714 .size = sizeof(HIDState), \
715 .vmsd = &vmstate_hid_keyboard_device, \
716 .flags = VMS_STRUCT, \
717 .offset = vmstate_offset_value(_state, _field, HIDState), \
718 }
719
720 extern const VMStateDescription vmstate_hid_ptr_device;
721
722 #define VMSTATE_HID_POINTER_DEVICE(_field, _state) { \
723 .name = (stringify(_field)), \
724 .size = sizeof(HIDState), \
725 .vmsd = &vmstate_hid_ptr_device, \
726 .flags = VMS_STRUCT, \
727 .offset = vmstate_offset_value(_state, _field, HIDState), \
728 }
729
730 /* _f : field name
731 _f_n : num of elements field_name
732 _n : num of elements
733 _s : struct state name
734 _v : version
735 */
736
737 #define VMSTATE_SINGLE(_field, _state, _version, _info, _type) \
738 VMSTATE_SINGLE_TEST(_field, _state, NULL, _version, _info, _type)
739
740 #define VMSTATE_STRUCT(_field, _state, _version, _vmsd, _type) \
741 VMSTATE_STRUCT_TEST(_field, _state, NULL, _version, _vmsd, _type)
742
743 #define VMSTATE_STRUCT_POINTER(_field, _state, _vmsd, _type) \
744 VMSTATE_STRUCT_POINTER_TEST(_field, _state, NULL, _vmsd, _type)
745
746 #define VMSTATE_STRUCT_ARRAY(_field, _state, _num, _version, _vmsd, _type) \
747 VMSTATE_STRUCT_ARRAY_TEST(_field, _state, _num, NULL, _version, \
748 _vmsd, _type)
749
750 #define VMSTATE_BOOL_V(_f, _s, _v) \
751 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_bool, bool)
752
753 #define VMSTATE_INT8_V(_f, _s, _v) \
754 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int8, int8_t)
755 #define VMSTATE_INT16_V(_f, _s, _v) \
756 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int16, int16_t)
757 #define VMSTATE_INT32_V(_f, _s, _v) \
758 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int32, int32_t)
759 #define VMSTATE_INT64_V(_f, _s, _v) \
760 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int64, int64_t)
761
762 #define VMSTATE_UINT8_V(_f, _s, _v) \
763 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint8, uint8_t)
764 #define VMSTATE_UINT16_V(_f, _s, _v) \
765 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint16, uint16_t)
766 #define VMSTATE_UINT32_V(_f, _s, _v) \
767 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint32, uint32_t)
768 #define VMSTATE_UINT64_V(_f, _s, _v) \
769 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint64, uint64_t)
770
771 #define VMSTATE_BOOL(_f, _s) \
772 VMSTATE_BOOL_V(_f, _s, 0)
773
774 #define VMSTATE_INT8(_f, _s) \
775 VMSTATE_INT8_V(_f, _s, 0)
776 #define VMSTATE_INT16(_f, _s) \
777 VMSTATE_INT16_V(_f, _s, 0)
778 #define VMSTATE_INT32(_f, _s) \
779 VMSTATE_INT32_V(_f, _s, 0)
780 #define VMSTATE_INT64(_f, _s) \
781 VMSTATE_INT64_V(_f, _s, 0)
782
783 #define VMSTATE_UINT8(_f, _s) \
784 VMSTATE_UINT8_V(_f, _s, 0)
785 #define VMSTATE_UINT16(_f, _s) \
786 VMSTATE_UINT16_V(_f, _s, 0)
787 #define VMSTATE_UINT32(_f, _s) \
788 VMSTATE_UINT32_V(_f, _s, 0)
789 #define VMSTATE_UINT64(_f, _s) \
790 VMSTATE_UINT64_V(_f, _s, 0)
791
792 #define VMSTATE_UINT8_EQUAL(_f, _s) \
793 VMSTATE_SINGLE(_f, _s, 0, vmstate_info_uint8_equal, uint8_t)
794
795 #define VMSTATE_UINT16_EQUAL(_f, _s) \
796 VMSTATE_SINGLE(_f, _s, 0, vmstate_info_uint16_equal, uint16_t)
797
798 #define VMSTATE_UINT16_EQUAL_V(_f, _s, _v) \
799 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint16_equal, uint16_t)
800
801 #define VMSTATE_INT32_EQUAL(_f, _s) \
802 VMSTATE_SINGLE(_f, _s, 0, vmstate_info_int32_equal, int32_t)
803
804 #define VMSTATE_UINT32_EQUAL(_f, _s) \
805 VMSTATE_SINGLE(_f, _s, 0, vmstate_info_uint32_equal, uint32_t)
806
807 #define VMSTATE_INT32_LE(_f, _s) \
808 VMSTATE_SINGLE(_f, _s, 0, vmstate_info_int32_le, int32_t)
809
810 #define VMSTATE_UINT8_TEST(_f, _s, _t) \
811 VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint8, uint8_t)
812
813 #define VMSTATE_UINT16_TEST(_f, _s, _t) \
814 VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint16, uint16_t)
815
816 #define VMSTATE_UINT32_TEST(_f, _s, _t) \
817 VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint32, uint32_t)
818
819 #define VMSTATE_TIMER_TEST(_f, _s, _test) \
820 VMSTATE_POINTER_TEST(_f, _s, _test, vmstate_info_timer, QEMUTimer *)
821
822 #define VMSTATE_TIMER(_f, _s) \
823 VMSTATE_TIMER_TEST(_f, _s, NULL)
824
825 #define VMSTATE_TIMER_ARRAY(_f, _s, _n) \
826 VMSTATE_ARRAY_OF_POINTER(_f, _s, _n, 0, vmstate_info_timer, QEMUTimer *)
827
828 #define VMSTATE_BOOL_ARRAY_V(_f, _s, _n, _v) \
829 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_bool, bool)
830
831 #define VMSTATE_BOOL_ARRAY(_f, _s, _n) \
832 VMSTATE_BOOL_ARRAY_V(_f, _s, _n, 0)
833
834 #define VMSTATE_UINT16_ARRAY_V(_f, _s, _n, _v) \
835 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint16, uint16_t)
836
837 #define VMSTATE_UINT16_ARRAY(_f, _s, _n) \
838 VMSTATE_UINT16_ARRAY_V(_f, _s, _n, 0)
839
840 #define VMSTATE_UINT8_ARRAY_V(_f, _s, _n, _v) \
841 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint8, uint8_t)
842
843 #define VMSTATE_UINT8_ARRAY(_f, _s, _n) \
844 VMSTATE_UINT8_ARRAY_V(_f, _s, _n, 0)
845
846 #define VMSTATE_UINT32_ARRAY_V(_f, _s, _n, _v) \
847 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint32, uint32_t)
848
849 #define VMSTATE_UINT32_ARRAY(_f, _s, _n) \
850 VMSTATE_UINT32_ARRAY_V(_f, _s, _n, 0)
851
852 #define VMSTATE_UINT64_ARRAY_V(_f, _s, _n, _v) \
853 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint64, uint64_t)
854
855 #define VMSTATE_UINT64_ARRAY(_f, _s, _n) \
856 VMSTATE_UINT64_ARRAY_V(_f, _s, _n, 0)
857
858 #define VMSTATE_INT16_ARRAY_V(_f, _s, _n, _v) \
859 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int16, int16_t)
860
861 #define VMSTATE_INT16_ARRAY(_f, _s, _n) \
862 VMSTATE_INT16_ARRAY_V(_f, _s, _n, 0)
863
864 #define VMSTATE_INT32_ARRAY_V(_f, _s, _n, _v) \
865 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int32, int32_t)
866
867 #define VMSTATE_INT32_ARRAY(_f, _s, _n) \
868 VMSTATE_INT32_ARRAY_V(_f, _s, _n, 0)
869
870 #define VMSTATE_UINT32_SUB_ARRAY(_f, _s, _start, _num) \
871 VMSTATE_SUB_ARRAY(_f, _s, _start, _num, 0, vmstate_info_uint32, uint32_t)
872
873 #define VMSTATE_UINT32_ARRAY(_f, _s, _n) \
874 VMSTATE_UINT32_ARRAY_V(_f, _s, _n, 0)
875
876 #define VMSTATE_INT64_ARRAY_V(_f, _s, _n, _v) \
877 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int64, int64_t)
878
879 #define VMSTATE_INT64_ARRAY(_f, _s, _n) \
880 VMSTATE_INT64_ARRAY_V(_f, _s, _n, 0)
881
882 #define VMSTATE_BUFFER_V(_f, _s, _v) \
883 VMSTATE_STATIC_BUFFER(_f, _s, _v, NULL, 0, sizeof(typeof_field(_s, _f)))
884
885 #define VMSTATE_BUFFER(_f, _s) \
886 VMSTATE_BUFFER_V(_f, _s, 0)
887
888 #define VMSTATE_PARTIAL_BUFFER(_f, _s, _size) \
889 VMSTATE_STATIC_BUFFER(_f, _s, 0, NULL, 0, _size)
890
891 #define VMSTATE_BUFFER_START_MIDDLE(_f, _s, _start) \
892 VMSTATE_STATIC_BUFFER(_f, _s, 0, NULL, _start, sizeof(typeof_field(_s, _f)))
893
894 #define VMSTATE_PARTIAL_VBUFFER(_f, _s, _size) \
895 VMSTATE_VBUFFER(_f, _s, 0, NULL, 0, _size)
896
897 #define VMSTATE_PARTIAL_VBUFFER_UINT32(_f, _s, _size) \
898 VMSTATE_VBUFFER_UINT32(_f, _s, 0, NULL, 0, _size)
899
900 #define VMSTATE_SUB_VBUFFER(_f, _s, _start, _size) \
901 VMSTATE_VBUFFER(_f, _s, 0, NULL, _start, _size)
902
903 #define VMSTATE_BUFFER_TEST(_f, _s, _test) \
904 VMSTATE_STATIC_BUFFER(_f, _s, 0, _test, 0, sizeof(typeof_field(_s, _f)))
905
906 #define VMSTATE_BUFFER_UNSAFE(_field, _state, _version, _size) \
907 VMSTATE_BUFFER_UNSAFE_INFO(_field, _state, _version, vmstate_info_buffer, _size)
908
909 #define VMSTATE_UNUSED_V(_v, _size) \
910 VMSTATE_UNUSED_BUFFER(NULL, _v, _size)
911
912 #define VMSTATE_UNUSED(_size) \
913 VMSTATE_UNUSED_V(0, _size)
914
915 #define VMSTATE_UNUSED_TEST(_test, _size) \
916 VMSTATE_UNUSED_BUFFER(_test, 0, _size)
917
918 #ifdef NEED_CPU_H
919 #if TARGET_LONG_BITS == 64
920 #define VMSTATE_UINTTL_V(_f, _s, _v) \
921 VMSTATE_UINT64_V(_f, _s, _v)
922 #define VMSTATE_UINTTL_ARRAY_V(_f, _s, _n, _v) \
923 VMSTATE_UINT64_ARRAY_V(_f, _s, _n, _v)
924 #else
925 #define VMSTATE_UINTTL_V(_f, _s, _v) \
926 VMSTATE_UINT32_V(_f, _s, _v)
927 #define VMSTATE_UINTTL_ARRAY_V(_f, _s, _n, _v) \
928 VMSTATE_UINT32_ARRAY_V(_f, _s, _n, _v)
929 #endif
930 #define VMSTATE_UINTTL(_f, _s) \
931 VMSTATE_UINTTL_V(_f, _s, 0)
932 #define VMSTATE_UINTTL_ARRAY(_f, _s, _n) \
933 VMSTATE_UINTTL_ARRAY_V(_f, _s, _n, 0)
934
935 #endif
936
937 #define VMSTATE_END_OF_LIST() \
938 {}
939
940 int vmstate_load_state(QEMUFile *f, const VMStateDescription *vmsd,
941 void *opaque, int version_id);
942 void vmstate_save_state(QEMUFile *f, const VMStateDescription *vmsd,
943 void *opaque);
944 int vmstate_register(DeviceState *dev, int instance_id,
945 const VMStateDescription *vmsd, void *base);
946 int vmstate_register_with_alias_id(DeviceState *dev, int instance_id,
947 const VMStateDescription *vmsd,
948 void *base, int alias_id,
949 int required_for_version);
950 void vmstate_unregister(DeviceState *dev, const VMStateDescription *vmsd,
951 void *opaque);
952 #endif
QEMU mirror