]> git.proxmox.com Git - qemu.git/blob - hw/hw.h
vmstate: add uint64 array support
[qemu.git] / hw / hw.h
1 /* Declarations for use by hardware emulation. */
2 #ifndef QEMU_HW_H
3 #define QEMU_HW_H
4
5 #include "qemu-common.h"
6
7 #if defined(TARGET_PHYS_ADDR_BITS) && !defined(NEED_CPU_H)
8 #include "targphys.h"
9 #include "poison.h"
10 #include "cpu-common.h"
11 #endif
12
13 #include "ioport.h"
14 #include "irq.h"
15
16 /* VM Load/Save */
17
18 /* This function writes a chunk of data to a file at the given position.
19 * The pos argument can be ignored if the file is only being used for
20 * streaming. The handler should try to write all of the data it can.
21 */
22 typedef int (QEMUFilePutBufferFunc)(void *opaque, const uint8_t *buf,
23 int64_t pos, int size);
24
25 /* Read a chunk of data from a file at the given position. The pos argument
26 * can be ignored if the file is only be used for streaming. The number of
27 * bytes actually read should be returned.
28 */
29 typedef int (QEMUFileGetBufferFunc)(void *opaque, uint8_t *buf,
30 int64_t pos, int size);
31
32 /* Close a file and return an error code */
33 typedef int (QEMUFileCloseFunc)(void *opaque);
34
35 /* Called to determine if the file has exceeded it's bandwidth allocation. The
36 * bandwidth capping is a soft limit, not a hard limit.
37 */
38 typedef int (QEMUFileRateLimit)(void *opaque);
39
40 /* Called to change the current bandwidth allocation. This function must return
41 * the new actual bandwidth. It should be new_rate if everything goes ok, and
42 * the old rate otherwise
43 */
44 typedef size_t (QEMUFileSetRateLimit)(void *opaque, size_t new_rate);
45
46 QEMUFile *qemu_fopen_ops(void *opaque, QEMUFilePutBufferFunc *put_buffer,
47 QEMUFileGetBufferFunc *get_buffer,
48 QEMUFileCloseFunc *close,
49 QEMUFileRateLimit *rate_limit,
50 QEMUFileSetRateLimit *set_rate_limit);
51 QEMUFile *qemu_fopen(const char *filename, const char *mode);
52 QEMUFile *qemu_fdopen(int fd, const char *mode);
53 QEMUFile *qemu_fopen_socket(int fd);
54 QEMUFile *qemu_popen(FILE *popen_file, const char *mode);
55 QEMUFile *qemu_popen_cmd(const char *command, const char *mode);
56 int qemu_stdio_fd(QEMUFile *f);
57 void qemu_fflush(QEMUFile *f);
58 int qemu_fclose(QEMUFile *f);
59 void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, int size);
60 void qemu_put_byte(QEMUFile *f, int v);
61
62 static inline void qemu_put_ubyte(QEMUFile *f, unsigned int v)
63 {
64 qemu_put_byte(f, (int)v);
65 }
66
67 #define qemu_put_sbyte qemu_put_byte
68
69 void qemu_put_be16(QEMUFile *f, unsigned int v);
70 void qemu_put_be32(QEMUFile *f, unsigned int v);
71 void qemu_put_be64(QEMUFile *f, uint64_t v);
72 int qemu_get_buffer(QEMUFile *f, uint8_t *buf, int size);
73 int qemu_get_byte(QEMUFile *f);
74
75 static inline unsigned int qemu_get_ubyte(QEMUFile *f)
76 {
77 return (unsigned int)qemu_get_byte(f);
78 }
79
80 #define qemu_get_sbyte qemu_get_byte
81
82 unsigned int qemu_get_be16(QEMUFile *f);
83 unsigned int qemu_get_be32(QEMUFile *f);
84 uint64_t qemu_get_be64(QEMUFile *f);
85 int qemu_file_rate_limit(QEMUFile *f);
86 size_t qemu_file_set_rate_limit(QEMUFile *f, size_t new_rate);
87 int qemu_file_has_error(QEMUFile *f);
88 void qemu_file_set_error(QEMUFile *f);
89
90 /* Try to send any outstanding data. This function is useful when output is
91 * halted due to rate limiting or EAGAIN errors occur as it can be used to
92 * resume output. */
93 void qemu_file_put_notify(QEMUFile *f);
94
95 static inline void qemu_put_be64s(QEMUFile *f, const uint64_t *pv)
96 {
97 qemu_put_be64(f, *pv);
98 }
99
100 static inline void qemu_put_be32s(QEMUFile *f, const uint32_t *pv)
101 {
102 qemu_put_be32(f, *pv);
103 }
104
105 static inline void qemu_put_be16s(QEMUFile *f, const uint16_t *pv)
106 {
107 qemu_put_be16(f, *pv);
108 }
109
110 static inline void qemu_put_8s(QEMUFile *f, const uint8_t *pv)
111 {
112 qemu_put_byte(f, *pv);
113 }
114
115 static inline void qemu_get_be64s(QEMUFile *f, uint64_t *pv)
116 {
117 *pv = qemu_get_be64(f);
118 }
119
120 static inline void qemu_get_be32s(QEMUFile *f, uint32_t *pv)
121 {
122 *pv = qemu_get_be32(f);
123 }
124
125 static inline void qemu_get_be16s(QEMUFile *f, uint16_t *pv)
126 {
127 *pv = qemu_get_be16(f);
128 }
129
130 static inline void qemu_get_8s(QEMUFile *f, uint8_t *pv)
131 {
132 *pv = qemu_get_byte(f);
133 }
134
135 // Signed versions for type safety
136 static inline void qemu_put_sbuffer(QEMUFile *f, const int8_t *buf, int size)
137 {
138 qemu_put_buffer(f, (const uint8_t *)buf, size);
139 }
140
141 static inline void qemu_put_sbe16(QEMUFile *f, int v)
142 {
143 qemu_put_be16(f, (unsigned int)v);
144 }
145
146 static inline void qemu_put_sbe32(QEMUFile *f, int v)
147 {
148 qemu_put_be32(f, (unsigned int)v);
149 }
150
151 static inline void qemu_put_sbe64(QEMUFile *f, int64_t v)
152 {
153 qemu_put_be64(f, (uint64_t)v);
154 }
155
156 static inline size_t qemu_get_sbuffer(QEMUFile *f, int8_t *buf, int size)
157 {
158 return qemu_get_buffer(f, (uint8_t *)buf, size);
159 }
160
161 static inline int qemu_get_sbe16(QEMUFile *f)
162 {
163 return (int)qemu_get_be16(f);
164 }
165
166 static inline int qemu_get_sbe32(QEMUFile *f)
167 {
168 return (int)qemu_get_be32(f);
169 }
170
171 static inline int64_t qemu_get_sbe64(QEMUFile *f)
172 {
173 return (int64_t)qemu_get_be64(f);
174 }
175
176 static inline void qemu_put_s8s(QEMUFile *f, const int8_t *pv)
177 {
178 qemu_put_8s(f, (const uint8_t *)pv);
179 }
180
181 static inline void qemu_put_sbe16s(QEMUFile *f, const int16_t *pv)
182 {
183 qemu_put_be16s(f, (const uint16_t *)pv);
184 }
185
186 static inline void qemu_put_sbe32s(QEMUFile *f, const int32_t *pv)
187 {
188 qemu_put_be32s(f, (const uint32_t *)pv);
189 }
190
191 static inline void qemu_put_sbe64s(QEMUFile *f, const int64_t *pv)
192 {
193 qemu_put_be64s(f, (const uint64_t *)pv);
194 }
195
196 static inline void qemu_get_s8s(QEMUFile *f, int8_t *pv)
197 {
198 qemu_get_8s(f, (uint8_t *)pv);
199 }
200
201 static inline void qemu_get_sbe16s(QEMUFile *f, int16_t *pv)
202 {
203 qemu_get_be16s(f, (uint16_t *)pv);
204 }
205
206 static inline void qemu_get_sbe32s(QEMUFile *f, int32_t *pv)
207 {
208 qemu_get_be32s(f, (uint32_t *)pv);
209 }
210
211 static inline void qemu_get_sbe64s(QEMUFile *f, int64_t *pv)
212 {
213 qemu_get_be64s(f, (uint64_t *)pv);
214 }
215
216 #ifdef NEED_CPU_H
217 #if TARGET_LONG_BITS == 64
218 #define qemu_put_betl qemu_put_be64
219 #define qemu_get_betl qemu_get_be64
220 #define qemu_put_betls qemu_put_be64s
221 #define qemu_get_betls qemu_get_be64s
222 #define qemu_put_sbetl qemu_put_sbe64
223 #define qemu_get_sbetl qemu_get_sbe64
224 #define qemu_put_sbetls qemu_put_sbe64s
225 #define qemu_get_sbetls qemu_get_sbe64s
226 #else
227 #define qemu_put_betl qemu_put_be32
228 #define qemu_get_betl qemu_get_be32
229 #define qemu_put_betls qemu_put_be32s
230 #define qemu_get_betls qemu_get_be32s
231 #define qemu_put_sbetl qemu_put_sbe32
232 #define qemu_get_sbetl qemu_get_sbe32
233 #define qemu_put_sbetls qemu_put_sbe32s
234 #define qemu_get_sbetls qemu_get_sbe32s
235 #endif
236 #endif
237
238 int64_t qemu_ftell(QEMUFile *f);
239 int64_t qemu_fseek(QEMUFile *f, int64_t pos, int whence);
240
241 typedef void SaveStateHandler(QEMUFile *f, void *opaque);
242 typedef int SaveLiveStateHandler(QEMUFile *f, int stage, void *opaque);
243 typedef int LoadStateHandler(QEMUFile *f, void *opaque, int version_id);
244
245 int register_savevm(const char *idstr,
246 int instance_id,
247 int version_id,
248 SaveStateHandler *save_state,
249 LoadStateHandler *load_state,
250 void *opaque);
251
252 int register_savevm_live(const char *idstr,
253 int instance_id,
254 int version_id,
255 SaveLiveStateHandler *save_live_state,
256 SaveStateHandler *save_state,
257 LoadStateHandler *load_state,
258 void *opaque);
259
260 void unregister_savevm(const char *idstr, void *opaque);
261
262 typedef void QEMUResetHandler(void *opaque);
263
264 void qemu_register_reset(QEMUResetHandler *func, void *opaque);
265 void qemu_unregister_reset(QEMUResetHandler *func, void *opaque);
266
267 /* handler to set the boot_device order for a specific type of QEMUMachine */
268 /* return 0 if success */
269 typedef int QEMUBootSetHandler(void *opaque, const char *boot_devices);
270 void qemu_register_boot_set(QEMUBootSetHandler *func, void *opaque);
271 int qemu_boot_set(const char *boot_devices);
272
273 typedef struct VMStateInfo VMStateInfo;
274 typedef struct VMStateDescription VMStateDescription;
275
276 struct VMStateInfo {
277 const char *name;
278 int (*get)(QEMUFile *f, void *pv, size_t size);
279 void (*put)(QEMUFile *f, const void *pv, size_t size);
280 };
281
282 enum VMStateFlags {
283 VMS_SINGLE = 0x001,
284 VMS_POINTER = 0x002,
285 VMS_ARRAY = 0x004,
286 VMS_STRUCT = 0x008,
287 VMS_VARRAY = 0x010, /* Array with size in another field */
288 VMS_BUFFER = 0x020, /* static sized buffer */
289 };
290
291 typedef struct {
292 const char *name;
293 size_t offset;
294 size_t size;
295 int num;
296 size_t num_offset;
297 const VMStateInfo *info;
298 enum VMStateFlags flags;
299 const VMStateDescription *vmsd;
300 int version_id;
301 } VMStateField;
302
303 struct VMStateDescription {
304 const char *name;
305 int version_id;
306 int minimum_version_id;
307 int minimum_version_id_old;
308 LoadStateHandler *load_state_old;
309 int (*pre_load)(void *opaque);
310 int (*post_load)(void *opaque);
311 void (*pre_save)(const void *opaque);
312 void (*post_save)(const void *opaque);
313 VMStateField *fields;
314 };
315
316 extern const VMStateInfo vmstate_info_int8;
317 extern const VMStateInfo vmstate_info_int16;
318 extern const VMStateInfo vmstate_info_int32;
319 extern const VMStateInfo vmstate_info_int64;
320
321 extern const VMStateInfo vmstate_info_uint8_equal;
322 extern const VMStateInfo vmstate_info_int32_equal;
323 extern const VMStateInfo vmstate_info_int32_le;
324
325 extern const VMStateInfo vmstate_info_uint8;
326 extern const VMStateInfo vmstate_info_uint16;
327 extern const VMStateInfo vmstate_info_uint32;
328 extern const VMStateInfo vmstate_info_uint64;
329
330 extern const VMStateInfo vmstate_info_timer;
331 extern const VMStateInfo vmstate_info_ptimer;
332 extern const VMStateInfo vmstate_info_buffer;
333
334 #define type_check_array(t1,t2,n) ((t1(*)[n])0 - (t2*)0)
335 #define type_check_pointer(t1,t2) ((t1**)0 - (t2*)0)
336
337 #define VMSTATE_SINGLE(_field, _state, _version, _info, _type) { \
338 .name = (stringify(_field)), \
339 .version_id = (_version), \
340 .size = sizeof(_type), \
341 .info = &(_info), \
342 .flags = VMS_SINGLE, \
343 .offset = offsetof(_state, _field) \
344 + type_check(_type,typeof_field(_state, _field)) \
345 }
346
347 #define VMSTATE_POINTER(_field, _state, _version, _info, _type) { \
348 .name = (stringify(_field)), \
349 .version_id = (_version), \
350 .info = &(_info), \
351 .size = sizeof(_type), \
352 .flags = VMS_SINGLE|VMS_POINTER, \
353 .offset = offsetof(_state, _field) \
354 + type_check(_type,typeof_field(_state, _field)) \
355 }
356
357 #define VMSTATE_ARRAY(_field, _state, _num, _version, _info, _type) {\
358 .name = (stringify(_field)), \
359 .version_id = (_version), \
360 .num = (_num), \
361 .info = &(_info), \
362 .size = sizeof(_type), \
363 .flags = VMS_ARRAY, \
364 .offset = offsetof(_state, _field) \
365 + type_check_array(_type,typeof_field(_state, _field),_num) \
366 }
367
368 #define VMSTATE_VARRAY(_field, _state, _field_num, _version, _info, _type) {\
369 .name = (stringify(_field)), \
370 .version_id = (_version), \
371 .num_offset = offsetof(_state, _field_num) \
372 + type_check(int32_t,typeof_field(_state, _field_num)), \
373 .info = &(_info), \
374 .size = sizeof(_type), \
375 .flags = VMS_VARRAY|VMS_POINTER, \
376 .offset = offsetof(_state, _field) \
377 + type_check_pointer(_type,typeof_field(_state, _field)) \
378 }
379
380 #define VMSTATE_STRUCT(_field, _state, _version, _vmsd, _type) { \
381 .name = (stringify(_field)), \
382 .version_id = (_version), \
383 .vmsd = &(_vmsd), \
384 .size = sizeof(_type), \
385 .flags = VMS_STRUCT, \
386 .offset = offsetof(_state, _field) \
387 + type_check(_type,typeof_field(_state, _field)) \
388 }
389
390 #define VMSTATE_STRUCT_ARRAY(_field, _state, _num, _version, _vmsd, _type) { \
391 .name = (stringify(_field)), \
392 .num = (_num), \
393 .version_id = (_version), \
394 .vmsd = &(_vmsd), \
395 .size = sizeof(_type), \
396 .flags = VMS_STRUCT|VMS_ARRAY, \
397 .offset = offsetof(_state, _field) \
398 + type_check_array(_type,typeof_field(_state, _field),_num) \
399 }
400
401 #define VMSTATE_STATIC_BUFFER(_field, _state, _version) { \
402 .name = (stringify(_field)), \
403 .version_id = (_version), \
404 .size = sizeof(typeof_field(_state,_field)), \
405 .info = &vmstate_info_buffer, \
406 .flags = VMS_BUFFER, \
407 .offset = offsetof(_state, _field) \
408 + type_check_array(uint8_t,typeof_field(_state, _field),sizeof(typeof_field(_state,_field))) \
409 }
410
411 extern const VMStateDescription vmstate_pci_device;
412
413 #define VMSTATE_PCI_DEVICE(_field, _state) { \
414 .name = (stringify(_field)), \
415 .size = sizeof(PCIDevice), \
416 .vmsd = &vmstate_pci_device, \
417 .flags = VMS_STRUCT, \
418 .offset = offsetof(_state, _field) \
419 + type_check(PCIDevice,typeof_field(_state, _field)) \
420 }
421
422 /* _f : field name
423 _f_n : num of elements field_name
424 _n : num of elements
425 _s : struct state name
426 _v : version
427 */
428
429 #define VMSTATE_INT8_V(_f, _s, _v) \
430 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int8, int8_t)
431 #define VMSTATE_INT16_V(_f, _s, _v) \
432 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int16, int16_t)
433 #define VMSTATE_INT32_V(_f, _s, _v) \
434 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int32, int32_t)
435 #define VMSTATE_INT64_V(_f, _s, _v) \
436 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int64, int64_t)
437
438 #define VMSTATE_UINT8_V(_f, _s, _v) \
439 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint8, uint8_t)
440 #define VMSTATE_UINT16_V(_f, _s, _v) \
441 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint16, uint16_t)
442 #define VMSTATE_UINT32_V(_f, _s, _v) \
443 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint32, uint32_t)
444 #define VMSTATE_UINT64_V(_f, _s, _v) \
445 VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint64, uint64_t)
446
447 #define VMSTATE_INT8(_f, _s) \
448 VMSTATE_INT8_V(_f, _s, 0)
449 #define VMSTATE_INT16(_f, _s) \
450 VMSTATE_INT16_V(_f, _s, 0)
451 #define VMSTATE_INT32(_f, _s) \
452 VMSTATE_INT32_V(_f, _s, 0)
453 #define VMSTATE_INT64(_f, _s) \
454 VMSTATE_INT64_V(_f, _s, 0)
455
456 #define VMSTATE_UINT8(_f, _s) \
457 VMSTATE_UINT8_V(_f, _s, 0)
458 #define VMSTATE_UINT16(_f, _s) \
459 VMSTATE_UINT16_V(_f, _s, 0)
460 #define VMSTATE_UINT32(_f, _s) \
461 VMSTATE_UINT32_V(_f, _s, 0)
462 #define VMSTATE_UINT64(_f, _s) \
463 VMSTATE_UINT64_V(_f, _s, 0)
464
465 #define VMSTATE_UINT8_EQUAL(_f, _s) \
466 VMSTATE_SINGLE(_f, _s, 0, vmstate_info_uint8_equal, uint8_t)
467
468 #define VMSTATE_INT32_EQUAL(_f, _s) \
469 VMSTATE_SINGLE(_f, _s, 0, vmstate_info_int32_equal, int32_t)
470
471 #define VMSTATE_INT32_LE(_f, _s) \
472 VMSTATE_SINGLE(_f, _s, 0, vmstate_info_int32_le, int32_t)
473
474 #define VMSTATE_TIMER_V(_f, _s, _v) \
475 VMSTATE_POINTER(_f, _s, _v, vmstate_info_timer, QEMUTimer *)
476
477 #define VMSTATE_TIMER(_f, _s) \
478 VMSTATE_TIMER_V(_f, _s, 0)
479
480 #define VMSTATE_PTIMER_V(_f, _s, _v) \
481 VMSTATE_POINTER(_f, _s, _v, vmstate_info_ptimer, ptimer_state *)
482
483 #define VMSTATE_PTIMER(_f, _s) \
484 VMSTATE_PTIMER_V(_f, _s, 0)
485
486 #define VMSTATE_UINT16_ARRAY_V(_f, _s, _n, _v) \
487 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint16, uint16_t)
488
489 #define VMSTATE_UINT16_ARRAY(_f, _s, _n) \
490 VMSTATE_UINT16_ARRAY_V(_f, _s, _n, 0)
491
492 #define VMSTATE_UINT32_ARRAY_V(_f, _s, _n, _v) \
493 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint32, uint32_t)
494
495 #define VMSTATE_UINT32_ARRAY(_f, _s, _n) \
496 VMSTATE_UINT32_ARRAY_V(_f, _s, _n, 0)
497
498 #define VMSTATE_UINT64_ARRAY_V(_f, _s, _n, _v) \
499 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint64, uint64_t)
500
501 #define VMSTATE_UINT64_ARRAY(_f, _s, _n) \
502 VMSTATE_UINT64_ARRAY_V(_f, _s, _n, 0)
503
504 #define VMSTATE_INT32_ARRAY_V(_f, _s, _n, _v) \
505 VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int32, int32_t)
506
507 #define VMSTATE_INT32_ARRAY(_f, _s, _n) \
508 VMSTATE_INT32_ARRAY_V(_f, _s, _n, 0)
509
510 #define VMSTATE_INT32_VARRAY_V(_f, _s, _f_n, _v) \
511 VMSTATE_VARRAY(_f, _s, _f_n, _v, vmstate_info_int32, int32_t)
512
513 #define VMSTATE_INT32_VARRAY(_f, _s, _f_n) \
514 VMSTATE_INT32_VARRAY_V(_f, _s, _f_n, 0)
515
516 #define VMSTATE_BUFFER_V(_f, _s, _v) \
517 VMSTATE_STATIC_BUFFER(_f, _s, _v)
518
519 #define VMSTATE_BUFFER(_f, _s) \
520 VMSTATE_STATIC_BUFFER(_f, _s, 0)
521
522 #define VMSTATE_END_OF_LIST() \
523 {}
524
525 extern int vmstate_load_state(QEMUFile *f, const VMStateDescription *vmsd,
526 void *opaque, int version_id);
527 extern void vmstate_save_state(QEMUFile *f, const VMStateDescription *vmsd,
528 const void *opaque);
529 extern int vmstate_register(int instance_id, const VMStateDescription *vmsd,
530 void *base);
531 void vmstate_unregister(const VMStateDescription *vmsd, void *opaque);
532 #endif