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
10 * of config-host.h, config-target.h, qemu/compiler.h,
11 * system/os-posix.h, system/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.
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 */
27 #ifndef QEMU_OSDEP_H
28 #define QEMU_OSDEP_H
29
30 #if !defined _FORTIFY_SOURCE && defined __OPTIMIZE__ && __OPTIMIZE__ && defined __linux__
31 # define _FORTIFY_SOURCE 2
32 #endif
33
34 #include "config-host.h"
35 #ifdef COMPILING_PER_TARGET
36 #include CONFIG_TARGET
37 #else
38 #include "exec/poison.h"
39 #endif
40
41 /*
42 * HOST_WORDS_BIGENDIAN was replaced with HOST_BIG_ENDIAN. Prevent it from
43 * creeping back in.
44 */
45 #pragma GCC poison HOST_WORDS_BIGENDIAN
46
47 /*
48 * TARGET_WORDS_BIGENDIAN was replaced with TARGET_BIG_ENDIAN. Prevent it from
49 * creeping back in.
50 */
51 #pragma GCC poison TARGET_WORDS_BIGENDIAN
52
53 #include "qemu/compiler.h"
54
55 /* Older versions of C++ don't get definitions of various macros from
56 * stdlib.h unless we define these macros before first inclusion of
57 * that system header.
58 */
59 #ifndef __STDC_CONSTANT_MACROS
60 #define __STDC_CONSTANT_MACROS
61 #endif
62 #ifndef __STDC_LIMIT_MACROS
63 #define __STDC_LIMIT_MACROS
64 #endif
65 #ifndef __STDC_FORMAT_MACROS
66 #define __STDC_FORMAT_MACROS
67 #endif
68
69 /* The following block of code temporarily renames the daemon() function so the
70 * compiler does not see the warning associated with it in stdlib.h on OSX
71 */
72 #ifdef __APPLE__
73 #define daemon qemu_fake_daemon_function
74 #include <stdlib.h>
75 #undef daemon
76 QEMU_EXTERN_C int daemon(int, int);
77 #endif
78
79 #ifdef _WIN32
80 /* as defined in sdkddkver.h */
81 #ifndef _WIN32_WINNT
82 #define _WIN32_WINNT 0x0602 /* Windows 8 API (should be >= the one from glib) */
83 #endif
84 /* reduces the number of implicitly included headers */
85 #ifndef WIN32_LEAN_AND_MEAN
86 #define WIN32_LEAN_AND_MEAN
87 #endif
88 #endif
89
90 /* enable C99/POSIX format strings (needs mingw32-runtime 3.15 or later) */
91 #ifdef __MINGW32__
92 #define __USE_MINGW_ANSI_STDIO 1
93 #endif
94
95 /*
96 * We need the FreeBSD "legacy" definitions. Rust needs the FreeBSD 11 system
97 * calls since it doesn't use libc at all, so we have to emulate that despite
98 * FreeBSD 11 being EOL'd.
99 */
100 #ifdef __FreeBSD__
101 #define _WANT_FREEBSD11_STAT
102 #define _WANT_FREEBSD11_STATFS
103 #define _WANT_FREEBSD11_DIRENT
104 #define _WANT_KERNEL_ERRNO
105 #define _WANT_SEMUN
106 #endif
107
108 #include <stdarg.h>
109 #include <stddef.h>
110 #include <stdbool.h>
111 #include <stdint.h>
112 #include <sys/types.h>
113 #include <stdlib.h>
114 #include <stdio.h>
115
116 #include <string.h>
117 #include <strings.h>
118 #include <inttypes.h>
119 #include <limits.h>
120 /* Put unistd.h before time.h as that triggers localtime_r/gmtime_r
121 * function availability on recentish Mingw-w64 platforms. */
122 #include <unistd.h>
123 #include <time.h>
124 #include <ctype.h>
125 #include <errno.h>
126 #include <fcntl.h>
127 #include <getopt.h>
128 #include <sys/stat.h>
129 #include <sys/time.h>
130 #include <assert.h>
131 /* setjmp must be declared before system/os-win32.h
132 * because it is redefined there. */
133 #include <setjmp.h>
134 #include <signal.h>
135
136 #ifdef CONFIG_IOVEC
137 #include <sys/uio.h>
138 #endif
139
140 #if defined(__linux__) && defined(__sparc__)
141 /* The SPARC definition of QEMU_VMALLOC_ALIGN needs SHMLBA */
142 #include <sys/shm.h>
143 #endif
144
145 #ifndef _WIN32
146 #include <sys/wait.h>
147 #else
148 #define WIFEXITED(x) 1
149 #define WEXITSTATUS(x) (x)
150 #endif
151
152 #ifdef __APPLE__
153 #include <AvailabilityMacros.h>
154 #endif
155
156 /*
157 * This is somewhat like a system header; it must be outside any extern "C"
158 * block because it includes system headers itself, including glib.h,
159 * which will not compile if inside an extern "C" block.
160 */
161 #include "glib-compat.h"
162
163 #ifdef _WIN32
164 #include "system/os-win32.h"
165 #endif
166
167 #ifdef CONFIG_POSIX
168 #include "system/os-posix.h"
169 #endif
170
171 #ifdef __cplusplus
172 extern "C" {
173 #endif
174
175 #include "qemu/typedefs.h"
176
177 /**
178 * Mark a function that executes in coroutine context
179 *
180 * Functions that execute in coroutine context cannot be called directly from
181 * normal functions. In the future it would be nice to enable compiler or
182 * static checker support for catching such errors. This annotation might make
183 * it possible and in the meantime it serves as documentation.
184 *
185 * For example:
186 *
187 * static void coroutine_fn foo(void) {
188 * ....
189 * }
190 */
191 #ifdef __clang__
192 #define coroutine_fn QEMU_ANNOTATE("coroutine_fn")
193 #else
194 #define coroutine_fn
195 #endif
196
197 /**
198 * Mark a function that can suspend when executed in coroutine context,
199 * but can handle running in non-coroutine context too.
200 */
201 #ifdef __clang__
202 #define coroutine_mixed_fn QEMU_ANNOTATE("coroutine_mixed_fn")
203 #else
204 #define coroutine_mixed_fn
205 #endif
206
207 /**
208 * Mark a function that should not be called from a coroutine context.
209 * Usually there will be an analogous, coroutine_fn function that should
210 * be used instead.
211 *
212 * When the function is also marked as coroutine_mixed_fn, the function should
213 * only be called if the caller does not know whether it is in coroutine
214 * context.
215 *
216 * Functions that are only no_coroutine_fn, on the other hand, should not
217 * be called from within coroutines at all. This for example includes
218 * functions that block.
219 *
220 * In the future it would be nice to enable compiler or static checker
221 * support for catching such errors. This annotation is the first step
222 * towards this, and in the meantime it serves as documentation.
223 *
224 * For example:
225 *
226 * static void no_coroutine_fn foo(void) {
227 * ....
228 * }
229 */
230 #ifdef __clang__
231 #define no_coroutine_fn QEMU_ANNOTATE("no_coroutine_fn")
232 #else
233 #define no_coroutine_fn
234 #endif
235
236
237 /*
238 * For mingw, as of v6.0.0, the function implementing the assert macro is
239 * not marked as noreturn, so the compiler cannot delete code following an
240 * assert(false) as unused. We rely on this within the code base to delete
241 * code that is unreachable when features are disabled.
242 * All supported versions of Glib's g_assert() satisfy this requirement.
243 */
244 #ifdef __MINGW32__
245 #undef assert
246 #define assert(x) g_assert(x)
247 #endif
248
249 /**
250 * qemu_build_not_reached()
251 *
252 * The compiler, during optimization, is expected to prove that a call
253 * to this function cannot be reached and remove it. If the compiler
254 * supports QEMU_ERROR, this will be reported at compile time; otherwise
255 * this will be reported at link time due to the missing symbol.
256 */
257 G_NORETURN
258 void QEMU_ERROR("code path is reachable")
259 qemu_build_not_reached_always(void);
260 #if defined(__OPTIMIZE__) && !defined(__NO_INLINE__)
261 #define qemu_build_not_reached() qemu_build_not_reached_always()
262 #else
263 #define qemu_build_not_reached() g_assert_not_reached()
264 #endif
265
266 /**
267 * qemu_build_assert()
268 *
269 * The compiler, during optimization, is expected to prove that the
270 * assertion is true.
271 */
272 #define qemu_build_assert(test) while (!(test)) qemu_build_not_reached()
273
274 /*
275 * According to waitpid man page:
276 * WCOREDUMP
277 * This macro is not specified in POSIX.1-2001 and is not
278 * available on some UNIX implementations (e.g., AIX, SunOS).
279 * Therefore, enclose its use inside #ifdef WCOREDUMP ... #endif.
280 */
281 #ifndef WCOREDUMP
282 #define WCOREDUMP(status) 0
283 #endif
284 /*
285 * We have a lot of unaudited code that may fail in strange ways, or
286 * even be a security risk during migration, if you disable assertions
287 * at compile-time. You may comment out these safety checks if you
288 * absolutely want to disable assertion overhead, but it is not
289 * supported upstream so the risk is all yours. Meanwhile, please
290 * submit patches to remove any side-effects inside an assertion, or
291 * fixing error handling that should use Error instead of assert.
292 */
293 #ifdef NDEBUG
294 #error building with NDEBUG is not supported
295 #endif
296 #ifdef G_DISABLE_ASSERT
297 #error building with G_DISABLE_ASSERT is not supported
298 #endif
299
300 #ifndef OFF_MAX
301 #define OFF_MAX (sizeof (off_t) == 8 ? INT64_MAX : INT32_MAX)
302 #endif
303
304 #ifndef O_LARGEFILE
305 #define O_LARGEFILE 0
306 #endif
307 #ifndef O_BINARY
308 #define O_BINARY 0
309 #endif
310 #ifndef MAP_ANONYMOUS
311 #define MAP_ANONYMOUS MAP_ANON
312 #endif
313 #ifndef MAP_NORESERVE
314 #define MAP_NORESERVE 0
315 #endif
316 #ifndef ENOMEDIUM
317 #define ENOMEDIUM ENODEV
318 #endif
319 #if !defined(ENOTSUP)
320 #define ENOTSUP 4096
321 #endif
322 #if !defined(ECANCELED)
323 #define ECANCELED 4097
324 #endif
325 #if !defined(EMEDIUMTYPE)
326 #define EMEDIUMTYPE 4098
327 #endif
328 #if !defined(ESHUTDOWN)
329 #define ESHUTDOWN 4099
330 #endif
331
332 #define RETRY_ON_EINTR(expr) \
333 (__extension__ \
334 ({ typeof(expr) __result; \
335 do { \
336 __result = (expr); \
337 } while (__result == -1 && errno == EINTR); \
338 __result; }))
339
340 /* time_t may be either 32 or 64 bits depending on the host OS, and
341 * can be either signed or unsigned, so we can't just hardcode a
342 * specific maximum value. This is not a C preprocessor constant,
343 * so you can't use TIME_MAX in an #ifdef, but for our purposes
344 * this isn't a problem.
345 */
346
347 /* The macros TYPE_SIGNED, TYPE_WIDTH, and TYPE_MAXIMUM are from
348 * Gnulib, and are under the LGPL v2.1 or (at your option) any
349 * later version.
350 */
351
352 /* True if the real type T is signed. */
353 #define TYPE_SIGNED(t) (!((t)0 < (t)-1))
354
355 /* The width in bits of the integer type or expression T.
356 * Padding bits are not supported.
357 */
358 #define TYPE_WIDTH(t) (sizeof(t) * CHAR_BIT)
359
360 /* The maximum and minimum values for the integer type T. */
361 #define TYPE_MAXIMUM(t) \
362 ((t) (!TYPE_SIGNED(t) \
363 ? (t)-1 \
364 : ((((t)1 << (TYPE_WIDTH(t) - 2)) - 1) * 2 + 1)))
365
366 #ifndef TIME_MAX
367 #define TIME_MAX TYPE_MAXIMUM(time_t)
368 #endif
369
370 /* Mac OSX has a <stdint.h> bug that incorrectly defines SIZE_MAX with
371 * the wrong type. Our replacement isn't usable in preprocessor
372 * expressions, but it is sufficient for our needs. */
373 #ifdef HAVE_BROKEN_SIZE_MAX
374 #undef SIZE_MAX
375 #define SIZE_MAX ((size_t)-1)
376 #endif
377
378 /*
379 * Two variations of MIN/MAX macros. The first is for runtime use, and
380 * evaluates arguments only once (so it is safe even with side
381 * effects), but will not work in constant contexts (such as array
382 * size declarations) because of the '{}'. The second is for constant
383 * expression use, where evaluating arguments twice is safe because
384 * the result is going to be constant anyway, but will not work in a
385 * runtime context because of a void expression where a value is
386 * expected. Thus, both gcc and clang will fail to compile if you use
387 * the wrong macro (even if the error may seem a bit cryptic).
388 *
389 * Note that neither form is usable as an #if condition; if you truly
390 * need to write conditional code that depends on a minimum or maximum
391 * determined by the pre-processor instead of the compiler, you'll
392 * have to open-code it. Sadly, Coverity is severely confused by the
393 * constant variants, so we have to dumb things down there.
394 *
395 * Preprocessor sorcery ahead: use different identifiers for the local
396 * variables in each expansion, so we can nest macro calls without
397 * shadowing variables.
398 */
399 #define MIN_INTERNAL(a, b, _a, _b) \
400 ({ \
401 typeof(1 ? (a) : (b)) _a = (a), _b = (b); \
402 _a < _b ? _a : _b; \
403 })
404 #undef MIN
405 #define MIN(a, b) \
406 MIN_INTERNAL((a), (b), MAKE_IDENTIFIER(_a), MAKE_IDENTIFIER(_b))
407
408 #define MAX_INTERNAL(a, b, _a, _b) \
409 ({ \
410 typeof(1 ? (a) : (b)) _a = (a), _b = (b); \
411 _a > _b ? _a : _b; \
412 })
413 #undef MAX
414 #define MAX(a, b) \
415 MAX_INTERNAL((a), (b), MAKE_IDENTIFIER(_a), MAKE_IDENTIFIER(_b))
416
417 #ifdef __COVERITY__
418 # define MIN_CONST(a, b) ((a) < (b) ? (a) : (b))
419 # define MAX_CONST(a, b) ((a) > (b) ? (a) : (b))
420 #else
421 # define MIN_CONST(a, b) \
422 __builtin_choose_expr( \
423 __builtin_constant_p(a) && __builtin_constant_p(b), \
424 (a) < (b) ? (a) : (b), \
425 ((void)0))
426 # define MAX_CONST(a, b) \
427 __builtin_choose_expr( \
428 __builtin_constant_p(a) && __builtin_constant_p(b), \
429 (a) > (b) ? (a) : (b), \
430 ((void)0))
431 #endif
432
433 /*
434 * Minimum function that returns zero only if both values are zero.
435 * Intended for use with unsigned values only.
436 *
437 * Preprocessor sorcery ahead: use different identifiers for the local
438 * variables in each expansion, so we can nest macro calls without
439 * shadowing variables.
440 */
441 #define MIN_NON_ZERO_INTERNAL(a, b, _a, _b) \
442 ({ \
443 typeof(1 ? (a) : (b)) _a = (a), _b = (b); \
444 _a == 0 ? _b : (_b == 0 || _b > _a) ? _a : _b; \
445 })
446 #define MIN_NON_ZERO(a, b) \
447 MIN_NON_ZERO_INTERNAL((a), (b), MAKE_IDENTIFIER(_a), MAKE_IDENTIFIER(_b))
448
449 /*
450 * Round number down to multiple. Safe when m is not a power of 2 (see
451 * ROUND_DOWN for a faster version when a power of 2 is guaranteed).
452 */
453 #define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
454
455 /*
456 * Round number up to multiple. Safe when m is not a power of 2 (see
457 * ROUND_UP for a faster version when a power of 2 is guaranteed).
458 */
459 #define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
460
461 /* Check if n is a multiple of m */
462 #define QEMU_IS_ALIGNED(n, m) (((n) % (m)) == 0)
463
464 /* n-byte align pointer down */
465 #define QEMU_ALIGN_PTR_DOWN(p, n) \
466 ((typeof(p))QEMU_ALIGN_DOWN((uintptr_t)(p), (n)))
467
468 /* n-byte align pointer up */
469 #define QEMU_ALIGN_PTR_UP(p, n) \
470 ((typeof(p))QEMU_ALIGN_UP((uintptr_t)(p), (n)))
471
472 /* Check if pointer p is n-bytes aligned */
473 #define QEMU_PTR_IS_ALIGNED(p, n) QEMU_IS_ALIGNED((uintptr_t)(p), (n))
474
475 /*
476 * Round number down to multiple. Requires that d be a power of 2 (see
477 * QEMU_ALIGN_UP for a safer but slower version on arbitrary
478 * numbers); works even if d is a smaller type than n.
479 */
480 #ifndef ROUND_DOWN
481 #define ROUND_DOWN(n, d) ((n) & -(0 ? (n) : (d)))
482 #endif
483
484 /*
485 * Round number up to multiple. Requires that d be a power of 2 (see
486 * QEMU_ALIGN_UP for a safer but slower version on arbitrary
487 * numbers); works even if d is a smaller type than n.
488 */
489 #ifndef ROUND_UP
490 #define ROUND_UP(n, d) ROUND_DOWN((n) + (d) - 1, (d))
491 #endif
492
493 #ifndef DIV_ROUND_UP
494 #define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
495 #endif
496
497 /*
498 * &(x)[0] is always a pointer - if it's same type as x then the argument is a
499 * pointer, not an array.
500 */
501 #define QEMU_IS_ARRAY(x) (!__builtin_types_compatible_p(typeof(x), \
502 typeof(&(x)[0])))
503 #ifndef ARRAY_SIZE
504 #define ARRAY_SIZE(x) ((sizeof(x) / sizeof((x)[0])) + \
505 QEMU_BUILD_BUG_ON_ZERO(!QEMU_IS_ARRAY(x)))
506 #endif
507
508 int qemu_daemon(int nochdir, int noclose);
509 void *qemu_anon_ram_alloc(size_t size, uint64_t *align, bool shared,
510 bool noreserve);
511 void qemu_anon_ram_free(void *ptr, size_t size);
512 int qemu_shm_alloc(size_t size, Error **errp);
513
514 #ifdef _WIN32
515 #define HAVE_CHARDEV_SERIAL 1
516 #define HAVE_CHARDEV_PARALLEL 1
517 #else
518 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
519 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) \
520 || defined(__GLIBC__) || defined(__APPLE__)
521 #define HAVE_CHARDEV_SERIAL 1
522 #endif
523 #if defined(__linux__) || defined(__FreeBSD__) \
524 || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
525 #define HAVE_CHARDEV_PARALLEL 1
526 #endif
527 #endif
528
529 #if defined(__HAIKU__)
530 #define SIGIO SIGPOLL
531 #endif
532
533 #ifdef HAVE_MADVISE_WITHOUT_PROTOTYPE
534 /*
535 * See MySQL bug #7156 (http://bugs.mysql.com/bug.php?id=7156) for discussion
536 * about Solaris missing the madvise() prototype.
537 */
538 int madvise(char *, size_t, int);
539 #endif
540
541 #if defined(CONFIG_LINUX)
542 #ifndef BUS_MCEERR_AR
543 #define BUS_MCEERR_AR 4
544 #endif
545 #ifndef BUS_MCEERR_AO
546 #define BUS_MCEERR_AO 5
547 #endif
548 #endif
549
550 #if defined(__linux__) && \
551 (defined(__x86_64__) || defined(__arm__) || defined(__aarch64__) \
552 || defined(__powerpc64__))
553 /* Use 2 MiB alignment so transparent hugepages can be used by KVM.
554 Valgrind does not support alignments larger than 1 MiB,
555 therefore we need special code which handles running on Valgrind. */
556 # define QEMU_VMALLOC_ALIGN (512 * 4096)
557 #elif defined(__linux__) && defined(__s390x__)
558 /* Use 1 MiB (segment size) alignment so gmap can be used by KVM. */
559 # define QEMU_VMALLOC_ALIGN (256 * 4096)
560 #elif defined(__linux__) && defined(__sparc__)
561 # define QEMU_VMALLOC_ALIGN MAX(qemu_real_host_page_size(), SHMLBA)
562 #elif defined(__linux__) && defined(__loongarch__)
563 /*
564 * For transparent hugepage optimization, it has better be huge page
565 * aligned. LoongArch host system supports two kinds of pagesize: 4K
566 * and 16K, here calculate huge page size from host page size
567 */
568 # define QEMU_VMALLOC_ALIGN (qemu_real_host_page_size() * \
569 qemu_real_host_page_size() / sizeof(long))
570 #else
571 # define QEMU_VMALLOC_ALIGN qemu_real_host_page_size()
572 #endif
573
574 #ifdef CONFIG_POSIX
575 struct qemu_signalfd_siginfo {
576 uint32_t ssi_signo; /* Signal number */
577 int32_t ssi_errno; /* Error number (unused) */
578 int32_t ssi_code; /* Signal code */
579 uint32_t ssi_pid; /* PID of sender */
580 uint32_t ssi_uid; /* Real UID of sender */
581 int32_t ssi_fd; /* File descriptor (SIGIO) */
582 uint32_t ssi_tid; /* Kernel timer ID (POSIX timers) */
583 uint32_t ssi_band; /* Band event (SIGIO) */
584 uint32_t ssi_overrun; /* POSIX timer overrun count */
585 uint32_t ssi_trapno; /* Trap number that caused signal */
586 int32_t ssi_status; /* Exit status or signal (SIGCHLD) */
587 int32_t ssi_int; /* Integer sent by sigqueue(2) */
588 uint64_t ssi_ptr; /* Pointer sent by sigqueue(2) */
589 uint64_t ssi_utime; /* User CPU time consumed (SIGCHLD) */
590 uint64_t ssi_stime; /* System CPU time consumed (SIGCHLD) */
591 uint64_t ssi_addr; /* Address that generated signal
592 (for hardware-generated signals) */
593 uint8_t pad[48]; /* Pad size to 128 bytes (allow for
594 additional fields in the future) */
595 };
596
597 int qemu_signalfd(const sigset_t *mask);
598 void sigaction_invoke(struct sigaction *action,
599 struct qemu_signalfd_siginfo *info);
600 #endif
601
602 /*
603 * Don't introduce new usage of this function, prefer the following
604 * qemu_open/qemu_create that take an "Error **errp"
605 */
606 int qemu_open_old(const char *name, int flags, ...);
607 int qemu_open(const char *name, int flags, Error **errp);
608 int qemu_create(const char *name, int flags, mode_t mode, Error **errp);
609 int qemu_close(int fd);
610 int qemu_unlink(const char *name);
611 #ifndef _WIN32
612 int qemu_dup_flags(int fd, int flags);
613 int qemu_dup(int fd);
614 int qemu_lock_fd(int fd, int64_t start, int64_t len, bool exclusive);
615 int qemu_unlock_fd(int fd, int64_t start, int64_t len);
616 int qemu_lock_fd_test(int fd, int64_t start, int64_t len, bool exclusive);
617 bool qemu_has_ofd_lock(void);
618 #endif
619
620 bool qemu_has_direct_io(void);
621
622 #if defined(__HAIKU__) && defined(__i386__)
623 #define FMT_pid "%ld"
624 #elif defined(WIN64)
625 #define FMT_pid "%" PRId64
626 #else
627 #define FMT_pid "%d"
628 #endif
629
630 bool qemu_write_pidfile(const char *pidfile, Error **errp);
631
632 int qemu_get_thread_id(void);
633
634 /**
635 * qemu_kill_thread:
636 * @tid: thread id.
637 * @sig: host signal.
638 *
639 * Send @sig to one of QEMU's own threads with identifier @tid.
640 */
641 int qemu_kill_thread(int tid, int sig);
642
643 #ifndef CONFIG_IOVEC
644 struct iovec {
645 void *iov_base;
646 size_t iov_len;
647 };
648 /*
649 * Use the same value as Linux for now.
650 */
651 #define IOV_MAX 1024
652
653 ssize_t readv(int fd, const struct iovec *iov, int iov_cnt);
654 ssize_t writev(int fd, const struct iovec *iov, int iov_cnt);
655 #endif
656
657 #ifdef _WIN32
qemu_timersub(const struct timeval * val1,const struct timeval * val2,struct timeval * res)658 static inline void qemu_timersub(const struct timeval *val1,
659 const struct timeval *val2,
660 struct timeval *res)
661 {
662 res->tv_sec = val1->tv_sec - val2->tv_sec;
663 if (val1->tv_usec < val2->tv_usec) {
664 res->tv_sec--;
665 res->tv_usec = val1->tv_usec - val2->tv_usec + 1000 * 1000;
666 } else {
667 res->tv_usec = val1->tv_usec - val2->tv_usec;
668 }
669 }
670 #else
671 #define qemu_timersub timersub
672 #endif
673
674 ssize_t qemu_write_full(int fd, const void *buf, size_t count)
675 G_GNUC_WARN_UNUSED_RESULT;
676
677 void qemu_set_cloexec(int fd);
678
679 /* Return a dynamically allocated directory path that is appropriate for storing
680 * local state.
681 *
682 * The caller is responsible for releasing the value returned with g_free()
683 * after use.
684 */
685 char *qemu_get_local_state_dir(void);
686
687 /**
688 * qemu_getauxval:
689 * @type: the auxiliary vector key to lookup
690 *
691 * Search the auxiliary vector for @type, returning the value
692 * or 0 if @type is not present.
693 */
694 unsigned long qemu_getauxval(unsigned long type);
695
696 void qemu_set_tty_echo(int fd, bool echo);
697
698 typedef struct ThreadContext ThreadContext;
699
700 /**
701 * qemu_prealloc_mem:
702 * @fd: the fd mapped into the area, -1 for anonymous memory
703 * @area: start address of the are to preallocate
704 * @sz: the size of the area to preallocate
705 * @max_threads: maximum number of threads to use
706 * @tc: prealloc context threads pointer, NULL if not in use
707 * @async: request asynchronous preallocation, requires @tc
708 * @errp: returns an error if this function fails
709 *
710 * Preallocate memory (populate/prefault page tables writable) for the virtual
711 * memory area starting at @area with the size of @sz. After a successful call,
712 * each page in the area was faulted in writable at least once, for example,
713 * after allocating file blocks for mapped files.
714 *
715 * When setting @async, allocation might be performed asynchronously.
716 * qemu_finish_async_prealloc_mem() must be called to finish any asynchronous
717 * preallocation.
718 *
719 * Return: true on success, else false setting @errp with error.
720 */
721 bool qemu_prealloc_mem(int fd, char *area, size_t sz, int max_threads,
722 ThreadContext *tc, bool async, Error **errp);
723
724 /**
725 * qemu_finish_async_prealloc_mem:
726 * @errp: returns an error if this function fails
727 *
728 * Finish all outstanding asynchronous memory preallocation.
729 *
730 * Return: true on success, else false setting @errp with error.
731 */
732 bool qemu_finish_async_prealloc_mem(Error **errp);
733
734 /**
735 * qemu_get_pid_name:
736 * @pid: pid of a process
737 *
738 * For given @pid fetch its name. Caller is responsible for
739 * freeing the string when no longer needed.
740 * Returns allocated string on success, NULL on failure.
741 */
742 char *qemu_get_pid_name(pid_t pid);
743
744 /* Using intptr_t ensures that qemu_*_page_mask is sign-extended even
745 * when intptr_t is 32-bit and we are aligning a long long.
746 */
qemu_real_host_page_size(void)747 static inline uintptr_t qemu_real_host_page_size(void)
748 {
749 return getpagesize();
750 }
751
qemu_real_host_page_mask(void)752 static inline intptr_t qemu_real_host_page_mask(void)
753 {
754 return -(intptr_t)qemu_real_host_page_size();
755 }
756
757 /*
758 * After using getopt or getopt_long, if you need to parse another set
759 * of options, then you must reset optind. Unfortunately the way to
760 * do this varies between implementations of getopt.
761 */
qemu_reset_optind(void)762 static inline void qemu_reset_optind(void)
763 {
764 #ifdef HAVE_OPTRESET
765 optind = 1;
766 optreset = 1;
767 #else
768 optind = 0;
769 #endif
770 }
771
772 int qemu_fdatasync(int fd);
773
774 /**
775 * qemu_close_all_open_fd:
776 *
777 * Close all open file descriptors except the ones supplied in the @skip array
778 *
779 * @skip: ordered array of distinct file descriptors that should not be closed
780 * if any, or NULL.
781 * @nskip: number of entries in the @skip array or 0 if @skip is NULL.
782 */
783 void qemu_close_all_open_fd(const int *skip, unsigned int nskip);
784
785 /**
786 * Sync changes made to the memory mapped file back to the backing
787 * storage. For POSIX compliant systems this will fallback
788 * to regular msync call. Otherwise it will trigger whole file sync
789 * (including the metadata case there is no support to skip that otherwise)
790 *
791 * @addr - start of the memory area to be synced
792 * @length - length of the are to be synced
793 * @fd - file descriptor for the file to be synced
794 * (mandatory only for POSIX non-compliant systems)
795 */
796 int qemu_msync(void *addr, size_t length, int fd);
797
798 /**
799 * qemu_get_host_physmem:
800 *
801 * Operating system agnostic way of querying host memory.
802 *
803 * Returns amount of physical memory on the system. This is purely
804 * advisery and may return 0 if we can't work it out. At the other
805 * end we saturate to SIZE_MAX if you are lucky enough to have that
806 * much memory.
807 */
808 size_t qemu_get_host_physmem(void);
809
810 /*
811 * Toggle write/execute on the pages marked MAP_JIT
812 * for the current thread.
813 */
814 #ifdef __APPLE__
qemu_thread_jit_execute(void)815 static inline void qemu_thread_jit_execute(void)
816 {
817 pthread_jit_write_protect_np(true);
818 }
819
qemu_thread_jit_write(void)820 static inline void qemu_thread_jit_write(void)
821 {
822 pthread_jit_write_protect_np(false);
823 }
824 #else
qemu_thread_jit_write(void)825 static inline void qemu_thread_jit_write(void) {}
qemu_thread_jit_execute(void)826 static inline void qemu_thread_jit_execute(void) {}
827 #endif
828
829 /**
830 * Platforms which do not support system() return ENOSYS
831 */
832 #ifndef HAVE_SYSTEM_FUNCTION
833 #define system platform_does_not_support_system
platform_does_not_support_system(const char * command)834 static inline int platform_does_not_support_system(const char *command)
835 {
836 errno = ENOSYS;
837 return -1;
838 }
839 #endif /* !HAVE_SYSTEM_FUNCTION */
840
841 #ifdef __cplusplus
842 }
843 #endif
844
845 #endif
846