[mirror_qemu.git] / include / qemu / osdep.h

/*
 * OS includes and handling of OS dependencies
 *
 * This header exists to pull in some common system headers that
 * most code in QEMU will want, and to fix up some possible issues with
 * it (missing defines, Windows weirdness, and so on).
 *
 * To avoid getting into possible circular include dependencies, this
 * file should not include any other QEMU headers, with the exceptions
 * of config-host.h, config-target.h, qemu/compiler.h,
 * sysemu/os-posix.h, sysemu/os-win32.h, glib-compat.h and
 * qemu/typedefs.h, all of which are doing a similar job to this file
 * and are under similar constraints.
 *
 * This header also contains prototypes for functions defined in
 * os-*.c and util/oslib-*.c; those would probably be better split
 * out into separate header files.
 *
 * In an ideal world this header would contain only:
 *  (1) things which everybody needs
 *  (2) things without which code would work on most platforms but
 *      fail to compile or misbehave on a minority of host OSes
 *
 * This work is licensed under the terms of the GNU GPL, version 2 or later.
 * See the COPYING file in the top-level directory.
 */
#ifndef QEMU_OSDEP_H
#define QEMU_OSDEP_H

#include "config-host.h"
#ifdef NEED_CPU_H
#include "config-target.h"
#else
#include "exec/poison.h"
#endif
#include "qemu/compiler.h"

/* Older versions of C++ don't get definitions of various macros from
 * stdlib.h unless we define these macros before first inclusion of
 * that system header.
 */
#ifndef __STDC_CONSTANT_MACROS
#define __STDC_CONSTANT_MACROS
#endif
#ifndef __STDC_LIMIT_MACROS
#define __STDC_LIMIT_MACROS
#endif
#ifndef __STDC_FORMAT_MACROS
#define __STDC_FORMAT_MACROS
#endif

/* The following block of code temporarily renames the daemon() function so the
 * compiler does not see the warning associated with it in stdlib.h on OSX
 */
#ifdef __APPLE__
#define daemon qemu_fake_daemon_function
#include <stdlib.h>
#undef daemon
extern int daemon(int, int);
#endif

#include <stdarg.h>
#include <stddef.h>
#include <stdbool.h>
#include <stdint.h>
#include <sys/types.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <strings.h>
#include <inttypes.h>
#include <limits.h>
/* Put unistd.h before time.h as that triggers localtime_r/gmtime_r
 * function availability on recentish Mingw-w64 platforms. */
#include <unistd.h>
#include <time.h>
#include <ctype.h>
#include <errno.h>
#include <fcntl.h>
#include <sys/stat.h>
#include <sys/time.h>
#include <assert.h>
/* setjmp must be declared before sysemu/os-win32.h
 * because it is redefined there. */
#include <setjmp.h>
#include <signal.h>

#ifdef __OpenBSD__
#include <sys/signal.h>
#endif

#ifndef _WIN32
#include <sys/wait.h>
#else
#define WIFEXITED(x)   1
#define WEXITSTATUS(x) (x)
#endif

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

#ifdef CONFIG_POSIX
#include "sysemu/os-posix.h"
#endif

#include "glib-compat.h"
#include "qemu/typedefs.h"

/*
 * We have a lot of unaudited code that may fail in strange ways, or
 * even be a security risk during migration, if you disable assertions
 * at compile-time.  You may comment out these safety checks if you
 * absolutely want to disable assertion overhead, but it is not
 * supported upstream so the risk is all yours.  Meanwhile, please
 * submit patches to remove any side-effects inside an assertion, or
 * fixing error handling that should use Error instead of assert.
 */
#ifdef NDEBUG
#error building with NDEBUG is not supported
#endif
#ifdef G_DISABLE_ASSERT
#error building with G_DISABLE_ASSERT is not supported
#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
#if !defined(ESHUTDOWN)
#define ESHUTDOWN 4099
#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

/* Mac OSX has a <stdint.h> bug that incorrectly defines SIZE_MAX with
 * the wrong type. Our replacement isn't usable in preprocessor
 * expressions, but it is sufficient for our needs. */
#if defined(HAVE_BROKEN_SIZE_MAX) && HAVE_BROKEN_SIZE_MAX
#undef SIZE_MAX
#define SIZE_MAX ((size_t)-1)
#endif

#ifndef MIN
#define MIN(a, b) (((a) < (b)) ? (a) : (b))
#endif
#ifndef MAX
#define MAX(a, b) (((a) > (b)) ? (a) : (b))
#endif

/* Minimum function that returns zero only iff both values are zero.
 * Intended for use with unsigned values only. */
#ifndef MIN_NON_ZERO
#define MIN_NON_ZERO(a, b) ((a) == 0 ? (b) : \
                                ((b) == 0 ? (a) : (MIN(a, b))))
#endif

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

/* Round number up to multiple. Safe when m is not a power of 2 (see
 * ROUND_UP for a faster version when a power of 2 is guaranteed) */
#define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))

/* Check if n is a multiple of m */
#define QEMU_IS_ALIGNED(n, m) (((n) % (m)) == 0)

/* n-byte align pointer down */
#define QEMU_ALIGN_PTR_DOWN(p, n) \
    ((typeof(p))QEMU_ALIGN_DOWN((uintptr_t)(p), (n)))

/* n-byte align pointer up */
#define QEMU_ALIGN_PTR_UP(p, n) \
    ((typeof(p))QEMU_ALIGN_UP((uintptr_t)(p), (n)))

/* Check if pointer p is n-bytes aligned */
#define QEMU_PTR_IS_ALIGNED(p, n) QEMU_IS_ALIGNED((uintptr_t)(p), (n))

/* Round number up to multiple. Requires that d be a power of 2 (see
 * QEMU_ALIGN_UP for a safer but slower version on arbitrary
 * numbers); works even if d is a smaller type than n.  */
#ifndef ROUND_UP
#define ROUND_UP(n, d) (((n) + (d) - 1) & -(0 ? (n) : (d)))
#endif

#ifndef DIV_ROUND_UP
#define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
#endif

/*
 * &(x)[0] is always a pointer - if it's same type as x then the argument is a
 * pointer, not an array.
 */
#define QEMU_IS_ARRAY(x) (!__builtin_types_compatible_p(typeof(x), \
                                                        typeof(&(x)[0])))
#ifndef ARRAY_SIZE
#define ARRAY_SIZE(x) ((sizeof(x) / sizeof((x)[0])) + \
                       QEMU_BUILD_BUG_ON_ZERO(!QEMU_IS_ARRAY(x)))
#endif

int qemu_daemon(int nochdir, int noclose);
void *qemu_try_memalign(size_t alignment, size_t size);
void *qemu_memalign(size_t alignment, size_t size);
void *qemu_anon_ram_alloc(size_t size, uint64_t *align);
void qemu_vfree(void *ptr);
void qemu_anon_ram_free(void *ptr, size_t size);

#define QEMU_MADV_INVALID -1

#if defined(CONFIG_MADVISE)

#define QEMU_MADV_WILLNEED  MADV_WILLNEED
#define QEMU_MADV_DONTNEED  MADV_DONTNEED
#ifdef MADV_DONTFORK
#define QEMU_MADV_DONTFORK  MADV_DONTFORK
#else
#define QEMU_MADV_DONTFORK  QEMU_MADV_INVALID
#endif
#ifdef MADV_MERGEABLE
#define QEMU_MADV_MERGEABLE MADV_MERGEABLE
#else
#define QEMU_MADV_MERGEABLE QEMU_MADV_INVALID
#endif
#ifdef MADV_UNMERGEABLE
#define QEMU_MADV_UNMERGEABLE MADV_UNMERGEABLE
#else
#define QEMU_MADV_UNMERGEABLE QEMU_MADV_INVALID
#endif
#ifdef MADV_DODUMP
#define QEMU_MADV_DODUMP MADV_DODUMP
#else
#define QEMU_MADV_DODUMP QEMU_MADV_INVALID
#endif
#ifdef MADV_DONTDUMP
#define QEMU_MADV_DONTDUMP MADV_DONTDUMP
#else
#define QEMU_MADV_DONTDUMP QEMU_MADV_INVALID
#endif
#ifdef MADV_HUGEPAGE
#define QEMU_MADV_HUGEPAGE MADV_HUGEPAGE
#else
#define QEMU_MADV_HUGEPAGE QEMU_MADV_INVALID
#endif
#ifdef MADV_NOHUGEPAGE
#define QEMU_MADV_NOHUGEPAGE MADV_NOHUGEPAGE
#else
#define QEMU_MADV_NOHUGEPAGE QEMU_MADV_INVALID
#endif
#ifdef MADV_REMOVE
#define QEMU_MADV_REMOVE MADV_REMOVE
#else
#define QEMU_MADV_REMOVE QEMU_MADV_INVALID
#endif

#elif defined(CONFIG_POSIX_MADVISE)

#define QEMU_MADV_WILLNEED  POSIX_MADV_WILLNEED
#define QEMU_MADV_DONTNEED  POSIX_MADV_DONTNEED
#define QEMU_MADV_DONTFORK  QEMU_MADV_INVALID
#define QEMU_MADV_MERGEABLE QEMU_MADV_INVALID
#define QEMU_MADV_UNMERGEABLE QEMU_MADV_INVALID
#define QEMU_MADV_DODUMP QEMU_MADV_INVALID
#define QEMU_MADV_DONTDUMP QEMU_MADV_INVALID
#define QEMU_MADV_HUGEPAGE  QEMU_MADV_INVALID
#define QEMU_MADV_NOHUGEPAGE  QEMU_MADV_INVALID
#define QEMU_MADV_REMOVE QEMU_MADV_INVALID

#else /* no-op */

#define QEMU_MADV_WILLNEED  QEMU_MADV_INVALID
#define QEMU_MADV_DONTNEED  QEMU_MADV_INVALID
#define QEMU_MADV_DONTFORK  QEMU_MADV_INVALID
#define QEMU_MADV_MERGEABLE QEMU_MADV_INVALID
#define QEMU_MADV_UNMERGEABLE QEMU_MADV_INVALID
#define QEMU_MADV_DODUMP QEMU_MADV_INVALID
#define QEMU_MADV_DONTDUMP QEMU_MADV_INVALID
#define QEMU_MADV_HUGEPAGE  QEMU_MADV_INVALID
#define QEMU_MADV_NOHUGEPAGE  QEMU_MADV_INVALID
#define QEMU_MADV_REMOVE QEMU_MADV_INVALID

#endif

#ifdef _WIN32
#define HAVE_CHARDEV_SERIAL 1
#elif defined(__linux__) || defined(__sun__) || defined(__FreeBSD__)    \
    || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) \
    || defined(__GLIBC__)
#define HAVE_CHARDEV_SERIAL 1
#endif

#if defined(__linux__) || defined(__FreeBSD__) ||               \
    defined(__FreeBSD_kernel__) || defined(__DragonFly__)
#define HAVE_CHARDEV_PARPORT 1
#endif

#if defined(CONFIG_LINUX)
#ifndef BUS_MCEERR_AR
#define BUS_MCEERR_AR 4
#endif
#ifndef BUS_MCEERR_AO
#define BUS_MCEERR_AO 5
#endif
#endif

#if defined(__linux__) && \
    (defined(__x86_64__) || defined(__arm__) || defined(__aarch64__))
   /* Use 2 MiB alignment so transparent hugepages can be used by KVM.
      Valgrind does not support alignments larger than 1 MiB,
      therefore we need special code which handles running on Valgrind. */
#  define QEMU_VMALLOC_ALIGN (512 * 4096)
#elif defined(__linux__) && defined(__s390x__)
   /* Use 1 MiB (segment size) alignment so gmap can be used by KVM. */
#  define QEMU_VMALLOC_ALIGN (256 * 4096)
#else
#  define QEMU_VMALLOC_ALIGN getpagesize()
#endif

#ifdef CONFIG_POSIX
struct qemu_signalfd_siginfo {
    uint32_t ssi_signo;   /* Signal number */
    int32_t  ssi_errno;   /* Error number (unused) */
    int32_t  ssi_code;    /* Signal code */
    uint32_t ssi_pid;     /* PID of sender */
    uint32_t ssi_uid;     /* Real UID of sender */
    int32_t  ssi_fd;      /* File descriptor (SIGIO) */
    uint32_t ssi_tid;     /* Kernel timer ID (POSIX timers) */
    uint32_t ssi_band;    /* Band event (SIGIO) */
    uint32_t ssi_overrun; /* POSIX timer overrun count */
    uint32_t ssi_trapno;  /* Trap number that caused signal */
    int32_t  ssi_status;  /* Exit status or signal (SIGCHLD) */
    int32_t  ssi_int;     /* Integer sent by sigqueue(2) */
    uint64_t ssi_ptr;     /* Pointer sent by sigqueue(2) */
    uint64_t ssi_utime;   /* User CPU time consumed (SIGCHLD) */
    uint64_t ssi_stime;   /* System CPU time consumed (SIGCHLD) */
    uint64_t ssi_addr;    /* Address that generated signal
                             (for hardware-generated signals) */
    uint8_t  pad[48];     /* Pad size to 128 bytes (allow for
                             additional fields in the future) */
};

int qemu_signalfd(const sigset_t *mask);
void sigaction_invoke(struct sigaction *action,
                      struct qemu_signalfd_siginfo *info);
#endif

int qemu_madvise(void *addr, size_t len, int advice);

int qemu_open(const char *name, int flags, ...);
int qemu_close(int fd);
#ifndef _WIN32
int qemu_dup(int fd);
#endif
int qemu_lock_fd(int fd, int64_t start, int64_t len, bool exclusive);
int qemu_unlock_fd(int fd, int64_t start, int64_t len);
int qemu_lock_fd_test(int fd, int64_t start, int64_t len, bool exclusive);
bool qemu_has_ofd_lock(void);

#if defined(__HAIKU__) && defined(__i386__)
#define FMT_pid "%ld"
#elif defined(WIN64)
#define FMT_pid "%" PRId64
#else
#define FMT_pid "%d"
#endif

int qemu_create_pidfile(const char *filename);
int qemu_get_thread_id(void);

#ifndef CONFIG_IOVEC
struct iovec {
    void *iov_base;
    size_t iov_len;
};
/*
 * Use the same value as Linux for now.
 */
#define IOV_MAX 1024

ssize_t readv(int fd, const struct iovec *iov, int iov_cnt);
ssize_t writev(int fd, const struct iovec *iov, int iov_cnt);
#else
#include <sys/uio.h>
#endif

#ifdef _WIN32
static inline void qemu_timersub(const struct timeval *val1,
                                 const struct timeval *val2,
                                 struct timeval *res)
{
    res->tv_sec = val1->tv_sec - val2->tv_sec;
    if (val1->tv_usec < val2->tv_usec) {
        res->tv_sec--;
        res->tv_usec = val1->tv_usec - val2->tv_usec + 1000 * 1000;
    } else {
        res->tv_usec = val1->tv_usec - val2->tv_usec;
    }
}
#else
#define qemu_timersub timersub
#endif

void qemu_set_cloexec(int fd);

/* Starting on QEMU 2.5, qemu_hw_version() returns "2.5+" by default
 * instead of QEMU_VERSION, so setting hw_version on MachineClass
 * is no longer mandatory.
 *
 * Do NOT change this string, or it will break compatibility on all
 * machine classes that don't set hw_version.
 */
#define QEMU_HW_VERSION "2.5+"

/* QEMU "hardware version" setting. Used to replace code that exposed
 * QEMU_VERSION to guests in the past and need to keep compatibility.
 * Do not use qemu_hw_version() in new code.
 */
void qemu_set_hw_version(const char *);
const char *qemu_hw_version(void);

void fips_set_state(bool requested);
bool fips_get_state(void);

/* Return a dynamically allocated pathname denoting a file or directory that is
 * appropriate for storing local state.
 *
 * @relative_pathname need not start with a directory separator; one will be
 * added automatically.
 *
 * The caller is responsible for releasing the value returned with g_free()
 * after use.
 */
char *qemu_get_local_state_pathname(const char *relative_pathname);

/* Find program directory, and save it for later usage with
 * qemu_get_exec_dir().
 * Try OS specific API first, if not working, parse from argv0. */
void qemu_init_exec_dir(const char *argv0);

/* Get the saved exec dir.
 * Caller needs to release the returned string by g_free() */
char *qemu_get_exec_dir(void);

/**
 * qemu_getauxval:
 * @type: the auxiliary vector key to lookup
 *
 * Search the auxiliary vector for @type, returning the value
 * or 0 if @type is not present.
 */
unsigned long qemu_getauxval(unsigned long type);

void qemu_set_tty_echo(int fd, bool echo);

void os_mem_prealloc(int fd, char *area, size_t sz, int smp_cpus,
                     Error **errp);

/**
 * qemu_get_pid_name:
 * @pid: pid of a process
 *
 * For given @pid fetch its name. Caller is responsible for
 * freeing the string when no longer needed.
 * Returns allocated string on success, NULL on failure.
 */
char *qemu_get_pid_name(pid_t pid);

/**
 * qemu_fork:
 *
 * A version of fork that avoids signal handler race
 * conditions that can lead to child process getting
 * signals that are otherwise only expected by the
 * parent. It also resets all signal handlers to the
 * default settings.
 *
 * Returns 0 to child process, pid number to parent
 * or -1 on failure.
 */
pid_t qemu_fork(Error **errp);

/* Using intptr_t ensures that qemu_*_page_mask is sign-extended even
 * when intptr_t is 32-bit and we are aligning a long long.
 */
extern uintptr_t qemu_real_host_page_size;
extern intptr_t qemu_real_host_page_mask;

extern int qemu_icache_linesize;
extern int qemu_dcache_linesize;

#endif
Commit	Line	Data
03557b9a PM	1	/*
	2	* OS includes and handling of OS dependencies
	3	*
	4	* This header exists to pull in some common system headers that
	5	* most code in QEMU will want, and to fix up some possible issues with
	6	* it (missing defines, Windows weirdness, and so on).
	7	*
	8	* To avoid getting into possible circular include dependencies, this
	9	* file should not include any other QEMU headers, with the exceptions
da34e65c MA	10	* of config-host.h, config-target.h, qemu/compiler.h,
	11	* sysemu/os-posix.h, sysemu/os-win32.h, glib-compat.h and
	12	* qemu/typedefs.h, all of which are doing a similar job to this file
	13	* and are under similar constraints.
03557b9a PM	14	*
	15	* This header also contains prototypes for functions defined in
	16	* os-.c and util/oslib-.c; those would probably be better split
	17	* out into separate header files.
	18	*
	19	* In an ideal world this header would contain only:
	20	* (1) things which everybody needs
	21	* (2) things without which code would work on most platforms but
	22	* fail to compile or misbehave on a minority of host OSes
	23	*
	24	* This work is licensed under the terms of the GNU GPL, version 2 or later.
	25	* See the COPYING file in the top-level directory.
	26	*/
ea88812f FB	27	#ifndef QEMU_OSDEP_H
	28	#define QEMU_OSDEP_H
	29
9adea5f7	30	#include "config-host.h"
b1e34d1c PM	31	#ifdef NEED_CPU_H
b1e34d1c PM	32	#include "config-target.h"
bdd90227 PB	33	#else
bdd90227 PB	34	#include "exec/poison.h"
b1e34d1c	35	#endif
49120868	36	#include "qemu/compiler.h"
d5db2ec1	37
79f56d82 PM	38	/* Older versions of C++ don't get definitions of various macros from
	39	* stdlib.h unless we define these macros before first inclusion of
	40	* that system header.
	41	*/
	42	#ifndef __STDC_CONSTANT_MACROS
	43	#define __STDC_CONSTANT_MACROS
	44	#endif
	45	#ifndef __STDC_LIMIT_MACROS
	46	#define __STDC_LIMIT_MACROS
	47	#endif
	48	#ifndef __STDC_FORMAT_MACROS
	49	#define __STDC_FORMAT_MACROS
	50	#endif
	51
d5db2ec1 PM	52	/* The following block of code temporarily renames the daemon() function so the
	53	* compiler does not see the warning associated with it in stdlib.h on OSX
	54	*/
	55	#ifdef __APPLE__
	56	#define daemon qemu_fake_daemon_function
	57	#include <stdlib.h>
	58	#undef daemon
	59	extern int daemon(int, int);
	60	#endif
	61
ea88812f	62	#include <stdarg.h>
de5071c5	63	#include <stddef.h>
0f66998f	64	#include <stdbool.h>
a2b257d6	65	#include <stdint.h>
128ab2ff	66	#include <sys/types.h>
bfe7e449 PM	67	#include <stdlib.h>
	68	#include <stdio.h>
	69	#include <string.h>
	70	#include <strings.h>
	71	#include <inttypes.h>
	72	#include <limits.h>
4d9310f4 DB	73	/* Put unistd.h before time.h as that triggers localtime_r/gmtime_r
	74	* function availability on recentish Mingw-w64 platforms. */
	75	#include <unistd.h>
bfe7e449 PM	76	#include <time.h>
	77	#include <ctype.h>
	78	#include <errno.h>
bfe7e449 PM	79	#include <fcntl.h>
	80	#include <sys/stat.h>
	81	#include <sys/time.h>
	82	#include <assert.h>
e89fdafb SW	83	/* setjmp must be declared before sysemu/os-win32.h
	84	* because it is redefined there. */
	85	#include <setjmp.h>
bfe7e449 PM	86	#include <signal.h>
bfe7e449 PM	87
98b2d199	88	#ifdef __OpenBSD__
128ab2ff BS	89	#include <sys/signal.h>
128ab2ff BS	90	#endif
ea88812f	91
13c7b2da PB	92	#ifndef _WIN32
	93	#include <sys/wait.h>
	94	#else
	95	#define WIFEXITED(x) 1
	96	#define WEXITSTATUS(x) (x)
	97	#endif
	98
bfe7e449 PM	99	#ifdef _WIN32
	100	#include "sysemu/os-win32.h"
	101	#endif
	102
	103	#ifdef CONFIG_POSIX
	104	#include "sysemu/os-posix.h"
	105	#endif
f7b4a940	106
529490e5	107	#include "glib-compat.h"
da34e65c	108	#include "qemu/typedefs.h"
57cb38b3	109
262a69f4 EB	110	/*
	111	* We have a lot of unaudited code that may fail in strange ways, or
	112	* even be a security risk during migration, if you disable assertions
	113	* at compile-time. You may comment out these safety checks if you
	114	* absolutely want to disable assertion overhead, but it is not
	115	* supported upstream so the risk is all yours. Meanwhile, please
	116	* submit patches to remove any side-effects inside an assertion, or
	117	* fixing error handling that should use Error instead of assert.
	118	*/
	119	#ifdef NDEBUG
	120	#error building with NDEBUG is not supported
	121	#endif
	122	#ifdef G_DISABLE_ASSERT
	123	#error building with G_DISABLE_ASSERT is not supported
	124	#endif
	125
bfe7e449 PM	126	#ifndef O_LARGEFILE
	127	#define O_LARGEFILE 0
	128	#endif
	129	#ifndef O_BINARY
	130	#define O_BINARY 0
	131	#endif
	132	#ifndef MAP_ANONYMOUS
	133	#define MAP_ANONYMOUS MAP_ANON
	134	#endif
	135	#ifndef ENOMEDIUM
	136	#define ENOMEDIUM ENODEV
	137	#endif
	138	#if !defined(ENOTSUP)
	139	#define ENOTSUP 4096
	140	#endif
	141	#if !defined(ECANCELED)
	142	#define ECANCELED 4097
	143	#endif
	144	#if !defined(EMEDIUMTYPE)
	145	#define EMEDIUMTYPE 4098
	146	#endif
b6f5d3b5 EB	147	#if !defined(ESHUTDOWN)
	148	#define ESHUTDOWN 4099
	149	#endif
bfe7e449 PM	150	#ifndef TIME_MAX
	151	#define TIME_MAX LONG_MAX
	152	#endif
	153
a8139632 MA	154	/* HOST_LONG_BITS is the size of a native pointer in bits. */
	155	#if UINTPTR_MAX == UINT32_MAX
	156	# define HOST_LONG_BITS 32
	157	#elif UINTPTR_MAX == UINT64_MAX
	158	# define HOST_LONG_BITS 64
	159	#else
	160	# error Unknown pointer size
	161	#endif
	162
6b39b063 EB	163	/* Mac OSX has a <stdint.h> bug that incorrectly defines SIZE_MAX with
	164	* the wrong type. Our replacement isn't usable in preprocessor
	165	* expressions, but it is sufficient for our needs. */
	166	#if defined(HAVE_BROKEN_SIZE_MAX) && HAVE_BROKEN_SIZE_MAX
	167	#undef SIZE_MAX
	168	#define SIZE_MAX ((size_t)-1)
	169	#endif
	170
df2542c7 JM	171	#ifndef MIN
	172	#define MIN(a, b) (((a) < (b)) ? (a) : (b))
	173	#endif
	174	#ifndef MAX
	175	#define MAX(a, b) (((a) > (b)) ? (a) : (b))
	176	#endif
	177
ac3a8726 PL	178	/* Minimum function that returns zero only iff both values are zero.
	179	* Intended for use with unsigned values only. */
	180	#ifndef MIN_NON_ZERO
d27ba624 FZ	181	#define MIN_NON_ZERO(a, b) ((a) == 0 ? (b) : \
d27ba624 FZ	182	((b) == 0 ? (a) : (MIN(a, b))))
ac3a8726 PL	183	#endif
ac3a8726 PL	184
e07e540a MA	185	/* Round number down to multiple */
	186	#define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
	187
e9fd416e EB	188	/* Round number up to multiple. Safe when m is not a power of 2 (see
e9fd416e EB	189	* ROUND_UP for a faster version when a power of 2 is guaranteed) */
e07e540a MA	190	#define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
e07e540a MA	191
18a60a76 SF	192	/* Check if n is a multiple of m */
	193	#define QEMU_IS_ALIGNED(n, m) (((n) % (m)) == 0)
	194
6b587d3c SF	195	/* n-byte align pointer down */
	196	#define QEMU_ALIGN_PTR_DOWN(p, n) \
	197	((typeof(p))QEMU_ALIGN_DOWN((uintptr_t)(p), (n)))
	198
	199	/* n-byte align pointer up */
	200	#define QEMU_ALIGN_PTR_UP(p, n) \
	201	((typeof(p))QEMU_ALIGN_UP((uintptr_t)(p), (n)))
	202
	203	/* Check if pointer p is n-bytes aligned */
	204	#define QEMU_PTR_IS_ALIGNED(p, n) QEMU_IS_ALIGNED((uintptr_t)(p), (n))
	205
e9fd416e EB	206	/* Round number up to multiple. Requires that d be a power of 2 (see
e9fd416e EB	207	* QEMU_ALIGN_UP for a safer but slower version on arbitrary
2098b073	208	* numbers); works even if d is a smaller type than n. */
292c8e50	209	#ifndef ROUND_UP
2098b073	210	#define ROUND_UP(n, d) (((n) + (d) - 1) & -(0 ? (n) : (d)))
292c8e50 PB	211	#endif
292c8e50 PB	212
e0e53b2f	213	#ifndef DIV_ROUND_UP
2098b073	214	#define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
e0e53b2f CC	215	#endif
e0e53b2f CC	216
ed63ec0d MT	217	/*
	218	* &(x)[0] is always a pointer - if it's same type as x then the argument is a
	219	* pointer, not an array.
	220	*/
	221	#define QEMU_IS_ARRAY(x) (!__builtin_types_compatible_p(typeof(x), \
	222	typeof(&(x)[0])))
0954d0d9	223	#ifndef ARRAY_SIZE
ed63ec0d MT	224	#define ARRAY_SIZE(x) ((sizeof(x) / sizeof((x)[0])) + \
ed63ec0d MT	225	QEMU_BUILD_BUG_ON_ZERO(!QEMU_IS_ARRAY(x)))
0954d0d9 BS	226	#endif
0954d0d9 BS	227
f97742d0	228	int qemu_daemon(int nochdir, int noclose);
7d2a35cc	229	void *qemu_try_memalign(size_t alignment, size_t size);
33f00271	230	void *qemu_memalign(size_t alignment, size_t size);
a2b257d6	231	void qemu_anon_ram_alloc(size_t size, uint64_t align);
49b470eb	232	void qemu_vfree(void *ptr);
e7a09b92	233	void qemu_anon_ram_free(void *ptr, size_t size);
ea88812f	234
e78815a5 AF	235	#define QEMU_MADV_INVALID -1
	236
	237	#if defined(CONFIG_MADVISE)
	238
	239	#define QEMU_MADV_WILLNEED MADV_WILLNEED
	240	#define QEMU_MADV_DONTNEED MADV_DONTNEED
	241	#ifdef MADV_DONTFORK
	242	#define QEMU_MADV_DONTFORK MADV_DONTFORK
	243	#else
	244	#define QEMU_MADV_DONTFORK QEMU_MADV_INVALID
	245	#endif
	246	#ifdef MADV_MERGEABLE
	247	#define QEMU_MADV_MERGEABLE MADV_MERGEABLE
	248	#else
	249	#define QEMU_MADV_MERGEABLE QEMU_MADV_INVALID
	250	#endif
605d0a94 PB	251	#ifdef MADV_UNMERGEABLE
	252	#define QEMU_MADV_UNMERGEABLE MADV_UNMERGEABLE
	253	#else
	254	#define QEMU_MADV_UNMERGEABLE QEMU_MADV_INVALID
	255	#endif
	256	#ifdef MADV_DODUMP
	257	#define QEMU_MADV_DODUMP MADV_DODUMP
	258	#else
	259	#define QEMU_MADV_DODUMP QEMU_MADV_INVALID
	260	#endif
ddb97f1d JB	261	#ifdef MADV_DONTDUMP
	262	#define QEMU_MADV_DONTDUMP MADV_DONTDUMP
	263	#else
	264	#define QEMU_MADV_DONTDUMP QEMU_MADV_INVALID
	265	#endif
ad0b5321 LC	266	#ifdef MADV_HUGEPAGE
	267	#define QEMU_MADV_HUGEPAGE MADV_HUGEPAGE
	268	#else
	269	#define QEMU_MADV_HUGEPAGE QEMU_MADV_INVALID
	270	#endif
ebf81150 DDAG	271	#ifdef MADV_NOHUGEPAGE
	272	#define QEMU_MADV_NOHUGEPAGE MADV_NOHUGEPAGE
	273	#else
	274	#define QEMU_MADV_NOHUGEPAGE QEMU_MADV_INVALID
	275	#endif
0f81d335 EH	276	#ifdef MADV_REMOVE
	277	#define QEMU_MADV_REMOVE MADV_REMOVE
	278	#else
	279	#define QEMU_MADV_REMOVE QEMU_MADV_INVALID
	280	#endif
e78815a5 AF	281
	282	#elif defined(CONFIG_POSIX_MADVISE)
	283
	284	#define QEMU_MADV_WILLNEED POSIX_MADV_WILLNEED
	285	#define QEMU_MADV_DONTNEED POSIX_MADV_DONTNEED
	286	#define QEMU_MADV_DONTFORK QEMU_MADV_INVALID
	287	#define QEMU_MADV_MERGEABLE QEMU_MADV_INVALID
2925020d MT	288	#define QEMU_MADV_UNMERGEABLE QEMU_MADV_INVALID
2925020d MT	289	#define QEMU_MADV_DODUMP QEMU_MADV_INVALID
ddb97f1d	290	#define QEMU_MADV_DONTDUMP QEMU_MADV_INVALID
8473f377	291	#define QEMU_MADV_HUGEPAGE QEMU_MADV_INVALID
ebf81150	292	#define QEMU_MADV_NOHUGEPAGE QEMU_MADV_INVALID
0f81d335	293	#define QEMU_MADV_REMOVE QEMU_MADV_INVALID
e78815a5 AF	294
	295	#else /* no-op */
	296
	297	#define QEMU_MADV_WILLNEED QEMU_MADV_INVALID
	298	#define QEMU_MADV_DONTNEED QEMU_MADV_INVALID
	299	#define QEMU_MADV_DONTFORK QEMU_MADV_INVALID
	300	#define QEMU_MADV_MERGEABLE QEMU_MADV_INVALID
2925020d MT	301	#define QEMU_MADV_UNMERGEABLE QEMU_MADV_INVALID
2925020d MT	302	#define QEMU_MADV_DODUMP QEMU_MADV_INVALID
ddb97f1d	303	#define QEMU_MADV_DONTDUMP QEMU_MADV_INVALID
8473f377	304	#define QEMU_MADV_HUGEPAGE QEMU_MADV_INVALID
ebf81150	305	#define QEMU_MADV_NOHUGEPAGE QEMU_MADV_INVALID
0f81d335	306	#define QEMU_MADV_REMOVE QEMU_MADV_INVALID
e78815a5 AF	307
	308	#endif
	309
d203c643 MAL	310	#ifdef _WIN32
	311	#define HAVE_CHARDEV_SERIAL 1
	312	#elif defined(__linux__) \|\| defined(__sun__) \|\| defined(__FreeBSD__) \
	313	\|\| defined(__NetBSD__) \|\| defined(__OpenBSD__) \|\| defined(__DragonFly__) \
	314	\|\| defined(__GLIBC__)
	315	#define HAVE_CHARDEV_SERIAL 1
	316	#endif
	317
	318	#if defined(__linux__) \|\| defined(__FreeBSD__) \|\| \
	319	defined(__FreeBSD_kernel__) \|\| defined(__DragonFly__)
	320	#define HAVE_CHARDEV_PARPORT 1
	321	#endif
	322
a16fc07e PB	323	#if defined(CONFIG_LINUX)
	324	#ifndef BUS_MCEERR_AR
	325	#define BUS_MCEERR_AR 4
	326	#endif
	327	#ifndef BUS_MCEERR_AO
	328	#define BUS_MCEERR_AO 5
	329	#endif
	330	#endif
	331
d2f39add DD	332	#if defined(__linux__) && \
	333	(defined(__x86_64__) \|\| defined(__arm__) \|\| defined(__aarch64__))
	334	/* Use 2 MiB alignment so transparent hugepages can be used by KVM.
	335	Valgrind does not support alignments larger than 1 MiB,
	336	therefore we need special code which handles running on Valgrind. */
	337	# define QEMU_VMALLOC_ALIGN (512 * 4096)
	338	#elif defined(__linux__) && defined(__s390x__)
	339	/* Use 1 MiB (segment size) alignment so gmap can be used by KVM. */
	340	# define QEMU_VMALLOC_ALIGN (256 * 4096)
	341	#else
	342	# define QEMU_VMALLOC_ALIGN getpagesize()
	343	#endif
	344
d98d4072 PB	345	#ifdef CONFIG_POSIX
	346	struct qemu_signalfd_siginfo {
	347	uint32_t ssi_signo; /* Signal number */
	348	int32_t ssi_errno; /* Error number (unused) */
	349	int32_t ssi_code; /* Signal code */
	350	uint32_t ssi_pid; /* PID of sender */
	351	uint32_t ssi_uid; /* Real UID of sender */
	352	int32_t ssi_fd; /* File descriptor (SIGIO) */
	353	uint32_t ssi_tid; /* Kernel timer ID (POSIX timers) */
	354	uint32_t ssi_band; /* Band event (SIGIO) */
	355	uint32_t ssi_overrun; /* POSIX timer overrun count */
	356	uint32_t ssi_trapno; /* Trap number that caused signal */
	357	int32_t ssi_status; /* Exit status or signal (SIGCHLD) */
	358	int32_t ssi_int; /* Integer sent by sigqueue(2) */
	359	uint64_t ssi_ptr; /* Pointer sent by sigqueue(2) */
	360	uint64_t ssi_utime; /* User CPU time consumed (SIGCHLD) */
	361	uint64_t ssi_stime; /* System CPU time consumed (SIGCHLD) */
	362	uint64_t ssi_addr; /* Address that generated signal
	363	(for hardware-generated signals) */
	364	uint8_t pad[48]; /* Pad size to 128 bytes (allow for
	365	additional fields in the future) */
	366	};
	367
	368	int qemu_signalfd(const sigset_t *mask);
	369	void sigaction_invoke(struct sigaction *action,
	370	struct qemu_signalfd_siginfo *info);
	371	#endif
	372
e78815a5 AF	373	int qemu_madvise(void *addr, size_t len, int advice);
e78815a5 AF	374
17e0b6ab AF	375	int qemu_open(const char *name, int flags, ...);
17e0b6ab AF	376	int qemu_close(int fd);
761d1ddf FZ	377	#ifndef _WIN32
	378	int qemu_dup(int fd);
	379	#endif
13461fdb FZ	380	int qemu_lock_fd(int fd, int64_t start, int64_t len, bool exclusive);
	381	int qemu_unlock_fd(int fd, int64_t start, int64_t len);
	382	int qemu_lock_fd_test(int fd, int64_t start, int64_t len, bool exclusive);
ca749954	383	bool qemu_has_ofd_lock(void);
17e0b6ab	384
953ffe0f AF	385	#if defined(__HAIKU__) && defined(__i386__)
953ffe0f AF	386	#define FMT_pid "%ld"
0e0167ba SW	387	#elif defined(WIN64)
0e0167ba SW	388	#define FMT_pid "%" PRId64
953ffe0f AF	389	#else
	390	#define FMT_pid "%d"
	391	#endif
	392
aa26bb2d	393	int qemu_create_pidfile(const char *filename);
dc7a09cf	394	int qemu_get_thread_id(void);
aa26bb2d	395
9adea5f7 PB	396	#ifndef CONFIG_IOVEC
	397	struct iovec {
	398	void *iov_base;
	399	size_t iov_len;
	400	};
	401	/*
	402	* Use the same value as Linux for now.
	403	*/
	404	#define IOV_MAX 1024
	405
	406	ssize_t readv(int fd, const struct iovec *iov, int iov_cnt);
	407	ssize_t writev(int fd, const struct iovec *iov, int iov_cnt);
	408	#else
	409	#include <sys/uio.h>
	410	#endif
	411
ad620c29 BS	412	#ifdef _WIN32
	413	static inline void qemu_timersub(const struct timeval *val1,
	414	const struct timeval *val2,
	415	struct timeval *res)
	416	{
	417	res->tv_sec = val1->tv_sec - val2->tv_sec;
	418	if (val1->tv_usec < val2->tv_usec) {
	419	res->tv_sec--;
	420	res->tv_usec = val1->tv_usec - val2->tv_usec + 1000 * 1000;
	421	} else {
	422	res->tv_usec = val1->tv_usec - val2->tv_usec;
	423	}
	424	}
	425	#else
	426	#define qemu_timersub timersub
	427	#endif
	428
49ee3590 AL	429	void qemu_set_cloexec(int fd);
49ee3590 AL	430
d494352c EH	431	/* Starting on QEMU 2.5, qemu_hw_version() returns "2.5+" by default
	432	* instead of QEMU_VERSION, so setting hw_version on MachineClass
	433	* is no longer mandatory.
	434	*
	435	* Do NOT change this string, or it will break compatibility on all
	436	* machine classes that don't set hw_version.
	437	*/
	438	#define QEMU_HW_VERSION "2.5+"
	439
fac862ff	440	/* QEMU "hardware version" setting. Used to replace code that exposed
cb8d4c8f	441	* QEMU_VERSION to guests in the past and need to keep compatibility.
fac862ff EH	442	* Do not use qemu_hw_version() in new code.
fac862ff EH	443	*/
35c2c8dc EH	444	void qemu_set_hw_version(const char *);
35c2c8dc EH	445	const char *qemu_hw_version(void);
93bfef4c	446
0f66998f PM	447	void fips_set_state(bool requested);
	448	bool fips_get_state(void);
	449
e2ea3515 LE	450	/* Return a dynamically allocated pathname denoting a file or directory that is
	451	* appropriate for storing local state.
	452	*
	453	* @relative_pathname need not start with a directory separator; one will be
	454	* added automatically.
	455	*
	456	* The caller is responsible for releasing the value returned with g_free()
	457	* after use.
	458	*/
	459	char qemu_get_local_state_pathname(const char relative_pathname);
	460
10f5bff6 FZ	461	/* Find program directory, and save it for later usage with
	462	* qemu_get_exec_dir().
	463	* Try OS specific API first, if not working, parse from argv0. */
	464	void qemu_init_exec_dir(const char *argv0);
	465
	466	/* Get the saved exec dir.
	467	* Caller needs to release the returned string by g_free() */
	468	char *qemu_get_exec_dir(void);
	469
b6a3e690 RH	470	/**
	471	* qemu_getauxval:
	472	* @type: the auxiliary vector key to lookup
	473	*
	474	* Search the auxiliary vector for @type, returning the value
	475	* or 0 if @type is not present.
	476	*/
b6a3e690	477	unsigned long qemu_getauxval(unsigned long type);
b6a3e690	478
13401ba0 SH	479	void qemu_set_tty_echo(int fd, bool echo);
13401ba0 SH	480
1e356fc1 JK	481	void os_mem_prealloc(int fd, char *area, size_t sz, int smp_cpus,
1e356fc1 JK	482	Error **errp);
38183310	483
7dc9ae43 MP	484	/**
	485	* qemu_get_pid_name:
	486	* @pid: pid of a process
	487	*
	488	* For given @pid fetch its name. Caller is responsible for
	489	* freeing the string when no longer needed.
	490	* Returns allocated string on success, NULL on failure.
	491	*/
	492	char *qemu_get_pid_name(pid_t pid);
	493
57cb38b3 DB	494	/**
	495	* qemu_fork:
	496	*
	497	* A version of fork that avoids signal handler race
	498	* conditions that can lead to child process getting
	499	* signals that are otherwise only expected by the
	500	* parent. It also resets all signal handlers to the
	501	* default settings.
	502	*
	503	* Returns 0 to child process, pid number to parent
	504	* or -1 on failure.
	505	*/
	506	pid_t qemu_fork(Error **errp);
	507
3637cf58 EC	508	/* Using intptr_t ensures that qemu_*_page_mask is sign-extended even
	509	* when intptr_t is 32-bit and we are aligning a long long.
	510	*/
	511	extern uintptr_t qemu_real_host_page_size;
	512	extern intptr_t qemu_real_host_page_mask;
	513
b255b2c8 EC	514	extern int qemu_icache_linesize;
	515	extern int qemu_dcache_linesize;
	516
ea88812f	517	#endif