[qemu.git] / qemu-common.h

/* Common header file that is included by all of qemu.  */
#ifndef QEMU_COMMON_H
#define QEMU_COMMON_H

#include "config-host.h"

#define QEMU_NORETURN __attribute__ ((__noreturn__))
#ifdef CONFIG_GCC_ATTRIBUTE_WARN_UNUSED_RESULT
#define QEMU_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
#else
#define QEMU_WARN_UNUSED_RESULT
#endif

#define QEMU_BUILD_BUG_ON(x) typedef char __build_bug_on__##__LINE__[(x)?-1:1];

/* Hack around the mess dyngen-exec.h causes: We need QEMU_NORETURN in files that
   cannot include the following headers without conflicts. This condition has
   to be removed once dyngen is gone. */
#ifndef __DYNGEN_EXEC_H__

/* we put basic includes here to avoid repeating them in device drivers */
#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include <string.h>
#include <strings.h>
#include <inttypes.h>
#include <limits.h>
#include <time.h>
#include <ctype.h>
#include <errno.h>
#include <unistd.h>
#include <fcntl.h>
#include <sys/stat.h>
#include <assert.h>

#ifndef O_LARGEFILE
#define O_LARGEFILE 0
#endif
#ifndef O_BINARY
#define O_BINARY 0
#endif
#ifndef MAP_ANONYMOUS
#define MAP_ANONYMOUS MAP_ANON
#endif
#ifndef ENOMEDIUM
#define ENOMEDIUM ENODEV
#endif
#if !defined(ENOTSUP)
#define ENOTSUP 4096
#endif

#ifndef CONFIG_IOVEC
#define CONFIG_IOVEC
struct iovec {
    void *iov_base;
    size_t iov_len;
};
/*
 * Use the same value as Linux for now.
 */
#define IOV_MAX		1024
#else
#include <sys/uio.h>
#endif

#ifdef _WIN32
#define fsync _commit
#define lseek _lseeki64
extern int qemu_ftruncate64(int, int64_t);
#define ftruncate qemu_ftruncate64

static inline char *realpath(const char *path, char *resolved_path)
{
    _fullpath(resolved_path, path, _MAX_PATH);
    return resolved_path;
}

#define PRId64 "I64d"
#define PRIx64 "I64x"
#define PRIu64 "I64u"
#define PRIo64 "I64o"
#endif

/* FIXME: Remove NEED_CPU_H.  */
#ifndef NEED_CPU_H

#include <setjmp.h>
#include "osdep.h"
#include "bswap.h"

#else

#include "cpu.h"

#endif /* !defined(NEED_CPU_H) */

/* bottom halves */
typedef struct QEMUBH QEMUBH;

typedef void QEMUBHFunc(void *opaque);

void async_context_push(void);
void async_context_pop(void);
int get_async_context_id(void);

QEMUBH *qemu_bh_new(QEMUBHFunc *cb, void *opaque);
void qemu_bh_schedule(QEMUBH *bh);
/* Bottom halfs that are scheduled from a bottom half handler are instantly
 * invoked.  This can create an infinite loop if a bottom half handler
 * schedules itself.  qemu_bh_schedule_idle() avoids this infinite loop by
 * ensuring that the bottom half isn't executed until the next main loop
 * iteration.
 */
void qemu_bh_schedule_idle(QEMUBH *bh);
void qemu_bh_cancel(QEMUBH *bh);
void qemu_bh_delete(QEMUBH *bh);
int qemu_bh_poll(void);
void qemu_bh_update_timeout(int *timeout);

uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c);

void qemu_get_timedate(struct tm *tm, int offset);
int qemu_timedate_diff(struct tm *tm);

/* cutils.c */
void pstrcpy(char *buf, int buf_size, const char *str);
char *pstrcat(char *buf, int buf_size, const char *s);
int strstart(const char *str, const char *val, const char **ptr);
int stristart(const char *str, const char *val, const char **ptr);
int qemu_strnlen(const char *s, int max_len);
time_t mktimegm(struct tm *tm);
int qemu_fls(int i);
int qemu_fdatasync(int fd);
int fcntl_setfl(int fd, int flag);

/* path.c */
void init_paths(const char *prefix);
const char *path(const char *pathname);

#define qemu_isalnum(c)		isalnum((unsigned char)(c))
#define qemu_isalpha(c)		isalpha((unsigned char)(c))
#define qemu_iscntrl(c)		iscntrl((unsigned char)(c))
#define qemu_isdigit(c)		isdigit((unsigned char)(c))
#define qemu_isgraph(c)		isgraph((unsigned char)(c))
#define qemu_islower(c)		islower((unsigned char)(c))
#define qemu_isprint(c)		isprint((unsigned char)(c))
#define qemu_ispunct(c)		ispunct((unsigned char)(c))
#define qemu_isspace(c)		isspace((unsigned char)(c))
#define qemu_isupper(c)		isupper((unsigned char)(c))
#define qemu_isxdigit(c)	isxdigit((unsigned char)(c))
#define qemu_tolower(c)		tolower((unsigned char)(c))
#define qemu_toupper(c)		toupper((unsigned char)(c))
#define qemu_isascii(c)		isascii((unsigned char)(c))
#define qemu_toascii(c)		toascii((unsigned char)(c))

void *qemu_malloc(size_t size);
void *qemu_realloc(void *ptr, size_t size);
void *qemu_mallocz(size_t size);
void qemu_free(void *ptr);
char *qemu_strdup(const char *str);
char *qemu_strndup(const char *str, size_t size);

void *get_mmap_addr(unsigned long size);


void qemu_mutex_lock_iothread(void);
void qemu_mutex_unlock_iothread(void);

int qemu_open(const char *name, int flags, ...);
ssize_t qemu_write_full(int fd, const void *buf, size_t count)
    QEMU_WARN_UNUSED_RESULT;
void qemu_set_cloexec(int fd);

#ifndef _WIN32
int qemu_eventfd(int pipefd[2]);
int qemu_pipe(int pipefd[2]);
#endif

/* Error handling.  */

void QEMU_NORETURN hw_error(const char *fmt, ...)
    __attribute__ ((__format__ (__printf__, 1, 2)));

/* IO callbacks.  */
typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size);
typedef int IOCanReadHandler(void *opaque);
typedef void IOHandler(void *opaque);

struct ParallelIOArg {
    void *buffer;
    int count;
};

typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);

/* A load of opaque types so that device init declarations don't have to
   pull in all the real definitions.  */
typedef struct NICInfo NICInfo;
typedef struct HCIInfo HCIInfo;
typedef struct AudioState AudioState;
typedef struct BlockDriverState BlockDriverState;
typedef struct DisplayState DisplayState;
typedef struct DisplayChangeListener DisplayChangeListener;
typedef struct DisplaySurface DisplaySurface;
typedef struct DisplayAllocator DisplayAllocator;
typedef struct PixelFormat PixelFormat;
typedef struct TextConsole TextConsole;
typedef TextConsole QEMUConsole;
typedef struct CharDriverState CharDriverState;
typedef struct MACAddr MACAddr;
typedef struct VLANState VLANState;
typedef struct VLANClientState VLANClientState;
typedef struct QEMUFile QEMUFile;
typedef struct i2c_bus i2c_bus;
typedef struct i2c_slave i2c_slave;
typedef struct SMBusDevice SMBusDevice;
typedef struct QEMUTimer QEMUTimer;
typedef struct PCIHostState PCIHostState;
typedef struct PCIExpressHost PCIExpressHost;
typedef struct PCIBus PCIBus;
typedef struct PCIDevice PCIDevice;
typedef struct SerialState SerialState;
typedef struct IRQState *qemu_irq;
typedef struct PCMCIACardState PCMCIACardState;
typedef struct MouseTransformInfo MouseTransformInfo;
typedef struct uWireSlave uWireSlave;
typedef struct I2SCodec I2SCodec;
typedef struct DeviceState DeviceState;
typedef struct SSIBus SSIBus;

typedef uint64_t pcibus_t;

void cpu_exec_init_all(unsigned long tb_size);

/* CPU save/load.  */
void cpu_save(QEMUFile *f, void *opaque);
int cpu_load(QEMUFile *f, void *opaque, int version_id);

/* Force QEMU to stop what it's doing and service IO */
void qemu_service_io(void);

/* Force QEMU to process pending events */
void qemu_notify_event(void);

/* Unblock cpu */
void qemu_cpu_kick(void *env);
int qemu_cpu_self(void *env);

#ifdef CONFIG_USER_ONLY
#define qemu_init_vcpu(env) do { } while (0)
#else
void qemu_init_vcpu(void *env);
#endif

typedef struct QEMUIOVector {
    struct iovec *iov;
    int niov;
    int nalloc;
    size_t size;
} QEMUIOVector;

void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
void qemu_iovec_concat(QEMUIOVector *dst, QEMUIOVector *src, size_t size);
void qemu_iovec_destroy(QEMUIOVector *qiov);
void qemu_iovec_reset(QEMUIOVector *qiov);
void qemu_iovec_to_buffer(QEMUIOVector *qiov, void *buf);
void qemu_iovec_from_buffer(QEMUIOVector *qiov, const void *buf, size_t count);

struct Monitor;
typedef struct Monitor Monitor;

/* Convert a byte between binary and BCD.  */
static inline uint8_t to_bcd(uint8_t val)
{
    return ((val / 10) << 4) | (val % 10);
}

static inline uint8_t from_bcd(uint8_t val)
{
    return ((val >> 4) * 10) + (val & 0x0f);
}

#include "module.h"

#endif /* dyngen-exec.h hack */

#endif
Commit	Line	Data
	1	/* Common header file that is included by all of qemu. */
	2	#ifndef QEMU_COMMON_H
	3	#define QEMU_COMMON_H
	4
	5	#include "config-host.h"
	6
	7	#define QEMU_NORETURN __attribute__ ((__noreturn__))
	8	#ifdef CONFIG_GCC_ATTRIBUTE_WARN_UNUSED_RESULT
	9	#define QEMU_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
	10	#else
	11	#define QEMU_WARN_UNUSED_RESULT
	12	#endif
	13
	14	#define QEMU_BUILD_BUG_ON(x) typedef char __build_bug_on__##__LINE__[(x)?-1:1];
	15
	16	/* Hack around the mess dyngen-exec.h causes: We need QEMU_NORETURN in files that
	17	cannot include the following headers without conflicts. This condition has
	18	to be removed once dyngen is gone. */
	19	#ifndef __DYNGEN_EXEC_H__
	20
	21	/* we put basic includes here to avoid repeating them in device drivers */
	22	#include <stdlib.h>
	23	#include <stdio.h>
	24	#include <stdarg.h>
	25	#include <string.h>
	26	#include <strings.h>
	27	#include <inttypes.h>
	28	#include <limits.h>
	29	#include <time.h>
	30	#include <ctype.h>
	31	#include <errno.h>
	32	#include <unistd.h>
	33	#include <fcntl.h>
	34	#include <sys/stat.h>
	35	#include <assert.h>
	36
	37	#ifndef O_LARGEFILE
	38	#define O_LARGEFILE 0
	39	#endif
	40	#ifndef O_BINARY
	41	#define O_BINARY 0
	42	#endif
	43	#ifndef MAP_ANONYMOUS
	44	#define MAP_ANONYMOUS MAP_ANON
	45	#endif
	46	#ifndef ENOMEDIUM
	47	#define ENOMEDIUM ENODEV
	48	#endif
	49	#if !defined(ENOTSUP)
	50	#define ENOTSUP 4096
	51	#endif
	52
	53	#ifndef CONFIG_IOVEC
	54	#define CONFIG_IOVEC
	55	struct iovec {
	56	void *iov_base;
	57	size_t iov_len;
	58	};
	59	/*
	60	* Use the same value as Linux for now.
	61	*/
	62	#define IOV_MAX 1024
	63	#else
	64	#include <sys/uio.h>
	65	#endif
	66
	67	#ifdef _WIN32
	68	#define fsync _commit
	69	#define lseek _lseeki64
	70	extern int qemu_ftruncate64(int, int64_t);
	71	#define ftruncate qemu_ftruncate64
	72
	73	static inline char realpath(const char path, char *resolved_path)
	74	{
	75	_fullpath(resolved_path, path, _MAX_PATH);
	76	return resolved_path;
	77	}
	78
	79	#define PRId64 "I64d"
	80	#define PRIx64 "I64x"
	81	#define PRIu64 "I64u"
	82	#define PRIo64 "I64o"
	83	#endif
	84
	85	/* FIXME: Remove NEED_CPU_H. */
	86	#ifndef NEED_CPU_H
	87
	88	#include <setjmp.h>
	89	#include "osdep.h"
	90	#include "bswap.h"
	91
	92	#else
	93
	94	#include "cpu.h"
	95
	96	#endif /* !defined(NEED_CPU_H) */
	97
	98	/* bottom halves */
	99	typedef struct QEMUBH QEMUBH;
	100
	101	typedef void QEMUBHFunc(void *opaque);
	102
	103	void async_context_push(void);
	104	void async_context_pop(void);
	105	int get_async_context_id(void);
	106
	107	QEMUBH qemu_bh_new(QEMUBHFunc cb, void *opaque);
	108	void qemu_bh_schedule(QEMUBH *bh);
	109	/* Bottom halfs that are scheduled from a bottom half handler are instantly
	110	* invoked. This can create an infinite loop if a bottom half handler
	111	* schedules itself. qemu_bh_schedule_idle() avoids this infinite loop by
	112	* ensuring that the bottom half isn't executed until the next main loop
	113	* iteration.
	114	*/
	115	void qemu_bh_schedule_idle(QEMUBH *bh);
	116	void qemu_bh_cancel(QEMUBH *bh);
	117	void qemu_bh_delete(QEMUBH *bh);
	118	int qemu_bh_poll(void);
	119	void qemu_bh_update_timeout(int *timeout);
	120
	121	uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c);
	122
	123	void qemu_get_timedate(struct tm *tm, int offset);
	124	int qemu_timedate_diff(struct tm *tm);
	125
	126	/* cutils.c */
	127	void pstrcpy(char buf, int buf_size, const char str);
	128	char pstrcat(char buf, int buf_size, const char *s);
	129	int strstart(const char str, const char val, const char **ptr);
	130	int stristart(const char str, const char val, const char **ptr);
	131	int qemu_strnlen(const char *s, int max_len);
	132	time_t mktimegm(struct tm *tm);
	133	int qemu_fls(int i);
	134	int qemu_fdatasync(int fd);
	135	int fcntl_setfl(int fd, int flag);
	136
	137	/* path.c */
	138	void init_paths(const char *prefix);
	139	const char path(const char pathname);
	140
	141	#define qemu_isalnum(c) isalnum((unsigned char)(c))
	142	#define qemu_isalpha(c) isalpha((unsigned char)(c))
	143	#define qemu_iscntrl(c) iscntrl((unsigned char)(c))
	144	#define qemu_isdigit(c) isdigit((unsigned char)(c))
	145	#define qemu_isgraph(c) isgraph((unsigned char)(c))
	146	#define qemu_islower(c) islower((unsigned char)(c))
	147	#define qemu_isprint(c) isprint((unsigned char)(c))
	148	#define qemu_ispunct(c) ispunct((unsigned char)(c))
	149	#define qemu_isspace(c) isspace((unsigned char)(c))
	150	#define qemu_isupper(c) isupper((unsigned char)(c))
	151	#define qemu_isxdigit(c) isxdigit((unsigned char)(c))
	152	#define qemu_tolower(c) tolower((unsigned char)(c))
	153	#define qemu_toupper(c) toupper((unsigned char)(c))
	154	#define qemu_isascii(c) isascii((unsigned char)(c))
	155	#define qemu_toascii(c) toascii((unsigned char)(c))
	156
	157	void *qemu_malloc(size_t size);
	158	void qemu_realloc(void ptr, size_t size);
	159	void *qemu_mallocz(size_t size);
	160	void qemu_free(void *ptr);
	161	char qemu_strdup(const char str);
	162	char qemu_strndup(const char str, size_t size);
	163
	164	void *get_mmap_addr(unsigned long size);
	165
	166
	167	void qemu_mutex_lock_iothread(void);
	168	void qemu_mutex_unlock_iothread(void);
	169
	170	int qemu_open(const char *name, int flags, ...);
	171	ssize_t qemu_write_full(int fd, const void *buf, size_t count)
	172	QEMU_WARN_UNUSED_RESULT;
	173	void qemu_set_cloexec(int fd);
	174
	175	#ifndef _WIN32
	176	int qemu_eventfd(int pipefd[2]);
	177	int qemu_pipe(int pipefd[2]);
	178	#endif
	179
	180	/* Error handling. */
	181
	182	void QEMU_NORETURN hw_error(const char *fmt, ...)
	183	__attribute__ ((__format__ (__printf__, 1, 2)));
	184
	185	/* IO callbacks. */
	186	typedef void IOReadHandler(void opaque, const uint8_t buf, int size);
	187	typedef int IOCanReadHandler(void *opaque);
	188	typedef void IOHandler(void *opaque);
	189
	190	struct ParallelIOArg {
	191	void *buffer;
	192	int count;
	193	};
	194
	195	typedef int (DMA_transfer_handler) (void opaque, int nchan, int pos, int size);
	196
	197	/* A load of opaque types so that device init declarations don't have to
	198	pull in all the real definitions. */
	199	typedef struct NICInfo NICInfo;
	200	typedef struct HCIInfo HCIInfo;
	201	typedef struct AudioState AudioState;
	202	typedef struct BlockDriverState BlockDriverState;
	203	typedef struct DisplayState DisplayState;
	204	typedef struct DisplayChangeListener DisplayChangeListener;
	205	typedef struct DisplaySurface DisplaySurface;
	206	typedef struct DisplayAllocator DisplayAllocator;
	207	typedef struct PixelFormat PixelFormat;
	208	typedef struct TextConsole TextConsole;
	209	typedef TextConsole QEMUConsole;
	210	typedef struct CharDriverState CharDriverState;
	211	typedef struct MACAddr MACAddr;
	212	typedef struct VLANState VLANState;
	213	typedef struct VLANClientState VLANClientState;
	214	typedef struct QEMUFile QEMUFile;
	215	typedef struct i2c_bus i2c_bus;
	216	typedef struct i2c_slave i2c_slave;
	217	typedef struct SMBusDevice SMBusDevice;
	218	typedef struct QEMUTimer QEMUTimer;
	219	typedef struct PCIHostState PCIHostState;
	220	typedef struct PCIExpressHost PCIExpressHost;
	221	typedef struct PCIBus PCIBus;
	222	typedef struct PCIDevice PCIDevice;
	223	typedef struct SerialState SerialState;
	224	typedef struct IRQState *qemu_irq;
	225	typedef struct PCMCIACardState PCMCIACardState;
	226	typedef struct MouseTransformInfo MouseTransformInfo;
	227	typedef struct uWireSlave uWireSlave;
	228	typedef struct I2SCodec I2SCodec;
	229	typedef struct DeviceState DeviceState;
	230	typedef struct SSIBus SSIBus;
	231
	232	typedef uint64_t pcibus_t;
	233
	234	void cpu_exec_init_all(unsigned long tb_size);
	235
	236	/* CPU save/load. */
	237	void cpu_save(QEMUFile f, void opaque);
	238	int cpu_load(QEMUFile f, void opaque, int version_id);
	239
	240	/* Force QEMU to stop what it's doing and service IO */
	241	void qemu_service_io(void);
	242
	243	/* Force QEMU to process pending events */
	244	void qemu_notify_event(void);
	245
	246	/* Unblock cpu */
	247	void qemu_cpu_kick(void *env);
	248	int qemu_cpu_self(void *env);
	249
	250	#ifdef CONFIG_USER_ONLY
	251	#define qemu_init_vcpu(env) do { } while (0)
	252	#else
	253	void qemu_init_vcpu(void *env);
	254	#endif
	255
	256	typedef struct QEMUIOVector {
	257	struct iovec *iov;
	258	int niov;
	259	int nalloc;
	260	size_t size;
	261	} QEMUIOVector;
	262
	263	void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
	264	void qemu_iovec_init_external(QEMUIOVector qiov, struct iovec iov, int niov);
	265	void qemu_iovec_add(QEMUIOVector qiov, void base, size_t len);
	266	void qemu_iovec_concat(QEMUIOVector dst, QEMUIOVector src, size_t size);
	267	void qemu_iovec_destroy(QEMUIOVector *qiov);
	268	void qemu_iovec_reset(QEMUIOVector *qiov);
	269	void qemu_iovec_to_buffer(QEMUIOVector qiov, void buf);
	270	void qemu_iovec_from_buffer(QEMUIOVector qiov, const void buf, size_t count);
	271
	272	struct Monitor;
	273	typedef struct Monitor Monitor;
	274
	275	/* Convert a byte between binary and BCD. */
	276	static inline uint8_t to_bcd(uint8_t val)
	277	{
	278	return ((val / 10) << 4) \| (val % 10);
	279	}
	280
	281	static inline uint8_t from_bcd(uint8_t val)
	282	{
	283	return ((val >> 4) * 10) + (val & 0x0f);
	284	}
	285
	286	#include "module.h"
	287
	288	#endif /* dyngen-exec.h hack */
	289
	290	#endif