libcacard: introduce NEXT_TOKEN macro
[qemu.git] / qemu-common.h
blobc2b79bd60e7d73ade0da015d91881d1ba5affef8
1 /* Common header file that is included by all of qemu. */
2 #ifndef QEMU_COMMON_H
3 #define QEMU_COMMON_H
5 #include "config-host.h"
7 #define QEMU_NORETURN __attribute__ ((__noreturn__))
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
14 #define QEMU_BUILD_BUG_ON(x) typedef char __build_bug_on__##__LINE__[(x)?-1:1];
15 #define TFR(expr) do { if ((expr) != -1) break; } while (errno == EINTR)
17 typedef struct QEMUTimer QEMUTimer;
18 typedef struct QEMUFile QEMUFile;
19 typedef struct QEMUBH QEMUBH;
20 typedef struct DeviceState DeviceState;
22 struct Monitor;
23 typedef struct Monitor Monitor;
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>
29 #include <stdbool.h>
30 #include <string.h>
31 #include <strings.h>
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>
40 #include <sys/time.h>
41 #include <assert.h>
42 #include <signal.h>
44 #ifdef _WIN32
45 #include "qemu-os-win32.h"
46 #endif
48 #ifdef CONFIG_POSIX
49 #include "qemu-os-posix.h"
50 #endif
52 #ifndef O_LARGEFILE
53 #define O_LARGEFILE 0
54 #endif
55 #ifndef O_BINARY
56 #define O_BINARY 0
57 #endif
58 #ifndef MAP_ANONYMOUS
59 #define MAP_ANONYMOUS MAP_ANON
60 #endif
61 #ifndef ENOMEDIUM
62 #define ENOMEDIUM ENODEV
63 #endif
64 #if !defined(ENOTSUP)
65 #define ENOTSUP 4096
66 #endif
67 #ifndef TIME_MAX
68 #define TIME_MAX LONG_MAX
69 #endif
71 #ifndef CONFIG_IOVEC
72 #define CONFIG_IOVEC
73 struct iovec {
74 void *iov_base;
75 size_t iov_len;
78 * Use the same value as Linux for now.
80 #define IOV_MAX 1024
81 #else
82 #include <sys/uio.h>
83 #endif
85 #if defined __GNUC__
86 # if (__GNUC__ < 4) || \
87 defined(__GNUC_MINOR__) && (__GNUC__ == 4) && (__GNUC_MINOR__ < 4)
88 /* gcc versions before 4.4.x don't support gnu_printf, so use printf. */
89 # define GCC_ATTR __attribute__((__unused__, format(printf, 1, 2)))
90 # define GCC_FMT_ATTR(n, m) __attribute__((format(printf, n, m)))
91 # else
92 /* Use gnu_printf when supported (qemu uses standard format strings). */
93 # define GCC_ATTR __attribute__((__unused__, format(gnu_printf, 1, 2)))
94 # define GCC_FMT_ATTR(n, m) __attribute__((format(gnu_printf, n, m)))
95 # endif
96 #else
97 #define GCC_ATTR /**/
98 #define GCC_FMT_ATTR(n, m)
99 #endif
101 typedef int (*fprintf_function)(FILE *f, const char *fmt, ...)
102 GCC_FMT_ATTR(2, 3);
104 #ifdef _WIN32
105 #define fsync _commit
106 #define lseek _lseeki64
107 int qemu_ftruncate64(int, int64_t);
108 #define ftruncate qemu_ftruncate64
110 static inline char *realpath(const char *path, char *resolved_path)
112 _fullpath(resolved_path, path, _MAX_PATH);
113 return resolved_path;
115 #endif
117 /* FIXME: Remove NEED_CPU_H. */
118 #ifndef NEED_CPU_H
120 #include "osdep.h"
121 #include "bswap.h"
123 #else
125 #include "cpu.h"
127 #endif /* !defined(NEED_CPU_H) */
129 /* main function, renamed */
130 #if defined(CONFIG_COCOA)
131 int qemu_main(int argc, char **argv, char **envp);
132 #endif
134 /* bottom halves */
135 typedef void QEMUBHFunc(void *opaque);
137 void async_context_push(void);
138 void async_context_pop(void);
139 int get_async_context_id(void);
141 QEMUBH *qemu_bh_new(QEMUBHFunc *cb, void *opaque);
142 void qemu_bh_schedule(QEMUBH *bh);
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.
149 void qemu_bh_schedule_idle(QEMUBH *bh);
150 void qemu_bh_cancel(QEMUBH *bh);
151 void qemu_bh_delete(QEMUBH *bh);
152 int qemu_bh_poll(void);
153 void qemu_bh_update_timeout(int *timeout);
155 void qemu_get_timedate(struct tm *tm, int offset);
156 int qemu_timedate_diff(struct tm *tm);
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);
163 int qemu_strnlen(const char *s, int max_len);
164 time_t mktimegm(struct tm *tm);
165 int qemu_fls(int i);
166 int qemu_fdatasync(int fd);
167 int fcntl_setfl(int fd, int flag);
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.
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'
181 int64_t strtosz(const char *nptr, char **end);
182 int64_t strtosz_suffix(const char *nptr, char **end, const char default_suffix);
184 /* path.c */
185 void init_paths(const char *prefix);
186 const char *path(const char *pathname);
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))
204 void *qemu_oom_check(void *ptr);
205 void *qemu_malloc(size_t size);
206 void *qemu_realloc(void *ptr, size_t size);
207 void *qemu_mallocz(size_t size);
208 void qemu_free(void *ptr);
209 char *qemu_strdup(const char *str);
210 char *qemu_strndup(const char *str, size_t size);
212 void qemu_mutex_lock_iothread(void);
213 void qemu_mutex_unlock_iothread(void);
215 int qemu_open(const char *name, int flags, ...);
216 ssize_t qemu_write_full(int fd, const void *buf, size_t count)
217 QEMU_WARN_UNUSED_RESULT;
218 void qemu_set_cloexec(int fd);
220 #ifndef _WIN32
221 int qemu_add_child_watch(pid_t pid);
222 int qemu_eventfd(int pipefd[2]);
223 int qemu_pipe(int pipefd[2]);
224 #endif
226 /* Error handling. */
228 void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
230 /* IO callbacks. */
231 typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size);
232 typedef int IOCanReadHandler(void *opaque);
233 typedef void IOHandler(void *opaque);
235 void qemu_iohandler_fill(int *pnfds, fd_set *readfds, fd_set *writefds, fd_set *xfds);
236 void qemu_iohandler_poll(fd_set *readfds, fd_set *writefds, fd_set *xfds, int rc);
238 struct ParallelIOArg {
239 void *buffer;
240 int count;
243 typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
245 /* A load of opaque types so that device init declarations don't have to
246 pull in all the real definitions. */
247 typedef struct NICInfo NICInfo;
248 typedef struct HCIInfo HCIInfo;
249 typedef struct AudioState AudioState;
250 typedef struct BlockDriverState BlockDriverState;
251 typedef struct DriveInfo DriveInfo;
252 typedef struct DisplayState DisplayState;
253 typedef struct DisplayChangeListener DisplayChangeListener;
254 typedef struct DisplaySurface DisplaySurface;
255 typedef struct DisplayAllocator DisplayAllocator;
256 typedef struct PixelFormat PixelFormat;
257 typedef struct TextConsole TextConsole;
258 typedef TextConsole QEMUConsole;
259 typedef struct CharDriverState CharDriverState;
260 typedef struct MACAddr MACAddr;
261 typedef struct VLANState VLANState;
262 typedef struct VLANClientState VLANClientState;
263 typedef struct i2c_bus i2c_bus;
264 typedef struct i2c_slave i2c_slave;
265 typedef struct SMBusDevice SMBusDevice;
266 typedef struct PCIHostState PCIHostState;
267 typedef struct PCIExpressHost PCIExpressHost;
268 typedef struct PCIBus PCIBus;
269 typedef struct PCIDevice PCIDevice;
270 typedef struct PCIExpressDevice PCIExpressDevice;
271 typedef struct PCIBridge PCIBridge;
272 typedef struct PCIEAERMsg PCIEAERMsg;
273 typedef struct PCIEAERLog PCIEAERLog;
274 typedef struct PCIEAERErr PCIEAERErr;
275 typedef struct PCIEPort PCIEPort;
276 typedef struct PCIESlot PCIESlot;
277 typedef struct SerialState SerialState;
278 typedef struct IRQState *qemu_irq;
279 typedef struct PCMCIACardState PCMCIACardState;
280 typedef struct MouseTransformInfo MouseTransformInfo;
281 typedef struct uWireSlave uWireSlave;
282 typedef struct I2SCodec I2SCodec;
283 typedef struct SSIBus SSIBus;
284 typedef struct EventNotifier EventNotifier;
285 typedef struct VirtIODevice VirtIODevice;
287 typedef uint64_t pcibus_t;
289 void cpu_exec_init_all(unsigned long tb_size);
291 /* CPU save/load. */
292 void cpu_save(QEMUFile *f, void *opaque);
293 int cpu_load(QEMUFile *f, void *opaque, int version_id);
295 /* Force QEMU to stop what it's doing and service IO */
296 void qemu_service_io(void);
298 /* Force QEMU to process pending events */
299 void qemu_notify_event(void);
301 /* Unblock cpu */
302 void qemu_cpu_kick(void *env);
303 void qemu_cpu_kick_self(void);
304 int qemu_cpu_is_self(void *env);
305 bool all_cpu_threads_idle(void);
307 /* work queue */
308 struct qemu_work_item {
309 struct qemu_work_item *next;
310 void (*func)(void *data);
311 void *data;
312 int done;
315 #ifdef CONFIG_USER_ONLY
316 #define qemu_init_vcpu(env) do { } while (0)
317 #else
318 void qemu_init_vcpu(void *env);
319 #endif
321 typedef struct QEMUIOVector {
322 struct iovec *iov;
323 int niov;
324 int nalloc;
325 size_t size;
326 } QEMUIOVector;
328 void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
329 void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
330 void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
331 void qemu_iovec_copy(QEMUIOVector *dst, QEMUIOVector *src, uint64_t skip,
332 size_t size);
333 void qemu_iovec_concat(QEMUIOVector *dst, QEMUIOVector *src, size_t size);
334 void qemu_iovec_destroy(QEMUIOVector *qiov);
335 void qemu_iovec_reset(QEMUIOVector *qiov);
336 void qemu_iovec_to_buffer(QEMUIOVector *qiov, void *buf);
337 void qemu_iovec_from_buffer(QEMUIOVector *qiov, const void *buf, size_t count);
338 void qemu_iovec_memset(QEMUIOVector *qiov, int c, size_t count);
339 void qemu_iovec_memset_skip(QEMUIOVector *qiov, int c, size_t count,
340 size_t skip);
342 void qemu_progress_init(int enabled, float min_skip);
343 void qemu_progress_end(void);
344 void qemu_progress_print(float delta, int max);
346 #define QEMU_FILE_TYPE_BIOS 0
347 #define QEMU_FILE_TYPE_KEYMAP 1
348 char *qemu_find_file(int type, const char *name);
350 /* OS specific functions */
351 void os_setup_early_signal_handling(void);
352 char *os_find_datadir(const char *argv0);
353 void os_parse_cmd_args(int index, const char *optarg);
354 void os_pidfile_error(void);
356 /* Convert a byte between binary and BCD. */
357 static inline uint8_t to_bcd(uint8_t val)
359 return ((val / 10) << 4) | (val % 10);
362 static inline uint8_t from_bcd(uint8_t val)
364 return ((val >> 4) * 10) + (val & 0x0f);
367 /* compute with 96 bit intermediate result: (a*b)/c */
368 static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
370 union {
371 uint64_t ll;
372 struct {
373 #ifdef HOST_WORDS_BIGENDIAN
374 uint32_t high, low;
375 #else
376 uint32_t low, high;
377 #endif
378 } l;
379 } u, res;
380 uint64_t rl, rh;
382 u.ll = a;
383 rl = (uint64_t)u.l.low * (uint64_t)b;
384 rh = (uint64_t)u.l.high * (uint64_t)b;
385 rh += (rl >> 32);
386 res.l.high = rh / c;
387 res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
388 return res.ll;
391 #include "module.h"
393 #endif