2 * OS includes and handling of OS dependencies
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).
8 * To avoid getting into possible circular include dependencies, this
9 * file should not include any other QEMU headers, with the exceptions
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.
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.
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
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.
30 #include "config-host.h"
32 #include CONFIG_TARGET
34 #include "exec/poison.h"
38 * HOST_WORDS_BIGENDIAN was replaced with HOST_BIG_ENDIAN. Prevent it from
41 #pragma GCC poison HOST_WORDS_BIGENDIAN
44 * TARGET_WORDS_BIGENDIAN was replaced with TARGET_BIG_ENDIAN. Prevent it from
47 #pragma GCC poison TARGET_WORDS_BIGENDIAN
49 #include "qemu/compiler.h"
51 /* Older versions of C++ don't get definitions of various macros from
52 * stdlib.h unless we define these macros before first inclusion of
55 #ifndef __STDC_CONSTANT_MACROS
56 #define __STDC_CONSTANT_MACROS
58 #ifndef __STDC_LIMIT_MACROS
59 #define __STDC_LIMIT_MACROS
61 #ifndef __STDC_FORMAT_MACROS
62 #define __STDC_FORMAT_MACROS
65 /* The following block of code temporarily renames the daemon() function so the
66 * compiler does not see the warning associated with it in stdlib.h on OSX
69 #define daemon qemu_fake_daemon_function
72 QEMU_EXTERN_C int daemon(int, int);
76 /* as defined in sdkddkver.h */
78 #define _WIN32_WINNT 0x0600 /* Vista */
80 /* reduces the number of implicitly included headers */
81 #ifndef WIN32_LEAN_AND_MEAN
82 #define WIN32_LEAN_AND_MEAN
86 /* enable C99/POSIX format strings (needs mingw32-runtime 3.15 or later) */
88 #define __USE_MINGW_ANSI_STDIO 1
95 #include <sys/types.h>
101 #include <inttypes.h>
103 /* Put unistd.h before time.h as that triggers localtime_r/gmtime_r
104 * function availability on recentish Mingw-w64 platforms. */
111 #include <sys/stat.h>
112 #include <sys/time.h>
114 /* setjmp must be declared before sysemu/os-win32.h
115 * because it is redefined there. */
123 #if defined(__linux__) && defined(__sparc__)
124 /* The SPARC definition of QEMU_VMALLOC_ALIGN needs SHMLBA */
129 #include <sys/wait.h>
131 #define WIFEXITED(x) 1
132 #define WEXITSTATUS(x) (x)
136 #include <AvailabilityMacros.h>
140 * This is somewhat like a system header; it must be outside any extern "C"
141 * block because it includes system headers itself, including glib.h,
142 * which will not compile if inside an extern "C" block.
144 #include "glib-compat.h"
147 #include "sysemu/os-win32.h"
151 #include "sysemu/os-posix.h"
158 #include "qemu/typedefs.h"
161 * For mingw, as of v6.0.0, the function implementing the assert macro is
162 * not marked as noreturn, so the compiler cannot delete code following an
163 * assert(false) as unused. We rely on this within the code base to delete
164 * code that is unreachable when features are disabled.
165 * All supported versions of Glib's g_assert() satisfy this requirement.
169 #define assert(x) g_assert(x)
173 * According to waitpid man page:
175 * This macro is not specified in POSIX.1-2001 and is not
176 * available on some UNIX implementations (e.g., AIX, SunOS).
177 * Therefore, enclose its use inside #ifdef WCOREDUMP ... #endif.
180 #define WCOREDUMP(status) 0
183 * We have a lot of unaudited code that may fail in strange ways, or
184 * even be a security risk during migration, if you disable assertions
185 * at compile-time. You may comment out these safety checks if you
186 * absolutely want to disable assertion overhead, but it is not
187 * supported upstream so the risk is all yours. Meanwhile, please
188 * submit patches to remove any side-effects inside an assertion, or
189 * fixing error handling that should use Error instead of assert.
192 #error building with NDEBUG is not supported
194 #ifdef G_DISABLE_ASSERT
195 #error building with G_DISABLE_ASSERT is not supported
199 #define O_LARGEFILE 0
204 #ifndef MAP_ANONYMOUS
205 #define MAP_ANONYMOUS MAP_ANON
207 #ifndef MAP_FIXED_NOREPLACE
208 #define MAP_FIXED_NOREPLACE 0
210 #ifndef MAP_NORESERVE
211 #define MAP_NORESERVE 0
214 #define ENOMEDIUM ENODEV
216 #if !defined(ENOTSUP)
219 #if !defined(ECANCELED)
220 #define ECANCELED 4097
222 #if !defined(EMEDIUMTYPE)
223 #define EMEDIUMTYPE 4098
225 #if !defined(ESHUTDOWN)
226 #define ESHUTDOWN 4099
229 #define TFR(expr) do { if ((expr) != -1) break; } while (errno == EINTR)
231 /* time_t may be either 32 or 64 bits depending on the host OS, and
232 * can be either signed or unsigned, so we can't just hardcode a
233 * specific maximum value. This is not a C preprocessor constant,
234 * so you can't use TIME_MAX in an #ifdef, but for our purposes
235 * this isn't a problem.
238 /* The macros TYPE_SIGNED, TYPE_WIDTH, and TYPE_MAXIMUM are from
239 * Gnulib, and are under the LGPL v2.1 or (at your option) any
243 /* True if the real type T is signed. */
244 #define TYPE_SIGNED(t) (!((t)0 < (t)-1))
246 /* The width in bits of the integer type or expression T.
247 * Padding bits are not supported.
249 #define TYPE_WIDTH(t) (sizeof(t) * CHAR_BIT)
251 /* The maximum and minimum values for the integer type T. */
252 #define TYPE_MAXIMUM(t) \
253 ((t) (!TYPE_SIGNED(t) \
255 : ((((t)1 << (TYPE_WIDTH(t) - 2)) - 1) * 2 + 1)))
258 #define TIME_MAX TYPE_MAXIMUM(time_t)
261 /* Mac OSX has a <stdint.h> bug that incorrectly defines SIZE_MAX with
262 * the wrong type. Our replacement isn't usable in preprocessor
263 * expressions, but it is sufficient for our needs. */
264 #ifdef HAVE_BROKEN_SIZE_MAX
266 #define SIZE_MAX ((size_t)-1)
270 * Two variations of MIN/MAX macros. The first is for runtime use, and
271 * evaluates arguments only once (so it is safe even with side
272 * effects), but will not work in constant contexts (such as array
273 * size declarations) because of the '{}'. The second is for constant
274 * expression use, where evaluating arguments twice is safe because
275 * the result is going to be constant anyway, but will not work in a
276 * runtime context because of a void expression where a value is
277 * expected. Thus, both gcc and clang will fail to compile if you use
278 * the wrong macro (even if the error may seem a bit cryptic).
280 * Note that neither form is usable as an #if condition; if you truly
281 * need to write conditional code that depends on a minimum or maximum
282 * determined by the pre-processor instead of the compiler, you'll
283 * have to open-code it. Sadly, Coverity is severely confused by the
284 * constant variants, so we have to dumb things down there.
289 typeof(1 ? (a) : (b)) _a = (a), _b = (b); \
295 typeof(1 ? (a) : (b)) _a = (a), _b = (b); \
300 # define MIN_CONST(a, b) ((a) < (b) ? (a) : (b))
301 # define MAX_CONST(a, b) ((a) > (b) ? (a) : (b))
303 # define MIN_CONST(a, b) \
304 __builtin_choose_expr( \
305 __builtin_constant_p(a) && __builtin_constant_p(b), \
306 (a) < (b) ? (a) : (b), \
308 # define MAX_CONST(a, b) \
309 __builtin_choose_expr( \
310 __builtin_constant_p(a) && __builtin_constant_p(b), \
311 (a) > (b) ? (a) : (b), \
316 * Minimum function that returns zero only if both values are zero.
317 * Intended for use with unsigned values only.
320 #define MIN_NON_ZERO(a, b) \
322 typeof(1 ? (a) : (b)) _a = (a), _b = (b); \
323 _a == 0 ? _b : (_b == 0 || _b > _a) ? _a : _b; \
328 * Round number down to multiple. Safe when m is not a power of 2 (see
329 * ROUND_DOWN for a faster version when a power of 2 is guaranteed).
331 #define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
334 * Round number up to multiple. Safe when m is not a power of 2 (see
335 * ROUND_UP for a faster version when a power of 2 is guaranteed).
337 #define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
339 /* Check if n is a multiple of m */
340 #define QEMU_IS_ALIGNED(n, m) (((n) % (m)) == 0)
342 /* n-byte align pointer down */
343 #define QEMU_ALIGN_PTR_DOWN(p, n) \
344 ((typeof(p))QEMU_ALIGN_DOWN((uintptr_t)(p), (n)))
346 /* n-byte align pointer up */
347 #define QEMU_ALIGN_PTR_UP(p, n) \
348 ((typeof(p))QEMU_ALIGN_UP((uintptr_t)(p), (n)))
350 /* Check if pointer p is n-bytes aligned */
351 #define QEMU_PTR_IS_ALIGNED(p, n) QEMU_IS_ALIGNED((uintptr_t)(p), (n))
354 * Round number down to multiple. Requires that d be a power of 2 (see
355 * QEMU_ALIGN_UP for a safer but slower version on arbitrary
356 * numbers); works even if d is a smaller type than n.
359 #define ROUND_DOWN(n, d) ((n) & -(0 ? (n) : (d)))
363 * Round number up to multiple. Requires that d be a power of 2 (see
364 * QEMU_ALIGN_UP for a safer but slower version on arbitrary
365 * numbers); works even if d is a smaller type than n.
368 #define ROUND_UP(n, d) ROUND_DOWN((n) + (d) - 1, (d))
372 #define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
376 * &(x)[0] is always a pointer - if it's same type as x then the argument is a
377 * pointer, not an array.
379 #define QEMU_IS_ARRAY(x) (!__builtin_types_compatible_p(typeof(x), \
382 #define ARRAY_SIZE(x) ((sizeof(x) / sizeof((x)[0])) + \
383 QEMU_BUILD_BUG_ON_ZERO(!QEMU_IS_ARRAY(x)))
386 int qemu_daemon(int nochdir, int noclose);
387 void *qemu_anon_ram_alloc(size_t size, uint64_t *align, bool shared,
389 void qemu_anon_ram_free(void *ptr, size_t size);
392 #define HAVE_CHARDEV_SERIAL 1
393 #elif defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
394 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) \
395 || defined(__GLIBC__) || defined(__APPLE__)
396 #define HAVE_CHARDEV_SERIAL 1
399 #if defined(__linux__) || defined(__FreeBSD__) || \
400 defined(__FreeBSD_kernel__) || defined(__DragonFly__)
401 #define HAVE_CHARDEV_PARPORT 1
404 #if defined(__HAIKU__)
405 #define SIGIO SIGPOLL
408 #ifdef HAVE_MADVISE_WITHOUT_PROTOTYPE
410 * See MySQL bug #7156 (http://bugs.mysql.com/bug.php?id=7156) for discussion
411 * about Solaris missing the madvise() prototype.
413 extern int madvise(char *, size_t, int);
416 #if defined(CONFIG_LINUX)
417 #ifndef BUS_MCEERR_AR
418 #define BUS_MCEERR_AR 4
420 #ifndef BUS_MCEERR_AO
421 #define BUS_MCEERR_AO 5
425 #if defined(__linux__) && \
426 (defined(__x86_64__) || defined(__arm__) || defined(__aarch64__) \
427 || defined(__powerpc64__))
428 /* Use 2 MiB alignment so transparent hugepages can be used by KVM.
429 Valgrind does not support alignments larger than 1 MiB,
430 therefore we need special code which handles running on Valgrind. */
431 # define QEMU_VMALLOC_ALIGN (512 * 4096)
432 #elif defined(__linux__) && defined(__s390x__)
433 /* Use 1 MiB (segment size) alignment so gmap can be used by KVM. */
434 # define QEMU_VMALLOC_ALIGN (256 * 4096)
435 #elif defined(__linux__) && defined(__sparc__)
436 # define QEMU_VMALLOC_ALIGN MAX(qemu_real_host_page_size(), SHMLBA)
438 # define QEMU_VMALLOC_ALIGN qemu_real_host_page_size()
442 struct qemu_signalfd_siginfo {
443 uint32_t ssi_signo; /* Signal number */
444 int32_t ssi_errno; /* Error number (unused) */
445 int32_t ssi_code; /* Signal code */
446 uint32_t ssi_pid; /* PID of sender */
447 uint32_t ssi_uid; /* Real UID of sender */
448 int32_t ssi_fd; /* File descriptor (SIGIO) */
449 uint32_t ssi_tid; /* Kernel timer ID (POSIX timers) */
450 uint32_t ssi_band; /* Band event (SIGIO) */
451 uint32_t ssi_overrun; /* POSIX timer overrun count */
452 uint32_t ssi_trapno; /* Trap number that caused signal */
453 int32_t ssi_status; /* Exit status or signal (SIGCHLD) */
454 int32_t ssi_int; /* Integer sent by sigqueue(2) */
455 uint64_t ssi_ptr; /* Pointer sent by sigqueue(2) */
456 uint64_t ssi_utime; /* User CPU time consumed (SIGCHLD) */
457 uint64_t ssi_stime; /* System CPU time consumed (SIGCHLD) */
458 uint64_t ssi_addr; /* Address that generated signal
459 (for hardware-generated signals) */
460 uint8_t pad[48]; /* Pad size to 128 bytes (allow for
461 additional fields in the future) */
464 int qemu_signalfd(const sigset_t *mask);
465 void sigaction_invoke(struct sigaction *action,
466 struct qemu_signalfd_siginfo *info);
470 * Don't introduce new usage of this function, prefer the following
471 * qemu_open/qemu_create that take an "Error **errp"
473 int qemu_open_old(const char *name, int flags, ...);
474 int qemu_open(const char *name, int flags, Error **errp);
475 int qemu_create(const char *name, int flags, mode_t mode, Error **errp);
476 int qemu_close(int fd);
477 int qemu_unlink(const char *name);
479 int qemu_dup_flags(int fd, int flags);
480 int qemu_dup(int fd);
481 int qemu_lock_fd(int fd, int64_t start, int64_t len, bool exclusive);
482 int qemu_unlock_fd(int fd, int64_t start, int64_t len);
483 int qemu_lock_fd_test(int fd, int64_t start, int64_t len, bool exclusive);
484 bool qemu_has_ofd_lock(void);
487 #if defined(__HAIKU__) && defined(__i386__)
488 #define FMT_pid "%ld"
490 #define FMT_pid "%" PRId64
495 bool qemu_write_pidfile(const char *pidfile, Error **errp);
497 int qemu_get_thread_id(void);
505 * Use the same value as Linux for now.
509 ssize_t readv(int fd, const struct iovec *iov, int iov_cnt);
510 ssize_t writev(int fd, const struct iovec *iov, int iov_cnt);
514 static inline void qemu_timersub(const struct timeval *val1,
515 const struct timeval *val2,
518 res->tv_sec = val1->tv_sec - val2->tv_sec;
519 if (val1->tv_usec < val2->tv_usec) {
521 res->tv_usec = val1->tv_usec - val2->tv_usec + 1000 * 1000;
523 res->tv_usec = val1->tv_usec - val2->tv_usec;
527 #define qemu_timersub timersub
530 ssize_t qemu_write_full(int fd, const void *buf, size_t count)
531 G_GNUC_WARN_UNUSED_RESULT;
534 int qemu_pipe(int pipefd[2]);
537 void qemu_set_cloexec(int fd);
539 void fips_set_state(bool requested);
540 bool fips_get_state(void);
542 /* Return a dynamically allocated pathname denoting a file or directory that is
543 * appropriate for storing local state.
545 * @relative_pathname need not start with a directory separator; one will be
546 * added automatically.
548 * The caller is responsible for releasing the value returned with g_free()
551 char *qemu_get_local_state_pathname(const char *relative_pathname);
553 /* Find program directory, and save it for later usage with
554 * qemu_get_exec_dir().
555 * Try OS specific API first, if not working, parse from argv0. */
556 void qemu_init_exec_dir(const char *argv0);
558 /* Get the saved exec dir. */
559 const char *qemu_get_exec_dir(void);
563 * @type: the auxiliary vector key to lookup
565 * Search the auxiliary vector for @type, returning the value
566 * or 0 if @type is not present.
568 unsigned long qemu_getauxval(unsigned long type);
570 void qemu_set_tty_echo(int fd, bool echo);
572 void os_mem_prealloc(int fd, char *area, size_t sz, int smp_cpus,
577 * @pid: pid of a process
579 * For given @pid fetch its name. Caller is responsible for
580 * freeing the string when no longer needed.
581 * Returns allocated string on success, NULL on failure.
583 char *qemu_get_pid_name(pid_t pid);
588 * A version of fork that avoids signal handler race
589 * conditions that can lead to child process getting
590 * signals that are otherwise only expected by the
591 * parent. It also resets all signal handlers to the
594 * Returns 0 to child process, pid number to parent
597 pid_t qemu_fork(Error **errp);
599 /* Using intptr_t ensures that qemu_*_page_mask is sign-extended even
600 * when intptr_t is 32-bit and we are aligning a long long.
602 static inline uintptr_t qemu_real_host_page_size(void)
604 return getpagesize();
607 static inline intptr_t qemu_real_host_page_mask(void)
609 return -(intptr_t)qemu_real_host_page_size();
613 * After using getopt or getopt_long, if you need to parse another set
614 * of options, then you must reset optind. Unfortunately the way to
615 * do this varies between implementations of getopt.
617 static inline void qemu_reset_optind(void)
628 * qemu_get_host_name:
629 * @errp: Error object
631 * Operating system agnostic way of querying host name.
633 * Returns allocated hostname (caller should free), NULL on failure.
635 char *qemu_get_host_name(Error **errp);
638 * qemu_get_host_physmem:
640 * Operating system agnostic way of querying host memory.
642 * Returns amount of physical memory on the system. This is purely
643 * advisery and may return 0 if we can't work it out. At the other
644 * end we saturate to SIZE_MAX if you are lucky enough to have that
647 size_t qemu_get_host_physmem(void);
650 * Toggle write/execute on the pages marked MAP_JIT
651 * for the current thread.
653 #if defined(MAC_OS_VERSION_11_0) && \
654 MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_VERSION_11_0
655 static inline void qemu_thread_jit_execute(void)
657 pthread_jit_write_protect_np(true);
660 static inline void qemu_thread_jit_write(void)
662 pthread_jit_write_protect_np(false);
665 static inline void qemu_thread_jit_write(void) {}
666 static inline void qemu_thread_jit_execute(void) {}
670 * Platforms which do not support system() return ENOSYS
672 #ifndef HAVE_SYSTEM_FUNCTION
673 #define system platform_does_not_support_system
674 static inline int platform_does_not_support_system(const char *command)
679 #endif /* !HAVE_SYSTEM_FUNCTION */