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 /* Coverity does not like the new _Float* types that are used by
38 * recent glibc, and croaks on every single file that includes
39 * stdlib.h. These typedefs are enough to please it.
41 * Note that these fix parse errors so they cannot be placed in
42 * scripts/coverity-model.c.
44 typedef float _Float32;
45 typedef double _Float32x;
46 typedef double _Float64;
47 typedef __float80 _Float64x;
48 typedef __float128 _Float128;
51 #include "qemu/compiler.h"
53 /* Older versions of C++ don't get definitions of various macros from
54 * stdlib.h unless we define these macros before first inclusion of
57 #ifndef __STDC_CONSTANT_MACROS
58 #define __STDC_CONSTANT_MACROS
60 #ifndef __STDC_LIMIT_MACROS
61 #define __STDC_LIMIT_MACROS
63 #ifndef __STDC_FORMAT_MACROS
64 #define __STDC_FORMAT_MACROS
67 /* The following block of code temporarily renames the daemon() function so the
68 * compiler does not see the warning associated with it in stdlib.h on OSX
71 #define daemon qemu_fake_daemon_function
74 extern int daemon(int, int);
81 #include <sys/types.h>
88 /* Put unistd.h before time.h as that triggers localtime_r/gmtime_r
89 * function availability on recentish Mingw-w64 platforms. */
98 /* setjmp must be declared before sysemu/os-win32.h
99 * because it is redefined there. */
104 #include <sys/signal.h>
108 #include <sys/wait.h>
110 #define WIFEXITED(x) 1
111 #define WEXITSTATUS(x) (x)
115 #include "sysemu/os-win32.h"
119 #include "sysemu/os-posix.h"
122 #include "glib-compat.h"
123 #include "qemu/typedefs.h"
126 * According to waitpid man page:
128 * This macro is not specified in POSIX.1-2001 and is not
129 * available on some UNIX implementations (e.g., AIX, SunOS).
130 * Therefore, enclose its use inside #ifdef WCOREDUMP ... #endif.
133 #define WCOREDUMP(status) 0
136 * We have a lot of unaudited code that may fail in strange ways, or
137 * even be a security risk during migration, if you disable assertions
138 * at compile-time. You may comment out these safety checks if you
139 * absolutely want to disable assertion overhead, but it is not
140 * supported upstream so the risk is all yours. Meanwhile, please
141 * submit patches to remove any side-effects inside an assertion, or
142 * fixing error handling that should use Error instead of assert.
145 #error building with NDEBUG is not supported
147 #ifdef G_DISABLE_ASSERT
148 #error building with G_DISABLE_ASSERT is not supported
152 #define O_LARGEFILE 0
157 #ifndef MAP_ANONYMOUS
158 #define MAP_ANONYMOUS MAP_ANON
161 #define ENOMEDIUM ENODEV
163 #if !defined(ENOTSUP)
166 #if !defined(ECANCELED)
167 #define ECANCELED 4097
169 #if !defined(EMEDIUMTYPE)
170 #define EMEDIUMTYPE 4098
172 #if !defined(ESHUTDOWN)
173 #define ESHUTDOWN 4099
176 /* time_t may be either 32 or 64 bits depending on the host OS, and
177 * can be either signed or unsigned, so we can't just hardcode a
178 * specific maximum value. This is not a C preprocessor constant,
179 * so you can't use TIME_MAX in an #ifdef, but for our purposes
180 * this isn't a problem.
183 /* The macros TYPE_SIGNED, TYPE_WIDTH, and TYPE_MAXIMUM are from
184 * Gnulib, and are under the LGPL v2.1 or (at your option) any
188 /* True if the real type T is signed. */
189 #define TYPE_SIGNED(t) (!((t)0 < (t)-1))
191 /* The width in bits of the integer type or expression T.
192 * Padding bits are not supported.
194 #define TYPE_WIDTH(t) (sizeof(t) * CHAR_BIT)
196 /* The maximum and minimum values for the integer type T. */
197 #define TYPE_MAXIMUM(t) \
198 ((t) (!TYPE_SIGNED(t) \
200 : ((((t)1 << (TYPE_WIDTH(t) - 2)) - 1) * 2 + 1)))
203 #define TIME_MAX TYPE_MAXIMUM(time_t)
206 /* HOST_LONG_BITS is the size of a native pointer in bits. */
207 #if UINTPTR_MAX == UINT32_MAX
208 # define HOST_LONG_BITS 32
209 #elif UINTPTR_MAX == UINT64_MAX
210 # define HOST_LONG_BITS 64
212 # error Unknown pointer size
215 /* Mac OSX has a <stdint.h> bug that incorrectly defines SIZE_MAX with
216 * the wrong type. Our replacement isn't usable in preprocessor
217 * expressions, but it is sufficient for our needs. */
218 #if defined(HAVE_BROKEN_SIZE_MAX) && HAVE_BROKEN_SIZE_MAX
220 #define SIZE_MAX ((size_t)-1)
224 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
227 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
230 /* Minimum function that returns zero only iff both values are zero.
231 * Intended for use with unsigned values only. */
233 #define MIN_NON_ZERO(a, b) ((a) == 0 ? (b) : \
234 ((b) == 0 ? (a) : (MIN(a, b))))
237 /* Round number down to multiple */
238 #define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
240 /* Round number up to multiple. Safe when m is not a power of 2 (see
241 * ROUND_UP for a faster version when a power of 2 is guaranteed) */
242 #define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
244 /* Check if n is a multiple of m */
245 #define QEMU_IS_ALIGNED(n, m) (((n) % (m)) == 0)
247 /* n-byte align pointer down */
248 #define QEMU_ALIGN_PTR_DOWN(p, n) \
249 ((typeof(p))QEMU_ALIGN_DOWN((uintptr_t)(p), (n)))
251 /* n-byte align pointer up */
252 #define QEMU_ALIGN_PTR_UP(p, n) \
253 ((typeof(p))QEMU_ALIGN_UP((uintptr_t)(p), (n)))
255 /* Check if pointer p is n-bytes aligned */
256 #define QEMU_PTR_IS_ALIGNED(p, n) QEMU_IS_ALIGNED((uintptr_t)(p), (n))
258 /* Round number up to multiple. Requires that d be a power of 2 (see
259 * QEMU_ALIGN_UP for a safer but slower version on arbitrary
260 * numbers); works even if d is a smaller type than n. */
262 #define ROUND_UP(n, d) (((n) + (d) - 1) & -(0 ? (n) : (d)))
266 #define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
270 * &(x)[0] is always a pointer - if it's same type as x then the argument is a
271 * pointer, not an array.
273 #define QEMU_IS_ARRAY(x) (!__builtin_types_compatible_p(typeof(x), \
276 #define ARRAY_SIZE(x) ((sizeof(x) / sizeof((x)[0])) + \
277 QEMU_BUILD_BUG_ON_ZERO(!QEMU_IS_ARRAY(x)))
280 int qemu_daemon(int nochdir, int noclose);
281 void *qemu_try_memalign(size_t alignment, size_t size);
282 void *qemu_memalign(size_t alignment, size_t size);
283 void *qemu_anon_ram_alloc(size_t size, uint64_t *align, bool shared);
284 void qemu_vfree(void *ptr);
285 void qemu_anon_ram_free(void *ptr, size_t size);
287 #define QEMU_MADV_INVALID -1
289 #if defined(CONFIG_MADVISE)
291 #define QEMU_MADV_WILLNEED MADV_WILLNEED
292 #define QEMU_MADV_DONTNEED MADV_DONTNEED
294 #define QEMU_MADV_DONTFORK MADV_DONTFORK
296 #define QEMU_MADV_DONTFORK QEMU_MADV_INVALID
298 #ifdef MADV_MERGEABLE
299 #define QEMU_MADV_MERGEABLE MADV_MERGEABLE
301 #define QEMU_MADV_MERGEABLE QEMU_MADV_INVALID
303 #ifdef MADV_UNMERGEABLE
304 #define QEMU_MADV_UNMERGEABLE MADV_UNMERGEABLE
306 #define QEMU_MADV_UNMERGEABLE QEMU_MADV_INVALID
309 #define QEMU_MADV_DODUMP MADV_DODUMP
311 #define QEMU_MADV_DODUMP QEMU_MADV_INVALID
314 #define QEMU_MADV_DONTDUMP MADV_DONTDUMP
316 #define QEMU_MADV_DONTDUMP QEMU_MADV_INVALID
319 #define QEMU_MADV_HUGEPAGE MADV_HUGEPAGE
321 #define QEMU_MADV_HUGEPAGE QEMU_MADV_INVALID
323 #ifdef MADV_NOHUGEPAGE
324 #define QEMU_MADV_NOHUGEPAGE MADV_NOHUGEPAGE
326 #define QEMU_MADV_NOHUGEPAGE QEMU_MADV_INVALID
329 #define QEMU_MADV_REMOVE MADV_REMOVE
331 #define QEMU_MADV_REMOVE QEMU_MADV_INVALID
334 #elif defined(CONFIG_POSIX_MADVISE)
336 #define QEMU_MADV_WILLNEED POSIX_MADV_WILLNEED
337 #define QEMU_MADV_DONTNEED POSIX_MADV_DONTNEED
338 #define QEMU_MADV_DONTFORK QEMU_MADV_INVALID
339 #define QEMU_MADV_MERGEABLE QEMU_MADV_INVALID
340 #define QEMU_MADV_UNMERGEABLE QEMU_MADV_INVALID
341 #define QEMU_MADV_DODUMP QEMU_MADV_INVALID
342 #define QEMU_MADV_DONTDUMP QEMU_MADV_INVALID
343 #define QEMU_MADV_HUGEPAGE QEMU_MADV_INVALID
344 #define QEMU_MADV_NOHUGEPAGE QEMU_MADV_INVALID
345 #define QEMU_MADV_REMOVE QEMU_MADV_INVALID
349 #define QEMU_MADV_WILLNEED QEMU_MADV_INVALID
350 #define QEMU_MADV_DONTNEED QEMU_MADV_INVALID
351 #define QEMU_MADV_DONTFORK QEMU_MADV_INVALID
352 #define QEMU_MADV_MERGEABLE QEMU_MADV_INVALID
353 #define QEMU_MADV_UNMERGEABLE QEMU_MADV_INVALID
354 #define QEMU_MADV_DODUMP QEMU_MADV_INVALID
355 #define QEMU_MADV_DONTDUMP QEMU_MADV_INVALID
356 #define QEMU_MADV_HUGEPAGE QEMU_MADV_INVALID
357 #define QEMU_MADV_NOHUGEPAGE QEMU_MADV_INVALID
358 #define QEMU_MADV_REMOVE QEMU_MADV_INVALID
363 #define HAVE_CHARDEV_SERIAL 1
364 #elif defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
365 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) \
366 || defined(__GLIBC__)
367 #define HAVE_CHARDEV_SERIAL 1
370 #if defined(__linux__) || defined(__FreeBSD__) || \
371 defined(__FreeBSD_kernel__) || defined(__DragonFly__)
372 #define HAVE_CHARDEV_PARPORT 1
375 #if defined(CONFIG_LINUX)
376 #ifndef BUS_MCEERR_AR
377 #define BUS_MCEERR_AR 4
379 #ifndef BUS_MCEERR_AO
380 #define BUS_MCEERR_AO 5
384 #if defined(__linux__) && \
385 (defined(__x86_64__) || defined(__arm__) || defined(__aarch64__) \
386 || defined(__powerpc64__))
387 /* Use 2 MiB alignment so transparent hugepages can be used by KVM.
388 Valgrind does not support alignments larger than 1 MiB,
389 therefore we need special code which handles running on Valgrind. */
390 # define QEMU_VMALLOC_ALIGN (512 * 4096)
391 #elif defined(__linux__) && defined(__s390x__)
392 /* Use 1 MiB (segment size) alignment so gmap can be used by KVM. */
393 # define QEMU_VMALLOC_ALIGN (256 * 4096)
394 #elif defined(__linux__) && defined(__sparc__)
396 # define QEMU_VMALLOC_ALIGN MAX(getpagesize(), SHMLBA)
398 # define QEMU_VMALLOC_ALIGN getpagesize()
402 struct qemu_signalfd_siginfo {
403 uint32_t ssi_signo; /* Signal number */
404 int32_t ssi_errno; /* Error number (unused) */
405 int32_t ssi_code; /* Signal code */
406 uint32_t ssi_pid; /* PID of sender */
407 uint32_t ssi_uid; /* Real UID of sender */
408 int32_t ssi_fd; /* File descriptor (SIGIO) */
409 uint32_t ssi_tid; /* Kernel timer ID (POSIX timers) */
410 uint32_t ssi_band; /* Band event (SIGIO) */
411 uint32_t ssi_overrun; /* POSIX timer overrun count */
412 uint32_t ssi_trapno; /* Trap number that caused signal */
413 int32_t ssi_status; /* Exit status or signal (SIGCHLD) */
414 int32_t ssi_int; /* Integer sent by sigqueue(2) */
415 uint64_t ssi_ptr; /* Pointer sent by sigqueue(2) */
416 uint64_t ssi_utime; /* User CPU time consumed (SIGCHLD) */
417 uint64_t ssi_stime; /* System CPU time consumed (SIGCHLD) */
418 uint64_t ssi_addr; /* Address that generated signal
419 (for hardware-generated signals) */
420 uint8_t pad[48]; /* Pad size to 128 bytes (allow for
421 additional fields in the future) */
424 int qemu_signalfd(const sigset_t *mask);
425 void sigaction_invoke(struct sigaction *action,
426 struct qemu_signalfd_siginfo *info);
429 int qemu_madvise(void *addr, size_t len, int advice);
430 int qemu_mprotect_rwx(void *addr, size_t size);
431 int qemu_mprotect_none(void *addr, size_t size);
433 int qemu_open(const char *name, int flags, ...);
434 int qemu_close(int fd);
436 int qemu_dup(int fd);
438 int qemu_lock_fd(int fd, int64_t start, int64_t len, bool exclusive);
439 int qemu_unlock_fd(int fd, int64_t start, int64_t len);
440 int qemu_lock_fd_test(int fd, int64_t start, int64_t len, bool exclusive);
441 bool qemu_has_ofd_lock(void);
443 #if defined(__HAIKU__) && defined(__i386__)
444 #define FMT_pid "%ld"
446 #define FMT_pid "%" PRId64
451 int qemu_create_pidfile(const char *filename);
452 int qemu_get_thread_id(void);
460 * Use the same value as Linux for now.
464 ssize_t readv(int fd, const struct iovec *iov, int iov_cnt);
465 ssize_t writev(int fd, const struct iovec *iov, int iov_cnt);
471 static inline void qemu_timersub(const struct timeval *val1,
472 const struct timeval *val2,
475 res->tv_sec = val1->tv_sec - val2->tv_sec;
476 if (val1->tv_usec < val2->tv_usec) {
478 res->tv_usec = val1->tv_usec - val2->tv_usec + 1000 * 1000;
480 res->tv_usec = val1->tv_usec - val2->tv_usec;
484 #define qemu_timersub timersub
487 void qemu_set_cloexec(int fd);
489 /* Starting on QEMU 2.5, qemu_hw_version() returns "2.5+" by default
490 * instead of QEMU_VERSION, so setting hw_version on MachineClass
491 * is no longer mandatory.
493 * Do NOT change this string, or it will break compatibility on all
494 * machine classes that don't set hw_version.
496 #define QEMU_HW_VERSION "2.5+"
498 /* QEMU "hardware version" setting. Used to replace code that exposed
499 * QEMU_VERSION to guests in the past and need to keep compatibility.
500 * Do not use qemu_hw_version() in new code.
502 void qemu_set_hw_version(const char *);
503 const char *qemu_hw_version(void);
505 void fips_set_state(bool requested);
506 bool fips_get_state(void);
508 /* Return a dynamically allocated pathname denoting a file or directory that is
509 * appropriate for storing local state.
511 * @relative_pathname need not start with a directory separator; one will be
512 * added automatically.
514 * The caller is responsible for releasing the value returned with g_free()
517 char *qemu_get_local_state_pathname(const char *relative_pathname);
519 /* Find program directory, and save it for later usage with
520 * qemu_get_exec_dir().
521 * Try OS specific API first, if not working, parse from argv0. */
522 void qemu_init_exec_dir(const char *argv0);
524 /* Get the saved exec dir.
525 * Caller needs to release the returned string by g_free() */
526 char *qemu_get_exec_dir(void);
530 * @type: the auxiliary vector key to lookup
532 * Search the auxiliary vector for @type, returning the value
533 * or 0 if @type is not present.
535 unsigned long qemu_getauxval(unsigned long type);
537 void qemu_set_tty_echo(int fd, bool echo);
539 void os_mem_prealloc(int fd, char *area, size_t sz, int smp_cpus,
544 * @pid: pid of a process
546 * For given @pid fetch its name. Caller is responsible for
547 * freeing the string when no longer needed.
548 * Returns allocated string on success, NULL on failure.
550 char *qemu_get_pid_name(pid_t pid);
555 * A version of fork that avoids signal handler race
556 * conditions that can lead to child process getting
557 * signals that are otherwise only expected by the
558 * parent. It also resets all signal handlers to the
561 * Returns 0 to child process, pid number to parent
564 pid_t qemu_fork(Error **errp);
566 /* Using intptr_t ensures that qemu_*_page_mask is sign-extended even
567 * when intptr_t is 32-bit and we are aligning a long long.
569 extern uintptr_t qemu_real_host_page_size;
570 extern intptr_t qemu_real_host_page_mask;
572 extern int qemu_icache_linesize;
573 extern int qemu_dcache_linesize;