xref: /qemu/include/qemu/osdep.h (revision 2e8f72ac)
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  * 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.
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 #include "config-host.h"
31 #ifdef NEED_CPU_H
32 #include CONFIG_TARGET
33 #else
34 #include "exec/poison.h"
35 #endif
36 
37 #include "qemu/compiler.h"
38 
39 /* Older versions of C++ don't get definitions of various macros from
40  * stdlib.h unless we define these macros before first inclusion of
41  * that system header.
42  */
43 #ifndef __STDC_CONSTANT_MACROS
44 #define __STDC_CONSTANT_MACROS
45 #endif
46 #ifndef __STDC_LIMIT_MACROS
47 #define __STDC_LIMIT_MACROS
48 #endif
49 #ifndef __STDC_FORMAT_MACROS
50 #define __STDC_FORMAT_MACROS
51 #endif
52 
53 /* The following block of code temporarily renames the daemon() function so the
54  * compiler does not see the warning associated with it in stdlib.h on OSX
55  */
56 #ifdef __APPLE__
57 #define daemon qemu_fake_daemon_function
58 #include <stdlib.h>
59 #undef daemon
60 extern int daemon(int, int);
61 #endif
62 
63 #ifdef _WIN32
64 /* as defined in sdkddkver.h */
65 #ifndef _WIN32_WINNT
66 #define _WIN32_WINNT 0x0600 /* Vista */
67 #endif
68 /* reduces the number of implicitly included headers */
69 #ifndef WIN32_LEAN_AND_MEAN
70 #define WIN32_LEAN_AND_MEAN
71 #endif
72 #endif
73 
74 /* enable C99/POSIX format strings (needs mingw32-runtime 3.15 or later) */
75 #ifdef __MINGW32__
76 #define __USE_MINGW_ANSI_STDIO 1
77 #endif
78 
79 #include <stdarg.h>
80 #include <stddef.h>
81 #include <stdbool.h>
82 #include <stdint.h>
83 #include <sys/types.h>
84 #include <stdlib.h>
85 #include <stdio.h>
86 
87 #include <string.h>
88 #include <strings.h>
89 #include <inttypes.h>
90 #include <limits.h>
91 /* Put unistd.h before time.h as that triggers localtime_r/gmtime_r
92  * function availability on recentish Mingw-w64 platforms. */
93 #include <unistd.h>
94 #include <time.h>
95 #include <ctype.h>
96 #include <errno.h>
97 #include <fcntl.h>
98 #include <getopt.h>
99 #include <sys/stat.h>
100 #include <sys/time.h>
101 #include <assert.h>
102 /* setjmp must be declared before sysemu/os-win32.h
103  * because it is redefined there. */
104 #include <setjmp.h>
105 #include <signal.h>
106 
107 #ifndef _WIN32
108 #include <sys/wait.h>
109 #else
110 #define WIFEXITED(x)   1
111 #define WEXITSTATUS(x) (x)
112 #endif
113 
114 #ifdef _WIN32
115 #include "sysemu/os-win32.h"
116 #endif
117 
118 #ifdef CONFIG_POSIX
119 #include "sysemu/os-posix.h"
120 #endif
121 
122 #include "glib-compat.h"
123 #include "qemu/typedefs.h"
124 
125 /*
126  * For mingw, as of v6.0.0, the function implementing the assert macro is
127  * not marked as noreturn, so the compiler cannot delete code following an
128  * assert(false) as unused.  We rely on this within the code base to delete
129  * code that is unreachable when features are disabled.
130  * All supported versions of Glib's g_assert() satisfy this requirement.
131  */
132 #ifdef __MINGW32__
133 #undef assert
134 #define assert(x)  g_assert(x)
135 #endif
136 
137 /*
138  * According to waitpid man page:
139  * WCOREDUMP
140  *  This  macro  is  not  specified  in POSIX.1-2001 and is not
141  *  available on some UNIX implementations (e.g., AIX, SunOS).
142  *  Therefore, enclose its use inside #ifdef WCOREDUMP ... #endif.
143  */
144 #ifndef WCOREDUMP
145 #define WCOREDUMP(status) 0
146 #endif
147 /*
148  * We have a lot of unaudited code that may fail in strange ways, or
149  * even be a security risk during migration, if you disable assertions
150  * at compile-time.  You may comment out these safety checks if you
151  * absolutely want to disable assertion overhead, but it is not
152  * supported upstream so the risk is all yours.  Meanwhile, please
153  * submit patches to remove any side-effects inside an assertion, or
154  * fixing error handling that should use Error instead of assert.
155  */
156 #ifdef NDEBUG
157 #error building with NDEBUG is not supported
158 #endif
159 #ifdef G_DISABLE_ASSERT
160 #error building with G_DISABLE_ASSERT is not supported
161 #endif
162 
163 #ifndef O_LARGEFILE
164 #define O_LARGEFILE 0
165 #endif
166 #ifndef O_BINARY
167 #define O_BINARY 0
168 #endif
169 #ifndef MAP_ANONYMOUS
170 #define MAP_ANONYMOUS MAP_ANON
171 #endif
172 #ifndef MAP_FIXED_NOREPLACE
173 #define MAP_FIXED_NOREPLACE 0
174 #endif
175 #ifndef ENOMEDIUM
176 #define ENOMEDIUM ENODEV
177 #endif
178 #if !defined(ENOTSUP)
179 #define ENOTSUP 4096
180 #endif
181 #if !defined(ECANCELED)
182 #define ECANCELED 4097
183 #endif
184 #if !defined(EMEDIUMTYPE)
185 #define EMEDIUMTYPE 4098
186 #endif
187 #if !defined(ESHUTDOWN)
188 #define ESHUTDOWN 4099
189 #endif
190 
191 /* time_t may be either 32 or 64 bits depending on the host OS, and
192  * can be either signed or unsigned, so we can't just hardcode a
193  * specific maximum value. This is not a C preprocessor constant,
194  * so you can't use TIME_MAX in an #ifdef, but for our purposes
195  * this isn't a problem.
196  */
197 
198 /* The macros TYPE_SIGNED, TYPE_WIDTH, and TYPE_MAXIMUM are from
199  * Gnulib, and are under the LGPL v2.1 or (at your option) any
200  * later version.
201  */
202 
203 /* True if the real type T is signed.  */
204 #define TYPE_SIGNED(t) (!((t)0 < (t)-1))
205 
206 /* The width in bits of the integer type or expression T.
207  * Padding bits are not supported.
208  */
209 #define TYPE_WIDTH(t) (sizeof(t) * CHAR_BIT)
210 
211 /* The maximum and minimum values for the integer type T.  */
212 #define TYPE_MAXIMUM(t)                                                \
213   ((t) (!TYPE_SIGNED(t)                                                \
214         ? (t)-1                                                        \
215         : ((((t)1 << (TYPE_WIDTH(t) - 2)) - 1) * 2 + 1)))
216 
217 #ifndef TIME_MAX
218 #define TIME_MAX TYPE_MAXIMUM(time_t)
219 #endif
220 
221 /* HOST_LONG_BITS is the size of a native pointer in bits. */
222 #if UINTPTR_MAX == UINT32_MAX
223 # define HOST_LONG_BITS 32
224 #elif UINTPTR_MAX == UINT64_MAX
225 # define HOST_LONG_BITS 64
226 #else
227 # error Unknown pointer size
228 #endif
229 
230 /* Mac OSX has a <stdint.h> bug that incorrectly defines SIZE_MAX with
231  * the wrong type. Our replacement isn't usable in preprocessor
232  * expressions, but it is sufficient for our needs. */
233 #if defined(HAVE_BROKEN_SIZE_MAX) && HAVE_BROKEN_SIZE_MAX
234 #undef SIZE_MAX
235 #define SIZE_MAX ((size_t)-1)
236 #endif
237 
238 /*
239  * Two variations of MIN/MAX macros. The first is for runtime use, and
240  * evaluates arguments only once (so it is safe even with side
241  * effects), but will not work in constant contexts (such as array
242  * size declarations) because of the '{}'.  The second is for constant
243  * expression use, where evaluating arguments twice is safe because
244  * the result is going to be constant anyway, but will not work in a
245  * runtime context because of a void expression where a value is
246  * expected.  Thus, both gcc and clang will fail to compile if you use
247  * the wrong macro (even if the error may seem a bit cryptic).
248  *
249  * Note that neither form is usable as an #if condition; if you truly
250  * need to write conditional code that depends on a minimum or maximum
251  * determined by the pre-processor instead of the compiler, you'll
252  * have to open-code it.  Sadly, Coverity is severely confused by the
253  * constant variants, so we have to dumb things down there.
254  */
255 #undef MIN
256 #define MIN(a, b)                                       \
257     ({                                                  \
258         typeof(1 ? (a) : (b)) _a = (a), _b = (b);       \
259         _a < _b ? _a : _b;                              \
260     })
261 #undef MAX
262 #define MAX(a, b)                                       \
263     ({                                                  \
264         typeof(1 ? (a) : (b)) _a = (a), _b = (b);       \
265         _a > _b ? _a : _b;                              \
266     })
267 
268 #ifdef __COVERITY__
269 # define MIN_CONST(a, b) ((a) < (b) ? (a) : (b))
270 # define MAX_CONST(a, b) ((a) > (b) ? (a) : (b))
271 #else
272 # define MIN_CONST(a, b)                                        \
273     __builtin_choose_expr(                                      \
274         __builtin_constant_p(a) && __builtin_constant_p(b),     \
275         (a) < (b) ? (a) : (b),                                  \
276         ((void)0))
277 # define MAX_CONST(a, b)                                        \
278     __builtin_choose_expr(                                      \
279         __builtin_constant_p(a) && __builtin_constant_p(b),     \
280         (a) > (b) ? (a) : (b),                                  \
281         ((void)0))
282 #endif
283 
284 /*
285  * Minimum function that returns zero only if both values are zero.
286  * Intended for use with unsigned values only.
287  */
288 #ifndef MIN_NON_ZERO
289 #define MIN_NON_ZERO(a, b)                              \
290     ({                                                  \
291         typeof(1 ? (a) : (b)) _a = (a), _b = (b);       \
292         _a == 0 ? _b : (_b == 0 || _b > _a) ? _a : _b;  \
293     })
294 #endif
295 
296 /* Round number down to multiple */
297 #define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
298 
299 /* Round number up to multiple. Safe when m is not a power of 2 (see
300  * ROUND_UP for a faster version when a power of 2 is guaranteed) */
301 #define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
302 
303 /* Check if n is a multiple of m */
304 #define QEMU_IS_ALIGNED(n, m) (((n) % (m)) == 0)
305 
306 /* n-byte align pointer down */
307 #define QEMU_ALIGN_PTR_DOWN(p, n) \
308     ((typeof(p))QEMU_ALIGN_DOWN((uintptr_t)(p), (n)))
309 
310 /* n-byte align pointer up */
311 #define QEMU_ALIGN_PTR_UP(p, n) \
312     ((typeof(p))QEMU_ALIGN_UP((uintptr_t)(p), (n)))
313 
314 /* Check if pointer p is n-bytes aligned */
315 #define QEMU_PTR_IS_ALIGNED(p, n) QEMU_IS_ALIGNED((uintptr_t)(p), (n))
316 
317 /* Round number up to multiple. Requires that d be a power of 2 (see
318  * QEMU_ALIGN_UP for a safer but slower version on arbitrary
319  * numbers); works even if d is a smaller type than n.  */
320 #ifndef ROUND_UP
321 #define ROUND_UP(n, d) (((n) + (d) - 1) & -(0 ? (n) : (d)))
322 #endif
323 
324 #ifndef DIV_ROUND_UP
325 #define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
326 #endif
327 
328 /*
329  * &(x)[0] is always a pointer - if it's same type as x then the argument is a
330  * pointer, not an array.
331  */
332 #define QEMU_IS_ARRAY(x) (!__builtin_types_compatible_p(typeof(x), \
333                                                         typeof(&(x)[0])))
334 #ifndef ARRAY_SIZE
335 #define ARRAY_SIZE(x) ((sizeof(x) / sizeof((x)[0])) + \
336                        QEMU_BUILD_BUG_ON_ZERO(!QEMU_IS_ARRAY(x)))
337 #endif
338 
339 int qemu_daemon(int nochdir, int noclose);
340 void *qemu_try_memalign(size_t alignment, size_t size);
341 void *qemu_memalign(size_t alignment, size_t size);
342 void *qemu_anon_ram_alloc(size_t size, uint64_t *align, bool shared);
343 void qemu_vfree(void *ptr);
344 void qemu_anon_ram_free(void *ptr, size_t size);
345 
346 #define QEMU_MADV_INVALID -1
347 
348 #if defined(CONFIG_MADVISE)
349 
350 #define QEMU_MADV_WILLNEED  MADV_WILLNEED
351 #define QEMU_MADV_DONTNEED  MADV_DONTNEED
352 #ifdef MADV_DONTFORK
353 #define QEMU_MADV_DONTFORK  MADV_DONTFORK
354 #else
355 #define QEMU_MADV_DONTFORK  QEMU_MADV_INVALID
356 #endif
357 #ifdef MADV_MERGEABLE
358 #define QEMU_MADV_MERGEABLE MADV_MERGEABLE
359 #else
360 #define QEMU_MADV_MERGEABLE QEMU_MADV_INVALID
361 #endif
362 #ifdef MADV_UNMERGEABLE
363 #define QEMU_MADV_UNMERGEABLE MADV_UNMERGEABLE
364 #else
365 #define QEMU_MADV_UNMERGEABLE QEMU_MADV_INVALID
366 #endif
367 #ifdef MADV_DODUMP
368 #define QEMU_MADV_DODUMP MADV_DODUMP
369 #else
370 #define QEMU_MADV_DODUMP QEMU_MADV_INVALID
371 #endif
372 #ifdef MADV_DONTDUMP
373 #define QEMU_MADV_DONTDUMP MADV_DONTDUMP
374 #else
375 #define QEMU_MADV_DONTDUMP QEMU_MADV_INVALID
376 #endif
377 #ifdef MADV_HUGEPAGE
378 #define QEMU_MADV_HUGEPAGE MADV_HUGEPAGE
379 #else
380 #define QEMU_MADV_HUGEPAGE QEMU_MADV_INVALID
381 #endif
382 #ifdef MADV_NOHUGEPAGE
383 #define QEMU_MADV_NOHUGEPAGE MADV_NOHUGEPAGE
384 #else
385 #define QEMU_MADV_NOHUGEPAGE QEMU_MADV_INVALID
386 #endif
387 #ifdef MADV_REMOVE
388 #define QEMU_MADV_REMOVE MADV_REMOVE
389 #else
390 #define QEMU_MADV_REMOVE QEMU_MADV_INVALID
391 #endif
392 
393 #elif defined(CONFIG_POSIX_MADVISE)
394 
395 #define QEMU_MADV_WILLNEED  POSIX_MADV_WILLNEED
396 #define QEMU_MADV_DONTNEED  POSIX_MADV_DONTNEED
397 #define QEMU_MADV_DONTFORK  QEMU_MADV_INVALID
398 #define QEMU_MADV_MERGEABLE QEMU_MADV_INVALID
399 #define QEMU_MADV_UNMERGEABLE QEMU_MADV_INVALID
400 #define QEMU_MADV_DODUMP QEMU_MADV_INVALID
401 #define QEMU_MADV_DONTDUMP QEMU_MADV_INVALID
402 #define QEMU_MADV_HUGEPAGE  QEMU_MADV_INVALID
403 #define QEMU_MADV_NOHUGEPAGE  QEMU_MADV_INVALID
404 #define QEMU_MADV_REMOVE QEMU_MADV_INVALID
405 
406 #else /* no-op */
407 
408 #define QEMU_MADV_WILLNEED  QEMU_MADV_INVALID
409 #define QEMU_MADV_DONTNEED  QEMU_MADV_INVALID
410 #define QEMU_MADV_DONTFORK  QEMU_MADV_INVALID
411 #define QEMU_MADV_MERGEABLE QEMU_MADV_INVALID
412 #define QEMU_MADV_UNMERGEABLE QEMU_MADV_INVALID
413 #define QEMU_MADV_DODUMP QEMU_MADV_INVALID
414 #define QEMU_MADV_DONTDUMP QEMU_MADV_INVALID
415 #define QEMU_MADV_HUGEPAGE  QEMU_MADV_INVALID
416 #define QEMU_MADV_NOHUGEPAGE  QEMU_MADV_INVALID
417 #define QEMU_MADV_REMOVE QEMU_MADV_INVALID
418 
419 #endif
420 
421 #ifdef _WIN32
422 #define HAVE_CHARDEV_SERIAL 1
423 #elif defined(__linux__) || defined(__sun__) || defined(__FreeBSD__)    \
424     || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) \
425     || defined(__GLIBC__) || defined(__APPLE__)
426 #define HAVE_CHARDEV_SERIAL 1
427 #endif
428 
429 #if defined(__linux__) || defined(__FreeBSD__) ||               \
430     defined(__FreeBSD_kernel__) || defined(__DragonFly__)
431 #define HAVE_CHARDEV_PARPORT 1
432 #endif
433 
434 #if defined(__HAIKU__)
435 #define SIGIO SIGPOLL
436 #endif
437 
438 #if defined(CONFIG_LINUX)
439 #ifndef BUS_MCEERR_AR
440 #define BUS_MCEERR_AR 4
441 #endif
442 #ifndef BUS_MCEERR_AO
443 #define BUS_MCEERR_AO 5
444 #endif
445 #endif
446 
447 #if defined(__linux__) && \
448     (defined(__x86_64__) || defined(__arm__) || defined(__aarch64__) \
449      || defined(__powerpc64__))
450    /* Use 2 MiB alignment so transparent hugepages can be used by KVM.
451       Valgrind does not support alignments larger than 1 MiB,
452       therefore we need special code which handles running on Valgrind. */
453 #  define QEMU_VMALLOC_ALIGN (512 * 4096)
454 #elif defined(__linux__) && defined(__s390x__)
455    /* Use 1 MiB (segment size) alignment so gmap can be used by KVM. */
456 #  define QEMU_VMALLOC_ALIGN (256 * 4096)
457 #elif defined(__linux__) && defined(__sparc__)
458 #include <sys/shm.h>
459 #  define QEMU_VMALLOC_ALIGN MAX(qemu_real_host_page_size, SHMLBA)
460 #else
461 #  define QEMU_VMALLOC_ALIGN qemu_real_host_page_size
462 #endif
463 
464 #ifdef CONFIG_POSIX
465 struct qemu_signalfd_siginfo {
466     uint32_t ssi_signo;   /* Signal number */
467     int32_t  ssi_errno;   /* Error number (unused) */
468     int32_t  ssi_code;    /* Signal code */
469     uint32_t ssi_pid;     /* PID of sender */
470     uint32_t ssi_uid;     /* Real UID of sender */
471     int32_t  ssi_fd;      /* File descriptor (SIGIO) */
472     uint32_t ssi_tid;     /* Kernel timer ID (POSIX timers) */
473     uint32_t ssi_band;    /* Band event (SIGIO) */
474     uint32_t ssi_overrun; /* POSIX timer overrun count */
475     uint32_t ssi_trapno;  /* Trap number that caused signal */
476     int32_t  ssi_status;  /* Exit status or signal (SIGCHLD) */
477     int32_t  ssi_int;     /* Integer sent by sigqueue(2) */
478     uint64_t ssi_ptr;     /* Pointer sent by sigqueue(2) */
479     uint64_t ssi_utime;   /* User CPU time consumed (SIGCHLD) */
480     uint64_t ssi_stime;   /* System CPU time consumed (SIGCHLD) */
481     uint64_t ssi_addr;    /* Address that generated signal
482                              (for hardware-generated signals) */
483     uint8_t  pad[48];     /* Pad size to 128 bytes (allow for
484                              additional fields in the future) */
485 };
486 
487 int qemu_signalfd(const sigset_t *mask);
488 void sigaction_invoke(struct sigaction *action,
489                       struct qemu_signalfd_siginfo *info);
490 #endif
491 
492 int qemu_madvise(void *addr, size_t len, int advice);
493 int qemu_mprotect_rwx(void *addr, size_t size);
494 int qemu_mprotect_none(void *addr, size_t size);
495 
496 /*
497  * Don't introduce new usage of this function, prefer the following
498  * qemu_open/qemu_create that take an "Error **errp"
499  */
500 int qemu_open_old(const char *name, int flags, ...);
501 int qemu_open(const char *name, int flags, Error **errp);
502 int qemu_create(const char *name, int flags, mode_t mode, Error **errp);
503 int qemu_close(int fd);
504 int qemu_unlink(const char *name);
505 #ifndef _WIN32
506 int qemu_dup_flags(int fd, int flags);
507 int qemu_dup(int fd);
508 int qemu_lock_fd(int fd, int64_t start, int64_t len, bool exclusive);
509 int qemu_unlock_fd(int fd, int64_t start, int64_t len);
510 int qemu_lock_fd_test(int fd, int64_t start, int64_t len, bool exclusive);
511 bool qemu_has_ofd_lock(void);
512 #endif
513 
514 #if defined(__HAIKU__) && defined(__i386__)
515 #define FMT_pid "%ld"
516 #elif defined(WIN64)
517 #define FMT_pid "%" PRId64
518 #else
519 #define FMT_pid "%d"
520 #endif
521 
522 bool qemu_write_pidfile(const char *pidfile, Error **errp);
523 
524 int qemu_get_thread_id(void);
525 
526 #ifndef CONFIG_IOVEC
527 struct iovec {
528     void *iov_base;
529     size_t iov_len;
530 };
531 /*
532  * Use the same value as Linux for now.
533  */
534 #define IOV_MAX 1024
535 
536 ssize_t readv(int fd, const struct iovec *iov, int iov_cnt);
537 ssize_t writev(int fd, const struct iovec *iov, int iov_cnt);
538 #else
539 #include <sys/uio.h>
540 #endif
541 
542 #ifdef _WIN32
543 static inline void qemu_timersub(const struct timeval *val1,
544                                  const struct timeval *val2,
545                                  struct timeval *res)
546 {
547     res->tv_sec = val1->tv_sec - val2->tv_sec;
548     if (val1->tv_usec < val2->tv_usec) {
549         res->tv_sec--;
550         res->tv_usec = val1->tv_usec - val2->tv_usec + 1000 * 1000;
551     } else {
552         res->tv_usec = val1->tv_usec - val2->tv_usec;
553     }
554 }
555 #else
556 #define qemu_timersub timersub
557 #endif
558 
559 void qemu_set_cloexec(int fd);
560 
561 /* Starting on QEMU 2.5, qemu_hw_version() returns "2.5+" by default
562  * instead of QEMU_VERSION, so setting hw_version on MachineClass
563  * is no longer mandatory.
564  *
565  * Do NOT change this string, or it will break compatibility on all
566  * machine classes that don't set hw_version.
567  */
568 #define QEMU_HW_VERSION "2.5+"
569 
570 /* QEMU "hardware version" setting. Used to replace code that exposed
571  * QEMU_VERSION to guests in the past and need to keep compatibility.
572  * Do not use qemu_hw_version() in new code.
573  */
574 void qemu_set_hw_version(const char *);
575 const char *qemu_hw_version(void);
576 
577 void fips_set_state(bool requested);
578 bool fips_get_state(void);
579 
580 /* Return a dynamically allocated pathname denoting a file or directory that is
581  * appropriate for storing local state.
582  *
583  * @relative_pathname need not start with a directory separator; one will be
584  * added automatically.
585  *
586  * The caller is responsible for releasing the value returned with g_free()
587  * after use.
588  */
589 char *qemu_get_local_state_pathname(const char *relative_pathname);
590 
591 /* Find program directory, and save it for later usage with
592  * qemu_get_exec_dir().
593  * Try OS specific API first, if not working, parse from argv0. */
594 void qemu_init_exec_dir(const char *argv0);
595 
596 /* Get the saved exec dir.  */
597 const char *qemu_get_exec_dir(void);
598 
599 /**
600  * qemu_getauxval:
601  * @type: the auxiliary vector key to lookup
602  *
603  * Search the auxiliary vector for @type, returning the value
604  * or 0 if @type is not present.
605  */
606 unsigned long qemu_getauxval(unsigned long type);
607 
608 void qemu_set_tty_echo(int fd, bool echo);
609 
610 void os_mem_prealloc(int fd, char *area, size_t sz, int smp_cpus,
611                      Error **errp);
612 
613 /**
614  * qemu_get_pid_name:
615  * @pid: pid of a process
616  *
617  * For given @pid fetch its name. Caller is responsible for
618  * freeing the string when no longer needed.
619  * Returns allocated string on success, NULL on failure.
620  */
621 char *qemu_get_pid_name(pid_t pid);
622 
623 /**
624  * qemu_fork:
625  *
626  * A version of fork that avoids signal handler race
627  * conditions that can lead to child process getting
628  * signals that are otherwise only expected by the
629  * parent. It also resets all signal handlers to the
630  * default settings.
631  *
632  * Returns 0 to child process, pid number to parent
633  * or -1 on failure.
634  */
635 pid_t qemu_fork(Error **errp);
636 
637 /* Using intptr_t ensures that qemu_*_page_mask is sign-extended even
638  * when intptr_t is 32-bit and we are aligning a long long.
639  */
640 extern uintptr_t qemu_real_host_page_size;
641 extern intptr_t qemu_real_host_page_mask;
642 
643 extern int qemu_icache_linesize;
644 extern int qemu_icache_linesize_log;
645 extern int qemu_dcache_linesize;
646 extern int qemu_dcache_linesize_log;
647 
648 /*
649  * After using getopt or getopt_long, if you need to parse another set
650  * of options, then you must reset optind.  Unfortunately the way to
651  * do this varies between implementations of getopt.
652  */
653 static inline void qemu_reset_optind(void)
654 {
655 #ifdef HAVE_OPTRESET
656     optind = 1;
657     optreset = 1;
658 #else
659     optind = 0;
660 #endif
661 }
662 
663 /**
664  * qemu_get_host_name:
665  * @errp: Error object
666  *
667  * Operating system agnostic way of querying host name.
668  *
669  * Returns allocated hostname (caller should free), NULL on failure.
670  */
671 char *qemu_get_host_name(Error **errp);
672 
673 /**
674  * qemu_get_host_physmem:
675  *
676  * Operating system agnostic way of querying host memory.
677  *
678  * Returns amount of physical memory on the system. This is purely
679  * advisery and may return 0 if we can't work it out. At the other
680  * end we saturate to SIZE_MAX if you are lucky enough to have that
681  * much memory.
682  */
683 size_t qemu_get_host_physmem(void);
684 
685 #endif
686