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