[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

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;

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

#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);
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);
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);
ssize_t qemu_iovec_compare(QEMUIOVector *a, QEMUIOVector *b);
void qemu_iovec_clone(QEMUIOVector *dest, const QEMUIOVector *src, void *buf);

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