]>
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 | ||
5c026320 | 5 | #include "compiler.h" |
beb6f0de KW |
6 | #include "config-host.h" |
7 | ||
332ae28d PB |
8 | #if defined(__arm__) || defined(__sparc__) || defined(__mips__) || defined(__hppa__) || defined(__ia64__) |
9 | #define WORDS_ALIGNED | |
10 | #endif | |
11 | ||
082b5557 | 12 | #define TFR(expr) do { if ((expr) != -1) break; } while (errno == EINTR) |
24ebf5f3 | 13 | |
29e922b6 BS |
14 | typedef struct QEMUTimer QEMUTimer; |
15 | typedef struct QEMUFile QEMUFile; | |
92a16d7a | 16 | typedef struct DeviceState DeviceState; |
29e922b6 | 17 | |
316378e4 JK |
18 | struct Monitor; |
19 | typedef struct Monitor Monitor; | |
6607ae23 | 20 | typedef struct MigrationParams MigrationParams; |
316378e4 | 21 | |
faf07963 PB |
22 | /* we put basic includes here to avoid repeating them in device drivers */ |
23 | #include <stdlib.h> | |
24 | #include <stdio.h> | |
25 | #include <stdarg.h> | |
11165820 | 26 | #include <stdbool.h> |
faf07963 | 27 | #include <string.h> |
c8906845 | 28 | #include <strings.h> |
faf07963 PB |
29 | #include <inttypes.h> |
30 | #include <limits.h> | |
31 | #include <time.h> | |
32 | #include <ctype.h> | |
33 | #include <errno.h> | |
34 | #include <unistd.h> | |
35 | #include <fcntl.h> | |
36 | #include <sys/stat.h> | |
dcfd0865 | 37 | #include <sys/time.h> |
55616505 | 38 | #include <assert.h> |
86f69a92 | 39 | #include <signal.h> |
14015304 | 40 | #include <glib.h> |
faf07963 | 41 | |
082b5557 BS |
42 | #ifdef _WIN32 |
43 | #include "qemu-os-win32.h" | |
44 | #endif | |
45 | ||
46 | #ifdef CONFIG_POSIX | |
47 | #include "qemu-os-posix.h" | |
48 | #endif | |
49 | ||
faf07963 PB |
50 | #ifndef O_LARGEFILE |
51 | #define O_LARGEFILE 0 | |
52 | #endif | |
53 | #ifndef O_BINARY | |
54 | #define O_BINARY 0 | |
55 | #endif | |
0e74e66b JQ |
56 | #ifndef MAP_ANONYMOUS |
57 | #define MAP_ANONYMOUS MAP_ANON | |
58 | #endif | |
faf07963 PB |
59 | #ifndef ENOMEDIUM |
60 | #define ENOMEDIUM ENODEV | |
61 | #endif | |
4c955388 | 62 | #if !defined(ENOTSUP) |
2880bc32 JQ |
63 | #define ENOTSUP 4096 |
64 | #endif | |
2084a8e3 PB |
65 | #if !defined(ECANCELED) |
66 | #define ECANCELED 4097 | |
67 | #endif | |
3c9405a0 GH |
68 | #ifndef TIME_MAX |
69 | #define TIME_MAX LONG_MAX | |
70 | #endif | |
faf07963 | 71 | |
c0fd260e SW |
72 | /* HOST_LONG_BITS is the size of a native pointer in bits. */ |
73 | #if UINTPTR_MAX == UINT32_MAX | |
74 | # define HOST_LONG_BITS 32 | |
75 | #elif UINTPTR_MAX == UINT64_MAX | |
76 | # define HOST_LONG_BITS 64 | |
77 | #else | |
78 | # error Unknown pointer size | |
79 | #endif | |
80 | ||
6114fdb0 JQ |
81 | #ifndef CONFIG_IOVEC |
82 | #define CONFIG_IOVEC | |
bf9298b9 AL |
83 | struct iovec { |
84 | void *iov_base; | |
85 | size_t iov_len; | |
86 | }; | |
e2a305fb CH |
87 | /* |
88 | * Use the same value as Linux for now. | |
89 | */ | |
90 | #define IOV_MAX 1024 | |
331dadde BS |
91 | #else |
92 | #include <sys/uio.h> | |
bf9298b9 AL |
93 | #endif |
94 | ||
f868445a SW |
95 | typedef int (*fprintf_function)(FILE *f, const char *fmt, ...) |
96 | GCC_FMT_ATTR(2, 3); | |
97 | ||
faf07963 | 98 | #ifdef _WIN32 |
faf07963 | 99 | #define fsync _commit |
371c6489 SW |
100 | #if !defined(lseek) |
101 | # define lseek _lseeki64 | |
102 | #endif | |
64b85a8f | 103 | int qemu_ftruncate64(int, int64_t); |
371c6489 SW |
104 | #if !defined(ftruncate) |
105 | # define ftruncate qemu_ftruncate64 | |
106 | #endif | |
faf07963 | 107 | |
faf07963 PB |
108 | static inline char *realpath(const char *path, char *resolved_path) |
109 | { | |
110 | _fullpath(resolved_path, path, _MAX_PATH); | |
111 | return resolved_path; | |
112 | } | |
faf07963 PB |
113 | #endif |
114 | ||
946fb27c PB |
115 | /* icount */ |
116 | void configure_icount(const char *option); | |
117 | extern int use_icount; | |
118 | ||
faf07963 PB |
119 | /* FIXME: Remove NEED_CPU_H. */ |
120 | #ifndef NEED_CPU_H | |
121 | ||
faf07963 PB |
122 | #include "osdep.h" |
123 | #include "bswap.h" | |
124 | ||
125 | #else | |
126 | ||
127 | #include "cpu.h" | |
128 | ||
129 | #endif /* !defined(NEED_CPU_H) */ | |
130 | ||
3bbbee18 AF |
131 | /* main function, renamed */ |
132 | #if defined(CONFIG_COCOA) | |
133 | int qemu_main(int argc, char **argv, char **envp); | |
134 | #endif | |
135 | ||
f6503059 AZ |
136 | void qemu_get_timedate(struct tm *tm, int offset); |
137 | int qemu_timedate_diff(struct tm *tm); | |
138 | ||
c8057f95 PM |
139 | /** |
140 | * is_help_option: | |
141 | * @s: string to test | |
142 | * | |
143 | * Check whether @s is one of the standard strings which indicate | |
144 | * that the user is asking for a list of the valid values for a | |
145 | * command option like -cpu or -M. The current accepted strings | |
146 | * are 'help' and '?'. '?' is deprecated (it is a shell wildcard | |
147 | * which makes it annoying to use in a reliable way) but provided | |
148 | * for backwards compatibility. | |
149 | * | |
150 | * Returns: true if @s is a request for a list. | |
151 | */ | |
152 | static inline bool is_help_option(const char *s) | |
153 | { | |
154 | return !strcmp(s, "?") || !strcmp(s, "help"); | |
155 | } | |
156 | ||
faf07963 PB |
157 | /* cutils.c */ |
158 | void pstrcpy(char *buf, int buf_size, const char *str); | |
2a025ae4 | 159 | void strpadcpy(char *buf, int buf_size, const char *str, char pad); |
faf07963 PB |
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); |
443916d1 | 168 | int qemu_parse_fd(const char *param); |
d8427002 | 169 | |
d7142456 JS |
170 | /* |
171 | * strtosz() suffixes used to specify the default treatment of an | |
172 | * argument passed to strtosz() without an explicit suffix. | |
173 | * These should be defined using upper case characters in the range | |
174 | * A-Z, as strtosz() will use qemu_toupper() on the given argument | |
175 | * prior to comparison. | |
176 | */ | |
d8427002 JS |
177 | #define STRTOSZ_DEFSUFFIX_TB 'T' |
178 | #define STRTOSZ_DEFSUFFIX_GB 'G' | |
179 | #define STRTOSZ_DEFSUFFIX_MB 'M' | |
180 | #define STRTOSZ_DEFSUFFIX_KB 'K' | |
181 | #define STRTOSZ_DEFSUFFIX_B 'B' | |
70b4f4bb JS |
182 | int64_t strtosz(const char *nptr, char **end); |
183 | int64_t strtosz_suffix(const char *nptr, char **end, const char default_suffix); | |
a732e1ba JR |
184 | int64_t strtosz_suffix_unit(const char *nptr, char **end, |
185 | const char default_suffix, int64_t unit); | |
faf07963 | 186 | |
37022086 BS |
187 | /* path.c */ |
188 | void init_paths(const char *prefix); | |
189 | const char *path(const char *pathname); | |
190 | ||
cd390083 BS |
191 | #define qemu_isalnum(c) isalnum((unsigned char)(c)) |
192 | #define qemu_isalpha(c) isalpha((unsigned char)(c)) | |
193 | #define qemu_iscntrl(c) iscntrl((unsigned char)(c)) | |
194 | #define qemu_isdigit(c) isdigit((unsigned char)(c)) | |
195 | #define qemu_isgraph(c) isgraph((unsigned char)(c)) | |
196 | #define qemu_islower(c) islower((unsigned char)(c)) | |
197 | #define qemu_isprint(c) isprint((unsigned char)(c)) | |
198 | #define qemu_ispunct(c) ispunct((unsigned char)(c)) | |
199 | #define qemu_isspace(c) isspace((unsigned char)(c)) | |
200 | #define qemu_isupper(c) isupper((unsigned char)(c)) | |
201 | #define qemu_isxdigit(c) isxdigit((unsigned char)(c)) | |
202 | #define qemu_tolower(c) tolower((unsigned char)(c)) | |
203 | #define qemu_toupper(c) toupper((unsigned char)(c)) | |
204 | #define qemu_isascii(c) isascii((unsigned char)(c)) | |
205 | #define qemu_toascii(c) toascii((unsigned char)(c)) | |
206 | ||
b152aa84 | 207 | void *qemu_oom_check(void *ptr); |
ca10f867 | 208 | |
40ff6d7e | 209 | int qemu_open(const char *name, int flags, ...); |
7c7c0629 JQ |
210 | ssize_t qemu_write_full(int fd, const void *buf, size_t count) |
211 | QEMU_WARN_UNUSED_RESULT; | |
993295fe PB |
212 | ssize_t qemu_send_full(int fd, const void *buf, size_t count, int flags) |
213 | QEMU_WARN_UNUSED_RESULT; | |
8c5135f9 | 214 | ssize_t qemu_recv_full(int fd, void *buf, size_t count, int flags) |
993295fe | 215 | QEMU_WARN_UNUSED_RESULT; |
40ff6d7e KW |
216 | |
217 | #ifndef _WIN32 | |
f3dfda61 | 218 | int qemu_eventfd(int pipefd[2]); |
40ff6d7e KW |
219 | int qemu_pipe(int pipefd[2]); |
220 | #endif | |
221 | ||
00aa0040 BS |
222 | #ifdef _WIN32 |
223 | #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags) | |
224 | #else | |
225 | #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags) | |
226 | #endif | |
227 | ||
87ecb68b PB |
228 | /* Error handling. */ |
229 | ||
e5924d89 | 230 | void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2); |
87ecb68b | 231 | |
87ecb68b PB |
232 | struct ParallelIOArg { |
233 | void *buffer; | |
234 | int count; | |
235 | }; | |
236 | ||
237 | typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size); | |
238 | ||
239 | /* A load of opaque types so that device init declarations don't have to | |
240 | pull in all the real definitions. */ | |
241 | typedef struct NICInfo NICInfo; | |
1ae26a18 | 242 | typedef struct HCIInfo HCIInfo; |
87ecb68b PB |
243 | typedef struct AudioState AudioState; |
244 | typedef struct BlockDriverState BlockDriverState; | |
2446333c | 245 | typedef struct DriveInfo DriveInfo; |
87ecb68b | 246 | typedef struct DisplayState DisplayState; |
7d957bd8 AL |
247 | typedef struct DisplayChangeListener DisplayChangeListener; |
248 | typedef struct DisplaySurface DisplaySurface; | |
7b5d76da | 249 | typedef struct DisplayAllocator DisplayAllocator; |
7d957bd8 | 250 | typedef struct PixelFormat PixelFormat; |
87ecb68b | 251 | typedef struct TextConsole TextConsole; |
c60e08d9 | 252 | typedef TextConsole QEMUConsole; |
87ecb68b | 253 | typedef struct CharDriverState CharDriverState; |
76d32cba | 254 | typedef struct MACAddr MACAddr; |
4e68f7a0 | 255 | typedef struct NetClientState NetClientState; |
87ecb68b | 256 | typedef struct i2c_bus i2c_bus; |
48a18b3c | 257 | typedef struct ISABus ISABus; |
dfc65f1f | 258 | typedef struct ISADevice ISADevice; |
87ecb68b | 259 | typedef struct SMBusDevice SMBusDevice; |
fb47a2e9 IY |
260 | typedef struct PCIHostState PCIHostState; |
261 | typedef struct PCIExpressHost PCIExpressHost; | |
87ecb68b PB |
262 | typedef struct PCIBus PCIBus; |
263 | typedef struct PCIDevice PCIDevice; | |
0428527c | 264 | typedef struct PCIExpressDevice PCIExpressDevice; |
68f79994 | 265 | typedef struct PCIBridge PCIBridge; |
34e65944 IY |
266 | typedef struct PCIEAERMsg PCIEAERMsg; |
267 | typedef struct PCIEAERLog PCIEAERLog; | |
268 | typedef struct PCIEAERErr PCIEAERErr; | |
bc20ba98 IY |
269 | typedef struct PCIEPort PCIEPort; |
270 | typedef struct PCIESlot PCIESlot; | |
14de9bab | 271 | typedef struct MSIMessage MSIMessage; |
87ecb68b PB |
272 | typedef struct SerialState SerialState; |
273 | typedef struct IRQState *qemu_irq; | |
bc24a225 PB |
274 | typedef struct PCMCIACardState PCMCIACardState; |
275 | typedef struct MouseTransformInfo MouseTransformInfo; | |
276 | typedef struct uWireSlave uWireSlave; | |
277 | typedef struct I2SCodec I2SCodec; | |
90d37239 | 278 | typedef struct SSIBus SSIBus; |
2292b339 | 279 | typedef struct EventNotifier EventNotifier; |
2be24aaa | 280 | typedef struct VirtIODevice VirtIODevice; |
d35bf9ad | 281 | typedef struct QEMUSGList QEMUSGList; |
1dc324d2 | 282 | typedef struct SHPCDevice SHPCDevice; |
87ecb68b | 283 | |
186993ee MT |
284 | typedef uint64_t pcibus_t; |
285 | ||
4e4fa398 JK |
286 | typedef enum LostTickPolicy { |
287 | LOST_TICK_DISCARD, | |
288 | LOST_TICK_DELAY, | |
289 | LOST_TICK_MERGE, | |
290 | LOST_TICK_SLEW, | |
1ce05125 | 291 | LOST_TICK_MAX |
4e4fa398 JK |
292 | } LostTickPolicy; |
293 | ||
679042f0 AP |
294 | typedef struct PCIHostDeviceAddress { |
295 | unsigned int domain; | |
296 | unsigned int bus; | |
297 | unsigned int slot; | |
298 | unsigned int function; | |
299 | } PCIHostDeviceAddress; | |
300 | ||
d5ab9713 JK |
301 | void tcg_exec_init(unsigned long tb_size); |
302 | bool tcg_enabled(void); | |
303 | ||
304 | void cpu_exec_init_all(void); | |
d2053c3c | 305 | |
b3c7724c PB |
306 | /* CPU save/load. */ |
307 | void cpu_save(QEMUFile *f, void *opaque); | |
308 | int cpu_load(QEMUFile *f, void *opaque, int version_id); | |
309 | ||
8edac960 AL |
310 | /* Unblock cpu */ |
311 | void qemu_cpu_kick(void *env); | |
46d62fac | 312 | void qemu_cpu_kick_self(void); |
b7680cb6 | 313 | int qemu_cpu_is_self(void *env); |
8edac960 | 314 | |
e82bcec2 MT |
315 | /* work queue */ |
316 | struct qemu_work_item { | |
317 | struct qemu_work_item *next; | |
318 | void (*func)(void *data); | |
319 | void *data; | |
320 | int done; | |
321 | }; | |
322 | ||
0bf46a40 AL |
323 | #ifdef CONFIG_USER_ONLY |
324 | #define qemu_init_vcpu(env) do { } while (0) | |
325 | #else | |
326 | void qemu_init_vcpu(void *env); | |
327 | #endif | |
328 | ||
8c5135f9 PB |
329 | |
330 | /** | |
2fc8ae1d MT |
331 | * Sends a (part of) iovec down a socket, yielding when the socket is full, or |
332 | * Receives data into a (part of) iovec from a socket, | |
333 | * yielding when there is no data in the socket. | |
334 | * The same interface as qemu_sendv_recvv(), with added yielding. | |
335 | * XXX should mark these as coroutine_fn | |
8c5135f9 | 336 | */ |
2fc8ae1d MT |
337 | ssize_t qemu_co_sendv_recvv(int sockfd, struct iovec *iov, unsigned iov_cnt, |
338 | size_t offset, size_t bytes, bool do_send); | |
339 | #define qemu_co_recvv(sockfd, iov, iov_cnt, offset, bytes) \ | |
340 | qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, false) | |
341 | #define qemu_co_sendv(sockfd, iov, iov_cnt, offset, bytes) \ | |
342 | qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, true) | |
8c5135f9 PB |
343 | |
344 | /** | |
2fc8ae1d | 345 | * The same as above, but with just a single buffer |
8c5135f9 | 346 | */ |
2fc8ae1d MT |
347 | ssize_t qemu_co_send_recv(int sockfd, void *buf, size_t bytes, bool do_send); |
348 | #define qemu_co_recv(sockfd, buf, bytes) \ | |
349 | qemu_co_send_recv(sockfd, buf, bytes, false) | |
350 | #define qemu_co_send(sockfd, buf, bytes) \ | |
351 | qemu_co_send_recv(sockfd, buf, bytes, true) | |
8c5135f9 | 352 | |
44e3ee8a AL |
353 | typedef struct QEMUIOVector { |
354 | struct iovec *iov; | |
355 | int niov; | |
356 | int nalloc; | |
249aa745 | 357 | size_t size; |
44e3ee8a AL |
358 | } QEMUIOVector; |
359 | ||
360 | void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint); | |
522584a5 | 361 | void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov); |
44e3ee8a | 362 | void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len); |
1b093c48 MT |
363 | void qemu_iovec_concat(QEMUIOVector *dst, |
364 | QEMUIOVector *src, size_t soffset, size_t sbytes); | |
44e3ee8a | 365 | void qemu_iovec_destroy(QEMUIOVector *qiov); |
be959463 | 366 | void qemu_iovec_reset(QEMUIOVector *qiov); |
d5e6b161 MT |
367 | size_t qemu_iovec_to_buf(QEMUIOVector *qiov, size_t offset, |
368 | void *buf, size_t bytes); | |
03396148 MT |
369 | size_t qemu_iovec_from_buf(QEMUIOVector *qiov, size_t offset, |
370 | const void *buf, size_t bytes); | |
3d9b4925 MT |
371 | size_t qemu_iovec_memset(QEMUIOVector *qiov, size_t offset, |
372 | int fillc, size_t bytes); | |
44e3ee8a | 373 | |
1a6d39fd SH |
374 | bool buffer_is_zero(const void *buf, size_t len); |
375 | ||
6b837bc4 JS |
376 | void qemu_progress_init(int enabled, float min_skip); |
377 | void qemu_progress_end(void); | |
3bfe4dbf | 378 | void qemu_progress_print(float delta, int max); |
31459f46 | 379 | const char *qemu_get_vm_name(void); |
6b837bc4 | 380 | |
082b5557 BS |
381 | #define QEMU_FILE_TYPE_BIOS 0 |
382 | #define QEMU_FILE_TYPE_KEYMAP 1 | |
383 | char *qemu_find_file(int type, const char *name); | |
384 | ||
385 | /* OS specific functions */ | |
386 | void os_setup_early_signal_handling(void); | |
387 | char *os_find_datadir(const char *argv0); | |
388 | void os_parse_cmd_args(int index, const char *optarg); | |
389 | void os_pidfile_error(void); | |
390 | ||
abd0c6bd PB |
391 | /* Convert a byte between binary and BCD. */ |
392 | static inline uint8_t to_bcd(uint8_t val) | |
393 | { | |
394 | return ((val / 10) << 4) | (val % 10); | |
395 | } | |
396 | ||
397 | static inline uint8_t from_bcd(uint8_t val) | |
398 | { | |
399 | return ((val >> 4) * 10) + (val & 0x0f); | |
400 | } | |
401 | ||
338b922e | 402 | /* compute with 96 bit intermediate result: (a*b)/c */ |
403 | static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c) | |
404 | { | |
405 | union { | |
406 | uint64_t ll; | |
407 | struct { | |
408 | #ifdef HOST_WORDS_BIGENDIAN | |
409 | uint32_t high, low; | |
410 | #else | |
411 | uint32_t low, high; | |
412 | #endif | |
413 | } l; | |
414 | } u, res; | |
415 | uint64_t rl, rh; | |
416 | ||
417 | u.ll = a; | |
418 | rl = (uint64_t)u.l.low * (uint64_t)b; | |
419 | rh = (uint64_t)u.l.high * (uint64_t)b; | |
420 | rh += (rl >> 32); | |
421 | res.l.high = rh / c; | |
422 | res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c; | |
423 | return res.ll; | |
424 | } | |
425 | ||
3951690a SH |
426 | /* Round number down to multiple */ |
427 | #define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m)) | |
428 | ||
429 | /* Round number up to multiple */ | |
430 | #define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m)) | |
431 | ||
0bfe3ca5 AL |
432 | #include "module.h" |
433 | ||
faf07963 | 434 | #endif |