?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
MAINTAINERS: Make section QOM cover hw/core/*bus.c as well
[qemu/armbru.git] / include / migration / vmstate.h
blobeafa39f5603f094f564e3974c5688608b9263c4c
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
27 #ifndef QEMU_VMSTATE_H
28 #define QEMU_VMSTATE_H
29
30 #include "hw/vmstate-if.h"
31
32 typedef struct VMStateInfo VMStateInfo;
33 typedef struct VMStateField VMStateField;
34
35 /* VMStateInfo allows customized migration of objects that don't fit in
36 * any category in VMStateFlags. Additional information is always passed
37 * into get and put in terms of field and vmdesc parameters. However
38 * these two parameters should only be used in cases when customized
39 * handling is needed, such as QTAILQ. For primitive data types such as
40 * integer, field and vmdesc parameters should be ignored inside get/put.
41 */
42 struct VMStateInfo {
43 const char *name;
44 int (*get)(QEMUFile *f, void *pv, size_t size, const VMStateField *field);
45 int (*put)(QEMUFile *f, void *pv, size_t size, const VMStateField *field,
46 QJSON *vmdesc);
47 };
48
49 enum VMStateFlags {
50 /* Ignored */
51 VMS_SINGLE = 0x001,
52
53 /* The struct member at opaque + VMStateField.offset is a pointer
54 * to the actual field (e.g. struct a { uint8_t *b;
55 * }). Dereference the pointer before using it as basis for
56 * further pointer arithmetic (see e.g. VMS_ARRAY). Does not
57 * affect the meaning of VMStateField.num_offset or
58 * VMStateField.size_offset; see VMS_VARRAY* and VMS_VBUFFER for
59 * those. */
60 VMS_POINTER = 0x002,
61
62 /* The field is an array of fixed size. VMStateField.num contains
63 * the number of entries in the array. The size of each entry is
64 * given by VMStateField.size and / or opaque +
65 * VMStateField.size_offset; see VMS_VBUFFER and
66 * VMS_MULTIPLY. Each array entry will be processed individually
67 * (VMStateField.info.get()/put() if VMS_STRUCT is not set,
68 * recursion into VMStateField.vmsd if VMS_STRUCT is set). May not
69 * be combined with VMS_VARRAY*. */
70 VMS_ARRAY = 0x004,
71
72 /* The field is itself a struct, containing one or more
73 * fields. Recurse into VMStateField.vmsd. Most useful in
74 * combination with VMS_ARRAY / VMS_VARRAY*, recursing into each
75 * array entry. */
76 VMS_STRUCT = 0x008,
77
78 /* The field is an array of variable size. The int32_t at opaque +
79 * VMStateField.num_offset contains the number of entries in the
80 * array. See the VMS_ARRAY description regarding array handling
81 * in general. May not be combined with VMS_ARRAY or any other
82 * VMS_VARRAY*. */
83 VMS_VARRAY_INT32 = 0x010,
84
85 /* Ignored */
86 VMS_BUFFER = 0x020,
87
88 /* The field is a (fixed-size or variable-size) array of pointers
89 * (e.g. struct a { uint8_t *b[]; }). Dereference each array entry
90 * before using it. Note: Does not imply any one of VMS_ARRAY /
91 * VMS_VARRAY*; these need to be set explicitly. */
92 VMS_ARRAY_OF_POINTER = 0x040,
93
94 /* The field is an array of variable size. The uint16_t at opaque
95 * + VMStateField.num_offset (subject to VMS_MULTIPLY_ELEMENTS)
96 * contains the number of entries in the array. See the VMS_ARRAY
97 * description regarding array handling in general. May not be
98 * combined with VMS_ARRAY or any other VMS_VARRAY*. */
99 VMS_VARRAY_UINT16 = 0x080,
100
101 /* The size of the individual entries (a single array entry if
102 * VMS_ARRAY or any of VMS_VARRAY* are set, or the field itself if
103 * neither is set) is variable (i.e. not known at compile-time),
104 * but the same for all entries. Use the int32_t at opaque +
105 * VMStateField.size_offset (subject to VMS_MULTIPLY) to determine
106 * the size of each (and every) entry. */
107 VMS_VBUFFER = 0x100,
108
109 /* Multiply the entry size given by the int32_t at opaque +
110 * VMStateField.size_offset (see VMS_VBUFFER description) with
111 * VMStateField.size to determine the number of bytes to be
112 * allocated. Only valid in combination with VMS_VBUFFER. */
113 VMS_MULTIPLY = 0x200,
114
115 /* The field is an array of variable size. The uint8_t at opaque +
116 * VMStateField.num_offset (subject to VMS_MULTIPLY_ELEMENTS)
117 * contains the number of entries in the array. See the VMS_ARRAY
118 * description regarding array handling in general. May not be
119 * combined with VMS_ARRAY or any other VMS_VARRAY*. */
120 VMS_VARRAY_UINT8 = 0x400,
121
122 /* The field is an array of variable size. The uint32_t at opaque
123 * + VMStateField.num_offset (subject to VMS_MULTIPLY_ELEMENTS)
124 * contains the number of entries in the array. See the VMS_ARRAY
125 * description regarding array handling in general. May not be
126 * combined with VMS_ARRAY or any other VMS_VARRAY*. */
127 VMS_VARRAY_UINT32 = 0x800,
128
129 /* Fail loading the serialised VM state if this field is missing
130 * from the input. */
131 VMS_MUST_EXIST = 0x1000,
132
133 /* When loading serialised VM state, allocate memory for the
134 * (entire) field. Only valid in combination with
135 * VMS_POINTER. Note: Not all combinations with other flags are
136 * currently supported, e.g. VMS_ALLOC|VMS_ARRAY_OF_POINTER won't
137 * cause the individual entries to be allocated. */
138 VMS_ALLOC = 0x2000,
139
140 /* Multiply the number of entries given by the integer at opaque +
141 * VMStateField.num_offset (see VMS_VARRAY*) with VMStateField.num
142 * to determine the number of entries in the array. Only valid in
143 * combination with one of VMS_VARRAY*. */
144 VMS_MULTIPLY_ELEMENTS = 0x4000,
145
146 /* A structure field that is like VMS_STRUCT, but uses
147 * VMStateField.struct_version_id to tell which version of the
148 * structure we are referencing to use. */
149 VMS_VSTRUCT = 0x8000,
150 };
151
152 typedef enum {
153 MIG_PRI_DEFAULT = 0,
154 MIG_PRI_IOMMU, /* Must happen before PCI devices */
155 MIG_PRI_PCI_BUS, /* Must happen before IOMMU */
156 MIG_PRI_GICV3_ITS, /* Must happen before PCI devices */
157 MIG_PRI_GICV3, /* Must happen before the ITS */
158 MIG_PRI_MAX,
159 } MigrationPriority;
160
161 struct VMStateField {
162 const char *name;
163 const char *err_hint;
164 size_t offset;
165 size_t size;
166 size_t start;
167 int num;
168 size_t num_offset;
169 size_t size_offset;
170 const VMStateInfo *info;
171 enum VMStateFlags flags;
172 const VMStateDescription *vmsd;
173 int version_id;
174 int struct_version_id;
175 bool (*field_exists)(void *opaque, int version_id);
176 };
177
178 struct VMStateDescription {
179 const char *name;
180 int unmigratable;
181 int version_id;
182 int minimum_version_id;
183 int minimum_version_id_old;
184 MigrationPriority priority;
185 LoadStateHandler *load_state_old;
186 int (*pre_load)(void *opaque);
187 int (*post_load)(void *opaque, int version_id);
188 int (*pre_save)(void *opaque);
189 int (*post_save)(void *opaque);
190 bool (*needed)(void *opaque);
191 bool (*dev_unplug_pending)(void *opaque);
192
193 const VMStateField *fields;
194 const VMStateDescription **subsections;
195 };
196
197 extern const VMStateDescription vmstate_dummy;
198
199 extern const VMStateInfo vmstate_info_bool;
200
201 extern const VMStateInfo vmstate_info_int8;
202 extern const VMStateInfo vmstate_info_int16;
203 extern const VMStateInfo vmstate_info_int32;
204 extern const VMStateInfo vmstate_info_int64;
205
206 extern const VMStateInfo vmstate_info_uint8_equal;
207 extern const VMStateInfo vmstate_info_uint16_equal;
208 extern const VMStateInfo vmstate_info_int32_equal;
209 extern const VMStateInfo vmstate_info_uint32_equal;
210 extern const VMStateInfo vmstate_info_uint64_equal;
211 extern const VMStateInfo vmstate_info_int32_le;
212
213 extern const VMStateInfo vmstate_info_uint8;
214 extern const VMStateInfo vmstate_info_uint16;
215 extern const VMStateInfo vmstate_info_uint32;
216 extern const VMStateInfo vmstate_info_uint64;
217
218 /** Put this in the stream when migrating a null pointer.*/
219 #define VMS_NULLPTR_MARKER (0x30U) /* '0' */
220 extern const VMStateInfo vmstate_info_nullptr;
221
222 extern const VMStateInfo vmstate_info_float64;
223 extern const VMStateInfo vmstate_info_cpudouble;
224
225 extern const VMStateInfo vmstate_info_timer;
226 extern const VMStateInfo vmstate_info_buffer;
227 extern const VMStateInfo vmstate_info_unused_buffer;
228 extern const VMStateInfo vmstate_info_tmp;
229 extern const VMStateInfo vmstate_info_bitmap;
230 extern const VMStateInfo vmstate_info_qtailq;
231 extern const VMStateInfo vmstate_info_gtree;
232 extern const VMStateInfo vmstate_info_qlist;
233
234 #define type_check_2darray(t1,t2,n,m) ((t1(*)[n][m])0 - (t2*)0)
235 /*
236 * Check that type t2 is an array of type t1 of size n,
237 * e.g. if t1 is 'foo' and n is 32 then t2 must be 'foo[32]'
238 */
239 #define type_check_array(t1,t2,n) ((t1(*)[n])0 - (t2*)0)
240 #define type_check_pointer(t1,t2) ((t1**)0 - (t2*)0)
241 /*
242 * type of element 0 of the specified (array) field of the type.
243 * Note that if the field is a pointer then this will return the
244 * pointed-to type rather than complaining.
245 */
246 #define typeof_elt_of_field(type, field) typeof(((type *)0)->field[0])
247 /* Check that field f in struct type t2 is an array of t1, of any size */
248 #define type_check_varray(t1, t2, f) \
249 (type_check(t1, typeof_elt_of_field(t2, f)) \
250 + QEMU_BUILD_BUG_ON_ZERO(!QEMU_IS_ARRAY(((t2 *)0)->f)))
251
252 #define vmstate_offset_value(_state, _field, _type) \
253 (offsetof(_state, _field) + \
254 type_check(_type, typeof_field(_state, _field)))
255
256 #define vmstate_offset_pointer(_state, _field, _type) \
257 (offsetof(_state, _field) + \
258 type_check_pointer(_type, typeof_field(_state, _field)))
259
260 #define vmstate_offset_array(_state, _field, _type, _num) \
261 (offsetof(_state, _field) + \
262 type_check_array(_type, typeof_field(_state, _field), _num))
263
264 #define vmstate_offset_2darray(_state, _field, _type, _n1, _n2) \
265 (offsetof(_state, _field) + \
266 type_check_2darray(_type, typeof_field(_state, _field), _n1, _n2))
267
268 #define vmstate_offset_sub_array(_state, _field, _type, _start) \
269 vmstate_offset_value(_state, _field[_start], _type)
270
271 #define vmstate_offset_buffer(_state, _field) \
272 vmstate_offset_array(_state, _field, uint8_t, \
273 sizeof(typeof_field(_state, _field)))
274
275 #define vmstate_offset_varray(_state, _field, _type) \
276 (offsetof(_state, _field) + \
277 type_check_varray(_type, _state, _field))
278
279 /* In the macros below, if there is a _version, that means the macro's
280 * field will be processed only if the version being received is >=
281 * the _version specified. In general, if you add a new field, you
282 * would increment the structure's version and put that version
283 * number into the new field so it would only be processed with the
284 * new version.
285 *
286 * In particular, for VMSTATE_STRUCT() and friends the _version does
287 * *NOT* pick the version of the sub-structure. It works just as
288 * specified above. The version of the top-level structure received
289 * is passed down to all sub-structures. This means that the
290 * sub-structures must have version that are compatible with all the
291 * structures that use them.
292 *
293 * If you want to specify the version of the sub-structure, use
294 * VMSTATE_VSTRUCT(), which allows the specific sub-structure version
295 * to be directly specified.
296 */
297
298 #define VMSTATE_SINGLE_TEST(_field, _state, _test, _version, _info, _type) { \
299 .name = (stringify(_field)), \
300 .version_id = (_version), \
301 .field_exists = (_test), \
302 .size = sizeof(_type), \
303 .info = &(_info), \
304 .flags = VMS_SINGLE, \
305 .offset = vmstate_offset_value(_state, _field, _type), \
306 }
307
308 #define VMSTATE_SINGLE_FULL(_field, _state, _test, _version, _info, \
309 _type, _err_hint) { \
310 .name = (stringify(_field)), \
311 .err_hint = (_err_hint), \
312 .version_id = (_version), \
313 .field_exists = (_test), \
314 .size = sizeof(_type), \
315 .info = &(_info), \
316 .flags = VMS_SINGLE, \
317 .offset = vmstate_offset_value(_state, _field, _type), \
318 }
319
320 /* Validate state using a boolean predicate. */
321 #define VMSTATE_VALIDATE(_name, _test) { \
322 .name = (_name), \
323 .field_exists = (_test), \
324 .flags = VMS_ARRAY | VMS_MUST_EXIST, \
325 .num = 0, /* 0 elements: no data, only run _test */ \
326 }
327
328 #define VMSTATE_POINTER(_field, _state, _version, _info, _type) { \
329 .name = (stringify(_field)), \
330 .version_id = (_version), \
331 .info = &(_info), \
332 .size = sizeof(_type), \
333 .flags = VMS_SINGLE|VMS_POINTER, \
334 .offset = vmstate_offset_value(_state, _field, _type), \
335 }
336
337 #define VMSTATE_POINTER_TEST(_field, _state, _test, _info, _type) { \
338 .name = (stringify(_field)), \
339 .info = &(_info), \
340 .field_exists = (_test), \
341 .size = sizeof(_type), \
342 .flags = VMS_SINGLE|VMS_POINTER, \
343 .offset = vmstate_offset_value(_state, _field, _type), \
344 }
345
346 #define VMSTATE_ARRAY(_field, _state, _num, _version, _info, _type) {\
347 .name = (stringify(_field)), \
348 .version_id = (_version), \
349 .num = (_num), \
350 .info = &(_info), \
351 .size = sizeof(_type), \
352 .flags = VMS_ARRAY, \
353 .offset = vmstate_offset_array(_state, _field, _type, _num), \
354 }
355
356 #define VMSTATE_2DARRAY(_field, _state, _n1, _n2, _version, _info, _type) { \
357 .name = (stringify(_field)), \
358 .version_id = (_version), \
359 .num = (_n1) * (_n2), \
360 .info = &(_info), \
361 .size = sizeof(_type), \
362 .flags = VMS_ARRAY, \
363 .offset = vmstate_offset_2darray(_state, _field, _type, _n1, _n2), \
364 }
365
366 #define VMSTATE_VARRAY_MULTIPLY(_field, _state, _field_num, _multiply, _info, _type) { \
367 .name = (stringify(_field)), \
368 .num_offset = vmstate_offset_value(_state, _field_num, uint32_t),\
369 .num = (_multiply), \
370 .info = &(_info), \
371 .size = sizeof(_type), \
372 .flags = VMS_VARRAY_UINT32|VMS_MULTIPLY_ELEMENTS, \
373 .offset = vmstate_offset_varray(_state, _field, _type), \
374 }
375
376 #define VMSTATE_ARRAY_TEST(_field, _state, _num, _test, _info, _type) {\
377 .name = (stringify(_field)), \
378 .field_exists = (_test), \
379 .num = (_num), \
380 .info = &(_info), \
381 .size = sizeof(_type), \
382 .flags = VMS_ARRAY, \
383 .offset = vmstate_offset_array(_state, _field, _type, _num),\
384 }
385
386 #define VMSTATE_SUB_ARRAY(_field, _state, _start, _num, _version, _info, _type) { \
387 .name = (stringify(_field)), \
388 .version_id = (_version), \
389 .num = (_num), \
390 .info = &(_info), \
391 .size = sizeof(_type), \
392 .flags = VMS_ARRAY, \
393 .offset = vmstate_offset_sub_array(_state, _field, _type, _start), \
394 }
395
396 #define VMSTATE_ARRAY_INT32_UNSAFE(_field, _state, _field_num, _info, _type) {\
397 .name = (stringify(_field)), \
398 .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
399 .info = &(_info), \
400 .size = sizeof(_type), \
401 .flags = VMS_VARRAY_INT32, \
402 .offset = vmstate_offset_varray(_state, _field, _type), \
403 }
404
405 #define VMSTATE_VARRAY_INT32(_field, _state, _field_num, _version, _info, _type) {\
406 .name = (stringify(_field)), \
407 .version_id = (_version), \
408 .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
409 .info = &(_info), \
410 .size = sizeof(_type), \
411 .flags = VMS_VARRAY_INT32|VMS_POINTER, \
412 .offset = vmstate_offset_pointer(_state, _field, _type), \
413 }
414
415 #define VMSTATE_VARRAY_UINT32(_field, _state, _field_num, _version, _info, _type) {\
416 .name = (stringify(_field)), \
417 .version_id = (_version), \
418 .num_offset = vmstate_offset_value(_state, _field_num, uint32_t),\
419 .info = &(_info), \
420 .size = sizeof(_type), \
421 .flags = VMS_VARRAY_UINT32|VMS_POINTER, \
422 .offset = vmstate_offset_pointer(_state, _field, _type), \
423 }
424
425 #define VMSTATE_VARRAY_UINT32_ALLOC(_field, _state, _field_num, _version, _info, _type) {\
426 .name = (stringify(_field)), \
427 .version_id = (_version), \
428 .num_offset = vmstate_offset_value(_state, _field_num, uint32_t),\
429 .info = &(_info), \
430 .size = sizeof(_type), \
431 .flags = VMS_VARRAY_UINT32|VMS_POINTER|VMS_ALLOC, \
432 .offset = vmstate_offset_pointer(_state, _field, _type), \
433 }
434
435 #define VMSTATE_VARRAY_UINT16_UNSAFE(_field, _state, _field_num, _version, _info, _type) {\
436 .name = (stringify(_field)), \
437 .version_id = (_version), \
438 .num_offset = vmstate_offset_value(_state, _field_num, uint16_t),\
439 .info = &(_info), \
440 .size = sizeof(_type), \
441 .flags = VMS_VARRAY_UINT16, \
442 .offset = vmstate_offset_varray(_state, _field, _type), \
443 }
444
445 #define VMSTATE_VSTRUCT_TEST(_field, _state, _test, _version, _vmsd, _type, _struct_version) { \
446 .name = (stringify(_field)), \
447 .version_id = (_version), \
448 .struct_version_id = (_struct_version), \
449 .field_exists = (_test), \
450 .vmsd = &(_vmsd), \
451 .size = sizeof(_type), \
452 .flags = VMS_VSTRUCT, \
453 .offset = vmstate_offset_value(_state, _field, _type), \
454 }
455
456 #define VMSTATE_STRUCT_TEST(_field, _state, _test, _version, _vmsd, _type) { \
457 .name = (stringify(_field)), \
458 .version_id = (_version), \
459 .field_exists = (_test), \
460 .vmsd = &(_vmsd), \
461 .size = sizeof(_type), \
462 .flags = VMS_STRUCT, \
463 .offset = vmstate_offset_value(_state, _field, _type), \
464 }
465
466 #define VMSTATE_STRUCT_POINTER_V(_field, _state, _version, _vmsd, _type) { \
467 .name = (stringify(_field)), \
468 .version_id = (_version), \
469 .vmsd = &(_vmsd), \
470 .size = sizeof(_type *), \
471 .flags = VMS_STRUCT|VMS_POINTER, \
472 .offset = vmstate_offset_pointer(_state, _field, _type), \
473 }
474
475 #define VMSTATE_STRUCT_POINTER_TEST_V(_field, _state, _test, _version, _vmsd, _type) { \
476 .name = (stringify(_field)), \
477 .version_id = (_version), \
478 .field_exists = (_test), \
479 .vmsd = &(_vmsd), \
480 .size = sizeof(_type *), \
481 .flags = VMS_STRUCT|VMS_POINTER, \
482 .offset = vmstate_offset_pointer(_state, _field, _type), \
483 }
484
485 #define VMSTATE_ARRAY_OF_POINTER(_field, _state, _num, _version, _info, _type) {\
486 .name = (stringify(_field)), \
487 .version_id = (_version), \
488 .num = (_num), \
489 .info = &(_info), \
490 .size = sizeof(_type), \
491 .flags = VMS_ARRAY|VMS_ARRAY_OF_POINTER, \
492 .offset = vmstate_offset_array(_state, _field, _type, _num), \
493 }
494
495 #define VMSTATE_ARRAY_OF_POINTER_TO_STRUCT(_f, _s, _n, _v, _vmsd, _type) { \
496 .name = (stringify(_f)), \
497 .version_id = (_v), \
498 .num = (_n), \
499 .vmsd = &(_vmsd), \
500 .size = sizeof(_type *), \
501 .flags = VMS_ARRAY|VMS_STRUCT|VMS_ARRAY_OF_POINTER, \
502 .offset = vmstate_offset_array(_s, _f, _type*, _n), \
503 }
504
505 #define VMSTATE_STRUCT_SUB_ARRAY(_field, _state, _start, _num, _version, _vmsd, _type) { \
506 .name = (stringify(_field)), \
507 .version_id = (_version), \
508 .num = (_num), \
509 .vmsd = &(_vmsd), \
510 .size = sizeof(_type), \
511 .flags = VMS_STRUCT|VMS_ARRAY, \
512 .offset = vmstate_offset_sub_array(_state, _field, _type, _start), \
513 }
514
515 #define VMSTATE_STRUCT_ARRAY_TEST(_field, _state, _num, _test, _version, _vmsd, _type) { \
516 .name = (stringify(_field)), \
517 .num = (_num), \
518 .field_exists = (_test), \
519 .version_id = (_version), \
520 .vmsd = &(_vmsd), \
521 .size = sizeof(_type), \
522 .flags = VMS_STRUCT|VMS_ARRAY, \
523 .offset = vmstate_offset_array(_state, _field, _type, _num),\
524 }
525
526 #define VMSTATE_STRUCT_2DARRAY_TEST(_field, _state, _n1, _n2, _test, \
527 _version, _vmsd, _type) { \
528 .name = (stringify(_field)), \
529 .num = (_n1) * (_n2), \
530 .field_exists = (_test), \
531 .version_id = (_version), \
532 .vmsd = &(_vmsd), \
533 .size = sizeof(_type), \
534 .flags = VMS_STRUCT | VMS_ARRAY, \
535 .offset = vmstate_offset_2darray(_state, _field, _type, \
536 _n1, _n2), \
537 }
538
539 #define VMSTATE_STRUCT_VARRAY_UINT8(_field, _state, _field_num, _version, _vmsd, _type) { \
540 .name = (stringify(_field)), \
541 .num_offset = vmstate_offset_value(_state, _field_num, uint8_t), \
542 .version_id = (_version), \
543 .vmsd = &(_vmsd), \
544 .size = sizeof(_type), \
545 .flags = VMS_STRUCT|VMS_VARRAY_UINT8, \
546 .offset = vmstate_offset_varray(_state, _field, _type), \
547 }
548
549 /* a variable length array (i.e. _type *_field) but we know the
550 * length
551 */
552 #define VMSTATE_STRUCT_VARRAY_POINTER_KNOWN(_field, _state, _num, _version, _vmsd, _type) { \
553 .name = (stringify(_field)), \
554 .num = (_num), \
555 .version_id = (_version), \
556 .vmsd = &(_vmsd), \
557 .size = sizeof(_type), \
558 .flags = VMS_STRUCT|VMS_ARRAY|VMS_POINTER, \
559 .offset = offsetof(_state, _field), \
560 }
561
562 #define VMSTATE_STRUCT_VARRAY_POINTER_INT32(_field, _state, _field_num, _vmsd, _type) { \
563 .name = (stringify(_field)), \
564 .version_id = 0, \
565 .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
566 .size = sizeof(_type), \
567 .vmsd = &(_vmsd), \
568 .flags = VMS_POINTER | VMS_VARRAY_INT32 | VMS_STRUCT, \
569 .offset = vmstate_offset_pointer(_state, _field, _type), \
570 }
571
572 #define VMSTATE_STRUCT_VARRAY_POINTER_UINT32(_field, _state, _field_num, _vmsd, _type) { \
573 .name = (stringify(_field)), \
574 .version_id = 0, \
575 .num_offset = vmstate_offset_value(_state, _field_num, uint32_t),\
576 .size = sizeof(_type), \
577 .vmsd = &(_vmsd), \
578 .flags = VMS_POINTER | VMS_VARRAY_INT32 | VMS_STRUCT, \
579 .offset = vmstate_offset_pointer(_state, _field, _type), \
580 }
581
582 #define VMSTATE_STRUCT_VARRAY_POINTER_UINT16(_field, _state, _field_num, _vmsd, _type) { \
583 .name = (stringify(_field)), \
584 .version_id = 0, \
585 .num_offset = vmstate_offset_value(_state, _field_num, uint16_t),\
586 .size = sizeof(_type), \
587 .vmsd = &(_vmsd), \
588 .flags = VMS_POINTER | VMS_VARRAY_UINT16 | VMS_STRUCT, \
589 .offset = vmstate_offset_pointer(_state, _field, _type), \
590 }
591
592 #define VMSTATE_STRUCT_VARRAY_INT32(_field, _state, _field_num, _version, _vmsd, _type) { \
593 .name = (stringify(_field)), \
594 .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
595 .version_id = (_version), \
596 .vmsd = &(_vmsd), \
597 .size = sizeof(_type), \
598 .flags = VMS_STRUCT|VMS_VARRAY_INT32, \
599 .offset = vmstate_offset_varray(_state, _field, _type), \
600 }
601
602 #define VMSTATE_STRUCT_VARRAY_UINT32(_field, _state, _field_num, _version, _vmsd, _type) { \
603 .name = (stringify(_field)), \
604 .num_offset = vmstate_offset_value(_state, _field_num, uint32_t), \
605 .version_id = (_version), \
606 .vmsd = &(_vmsd), \
607 .size = sizeof(_type), \
608 .flags = VMS_STRUCT|VMS_VARRAY_UINT32, \
609 .offset = vmstate_offset_varray(_state, _field, _type), \
610 }
611
612 #define VMSTATE_STRUCT_VARRAY_ALLOC(_field, _state, _field_num, _version, _vmsd, _type) {\
613 .name = (stringify(_field)), \
614 .version_id = (_version), \
615 .vmsd = &(_vmsd), \
616 .num_offset = vmstate_offset_value(_state, _field_num, int32_t), \
617 .size = sizeof(_type), \
618 .flags = VMS_STRUCT|VMS_VARRAY_INT32|VMS_ALLOC|VMS_POINTER, \
619 .offset = vmstate_offset_pointer(_state, _field, _type), \
620 }
621
622 #define VMSTATE_STATIC_BUFFER(_field, _state, _version, _test, _start, _size) { \
623 .name = (stringify(_field)), \
624 .version_id = (_version), \
625 .field_exists = (_test), \
626 .size = (_size - _start), \
627 .info = &vmstate_info_buffer, \
628 .flags = VMS_BUFFER, \
629 .offset = vmstate_offset_buffer(_state, _field) + _start, \
630 }
631
632 #define VMSTATE_VBUFFER_MULTIPLY(_field, _state, _version, _test, \
633 _field_size, _multiply) { \
634 .name = (stringify(_field)), \
635 .version_id = (_version), \
636 .field_exists = (_test), \
637 .size_offset = vmstate_offset_value(_state, _field_size, uint32_t),\
638 .size = (_multiply), \
639 .info = &vmstate_info_buffer, \
640 .flags = VMS_VBUFFER|VMS_POINTER|VMS_MULTIPLY, \
641 .offset = offsetof(_state, _field), \
642 }
643
644 #define VMSTATE_VBUFFER(_field, _state, _version, _test, _field_size) { \
645 .name = (stringify(_field)), \
646 .version_id = (_version), \
647 .field_exists = (_test), \
648 .size_offset = vmstate_offset_value(_state, _field_size, int32_t),\
649 .info = &vmstate_info_buffer, \
650 .flags = VMS_VBUFFER|VMS_POINTER, \
651 .offset = offsetof(_state, _field), \
652 }
653
654 #define VMSTATE_VBUFFER_UINT32(_field, _state, _version, _test, _field_size) { \
655 .name = (stringify(_field)), \
656 .version_id = (_version), \
657 .field_exists = (_test), \
658 .size_offset = vmstate_offset_value(_state, _field_size, uint32_t),\
659 .info = &vmstate_info_buffer, \
660 .flags = VMS_VBUFFER|VMS_POINTER, \
661 .offset = offsetof(_state, _field), \
662 }
663
664 #define VMSTATE_VBUFFER_ALLOC_UINT32(_field, _state, _version, \
665 _test, _field_size) { \
666 .name = (stringify(_field)), \
667 .version_id = (_version), \
668 .field_exists = (_test), \
669 .size_offset = vmstate_offset_value(_state, _field_size, uint32_t),\
670 .info = &vmstate_info_buffer, \
671 .flags = VMS_VBUFFER|VMS_POINTER|VMS_ALLOC, \
672 .offset = offsetof(_state, _field), \
673 }
674
675 #define VMSTATE_BUFFER_UNSAFE_INFO_TEST(_field, _state, _test, _version, _info, _size) { \
676 .name = (stringify(_field)), \
677 .version_id = (_version), \
678 .field_exists = (_test), \
679 .size = (_size), \
680 .info = &(_info), \
681 .flags = VMS_BUFFER, \
682 .offset = offsetof(_state, _field), \
683 }
684
685 #define VMSTATE_BUFFER_POINTER_UNSAFE(_field, _state, _version, _size) { \
686 .name = (stringify(_field)), \
687 .version_id = (_version), \
688 .size = (_size), \
689 .info = &vmstate_info_buffer, \
690 .flags = VMS_BUFFER|VMS_POINTER, \
691 .offset = offsetof(_state, _field), \
692 }
693
694 /* Allocate a temporary of type 'tmp_type', set tmp->parent to _state
695 * and execute the vmsd on the temporary. Note that we're working with
696 * the whole of _state here, not a field within it.
697 * We compile time check that:
698 * That _tmp_type contains a 'parent' member that's a pointer to the
699 * '_state' type
700 * That the pointer is right at the start of _tmp_type.
701 */
702 #define VMSTATE_WITH_TMP(_state, _tmp_type, _vmsd) { \
703 .name = "tmp", \
704 .size = sizeof(_tmp_type) + \
705 QEMU_BUILD_BUG_ON_ZERO(offsetof(_tmp_type, parent) != 0) + \
706 type_check_pointer(_state, \
707 typeof_field(_tmp_type, parent)), \
708 .vmsd = &(_vmsd), \
709 .info = &vmstate_info_tmp, \
710 }
711
712 #define VMSTATE_UNUSED_BUFFER(_test, _version, _size) { \
713 .name = "unused", \
714 .field_exists = (_test), \
715 .version_id = (_version), \
716 .size = (_size), \
717 .info = &vmstate_info_unused_buffer, \
718 .flags = VMS_BUFFER, \
719 }
720
721 /* Discard size * field_num bytes, where field_num is a uint32 member */
722 #define VMSTATE_UNUSED_VARRAY_UINT32(_state, _test, _version, _field_num, _size) {\
723 .name = "unused", \
724 .field_exists = (_test), \
725 .num_offset = vmstate_offset_value(_state, _field_num, uint32_t),\
726 .version_id = (_version), \
727 .size = (_size), \
728 .info = &vmstate_info_unused_buffer, \
729 .flags = VMS_VARRAY_UINT32 | VMS_BUFFER, \
730 }
731
732 /* _field_size should be a int32_t field in the _state struct giving the
733 * size of the bitmap _field in bits.
734 */
735 #define VMSTATE_BITMAP(_field, _state, _version, _field_size) { \
736 .name = (stringify(_field)), \
737 .version_id = (_version), \
738 .size_offset = vmstate_offset_value(_state, _field_size, int32_t),\
739 .info = &vmstate_info_bitmap, \
740 .flags = VMS_VBUFFER|VMS_POINTER, \
741 .offset = offsetof(_state, _field), \
742 }
743
744 /* For migrating a QTAILQ.
745 * Target QTAILQ needs be properly initialized.
746 * _type: type of QTAILQ element
747 * _next: name of QTAILQ entry field in QTAILQ element
748 * _vmsd: VMSD for QTAILQ element
749 * size: size of QTAILQ element
750 * start: offset of QTAILQ entry in QTAILQ element
751 */
752 #define VMSTATE_QTAILQ_V(_field, _state, _version, _vmsd, _type, _next) \
753 { \
754 .name = (stringify(_field)), \
755 .version_id = (_version), \
756 .vmsd = &(_vmsd), \
757 .size = sizeof(_type), \
758 .info = &vmstate_info_qtailq, \
759 .offset = offsetof(_state, _field), \
760 .start = offsetof(_type, _next), \
761 }
762
763 /*
764 * For migrating a GTree whose key is a pointer to _key_type and the
765 * value, a pointer to _val_type
766 * The target tree must have been properly initialized
767 * _vmsd: Start address of the 2 element array containing the data vmsd
768 * and the key vmsd, in that order
769 * _key_type: type of the key
770 * _val_type: type of the value
771 */
772 #define VMSTATE_GTREE_V(_field, _state, _version, _vmsd, \
773 _key_type, _val_type) \
774 { \
775 .name = (stringify(_field)), \
776 .version_id = (_version), \
777 .vmsd = (_vmsd), \
778 .info = &vmstate_info_gtree, \
779 .start = sizeof(_key_type), \
780 .size = sizeof(_val_type), \
781 .offset = offsetof(_state, _field), \
782 }
783
784 /*
785 * For migrating a GTree with direct key and the value a pointer
786 * to _val_type
787 * The target tree must have been properly initialized
788 * _vmsd: data vmsd
789 * _val_type: type of the value
790 */
791 #define VMSTATE_GTREE_DIRECT_KEY_V(_field, _state, _version, _vmsd, _val_type) \
792 { \
793 .name = (stringify(_field)), \
794 .version_id = (_version), \
795 .vmsd = (_vmsd), \
796 .info = &vmstate_info_gtree, \
797 .start = 0, \
798 .size = sizeof(_val_type), \
799 .offset = offsetof(_state, _field), \
800 }
801
802 /*
803 * For migrating a QLIST
804 * Target QLIST needs be properly initialized.
805 * _type: type of QLIST element
806 * _next: name of QLIST_ENTRY entry field in QLIST element
807 * _vmsd: VMSD for QLIST element
808 * size: size of QLIST element
809 * start: offset of QLIST_ENTRY in QTAILQ element
810 */
811 #define VMSTATE_QLIST_V(_field, _state, _version, _vmsd, _type, _next) \
812 { \
813 .name = (stringify(_field)), \
814 .version_id = (_version), \
815 .vmsd = &(_vmsd), \
816 .size = sizeof(_type), \
817 .info = &vmstate_info_qlist, \
818 .offset = offsetof(_state, _field), \
819 .start = offsetof(_type, _next), \
820 }
821
822 /* _f : field name
823 _f_n : num of elements field_name
824 _n : num of elements
825 _s : struct state name
826 _v : version
827 */
828
829 #define VMSTATE_SINGLE(_field, _state, _version, _info, _type) \
830 VMSTATE_SINGLE_TEST(_field, _state, NULL, _version, _info, _type)
831
832 #define VMSTATE_VSTRUCT(_field, _state, _vmsd, _type, _struct_version)\
833 VMSTATE_VSTRUCT_TEST(_field, _state, NULL, 0, _vmsd, _type, _struct_version)
834
835 #define VMSTATE_VSTRUCT_V(_field, _state, _version, _vmsd, _type, _struct_version) \
836 VMSTATE_VSTRUCT_TEST(_field, _state, NULL, _version, _vmsd, _type, \
837 _struct_version)
838
839 #define VMSTATE_STRUCT(_field, _state, _version, _vmsd, _type) \
840 VMSTATE_STRUCT_TEST(_field, _state, NULL, _version, _vmsd, _type)
841
842 #define VMSTATE_STRUCT_POINTER(_field, _state, _vmsd, _type) \
843 VMSTATE_STRUCT_POINTER_V(_field, _state, 0, _vmsd, _type)
844
845 #define VMSTATE_STRUCT_POINTER_TEST(_field, _state, _test, _vmsd, _type) \
846 VMSTATE_STRUCT_POINTER_TEST_V(_field, _state, _test, 0, _vmsd, _type)
847
848 #define VMSTATE_STRUCT_ARRAY(_field, _state, _num, _version, _vmsd, _type) \
849 VMSTATE_STRUCT_ARRAY_TEST(_field, _state, _num, NULL, _version, \
850 _vmsd, _type)
851
852 #define VMSTATE_STRUCT_2DARRAY(_field, _state, _n1, _n2, _version, \
853 _vmsd, _type) \
854 VMSTATE_STRUCT_2DARRAY_TEST(_field, _state, _n1, _n2, NULL, \
855 _version, _vmsd, _type)
856
857 #define VMSTATE_BUFFER_UNSAFE_INFO(_field, _state, _version, _info, _size) \
858 VMSTATE_BUFFER_UNSAFE_INFO_TEST(_field, _state, NULL, _version, _info, \
859 _size)
860
861 #define VMSTATE_BOOL_V(_f, _s, _v) \
862 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_bool, bool)
863
864 #define VMSTATE_INT8_V(_f, _s, _v) \
865 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int8, int8_t)
866 #define VMSTATE_INT16_V(_f, _s, _v) \
867 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int16, int16_t)
868 #define VMSTATE_INT32_V(_f, _s, _v) \
869 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int32, int32_t)
870 #define VMSTATE_INT64_V(_f, _s, _v) \
871 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int64, int64_t)
872
873 #define VMSTATE_UINT8_V(_f, _s, _v) \
874 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint8, uint8_t)
875 #define VMSTATE_UINT16_V(_f, _s, _v) \
876 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint16, uint16_t)
877 #define VMSTATE_UINT32_V(_f, _s, _v) \
878 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint32, uint32_t)
879 #define VMSTATE_UINT64_V(_f, _s, _v) \
880 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint64, uint64_t)
881
882 #ifdef CONFIG_LINUX
883
884 #define VMSTATE_U8_V(_f, _s, _v) \
885 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint8, __u8)
886 #define VMSTATE_U16_V(_f, _s, _v) \
887 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint16, __u16)
888 #define VMSTATE_U32_V(_f, _s, _v) \
889 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint32, __u32)
890 #define VMSTATE_U64_V(_f, _s, _v) \
891 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint64, __u64)
892
893 #endif
894
895 #define VMSTATE_BOOL(_f, _s) \
896 VMSTATE_BOOL_V(_f, _s, 0)
897
898 #define VMSTATE_INT8(_f, _s) \
899 VMSTATE_INT8_V(_f, _s, 0)
900 #define VMSTATE_INT16(_f, _s) \
901 VMSTATE_INT16_V(_f, _s, 0)
902 #define VMSTATE_INT32(_f, _s) \
903 VMSTATE_INT32_V(_f, _s, 0)
904 #define VMSTATE_INT64(_f, _s) \
905 VMSTATE_INT64_V(_f, _s, 0)
906
907 #define VMSTATE_UINT8(_f, _s) \
908 VMSTATE_UINT8_V(_f, _s, 0)
909 #define VMSTATE_UINT16(_f, _s) \
910 VMSTATE_UINT16_V(_f, _s, 0)
911 #define VMSTATE_UINT32(_f, _s) \
912 VMSTATE_UINT32_V(_f, _s, 0)
913 #define VMSTATE_UINT64(_f, _s) \
914 VMSTATE_UINT64_V(_f, _s, 0)
915
916 #ifdef CONFIG_LINUX
917
918 #define VMSTATE_U8(_f, _s) \
919 VMSTATE_U8_V(_f, _s, 0)
920 #define VMSTATE_U16(_f, _s) \
921 VMSTATE_U16_V(_f, _s, 0)
922 #define VMSTATE_U32(_f, _s) \
923 VMSTATE_U32_V(_f, _s, 0)
924 #define VMSTATE_U64(_f, _s) \
925 VMSTATE_U64_V(_f, _s, 0)
926
927 #endif
928
929 #define VMSTATE_UINT8_EQUAL(_f, _s, _err_hint) \
930 VMSTATE_SINGLE_FULL(_f, _s, 0, 0, \
931 vmstate_info_uint8_equal, uint8_t, _err_hint)
932
933 #define VMSTATE_UINT16_EQUAL(_f, _s, _err_hint) \
934 VMSTATE_SINGLE_FULL(_f, _s, 0, 0, \
935 vmstate_info_uint16_equal, uint16_t, _err_hint)
936
937 #define VMSTATE_UINT16_EQUAL_V(_f, _s, _v, _err_hint) \
938 VMSTATE_SINGLE_FULL(_f, _s, 0, _v, \
939 vmstate_info_uint16_equal, uint16_t, _err_hint)
940
941 #define VMSTATE_INT32_EQUAL(_f, _s, _err_hint) \
942 VMSTATE_SINGLE_FULL(_f, _s, 0, 0, \
943 vmstate_info_int32_equal, int32_t, _err_hint)
944
945 #define VMSTATE_UINT32_EQUAL_V(_f, _s, _v, _err_hint) \
946 VMSTATE_SINGLE_FULL(_f, _s, 0, _v, \
947 vmstate_info_uint32_equal, uint32_t, _err_hint)
948
949 #define VMSTATE_UINT32_EQUAL(_f, _s, _err_hint) \
950 VMSTATE_UINT32_EQUAL_V(_f, _s, 0, _err_hint)
951
952 #define VMSTATE_UINT64_EQUAL_V(_f, _s, _v, _err_hint) \
953 VMSTATE_SINGLE_FULL(_f, _s, 0, _v, \
954 vmstate_info_uint64_equal, uint64_t, _err_hint)
955
956 #define VMSTATE_UINT64_EQUAL(_f, _s, _err_hint) \
957 VMSTATE_UINT64_EQUAL_V(_f, _s, 0, _err_hint)
958
959 #define VMSTATE_INT32_POSITIVE_LE(_f, _s) \
960 VMSTATE_SINGLE(_f, _s, 0, vmstate_info_int32_le, int32_t)
961
962 #define VMSTATE_BOOL_TEST(_f, _s, _t) \
963 VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_bool, bool)
964
965 #define VMSTATE_INT8_TEST(_f, _s, _t) \
966 VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_int8, int8_t)
967
968 #define VMSTATE_INT16_TEST(_f, _s, _t) \
969 VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_int16, int16_t)
970
971 #define VMSTATE_INT32_TEST(_f, _s, _t) \
972 VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_int32, int32_t)
973
974 #define VMSTATE_INT64_TEST(_f, _s, _t) \
975 VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_int64, int64_t)
976
977 #define VMSTATE_UINT8_TEST(_f, _s, _t) \
978 VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint8, uint8_t)
979
980 #define VMSTATE_UINT16_TEST(_f, _s, _t) \
981 VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint16, uint16_t)
982
983 #define VMSTATE_UINT32_TEST(_f, _s, _t) \
984 VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint32, uint32_t)
985
986 #define VMSTATE_UINT64_TEST(_f, _s, _t) \
987 VMSTATE_SINGLE_TEST(_f, _s, _t, 0, vmstate_info_uint64, uint64_t)
988
989
990 #define VMSTATE_FLOAT64_V(_f, _s, _v) \
991 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_float64, float64)
992
993 #define VMSTATE_FLOAT64(_f, _s) \
994 VMSTATE_FLOAT64_V(_f, _s, 0)
995
996 #define VMSTATE_TIMER_PTR_TEST(_f, _s, _test) \
997 VMSTATE_POINTER_TEST(_f, _s, _test, vmstate_info_timer, QEMUTimer *)
998
999 #define VMSTATE_TIMER_PTR_V(_f, _s, _v) \
1000 VMSTATE_POINTER(_f, _s, _v, vmstate_info_timer, QEMUTimer *)
1001
1002 #define VMSTATE_TIMER_PTR(_f, _s) \
1003 VMSTATE_TIMER_PTR_V(_f, _s, 0)
1004
1005 #define VMSTATE_TIMER_PTR_ARRAY(_f, _s, _n) \
1006 VMSTATE_ARRAY_OF_POINTER(_f, _s, _n, 0, vmstate_info_timer, QEMUTimer *)
1007
1008 #define VMSTATE_TIMER_TEST(_f, _s, _test) \
1009 VMSTATE_SINGLE_TEST(_f, _s, _test, 0, vmstate_info_timer, QEMUTimer)
1010
1011 #define VMSTATE_TIMER_V(_f, _s, _v) \
1012 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_timer, QEMUTimer)
1013
1014 #define VMSTATE_TIMER(_f, _s) \
1015 VMSTATE_TIMER_V(_f, _s, 0)
1016
1017 #define VMSTATE_TIMER_ARRAY(_f, _s, _n) \
1018 VMSTATE_ARRAY(_f, _s, _n, 0, vmstate_info_timer, QEMUTimer)
1019
1020 #define VMSTATE_BOOL_ARRAY_V(_f, _s, _n, _v) \
1021 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_bool, bool)
1022
1023 #define VMSTATE_BOOL_ARRAY(_f, _s, _n) \
1024 VMSTATE_BOOL_ARRAY_V(_f, _s, _n, 0)
1025
1026 #define VMSTATE_BOOL_SUB_ARRAY(_f, _s, _start, _num) \
1027 VMSTATE_SUB_ARRAY(_f, _s, _start, _num, 0, vmstate_info_bool, bool)
1028
1029 #define VMSTATE_UINT16_ARRAY_V(_f, _s, _n, _v) \
1030 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint16, uint16_t)
1031
1032 #define VMSTATE_UINT16_2DARRAY_V(_f, _s, _n1, _n2, _v) \
1033 VMSTATE_2DARRAY(_f, _s, _n1, _n2, _v, vmstate_info_uint16, uint16_t)
1034
1035 #define VMSTATE_UINT16_ARRAY(_f, _s, _n) \
1036 VMSTATE_UINT16_ARRAY_V(_f, _s, _n, 0)
1037
1038 #define VMSTATE_UINT16_SUB_ARRAY(_f, _s, _start, _num) \
1039 VMSTATE_SUB_ARRAY(_f, _s, _start, _num, 0, vmstate_info_uint16, uint16_t)
1040
1041 #define VMSTATE_UINT16_2DARRAY(_f, _s, _n1, _n2) \
1042 VMSTATE_UINT16_2DARRAY_V(_f, _s, _n1, _n2, 0)
1043
1044 #define VMSTATE_UINT8_2DARRAY_V(_f, _s, _n1, _n2, _v) \
1045 VMSTATE_2DARRAY(_f, _s, _n1, _n2, _v, vmstate_info_uint8, uint8_t)
1046
1047 #define VMSTATE_UINT8_ARRAY_V(_f, _s, _n, _v) \
1048 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint8, uint8_t)
1049
1050 #define VMSTATE_UINT8_ARRAY(_f, _s, _n) \
1051 VMSTATE_UINT8_ARRAY_V(_f, _s, _n, 0)
1052
1053 #define VMSTATE_UINT8_SUB_ARRAY(_f, _s, _start, _num) \
1054 VMSTATE_SUB_ARRAY(_f, _s, _start, _num, 0, vmstate_info_uint8, uint8_t)
1055
1056 #define VMSTATE_UINT8_2DARRAY(_f, _s, _n1, _n2) \
1057 VMSTATE_UINT8_2DARRAY_V(_f, _s, _n1, _n2, 0)
1058
1059 #define VMSTATE_UINT32_ARRAY_V(_f, _s, _n, _v) \
1060 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint32, uint32_t)
1061
1062 #define VMSTATE_UINT32_2DARRAY_V(_f, _s, _n1, _n2, _v) \
1063 VMSTATE_2DARRAY(_f, _s, _n1, _n2, _v, vmstate_info_uint32, uint32_t)
1064
1065 #define VMSTATE_UINT32_ARRAY(_f, _s, _n) \
1066 VMSTATE_UINT32_ARRAY_V(_f, _s, _n, 0)
1067
1068 #define VMSTATE_UINT32_SUB_ARRAY(_f, _s, _start, _num) \
1069 VMSTATE_SUB_ARRAY(_f, _s, _start, _num, 0, vmstate_info_uint32, uint32_t)
1070
1071 #define VMSTATE_UINT32_2DARRAY(_f, _s, _n1, _n2) \
1072 VMSTATE_UINT32_2DARRAY_V(_f, _s, _n1, _n2, 0)
1073
1074 #define VMSTATE_UINT64_ARRAY_V(_f, _s, _n, _v) \
1075 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint64, uint64_t)
1076
1077 #define VMSTATE_UINT64_ARRAY(_f, _s, _n) \
1078 VMSTATE_UINT64_ARRAY_V(_f, _s, _n, 0)
1079
1080 #define VMSTATE_UINT64_SUB_ARRAY(_f, _s, _start, _num) \
1081 VMSTATE_SUB_ARRAY(_f, _s, _start, _num, 0, vmstate_info_uint64, uint64_t)
1082
1083 #define VMSTATE_UINT64_2DARRAY(_f, _s, _n1, _n2) \
1084 VMSTATE_UINT64_2DARRAY_V(_f, _s, _n1, _n2, 0)
1085
1086 #define VMSTATE_UINT64_2DARRAY_V(_f, _s, _n1, _n2, _v) \
1087 VMSTATE_2DARRAY(_f, _s, _n1, _n2, _v, vmstate_info_uint64, uint64_t)
1088
1089 #define VMSTATE_INT16_ARRAY_V(_f, _s, _n, _v) \
1090 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int16, int16_t)
1091
1092 #define VMSTATE_INT16_ARRAY(_f, _s, _n) \
1093 VMSTATE_INT16_ARRAY_V(_f, _s, _n, 0)
1094
1095 #define VMSTATE_INT32_ARRAY_V(_f, _s, _n, _v) \
1096 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int32, int32_t)
1097
1098 #define VMSTATE_INT32_ARRAY(_f, _s, _n) \
1099 VMSTATE_INT32_ARRAY_V(_f, _s, _n, 0)
1100
1101 #define VMSTATE_INT64_ARRAY_V(_f, _s, _n, _v) \
1102 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int64, int64_t)
1103
1104 #define VMSTATE_INT64_ARRAY(_f, _s, _n) \
1105 VMSTATE_INT64_ARRAY_V(_f, _s, _n, 0)
1106
1107 #define VMSTATE_FLOAT64_ARRAY_V(_f, _s, _n, _v) \
1108 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_float64, float64)
1109
1110 #define VMSTATE_FLOAT64_ARRAY(_f, _s, _n) \
1111 VMSTATE_FLOAT64_ARRAY_V(_f, _s, _n, 0)
1112
1113 #define VMSTATE_CPUDOUBLE_ARRAY_V(_f, _s, _n, _v) \
1114 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_cpudouble, CPU_DoubleU)
1115
1116 #define VMSTATE_CPUDOUBLE_ARRAY(_f, _s, _n) \
1117 VMSTATE_CPUDOUBLE_ARRAY_V(_f, _s, _n, 0)
1118
1119 #define VMSTATE_BUFFER_V(_f, _s, _v) \
1120 VMSTATE_STATIC_BUFFER(_f, _s, _v, NULL, 0, sizeof(typeof_field(_s, _f)))
1121
1122 #define VMSTATE_BUFFER(_f, _s) \
1123 VMSTATE_BUFFER_V(_f, _s, 0)
1124
1125 #define VMSTATE_PARTIAL_BUFFER(_f, _s, _size) \
1126 VMSTATE_STATIC_BUFFER(_f, _s, 0, NULL, 0, _size)
1127
1128 #define VMSTATE_BUFFER_START_MIDDLE_V(_f, _s, _start, _v) \
1129 VMSTATE_STATIC_BUFFER(_f, _s, _v, NULL, _start, sizeof(typeof_field(_s, _f)))
1130
1131 #define VMSTATE_BUFFER_START_MIDDLE(_f, _s, _start) \
1132 VMSTATE_BUFFER_START_MIDDLE_V(_f, _s, _start, 0)
1133
1134 #define VMSTATE_PARTIAL_VBUFFER(_f, _s, _size) \
1135 VMSTATE_VBUFFER(_f, _s, 0, NULL, _size)
1136
1137 #define VMSTATE_PARTIAL_VBUFFER_UINT32(_f, _s, _size) \
1138 VMSTATE_VBUFFER_UINT32(_f, _s, 0, NULL, _size)
1139
1140 #define VMSTATE_BUFFER_TEST(_f, _s, _test) \
1141 VMSTATE_STATIC_BUFFER(_f, _s, 0, _test, 0, sizeof(typeof_field(_s, _f)))
1142
1143 #define VMSTATE_BUFFER_UNSAFE(_field, _state, _version, _size) \
1144 VMSTATE_BUFFER_UNSAFE_INFO(_field, _state, _version, vmstate_info_buffer, _size)
1145
1146 /*
1147 * These VMSTATE_UNUSED*() macros can be used to fill in the holes
1148 * when some of the vmstate fields are obsolete to be compatible with
1149 * migrations between new/old binaries.
1150 *
1151 * CAUTION: when using any of the VMSTATE_UNUSED*() macros please be
1152 * sure that the size passed in is the size that was actually *sent*
1153 * rather than the size of the *structure*. One example is the
1154 * boolean type - the size of the structure can vary depending on the
1155 * definition of boolean, however the size we actually sent is always
1156 * 1 byte (please refer to implementation of VMSTATE_BOOL_V and
1157 * vmstate_info_bool). So here we should always pass in size==1
1158 * rather than size==sizeof(bool).
1159 */
1160 #define VMSTATE_UNUSED_V(_v, _size) \
1161 VMSTATE_UNUSED_BUFFER(NULL, _v, _size)
1162
1163 #define VMSTATE_UNUSED(_size) \
1164 VMSTATE_UNUSED_V(0, _size)
1165
1166 #define VMSTATE_UNUSED_TEST(_test, _size) \
1167 VMSTATE_UNUSED_BUFFER(_test, 0, _size)
1168
1169 #define VMSTATE_END_OF_LIST() \
1170 {}
1171
1172 int vmstate_load_state(QEMUFile *f, const VMStateDescription *vmsd,
1173 void *opaque, int version_id);
1174 int vmstate_save_state(QEMUFile *f, const VMStateDescription *vmsd,
1175 void *opaque, QJSON *vmdesc);
1176 int vmstate_save_state_v(QEMUFile *f, const VMStateDescription *vmsd,
1177 void *opaque, QJSON *vmdesc, int version_id);
1178
1179 bool vmstate_save_needed(const VMStateDescription *vmsd, void *opaque);
1180
1181 #define VMSTATE_INSTANCE_ID_ANY -1
1182
1183 /* Returns: 0 on success, -1 on failure */
1184 int vmstate_register_with_alias_id(VMStateIf *obj, uint32_t instance_id,
1185 const VMStateDescription *vmsd,
1186 void *base, int alias_id,
1187 int required_for_version,
1188 Error **errp);
1189
1190 /* Returns: 0 on success, -1 on failure */
1191 static inline int vmstate_register(VMStateIf *obj, int instance_id,
1192 const VMStateDescription *vmsd,
1193 void *opaque)
1194 {
1195 return vmstate_register_with_alias_id(obj, instance_id, vmsd,
1196 opaque, -1, 0, NULL);
1197 }
1198
1199 void vmstate_unregister(VMStateIf *obj, const VMStateDescription *vmsd,
1200 void *opaque);
1201
1202 void vmstate_register_ram(struct MemoryRegion *memory, DeviceState *dev);
1203 void vmstate_unregister_ram(struct MemoryRegion *memory, DeviceState *dev);
1204 void vmstate_register_ram_global(struct MemoryRegion *memory);
1205
1206 bool vmstate_check_only_migratable(const VMStateDescription *vmsd);
1207
1208 #endif
armbru's QEMU hackery