]>
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 | ||
9afa888c DB |
30 | #if !defined _FORTIFY_SOURCE && defined __OPTIMIZE__ && __OPTIMIZE__ && defined __linux__ |
31 | # define _FORTIFY_SOURCE 2 | |
32 | #endif | |
33 | ||
9adea5f7 | 34 | #include "config-host.h" |
b1e34d1c | 35 | #ifdef NEED_CPU_H |
2becc36a | 36 | #include CONFIG_TARGET |
bdd90227 PB |
37 | #else |
38 | #include "exec/poison.h" | |
b1e34d1c | 39 | #endif |
a1a98357 | 40 | |
7773e13f MAL |
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 | ||
49120868 | 53 | #include "qemu/compiler.h" |
d5db2ec1 | 54 | |
79f56d82 PM |
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 | ||
d5db2ec1 PM |
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 | |
875df03b | 76 | QEMU_EXTERN_C int daemon(int, int); |
d5db2ec1 PM |
77 | #endif |
78 | ||
007e722c MAL |
79 | #ifdef _WIN32 |
80 | /* as defined in sdkddkver.h */ | |
56cdca1d | 81 | #ifndef _WIN32_WINNT |
8cbfc530 | 82 | #define _WIN32_WINNT 0x0602 /* Windows 8 API (should be >= the one from glib) */ |
007e722c MAL |
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 | ||
946376c2 CJ |
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 | ||
25e2cfbb WL |
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 | ||
ea88812f | 108 | #include <stdarg.h> |
de5071c5 | 109 | #include <stddef.h> |
0f66998f | 110 | #include <stdbool.h> |
a2b257d6 | 111 | #include <stdint.h> |
128ab2ff | 112 | #include <sys/types.h> |
bfe7e449 PM |
113 | #include <stdlib.h> |
114 | #include <stdio.h> | |
007e722c | 115 | |
bfe7e449 PM |
116 | #include <string.h> |
117 | #include <strings.h> | |
118 | #include <inttypes.h> | |
119 | #include <limits.h> | |
4d9310f4 DB |
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> | |
bfe7e449 PM |
123 | #include <time.h> |
124 | #include <ctype.h> | |
125 | #include <errno.h> | |
bfe7e449 | 126 | #include <fcntl.h> |
d339d766 | 127 | #include <getopt.h> |
bfe7e449 PM |
128 | #include <sys/stat.h> |
129 | #include <sys/time.h> | |
130 | #include <assert.h> | |
e89fdafb SW |
131 | /* setjmp must be declared before sysemu/os-win32.h |
132 | * because it is redefined there. */ | |
133 | #include <setjmp.h> | |
bfe7e449 PM |
134 | #include <signal.h> |
135 | ||
ec63ca2d PM |
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 | ||
13c7b2da PB |
145 | #ifndef _WIN32 |
146 | #include <sys/wait.h> | |
147 | #else | |
148 | #define WIFEXITED(x) 1 | |
149 | #define WEXITSTATUS(x) (x) | |
150 | #endif | |
151 | ||
ec63ca2d PM |
152 | #ifdef __APPLE__ |
153 | #include <AvailabilityMacros.h> | |
154 | #endif | |
155 | ||
af1bb59c PB |
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 | ||
bfe7e449 PM |
163 | #ifdef _WIN32 |
164 | #include "sysemu/os-win32.h" | |
165 | #endif | |
166 | ||
167 | #ifdef CONFIG_POSIX | |
168 | #include "sysemu/os-posix.h" | |
169 | #endif | |
f7b4a940 | 170 | |
415a9fb8 PM |
171 | #ifdef __cplusplus |
172 | extern "C" { | |
173 | #endif | |
174 | ||
da34e65c | 175 | #include "qemu/typedefs.h" |
57cb38b3 | 176 | |
af7f8eb5 MA |
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 | */ | |
cbdbc47c | 191 | #ifdef __clang__ |
d79b9202 | 192 | #define coroutine_fn QEMU_ANNOTATE("coroutine_fn") |
cbdbc47c | 193 | #else |
af7f8eb5 | 194 | #define coroutine_fn |
cbdbc47c | 195 | #endif |
af7f8eb5 | 196 | |
0f3de970 AF |
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__ | |
d79b9202 | 202 | #define coroutine_mixed_fn QEMU_ANNOTATE("coroutine_mixed_fn") |
0f3de970 AF |
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__ | |
d79b9202 | 231 | #define no_coroutine_fn QEMU_ANNOTATE("no_coroutine_fn") |
0f3de970 AF |
232 | #else |
233 | #define no_coroutine_fn | |
234 | #endif | |
235 | ||
236 | ||
3ebee3b1 RH |
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 | ||
94ae6b57 MAL |
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 | */ | |
f703f1ef | 257 | G_NORETURN |
8905770b | 258 | void QEMU_ERROR("code path is reachable") |
94ae6b57 MAL |
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 | ||
d44e3737 RH |
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 | ||
28012e19 MT |
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 | |
262a69f4 EB |
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 | ||
bfe7e449 PM |
300 | #ifndef O_LARGEFILE |
301 | #define O_LARGEFILE 0 | |
302 | #endif | |
303 | #ifndef O_BINARY | |
304 | #define O_BINARY 0 | |
305 | #endif | |
306 | #ifndef MAP_ANONYMOUS | |
307 | #define MAP_ANONYMOUS MAP_ANON | |
308 | #endif | |
d94e0bc9 DH |
309 | #ifndef MAP_NORESERVE |
310 | #define MAP_NORESERVE 0 | |
311 | #endif | |
bfe7e449 PM |
312 | #ifndef ENOMEDIUM |
313 | #define ENOMEDIUM ENODEV | |
314 | #endif | |
315 | #if !defined(ENOTSUP) | |
316 | #define ENOTSUP 4096 | |
317 | #endif | |
318 | #if !defined(ECANCELED) | |
319 | #define ECANCELED 4097 | |
320 | #endif | |
321 | #if !defined(EMEDIUMTYPE) | |
322 | #define EMEDIUMTYPE 4098 | |
323 | #endif | |
b6f5d3b5 EB |
324 | #if !defined(ESHUTDOWN) |
325 | #define ESHUTDOWN 4099 | |
326 | #endif | |
e7b47c22 | 327 | |
8b6aa693 NI |
328 | #define RETRY_ON_EINTR(expr) \ |
329 | (__extension__ \ | |
330 | ({ typeof(expr) __result; \ | |
331 | do { \ | |
332 | __result = (expr); \ | |
333 | } while (__result == -1 && errno == EINTR); \ | |
334 | __result; })) | |
1dacd88d | 335 | |
e7b47c22 PM |
336 | /* time_t may be either 32 or 64 bits depending on the host OS, and |
337 | * can be either signed or unsigned, so we can't just hardcode a | |
338 | * specific maximum value. This is not a C preprocessor constant, | |
339 | * so you can't use TIME_MAX in an #ifdef, but for our purposes | |
340 | * this isn't a problem. | |
341 | */ | |
342 | ||
343 | /* The macros TYPE_SIGNED, TYPE_WIDTH, and TYPE_MAXIMUM are from | |
344 | * Gnulib, and are under the LGPL v2.1 or (at your option) any | |
345 | * later version. | |
346 | */ | |
347 | ||
348 | /* True if the real type T is signed. */ | |
349 | #define TYPE_SIGNED(t) (!((t)0 < (t)-1)) | |
350 | ||
351 | /* The width in bits of the integer type or expression T. | |
352 | * Padding bits are not supported. | |
353 | */ | |
354 | #define TYPE_WIDTH(t) (sizeof(t) * CHAR_BIT) | |
355 | ||
356 | /* The maximum and minimum values for the integer type T. */ | |
357 | #define TYPE_MAXIMUM(t) \ | |
358 | ((t) (!TYPE_SIGNED(t) \ | |
359 | ? (t)-1 \ | |
360 | : ((((t)1 << (TYPE_WIDTH(t) - 2)) - 1) * 2 + 1))) | |
361 | ||
bfe7e449 | 362 | #ifndef TIME_MAX |
e7b47c22 | 363 | #define TIME_MAX TYPE_MAXIMUM(time_t) |
bfe7e449 PM |
364 | #endif |
365 | ||
6b39b063 EB |
366 | /* Mac OSX has a <stdint.h> bug that incorrectly defines SIZE_MAX with |
367 | * the wrong type. Our replacement isn't usable in preprocessor | |
368 | * expressions, but it is sufficient for our needs. */ | |
7db492a1 | 369 | #ifdef HAVE_BROKEN_SIZE_MAX |
6b39b063 EB |
370 | #undef SIZE_MAX |
371 | #define SIZE_MAX ((size_t)-1) | |
372 | #endif | |
373 | ||
f9919116 EB |
374 | /* |
375 | * Two variations of MIN/MAX macros. The first is for runtime use, and | |
376 | * evaluates arguments only once (so it is safe even with side | |
377 | * effects), but will not work in constant contexts (such as array | |
378 | * size declarations) because of the '{}'. The second is for constant | |
379 | * expression use, where evaluating arguments twice is safe because | |
380 | * the result is going to be constant anyway, but will not work in a | |
381 | * runtime context because of a void expression where a value is | |
382 | * expected. Thus, both gcc and clang will fail to compile if you use | |
383 | * the wrong macro (even if the error may seem a bit cryptic). | |
384 | * | |
385 | * Note that neither form is usable as an #if condition; if you truly | |
386 | * need to write conditional code that depends on a minimum or maximum | |
387 | * determined by the pre-processor instead of the compiler, you'll | |
6553aa1d EB |
388 | * have to open-code it. Sadly, Coverity is severely confused by the |
389 | * constant variants, so we have to dumb things down there. | |
bb718463 MA |
390 | * |
391 | * Preprocessor sorcery ahead: use different identifiers for the local | |
392 | * variables in each expansion, so we can nest macro calls without | |
393 | * shadowing variables. | |
f9919116 | 394 | */ |
bb718463 | 395 | #define MIN_INTERNAL(a, b, _a, _b) \ |
f9919116 EB |
396 | ({ \ |
397 | typeof(1 ? (a) : (b)) _a = (a), _b = (b); \ | |
398 | _a < _b ? _a : _b; \ | |
399 | }) | |
bb718463 MA |
400 | #undef MIN |
401 | #define MIN(a, b) \ | |
402 | MIN_INTERNAL((a), (b), MAKE_IDENTFIER(_a), MAKE_IDENTFIER(_b)) | |
403 | ||
404 | #define MAX_INTERNAL(a, b, _a, _b) \ | |
f9919116 EB |
405 | ({ \ |
406 | typeof(1 ? (a) : (b)) _a = (a), _b = (b); \ | |
407 | _a > _b ? _a : _b; \ | |
408 | }) | |
bb718463 MA |
409 | #undef MAX |
410 | #define MAX(a, b) \ | |
411 | MAX_INTERNAL((a), (b), MAKE_IDENTFIER(_a), MAKE_IDENTFIER(_b)) | |
6553aa1d EB |
412 | |
413 | #ifdef __COVERITY__ | |
414 | # define MIN_CONST(a, b) ((a) < (b) ? (a) : (b)) | |
415 | # define MAX_CONST(a, b) ((a) > (b) ? (a) : (b)) | |
416 | #else | |
417 | # define MIN_CONST(a, b) \ | |
418 | __builtin_choose_expr( \ | |
419 | __builtin_constant_p(a) && __builtin_constant_p(b), \ | |
420 | (a) < (b) ? (a) : (b), \ | |
421 | ((void)0)) | |
422 | # define MAX_CONST(a, b) \ | |
f9919116 EB |
423 | __builtin_choose_expr( \ |
424 | __builtin_constant_p(a) && __builtin_constant_p(b), \ | |
425 | (a) > (b) ? (a) : (b), \ | |
426 | ((void)0)) | |
6553aa1d | 427 | #endif |
df2542c7 | 428 | |
f9919116 EB |
429 | /* |
430 | * Minimum function that returns zero only if both values are zero. | |
431 | * Intended for use with unsigned values only. | |
bb718463 MA |
432 | * |
433 | * Preprocessor sorcery ahead: use different identifiers for the local | |
434 | * variables in each expansion, so we can nest macro calls without | |
435 | * shadowing variables. | |
f9919116 | 436 | */ |
bb718463 | 437 | #define MIN_NON_ZERO_INTERNAL(a, b, _a, _b) \ |
f9919116 EB |
438 | ({ \ |
439 | typeof(1 ? (a) : (b)) _a = (a), _b = (b); \ | |
440 | _a == 0 ? _b : (_b == 0 || _b > _a) ? _a : _b; \ | |
441 | }) | |
bb718463 MA |
442 | #define MIN_NON_ZERO(a, b) \ |
443 | MIN_NON_ZERO_INTERNAL((a), (b), MAKE_IDENTFIER(_a), MAKE_IDENTFIER(_b)) | |
ac3a8726 | 444 | |
c9797456 PB |
445 | /* |
446 | * Round number down to multiple. Safe when m is not a power of 2 (see | |
447 | * ROUND_DOWN for a faster version when a power of 2 is guaranteed). | |
448 | */ | |
e07e540a MA |
449 | #define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m)) |
450 | ||
c9797456 PB |
451 | /* |
452 | * Round number up to multiple. Safe when m is not a power of 2 (see | |
453 | * ROUND_UP for a faster version when a power of 2 is guaranteed). | |
454 | */ | |
e07e540a MA |
455 | #define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m)) |
456 | ||
18a60a76 SF |
457 | /* Check if n is a multiple of m */ |
458 | #define QEMU_IS_ALIGNED(n, m) (((n) % (m)) == 0) | |
459 | ||
6b587d3c SF |
460 | /* n-byte align pointer down */ |
461 | #define QEMU_ALIGN_PTR_DOWN(p, n) \ | |
462 | ((typeof(p))QEMU_ALIGN_DOWN((uintptr_t)(p), (n))) | |
463 | ||
464 | /* n-byte align pointer up */ | |
465 | #define QEMU_ALIGN_PTR_UP(p, n) \ | |
466 | ((typeof(p))QEMU_ALIGN_UP((uintptr_t)(p), (n))) | |
467 | ||
468 | /* Check if pointer p is n-bytes aligned */ | |
469 | #define QEMU_PTR_IS_ALIGNED(p, n) QEMU_IS_ALIGNED((uintptr_t)(p), (n)) | |
470 | ||
c9797456 PB |
471 | /* |
472 | * Round number down to multiple. Requires that d be a power of 2 (see | |
e9fd416e | 473 | * QEMU_ALIGN_UP for a safer but slower version on arbitrary |
c9797456 PB |
474 | * numbers); works even if d is a smaller type than n. |
475 | */ | |
476 | #ifndef ROUND_DOWN | |
477 | #define ROUND_DOWN(n, d) ((n) & -(0 ? (n) : (d))) | |
478 | #endif | |
479 | ||
480 | /* | |
481 | * Round number up to multiple. Requires that d be a power of 2 (see | |
482 | * QEMU_ALIGN_UP for a safer but slower version on arbitrary | |
483 | * numbers); works even if d is a smaller type than n. | |
484 | */ | |
292c8e50 | 485 | #ifndef ROUND_UP |
c9797456 | 486 | #define ROUND_UP(n, d) ROUND_DOWN((n) + (d) - 1, (d)) |
292c8e50 PB |
487 | #endif |
488 | ||
e0e53b2f | 489 | #ifndef DIV_ROUND_UP |
2098b073 | 490 | #define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d)) |
e0e53b2f CC |
491 | #endif |
492 | ||
ed63ec0d MT |
493 | /* |
494 | * &(x)[0] is always a pointer - if it's same type as x then the argument is a | |
495 | * pointer, not an array. | |
496 | */ | |
497 | #define QEMU_IS_ARRAY(x) (!__builtin_types_compatible_p(typeof(x), \ | |
498 | typeof(&(x)[0]))) | |
0954d0d9 | 499 | #ifndef ARRAY_SIZE |
ed63ec0d MT |
500 | #define ARRAY_SIZE(x) ((sizeof(x) / sizeof((x)[0])) + \ |
501 | QEMU_BUILD_BUG_ON_ZERO(!QEMU_IS_ARRAY(x))) | |
0954d0d9 BS |
502 | #endif |
503 | ||
f97742d0 | 504 | int qemu_daemon(int nochdir, int noclose); |
8dbe22c6 DH |
505 | void *qemu_anon_ram_alloc(size_t size, uint64_t *align, bool shared, |
506 | bool noreserve); | |
e7a09b92 | 507 | void qemu_anon_ram_free(void *ptr, size_t size); |
ea88812f | 508 | |
d203c643 MAL |
509 | #ifdef _WIN32 |
510 | #define HAVE_CHARDEV_SERIAL 1 | |
511 | #elif defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ | |
512 | || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) \ | |
949da1eb | 513 | || defined(__GLIBC__) || defined(__APPLE__) |
d203c643 MAL |
514 | #define HAVE_CHARDEV_SERIAL 1 |
515 | #endif | |
516 | ||
8bf0f175 DC |
517 | #if defined(__HAIKU__) |
518 | #define SIGIO SIGPOLL | |
519 | #endif | |
520 | ||
8900c204 AD |
521 | #ifdef HAVE_MADVISE_WITHOUT_PROTOTYPE |
522 | /* | |
523 | * See MySQL bug #7156 (http://bugs.mysql.com/bug.php?id=7156) for discussion | |
524 | * about Solaris missing the madvise() prototype. | |
525 | */ | |
f703f1ef | 526 | int madvise(char *, size_t, int); |
8900c204 AD |
527 | #endif |
528 | ||
a16fc07e PB |
529 | #if defined(CONFIG_LINUX) |
530 | #ifndef BUS_MCEERR_AR | |
531 | #define BUS_MCEERR_AR 4 | |
532 | #endif | |
533 | #ifndef BUS_MCEERR_AO | |
534 | #define BUS_MCEERR_AO 5 | |
535 | #endif | |
536 | #endif | |
537 | ||
d2f39add | 538 | #if defined(__linux__) && \ |
0c1272cc NP |
539 | (defined(__x86_64__) || defined(__arm__) || defined(__aarch64__) \ |
540 | || defined(__powerpc64__)) | |
d2f39add DD |
541 | /* Use 2 MiB alignment so transparent hugepages can be used by KVM. |
542 | Valgrind does not support alignments larger than 1 MiB, | |
543 | therefore we need special code which handles running on Valgrind. */ | |
544 | # define QEMU_VMALLOC_ALIGN (512 * 4096) | |
545 | #elif defined(__linux__) && defined(__s390x__) | |
546 | /* Use 1 MiB (segment size) alignment so gmap can be used by KVM. */ | |
547 | # define QEMU_VMALLOC_ALIGN (256 * 4096) | |
57d1f6d7 | 548 | #elif defined(__linux__) && defined(__sparc__) |
8e3b0cbb | 549 | # define QEMU_VMALLOC_ALIGN MAX(qemu_real_host_page_size(), SHMLBA) |
d2f39add | 550 | #else |
8e3b0cbb | 551 | # define QEMU_VMALLOC_ALIGN qemu_real_host_page_size() |
d2f39add DD |
552 | #endif |
553 | ||
d98d4072 PB |
554 | #ifdef CONFIG_POSIX |
555 | struct qemu_signalfd_siginfo { | |
556 | uint32_t ssi_signo; /* Signal number */ | |
557 | int32_t ssi_errno; /* Error number (unused) */ | |
558 | int32_t ssi_code; /* Signal code */ | |
559 | uint32_t ssi_pid; /* PID of sender */ | |
560 | uint32_t ssi_uid; /* Real UID of sender */ | |
561 | int32_t ssi_fd; /* File descriptor (SIGIO) */ | |
562 | uint32_t ssi_tid; /* Kernel timer ID (POSIX timers) */ | |
563 | uint32_t ssi_band; /* Band event (SIGIO) */ | |
564 | uint32_t ssi_overrun; /* POSIX timer overrun count */ | |
565 | uint32_t ssi_trapno; /* Trap number that caused signal */ | |
566 | int32_t ssi_status; /* Exit status or signal (SIGCHLD) */ | |
567 | int32_t ssi_int; /* Integer sent by sigqueue(2) */ | |
568 | uint64_t ssi_ptr; /* Pointer sent by sigqueue(2) */ | |
569 | uint64_t ssi_utime; /* User CPU time consumed (SIGCHLD) */ | |
570 | uint64_t ssi_stime; /* System CPU time consumed (SIGCHLD) */ | |
571 | uint64_t ssi_addr; /* Address that generated signal | |
572 | (for hardware-generated signals) */ | |
573 | uint8_t pad[48]; /* Pad size to 128 bytes (allow for | |
574 | additional fields in the future) */ | |
575 | }; | |
576 | ||
577 | int qemu_signalfd(const sigset_t *mask); | |
578 | void sigaction_invoke(struct sigaction *action, | |
579 | struct qemu_signalfd_siginfo *info); | |
580 | #endif | |
581 | ||
c490af57 DB |
582 | /* |
583 | * Don't introduce new usage of this function, prefer the following | |
584 | * qemu_open/qemu_create that take an "Error **errp" | |
585 | */ | |
448058aa | 586 | int qemu_open_old(const char *name, int flags, ...); |
c490af57 DB |
587 | int qemu_open(const char *name, int flags, Error **errp); |
588 | int qemu_create(const char *name, int flags, mode_t mode, Error **errp); | |
17e0b6ab | 589 | int qemu_close(int fd); |
ee13240e | 590 | int qemu_unlink(const char *name); |
761d1ddf | 591 | #ifndef _WIN32 |
60efffa4 | 592 | int qemu_dup_flags(int fd, int flags); |
761d1ddf | 593 | int qemu_dup(int fd); |
13461fdb FZ |
594 | int qemu_lock_fd(int fd, int64_t start, int64_t len, bool exclusive); |
595 | int qemu_unlock_fd(int fd, int64_t start, int64_t len); | |
596 | int qemu_lock_fd_test(int fd, int64_t start, int64_t len, bool exclusive); | |
ca749954 | 597 | bool qemu_has_ofd_lock(void); |
6333da0f | 598 | #endif |
17e0b6ab | 599 | |
953ffe0f AF |
600 | #if defined(__HAIKU__) && defined(__i386__) |
601 | #define FMT_pid "%ld" | |
0e0167ba SW |
602 | #elif defined(WIN64) |
603 | #define FMT_pid "%" PRId64 | |
953ffe0f AF |
604 | #else |
605 | #define FMT_pid "%d" | |
606 | #endif | |
607 | ||
9e6bdef2 MAL |
608 | bool qemu_write_pidfile(const char *pidfile, Error **errp); |
609 | ||
dc7a09cf | 610 | int qemu_get_thread_id(void); |
aa26bb2d | 611 | |
9adea5f7 PB |
612 | #ifndef CONFIG_IOVEC |
613 | struct iovec { | |
614 | void *iov_base; | |
615 | size_t iov_len; | |
616 | }; | |
617 | /* | |
618 | * Use the same value as Linux for now. | |
619 | */ | |
620 | #define IOV_MAX 1024 | |
621 | ||
622 | ssize_t readv(int fd, const struct iovec *iov, int iov_cnt); | |
623 | ssize_t writev(int fd, const struct iovec *iov, int iov_cnt); | |
9adea5f7 PB |
624 | #endif |
625 | ||
ad620c29 BS |
626 | #ifdef _WIN32 |
627 | static inline void qemu_timersub(const struct timeval *val1, | |
628 | const struct timeval *val2, | |
629 | struct timeval *res) | |
630 | { | |
631 | res->tv_sec = val1->tv_sec - val2->tv_sec; | |
632 | if (val1->tv_usec < val2->tv_usec) { | |
633 | res->tv_sec--; | |
634 | res->tv_usec = val1->tv_usec - val2->tv_usec + 1000 * 1000; | |
635 | } else { | |
636 | res->tv_usec = val1->tv_usec - val2->tv_usec; | |
637 | } | |
638 | } | |
639 | #else | |
640 | #define qemu_timersub timersub | |
641 | #endif | |
642 | ||
0d14a2f3 MAL |
643 | ssize_t qemu_write_full(int fd, const void *buf, size_t count) |
644 | G_GNUC_WARN_UNUSED_RESULT; | |
645 | ||
49ee3590 AL |
646 | void qemu_set_cloexec(int fd); |
647 | ||
1fbf2665 MAL |
648 | /* Return a dynamically allocated directory path that is appropriate for storing |
649 | * local state. | |
e2ea3515 LE |
650 | * |
651 | * The caller is responsible for releasing the value returned with g_free() | |
652 | * after use. | |
653 | */ | |
1fbf2665 | 654 | char *qemu_get_local_state_dir(void); |
e2ea3515 | 655 | |
b6a3e690 RH |
656 | /** |
657 | * qemu_getauxval: | |
658 | * @type: the auxiliary vector key to lookup | |
659 | * | |
660 | * Search the auxiliary vector for @type, returning the value | |
661 | * or 0 if @type is not present. | |
662 | */ | |
b6a3e690 | 663 | unsigned long qemu_getauxval(unsigned long type); |
b6a3e690 | 664 | |
13401ba0 SH |
665 | void qemu_set_tty_echo(int fd, bool echo); |
666 | ||
e04a34e5 DH |
667 | typedef struct ThreadContext ThreadContext; |
668 | ||
6556aadc DH |
669 | /** |
670 | * qemu_prealloc_mem: | |
671 | * @fd: the fd mapped into the area, -1 for anonymous memory | |
672 | * @area: start address of the are to preallocate | |
673 | * @sz: the size of the area to preallocate | |
674 | * @max_threads: maximum number of threads to use | |
675 | * @errp: returns an error if this function fails | |
676 | * | |
677 | * Preallocate memory (populate/prefault page tables writable) for the virtual | |
678 | * memory area starting at @area with the size of @sz. After a successful call, | |
679 | * each page in the area was faulted in writable at least once, for example, | |
680 | * after allocating file blocks for mapped files. | |
681 | */ | |
682 | void qemu_prealloc_mem(int fd, char *area, size_t sz, int max_threads, | |
e04a34e5 | 683 | ThreadContext *tc, Error **errp); |
38183310 | 684 | |
7dc9ae43 MP |
685 | /** |
686 | * qemu_get_pid_name: | |
687 | * @pid: pid of a process | |
688 | * | |
689 | * For given @pid fetch its name. Caller is responsible for | |
690 | * freeing the string when no longer needed. | |
691 | * Returns allocated string on success, NULL on failure. | |
692 | */ | |
693 | char *qemu_get_pid_name(pid_t pid); | |
694 | ||
3637cf58 EC |
695 | /* Using intptr_t ensures that qemu_*_page_mask is sign-extended even |
696 | * when intptr_t is 32-bit and we are aligning a long long. | |
697 | */ | |
8e3b0cbb MAL |
698 | static inline uintptr_t qemu_real_host_page_size(void) |
699 | { | |
700 | return getpagesize(); | |
701 | } | |
702 | ||
703 | static inline intptr_t qemu_real_host_page_mask(void) | |
704 | { | |
705 | return -(intptr_t)qemu_real_host_page_size(); | |
706 | } | |
3637cf58 | 707 | |
d339d766 RJ |
708 | /* |
709 | * After using getopt or getopt_long, if you need to parse another set | |
710 | * of options, then you must reset optind. Unfortunately the way to | |
711 | * do this varies between implementations of getopt. | |
712 | */ | |
713 | static inline void qemu_reset_optind(void) | |
714 | { | |
715 | #ifdef HAVE_OPTRESET | |
716 | optind = 1; | |
717 | optreset = 1; | |
718 | #else | |
719 | optind = 0; | |
720 | #endif | |
721 | } | |
722 | ||
282468c7 MAL |
723 | int qemu_fdatasync(int fd); |
724 | ||
73991a92 MAL |
725 | /** |
726 | * Sync changes made to the memory mapped file back to the backing | |
727 | * storage. For POSIX compliant systems this will fallback | |
728 | * to regular msync call. Otherwise it will trigger whole file sync | |
729 | * (including the metadata case there is no support to skip that otherwise) | |
730 | * | |
731 | * @addr - start of the memory area to be synced | |
732 | * @length - length of the are to be synced | |
733 | * @fd - file descriptor for the file to be synced | |
734 | * (mandatory only for POSIX non-compliant systems) | |
735 | */ | |
736 | int qemu_msync(void *addr, size_t length, int fd); | |
737 | ||
ad06ef0e AB |
738 | /** |
739 | * qemu_get_host_physmem: | |
740 | * | |
741 | * Operating system agnostic way of querying host memory. | |
742 | * | |
743 | * Returns amount of physical memory on the system. This is purely | |
744 | * advisery and may return 0 if we can't work it out. At the other | |
745 | * end we saturate to SIZE_MAX if you are lucky enough to have that | |
746 | * much memory. | |
747 | */ | |
748 | size_t qemu_get_host_physmem(void); | |
749 | ||
653b87eb RB |
750 | /* |
751 | * Toggle write/execute on the pages marked MAP_JIT | |
752 | * for the current thread. | |
753 | */ | |
754 | #if defined(MAC_OS_VERSION_11_0) && \ | |
98f5ebfd | 755 | MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_VERSION_11_0 |
653b87eb RB |
756 | static inline void qemu_thread_jit_execute(void) |
757 | { | |
98f5ebfd | 758 | pthread_jit_write_protect_np(true); |
653b87eb RB |
759 | } |
760 | ||
761 | static inline void qemu_thread_jit_write(void) | |
762 | { | |
98f5ebfd | 763 | pthread_jit_write_protect_np(false); |
653b87eb RB |
764 | } |
765 | #else | |
766 | static inline void qemu_thread_jit_write(void) {} | |
767 | static inline void qemu_thread_jit_execute(void) {} | |
768 | #endif | |
769 | ||
1ad27f7d JD |
770 | /** |
771 | * Platforms which do not support system() return ENOSYS | |
772 | */ | |
773 | #ifndef HAVE_SYSTEM_FUNCTION | |
774 | #define system platform_does_not_support_system | |
775 | static inline int platform_does_not_support_system(const char *command) | |
776 | { | |
777 | errno = ENOSYS; | |
778 | return -1; | |
779 | } | |
780 | #endif /* !HAVE_SYSTEM_FUNCTION */ | |
781 | ||
875df03b PB |
782 | #ifdef __cplusplus |
783 | } | |
784 | #endif | |
785 | ||
ea88812f | 786 | #endif |