[mirror_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"
#include "qemu/option.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

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(QemuOpts *opts, Error **errp);
extern int use_icount;

#include "qemu/osdep.h"
#include "qemu/bswap.h"

/* FIXME: Remove NEED_CPU_H.  */
#ifdef NEED_CPU_H
#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);
char *qemu_strsep(char **input, const char *delim);
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_EB	'E'
#define STRTOSZ_DEFSUFFIX_PB	'P'
#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);

/* used to print char* safely */
#define STR_OR_NULL(str) ((str) ? (str) : "null")

/* 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]);
/* like openpty() but also makes it raw; return master fd */
int qemu_openpty_raw(int *aslave, char *pty_name);
#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 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.  */
#ifdef CPU_SAVE_VERSION
void cpu_save(QEMUFile *f, void *opaque);
int cpu_load(QEMUFile *f, void *opaque, int version_id);
#endif

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


/**
 * 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);
size_t qemu_iovec_concat_iov(QEMUIOVector *dst,
                             struct iovec *src_iov, unsigned int src_cnt,
                             size_t soffset, size_t sbytes);
bool qemu_iovec_is_zero(QEMUIOVector *qiov);
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);
ssize_t qemu_iovec_compare(QEMUIOVector *a, QEMUIOVector *b);
void qemu_iovec_clone(QEMUIOVector *dest, const QEMUIOVector *src, void *buf);
void qemu_iovec_discard_back(QEMUIOVector *qiov, 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(void);
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 qemu_hexdump(const char *buf, FILE *fp, const char *prefix, size_t size);

/* vector definitions */
#ifdef __ALTIVEC__
#include <altivec.h>
/* The altivec.h header says we're allowed to undef these for
 * C++ compatibility.  Here we don't care about C++, but we
 * undef them anyway to avoid namespace pollution.
 */
#undef vector
#undef pixel
#undef bool
#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. */
#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);

const char *qemu_ether_ntoa(const MACAddr *mac);

#endif
Commit	Line	Data
	1
	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	*/
	12	#ifndef QEMU_COMMON_H
	13	#define QEMU_COMMON_H
	14
	15	#include "qemu/compiler.h"
	16	#include "config-host.h"
	17	#include "qemu/typedefs.h"
	18
	19	#if defined(__arm__) \|\| defined(__sparc__) \|\| defined(__mips__) \|\| defined(__hppa__) \|\| defined(__ia64__)
	20	#define WORDS_ALIGNED
	21	#endif
	22
	23	#define TFR(expr) do { if ((expr) != -1) break; } while (errno == EINTR)
	24
	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>
	29	#include <stdbool.h>
	30	#include <string.h>
	31	#include <strings.h>
	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>
	40	#include <sys/time.h>
	41	#include <assert.h>
	42	#include <signal.h>
	43	#include "glib-compat.h"
	44	#include "qemu/option.h"
	45
	46	#ifdef _WIN32
	47	#include "sysemu/os-win32.h"
	48	#endif
	49
	50	#ifdef CONFIG_POSIX
	51	#include "sysemu/os-posix.h"
	52	#endif
	53
	54	#ifndef O_LARGEFILE
	55	#define O_LARGEFILE 0
	56	#endif
	57	#ifndef O_BINARY
	58	#define O_BINARY 0
	59	#endif
	60	#ifndef MAP_ANONYMOUS
	61	#define MAP_ANONYMOUS MAP_ANON
	62	#endif
	63	#ifndef ENOMEDIUM
	64	#define ENOMEDIUM ENODEV
	65	#endif
	66	#if !defined(ENOTSUP)
	67	#define ENOTSUP 4096
	68	#endif
	69	#if !defined(ECANCELED)
	70	#define ECANCELED 4097
	71	#endif
	72	#if !defined(EMEDIUMTYPE)
	73	#define EMEDIUMTYPE 4098
	74	#endif
	75	#ifndef TIME_MAX
	76	#define TIME_MAX LONG_MAX
	77	#endif
	78
	79	/* HOST_LONG_BITS is the size of a native pointer in bits. */
	80	#if UINTPTR_MAX == UINT32_MAX
	81	# define HOST_LONG_BITS 32
	82	#elif UINTPTR_MAX == UINT64_MAX
	83	# define HOST_LONG_BITS 64
	84	#else
	85	# error Unknown pointer size
	86	#endif
	87
	88	typedef int (fprintf_function)(FILE f, const char *fmt, ...)
	89	GCC_FMT_ATTR(2, 3);
	90
	91	#ifdef _WIN32
	92	#define fsync _commit
	93	#if !defined(lseek)
	94	# define lseek _lseeki64
	95	#endif
	96	int qemu_ftruncate64(int, int64_t);
	97	#if !defined(ftruncate)
	98	# define ftruncate qemu_ftruncate64
	99	#endif
	100
	101	static inline char realpath(const char path, char *resolved_path)
	102	{
	103	_fullpath(resolved_path, path, _MAX_PATH);
	104	return resolved_path;
	105	}
	106	#endif
	107
	108	/* icount */
	109	void configure_icount(QemuOpts opts, Error *errp);
	110	extern int use_icount;
	111
	112	#include "qemu/osdep.h"
	113	#include "qemu/bswap.h"
	114
	115	/* FIXME: Remove NEED_CPU_H. */
	116	#ifdef NEED_CPU_H
	117	#include "cpu.h"
	118	#endif /* !defined(NEED_CPU_H) */
	119
	120	/* main function, renamed */
	121	#if defined(CONFIG_COCOA)
	122	int qemu_main(int argc, char argv, char envp);
	123	#endif
	124
	125	void qemu_get_timedate(struct tm *tm, int offset);
	126	int qemu_timedate_diff(struct tm *tm);
	127
	128	/**
	129	* is_help_option:
	130	* @s: string to test
	131	*
	132	* Check whether @s is one of the standard strings which indicate
	133	* that the user is asking for a list of the valid values for a
	134	* command option like -cpu or -M. The current accepted strings
	135	* are 'help' and '?'. '?' is deprecated (it is a shell wildcard
	136	* which makes it annoying to use in a reliable way) but provided
	137	* for backwards compatibility.
	138	*
	139	* Returns: true if @s is a request for a list.
	140	*/
	141	static inline bool is_help_option(const char *s)
	142	{
	143	return !strcmp(s, "?") \|\| !strcmp(s, "help");
	144	}
	145
	146	/* cutils.c */
	147	void pstrcpy(char buf, int buf_size, const char str);
	148	void strpadcpy(char buf, int buf_size, const char str, char pad);
	149	char pstrcat(char buf, int buf_size, const char *s);
	150	int strstart(const char str, const char val, const char **ptr);
	151	int stristart(const char str, const char val, const char **ptr);
	152	int qemu_strnlen(const char *s, int max_len);
	153	char qemu_strsep(char input, const char delim);
	154	time_t mktimegm(struct tm *tm);
	155	int qemu_fls(int i);
	156	int qemu_fdatasync(int fd);
	157	int fcntl_setfl(int fd, int flag);
	158	int qemu_parse_fd(const char *param);
	159
	160	int parse_uint(const char s, unsigned long long value, char **endptr,
	161	int base);
	162	int parse_uint_full(const char s, unsigned long long value, int base);
	163
	164	/*
	165	* strtosz() suffixes used to specify the default treatment of an
	166	* argument passed to strtosz() without an explicit suffix.
	167	* These should be defined using upper case characters in the range
	168	* A-Z, as strtosz() will use qemu_toupper() on the given argument
	169	* prior to comparison.
	170	*/
	171	#define STRTOSZ_DEFSUFFIX_EB 'E'
	172	#define STRTOSZ_DEFSUFFIX_PB 'P'
	173	#define STRTOSZ_DEFSUFFIX_TB 'T'
	174	#define STRTOSZ_DEFSUFFIX_GB 'G'
	175	#define STRTOSZ_DEFSUFFIX_MB 'M'
	176	#define STRTOSZ_DEFSUFFIX_KB 'K'
	177	#define STRTOSZ_DEFSUFFIX_B 'B'
	178	int64_t strtosz(const char nptr, char *end);
	179	int64_t strtosz_suffix(const char nptr, char *end, const char default_suffix);
	180	int64_t strtosz_suffix_unit(const char nptr, char *end,
	181	const char default_suffix, int64_t unit);
	182
	183	/* used to print char* safely */
	184	#define STR_OR_NULL(str) ((str) ? (str) : "null")
	185
	186	/* path.c */
	187	void init_paths(const char *prefix);
	188	const char path(const char pathname);
	189
	190	#define qemu_isalnum(c) isalnum((unsigned char)(c))
	191	#define qemu_isalpha(c) isalpha((unsigned char)(c))
	192	#define qemu_iscntrl(c) iscntrl((unsigned char)(c))
	193	#define qemu_isdigit(c) isdigit((unsigned char)(c))
	194	#define qemu_isgraph(c) isgraph((unsigned char)(c))
	195	#define qemu_islower(c) islower((unsigned char)(c))
	196	#define qemu_isprint(c) isprint((unsigned char)(c))
	197	#define qemu_ispunct(c) ispunct((unsigned char)(c))
	198	#define qemu_isspace(c) isspace((unsigned char)(c))
	199	#define qemu_isupper(c) isupper((unsigned char)(c))
	200	#define qemu_isxdigit(c) isxdigit((unsigned char)(c))
	201	#define qemu_tolower(c) tolower((unsigned char)(c))
	202	#define qemu_toupper(c) toupper((unsigned char)(c))
	203	#define qemu_isascii(c) isascii((unsigned char)(c))
	204	#define qemu_toascii(c) toascii((unsigned char)(c))
	205
	206	void qemu_oom_check(void ptr);
	207
	208	ssize_t qemu_write_full(int fd, const void *buf, size_t count)
	209	QEMU_WARN_UNUSED_RESULT;
	210	ssize_t qemu_send_full(int fd, const void *buf, size_t count, int flags)
	211	QEMU_WARN_UNUSED_RESULT;
	212	ssize_t qemu_recv_full(int fd, void *buf, size_t count, int flags)
	213	QEMU_WARN_UNUSED_RESULT;
	214
	215	#ifndef _WIN32
	216	int qemu_pipe(int pipefd[2]);
	217	/* like openpty() but also makes it raw; return master fd */
	218	int qemu_openpty_raw(int aslave, char pty_name);
	219	#endif
	220
	221	#ifdef _WIN32
	222	/* MinGW needs type casts for the 'buf' and 'optval' arguments. */
	223	#define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
	224	getsockopt(sockfd, level, optname, (void *)optval, optlen)
	225	#define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
	226	setsockopt(sockfd, level, optname, (const void *)optval, optlen)
	227	#define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags)
	228	#define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
	229	sendto(sockfd, (const void *)buf, len, flags, destaddr, addrlen)
	230	#else
	231	#define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
	232	getsockopt(sockfd, level, optname, optval, optlen)
	233	#define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
	234	setsockopt(sockfd, level, optname, optval, optlen)
	235	#define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags)
	236	#define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
	237	sendto(sockfd, buf, len, flags, destaddr, addrlen)
	238	#endif
	239
	240	/* Error handling. */
	241
	242	void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
	243
	244	struct ParallelIOArg {
	245	void *buffer;
	246	int count;
	247	};
	248
	249	typedef int (DMA_transfer_handler) (void opaque, int nchan, int pos, int size);
	250
	251	typedef uint64_t pcibus_t;
	252
	253	typedef struct PCIHostDeviceAddress {
	254	unsigned int domain;
	255	unsigned int bus;
	256	unsigned int slot;
	257	unsigned int function;
	258	} PCIHostDeviceAddress;
	259
	260	void tcg_exec_init(unsigned long tb_size);
	261	bool tcg_enabled(void);
	262
	263	void cpu_exec_init_all(void);
	264
	265	/* CPU save/load. */
	266	#ifdef CPU_SAVE_VERSION
	267	void cpu_save(QEMUFile f, void opaque);
	268	int cpu_load(QEMUFile f, void opaque, int version_id);
	269	#endif
	270
	271	/* Unblock cpu */
	272	void qemu_cpu_kick_self(void);
	273
	274	/* work queue */
	275	struct qemu_work_item {
	276	struct qemu_work_item *next;
	277	void (func)(void data);
	278	void *data;
	279	int done;
	280	bool free;
	281	};
	282
	283
	284	/**
	285	* Sends a (part of) iovec down a socket, yielding when the socket is full, or
	286	* Receives data into a (part of) iovec from a socket,
	287	* yielding when there is no data in the socket.
	288	* The same interface as qemu_sendv_recvv(), with added yielding.
	289	* XXX should mark these as coroutine_fn
	290	*/
	291	ssize_t qemu_co_sendv_recvv(int sockfd, struct iovec *iov, unsigned iov_cnt,
	292	size_t offset, size_t bytes, bool do_send);
	293	#define qemu_co_recvv(sockfd, iov, iov_cnt, offset, bytes) \
	294	qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, false)
	295	#define qemu_co_sendv(sockfd, iov, iov_cnt, offset, bytes) \
	296	qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, true)
	297
	298	/**
	299	* The same as above, but with just a single buffer
	300	*/
	301	ssize_t qemu_co_send_recv(int sockfd, void *buf, size_t bytes, bool do_send);
	302	#define qemu_co_recv(sockfd, buf, bytes) \
	303	qemu_co_send_recv(sockfd, buf, bytes, false)
	304	#define qemu_co_send(sockfd, buf, bytes) \
	305	qemu_co_send_recv(sockfd, buf, bytes, true)
	306
	307	typedef struct QEMUIOVector {
	308	struct iovec *iov;
	309	int niov;
	310	int nalloc;
	311	size_t size;
	312	} QEMUIOVector;
	313
	314	void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
	315	void qemu_iovec_init_external(QEMUIOVector qiov, struct iovec iov, int niov);
	316	void qemu_iovec_add(QEMUIOVector qiov, void base, size_t len);
	317	void qemu_iovec_concat(QEMUIOVector *dst,
	318	QEMUIOVector *src, size_t soffset, size_t sbytes);
	319	size_t qemu_iovec_concat_iov(QEMUIOVector *dst,
	320	struct iovec *src_iov, unsigned int src_cnt,
	321	size_t soffset, size_t sbytes);
	322	bool qemu_iovec_is_zero(QEMUIOVector *qiov);
	323	void qemu_iovec_destroy(QEMUIOVector *qiov);
	324	void qemu_iovec_reset(QEMUIOVector *qiov);
	325	size_t qemu_iovec_to_buf(QEMUIOVector *qiov, size_t offset,
	326	void *buf, size_t bytes);
	327	size_t qemu_iovec_from_buf(QEMUIOVector *qiov, size_t offset,
	328	const void *buf, size_t bytes);
	329	size_t qemu_iovec_memset(QEMUIOVector *qiov, size_t offset,
	330	int fillc, size_t bytes);
	331	ssize_t qemu_iovec_compare(QEMUIOVector a, QEMUIOVector b);
	332	void qemu_iovec_clone(QEMUIOVector dest, const QEMUIOVector src, void *buf);
	333	void qemu_iovec_discard_back(QEMUIOVector *qiov, size_t bytes);
	334
	335	bool buffer_is_zero(const void *buf, size_t len);
	336
	337	void qemu_progress_init(int enabled, float min_skip);
	338	void qemu_progress_end(void);
	339	void qemu_progress_print(float delta, int max);
	340	const char *qemu_get_vm_name(void);
	341
	342	#define QEMU_FILE_TYPE_BIOS 0
	343	#define QEMU_FILE_TYPE_KEYMAP 1
	344	char qemu_find_file(int type, const char name);
	345
	346	/* OS specific functions */
	347	void os_setup_early_signal_handling(void);
	348	char *os_find_datadir(void);
	349	void os_parse_cmd_args(int index, const char *optarg);
	350	void os_pidfile_error(void);
	351
	352	/* Convert a byte between binary and BCD. */
	353	static inline uint8_t to_bcd(uint8_t val)
	354	{
	355	return ((val / 10) << 4) \| (val % 10);
	356	}
	357
	358	static inline uint8_t from_bcd(uint8_t val)
	359	{
	360	return ((val >> 4) * 10) + (val & 0x0f);
	361	}
	362
	363	/* compute with 96 bit intermediate result: (ab)/c /
	364	static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
	365	{
	366	union {
	367	uint64_t ll;
	368	struct {
	369	#ifdef HOST_WORDS_BIGENDIAN
	370	uint32_t high, low;
	371	#else
	372	uint32_t low, high;
	373	#endif
	374	} l;
	375	} u, res;
	376	uint64_t rl, rh;
	377
	378	u.ll = a;
	379	rl = (uint64_t)u.l.low * (uint64_t)b;
	380	rh = (uint64_t)u.l.high * (uint64_t)b;
	381	rh += (rl >> 32);
	382	res.l.high = rh / c;
	383	res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
	384	return res.ll;
	385	}
	386
	387	/* Round number down to multiple */
	388	#define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
	389
	390	/* Round number up to multiple */
	391	#define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
	392
	393	static inline bool is_power_of_2(uint64_t value)
	394	{
	395	if (!value) {
	396	return 0;
	397	}
	398
	399	return !(value & (value - 1));
	400	}
	401
	402	/* round down to the nearest power of 2*/
	403	int64_t pow2floor(int64_t value);
	404
	405	#include "qemu/module.h"
	406
	407	/*
	408	* Implementation of ULEB128 (http://en.wikipedia.org/wiki/LEB128)
	409	* Input is limited to 14-bit numbers
	410	*/
	411
	412	int uleb128_encode_small(uint8_t *out, uint32_t n);
	413	int uleb128_decode_small(const uint8_t in, uint32_t n);
	414
	415	/* unicode.c */
	416	int mod_utf8_codepoint(const char s, size_t n, char *end);
	417
	418	/*
	419	* Hexdump a buffer to a file. An optional string prefix is added to every line
	420	*/
	421
	422	void qemu_hexdump(const char buf, FILE fp, const char *prefix, size_t size);
	423
	424	/* vector definitions */
	425	#ifdef __ALTIVEC__
	426	#include <altivec.h>
	427	/* The altivec.h header says we're allowed to undef these for
	428	* C++ compatibility. Here we don't care about C++, but we
	429	* undef them anyway to avoid namespace pollution.
	430	*/
	431	#undef vector
	432	#undef pixel
	433	#undef bool
	434	#define VECTYPE __vector unsigned char
	435	#define SPLAT(p) vec_splat(vec_ld(0, p), 0)
	436	#define ALL_EQ(v1, v2) vec_all_eq(v1, v2)
	437	/* altivec.h may redefine the bool macro as vector type.
	438	* Reset it to POSIX semantics. */
	439	#define bool _Bool
	440	#elif defined __SSE2__
	441	#include <emmintrin.h>
	442	#define VECTYPE __m128i
	443	#define SPLAT(p) _mm_set1_epi8(*(p))
	444	#define ALL_EQ(v1, v2) (_mm_movemask_epi8(_mm_cmpeq_epi8(v1, v2)) == 0xFFFF)
	445	#else
	446	#define VECTYPE unsigned long
	447	#define SPLAT(p) ((p) (~0UL / 255))
	448	#define ALL_EQ(v1, v2) ((v1) == (v2))
	449	#endif
	450
	451	#define BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR 8
	452	static inline bool
	453	can_use_buffer_find_nonzero_offset(const void *buf, size_t len)
	454	{
	455	return (len % (BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR
	456	* sizeof(VECTYPE)) == 0
	457	&& ((uintptr_t) buf) % sizeof(VECTYPE) == 0);
	458	}
	459	size_t buffer_find_nonzero_offset(const void *buf, size_t len);
	460
	461	/*
	462	* helper to parse debug environment variables
	463	*/
	464	int parse_debug_env(const char *name, int max, int initial);
	465
	466	const char qemu_ether_ntoa(const MACAddr mac);
	467
	468	#endif