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