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.h"
34 #include "exec/poison.h"
37 #include "qemu/compiler.h"
39 /* Older versions of C++ don't get definitions of various macros from
40 * stdlib.h unless we define these macros before first inclusion of
43 #ifndef __STDC_CONSTANT_MACROS
44 #define __STDC_CONSTANT_MACROS
46 #ifndef __STDC_LIMIT_MACROS
47 #define __STDC_LIMIT_MACROS
49 #ifndef __STDC_FORMAT_MACROS
50 #define __STDC_FORMAT_MACROS
53 /* The following block of code temporarily renames the daemon() function so the
54 * compiler does not see the warning associated with it in stdlib.h on OSX
57 #define daemon qemu_fake_daemon_function
60 extern int daemon(int, int);
64 /* as defined in sdkddkver.h */
66 #define _WIN32_WINNT 0x0600 /* Vista */
68 /* reduces the number of implicitly included headers */
69 #ifndef WIN32_LEAN_AND_MEAN
70 #define WIN32_LEAN_AND_MEAN
74 /* enable C99/POSIX format strings (needs mingw32-runtime 3.15 or later) */
76 #define __USE_MINGW_ANSI_STDIO 1
83 #include <sys/types.h>
91 /* Put unistd.h before time.h as that triggers localtime_r/gmtime_r
92 * function availability on recentish Mingw-w64 platforms. */
100 #include <sys/time.h>
102 /* setjmp must be declared before sysemu/os-win32.h
103 * because it is redefined there. */
108 #include <sys/signal.h>
112 #include <sys/wait.h>
114 #define WIFEXITED(x) 1
115 #define WEXITSTATUS(x) (x)
119 #include "sysemu/os-win32.h"
123 #include "sysemu/os-posix.h"
126 #include "glib-compat.h"
127 #include "qemu/typedefs.h"
130 * For mingw, as of v6.0.0, the function implementing the assert macro is
131 * not marked as noreturn, so the compiler cannot delete code following an
132 * assert(false) as unused. We rely on this within the code base to delete
133 * code that is unreachable when features are disabled.
134 * All supported versions of Glib's g_assert() satisfy this requirement.
138 #define assert(x) g_assert(x)
142 * According to waitpid man page:
144 * This macro is not specified in POSIX.1-2001 and is not
145 * available on some UNIX implementations (e.g., AIX, SunOS).
146 * Therefore, enclose its use inside #ifdef WCOREDUMP ... #endif.
149 #define WCOREDUMP(status) 0
152 * We have a lot of unaudited code that may fail in strange ways, or
153 * even be a security risk during migration, if you disable assertions
154 * at compile-time. You may comment out these safety checks if you
155 * absolutely want to disable assertion overhead, but it is not
156 * supported upstream so the risk is all yours. Meanwhile, please
157 * submit patches to remove any side-effects inside an assertion, or
158 * fixing error handling that should use Error instead of assert.
161 #error building with NDEBUG is not supported
163 #ifdef G_DISABLE_ASSERT
164 #error building with G_DISABLE_ASSERT is not supported
168 #define O_LARGEFILE 0
173 #ifndef MAP_ANONYMOUS
174 #define MAP_ANONYMOUS MAP_ANON
177 #define ENOMEDIUM ENODEV
179 #if !defined(ENOTSUP)
182 #if !defined(ECANCELED)
183 #define ECANCELED 4097
185 #if !defined(EMEDIUMTYPE)
186 #define EMEDIUMTYPE 4098
188 #if !defined(ESHUTDOWN)
189 #define ESHUTDOWN 4099
192 /* time_t may be either 32 or 64 bits depending on the host OS, and
193 * can be either signed or unsigned, so we can't just hardcode a
194 * specific maximum value. This is not a C preprocessor constant,
195 * so you can't use TIME_MAX in an #ifdef, but for our purposes
196 * this isn't a problem.
199 /* The macros TYPE_SIGNED, TYPE_WIDTH, and TYPE_MAXIMUM are from
200 * Gnulib, and are under the LGPL v2.1 or (at your option) any
204 /* True if the real type T is signed. */
205 #define TYPE_SIGNED(t) (!((t)0 < (t)-1))
207 /* The width in bits of the integer type or expression T.
208 * Padding bits are not supported.
210 #define TYPE_WIDTH(t) (sizeof(t) * CHAR_BIT)
212 /* The maximum and minimum values for the integer type T. */
213 #define TYPE_MAXIMUM(t) \
214 ((t) (!TYPE_SIGNED(t) \
216 : ((((t)1 << (TYPE_WIDTH(t) - 2)) - 1) * 2 + 1)))
219 #define TIME_MAX TYPE_MAXIMUM(time_t)
222 /* HOST_LONG_BITS is the size of a native pointer in bits. */
223 #if UINTPTR_MAX == UINT32_MAX
224 # define HOST_LONG_BITS 32
225 #elif UINTPTR_MAX == UINT64_MAX
226 # define HOST_LONG_BITS 64
228 # error Unknown pointer size
231 /* Mac OSX has a <stdint.h> bug that incorrectly defines SIZE_MAX with
232 * the wrong type. Our replacement isn't usable in preprocessor
233 * expressions, but it is sufficient for our needs. */
234 #if defined(HAVE_BROKEN_SIZE_MAX) && HAVE_BROKEN_SIZE_MAX
236 #define SIZE_MAX ((size_t)-1)
240 * Two variations of MIN/MAX macros. The first is for runtime use, and
241 * evaluates arguments only once (so it is safe even with side
242 * effects), but will not work in constant contexts (such as array
243 * size declarations) because of the '{}'. The second is for constant
244 * expression use, where evaluating arguments twice is safe because
245 * the result is going to be constant anyway, but will not work in a
246 * runtime context because of a void expression where a value is
247 * expected. Thus, both gcc and clang will fail to compile if you use
248 * the wrong macro (even if the error may seem a bit cryptic).
250 * Note that neither form is usable as an #if condition; if you truly
251 * need to write conditional code that depends on a minimum or maximum
252 * determined by the pre-processor instead of the compiler, you'll
253 * have to open-code it.
258 typeof(1 ? (a) : (b)) _a = (a), _b = (b); \
261 #define MIN_CONST(a, b) \
262 __builtin_choose_expr( \
263 __builtin_constant_p(a) && __builtin_constant_p(b), \
264 (a) < (b) ? (a) : (b), \
269 typeof(1 ? (a) : (b)) _a = (a), _b = (b); \
272 #define MAX_CONST(a, b) \
273 __builtin_choose_expr( \
274 __builtin_constant_p(a) && __builtin_constant_p(b), \
275 (a) > (b) ? (a) : (b), \
279 * Minimum function that returns zero only if both values are zero.
280 * Intended for use with unsigned values only.
283 #define MIN_NON_ZERO(a, b) \
285 typeof(1 ? (a) : (b)) _a = (a), _b = (b); \
286 _a == 0 ? _b : (_b == 0 || _b > _a) ? _a : _b; \
290 /* Round number down to multiple */
291 #define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
293 /* Round number up to multiple. Safe when m is not a power of 2 (see
294 * ROUND_UP for a faster version when a power of 2 is guaranteed) */
295 #define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
297 /* Check if n is a multiple of m */
298 #define QEMU_IS_ALIGNED(n, m) (((n) % (m)) == 0)
300 /* n-byte align pointer down */
301 #define QEMU_ALIGN_PTR_DOWN(p, n) \
302 ((typeof(p))QEMU_ALIGN_DOWN((uintptr_t)(p), (n)))
304 /* n-byte align pointer up */
305 #define QEMU_ALIGN_PTR_UP(p, n) \
306 ((typeof(p))QEMU_ALIGN_UP((uintptr_t)(p), (n)))
308 /* Check if pointer p is n-bytes aligned */
309 #define QEMU_PTR_IS_ALIGNED(p, n) QEMU_IS_ALIGNED((uintptr_t)(p), (n))
311 /* Round number up to multiple. Requires that d be a power of 2 (see
312 * QEMU_ALIGN_UP for a safer but slower version on arbitrary
313 * numbers); works even if d is a smaller type than n. */
315 #define ROUND_UP(n, d) (((n) + (d) - 1) & -(0 ? (n) : (d)))
319 #define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
323 * &(x)[0] is always a pointer - if it's same type as x then the argument is a
324 * pointer, not an array.
326 #define QEMU_IS_ARRAY(x) (!__builtin_types_compatible_p(typeof(x), \
329 #define ARRAY_SIZE(x) ((sizeof(x) / sizeof((x)[0])) + \
330 QEMU_BUILD_BUG_ON_ZERO(!QEMU_IS_ARRAY(x)))
333 int qemu_daemon(int nochdir
, int noclose
);
334 void *qemu_try_memalign(size_t alignment
, size_t size
);
335 void *qemu_memalign(size_t alignment
, size_t size
);
336 void *qemu_anon_ram_alloc(size_t size
, uint64_t *align
, bool shared
);
337 void qemu_vfree(void *ptr
);
338 void qemu_anon_ram_free(void *ptr
, size_t size
);
340 #define QEMU_MADV_INVALID -1
342 #if defined(CONFIG_MADVISE)
344 #define QEMU_MADV_WILLNEED MADV_WILLNEED
345 #define QEMU_MADV_DONTNEED MADV_DONTNEED
347 #define QEMU_MADV_DONTFORK MADV_DONTFORK
349 #define QEMU_MADV_DONTFORK QEMU_MADV_INVALID
351 #ifdef MADV_MERGEABLE
352 #define QEMU_MADV_MERGEABLE MADV_MERGEABLE
354 #define QEMU_MADV_MERGEABLE QEMU_MADV_INVALID
356 #ifdef MADV_UNMERGEABLE
357 #define QEMU_MADV_UNMERGEABLE MADV_UNMERGEABLE
359 #define QEMU_MADV_UNMERGEABLE QEMU_MADV_INVALID
362 #define QEMU_MADV_DODUMP MADV_DODUMP
364 #define QEMU_MADV_DODUMP QEMU_MADV_INVALID
367 #define QEMU_MADV_DONTDUMP MADV_DONTDUMP
369 #define QEMU_MADV_DONTDUMP QEMU_MADV_INVALID
372 #define QEMU_MADV_HUGEPAGE MADV_HUGEPAGE
374 #define QEMU_MADV_HUGEPAGE QEMU_MADV_INVALID
376 #ifdef MADV_NOHUGEPAGE
377 #define QEMU_MADV_NOHUGEPAGE MADV_NOHUGEPAGE
379 #define QEMU_MADV_NOHUGEPAGE QEMU_MADV_INVALID
382 #define QEMU_MADV_REMOVE MADV_REMOVE
384 #define QEMU_MADV_REMOVE QEMU_MADV_INVALID
387 #elif defined(CONFIG_POSIX_MADVISE)
389 #define QEMU_MADV_WILLNEED POSIX_MADV_WILLNEED
390 #define QEMU_MADV_DONTNEED POSIX_MADV_DONTNEED
391 #define QEMU_MADV_DONTFORK QEMU_MADV_INVALID
392 #define QEMU_MADV_MERGEABLE QEMU_MADV_INVALID
393 #define QEMU_MADV_UNMERGEABLE QEMU_MADV_INVALID
394 #define QEMU_MADV_DODUMP QEMU_MADV_INVALID
395 #define QEMU_MADV_DONTDUMP QEMU_MADV_INVALID
396 #define QEMU_MADV_HUGEPAGE QEMU_MADV_INVALID
397 #define QEMU_MADV_NOHUGEPAGE QEMU_MADV_INVALID
398 #define QEMU_MADV_REMOVE QEMU_MADV_INVALID
402 #define QEMU_MADV_WILLNEED QEMU_MADV_INVALID
403 #define QEMU_MADV_DONTNEED QEMU_MADV_INVALID
404 #define QEMU_MADV_DONTFORK QEMU_MADV_INVALID
405 #define QEMU_MADV_MERGEABLE QEMU_MADV_INVALID
406 #define QEMU_MADV_UNMERGEABLE QEMU_MADV_INVALID
407 #define QEMU_MADV_DODUMP QEMU_MADV_INVALID
408 #define QEMU_MADV_DONTDUMP QEMU_MADV_INVALID
409 #define QEMU_MADV_HUGEPAGE QEMU_MADV_INVALID
410 #define QEMU_MADV_NOHUGEPAGE QEMU_MADV_INVALID
411 #define QEMU_MADV_REMOVE QEMU_MADV_INVALID
416 #define HAVE_CHARDEV_SERIAL 1
417 #elif defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
418 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) \
419 || defined(__GLIBC__) || defined(__APPLE__)
420 #define HAVE_CHARDEV_SERIAL 1
423 #if defined(__linux__) || defined(__FreeBSD__) || \
424 defined(__FreeBSD_kernel__) || defined(__DragonFly__)
425 #define HAVE_CHARDEV_PARPORT 1
428 #if defined(CONFIG_LINUX)
429 #ifndef BUS_MCEERR_AR
430 #define BUS_MCEERR_AR 4
432 #ifndef BUS_MCEERR_AO
433 #define BUS_MCEERR_AO 5
437 #if defined(__linux__) && \
438 (defined(__x86_64__) || defined(__arm__) || defined(__aarch64__) \
439 || defined(__powerpc64__))
440 /* Use 2 MiB alignment so transparent hugepages can be used by KVM.
441 Valgrind does not support alignments larger than 1 MiB,
442 therefore we need special code which handles running on Valgrind. */
443 # define QEMU_VMALLOC_ALIGN (512 * 4096)
444 #elif defined(__linux__) && defined(__s390x__)
445 /* Use 1 MiB (segment size) alignment so gmap can be used by KVM. */
446 # define QEMU_VMALLOC_ALIGN (256 * 4096)
447 #elif defined(__linux__) && defined(__sparc__)
449 # define QEMU_VMALLOC_ALIGN MAX(qemu_real_host_page_size, SHMLBA)
451 # define QEMU_VMALLOC_ALIGN qemu_real_host_page_size
455 struct qemu_signalfd_siginfo
{
456 uint32_t ssi_signo
; /* Signal number */
457 int32_t ssi_errno
; /* Error number (unused) */
458 int32_t ssi_code
; /* Signal code */
459 uint32_t ssi_pid
; /* PID of sender */
460 uint32_t ssi_uid
; /* Real UID of sender */
461 int32_t ssi_fd
; /* File descriptor (SIGIO) */
462 uint32_t ssi_tid
; /* Kernel timer ID (POSIX timers) */
463 uint32_t ssi_band
; /* Band event (SIGIO) */
464 uint32_t ssi_overrun
; /* POSIX timer overrun count */
465 uint32_t ssi_trapno
; /* Trap number that caused signal */
466 int32_t ssi_status
; /* Exit status or signal (SIGCHLD) */
467 int32_t ssi_int
; /* Integer sent by sigqueue(2) */
468 uint64_t ssi_ptr
; /* Pointer sent by sigqueue(2) */
469 uint64_t ssi_utime
; /* User CPU time consumed (SIGCHLD) */
470 uint64_t ssi_stime
; /* System CPU time consumed (SIGCHLD) */
471 uint64_t ssi_addr
; /* Address that generated signal
472 (for hardware-generated signals) */
473 uint8_t pad
[48]; /* Pad size to 128 bytes (allow for
474 additional fields in the future) */
477 int qemu_signalfd(const sigset_t
*mask
);
478 void sigaction_invoke(struct sigaction
*action
,
479 struct qemu_signalfd_siginfo
*info
);
482 int qemu_madvise(void *addr
, size_t len
, int advice
);
483 int qemu_mprotect_rwx(void *addr
, size_t size
);
484 int qemu_mprotect_none(void *addr
, size_t size
);
486 int qemu_open(const char *name
, int flags
, ...);
487 int qemu_close(int fd
);
488 int qemu_unlink(const char *name
);
490 int qemu_dup(int fd
);
492 int qemu_lock_fd(int fd
, int64_t start
, int64_t len
, bool exclusive
);
493 int qemu_unlock_fd(int fd
, int64_t start
, int64_t len
);
494 int qemu_lock_fd_test(int fd
, int64_t start
, int64_t len
, bool exclusive
);
495 bool qemu_has_ofd_lock(void);
497 #if defined(__HAIKU__) && defined(__i386__)
498 #define FMT_pid "%ld"
500 #define FMT_pid "%" PRId64
505 bool qemu_write_pidfile(const char *pidfile
, Error
**errp
);
507 int qemu_get_thread_id(void);
515 * Use the same value as Linux for now.
519 ssize_t
readv(int fd
, const struct iovec
*iov
, int iov_cnt
);
520 ssize_t
writev(int fd
, const struct iovec
*iov
, int iov_cnt
);
526 static inline void qemu_timersub(const struct timeval
*val1
,
527 const struct timeval
*val2
,
530 res
->tv_sec
= val1
->tv_sec
- val2
->tv_sec
;
531 if (val1
->tv_usec
< val2
->tv_usec
) {
533 res
->tv_usec
= val1
->tv_usec
- val2
->tv_usec
+ 1000 * 1000;
535 res
->tv_usec
= val1
->tv_usec
- val2
->tv_usec
;
539 #define qemu_timersub timersub
542 void qemu_set_cloexec(int fd
);
544 /* Starting on QEMU 2.5, qemu_hw_version() returns "2.5+" by default
545 * instead of QEMU_VERSION, so setting hw_version on MachineClass
546 * is no longer mandatory.
548 * Do NOT change this string, or it will break compatibility on all
549 * machine classes that don't set hw_version.
551 #define QEMU_HW_VERSION "2.5+"
553 /* QEMU "hardware version" setting. Used to replace code that exposed
554 * QEMU_VERSION to guests in the past and need to keep compatibility.
555 * Do not use qemu_hw_version() in new code.
557 void qemu_set_hw_version(const char *);
558 const char *qemu_hw_version(void);
560 void fips_set_state(bool requested
);
561 bool fips_get_state(void);
563 /* Return a dynamically allocated pathname denoting a file or directory that is
564 * appropriate for storing local state.
566 * @relative_pathname need not start with a directory separator; one will be
567 * added automatically.
569 * The caller is responsible for releasing the value returned with g_free()
572 char *qemu_get_local_state_pathname(const char *relative_pathname
);
574 /* Find program directory, and save it for later usage with
575 * qemu_get_exec_dir().
576 * Try OS specific API first, if not working, parse from argv0. */
577 void qemu_init_exec_dir(const char *argv0
);
579 /* Get the saved exec dir.
580 * Caller needs to release the returned string by g_free() */
581 char *qemu_get_exec_dir(void);
585 * @type: the auxiliary vector key to lookup
587 * Search the auxiliary vector for @type, returning the value
588 * or 0 if @type is not present.
590 unsigned long qemu_getauxval(unsigned long type
);
592 void qemu_set_tty_echo(int fd
, bool echo
);
594 void os_mem_prealloc(int fd
, char *area
, size_t sz
, int smp_cpus
,
599 * @pid: pid of a process
601 * For given @pid fetch its name. Caller is responsible for
602 * freeing the string when no longer needed.
603 * Returns allocated string on success, NULL on failure.
605 char *qemu_get_pid_name(pid_t pid
);
610 * A version of fork that avoids signal handler race
611 * conditions that can lead to child process getting
612 * signals that are otherwise only expected by the
613 * parent. It also resets all signal handlers to the
616 * Returns 0 to child process, pid number to parent
619 pid_t
qemu_fork(Error
**errp
);
621 /* Using intptr_t ensures that qemu_*_page_mask is sign-extended even
622 * when intptr_t is 32-bit and we are aligning a long long.
624 extern uintptr_t qemu_real_host_page_size
;
625 extern intptr_t qemu_real_host_page_mask
;
627 extern int qemu_icache_linesize
;
628 extern int qemu_icache_linesize_log
;
629 extern int qemu_dcache_linesize
;
630 extern int qemu_dcache_linesize_log
;
633 * After using getopt or getopt_long, if you need to parse another set
634 * of options, then you must reset optind. Unfortunately the way to
635 * do this varies between implementations of getopt.
637 static inline void qemu_reset_optind(void)