xref: /qemu/include/qemu/osdep.h (revision d072cdf3)
1 #ifndef QEMU_OSDEP_H
2 #define QEMU_OSDEP_H
3 
4 #include "config-host.h"
5 #include <stdarg.h>
6 #include <stddef.h>
7 #include <stdbool.h>
8 #include <sys/types.h>
9 #ifdef __OpenBSD__
10 #include <sys/signal.h>
11 #endif
12 
13 #ifndef _WIN32
14 #include <sys/wait.h>
15 #else
16 #define WIFEXITED(x)   1
17 #define WEXITSTATUS(x) (x)
18 #endif
19 
20 #include <sys/time.h>
21 
22 #if defined(CONFIG_SOLARIS) && CONFIG_SOLARIS_VERSION < 10
23 /* [u]int_fast*_t not in <sys/int_types.h> */
24 typedef unsigned char           uint_fast8_t;
25 typedef unsigned int            uint_fast16_t;
26 typedef signed int              int_fast16_t;
27 #endif
28 
29 #ifndef glue
30 #define xglue(x, y) x ## y
31 #define glue(x, y) xglue(x, y)
32 #define stringify(s)	tostring(s)
33 #define tostring(s)	#s
34 #endif
35 
36 #ifndef likely
37 #if __GNUC__ < 3
38 #define __builtin_expect(x, n) (x)
39 #endif
40 
41 #define likely(x)   __builtin_expect(!!(x), 1)
42 #define unlikely(x)   __builtin_expect(!!(x), 0)
43 #endif
44 
45 #ifndef container_of
46 #define container_of(ptr, type, member) ({                      \
47         const typeof(((type *) 0)->member) *__mptr = (ptr);     \
48         (type *) ((char *) __mptr - offsetof(type, member));})
49 #endif
50 
51 /* Convert from a base type to a parent type, with compile time checking.  */
52 #ifdef __GNUC__
53 #define DO_UPCAST(type, field, dev) ( __extension__ ( { \
54     char __attribute__((unused)) offset_must_be_zero[ \
55         -offsetof(type, field)]; \
56     container_of(dev, type, field);}))
57 #else
58 #define DO_UPCAST(type, field, dev) container_of(dev, type, field)
59 #endif
60 
61 #define typeof_field(type, field) typeof(((type *)0)->field)
62 #define type_check(t1,t2) ((t1*)0 - (t2*)0)
63 
64 #ifndef MIN
65 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
66 #endif
67 #ifndef MAX
68 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
69 #endif
70 
71 #ifndef ROUND_UP
72 #define ROUND_UP(n,d) (((n) + (d) - 1) & -(d))
73 #endif
74 
75 #ifndef DIV_ROUND_UP
76 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
77 #endif
78 
79 #ifndef ARRAY_SIZE
80 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
81 #endif
82 
83 #ifndef always_inline
84 #if !((__GNUC__ < 3) || defined(__APPLE__))
85 #ifdef __OPTIMIZE__
86 #undef inline
87 #define inline __attribute__ (( always_inline )) __inline__
88 #endif
89 #endif
90 #else
91 #undef inline
92 #define inline always_inline
93 #endif
94 
95 #define qemu_printf printf
96 
97 int qemu_daemon(int nochdir, int noclose);
98 void *qemu_try_memalign(size_t alignment, size_t size);
99 void *qemu_memalign(size_t alignment, size_t size);
100 void *qemu_anon_ram_alloc(size_t size);
101 void qemu_vfree(void *ptr);
102 void qemu_anon_ram_free(void *ptr, size_t size);
103 
104 #define QEMU_MADV_INVALID -1
105 
106 #if defined(CONFIG_MADVISE)
107 
108 #define QEMU_MADV_WILLNEED  MADV_WILLNEED
109 #define QEMU_MADV_DONTNEED  MADV_DONTNEED
110 #ifdef MADV_DONTFORK
111 #define QEMU_MADV_DONTFORK  MADV_DONTFORK
112 #else
113 #define QEMU_MADV_DONTFORK  QEMU_MADV_INVALID
114 #endif
115 #ifdef MADV_MERGEABLE
116 #define QEMU_MADV_MERGEABLE MADV_MERGEABLE
117 #else
118 #define QEMU_MADV_MERGEABLE QEMU_MADV_INVALID
119 #endif
120 #ifdef MADV_UNMERGEABLE
121 #define QEMU_MADV_UNMERGEABLE MADV_UNMERGEABLE
122 #else
123 #define QEMU_MADV_UNMERGEABLE QEMU_MADV_INVALID
124 #endif
125 #ifdef MADV_DODUMP
126 #define QEMU_MADV_DODUMP MADV_DODUMP
127 #else
128 #define QEMU_MADV_DODUMP QEMU_MADV_INVALID
129 #endif
130 #ifdef MADV_DONTDUMP
131 #define QEMU_MADV_DONTDUMP MADV_DONTDUMP
132 #else
133 #define QEMU_MADV_DONTDUMP QEMU_MADV_INVALID
134 #endif
135 #ifdef MADV_HUGEPAGE
136 #define QEMU_MADV_HUGEPAGE MADV_HUGEPAGE
137 #else
138 #define QEMU_MADV_HUGEPAGE QEMU_MADV_INVALID
139 #endif
140 
141 #elif defined(CONFIG_POSIX_MADVISE)
142 
143 #define QEMU_MADV_WILLNEED  POSIX_MADV_WILLNEED
144 #define QEMU_MADV_DONTNEED  POSIX_MADV_DONTNEED
145 #define QEMU_MADV_DONTFORK  QEMU_MADV_INVALID
146 #define QEMU_MADV_MERGEABLE QEMU_MADV_INVALID
147 #define QEMU_MADV_UNMERGEABLE QEMU_MADV_INVALID
148 #define QEMU_MADV_DODUMP QEMU_MADV_INVALID
149 #define QEMU_MADV_DONTDUMP QEMU_MADV_INVALID
150 #define QEMU_MADV_HUGEPAGE  QEMU_MADV_INVALID
151 
152 #else /* no-op */
153 
154 #define QEMU_MADV_WILLNEED  QEMU_MADV_INVALID
155 #define QEMU_MADV_DONTNEED  QEMU_MADV_INVALID
156 #define QEMU_MADV_DONTFORK  QEMU_MADV_INVALID
157 #define QEMU_MADV_MERGEABLE QEMU_MADV_INVALID
158 #define QEMU_MADV_UNMERGEABLE QEMU_MADV_INVALID
159 #define QEMU_MADV_DODUMP QEMU_MADV_INVALID
160 #define QEMU_MADV_DONTDUMP QEMU_MADV_INVALID
161 #define QEMU_MADV_HUGEPAGE  QEMU_MADV_INVALID
162 
163 #endif
164 
165 int qemu_madvise(void *addr, size_t len, int advice);
166 
167 int qemu_open(const char *name, int flags, ...);
168 int qemu_close(int fd);
169 
170 #if defined(__HAIKU__) && defined(__i386__)
171 #define FMT_pid "%ld"
172 #elif defined(WIN64)
173 #define FMT_pid "%" PRId64
174 #else
175 #define FMT_pid "%d"
176 #endif
177 
178 int qemu_create_pidfile(const char *filename);
179 int qemu_get_thread_id(void);
180 
181 #ifndef CONFIG_IOVEC
182 struct iovec {
183     void *iov_base;
184     size_t iov_len;
185 };
186 /*
187  * Use the same value as Linux for now.
188  */
189 #define IOV_MAX 1024
190 
191 ssize_t readv(int fd, const struct iovec *iov, int iov_cnt);
192 ssize_t writev(int fd, const struct iovec *iov, int iov_cnt);
193 #else
194 #include <sys/uio.h>
195 #endif
196 
197 #ifdef _WIN32
198 static inline void qemu_timersub(const struct timeval *val1,
199                                  const struct timeval *val2,
200                                  struct timeval *res)
201 {
202     res->tv_sec = val1->tv_sec - val2->tv_sec;
203     if (val1->tv_usec < val2->tv_usec) {
204         res->tv_sec--;
205         res->tv_usec = val1->tv_usec - val2->tv_usec + 1000 * 1000;
206     } else {
207         res->tv_usec = val1->tv_usec - val2->tv_usec;
208     }
209 }
210 #else
211 #define qemu_timersub timersub
212 #endif
213 
214 void qemu_set_cloexec(int fd);
215 
216 void qemu_set_version(const char *);
217 const char *qemu_get_version(void);
218 
219 void fips_set_state(bool requested);
220 bool fips_get_state(void);
221 
222 /* Return a dynamically allocated pathname denoting a file or directory that is
223  * appropriate for storing local state.
224  *
225  * @relative_pathname need not start with a directory separator; one will be
226  * added automatically.
227  *
228  * The caller is responsible for releasing the value returned with g_free()
229  * after use.
230  */
231 char *qemu_get_local_state_pathname(const char *relative_pathname);
232 
233 /* Find program directory, and save it for later usage with
234  * qemu_get_exec_dir().
235  * Try OS specific API first, if not working, parse from argv0. */
236 void qemu_init_exec_dir(const char *argv0);
237 
238 /* Get the saved exec dir.
239  * Caller needs to release the returned string by g_free() */
240 char *qemu_get_exec_dir(void);
241 
242 /**
243  * qemu_getauxval:
244  * @type: the auxiliary vector key to lookup
245  *
246  * Search the auxiliary vector for @type, returning the value
247  * or 0 if @type is not present.
248  */
249 #if defined(CONFIG_GETAUXVAL) || defined(__linux__)
250 unsigned long qemu_getauxval(unsigned long type);
251 #else
252 static inline unsigned long qemu_getauxval(unsigned long type) { return 0; }
253 #endif
254 
255 void qemu_set_tty_echo(int fd, bool echo);
256 
257 void os_mem_prealloc(int fd, char *area, size_t sz);
258 
259 #endif
260