[qemu.git] / include / 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 "qemu/compiler.h"
#include "config-host.h"
#include "qemu/typedefs.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)

/* 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-compat.h"

#ifdef _WIN32
#include "sysemu/os-win32.h"
#endif

#ifdef CONFIG_POSIX
#include "sysemu/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
#if !defined(EMEDIUMTYPE)
#define EMEDIUMTYPE 4098
#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 "qemu/osdep.h"
#include "qemu/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);

#if !GLIB_CHECK_VERSION(2, 20, 0)
/*
 * Glib before 2.20.0 doesn't implement g_poll, so wrap it to compile properly
 * on older systems.
 */
static inline gint g_poll(GPollFD *fds, guint nfds, gint timeout)
{
    GMainContext *ctx = g_main_context_default();
    return g_main_context_get_poll_func(ctx)(fds, nfds, timeout);
}
#endif

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

int parse_uint(const char *s, unsigned long long *value, char **endptr,
               int base);
int parse_uint_full(const char *s, unsigned long long *value, int base);

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

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);

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
static inline void qemu_init_vcpu(void *env)
{
}
#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_concat_iov(QEMUIOVector *dst,
                           struct iovec *src_iov, unsigned int src_cnt,
                           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 "qemu/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);

/* unicode.c */
int mod_utf8_codepoint(const char *s, size_t n, char **end);

/*
 * Hexdump a buffer to a file. An optional string prefix is added to every line
 */

void hexdump(const char *buf, FILE *fp, const char *prefix, size_t size);

/* vector definitions */
#ifdef __ALTIVEC__
#include <altivec.h>
#define VECTYPE        vector unsigned char
#define SPLAT(p)       vec_splat(vec_ld(0, p), 0)
#define ALL_EQ(v1, v2) vec_all_eq(v1, v2)
/* altivec.h may redefine the bool macro as vector type.
 * Reset it to POSIX semantics. */
#undef bool
#define bool _Bool
#elif defined __SSE2__
#include <emmintrin.h>
#define VECTYPE        __m128i
#define SPLAT(p)       _mm_set1_epi8(*(p))
#define ALL_EQ(v1, v2) (_mm_movemask_epi8(_mm_cmpeq_epi8(v1, v2)) == 0xFFFF)
#else
#define VECTYPE        unsigned long
#define SPLAT(p)       (*(p) * (~0UL / 255))
#define ALL_EQ(v1, v2) ((v1) == (v2))
#endif

#define BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR 8
static inline bool
can_use_buffer_find_nonzero_offset(const void *buf, size_t len)
{
    return (len % (BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR
                   * sizeof(VECTYPE)) == 0
            && ((uintptr_t) buf) % sizeof(VECTYPE) == 0);
}
size_t buffer_find_nonzero_offset(const void *buf, size_t len);

/*
 * helper to parse debug environment variables
 */
int parse_debug_env(const char *name, int max, int initial);

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