]>
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 PM |
31 | #ifdef NEED_CPU_H |
32 | #include "config-target.h" | |
bdd90227 PB |
33 | #else |
34 | #include "exec/poison.h" | |
b1e34d1c | 35 | #endif |
49120868 | 36 | #include "qemu/compiler.h" |
d5db2ec1 | 37 | |
79f56d82 PM |
38 | /* Older versions of C++ don't get definitions of various macros from |
39 | * stdlib.h unless we define these macros before first inclusion of | |
40 | * that system header. | |
41 | */ | |
42 | #ifndef __STDC_CONSTANT_MACROS | |
43 | #define __STDC_CONSTANT_MACROS | |
44 | #endif | |
45 | #ifndef __STDC_LIMIT_MACROS | |
46 | #define __STDC_LIMIT_MACROS | |
47 | #endif | |
48 | #ifndef __STDC_FORMAT_MACROS | |
49 | #define __STDC_FORMAT_MACROS | |
50 | #endif | |
51 | ||
d5db2ec1 PM |
52 | /* The following block of code temporarily renames the daemon() function so the |
53 | * compiler does not see the warning associated with it in stdlib.h on OSX | |
54 | */ | |
55 | #ifdef __APPLE__ | |
56 | #define daemon qemu_fake_daemon_function | |
57 | #include <stdlib.h> | |
58 | #undef daemon | |
59 | extern int daemon(int, int); | |
60 | #endif | |
61 | ||
ea88812f | 62 | #include <stdarg.h> |
de5071c5 | 63 | #include <stddef.h> |
0f66998f | 64 | #include <stdbool.h> |
a2b257d6 | 65 | #include <stdint.h> |
128ab2ff | 66 | #include <sys/types.h> |
bfe7e449 PM |
67 | #include <stdlib.h> |
68 | #include <stdio.h> | |
69 | #include <string.h> | |
70 | #include <strings.h> | |
71 | #include <inttypes.h> | |
72 | #include <limits.h> | |
4d9310f4 DB |
73 | /* Put unistd.h before time.h as that triggers localtime_r/gmtime_r |
74 | * function availability on recentish Mingw-w64 platforms. */ | |
75 | #include <unistd.h> | |
bfe7e449 PM |
76 | #include <time.h> |
77 | #include <ctype.h> | |
78 | #include <errno.h> | |
bfe7e449 PM |
79 | #include <fcntl.h> |
80 | #include <sys/stat.h> | |
81 | #include <sys/time.h> | |
82 | #include <assert.h> | |
e89fdafb SW |
83 | /* setjmp must be declared before sysemu/os-win32.h |
84 | * because it is redefined there. */ | |
85 | #include <setjmp.h> | |
bfe7e449 PM |
86 | #include <signal.h> |
87 | ||
98b2d199 | 88 | #ifdef __OpenBSD__ |
128ab2ff BS |
89 | #include <sys/signal.h> |
90 | #endif | |
ea88812f | 91 | |
13c7b2da PB |
92 | #ifndef _WIN32 |
93 | #include <sys/wait.h> | |
94 | #else | |
95 | #define WIFEXITED(x) 1 | |
96 | #define WEXITSTATUS(x) (x) | |
97 | #endif | |
98 | ||
bfe7e449 PM |
99 | #ifdef _WIN32 |
100 | #include "sysemu/os-win32.h" | |
101 | #endif | |
102 | ||
103 | #ifdef CONFIG_POSIX | |
104 | #include "sysemu/os-posix.h" | |
105 | #endif | |
f7b4a940 | 106 | |
529490e5 | 107 | #include "glib-compat.h" |
da34e65c | 108 | #include "qemu/typedefs.h" |
57cb38b3 | 109 | |
bfe7e449 PM |
110 | #ifndef O_LARGEFILE |
111 | #define O_LARGEFILE 0 | |
112 | #endif | |
113 | #ifndef O_BINARY | |
114 | #define O_BINARY 0 | |
115 | #endif | |
116 | #ifndef MAP_ANONYMOUS | |
117 | #define MAP_ANONYMOUS MAP_ANON | |
118 | #endif | |
119 | #ifndef ENOMEDIUM | |
120 | #define ENOMEDIUM ENODEV | |
121 | #endif | |
122 | #if !defined(ENOTSUP) | |
123 | #define ENOTSUP 4096 | |
124 | #endif | |
125 | #if !defined(ECANCELED) | |
126 | #define ECANCELED 4097 | |
127 | #endif | |
128 | #if !defined(EMEDIUMTYPE) | |
129 | #define EMEDIUMTYPE 4098 | |
130 | #endif | |
131 | #ifndef TIME_MAX | |
132 | #define TIME_MAX LONG_MAX | |
133 | #endif | |
134 | ||
a8139632 MA |
135 | /* HOST_LONG_BITS is the size of a native pointer in bits. */ |
136 | #if UINTPTR_MAX == UINT32_MAX | |
137 | # define HOST_LONG_BITS 32 | |
138 | #elif UINTPTR_MAX == UINT64_MAX | |
139 | # define HOST_LONG_BITS 64 | |
140 | #else | |
141 | # error Unknown pointer size | |
142 | #endif | |
143 | ||
df2542c7 JM |
144 | #ifndef MIN |
145 | #define MIN(a, b) (((a) < (b)) ? (a) : (b)) | |
146 | #endif | |
147 | #ifndef MAX | |
148 | #define MAX(a, b) (((a) > (b)) ? (a) : (b)) | |
149 | #endif | |
150 | ||
ac3a8726 PL |
151 | /* Minimum function that returns zero only iff both values are zero. |
152 | * Intended for use with unsigned values only. */ | |
153 | #ifndef MIN_NON_ZERO | |
154 | #define MIN_NON_ZERO(a, b) (((a) != 0 && (a) < (b)) ? (a) : (b)) | |
155 | #endif | |
156 | ||
e07e540a MA |
157 | /* Round number down to multiple */ |
158 | #define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m)) | |
159 | ||
160 | /* Round number up to multiple */ | |
161 | #define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m)) | |
162 | ||
18a60a76 SF |
163 | /* Check if n is a multiple of m */ |
164 | #define QEMU_IS_ALIGNED(n, m) (((n) % (m)) == 0) | |
165 | ||
6b587d3c SF |
166 | /* n-byte align pointer down */ |
167 | #define QEMU_ALIGN_PTR_DOWN(p, n) \ | |
168 | ((typeof(p))QEMU_ALIGN_DOWN((uintptr_t)(p), (n))) | |
169 | ||
170 | /* n-byte align pointer up */ | |
171 | #define QEMU_ALIGN_PTR_UP(p, n) \ | |
172 | ((typeof(p))QEMU_ALIGN_UP((uintptr_t)(p), (n))) | |
173 | ||
174 | /* Check if pointer p is n-bytes aligned */ | |
175 | #define QEMU_PTR_IS_ALIGNED(p, n) QEMU_IS_ALIGNED((uintptr_t)(p), (n)) | |
176 | ||
292c8e50 PB |
177 | #ifndef ROUND_UP |
178 | #define ROUND_UP(n,d) (((n) + (d) - 1) & -(d)) | |
179 | #endif | |
180 | ||
e0e53b2f CC |
181 | #ifndef DIV_ROUND_UP |
182 | #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d)) | |
183 | #endif | |
184 | ||
0954d0d9 BS |
185 | #ifndef ARRAY_SIZE |
186 | #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) | |
187 | #endif | |
188 | ||
f97742d0 | 189 | int qemu_daemon(int nochdir, int noclose); |
7d2a35cc | 190 | void *qemu_try_memalign(size_t alignment, size_t size); |
33f00271 | 191 | void *qemu_memalign(size_t alignment, size_t size); |
a2b257d6 | 192 | void *qemu_anon_ram_alloc(size_t size, uint64_t *align); |
49b470eb | 193 | void qemu_vfree(void *ptr); |
e7a09b92 | 194 | void qemu_anon_ram_free(void *ptr, size_t size); |
ea88812f | 195 | |
e78815a5 AF |
196 | #define QEMU_MADV_INVALID -1 |
197 | ||
198 | #if defined(CONFIG_MADVISE) | |
199 | ||
200 | #define QEMU_MADV_WILLNEED MADV_WILLNEED | |
201 | #define QEMU_MADV_DONTNEED MADV_DONTNEED | |
202 | #ifdef MADV_DONTFORK | |
203 | #define QEMU_MADV_DONTFORK MADV_DONTFORK | |
204 | #else | |
205 | #define QEMU_MADV_DONTFORK QEMU_MADV_INVALID | |
206 | #endif | |
207 | #ifdef MADV_MERGEABLE | |
208 | #define QEMU_MADV_MERGEABLE MADV_MERGEABLE | |
209 | #else | |
210 | #define QEMU_MADV_MERGEABLE QEMU_MADV_INVALID | |
211 | #endif | |
605d0a94 PB |
212 | #ifdef MADV_UNMERGEABLE |
213 | #define QEMU_MADV_UNMERGEABLE MADV_UNMERGEABLE | |
214 | #else | |
215 | #define QEMU_MADV_UNMERGEABLE QEMU_MADV_INVALID | |
216 | #endif | |
217 | #ifdef MADV_DODUMP | |
218 | #define QEMU_MADV_DODUMP MADV_DODUMP | |
219 | #else | |
220 | #define QEMU_MADV_DODUMP QEMU_MADV_INVALID | |
221 | #endif | |
ddb97f1d JB |
222 | #ifdef MADV_DONTDUMP |
223 | #define QEMU_MADV_DONTDUMP MADV_DONTDUMP | |
224 | #else | |
225 | #define QEMU_MADV_DONTDUMP QEMU_MADV_INVALID | |
226 | #endif | |
ad0b5321 LC |
227 | #ifdef MADV_HUGEPAGE |
228 | #define QEMU_MADV_HUGEPAGE MADV_HUGEPAGE | |
229 | #else | |
230 | #define QEMU_MADV_HUGEPAGE QEMU_MADV_INVALID | |
231 | #endif | |
ebf81150 DDAG |
232 | #ifdef MADV_NOHUGEPAGE |
233 | #define QEMU_MADV_NOHUGEPAGE MADV_NOHUGEPAGE | |
234 | #else | |
235 | #define QEMU_MADV_NOHUGEPAGE QEMU_MADV_INVALID | |
236 | #endif | |
e78815a5 AF |
237 | |
238 | #elif defined(CONFIG_POSIX_MADVISE) | |
239 | ||
240 | #define QEMU_MADV_WILLNEED POSIX_MADV_WILLNEED | |
241 | #define QEMU_MADV_DONTNEED POSIX_MADV_DONTNEED | |
242 | #define QEMU_MADV_DONTFORK QEMU_MADV_INVALID | |
243 | #define QEMU_MADV_MERGEABLE QEMU_MADV_INVALID | |
2925020d MT |
244 | #define QEMU_MADV_UNMERGEABLE QEMU_MADV_INVALID |
245 | #define QEMU_MADV_DODUMP QEMU_MADV_INVALID | |
ddb97f1d | 246 | #define QEMU_MADV_DONTDUMP QEMU_MADV_INVALID |
8473f377 | 247 | #define QEMU_MADV_HUGEPAGE QEMU_MADV_INVALID |
ebf81150 | 248 | #define QEMU_MADV_NOHUGEPAGE QEMU_MADV_INVALID |
e78815a5 AF |
249 | |
250 | #else /* no-op */ | |
251 | ||
252 | #define QEMU_MADV_WILLNEED QEMU_MADV_INVALID | |
253 | #define QEMU_MADV_DONTNEED QEMU_MADV_INVALID | |
254 | #define QEMU_MADV_DONTFORK QEMU_MADV_INVALID | |
255 | #define QEMU_MADV_MERGEABLE QEMU_MADV_INVALID | |
2925020d MT |
256 | #define QEMU_MADV_UNMERGEABLE QEMU_MADV_INVALID |
257 | #define QEMU_MADV_DODUMP QEMU_MADV_INVALID | |
ddb97f1d | 258 | #define QEMU_MADV_DONTDUMP QEMU_MADV_INVALID |
8473f377 | 259 | #define QEMU_MADV_HUGEPAGE QEMU_MADV_INVALID |
ebf81150 | 260 | #define QEMU_MADV_NOHUGEPAGE QEMU_MADV_INVALID |
e78815a5 AF |
261 | |
262 | #endif | |
263 | ||
d2f39add DD |
264 | #if defined(__linux__) && \ |
265 | (defined(__x86_64__) || defined(__arm__) || defined(__aarch64__)) | |
266 | /* Use 2 MiB alignment so transparent hugepages can be used by KVM. | |
267 | Valgrind does not support alignments larger than 1 MiB, | |
268 | therefore we need special code which handles running on Valgrind. */ | |
269 | # define QEMU_VMALLOC_ALIGN (512 * 4096) | |
270 | #elif defined(__linux__) && defined(__s390x__) | |
271 | /* Use 1 MiB (segment size) alignment so gmap can be used by KVM. */ | |
272 | # define QEMU_VMALLOC_ALIGN (256 * 4096) | |
273 | #else | |
274 | # define QEMU_VMALLOC_ALIGN getpagesize() | |
275 | #endif | |
276 | ||
e78815a5 AF |
277 | int qemu_madvise(void *addr, size_t len, int advice); |
278 | ||
17e0b6ab AF |
279 | int qemu_open(const char *name, int flags, ...); |
280 | int qemu_close(int fd); | |
281 | ||
953ffe0f AF |
282 | #if defined(__HAIKU__) && defined(__i386__) |
283 | #define FMT_pid "%ld" | |
0e0167ba SW |
284 | #elif defined(WIN64) |
285 | #define FMT_pid "%" PRId64 | |
953ffe0f AF |
286 | #else |
287 | #define FMT_pid "%d" | |
288 | #endif | |
289 | ||
aa26bb2d | 290 | int qemu_create_pidfile(const char *filename); |
dc7a09cf | 291 | int qemu_get_thread_id(void); |
aa26bb2d | 292 | |
9adea5f7 PB |
293 | #ifndef CONFIG_IOVEC |
294 | struct iovec { | |
295 | void *iov_base; | |
296 | size_t iov_len; | |
297 | }; | |
298 | /* | |
299 | * Use the same value as Linux for now. | |
300 | */ | |
301 | #define IOV_MAX 1024 | |
302 | ||
303 | ssize_t readv(int fd, const struct iovec *iov, int iov_cnt); | |
304 | ssize_t writev(int fd, const struct iovec *iov, int iov_cnt); | |
305 | #else | |
306 | #include <sys/uio.h> | |
307 | #endif | |
308 | ||
ad620c29 BS |
309 | #ifdef _WIN32 |
310 | static inline void qemu_timersub(const struct timeval *val1, | |
311 | const struct timeval *val2, | |
312 | struct timeval *res) | |
313 | { | |
314 | res->tv_sec = val1->tv_sec - val2->tv_sec; | |
315 | if (val1->tv_usec < val2->tv_usec) { | |
316 | res->tv_sec--; | |
317 | res->tv_usec = val1->tv_usec - val2->tv_usec + 1000 * 1000; | |
318 | } else { | |
319 | res->tv_usec = val1->tv_usec - val2->tv_usec; | |
320 | } | |
321 | } | |
322 | #else | |
323 | #define qemu_timersub timersub | |
324 | #endif | |
325 | ||
49ee3590 AL |
326 | void qemu_set_cloexec(int fd); |
327 | ||
d494352c EH |
328 | /* Starting on QEMU 2.5, qemu_hw_version() returns "2.5+" by default |
329 | * instead of QEMU_VERSION, so setting hw_version on MachineClass | |
330 | * is no longer mandatory. | |
331 | * | |
332 | * Do NOT change this string, or it will break compatibility on all | |
333 | * machine classes that don't set hw_version. | |
334 | */ | |
335 | #define QEMU_HW_VERSION "2.5+" | |
336 | ||
fac862ff | 337 | /* QEMU "hardware version" setting. Used to replace code that exposed |
cb8d4c8f | 338 | * QEMU_VERSION to guests in the past and need to keep compatibility. |
fac862ff EH |
339 | * Do not use qemu_hw_version() in new code. |
340 | */ | |
35c2c8dc EH |
341 | void qemu_set_hw_version(const char *); |
342 | const char *qemu_hw_version(void); | |
93bfef4c | 343 | |
0f66998f PM |
344 | void fips_set_state(bool requested); |
345 | bool fips_get_state(void); | |
346 | ||
e2ea3515 LE |
347 | /* Return a dynamically allocated pathname denoting a file or directory that is |
348 | * appropriate for storing local state. | |
349 | * | |
350 | * @relative_pathname need not start with a directory separator; one will be | |
351 | * added automatically. | |
352 | * | |
353 | * The caller is responsible for releasing the value returned with g_free() | |
354 | * after use. | |
355 | */ | |
356 | char *qemu_get_local_state_pathname(const char *relative_pathname); | |
357 | ||
10f5bff6 FZ |
358 | /* Find program directory, and save it for later usage with |
359 | * qemu_get_exec_dir(). | |
360 | * Try OS specific API first, if not working, parse from argv0. */ | |
361 | void qemu_init_exec_dir(const char *argv0); | |
362 | ||
363 | /* Get the saved exec dir. | |
364 | * Caller needs to release the returned string by g_free() */ | |
365 | char *qemu_get_exec_dir(void); | |
366 | ||
b6a3e690 RH |
367 | /** |
368 | * qemu_getauxval: | |
369 | * @type: the auxiliary vector key to lookup | |
370 | * | |
371 | * Search the auxiliary vector for @type, returning the value | |
372 | * or 0 if @type is not present. | |
373 | */ | |
b6a3e690 | 374 | unsigned long qemu_getauxval(unsigned long type); |
b6a3e690 | 375 | |
13401ba0 SH |
376 | void qemu_set_tty_echo(int fd, bool echo); |
377 | ||
38183310 PB |
378 | void os_mem_prealloc(int fd, char *area, size_t sz); |
379 | ||
d57e4e48 DB |
380 | int qemu_read_password(char *buf, int buf_size); |
381 | ||
57cb38b3 DB |
382 | /** |
383 | * qemu_fork: | |
384 | * | |
385 | * A version of fork that avoids signal handler race | |
386 | * conditions that can lead to child process getting | |
387 | * signals that are otherwise only expected by the | |
388 | * parent. It also resets all signal handlers to the | |
389 | * default settings. | |
390 | * | |
391 | * Returns 0 to child process, pid number to parent | |
392 | * or -1 on failure. | |
393 | */ | |
394 | pid_t qemu_fork(Error **errp); | |
395 | ||
ea88812f | 396 | #endif |