[qemu.git] / hw / hw.h

/* Declarations for use by hardware emulation.  */
#ifndef QEMU_HW_H
#define QEMU_HW_H

#include "qemu-common.h"

#if defined(TARGET_PHYS_ADDR_BITS) && !defined(NEED_CPU_H)
#include "targphys.h"
#include "poison.h"
#include "cpu-common.h"
#endif

#include "ioport.h"
#include "irq.h"

/* VM Load/Save */

/* This function writes a chunk of data to a file at the given position.
 * The pos argument can be ignored if the file is only being used for
 * streaming.  The handler should try to write all of the data it can.
 */
typedef int (QEMUFilePutBufferFunc)(void *opaque, const uint8_t *buf,
                                    int64_t pos, int size);

/* Read a chunk of data from a file at the given position.  The pos argument
 * can be ignored if the file is only be used for streaming.  The number of
 * bytes actually read should be returned.
 */
typedef int (QEMUFileGetBufferFunc)(void *opaque, uint8_t *buf,
                                    int64_t pos, int size);

/* Close a file and return an error code */
typedef int (QEMUFileCloseFunc)(void *opaque);

/* Called to determine if the file has exceeded it's bandwidth allocation.  The
 * bandwidth capping is a soft limit, not a hard limit.
 */
typedef int (QEMUFileRateLimit)(void *opaque);

/* Called to change the current bandwidth allocation. This function must return
 * the new actual bandwidth. It should be new_rate if everything goes ok, and
 * the old rate otherwise
 */
typedef size_t (QEMUFileSetRateLimit)(void *opaque, size_t new_rate);

QEMUFile *qemu_fopen_ops(void *opaque, QEMUFilePutBufferFunc *put_buffer,
                         QEMUFileGetBufferFunc *get_buffer,
                         QEMUFileCloseFunc *close,
                         QEMUFileRateLimit *rate_limit,
                         QEMUFileSetRateLimit *set_rate_limit);
QEMUFile *qemu_fopen(const char *filename, const char *mode);
QEMUFile *qemu_fdopen(int fd, const char *mode);
QEMUFile *qemu_fopen_socket(int fd);
QEMUFile *qemu_popen(FILE *popen_file, const char *mode);
QEMUFile *qemu_popen_cmd(const char *command, const char *mode);
int qemu_stdio_fd(QEMUFile *f);
void qemu_fflush(QEMUFile *f);
int qemu_fclose(QEMUFile *f);
void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, int size);
void qemu_put_byte(QEMUFile *f, int v);

static inline void qemu_put_ubyte(QEMUFile *f, unsigned int v)
{
    qemu_put_byte(f, (int)v);
}

#define qemu_put_sbyte qemu_put_byte

void qemu_put_be16(QEMUFile *f, unsigned int v);
void qemu_put_be32(QEMUFile *f, unsigned int v);
void qemu_put_be64(QEMUFile *f, uint64_t v);
int qemu_get_buffer(QEMUFile *f, uint8_t *buf, int size);
int qemu_get_byte(QEMUFile *f);

static inline unsigned int qemu_get_ubyte(QEMUFile *f)
{
    return (unsigned int)qemu_get_byte(f);
}

#define qemu_get_sbyte qemu_get_byte

unsigned int qemu_get_be16(QEMUFile *f);
unsigned int qemu_get_be32(QEMUFile *f);
uint64_t qemu_get_be64(QEMUFile *f);
int qemu_file_rate_limit(QEMUFile *f);
size_t qemu_file_set_rate_limit(QEMUFile *f, size_t new_rate);
int qemu_file_has_error(QEMUFile *f);
void qemu_file_set_error(QEMUFile *f);

/* Try to send any outstanding data.  This function is useful when output is
 * halted due to rate limiting or EAGAIN errors occur as it can be used to
 * resume output. */
void qemu_file_put_notify(QEMUFile *f);

static inline void qemu_put_be64s(QEMUFile *f, const uint64_t *pv)
{
    qemu_put_be64(f, *pv);
}

static inline void qemu_put_be32s(QEMUFile *f, const uint32_t *pv)
{
    qemu_put_be32(f, *pv);
}

static inline void qemu_put_be16s(QEMUFile *f, const uint16_t *pv)
{
    qemu_put_be16(f, *pv);
}

static inline void qemu_put_8s(QEMUFile *f, const uint8_t *pv)
{
    qemu_put_byte(f, *pv);
}

static inline void qemu_get_be64s(QEMUFile *f, uint64_t *pv)
{
    *pv = qemu_get_be64(f);
}

static inline void qemu_get_be32s(QEMUFile *f, uint32_t *pv)
{
    *pv = qemu_get_be32(f);
}

static inline void qemu_get_be16s(QEMUFile *f, uint16_t *pv)
{
    *pv = qemu_get_be16(f);
}

static inline void qemu_get_8s(QEMUFile *f, uint8_t *pv)
{
    *pv = qemu_get_byte(f);
}

// Signed versions for type safety
static inline void qemu_put_sbuffer(QEMUFile *f, const int8_t *buf, int size)
{
    qemu_put_buffer(f, (const uint8_t *)buf, size);
}

static inline void qemu_put_sbe16(QEMUFile *f, int v)
{
    qemu_put_be16(f, (unsigned int)v);
}

static inline void qemu_put_sbe32(QEMUFile *f, int v)
{
    qemu_put_be32(f, (unsigned int)v);
}

static inline void qemu_put_sbe64(QEMUFile *f, int64_t v)
{
    qemu_put_be64(f, (uint64_t)v);
}

static inline size_t qemu_get_sbuffer(QEMUFile *f, int8_t *buf, int size)
{
    return qemu_get_buffer(f, (uint8_t *)buf, size);
}

static inline int qemu_get_sbe16(QEMUFile *f)
{
    return (int)qemu_get_be16(f);
}

static inline int qemu_get_sbe32(QEMUFile *f)
{
    return (int)qemu_get_be32(f);
}

static inline int64_t qemu_get_sbe64(QEMUFile *f)
{
    return (int64_t)qemu_get_be64(f);
}

static inline void qemu_put_s8s(QEMUFile *f, const int8_t *pv)
{
    qemu_put_8s(f, (const uint8_t *)pv);
}

static inline void qemu_put_sbe16s(QEMUFile *f, const int16_t *pv)
{
    qemu_put_be16s(f, (const uint16_t *)pv);
}

static inline void qemu_put_sbe32s(QEMUFile *f, const int32_t *pv)
{
    qemu_put_be32s(f, (const uint32_t *)pv);
}

static inline void qemu_put_sbe64s(QEMUFile *f, const int64_t *pv)
{
    qemu_put_be64s(f, (const uint64_t *)pv);
}

static inline void qemu_get_s8s(QEMUFile *f, int8_t *pv)
{
    qemu_get_8s(f, (uint8_t *)pv);
}

static inline void qemu_get_sbe16s(QEMUFile *f, int16_t *pv)
{
    qemu_get_be16s(f, (uint16_t *)pv);
}

static inline void qemu_get_sbe32s(QEMUFile *f, int32_t *pv)
{
    qemu_get_be32s(f, (uint32_t *)pv);
}

static inline void qemu_get_sbe64s(QEMUFile *f, int64_t *pv)
{
    qemu_get_be64s(f, (uint64_t *)pv);
}

#ifdef NEED_CPU_H
#if TARGET_LONG_BITS == 64
#define qemu_put_betl qemu_put_be64
#define qemu_get_betl qemu_get_be64
#define qemu_put_betls qemu_put_be64s
#define qemu_get_betls qemu_get_be64s
#define qemu_put_sbetl qemu_put_sbe64
#define qemu_get_sbetl qemu_get_sbe64
#define qemu_put_sbetls qemu_put_sbe64s
#define qemu_get_sbetls qemu_get_sbe64s
#else
#define qemu_put_betl qemu_put_be32
#define qemu_get_betl qemu_get_be32
#define qemu_put_betls qemu_put_be32s
#define qemu_get_betls qemu_get_be32s
#define qemu_put_sbetl qemu_put_sbe32
#define qemu_get_sbetl qemu_get_sbe32
#define qemu_put_sbetls qemu_put_sbe32s
#define qemu_get_sbetls qemu_get_sbe32s
#endif
#endif

int64_t qemu_ftell(QEMUFile *f);
int64_t qemu_fseek(QEMUFile *f, int64_t pos, int whence);

typedef void SaveStateHandler(QEMUFile *f, void *opaque);
typedef int SaveLiveStateHandler(QEMUFile *f, int stage, void *opaque);
typedef int LoadStateHandler(QEMUFile *f, void *opaque, int version_id);

int register_savevm(const char *idstr,
                    int instance_id,
                    int version_id,
                    SaveStateHandler *save_state,
                    LoadStateHandler *load_state,
                    void *opaque);

int register_savevm_live(const char *idstr,
                         int instance_id,
                         int version_id,
                         SaveLiveStateHandler *save_live_state,
                         SaveStateHandler *save_state,
                         LoadStateHandler *load_state,
                         void *opaque);

void unregister_savevm(const char *idstr, void *opaque);

typedef void QEMUResetHandler(void *opaque);

void qemu_register_reset(QEMUResetHandler *func, void *opaque);
void qemu_unregister_reset(QEMUResetHandler *func, void *opaque);

/* handler to set the boot_device order for a specific type of QEMUMachine */
/* return 0 if success */
typedef int QEMUBootSetHandler(void *opaque, const char *boot_devices);
void qemu_register_boot_set(QEMUBootSetHandler *func, void *opaque);
int qemu_boot_set(const char *boot_devices);

typedef struct VMStateInfo VMStateInfo;
typedef struct VMStateDescription VMStateDescription;

struct VMStateInfo {
    const char *name;
    int (*get)(QEMUFile *f, void *pv, size_t size);
    void (*put)(QEMUFile *f, const void *pv, size_t size);
};

enum VMStateFlags {
    VMS_SINGLE  = 0x001,
    VMS_POINTER = 0x002,
    VMS_ARRAY   = 0x004,
    VMS_STRUCT  = 0x008,
    VMS_VARRAY  = 0x010,  /* Array with size in another field */
    VMS_BUFFER  = 0x020,  /* static sized buffer */
};

typedef struct {
    const char *name;
    size_t offset;
    size_t size;
    int num;
    size_t num_offset;
    const VMStateInfo *info;
    enum VMStateFlags flags;
    const VMStateDescription *vmsd;
    int version_id;
} VMStateField;

struct VMStateDescription {
    const char *name;
    int version_id;
    int minimum_version_id;
    int minimum_version_id_old;
    LoadStateHandler *load_state_old;
    int (*post_load)(void *opaque);
    VMStateField *fields;
};

extern const VMStateInfo vmstate_info_int8;
extern const VMStateInfo vmstate_info_int16;
extern const VMStateInfo vmstate_info_int32;
extern const VMStateInfo vmstate_info_int64;

extern const VMStateInfo vmstate_info_int32_equal;
extern const VMStateInfo vmstate_info_int32_le;

extern const VMStateInfo vmstate_info_uint8;
extern const VMStateInfo vmstate_info_uint16;
extern const VMStateInfo vmstate_info_uint32;
extern const VMStateInfo vmstate_info_uint64;

extern const VMStateInfo vmstate_info_timer;
extern const VMStateInfo vmstate_info_ptimer;
extern const VMStateInfo vmstate_info_buffer;

#define type_check_array(t1,t2,n) ((t1(*)[n])0 - (t2*)0)
#define type_check_pointer(t1,t2) ((t1**)0 - (t2*)0)

#define VMSTATE_SINGLE(_field, _state, _version, _info, _type) {     \
    .name       = (stringify(_field)),                               \
    .version_id = (_version),                                        \
    .size       = sizeof(_type),                                     \
    .info       = &(_info),                                          \
    .flags      = VMS_SINGLE,                                        \
    .offset     = offsetof(_state, _field)                           \
            + type_check(_type,typeof_field(_state, _field))         \
}

#define VMSTATE_POINTER(_field, _state, _version, _info, _type) {    \
    .name       = (stringify(_field)),                               \
    .version_id = (_version),                                        \
    .info       = &(_info),                                          \
    .size       = sizeof(_type),                                     \
    .flags      = VMS_SINGLE|VMS_POINTER,                            \
    .offset     = offsetof(_state, _field)                           \
            + type_check(_type,typeof_field(_state, _field))         \
}

#define VMSTATE_ARRAY(_field, _state, _num, _version, _info, _type) {\
    .name       = (stringify(_field)),                               \
    .version_id = (_version),                                        \
    .num        = (_num),                                            \
    .info       = &(_info),                                          \
    .size       = sizeof(_type),                                     \
    .flags      = VMS_ARRAY,                                         \
    .offset     = offsetof(_state, _field)                           \
        + type_check_array(_type,typeof_field(_state, _field),_num)  \
}

#define VMSTATE_VARRAY(_field, _state, _field_num, _version, _info, _type) {\
    .name       = (stringify(_field)),                               \
    .version_id = (_version),                                        \
    .num_offset = offsetof(_state, _field_num)                       \
        + type_check(int32_t,typeof_field(_state, _field_num)),      \
    .info       = &(_info),                                          \
    .size       = sizeof(_type),                                     \
    .flags      = VMS_VARRAY|VMS_POINTER,                            \
    .offset     = offsetof(_state, _field)                           \
        + type_check_pointer(_type,typeof_field(_state, _field))     \
}

#define VMSTATE_STRUCT(_field, _state, _version, _vmsd, _type) {     \
    .name       = (stringify(_field)),                               \
    .version_id = (_version),                                        \
    .vmsd       = &(_vmsd),                                          \
    .size       = sizeof(_type),                                     \
    .flags      = VMS_STRUCT,                                        \
    .offset     = offsetof(_state, _field)                           \
            + type_check(_type,typeof_field(_state, _field))         \
}

#define VMSTATE_STRUCT_ARRAY(_field, _state, _num, _version, _vmsd, _type) { \
    .name       = (stringify(_field)),                               \
    .num        = (_num),                                            \
    .version_id = (_version),                                        \
    .vmsd       = &(_vmsd),                                          \
    .size       = sizeof(_type),                                     \
    .flags      = VMS_STRUCT|VMS_ARRAY,                              \
    .offset     = offsetof(_state, _field)                           \
        + type_check_array(_type,typeof_field(_state, _field),_num)  \
}

#define VMSTATE_STATIC_BUFFER(_field, _state, _version) {            \
    .name       = (stringify(_field)),                               \
    .version_id = (_version),                                        \
    .size       = sizeof(typeof_field(_state,_field)),               \
    .info       = &vmstate_info_buffer,                              \
    .flags      = VMS_BUFFER,                                        \
    .offset     = offsetof(_state, _field)                           \
        + type_check_array(uint8_t,typeof_field(_state, _field),sizeof(typeof_field(_state,_field))) \
}

extern const VMStateDescription vmstate_pci_device;

#define VMSTATE_PCI_DEVICE(_field, _state) {                         \
    .name       = (stringify(_field)),                               \
    .size       = sizeof(PCIDevice),                                 \
    .vmsd       = &vmstate_pci_device,                               \
    .flags      = VMS_STRUCT,                                        \
    .offset     = offsetof(_state, _field)                           \
            + type_check(PCIDevice,typeof_field(_state, _field))     \
}

/* _f : field name
   _f_n : num of elements field_name
   _n : num of elements
   _s : struct state name
   _v : version
*/

#define VMSTATE_INT8_V(_f, _s, _v)                                    \
    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int8, int8_t)
#define VMSTATE_INT16_V(_f, _s, _v)                                   \
    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int16, int16_t)
#define VMSTATE_INT32_V(_f, _s, _v)                                   \
    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int32, int32_t)
#define VMSTATE_INT64_V(_f, _s, _v)                                   \
    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int64, int64_t)

#define VMSTATE_UINT8_V(_f, _s, _v)                                   \
    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint8, uint8_t)
#define VMSTATE_UINT16_V(_f, _s, _v)                                  \
    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint16, uint16_t)
#define VMSTATE_UINT32_V(_f, _s, _v)                                  \
    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint32, uint32_t)
#define VMSTATE_UINT64_V(_f, _s, _v)                                  \
    VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint64, uint64_t)

#define VMSTATE_INT8(_f, _s)                                          \
    VMSTATE_INT8_V(_f, _s, 0)
#define VMSTATE_INT16(_f, _s)                                         \
    VMSTATE_INT16_V(_f, _s, 0)
#define VMSTATE_INT32(_f, _s)                                         \
    VMSTATE_INT32_V(_f, _s, 0)
#define VMSTATE_INT64(_f, _s)                                         \
    VMSTATE_INT64_V(_f, _s, 0)

#define VMSTATE_UINT8(_f, _s)                                         \
    VMSTATE_UINT8_V(_f, _s, 0)
#define VMSTATE_UINT16(_f, _s)                                        \
    VMSTATE_UINT16_V(_f, _s, 0)
#define VMSTATE_UINT32(_f, _s)                                        \
    VMSTATE_UINT32_V(_f, _s, 0)
#define VMSTATE_UINT64(_f, _s)                                        \
    VMSTATE_UINT64_V(_f, _s, 0)

#define VMSTATE_INT32_EQUAL(_f, _s)                                   \
    VMSTATE_SINGLE(_f, _s, 0, vmstate_info_int32_equal, int32_t)

#define VMSTATE_INT32_LE(_f, _s)                                   \
    VMSTATE_SINGLE(_f, _s, 0, vmstate_info_int32_le, int32_t)

#define VMSTATE_TIMER_V(_f, _s, _v)                                   \
    VMSTATE_POINTER(_f, _s, _v, vmstate_info_timer, QEMUTimer *)

#define VMSTATE_TIMER(_f, _s)                                         \
    VMSTATE_TIMER_V(_f, _s, 0)

#define VMSTATE_PTIMER_V(_f, _s, _v)                                  \
    VMSTATE_POINTER(_f, _s, _v, vmstate_info_ptimer, ptimer_state *)

#define VMSTATE_PTIMER(_f, _s)                                        \
    VMSTATE_PTIMER_V(_f, _s, 0)

#define VMSTATE_UINT32_ARRAY_V(_f, _s, _n, _v)                        \
    VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint32, uint32_t)

#define VMSTATE_UINT32_ARRAY(_f, _s, _n)                              \
    VMSTATE_UINT32_ARRAY_V(_f, _s, _n, 0)

#define VMSTATE_INT32_ARRAY_V(_f, _s, _n, _v)                         \
    VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int32, int32_t)

#define VMSTATE_INT32_ARRAY(_f, _s, _n)                               \
    VMSTATE_INT32_ARRAY_V(_f, _s, _n, 0)

#define VMSTATE_INT32_VARRAY_V(_f, _s, _f_n, _v)                      \
    VMSTATE_VARRAY(_f, _s, _f_n, _v, vmstate_info_int32, int32_t)

#define VMSTATE_INT32_VARRAY(_f, _s, _f_n)                            \
    VMSTATE_INT32_VARRAY_V(_f, _s, _f_n, 0)

#define VMSTATE_BUFFER_V(_f, _s, _v)                                  \
    VMSTATE_STATIC_BUFFER(_f, _s, _v)

#define VMSTATE_BUFFER(_f, _s)                                        \
    VMSTATE_STATIC_BUFFER(_f, _s, 0)

#define VMSTATE_END_OF_LIST()                                         \
    {}

extern int vmstate_load_state(QEMUFile *f, const VMStateDescription *vmsd,
                              void *opaque, int version_id);
extern void vmstate_save_state(QEMUFile *f, const VMStateDescription *vmsd,
                               const void *opaque);
extern int vmstate_register(int instance_id, const VMStateDescription *vmsd,
                            void *base);
void vmstate_unregister(const VMStateDescription *vmsd, void *opaque);
#endif
Commit	Line	Data
87ecb68b PB	1	/* Declarations for use by hardware emulation. */
	2	#ifndef QEMU_HW_H
	3	#define QEMU_HW_H
	4
	5	#include "qemu-common.h"
1ad2134f PB	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
32993977	13	#include "ioport.h"
87ecb68b PB	14	#include "irq.h"
	15
	16	/* VM Load/Save */
	17
5dafc53f AL	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	*/
871d2f07 AL	22	typedef int (QEMUFilePutBufferFunc)(void opaque, const uint8_t buf,
871d2f07 AL	23	int64_t pos, int size);
5dafc53f AL	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
19629537 GC	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
5dafc53f AL	46	QEMUFile qemu_fopen_ops(void opaque, QEMUFilePutBufferFunc *put_buffer,
	47	QEMUFileGetBufferFunc *get_buffer,
	48	QEMUFileCloseFunc *close,
19629537 GC	49	QEMUFileRateLimit *rate_limit,
19629537 GC	50	QEMUFileSetRateLimit *set_rate_limit);
87ecb68b	51	QEMUFile qemu_fopen(const char filename, const char *mode);
5ac1fad3	52	QEMUFile qemu_fdopen(int fd, const char mode);
c1d36665	53	QEMUFile *qemu_fopen_socket(int fd);
065e2813 AL	54	QEMUFile qemu_popen(FILE popen_file, const char *mode);
065e2813 AL	55	QEMUFile qemu_popen_cmd(const char command, const char *mode);
7f79dd28	56	int qemu_stdio_fd(QEMUFile *f);
87ecb68b	57	void qemu_fflush(QEMUFile *f);
5dafc53f	58	int qemu_fclose(QEMUFile *f);
2ca83a8d BS	59	void qemu_put_buffer(QEMUFile f, const uint8_t buf, int size);
2ca83a8d BS	60	void qemu_put_byte(QEMUFile *f, int v);
b6c4f71f BS	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
2ca83a8d BS	69	void qemu_put_be16(QEMUFile *f, unsigned int v);
2ca83a8d BS	70	void qemu_put_be32(QEMUFile *f, unsigned int v);
87ecb68b	71	void qemu_put_be64(QEMUFile *f, uint64_t v);
2ca83a8d BS	72	int qemu_get_buffer(QEMUFile f, uint8_t buf, int size);
2ca83a8d BS	73	int qemu_get_byte(QEMUFile *f);
b6c4f71f BS	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
2ca83a8d BS	82	unsigned int qemu_get_be16(QEMUFile *f);
2ca83a8d BS	83	unsigned int qemu_get_be32(QEMUFile *f);
87ecb68b	84	uint64_t qemu_get_be64(QEMUFile *f);
5dafc53f	85	int qemu_file_rate_limit(QEMUFile *f);
19629537	86	size_t qemu_file_set_rate_limit(QEMUFile *f, size_t new_rate);
871d2f07	87	int qemu_file_has_error(QEMUFile *f);
4dabe248	88	void qemu_file_set_error(QEMUFile *f);
5dafc53f AL	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);
87ecb68b PB	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
b6c4f71f BS	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
87ecb68b PB	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
b6c4f71f BS	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
87ecb68b PB	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
b6c4f71f BS	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
87ecb68b PB	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);
9366f418	242	typedef int SaveLiveStateHandler(QEMUFile f, int stage, void opaque);
87ecb68b PB	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
9366f418 AL	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
41bd13af AL	260	void unregister_savevm(const char idstr, void opaque);
41bd13af AL	261
87ecb68b PB	262	typedef void QEMUResetHandler(void *opaque);
87ecb68b PB	263
a08d4367	264	void qemu_register_reset(QEMUResetHandler func, void opaque);
dda9b29f	265	void qemu_unregister_reset(QEMUResetHandler func, void opaque);
87ecb68b	266
76e30d0f	267	/* handler to set the boot_device order for a specific type of QEMUMachine */
0ecdffbb	268	/* return 0 if success */
76e30d0f	269	typedef int QEMUBootSetHandler(void opaque, const char boot_devices);
3b4366de	270	void qemu_register_boot_set(QEMUBootSetHandler func, void opaque);
76e30d0f	271	int qemu_boot_set(const char *boot_devices);
0ecdffbb	272
9ed7d6ae JQ	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,
dde0463b	284	VMS_POINTER = 0x002,
f752a6aa	285	VMS_ARRAY = 0x004,
ec245e21	286	VMS_STRUCT = 0x008,
b00319a9	287	VMS_VARRAY = 0x010, /* Array with size in another field */
6f67c50f	288	VMS_BUFFER = 0x020, /* static sized buffer */
9ed7d6ae JQ	289	};
	290
	291	typedef struct {
	292	const char *name;
	293	size_t offset;
	294	size_t size;
f752a6aa	295	int num;
b00319a9	296	size_t num_offset;
9ed7d6ae JQ	297	const VMStateInfo *info;
9ed7d6ae JQ	298	enum VMStateFlags flags;
ec245e21	299	const VMStateDescription *vmsd;
9ed7d6ae JQ	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;
752ff2fa	309	int (post_load)(void opaque);
9ed7d6ae JQ	310	VMStateField *fields;
	311	};
	312
	313	extern const VMStateInfo vmstate_info_int8;
	314	extern const VMStateInfo vmstate_info_int16;
	315	extern const VMStateInfo vmstate_info_int32;
	316	extern const VMStateInfo vmstate_info_int64;
	317
82501660	318	extern const VMStateInfo vmstate_info_int32_equal;
0a031e0a	319	extern const VMStateInfo vmstate_info_int32_le;
82501660	320
9ed7d6ae JQ	321	extern const VMStateInfo vmstate_info_uint8;
	322	extern const VMStateInfo vmstate_info_uint16;
	323	extern const VMStateInfo vmstate_info_uint32;
	324	extern const VMStateInfo vmstate_info_uint64;
	325
dde0463b	326	extern const VMStateInfo vmstate_info_timer;
55a6e51f	327	extern const VMStateInfo vmstate_info_ptimer;
6f67c50f	328	extern const VMStateInfo vmstate_info_buffer;
dde0463b	329
f752a6aa	330	#define type_check_array(t1,t2,n) ((t1()[n])0 - (t2)0)
b00319a9	331	#define type_check_pointer(t1,t2) ((t1*)0 - (t2)0)
f752a6aa	332
9ed7d6ae JQ	333	#define VMSTATE_SINGLE(_field, _state, _version, _info, _type) { \
	334	.name = (stringify(_field)), \
	335	.version_id = (_version), \
	336	.size = sizeof(_type), \
	337	.info = &(_info), \
	338	.flags = VMS_SINGLE, \
	339	.offset = offsetof(_state, _field) \
	340	+ type_check(_type,typeof_field(_state, _field)) \
	341	}
	342
dde0463b JQ	343	#define VMSTATE_POINTER(_field, _state, _version, _info, _type) { \
	344	.name = (stringify(_field)), \
	345	.version_id = (_version), \
	346	.info = &(_info), \
	347	.size = sizeof(_type), \
	348	.flags = VMS_SINGLE\|VMS_POINTER, \
	349	.offset = offsetof(_state, _field) \
	350	+ type_check(_type,typeof_field(_state, _field)) \
	351	}
	352
f752a6aa JQ	353	#define VMSTATE_ARRAY(_field, _state, _num, _version, _info, _type) {\
	354	.name = (stringify(_field)), \
	355	.version_id = (_version), \
	356	.num = (_num), \
	357	.info = &(_info), \
	358	.size = sizeof(_type), \
	359	.flags = VMS_ARRAY, \
	360	.offset = offsetof(_state, _field) \
	361	+ type_check_array(_type,typeof_field(_state, _field),_num) \
	362	}
	363
b00319a9 JQ	364	#define VMSTATE_VARRAY(_field, _state, _field_num, _version, _info, _type) {\
	365	.name = (stringify(_field)), \
	366	.version_id = (_version), \
	367	.num_offset = offsetof(_state, _field_num) \
	368	+ type_check(int32_t,typeof_field(_state, _field_num)), \
	369	.info = &(_info), \
	370	.size = sizeof(_type), \
	371	.flags = VMS_VARRAY\|VMS_POINTER, \
	372	.offset = offsetof(_state, _field) \
	373	+ type_check_pointer(_type,typeof_field(_state, _field)) \
	374	}
	375
ec245e21 JQ	376	#define VMSTATE_STRUCT(_field, _state, _version, _vmsd, _type) { \
	377	.name = (stringify(_field)), \
	378	.version_id = (_version), \
	379	.vmsd = &(_vmsd), \
	380	.size = sizeof(_type), \
	381	.flags = VMS_STRUCT, \
	382	.offset = offsetof(_state, _field) \
	383	+ type_check(_type,typeof_field(_state, _field)) \
	384	}
	385
79c451b9 JQ	386	#define VMSTATE_STRUCT_ARRAY(_field, _state, _num, _version, _vmsd, _type) { \
	387	.name = (stringify(_field)), \
	388	.num = (_num), \
	389	.version_id = (_version), \
	390	.vmsd = &(_vmsd), \
	391	.size = sizeof(_type), \
	392	.flags = VMS_STRUCT\|VMS_ARRAY, \
	393	.offset = offsetof(_state, _field) \
	394	+ type_check_array(_type,typeof_field(_state, _field),_num) \
	395	}
	396
6f67c50f JQ	397	#define VMSTATE_STATIC_BUFFER(_field, _state, _version) { \
	398	.name = (stringify(_field)), \
	399	.version_id = (_version), \
	400	.size = sizeof(typeof_field(_state,_field)), \
	401	.info = &vmstate_info_buffer, \
	402	.flags = VMS_BUFFER, \
	403	.offset = offsetof(_state, _field) \
	404	+ type_check_array(uint8_t,typeof_field(_state, _field),sizeof(typeof_field(_state,_field))) \
	405	}
	406
73534f2f JQ	407	extern const VMStateDescription vmstate_pci_device;
	408
	409	#define VMSTATE_PCI_DEVICE(_field, _state) { \
	410	.name = (stringify(_field)), \
73534f2f JQ	411	.size = sizeof(PCIDevice), \
	412	.vmsd = &vmstate_pci_device, \
	413	.flags = VMS_STRUCT, \
	414	.offset = offsetof(_state, _field) \
	415	+ type_check(PCIDevice,typeof_field(_state, _field)) \
	416	}
	417
9ed7d6ae	418	/* _f : field name
b00319a9	419	_f_n : num of elements field_name
f752a6aa	420	_n : num of elements
9ed7d6ae JQ	421	_s : struct state name
	422	_v : version
	423	*/
	424
	425	#define VMSTATE_INT8_V(_f, _s, _v) \
	426	VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int8, int8_t)
	427	#define VMSTATE_INT16_V(_f, _s, _v) \
	428	VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int16, int16_t)
	429	#define VMSTATE_INT32_V(_f, _s, _v) \
	430	VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int32, int32_t)
	431	#define VMSTATE_INT64_V(_f, _s, _v) \
	432	VMSTATE_SINGLE(_f, _s, _v, vmstate_info_int64, int64_t)
	433
	434	#define VMSTATE_UINT8_V(_f, _s, _v) \
	435	VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint8, uint8_t)
	436	#define VMSTATE_UINT16_V(_f, _s, _v) \
	437	VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint16, uint16_t)
	438	#define VMSTATE_UINT32_V(_f, _s, _v) \
	439	VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint32, uint32_t)
	440	#define VMSTATE_UINT64_V(_f, _s, _v) \
	441	VMSTATE_SINGLE(_f, _s, _v, vmstate_info_uint64, uint64_t)
	442
	443	#define VMSTATE_INT8(_f, _s) \
	444	VMSTATE_INT8_V(_f, _s, 0)
	445	#define VMSTATE_INT16(_f, _s) \
	446	VMSTATE_INT16_V(_f, _s, 0)
	447	#define VMSTATE_INT32(_f, _s) \
	448	VMSTATE_INT32_V(_f, _s, 0)
	449	#define VMSTATE_INT64(_f, _s) \
	450	VMSTATE_INT64_V(_f, _s, 0)
	451
	452	#define VMSTATE_UINT8(_f, _s) \
	453	VMSTATE_UINT8_V(_f, _s, 0)
	454	#define VMSTATE_UINT16(_f, _s) \
	455	VMSTATE_UINT16_V(_f, _s, 0)
	456	#define VMSTATE_UINT32(_f, _s) \
	457	VMSTATE_UINT32_V(_f, _s, 0)
	458	#define VMSTATE_UINT64(_f, _s) \
	459	VMSTATE_UINT64_V(_f, _s, 0)
	460
82501660 JQ	461	#define VMSTATE_INT32_EQUAL(_f, _s) \
	462	VMSTATE_SINGLE(_f, _s, 0, vmstate_info_int32_equal, int32_t)
	463
0a031e0a JQ	464	#define VMSTATE_INT32_LE(_f, _s) \
	465	VMSTATE_SINGLE(_f, _s, 0, vmstate_info_int32_le, int32_t)
	466
dde0463b JQ	467	#define VMSTATE_TIMER_V(_f, _s, _v) \
	468	VMSTATE_POINTER(_f, _s, _v, vmstate_info_timer, QEMUTimer *)
	469
	470	#define VMSTATE_TIMER(_f, _s) \
	471	VMSTATE_TIMER_V(_f, _s, 0)
	472
55a6e51f BS	473	#define VMSTATE_PTIMER_V(_f, _s, _v) \
	474	VMSTATE_POINTER(_f, _s, _v, vmstate_info_ptimer, ptimer_state *)
	475
	476	#define VMSTATE_PTIMER(_f, _s) \
	477	VMSTATE_PTIMER_V(_f, _s, 0)
	478
f752a6aa JQ	479	#define VMSTATE_UINT32_ARRAY_V(_f, _s, _n, _v) \
	480	VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_uint32, uint32_t)
	481
	482	#define VMSTATE_UINT32_ARRAY(_f, _s, _n) \
	483	VMSTATE_UINT32_ARRAY_V(_f, _s, _n, 0)
	484
	485	#define VMSTATE_INT32_ARRAY_V(_f, _s, _n, _v) \
	486	VMSTATE_ARRAY(_f, _s, _n, _v, vmstate_info_int32, int32_t)
	487
	488	#define VMSTATE_INT32_ARRAY(_f, _s, _n) \
	489	VMSTATE_INT32_ARRAY_V(_f, _s, _n, 0)
	490
b00319a9 JQ	491	#define VMSTATE_INT32_VARRAY_V(_f, _s, _f_n, _v) \
	492	VMSTATE_VARRAY(_f, _s, _f_n, _v, vmstate_info_int32, int32_t)
	493
	494	#define VMSTATE_INT32_VARRAY(_f, _s, _f_n) \
	495	VMSTATE_INT32_VARRAY_V(_f, _s, _f_n, 0)
	496
6f67c50f JQ	497	#define VMSTATE_BUFFER_V(_f, _s, _v) \
	498	VMSTATE_STATIC_BUFFER(_f, _s, _v)
	499
	500	#define VMSTATE_BUFFER(_f, _s) \
	501	VMSTATE_STATIC_BUFFER(_f, _s, 0)
	502
9ed7d6ae JQ	503	#define VMSTATE_END_OF_LIST() \
	504	{}
	505
	506	extern int vmstate_load_state(QEMUFile f, const VMStateDescription vmsd,
	507	void *opaque, int version_id);
	508	extern void vmstate_save_state(QEMUFile f, const VMStateDescription vmsd,
	509	const void *opaque);
	510	extern int vmstate_register(int instance_id, const VMStateDescription *vmsd,
	511	void *base);
1eb7538b	512	void vmstate_unregister(const VMStateDescription vmsd, void opaque);
87ecb68b	513	#endif