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