blob: 5d7ffebcd7ec355ea09b09a95c2207ca741396d9 [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>
Paul Brook55616502009-05-13 20:51:49 +010026#include <assert.h>
aliguoribf9298b2008-12-05 20:05:26 +000027#include "config-host.h"
pbrookfaf07962007-11-11 02:51:17 +000028
29#ifndef O_LARGEFILE
30#define O_LARGEFILE 0
31#endif
32#ifndef O_BINARY
33#define O_BINARY 0
34#endif
Juan Quintela0e74e662009-07-27 16:12:57 +020035#ifndef MAP_ANONYMOUS
36#define MAP_ANONYMOUS MAP_ANON
37#endif
pbrookfaf07962007-11-11 02:51:17 +000038#ifndef ENOMEDIUM
39#define ENOMEDIUM ENODEV
40#endif
Juan Quintela2880bc32009-07-27 16:13:22 +020041#if !defined(ENOTSUP) && defined(__OpenBSD__)
42#define ENOTSUP 4096
43#endif
pbrookfaf07962007-11-11 02:51:17 +000044
Juan Quintela6114fdb2009-07-27 16:12:59 +020045#ifndef CONFIG_IOVEC
46#define CONFIG_IOVEC
aliguoribf9298b2008-12-05 20:05:26 +000047struct iovec {
48 void *iov_base;
49 size_t iov_len;
50};
blueswir1331dadd2008-12-06 19:44:56 +000051#else
52#include <sys/uio.h>
aliguoribf9298b2008-12-05 20:05:26 +000053#endif
54
pbrookfaf07962007-11-11 02:51:17 +000055#ifdef _WIN32
pbrookfaf07962007-11-11 02:51:17 +000056#define fsync _commit
57#define lseek _lseeki64
pbrookfaf07962007-11-11 02:51:17 +000058extern int qemu_ftruncate64(int, int64_t);
59#define ftruncate qemu_ftruncate64
60
pbrookfaf07962007-11-11 02:51:17 +000061static inline char *realpath(const char *path, char *resolved_path)
62{
63 _fullpath(resolved_path, path, _MAX_PATH);
64 return resolved_path;
65}
66
67#define PRId64 "I64d"
68#define PRIx64 "I64x"
69#define PRIu64 "I64u"
70#define PRIo64 "I64o"
71#endif
72
73/* FIXME: Remove NEED_CPU_H. */
74#ifndef NEED_CPU_H
75
pbrookfaf07962007-11-11 02:51:17 +000076#include <setjmp.h>
77#include "osdep.h"
78#include "bswap.h"
79
80#else
81
82#include "cpu.h"
83
84#endif /* !defined(NEED_CPU_H) */
85
86/* bottom halves */
87typedef struct QEMUBH QEMUBH;
88
89typedef void QEMUBHFunc(void *opaque);
90
91QEMUBH *qemu_bh_new(QEMUBHFunc *cb, void *opaque);
92void qemu_bh_schedule(QEMUBH *bh);
aliguori80d35802008-10-31 17:42:00 +000093/* Bottom halfs that are scheduled from a bottom half handler are instantly
94 * invoked. This can create an infinite loop if a bottom half handler
95 * schedules itself. qemu_bh_schedule_idle() avoids this infinite loop by
96 * ensuring that the bottom half isn't executed until the next main loop
97 * iteration.
98 */
aliguori1b435b12008-10-31 17:24:21 +000099void qemu_bh_schedule_idle(QEMUBH *bh);
pbrookfaf07962007-11-11 02:51:17 +0000100void qemu_bh_cancel(QEMUBH *bh);
101void qemu_bh_delete(QEMUBH *bh);
102int qemu_bh_poll(void);
103
pbrook87ecb682007-11-17 17:14:51 +0000104uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c);
105
balrogf6503052008-02-17 11:42:19 +0000106void qemu_get_timedate(struct tm *tm, int offset);
107int qemu_timedate_diff(struct tm *tm);
108
pbrookfaf07962007-11-11 02:51:17 +0000109/* cutils.c */
110void pstrcpy(char *buf, int buf_size, const char *str);
111char *pstrcat(char *buf, int buf_size, const char *s);
112int strstart(const char *str, const char *val, const char **ptr);
113int stristart(const char *str, const char *val, const char **ptr);
Blue Swirld43277c2009-07-01 18:24:44 +0000114int qemu_strnlen(const char *s, int max_len);
pbrookfaf07962007-11-11 02:51:17 +0000115time_t mktimegm(struct tm *tm);
blueswir1ad46db92008-12-11 19:37:54 +0000116int qemu_fls(int i);
pbrookfaf07962007-11-11 02:51:17 +0000117
blueswir1cd390082008-11-16 13:53:32 +0000118#define qemu_isalnum(c) isalnum((unsigned char)(c))
119#define qemu_isalpha(c) isalpha((unsigned char)(c))
120#define qemu_iscntrl(c) iscntrl((unsigned char)(c))
121#define qemu_isdigit(c) isdigit((unsigned char)(c))
122#define qemu_isgraph(c) isgraph((unsigned char)(c))
123#define qemu_islower(c) islower((unsigned char)(c))
124#define qemu_isprint(c) isprint((unsigned char)(c))
125#define qemu_ispunct(c) ispunct((unsigned char)(c))
126#define qemu_isspace(c) isspace((unsigned char)(c))
127#define qemu_isupper(c) isupper((unsigned char)(c))
128#define qemu_isxdigit(c) isxdigit((unsigned char)(c))
129#define qemu_tolower(c) tolower((unsigned char)(c))
130#define qemu_toupper(c) toupper((unsigned char)(c))
131#define qemu_isascii(c) isascii((unsigned char)(c))
132#define qemu_toascii(c) toascii((unsigned char)(c))
133
aurel32ca10f862008-04-11 21:35:42 +0000134void *qemu_malloc(size_t size);
ths2137b4c2008-08-06 08:37:17 +0000135void *qemu_realloc(void *ptr, size_t size);
aurel32ca10f862008-04-11 21:35:42 +0000136void *qemu_mallocz(size_t size);
137void qemu_free(void *ptr);
138char *qemu_strdup(const char *str);
balrogac4b0d02008-11-09 00:28:40 +0000139char *qemu_strndup(const char *str, size_t size);
aurel32ca10f862008-04-11 21:35:42 +0000140
141void *get_mmap_addr(unsigned long size);
142
143
pbrook87ecb682007-11-17 17:14:51 +0000144/* Error handling. */
145
malca5e50b22009-02-01 22:19:27 +0000146void QEMU_NORETURN hw_error(const char *fmt, ...)
blueswir17d99a002009-01-14 19:00:36 +0000147 __attribute__ ((__format__ (__printf__, 1, 2)));
pbrook87ecb682007-11-17 17:14:51 +0000148
149/* IO callbacks. */
150typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size);
151typedef int IOCanRWHandler(void *opaque);
152typedef void IOHandler(void *opaque);
153
154struct ParallelIOArg {
155 void *buffer;
156 int count;
157};
158
159typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
160
161/* A load of opaque types so that device init declarations don't have to
162 pull in all the real definitions. */
163typedef struct NICInfo NICInfo;
balrog1ae26a12008-09-28 23:19:47 +0000164typedef struct HCIInfo HCIInfo;
pbrook87ecb682007-11-17 17:14:51 +0000165typedef struct AudioState AudioState;
166typedef struct BlockDriverState BlockDriverState;
167typedef struct DisplayState DisplayState;
aliguori7d957bd2009-01-15 22:14:11 +0000168typedef struct DisplayChangeListener DisplayChangeListener;
169typedef struct DisplaySurface DisplaySurface;
aliguori7b5d76d2009-03-13 15:02:13 +0000170typedef struct DisplayAllocator DisplayAllocator;
aliguori7d957bd2009-01-15 22:14:11 +0000171typedef struct PixelFormat PixelFormat;
pbrook87ecb682007-11-17 17:14:51 +0000172typedef struct TextConsole TextConsole;
pbrookc60e08d2008-07-01 16:24:38 +0000173typedef TextConsole QEMUConsole;
pbrook87ecb682007-11-17 17:14:51 +0000174typedef struct CharDriverState CharDriverState;
175typedef struct VLANState VLANState;
176typedef struct QEMUFile QEMUFile;
177typedef struct i2c_bus i2c_bus;
178typedef struct i2c_slave i2c_slave;
179typedef struct SMBusDevice SMBusDevice;
180typedef struct QEMUTimer QEMUTimer;
181typedef struct PCIBus PCIBus;
182typedef struct PCIDevice PCIDevice;
183typedef struct SerialState SerialState;
184typedef struct IRQState *qemu_irq;
Paul Brookbc24a222009-05-10 01:44:56 +0100185typedef struct PCMCIACardState PCMCIACardState;
186typedef struct MouseTransformInfo MouseTransformInfo;
187typedef struct uWireSlave uWireSlave;
188typedef struct I2SCodec I2SCodec;
Paul Brookaae94602009-05-14 22:35:06 +0100189typedef struct DeviceState DeviceState;
Paul Brook90d37232009-05-14 22:35:09 +0100190typedef struct SSIBus SSIBus;
pbrook87ecb682007-11-17 17:14:51 +0000191
pbrookb3c77242008-06-30 16:31:04 +0000192/* CPU save/load. */
193void cpu_save(QEMUFile *f, void *opaque);
194int cpu_load(QEMUFile *f, void *opaque, int version_id);
195
aliguori9e472e12008-10-08 19:50:24 +0000196/* Force QEMU to stop what it's doing and service IO */
197void qemu_service_io(void);
198
aliguorid9f75a42009-04-24 18:03:11 +0000199/* Force QEMU to process pending events */
200void qemu_notify_event(void);
201
aliguori8edac962009-04-24 18:03:45 +0000202/* Unblock cpu */
203void qemu_cpu_kick(void *env);
204int qemu_cpu_self(void *env);
205
aliguori0bf46a42009-04-24 18:03:41 +0000206#ifdef CONFIG_USER_ONLY
207#define qemu_init_vcpu(env) do { } while (0)
208#else
209void qemu_init_vcpu(void *env);
210#endif
211
aliguori44e3ee82009-01-22 16:59:20 +0000212typedef struct QEMUIOVector {
213 struct iovec *iov;
214 int niov;
215 int nalloc;
aliguori249aa742009-01-26 17:17:52 +0000216 size_t size;
aliguori44e3ee82009-01-22 16:59:20 +0000217} QEMUIOVector;
218
219void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
aliguori522584a2009-03-28 17:46:10 +0000220void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
aliguori44e3ee82009-01-22 16:59:20 +0000221void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
222void qemu_iovec_destroy(QEMUIOVector *qiov);
aliguoribe959462009-02-05 21:23:54 +0000223void qemu_iovec_reset(QEMUIOVector *qiov);
aliguori44e3ee82009-01-22 16:59:20 +0000224void qemu_iovec_to_buffer(QEMUIOVector *qiov, void *buf);
aliguori249aa742009-01-26 17:17:52 +0000225void qemu_iovec_from_buffer(QEMUIOVector *qiov, const void *buf, size_t count);
aliguori44e3ee82009-01-22 16:59:20 +0000226
aliguori376253e2009-03-05 23:01:23 +0000227struct Monitor;
228typedef struct Monitor Monitor;
229
Anthony Liguori0bfe3ca2009-05-14 19:29:53 +0100230#include "module.h"
231
blueswir17d99a002009-01-14 19:00:36 +0000232#endif /* dyngen-exec.h hack */
233
pbrookfaf07962007-11-11 02:51:17 +0000234#endif