blob: 28f47918dcc922ac746a4526e0977cc794b62f35 [file] [log] [blame]
pbrookfaf07962007-11-11 02:51:17 +00001/* Common header file that is included by all of qemu. */
2#ifndef QEMU_COMMON_H
3#define QEMU_COMMON_H
4
malca5e50b22009-02-01 22:19:27 +00005#define QEMU_NORETURN __attribute__ ((__noreturn__))
blueswir17d99a002009-01-14 19:00:36 +00006
malca5e50b22009-02-01 22:19:27 +00007/* Hack around the mess dyngen-exec.h causes: We need QEMU_NORETURN in files that
blueswir17d99a002009-01-14 19:00:36 +00008 cannot include the following headers without conflicts. This condition has
9 to be removed once dyngen is gone. */
10#ifndef __DYNGEN_EXEC_H__
11
pbrookfaf07962007-11-11 02:51:17 +000012/* we put basic includes here to avoid repeating them in device drivers */
13#include <stdlib.h>
14#include <stdio.h>
15#include <stdarg.h>
16#include <string.h>
balrogc8906842008-11-12 17:18:41 +000017#include <strings.h>
pbrookfaf07962007-11-11 02:51:17 +000018#include <inttypes.h>
19#include <limits.h>
20#include <time.h>
21#include <ctype.h>
22#include <errno.h>
23#include <unistd.h>
24#include <fcntl.h>
25#include <sys/stat.h>
aliguoribf9298b2008-12-05 20:05:26 +000026#include "config-host.h"
pbrookfaf07962007-11-11 02:51:17 +000027
28#ifndef O_LARGEFILE
29#define O_LARGEFILE 0
30#endif
31#ifndef O_BINARY
32#define O_BINARY 0
33#endif
34
35#ifndef ENOMEDIUM
36#define ENOMEDIUM ENODEV
37#endif
38
aliguoribf9298b2008-12-05 20:05:26 +000039#ifndef HAVE_IOVEC
40#define HAVE_IOVEC
41struct iovec {
42 void *iov_base;
43 size_t iov_len;
44};
blueswir1331dadd2008-12-06 19:44:56 +000045#else
46#include <sys/uio.h>
aliguoribf9298b2008-12-05 20:05:26 +000047#endif
48
pbrookfaf07962007-11-11 02:51:17 +000049#ifdef _WIN32
pbrookfaf07962007-11-11 02:51:17 +000050#define fsync _commit
51#define lseek _lseeki64
52#define ENOTSUP 4096
53extern int qemu_ftruncate64(int, int64_t);
54#define ftruncate qemu_ftruncate64
55
56
57static inline char *realpath(const char *path, char *resolved_path)
58{
59 _fullpath(resolved_path, path, _MAX_PATH);
60 return resolved_path;
61}
62
63#define PRId64 "I64d"
64#define PRIx64 "I64x"
65#define PRIu64 "I64u"
66#define PRIo64 "I64o"
67#endif
68
69/* FIXME: Remove NEED_CPU_H. */
70#ifndef NEED_CPU_H
71
pbrookfaf07962007-11-11 02:51:17 +000072#include <setjmp.h>
73#include "osdep.h"
74#include "bswap.h"
75
76#else
77
78#include "cpu.h"
79
80#endif /* !defined(NEED_CPU_H) */
81
82/* bottom halves */
83typedef struct QEMUBH QEMUBH;
84
85typedef void QEMUBHFunc(void *opaque);
86
87QEMUBH *qemu_bh_new(QEMUBHFunc *cb, void *opaque);
88void qemu_bh_schedule(QEMUBH *bh);
aliguori80d35802008-10-31 17:42:00 +000089/* Bottom halfs that are scheduled from a bottom half handler are instantly
90 * invoked. This can create an infinite loop if a bottom half handler
91 * schedules itself. qemu_bh_schedule_idle() avoids this infinite loop by
92 * ensuring that the bottom half isn't executed until the next main loop
93 * iteration.
94 */
aliguori1b435b12008-10-31 17:24:21 +000095void qemu_bh_schedule_idle(QEMUBH *bh);
pbrookfaf07962007-11-11 02:51:17 +000096void qemu_bh_cancel(QEMUBH *bh);
97void qemu_bh_delete(QEMUBH *bh);
98int qemu_bh_poll(void);
99
pbrook87ecb682007-11-17 17:14:51 +0000100uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c);
101
balrogf6503052008-02-17 11:42:19 +0000102void qemu_get_timedate(struct tm *tm, int offset);
103int qemu_timedate_diff(struct tm *tm);
104
pbrookfaf07962007-11-11 02:51:17 +0000105/* cutils.c */
106void pstrcpy(char *buf, int buf_size, const char *str);
107char *pstrcat(char *buf, int buf_size, const char *s);
108int strstart(const char *str, const char *val, const char **ptr);
109int stristart(const char *str, const char *val, const char **ptr);
110time_t mktimegm(struct tm *tm);
blueswir1ad46db92008-12-11 19:37:54 +0000111int qemu_fls(int i);
pbrookfaf07962007-11-11 02:51:17 +0000112
blueswir1cd390082008-11-16 13:53:32 +0000113#define qemu_isalnum(c) isalnum((unsigned char)(c))
114#define qemu_isalpha(c) isalpha((unsigned char)(c))
115#define qemu_iscntrl(c) iscntrl((unsigned char)(c))
116#define qemu_isdigit(c) isdigit((unsigned char)(c))
117#define qemu_isgraph(c) isgraph((unsigned char)(c))
118#define qemu_islower(c) islower((unsigned char)(c))
119#define qemu_isprint(c) isprint((unsigned char)(c))
120#define qemu_ispunct(c) ispunct((unsigned char)(c))
121#define qemu_isspace(c) isspace((unsigned char)(c))
122#define qemu_isupper(c) isupper((unsigned char)(c))
123#define qemu_isxdigit(c) isxdigit((unsigned char)(c))
124#define qemu_tolower(c) tolower((unsigned char)(c))
125#define qemu_toupper(c) toupper((unsigned char)(c))
126#define qemu_isascii(c) isascii((unsigned char)(c))
127#define qemu_toascii(c) toascii((unsigned char)(c))
128
aurel32ca10f862008-04-11 21:35:42 +0000129void *qemu_malloc(size_t size);
ths2137b4c2008-08-06 08:37:17 +0000130void *qemu_realloc(void *ptr, size_t size);
aurel32ca10f862008-04-11 21:35:42 +0000131void *qemu_mallocz(size_t size);
132void qemu_free(void *ptr);
133char *qemu_strdup(const char *str);
balrogac4b0d02008-11-09 00:28:40 +0000134char *qemu_strndup(const char *str, size_t size);
aurel32ca10f862008-04-11 21:35:42 +0000135
136void *get_mmap_addr(unsigned long size);
137
138
pbrook87ecb682007-11-17 17:14:51 +0000139/* Error handling. */
140
malca5e50b22009-02-01 22:19:27 +0000141void QEMU_NORETURN hw_error(const char *fmt, ...)
blueswir17d99a002009-01-14 19:00:36 +0000142 __attribute__ ((__format__ (__printf__, 1, 2)));
pbrook87ecb682007-11-17 17:14:51 +0000143
144/* IO callbacks. */
145typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size);
146typedef int IOCanRWHandler(void *opaque);
147typedef void IOHandler(void *opaque);
148
149struct ParallelIOArg {
150 void *buffer;
151 int count;
152};
153
154typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
155
156/* A load of opaque types so that device init declarations don't have to
157 pull in all the real definitions. */
158typedef struct NICInfo NICInfo;
balrog1ae26a12008-09-28 23:19:47 +0000159typedef struct HCIInfo HCIInfo;
pbrook87ecb682007-11-17 17:14:51 +0000160typedef struct AudioState AudioState;
161typedef struct BlockDriverState BlockDriverState;
162typedef struct DisplayState DisplayState;
aliguori7d957bd2009-01-15 22:14:11 +0000163typedef struct DisplayChangeListener DisplayChangeListener;
164typedef struct DisplaySurface DisplaySurface;
aliguori7b5d76d2009-03-13 15:02:13 +0000165typedef struct DisplayAllocator DisplayAllocator;
aliguori7d957bd2009-01-15 22:14:11 +0000166typedef struct PixelFormat PixelFormat;
pbrook87ecb682007-11-17 17:14:51 +0000167typedef struct TextConsole TextConsole;
pbrookc60e08d2008-07-01 16:24:38 +0000168typedef TextConsole QEMUConsole;
pbrook87ecb682007-11-17 17:14:51 +0000169typedef struct CharDriverState CharDriverState;
170typedef struct VLANState VLANState;
171typedef struct QEMUFile QEMUFile;
172typedef struct i2c_bus i2c_bus;
173typedef struct i2c_slave i2c_slave;
174typedef struct SMBusDevice SMBusDevice;
175typedef struct QEMUTimer QEMUTimer;
176typedef struct PCIBus PCIBus;
177typedef struct PCIDevice PCIDevice;
178typedef struct SerialState SerialState;
179typedef struct IRQState *qemu_irq;
180struct pcmcia_card_s;
181
pbrookb3c77242008-06-30 16:31:04 +0000182/* CPU save/load. */
183void cpu_save(QEMUFile *f, void *opaque);
184int cpu_load(QEMUFile *f, void *opaque, int version_id);
185
aliguori9e472e12008-10-08 19:50:24 +0000186/* Force QEMU to stop what it's doing and service IO */
187void qemu_service_io(void);
188
aliguori44e3ee82009-01-22 16:59:20 +0000189typedef struct QEMUIOVector {
190 struct iovec *iov;
191 int niov;
192 int nalloc;
aliguori249aa742009-01-26 17:17:52 +0000193 size_t size;
aliguori44e3ee82009-01-22 16:59:20 +0000194} QEMUIOVector;
195
196void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
197void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
198void qemu_iovec_destroy(QEMUIOVector *qiov);
aliguoribe959462009-02-05 21:23:54 +0000199void qemu_iovec_reset(QEMUIOVector *qiov);
aliguori44e3ee82009-01-22 16:59:20 +0000200void qemu_iovec_to_buffer(QEMUIOVector *qiov, void *buf);
aliguori249aa742009-01-26 17:17:52 +0000201void qemu_iovec_from_buffer(QEMUIOVector *qiov, const void *buf, size_t count);
aliguori44e3ee82009-01-22 16:59:20 +0000202
aliguori376253e2009-03-05 23:01:23 +0000203struct Monitor;
204typedef struct Monitor Monitor;
205
blueswir17d99a002009-01-14 19:00:36 +0000206#endif /* dyngen-exec.h hack */
207
pbrookfaf07962007-11-11 02:51:17 +0000208#endif