]>
Commit | Line | Data |
---|---|---|
faf07963 PB |
1 | /* Common header file that is included by all of qemu. */ |
2 | #ifndef QEMU_COMMON_H | |
3 | #define QEMU_COMMON_H | |
4 | ||
beb6f0de KW |
5 | #include "config-host.h" |
6 | ||
a5e50b26 | 7 | #define QEMU_NORETURN __attribute__ ((__noreturn__)) |
747bbdf7 BS |
8 | #ifdef CONFIG_GCC_ATTRIBUTE_WARN_UNUSED_RESULT |
9 | #define QEMU_WARN_UNUSED_RESULT __attribute__((warn_unused_result)) | |
10 | #else | |
11 | #define QEMU_WARN_UNUSED_RESULT | |
12 | #endif | |
7d99a001 | 13 | |
24ebf5f3 | 14 | #define QEMU_BUILD_BUG_ON(x) typedef char __build_bug_on__##__LINE__[(x)?-1:1]; |
082b5557 | 15 | #define TFR(expr) do { if ((expr) != -1) break; } while (errno == EINTR) |
24ebf5f3 | 16 | |
29e922b6 BS |
17 | typedef struct QEMUTimer QEMUTimer; |
18 | typedef struct QEMUFile QEMUFile; | |
19 | typedef struct QEMUBH QEMUBH; | |
92a16d7a | 20 | typedef struct DeviceState DeviceState; |
29e922b6 | 21 | |
316378e4 JK |
22 | struct Monitor; |
23 | typedef struct Monitor Monitor; | |
24 | ||
faf07963 PB |
25 | /* we put basic includes here to avoid repeating them in device drivers */ |
26 | #include <stdlib.h> | |
27 | #include <stdio.h> | |
28 | #include <stdarg.h> | |
11165820 | 29 | #include <stdbool.h> |
faf07963 | 30 | #include <string.h> |
c8906845 | 31 | #include <strings.h> |
faf07963 PB |
32 | #include <inttypes.h> |
33 | #include <limits.h> | |
34 | #include <time.h> | |
35 | #include <ctype.h> | |
36 | #include <errno.h> | |
37 | #include <unistd.h> | |
38 | #include <fcntl.h> | |
39 | #include <sys/stat.h> | |
dcfd0865 | 40 | #include <sys/time.h> |
55616505 | 41 | #include <assert.h> |
faf07963 | 42 | |
082b5557 BS |
43 | #ifdef _WIN32 |
44 | #include "qemu-os-win32.h" | |
45 | #endif | |
46 | ||
47 | #ifdef CONFIG_POSIX | |
48 | #include "qemu-os-posix.h" | |
49 | #endif | |
50 | ||
faf07963 PB |
51 | #ifndef O_LARGEFILE |
52 | #define O_LARGEFILE 0 | |
53 | #endif | |
54 | #ifndef O_BINARY | |
55 | #define O_BINARY 0 | |
56 | #endif | |
0e74e66b JQ |
57 | #ifndef MAP_ANONYMOUS |
58 | #define MAP_ANONYMOUS MAP_ANON | |
59 | #endif | |
faf07963 PB |
60 | #ifndef ENOMEDIUM |
61 | #define ENOMEDIUM ENODEV | |
62 | #endif | |
4c955388 | 63 | #if !defined(ENOTSUP) |
2880bc32 JQ |
64 | #define ENOTSUP 4096 |
65 | #endif | |
3c9405a0 GH |
66 | #ifndef TIME_MAX |
67 | #define TIME_MAX LONG_MAX | |
68 | #endif | |
faf07963 | 69 | |
6114fdb0 JQ |
70 | #ifndef CONFIG_IOVEC |
71 | #define CONFIG_IOVEC | |
bf9298b9 AL |
72 | struct iovec { |
73 | void *iov_base; | |
74 | size_t iov_len; | |
75 | }; | |
e2a305fb CH |
76 | /* |
77 | * Use the same value as Linux for now. | |
78 | */ | |
79 | #define IOV_MAX 1024 | |
331dadde BS |
80 | #else |
81 | #include <sys/uio.h> | |
bf9298b9 AL |
82 | #endif |
83 | ||
9c9e7d51 SW |
84 | #if defined __GNUC__ |
85 | # if (__GNUC__ < 4) || \ | |
86 | defined(__GNUC_MINOR__) && (__GNUC__ == 4) && (__GNUC_MINOR__ < 4) | |
87 | /* gcc versions before 4.4.x don't support gnu_printf, so use printf. */ | |
88 | # define GCC_ATTR __attribute__((__unused__, format(printf, 1, 2))) | |
89 | # define GCC_FMT_ATTR(n, m) __attribute__((format(printf, n, m))) | |
90 | # else | |
91 | /* Use gnu_printf when supported (qemu uses standard format strings). */ | |
92 | # define GCC_ATTR __attribute__((__unused__, format(gnu_printf, 1, 2))) | |
93 | # define GCC_FMT_ATTR(n, m) __attribute__((format(gnu_printf, n, m))) | |
94 | # endif | |
95 | #else | |
96 | #define GCC_ATTR /**/ | |
97 | #define GCC_FMT_ATTR(n, m) | |
98 | #endif | |
99 | ||
f868445a SW |
100 | typedef int (*fprintf_function)(FILE *f, const char *fmt, ...) |
101 | GCC_FMT_ATTR(2, 3); | |
102 | ||
faf07963 | 103 | #ifdef _WIN32 |
faf07963 PB |
104 | #define fsync _commit |
105 | #define lseek _lseeki64 | |
64b85a8f | 106 | int qemu_ftruncate64(int, int64_t); |
faf07963 PB |
107 | #define ftruncate qemu_ftruncate64 |
108 | ||
faf07963 PB |
109 | static inline char *realpath(const char *path, char *resolved_path) |
110 | { | |
111 | _fullpath(resolved_path, path, _MAX_PATH); | |
112 | return resolved_path; | |
113 | } | |
114 | ||
115 | #define PRId64 "I64d" | |
116 | #define PRIx64 "I64x" | |
117 | #define PRIu64 "I64u" | |
118 | #define PRIo64 "I64o" | |
119 | #endif | |
120 | ||
121 | /* FIXME: Remove NEED_CPU_H. */ | |
122 | #ifndef NEED_CPU_H | |
123 | ||
faf07963 PB |
124 | #include <setjmp.h> |
125 | #include "osdep.h" | |
126 | #include "bswap.h" | |
127 | ||
128 | #else | |
129 | ||
130 | #include "cpu.h" | |
131 | ||
132 | #endif /* !defined(NEED_CPU_H) */ | |
133 | ||
134 | /* bottom halves */ | |
faf07963 PB |
135 | typedef void QEMUBHFunc(void *opaque); |
136 | ||
9a1e9481 KW |
137 | void async_context_push(void); |
138 | void async_context_pop(void); | |
139 | int get_async_context_id(void); | |
140 | ||
faf07963 PB |
141 | QEMUBH *qemu_bh_new(QEMUBHFunc *cb, void *opaque); |
142 | void qemu_bh_schedule(QEMUBH *bh); | |
80d3580b AL |
143 | /* Bottom halfs that are scheduled from a bottom half handler are instantly |
144 | * invoked. This can create an infinite loop if a bottom half handler | |
145 | * schedules itself. qemu_bh_schedule_idle() avoids this infinite loop by | |
146 | * ensuring that the bottom half isn't executed until the next main loop | |
147 | * iteration. | |
148 | */ | |
1b435b10 | 149 | void qemu_bh_schedule_idle(QEMUBH *bh); |
faf07963 PB |
150 | void qemu_bh_cancel(QEMUBH *bh); |
151 | void qemu_bh_delete(QEMUBH *bh); | |
152 | int qemu_bh_poll(void); | |
4f999d05 | 153 | void qemu_bh_update_timeout(int *timeout); |
faf07963 | 154 | |
f6503059 AZ |
155 | void qemu_get_timedate(struct tm *tm, int offset); |
156 | int qemu_timedate_diff(struct tm *tm); | |
157 | ||
faf07963 PB |
158 | /* cutils.c */ |
159 | void pstrcpy(char *buf, int buf_size, const char *str); | |
160 | char *pstrcat(char *buf, int buf_size, const char *s); | |
161 | int strstart(const char *str, const char *val, const char **ptr); | |
162 | int stristart(const char *str, const char *val, const char **ptr); | |
d43277c5 | 163 | int qemu_strnlen(const char *s, int max_len); |
faf07963 | 164 | time_t mktimegm(struct tm *tm); |
ad46db9a | 165 | int qemu_fls(int i); |
6f1953c4 | 166 | int qemu_fdatasync(int fd); |
db1a4972 | 167 | int fcntl_setfl(int fd, int flag); |
d8427002 | 168 | |
d7142456 JS |
169 | /* |
170 | * strtosz() suffixes used to specify the default treatment of an | |
171 | * argument passed to strtosz() without an explicit suffix. | |
172 | * These should be defined using upper case characters in the range | |
173 | * A-Z, as strtosz() will use qemu_toupper() on the given argument | |
174 | * prior to comparison. | |
175 | */ | |
d8427002 JS |
176 | #define STRTOSZ_DEFSUFFIX_TB 'T' |
177 | #define STRTOSZ_DEFSUFFIX_GB 'G' | |
178 | #define STRTOSZ_DEFSUFFIX_MB 'M' | |
179 | #define STRTOSZ_DEFSUFFIX_KB 'K' | |
180 | #define STRTOSZ_DEFSUFFIX_B 'B' | |
70b4f4bb JS |
181 | int64_t strtosz(const char *nptr, char **end); |
182 | int64_t strtosz_suffix(const char *nptr, char **end, const char default_suffix); | |
faf07963 | 183 | |
37022086 BS |
184 | /* path.c */ |
185 | void init_paths(const char *prefix); | |
186 | const char *path(const char *pathname); | |
187 | ||
cd390083 BS |
188 | #define qemu_isalnum(c) isalnum((unsigned char)(c)) |
189 | #define qemu_isalpha(c) isalpha((unsigned char)(c)) | |
190 | #define qemu_iscntrl(c) iscntrl((unsigned char)(c)) | |
191 | #define qemu_isdigit(c) isdigit((unsigned char)(c)) | |
192 | #define qemu_isgraph(c) isgraph((unsigned char)(c)) | |
193 | #define qemu_islower(c) islower((unsigned char)(c)) | |
194 | #define qemu_isprint(c) isprint((unsigned char)(c)) | |
195 | #define qemu_ispunct(c) ispunct((unsigned char)(c)) | |
196 | #define qemu_isspace(c) isspace((unsigned char)(c)) | |
197 | #define qemu_isupper(c) isupper((unsigned char)(c)) | |
198 | #define qemu_isxdigit(c) isxdigit((unsigned char)(c)) | |
199 | #define qemu_tolower(c) tolower((unsigned char)(c)) | |
200 | #define qemu_toupper(c) toupper((unsigned char)(c)) | |
201 | #define qemu_isascii(c) isascii((unsigned char)(c)) | |
202 | #define qemu_toascii(c) toascii((unsigned char)(c)) | |
203 | ||
dc786bc9 JS |
204 | #ifdef _WIN32 |
205 | /* ffs() in oslib-win32.c for WIN32, strings.h for the rest of the world */ | |
206 | int ffs(int i); | |
207 | #endif | |
208 | ||
b152aa84 | 209 | void *qemu_oom_check(void *ptr); |
ca10f867 | 210 | void *qemu_malloc(size_t size); |
2137b4cc | 211 | void *qemu_realloc(void *ptr, size_t size); |
ca10f867 AJ |
212 | void *qemu_mallocz(size_t size); |
213 | void qemu_free(void *ptr); | |
214 | char *qemu_strdup(const char *str); | |
ac4b0d0c | 215 | char *qemu_strndup(const char *str, size_t size); |
ca10f867 | 216 | |
d549db5a GC |
217 | void qemu_mutex_lock_iothread(void); |
218 | void qemu_mutex_unlock_iothread(void); | |
219 | ||
40ff6d7e | 220 | int qemu_open(const char *name, int flags, ...); |
7c7c0629 JQ |
221 | ssize_t qemu_write_full(int fd, const void *buf, size_t count) |
222 | QEMU_WARN_UNUSED_RESULT; | |
40ff6d7e KW |
223 | void qemu_set_cloexec(int fd); |
224 | ||
225 | #ifndef _WIN32 | |
4d54ec78 | 226 | int qemu_add_child_watch(pid_t pid); |
f3dfda61 | 227 | int qemu_eventfd(int pipefd[2]); |
40ff6d7e KW |
228 | int qemu_pipe(int pipefd[2]); |
229 | #endif | |
230 | ||
87ecb68b PB |
231 | /* Error handling. */ |
232 | ||
e5924d89 | 233 | void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2); |
87ecb68b PB |
234 | |
235 | /* IO callbacks. */ | |
236 | typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size); | |
7b27a769 | 237 | typedef int IOCanReadHandler(void *opaque); |
87ecb68b PB |
238 | typedef void IOHandler(void *opaque); |
239 | ||
02981419 PB |
240 | void qemu_iohandler_fill(int *pnfds, fd_set *readfds, fd_set *writefds, fd_set *xfds); |
241 | void qemu_iohandler_poll(fd_set *readfds, fd_set *writefds, fd_set *xfds, int rc); | |
242 | ||
87ecb68b PB |
243 | struct ParallelIOArg { |
244 | void *buffer; | |
245 | int count; | |
246 | }; | |
247 | ||
248 | typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size); | |
249 | ||
250 | /* A load of opaque types so that device init declarations don't have to | |
251 | pull in all the real definitions. */ | |
252 | typedef struct NICInfo NICInfo; | |
1ae26a18 | 253 | typedef struct HCIInfo HCIInfo; |
87ecb68b PB |
254 | typedef struct AudioState AudioState; |
255 | typedef struct BlockDriverState BlockDriverState; | |
2446333c | 256 | typedef struct DriveInfo DriveInfo; |
87ecb68b | 257 | typedef struct DisplayState DisplayState; |
7d957bd8 AL |
258 | typedef struct DisplayChangeListener DisplayChangeListener; |
259 | typedef struct DisplaySurface DisplaySurface; | |
7b5d76da | 260 | typedef struct DisplayAllocator DisplayAllocator; |
7d957bd8 | 261 | typedef struct PixelFormat PixelFormat; |
87ecb68b | 262 | typedef struct TextConsole TextConsole; |
c60e08d9 | 263 | typedef TextConsole QEMUConsole; |
87ecb68b | 264 | typedef struct CharDriverState CharDriverState; |
76d32cba | 265 | typedef struct MACAddr MACAddr; |
87ecb68b | 266 | typedef struct VLANState VLANState; |
f7105843 | 267 | typedef struct VLANClientState VLANClientState; |
87ecb68b PB |
268 | typedef struct i2c_bus i2c_bus; |
269 | typedef struct i2c_slave i2c_slave; | |
270 | typedef struct SMBusDevice SMBusDevice; | |
fb47a2e9 IY |
271 | typedef struct PCIHostState PCIHostState; |
272 | typedef struct PCIExpressHost PCIExpressHost; | |
87ecb68b PB |
273 | typedef struct PCIBus PCIBus; |
274 | typedef struct PCIDevice PCIDevice; | |
0428527c | 275 | typedef struct PCIExpressDevice PCIExpressDevice; |
68f79994 | 276 | typedef struct PCIBridge PCIBridge; |
34e65944 IY |
277 | typedef struct PCIEAERMsg PCIEAERMsg; |
278 | typedef struct PCIEAERLog PCIEAERLog; | |
279 | typedef struct PCIEAERErr PCIEAERErr; | |
bc20ba98 IY |
280 | typedef struct PCIEPort PCIEPort; |
281 | typedef struct PCIESlot PCIESlot; | |
87ecb68b PB |
282 | typedef struct SerialState SerialState; |
283 | typedef struct IRQState *qemu_irq; | |
bc24a225 PB |
284 | typedef struct PCMCIACardState PCMCIACardState; |
285 | typedef struct MouseTransformInfo MouseTransformInfo; | |
286 | typedef struct uWireSlave uWireSlave; | |
287 | typedef struct I2SCodec I2SCodec; | |
90d37239 | 288 | typedef struct SSIBus SSIBus; |
2292b339 | 289 | typedef struct EventNotifier EventNotifier; |
2be24aaa | 290 | typedef struct VirtIODevice VirtIODevice; |
87ecb68b | 291 | |
186993ee MT |
292 | typedef uint64_t pcibus_t; |
293 | ||
d2053c3c BS |
294 | void cpu_exec_init_all(unsigned long tb_size); |
295 | ||
b3c7724c PB |
296 | /* CPU save/load. */ |
297 | void cpu_save(QEMUFile *f, void *opaque); | |
298 | int cpu_load(QEMUFile *f, void *opaque, int version_id); | |
299 | ||
9e472e10 AL |
300 | /* Force QEMU to stop what it's doing and service IO */ |
301 | void qemu_service_io(void); | |
302 | ||
d9f75a4e AL |
303 | /* Force QEMU to process pending events */ |
304 | void qemu_notify_event(void); | |
305 | ||
8edac960 AL |
306 | /* Unblock cpu */ |
307 | void qemu_cpu_kick(void *env); | |
46d62fac | 308 | void qemu_cpu_kick_self(void); |
b7680cb6 | 309 | int qemu_cpu_is_self(void *env); |
ab33fcda | 310 | bool all_cpu_threads_idle(void); |
8edac960 | 311 | |
e82bcec2 MT |
312 | /* work queue */ |
313 | struct qemu_work_item { | |
314 | struct qemu_work_item *next; | |
315 | void (*func)(void *data); | |
316 | void *data; | |
317 | int done; | |
318 | }; | |
319 | ||
0bf46a40 AL |
320 | #ifdef CONFIG_USER_ONLY |
321 | #define qemu_init_vcpu(env) do { } while (0) | |
322 | #else | |
323 | void qemu_init_vcpu(void *env); | |
324 | #endif | |
325 | ||
44e3ee8a AL |
326 | typedef struct QEMUIOVector { |
327 | struct iovec *iov; | |
328 | int niov; | |
329 | int nalloc; | |
249aa745 | 330 | size_t size; |
44e3ee8a AL |
331 | } QEMUIOVector; |
332 | ||
333 | void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint); | |
522584a5 | 334 | void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov); |
44e3ee8a | 335 | void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len); |
b8a83a4f KW |
336 | void qemu_iovec_copy(QEMUIOVector *dst, QEMUIOVector *src, uint64_t skip, |
337 | size_t size); | |
40b4f539 | 338 | void qemu_iovec_concat(QEMUIOVector *dst, QEMUIOVector *src, size_t size); |
44e3ee8a | 339 | void qemu_iovec_destroy(QEMUIOVector *qiov); |
be959463 | 340 | void qemu_iovec_reset(QEMUIOVector *qiov); |
44e3ee8a | 341 | void qemu_iovec_to_buffer(QEMUIOVector *qiov, void *buf); |
249aa745 | 342 | void qemu_iovec_from_buffer(QEMUIOVector *qiov, const void *buf, size_t count); |
b8a83a4f | 343 | void qemu_iovec_memset(QEMUIOVector *qiov, int c, size_t count); |
e0d9c6f9 CT |
344 | void qemu_iovec_memset_skip(QEMUIOVector *qiov, int c, size_t count, |
345 | size_t skip); | |
44e3ee8a | 346 | |
6b837bc4 JS |
347 | void qemu_progress_init(int enabled, float min_skip); |
348 | void qemu_progress_end(void); | |
349 | void qemu_progress_print(float percent, int max); | |
350 | ||
082b5557 BS |
351 | #define QEMU_FILE_TYPE_BIOS 0 |
352 | #define QEMU_FILE_TYPE_KEYMAP 1 | |
353 | char *qemu_find_file(int type, const char *name); | |
354 | ||
355 | /* OS specific functions */ | |
356 | void os_setup_early_signal_handling(void); | |
357 | char *os_find_datadir(const char *argv0); | |
358 | void os_parse_cmd_args(int index, const char *optarg); | |
359 | void os_pidfile_error(void); | |
360 | ||
abd0c6bd PB |
361 | /* Convert a byte between binary and BCD. */ |
362 | static inline uint8_t to_bcd(uint8_t val) | |
363 | { | |
364 | return ((val / 10) << 4) | (val % 10); | |
365 | } | |
366 | ||
367 | static inline uint8_t from_bcd(uint8_t val) | |
368 | { | |
369 | return ((val >> 4) * 10) + (val & 0x0f); | |
370 | } | |
371 | ||
338b922e | 372 | /* compute with 96 bit intermediate result: (a*b)/c */ |
373 | static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c) | |
374 | { | |
375 | union { | |
376 | uint64_t ll; | |
377 | struct { | |
378 | #ifdef HOST_WORDS_BIGENDIAN | |
379 | uint32_t high, low; | |
380 | #else | |
381 | uint32_t low, high; | |
382 | #endif | |
383 | } l; | |
384 | } u, res; | |
385 | uint64_t rl, rh; | |
386 | ||
387 | u.ll = a; | |
388 | rl = (uint64_t)u.l.low * (uint64_t)b; | |
389 | rh = (uint64_t)u.l.high * (uint64_t)b; | |
390 | rh += (rl >> 32); | |
391 | res.l.high = rh / c; | |
392 | res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c; | |
393 | return res.ll; | |
394 | } | |
395 | ||
0bfe3ca5 AL |
396 | #include "module.h" |
397 | ||
faf07963 | 398 | #endif |