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