[qemu.git] / qemu-common.h


/* Common header file that is included by all of QEMU.
 *
 * This file is supposed to be included only by .c files. No header file should
 * depend on qemu-common.h, as this would easily lead to circular header
 * dependencies.
 *
 * If a header file uses a definition from qemu-common.h, that definition
 * must be moved to a separate header file, and the header that uses it
 * must include that header.
 */
#ifndef QEMU_COMMON_H
#define QEMU_COMMON_H

#include "compiler.h"
#include "config-host.h"

#if defined(__arm__) || defined(__sparc__) || defined(__mips__) || defined(__hppa__) || defined(__ia64__)
#define WORDS_ALIGNED
#endif

#define TFR(expr) do { if ((expr) != -1) break; } while (errno == EINTR)

typedef struct QEMUTimer QEMUTimer;
typedef struct QEMUFile QEMUFile;
typedef struct QEMUBH QEMUBH;
typedef struct DeviceState DeviceState;

struct Monitor;
typedef struct Monitor Monitor;
typedef struct MigrationParams MigrationParams;

/* we put basic includes here to avoid repeating them in device drivers */
#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include <stdbool.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 <sys/time.h>
#include <assert.h>
#include <signal.h>
#include <glib.h>

#ifdef _WIN32
#include "qemu-os-win32.h"
#endif

#ifdef CONFIG_POSIX
#include "qemu-os-posix.h"
#endif

#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
#if !defined(ECANCELED)
#define ECANCELED 4097
#endif
#ifndef TIME_MAX
#define TIME_MAX LONG_MAX
#endif

/* HOST_LONG_BITS is the size of a native pointer in bits. */
#if UINTPTR_MAX == UINT32_MAX
# define HOST_LONG_BITS 32
#elif UINTPTR_MAX == UINT64_MAX
# define HOST_LONG_BITS 64
#else
# error Unknown pointer size
#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

typedef int (*fprintf_function)(FILE *f, const char *fmt, ...)
    GCC_FMT_ATTR(2, 3);

#ifdef _WIN32
#define fsync _commit
#if !defined(lseek)
# define lseek _lseeki64
#endif
int qemu_ftruncate64(int, int64_t);
#if !defined(ftruncate)
# define ftruncate qemu_ftruncate64
#endif

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

/* icount */
void configure_icount(const char *option);
extern int use_icount;

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

#include "osdep.h"
#include "bswap.h"

#else

#include "cpu.h"

#endif /* !defined(NEED_CPU_H) */

/* main function, renamed */
#if defined(CONFIG_COCOA)
int qemu_main(int argc, char **argv, char **envp);
#endif

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

/**
 * is_help_option:
 * @s: string to test
 *
 * Check whether @s is one of the standard strings which indicate
 * that the user is asking for a list of the valid values for a
 * command option like -cpu or -M. The current accepted strings
 * are 'help' and '?'. '?' is deprecated (it is a shell wildcard
 * which makes it annoying to use in a reliable way) but provided
 * for backwards compatibility.
 *
 * Returns: true if @s is a request for a list.
 */
static inline bool is_help_option(const char *s)
{
    return !strcmp(s, "?") || !strcmp(s, "help");
}

/* cutils.c */
void pstrcpy(char *buf, int buf_size, const char *str);
void strpadcpy(char *buf, int buf_size, const char *str, char pad);
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);
int qemu_parse_fd(const char *param);

/*
 * strtosz() suffixes used to specify the default treatment of an
 * argument passed to strtosz() without an explicit suffix.
 * These should be defined using upper case characters in the range
 * A-Z, as strtosz() will use qemu_toupper() on the given argument
 * prior to comparison.
 */
#define STRTOSZ_DEFSUFFIX_TB	'T'
#define STRTOSZ_DEFSUFFIX_GB	'G'
#define STRTOSZ_DEFSUFFIX_MB	'M'
#define STRTOSZ_DEFSUFFIX_KB	'K'
#define STRTOSZ_DEFSUFFIX_B	'B'
int64_t strtosz(const char *nptr, char **end);
int64_t strtosz_suffix(const char *nptr, char **end, const char default_suffix);
int64_t strtosz_suffix_unit(const char *nptr, char **end,
                            const char default_suffix, int64_t unit);

/* 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_oom_check(void *ptr);

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

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

#ifdef _WIN32
/* MinGW needs type casts for the 'buf' and 'optval' arguments. */
#define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
    getsockopt(sockfd, level, optname, (void *)optval, optlen)
#define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
    setsockopt(sockfd, level, optname, (const void *)optval, optlen)
#define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags)
#define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
    sendto(sockfd, (const void *)buf, len, flags, destaddr, addrlen)
#else
#define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
    getsockopt(sockfd, level, optname, optval, optlen)
#define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
    setsockopt(sockfd, level, optname, optval, optlen)
#define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags)
#define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
    sendto(sockfd, buf, len, flags, destaddr, addrlen)
#endif

/* Error handling.  */

void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);

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 DriveInfo DriveInfo;
typedef struct DisplayState DisplayState;
typedef struct DisplayChangeListener DisplayChangeListener;
typedef struct DisplaySurface DisplaySurface;
typedef struct PixelFormat PixelFormat;
typedef struct QemuConsole QemuConsole;
typedef struct CharDriverState CharDriverState;
typedef struct MACAddr MACAddr;
typedef struct NetClientState NetClientState;
typedef struct i2c_bus i2c_bus;
typedef struct ISABus ISABus;
typedef struct ISADevice ISADevice;
typedef struct SMBusDevice SMBusDevice;
typedef struct PCIHostState PCIHostState;
typedef struct PCIExpressHost PCIExpressHost;
typedef struct PCIBus PCIBus;
typedef struct PCIDevice PCIDevice;
typedef struct PCIExpressDevice PCIExpressDevice;
typedef struct PCIBridge PCIBridge;
typedef struct PCIEAERMsg PCIEAERMsg;
typedef struct PCIEAERLog PCIEAERLog;
typedef struct PCIEAERErr PCIEAERErr;
typedef struct PCIEPort PCIEPort;
typedef struct PCIESlot PCIESlot;
typedef struct MSIMessage MSIMessage;
typedef struct SerialState SerialState;
typedef struct PCMCIACardState PCMCIACardState;
typedef struct MouseTransformInfo MouseTransformInfo;
typedef struct uWireSlave uWireSlave;
typedef struct I2SCodec I2SCodec;
typedef struct SSIBus SSIBus;
typedef struct EventNotifier EventNotifier;
typedef struct VirtIODevice VirtIODevice;
typedef struct QEMUSGList QEMUSGList;
typedef struct SHPCDevice SHPCDevice;

typedef uint64_t pcibus_t;

typedef enum LostTickPolicy {
    LOST_TICK_DISCARD,
    LOST_TICK_DELAY,
    LOST_TICK_MERGE,
    LOST_TICK_SLEW,
    LOST_TICK_MAX
} LostTickPolicy;

typedef struct PCIHostDeviceAddress {
    unsigned int domain;
    unsigned int bus;
    unsigned int slot;
    unsigned int function;
} PCIHostDeviceAddress;

void tcg_exec_init(unsigned long tb_size);
bool tcg_enabled(void);

void cpu_exec_init_all(void);

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

/* Unblock cpu */
void qemu_cpu_kick_self(void);

/* work queue */
struct qemu_work_item {
    struct qemu_work_item *next;
    void (*func)(void *data);
    void *data;
    int done;
};

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


/**
 * Sends a (part of) iovec down a socket, yielding when the socket is full, or
 * Receives data into a (part of) iovec from a socket,
 * yielding when there is no data in the socket.
 * The same interface as qemu_sendv_recvv(), with added yielding.
 * XXX should mark these as coroutine_fn
 */
ssize_t qemu_co_sendv_recvv(int sockfd, struct iovec *iov, unsigned iov_cnt,
                            size_t offset, size_t bytes, bool do_send);
#define qemu_co_recvv(sockfd, iov, iov_cnt, offset, bytes) \
  qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, false)
#define qemu_co_sendv(sockfd, iov, iov_cnt, offset, bytes) \
  qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, true)

/**
 * The same as above, but with just a single buffer
 */
ssize_t qemu_co_send_recv(int sockfd, void *buf, size_t bytes, bool do_send);
#define qemu_co_recv(sockfd, buf, bytes) \
  qemu_co_send_recv(sockfd, buf, bytes, false)
#define qemu_co_send(sockfd, buf, bytes) \
  qemu_co_send_recv(sockfd, buf, bytes, true)

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 soffset, size_t sbytes);
void qemu_iovec_destroy(QEMUIOVector *qiov);
void qemu_iovec_reset(QEMUIOVector *qiov);
size_t qemu_iovec_to_buf(QEMUIOVector *qiov, size_t offset,
                         void *buf, size_t bytes);
size_t qemu_iovec_from_buf(QEMUIOVector *qiov, size_t offset,
                           const void *buf, size_t bytes);
size_t qemu_iovec_memset(QEMUIOVector *qiov, size_t offset,
                         int fillc, size_t bytes);

bool buffer_is_zero(const void *buf, size_t len);

void qemu_progress_init(int enabled, float min_skip);
void qemu_progress_end(void);
void qemu_progress_print(float delta, int max);
const char *qemu_get_vm_name(void);

#define QEMU_FILE_TYPE_BIOS   0
#define QEMU_FILE_TYPE_KEYMAP 1
char *qemu_find_file(int type, const char *name);

/* OS specific functions */
void os_setup_early_signal_handling(void);
char *os_find_datadir(const char *argv0);
void os_parse_cmd_args(int index, const char *optarg);
void os_pidfile_error(void);

/* 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);
}

/* compute with 96 bit intermediate result: (a*b)/c */
static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
{
    union {
        uint64_t ll;
        struct {
#ifdef HOST_WORDS_BIGENDIAN
            uint32_t high, low;
#else
            uint32_t low, high;
#endif
        } l;
    } u, res;
    uint64_t rl, rh;

    u.ll = a;
    rl = (uint64_t)u.l.low * (uint64_t)b;
    rh = (uint64_t)u.l.high * (uint64_t)b;
    rh += (rl >> 32);
    res.l.high = rh / c;
    res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
    return res.ll;
}

/* Round number down to multiple */
#define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))

/* Round number up to multiple */
#define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))

static inline bool is_power_of_2(uint64_t value)
{
    if (!value) {
        return 0;
    }

    return !(value & (value - 1));
}

/* round down to the nearest power of 2*/
int64_t pow2floor(int64_t value);

#include "module.h"

/*
 * Implementation of ULEB128 (http://en.wikipedia.org/wiki/LEB128)
 * Input is limited to 14-bit numbers
 */

int uleb128_encode_small(uint8_t *out, uint32_t n);
int uleb128_decode_small(const uint8_t *in, uint32_t *n);

#endif
Commit	Line	Data
9fb26641	1
04509ad9 EH	2	/* Common header file that is included by all of QEMU.
	3	*
	4	* This file is supposed to be included only by .c files. No header file should
	5	* depend on qemu-common.h, as this would easily lead to circular header
	6	* dependencies.
	7	*
	8	* If a header file uses a definition from qemu-common.h, that definition
	9	* must be moved to a separate header file, and the header that uses it
	10	* must include that header.
	11	*/
faf07963 PB	12	#ifndef QEMU_COMMON_H
	13	#define QEMU_COMMON_H
	14
5c026320	15	#include "compiler.h"
beb6f0de KW	16	#include "config-host.h"
beb6f0de KW	17
332ae28d PB	18	#if defined(__arm__) \|\| defined(__sparc__) \|\| defined(__mips__) \|\| defined(__hppa__) \|\| defined(__ia64__)
	19	#define WORDS_ALIGNED
	20	#endif
	21
082b5557	22	#define TFR(expr) do { if ((expr) != -1) break; } while (errno == EINTR)
24ebf5f3	23
29e922b6 BS	24	typedef struct QEMUTimer QEMUTimer;
29e922b6 BS	25	typedef struct QEMUFile QEMUFile;
f627aab1	26	typedef struct QEMUBH QEMUBH;
92a16d7a	27	typedef struct DeviceState DeviceState;
29e922b6	28
316378e4 JK	29	struct Monitor;
316378e4 JK	30	typedef struct Monitor Monitor;
6607ae23	31	typedef struct MigrationParams MigrationParams;
316378e4	32
faf07963 PB	33	/* we put basic includes here to avoid repeating them in device drivers */
	34	#include <stdlib.h>
	35	#include <stdio.h>
	36	#include <stdarg.h>
11165820	37	#include <stdbool.h>
faf07963	38	#include <string.h>
c8906845	39	#include <strings.h>
faf07963 PB	40	#include <inttypes.h>
	41	#include <limits.h>
	42	#include <time.h>
	43	#include <ctype.h>
	44	#include <errno.h>
	45	#include <unistd.h>
	46	#include <fcntl.h>
	47	#include <sys/stat.h>
dcfd0865	48	#include <sys/time.h>
55616505	49	#include <assert.h>
86f69a92	50	#include <signal.h>
14015304	51	#include <glib.h>
faf07963	52
082b5557 BS	53	#ifdef _WIN32
	54	#include "qemu-os-win32.h"
	55	#endif
	56
	57	#ifdef CONFIG_POSIX
	58	#include "qemu-os-posix.h"
	59	#endif
	60
faf07963 PB	61	#ifndef O_LARGEFILE
	62	#define O_LARGEFILE 0
	63	#endif
	64	#ifndef O_BINARY
	65	#define O_BINARY 0
	66	#endif
0e74e66b JQ	67	#ifndef MAP_ANONYMOUS
	68	#define MAP_ANONYMOUS MAP_ANON
	69	#endif
faf07963 PB	70	#ifndef ENOMEDIUM
	71	#define ENOMEDIUM ENODEV
	72	#endif
4c955388	73	#if !defined(ENOTSUP)
2880bc32 JQ	74	#define ENOTSUP 4096
2880bc32 JQ	75	#endif
2084a8e3 PB	76	#if !defined(ECANCELED)
	77	#define ECANCELED 4097
	78	#endif
3c9405a0 GH	79	#ifndef TIME_MAX
	80	#define TIME_MAX LONG_MAX
	81	#endif
faf07963	82
c0fd260e SW	83	/* HOST_LONG_BITS is the size of a native pointer in bits. */
	84	#if UINTPTR_MAX == UINT32_MAX
	85	# define HOST_LONG_BITS 32
	86	#elif UINTPTR_MAX == UINT64_MAX
	87	# define HOST_LONG_BITS 64
	88	#else
	89	# error Unknown pointer size
	90	#endif
	91
6114fdb0 JQ	92	#ifndef CONFIG_IOVEC
6114fdb0 JQ	93	#define CONFIG_IOVEC
bf9298b9 AL	94	struct iovec {
	95	void *iov_base;
	96	size_t iov_len;
	97	};
e2a305fb CH	98	/*
	99	* Use the same value as Linux for now.
	100	*/
	101	#define IOV_MAX 1024
331dadde BS	102	#else
331dadde BS	103	#include <sys/uio.h>
bf9298b9 AL	104	#endif
bf9298b9 AL	105
f868445a SW	106	typedef int (fprintf_function)(FILE f, const char *fmt, ...)
	107	GCC_FMT_ATTR(2, 3);
	108
faf07963	109	#ifdef _WIN32
faf07963	110	#define fsync _commit
371c6489 SW	111	#if !defined(lseek)
	112	# define lseek _lseeki64
	113	#endif
64b85a8f	114	int qemu_ftruncate64(int, int64_t);
371c6489 SW	115	#if !defined(ftruncate)
	116	# define ftruncate qemu_ftruncate64
	117	#endif
faf07963	118
faf07963 PB	119	static inline char realpath(const char path, char *resolved_path)
	120	{
	121	_fullpath(resolved_path, path, _MAX_PATH);
	122	return resolved_path;
	123	}
faf07963 PB	124	#endif
faf07963 PB	125
946fb27c PB	126	/* icount */
	127	void configure_icount(const char *option);
	128	extern int use_icount;
	129
faf07963 PB	130	/* FIXME: Remove NEED_CPU_H. */
	131	#ifndef NEED_CPU_H
	132
faf07963 PB	133	#include "osdep.h"
	134	#include "bswap.h"
	135
	136	#else
	137
	138	#include "cpu.h"
	139
	140	#endif /* !defined(NEED_CPU_H) */
	141
3bbbee18 AF	142	/* main function, renamed */
	143	#if defined(CONFIG_COCOA)
	144	int qemu_main(int argc, char argv, char envp);
	145	#endif
	146
f6503059 AZ	147	void qemu_get_timedate(struct tm *tm, int offset);
	148	int qemu_timedate_diff(struct tm *tm);
	149
c8057f95 PM	150	/**
	151	* is_help_option:
	152	* @s: string to test
	153	*
	154	* Check whether @s is one of the standard strings which indicate
	155	* that the user is asking for a list of the valid values for a
	156	* command option like -cpu or -M. The current accepted strings
	157	* are 'help' and '?'. '?' is deprecated (it is a shell wildcard
	158	* which makes it annoying to use in a reliable way) but provided
	159	* for backwards compatibility.
	160	*
	161	* Returns: true if @s is a request for a list.
	162	*/
	163	static inline bool is_help_option(const char *s)
	164	{
	165	return !strcmp(s, "?") \|\| !strcmp(s, "help");
	166	}
	167
faf07963 PB	168	/* cutils.c */
faf07963 PB	169	void pstrcpy(char buf, int buf_size, const char str);
2a025ae4	170	void strpadcpy(char buf, int buf_size, const char str, char pad);
faf07963 PB	171	char pstrcat(char buf, int buf_size, const char *s);
	172	int strstart(const char str, const char val, const char **ptr);
	173	int stristart(const char str, const char val, const char **ptr);
d43277c5	174	int qemu_strnlen(const char *s, int max_len);
faf07963	175	time_t mktimegm(struct tm *tm);
ad46db9a	176	int qemu_fls(int i);
6f1953c4	177	int qemu_fdatasync(int fd);
db1a4972	178	int fcntl_setfl(int fd, int flag);
443916d1	179	int qemu_parse_fd(const char *param);
d8427002	180
d7142456 JS	181	/*
	182	* strtosz() suffixes used to specify the default treatment of an
	183	* argument passed to strtosz() without an explicit suffix.
	184	* These should be defined using upper case characters in the range
	185	* A-Z, as strtosz() will use qemu_toupper() on the given argument
	186	* prior to comparison.
	187	*/
d8427002 JS	188	#define STRTOSZ_DEFSUFFIX_TB 'T'
	189	#define STRTOSZ_DEFSUFFIX_GB 'G'
	190	#define STRTOSZ_DEFSUFFIX_MB 'M'
	191	#define STRTOSZ_DEFSUFFIX_KB 'K'
	192	#define STRTOSZ_DEFSUFFIX_B 'B'
70b4f4bb JS	193	int64_t strtosz(const char nptr, char *end);
70b4f4bb JS	194	int64_t strtosz_suffix(const char nptr, char *end, const char default_suffix);
a732e1ba JR	195	int64_t strtosz_suffix_unit(const char nptr, char *end,
a732e1ba JR	196	const char default_suffix, int64_t unit);
faf07963	197
37022086 BS	198	/* path.c */
	199	void init_paths(const char *prefix);
	200	const char path(const char pathname);
	201
cd390083 BS	202	#define qemu_isalnum(c) isalnum((unsigned char)(c))
	203	#define qemu_isalpha(c) isalpha((unsigned char)(c))
	204	#define qemu_iscntrl(c) iscntrl((unsigned char)(c))
	205	#define qemu_isdigit(c) isdigit((unsigned char)(c))
	206	#define qemu_isgraph(c) isgraph((unsigned char)(c))
	207	#define qemu_islower(c) islower((unsigned char)(c))
	208	#define qemu_isprint(c) isprint((unsigned char)(c))
	209	#define qemu_ispunct(c) ispunct((unsigned char)(c))
	210	#define qemu_isspace(c) isspace((unsigned char)(c))
	211	#define qemu_isupper(c) isupper((unsigned char)(c))
	212	#define qemu_isxdigit(c) isxdigit((unsigned char)(c))
	213	#define qemu_tolower(c) tolower((unsigned char)(c))
	214	#define qemu_toupper(c) toupper((unsigned char)(c))
	215	#define qemu_isascii(c) isascii((unsigned char)(c))
	216	#define qemu_toascii(c) toascii((unsigned char)(c))
	217
b152aa84	218	void qemu_oom_check(void ptr);
ca10f867	219
40ff6d7e	220	int qemu_open(const char *name, int flags, ...);
2e1e79da	221	int qemu_close(int fd);
7c7c0629 JQ	222	ssize_t qemu_write_full(int fd, const void *buf, size_t count)
7c7c0629 JQ	223	QEMU_WARN_UNUSED_RESULT;
993295fe PB	224	ssize_t qemu_send_full(int fd, const void *buf, size_t count, int flags)
993295fe PB	225	QEMU_WARN_UNUSED_RESULT;
8c5135f9	226	ssize_t qemu_recv_full(int fd, void *buf, size_t count, int flags)
993295fe	227	QEMU_WARN_UNUSED_RESULT;
40ff6d7e KW	228
	229	#ifndef _WIN32
	230	int qemu_pipe(int pipefd[2]);
	231	#endif
	232
00aa0040	233	#ifdef _WIN32
58455eb9 SW	234	/* MinGW needs type casts for the 'buf' and 'optval' arguments. */
	235	#define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
	236	getsockopt(sockfd, level, optname, (void *)optval, optlen)
	237	#define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
	238	setsockopt(sockfd, level, optname, (const void *)optval, optlen)
00aa0040	239	#define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags)
73062dfe SW	240	#define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
73062dfe SW	241	sendto(sockfd, (const void *)buf, len, flags, destaddr, addrlen)
00aa0040	242	#else
58455eb9 SW	243	#define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
	244	getsockopt(sockfd, level, optname, optval, optlen)
	245	#define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
	246	setsockopt(sockfd, level, optname, optval, optlen)
00aa0040	247	#define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags)
73062dfe SW	248	#define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
73062dfe SW	249	sendto(sockfd, buf, len, flags, destaddr, addrlen)
00aa0040 BS	250	#endif
00aa0040 BS	251
87ecb68b PB	252	/* Error handling. */
87ecb68b PB	253
e5924d89	254	void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
87ecb68b	255
87ecb68b PB	256	struct ParallelIOArg {
	257	void *buffer;
	258	int count;
	259	};
	260
	261	typedef int (DMA_transfer_handler) (void opaque, int nchan, int pos, int size);
	262
	263	/* A load of opaque types so that device init declarations don't have to
	264	pull in all the real definitions. */
	265	typedef struct NICInfo NICInfo;
1ae26a18	266	typedef struct HCIInfo HCIInfo;
87ecb68b PB	267	typedef struct AudioState AudioState;
87ecb68b PB	268	typedef struct BlockDriverState BlockDriverState;
2446333c	269	typedef struct DriveInfo DriveInfo;
87ecb68b	270	typedef struct DisplayState DisplayState;
7d957bd8 AL	271	typedef struct DisplayChangeListener DisplayChangeListener;
	272	typedef struct DisplaySurface DisplaySurface;
	273	typedef struct PixelFormat PixelFormat;
76ffb0b4	274	typedef struct QemuConsole QemuConsole;
87ecb68b	275	typedef struct CharDriverState CharDriverState;
76d32cba	276	typedef struct MACAddr MACAddr;
4e68f7a0	277	typedef struct NetClientState NetClientState;
87ecb68b	278	typedef struct i2c_bus i2c_bus;
48a18b3c	279	typedef struct ISABus ISABus;
dfc65f1f	280	typedef struct ISADevice ISADevice;
87ecb68b	281	typedef struct SMBusDevice SMBusDevice;
fb47a2e9 IY	282	typedef struct PCIHostState PCIHostState;
fb47a2e9 IY	283	typedef struct PCIExpressHost PCIExpressHost;
87ecb68b PB	284	typedef struct PCIBus PCIBus;
87ecb68b PB	285	typedef struct PCIDevice PCIDevice;
0428527c	286	typedef struct PCIExpressDevice PCIExpressDevice;
68f79994	287	typedef struct PCIBridge PCIBridge;
34e65944 IY	288	typedef struct PCIEAERMsg PCIEAERMsg;
	289	typedef struct PCIEAERLog PCIEAERLog;
	290	typedef struct PCIEAERErr PCIEAERErr;
bc20ba98 IY	291	typedef struct PCIEPort PCIEPort;
bc20ba98 IY	292	typedef struct PCIESlot PCIESlot;
14de9bab	293	typedef struct MSIMessage MSIMessage;
87ecb68b	294	typedef struct SerialState SerialState;
bc24a225 PB	295	typedef struct PCMCIACardState PCMCIACardState;
	296	typedef struct MouseTransformInfo MouseTransformInfo;
	297	typedef struct uWireSlave uWireSlave;
	298	typedef struct I2SCodec I2SCodec;
90d37239	299	typedef struct SSIBus SSIBus;
2292b339	300	typedef struct EventNotifier EventNotifier;
2be24aaa	301	typedef struct VirtIODevice VirtIODevice;
d35bf9ad	302	typedef struct QEMUSGList QEMUSGList;
1dc324d2	303	typedef struct SHPCDevice SHPCDevice;
87ecb68b	304
186993ee MT	305	typedef uint64_t pcibus_t;
186993ee MT	306
4e4fa398 JK	307	typedef enum LostTickPolicy {
	308	LOST_TICK_DISCARD,
	309	LOST_TICK_DELAY,
	310	LOST_TICK_MERGE,
	311	LOST_TICK_SLEW,
1ce05125	312	LOST_TICK_MAX
4e4fa398 JK	313	} LostTickPolicy;
4e4fa398 JK	314
679042f0 AP	315	typedef struct PCIHostDeviceAddress {
	316	unsigned int domain;
	317	unsigned int bus;
	318	unsigned int slot;
	319	unsigned int function;
	320	} PCIHostDeviceAddress;
	321
d5ab9713 JK	322	void tcg_exec_init(unsigned long tb_size);
	323	bool tcg_enabled(void);
	324
	325	void cpu_exec_init_all(void);
d2053c3c	326
b3c7724c PB	327	/* CPU save/load. */
	328	void cpu_save(QEMUFile f, void opaque);
	329	int cpu_load(QEMUFile f, void opaque, int version_id);
	330
8edac960	331	/* Unblock cpu */
46d62fac	332	void qemu_cpu_kick_self(void);
8edac960	333
e82bcec2 MT	334	/* work queue */
	335	struct qemu_work_item {
	336	struct qemu_work_item *next;
	337	void (func)(void data);
	338	void *data;
	339	int done;
	340	};
	341
0bf46a40 AL	342	#ifdef CONFIG_USER_ONLY
	343	#define qemu_init_vcpu(env) do { } while (0)
	344	#else
	345	void qemu_init_vcpu(void *env);
	346	#endif
	347
8c5135f9 PB	348
8c5135f9 PB	349	/**
2fc8ae1d MT	350	* Sends a (part of) iovec down a socket, yielding when the socket is full, or
	351	* Receives data into a (part of) iovec from a socket,
	352	* yielding when there is no data in the socket.
	353	* The same interface as qemu_sendv_recvv(), with added yielding.
	354	* XXX should mark these as coroutine_fn
8c5135f9	355	*/
2fc8ae1d MT	356	ssize_t qemu_co_sendv_recvv(int sockfd, struct iovec *iov, unsigned iov_cnt,
	357	size_t offset, size_t bytes, bool do_send);
	358	#define qemu_co_recvv(sockfd, iov, iov_cnt, offset, bytes) \
	359	qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, false)
	360	#define qemu_co_sendv(sockfd, iov, iov_cnt, offset, bytes) \
	361	qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, true)
8c5135f9 PB	362
8c5135f9 PB	363	/**
2fc8ae1d	364	* The same as above, but with just a single buffer
8c5135f9	365	*/
2fc8ae1d MT	366	ssize_t qemu_co_send_recv(int sockfd, void *buf, size_t bytes, bool do_send);
	367	#define qemu_co_recv(sockfd, buf, bytes) \
	368	qemu_co_send_recv(sockfd, buf, bytes, false)
	369	#define qemu_co_send(sockfd, buf, bytes) \
	370	qemu_co_send_recv(sockfd, buf, bytes, true)
8c5135f9	371
44e3ee8a AL	372	typedef struct QEMUIOVector {
	373	struct iovec *iov;
	374	int niov;
	375	int nalloc;
249aa745	376	size_t size;
44e3ee8a AL	377	} QEMUIOVector;
	378
	379	void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
522584a5	380	void qemu_iovec_init_external(QEMUIOVector qiov, struct iovec iov, int niov);
44e3ee8a	381	void qemu_iovec_add(QEMUIOVector qiov, void base, size_t len);
1b093c48 MT	382	void qemu_iovec_concat(QEMUIOVector *dst,
1b093c48 MT	383	QEMUIOVector *src, size_t soffset, size_t sbytes);
44e3ee8a	384	void qemu_iovec_destroy(QEMUIOVector *qiov);
be959463	385	void qemu_iovec_reset(QEMUIOVector *qiov);
d5e6b161 MT	386	size_t qemu_iovec_to_buf(QEMUIOVector *qiov, size_t offset,
d5e6b161 MT	387	void *buf, size_t bytes);
03396148 MT	388	size_t qemu_iovec_from_buf(QEMUIOVector *qiov, size_t offset,
03396148 MT	389	const void *buf, size_t bytes);
3d9b4925 MT	390	size_t qemu_iovec_memset(QEMUIOVector *qiov, size_t offset,
3d9b4925 MT	391	int fillc, size_t bytes);
44e3ee8a	392
1a6d39fd SH	393	bool buffer_is_zero(const void *buf, size_t len);
1a6d39fd SH	394
6b837bc4 JS	395	void qemu_progress_init(int enabled, float min_skip);
6b837bc4 JS	396	void qemu_progress_end(void);
3bfe4dbf	397	void qemu_progress_print(float delta, int max);
31459f46	398	const char *qemu_get_vm_name(void);
6b837bc4	399
082b5557 BS	400	#define QEMU_FILE_TYPE_BIOS 0
	401	#define QEMU_FILE_TYPE_KEYMAP 1
	402	char qemu_find_file(int type, const char name);
	403
	404	/* OS specific functions */
	405	void os_setup_early_signal_handling(void);
	406	char os_find_datadir(const char argv0);
	407	void os_parse_cmd_args(int index, const char *optarg);
	408	void os_pidfile_error(void);
	409
abd0c6bd PB	410	/* Convert a byte between binary and BCD. */
	411	static inline uint8_t to_bcd(uint8_t val)
	412	{
	413	return ((val / 10) << 4) \| (val % 10);
	414	}
	415
	416	static inline uint8_t from_bcd(uint8_t val)
	417	{
	418	return ((val >> 4) * 10) + (val & 0x0f);
	419	}
	420
338b922e	421	/* compute with 96 bit intermediate result: (ab)/c /
	422	static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
	423	{
	424	union {
	425	uint64_t ll;
	426	struct {
	427	#ifdef HOST_WORDS_BIGENDIAN
	428	uint32_t high, low;
	429	#else
	430	uint32_t low, high;
	431	#endif
	432	} l;
	433	} u, res;
	434	uint64_t rl, rh;
	435
	436	u.ll = a;
	437	rl = (uint64_t)u.l.low * (uint64_t)b;
	438	rh = (uint64_t)u.l.high * (uint64_t)b;
	439	rh += (rl >> 32);
	440	res.l.high = rh / c;
	441	res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
	442	return res.ll;
	443	}
	444
3951690a SH	445	/* Round number down to multiple */
	446	#define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
	447
	448	/* Round number up to multiple */
	449	#define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
	450
9fb26641 OW	451	static inline bool is_power_of_2(uint64_t value)
	452	{
	453	if (!value) {
	454	return 0;
	455	}
	456
	457	return !(value & (value - 1));
	458	}
	459
	460	/* round down to the nearest power of 2*/
	461	int64_t pow2floor(int64_t value);
	462
0bfe3ca5 AL	463	#include "module.h"
0bfe3ca5 AL	464
e6546bb9 OW	465	/*
	466	* Implementation of ULEB128 (http://en.wikipedia.org/wiki/LEB128)
	467	* Input is limited to 14-bit numbers
	468	*/
	469
	470	int uleb128_encode_small(uint8_t *out, uint32_t n);
	471	int uleb128_decode_small(const uint8_t in, uint32_t n);
	472
faf07963	473	#endif