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