Statistics
| Branch: | Revision:

root / qemu-common.h @ 34e65944

History | View | Annotate | Download (9.9 kB)

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