blob: 805be1a8cc732192b4418de8186b5271e40ce335 [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
Kevin Wolfbeb6f0d2010-01-15 12:56:41 +01005#include "config-host.h"
6
malca5e50b22009-02-01 22:19:27 +00007#define QEMU_NORETURN __attribute__ ((__noreturn__))
Blue Swirl747bbdf2009-10-18 16:26:06 +00008#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
blueswir17d99a002009-01-14 19:00:36 +000013
Paolo Bonzini24ebf5f2010-02-18 21:25:23 +010014#define QEMU_BUILD_BUG_ON(x) typedef char __build_bug_on__##__LINE__[(x)?-1:1];
15
malca5e50b22009-02-01 22:19:27 +000016/* Hack around the mess dyngen-exec.h causes: We need QEMU_NORETURN in files that
blueswir17d99a002009-01-14 19:00:36 +000017 cannot include the following headers without conflicts. This condition has
18 to be removed once dyngen is gone. */
19#ifndef __DYNGEN_EXEC_H__
20
pbrookfaf07962007-11-11 02:51:17 +000021/* we put basic includes here to avoid repeating them in device drivers */
22#include <stdlib.h>
23#include <stdio.h>
24#include <stdarg.h>
25#include <string.h>
balrogc8906842008-11-12 17:18:41 +000026#include <strings.h>
pbrookfaf07962007-11-11 02:51:17 +000027#include <inttypes.h>
28#include <limits.h>
29#include <time.h>
30#include <ctype.h>
31#include <errno.h>
32#include <unistd.h>
33#include <fcntl.h>
34#include <sys/stat.h>
Paul Brook55616502009-05-13 20:51:49 +010035#include <assert.h>
pbrookfaf07962007-11-11 02:51:17 +000036
37#ifndef O_LARGEFILE
38#define O_LARGEFILE 0
39#endif
40#ifndef O_BINARY
41#define O_BINARY 0
42#endif
Juan Quintela0e74e662009-07-27 16:12:57 +020043#ifndef MAP_ANONYMOUS
44#define MAP_ANONYMOUS MAP_ANON
45#endif
pbrookfaf07962007-11-11 02:51:17 +000046#ifndef ENOMEDIUM
47#define ENOMEDIUM ENODEV
48#endif
Anthony Liguori4c955382009-07-28 15:48:31 -050049#if !defined(ENOTSUP)
Juan Quintela2880bc32009-07-27 16:13:22 +020050#define ENOTSUP 4096
51#endif
pbrookfaf07962007-11-11 02:51:17 +000052
Juan Quintela6114fdb2009-07-27 16:12:59 +020053#ifndef CONFIG_IOVEC
54#define CONFIG_IOVEC
aliguoribf9298b2008-12-05 20:05:26 +000055struct iovec {
56 void *iov_base;
57 size_t iov_len;
58};
Christoph Hellwige2a305f2010-01-26 14:49:08 +010059/*
60 * Use the same value as Linux for now.
61 */
62#define IOV_MAX 1024
blueswir1331dadd2008-12-06 19:44:56 +000063#else
64#include <sys/uio.h>
aliguoribf9298b2008-12-05 20:05:26 +000065#endif
66
pbrookfaf07962007-11-11 02:51:17 +000067#ifdef _WIN32
pbrookfaf07962007-11-11 02:51:17 +000068#define fsync _commit
69#define lseek _lseeki64
pbrookfaf07962007-11-11 02:51:17 +000070extern int qemu_ftruncate64(int, int64_t);
71#define ftruncate qemu_ftruncate64
72
pbrookfaf07962007-11-11 02:51:17 +000073static inline char *realpath(const char *path, char *resolved_path)
74{
75 _fullpath(resolved_path, path, _MAX_PATH);
76 return resolved_path;
77}
78
79#define PRId64 "I64d"
80#define PRIx64 "I64x"
81#define PRIu64 "I64u"
82#define PRIo64 "I64o"
83#endif
84
85/* FIXME: Remove NEED_CPU_H. */
86#ifndef NEED_CPU_H
87
pbrookfaf07962007-11-11 02:51:17 +000088#include <setjmp.h>
89#include "osdep.h"
90#include "bswap.h"
91
92#else
93
94#include "cpu.h"
95
96#endif /* !defined(NEED_CPU_H) */
97
98/* bottom halves */
99typedef struct QEMUBH QEMUBH;
100
101typedef void QEMUBHFunc(void *opaque);
102
Kevin Wolf9a1e9482009-10-22 17:54:38 +0200103void async_context_push(void);
104void async_context_pop(void);
105int get_async_context_id(void);
106
pbrookfaf07962007-11-11 02:51:17 +0000107QEMUBH *qemu_bh_new(QEMUBHFunc *cb, void *opaque);
108void qemu_bh_schedule(QEMUBH *bh);
aliguori80d35802008-10-31 17:42:00 +0000109/* Bottom halfs that are scheduled from a bottom half handler are instantly
110 * invoked. This can create an infinite loop if a bottom half handler
111 * schedules itself. qemu_bh_schedule_idle() avoids this infinite loop by
112 * ensuring that the bottom half isn't executed until the next main loop
113 * iteration.
114 */
aliguori1b435b12008-10-31 17:24:21 +0000115void qemu_bh_schedule_idle(QEMUBH *bh);
pbrookfaf07962007-11-11 02:51:17 +0000116void qemu_bh_cancel(QEMUBH *bh);
117void qemu_bh_delete(QEMUBH *bh);
118int qemu_bh_poll(void);
Kevin Wolf4f999d02009-10-22 17:54:37 +0200119void qemu_bh_update_timeout(int *timeout);
pbrookfaf07962007-11-11 02:51:17 +0000120
pbrook87ecb682007-11-17 17:14:51 +0000121uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c);
122
balrogf6503052008-02-17 11:42:19 +0000123void qemu_get_timedate(struct tm *tm, int offset);
124int qemu_timedate_diff(struct tm *tm);
125
pbrookfaf07962007-11-11 02:51:17 +0000126/* cutils.c */
127void pstrcpy(char *buf, int buf_size, const char *str);
128char *pstrcat(char *buf, int buf_size, const char *s);
129int strstart(const char *str, const char *val, const char **ptr);
130int stristart(const char *str, const char *val, const char **ptr);
Blue Swirld43277c2009-07-01 18:24:44 +0000131int qemu_strnlen(const char *s, int max_len);
pbrookfaf07962007-11-11 02:51:17 +0000132time_t mktimegm(struct tm *tm);
blueswir1ad46db92008-12-11 19:37:54 +0000133int qemu_fls(int i);
Christoph Hellwig6f1953c2009-09-04 19:01:32 +0200134int qemu_fdatasync(int fd);
pbrookfaf07962007-11-11 02:51:17 +0000135
Blue Swirl37022082009-08-15 07:51:59 +0000136/* path.c */
137void init_paths(const char *prefix);
138const char *path(const char *pathname);
139
blueswir1cd390082008-11-16 13:53:32 +0000140#define qemu_isalnum(c) isalnum((unsigned char)(c))
141#define qemu_isalpha(c) isalpha((unsigned char)(c))
142#define qemu_iscntrl(c) iscntrl((unsigned char)(c))
143#define qemu_isdigit(c) isdigit((unsigned char)(c))
144#define qemu_isgraph(c) isgraph((unsigned char)(c))
145#define qemu_islower(c) islower((unsigned char)(c))
146#define qemu_isprint(c) isprint((unsigned char)(c))
147#define qemu_ispunct(c) ispunct((unsigned char)(c))
148#define qemu_isspace(c) isspace((unsigned char)(c))
149#define qemu_isupper(c) isupper((unsigned char)(c))
150#define qemu_isxdigit(c) isxdigit((unsigned char)(c))
151#define qemu_tolower(c) tolower((unsigned char)(c))
152#define qemu_toupper(c) toupper((unsigned char)(c))
153#define qemu_isascii(c) isascii((unsigned char)(c))
154#define qemu_toascii(c) toascii((unsigned char)(c))
155
aurel32ca10f862008-04-11 21:35:42 +0000156void *qemu_malloc(size_t size);
ths2137b4c2008-08-06 08:37:17 +0000157void *qemu_realloc(void *ptr, size_t size);
aurel32ca10f862008-04-11 21:35:42 +0000158void *qemu_mallocz(size_t size);
159void qemu_free(void *ptr);
160char *qemu_strdup(const char *str);
balrogac4b0d02008-11-09 00:28:40 +0000161char *qemu_strndup(const char *str, size_t size);
aurel32ca10f862008-04-11 21:35:42 +0000162
163void *get_mmap_addr(unsigned long size);
164
165
Glauber Costad549db52009-10-07 16:38:03 -0300166void qemu_mutex_lock_iothread(void);
167void qemu_mutex_unlock_iothread(void);
168
Kevin Wolf40ff6d72009-12-02 12:24:42 +0100169int qemu_open(const char *name, int flags, ...);
Juan Quintela7c7c0622010-01-20 00:56:09 +0100170ssize_t qemu_write_full(int fd, const void *buf, size_t count)
171 QEMU_WARN_UNUSED_RESULT;
Kevin Wolf40ff6d72009-12-02 12:24:42 +0100172void qemu_set_cloexec(int fd);
173
174#ifndef _WIN32
Paolo Bonzinif3dfda62010-02-11 00:23:46 +0100175int qemu_eventfd(int pipefd[2]);
Kevin Wolf40ff6d72009-12-02 12:24:42 +0100176int qemu_pipe(int pipefd[2]);
177#endif
178
pbrook87ecb682007-11-17 17:14:51 +0000179/* Error handling. */
180
malca5e50b22009-02-01 22:19:27 +0000181void QEMU_NORETURN hw_error(const char *fmt, ...)
blueswir17d99a002009-01-14 19:00:36 +0000182 __attribute__ ((__format__ (__printf__, 1, 2)));
pbrook87ecb682007-11-17 17:14:51 +0000183
184/* IO callbacks. */
185typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size);
186typedef int IOCanRWHandler(void *opaque);
187typedef void IOHandler(void *opaque);
188
189struct ParallelIOArg {
190 void *buffer;
191 int count;
192};
193
194typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
195
196/* A load of opaque types so that device init declarations don't have to
197 pull in all the real definitions. */
198typedef struct NICInfo NICInfo;
balrog1ae26a12008-09-28 23:19:47 +0000199typedef struct HCIInfo HCIInfo;
pbrook87ecb682007-11-17 17:14:51 +0000200typedef struct AudioState AudioState;
201typedef struct BlockDriverState BlockDriverState;
202typedef struct DisplayState DisplayState;
aliguori7d957bd2009-01-15 22:14:11 +0000203typedef struct DisplayChangeListener DisplayChangeListener;
204typedef struct DisplaySurface DisplaySurface;
aliguori7b5d76d2009-03-13 15:02:13 +0000205typedef struct DisplayAllocator DisplayAllocator;
aliguori7d957bd2009-01-15 22:14:11 +0000206typedef struct PixelFormat PixelFormat;
pbrook87ecb682007-11-17 17:14:51 +0000207typedef struct TextConsole TextConsole;
pbrookc60e08d2008-07-01 16:24:38 +0000208typedef TextConsole QEMUConsole;
pbrook87ecb682007-11-17 17:14:51 +0000209typedef struct CharDriverState CharDriverState;
Gerd Hoffmann76d32cb2009-10-21 15:25:22 +0200210typedef struct MACAddr MACAddr;
pbrook87ecb682007-11-17 17:14:51 +0000211typedef struct VLANState VLANState;
Mark McLoughlinf7105842009-10-08 19:58:31 +0100212typedef struct VLANClientState VLANClientState;
pbrook87ecb682007-11-17 17:14:51 +0000213typedef struct QEMUFile QEMUFile;
214typedef struct i2c_bus i2c_bus;
215typedef struct i2c_slave i2c_slave;
216typedef struct SMBusDevice SMBusDevice;
217typedef struct QEMUTimer QEMUTimer;
Isaku Yamahatafb47a2e2009-11-12 14:58:41 +0900218typedef struct PCIHostState PCIHostState;
219typedef struct PCIExpressHost PCIExpressHost;
pbrook87ecb682007-11-17 17:14:51 +0000220typedef struct PCIBus PCIBus;
221typedef struct PCIDevice PCIDevice;
222typedef struct SerialState SerialState;
223typedef struct IRQState *qemu_irq;
Paul Brookbc24a222009-05-10 01:44:56 +0100224typedef struct PCMCIACardState PCMCIACardState;
225typedef struct MouseTransformInfo MouseTransformInfo;
226typedef struct uWireSlave uWireSlave;
227typedef struct I2SCodec I2SCodec;
Paul Brookaae94602009-05-14 22:35:06 +0100228typedef struct DeviceState DeviceState;
Paul Brook90d37232009-05-14 22:35:09 +0100229typedef struct SSIBus SSIBus;
pbrook87ecb682007-11-17 17:14:51 +0000230
Michael S. Tsirkin186993e2010-02-10 21:25:42 +0200231typedef uint64_t pcibus_t;
232
pbrookb3c77242008-06-30 16:31:04 +0000233/* CPU save/load. */
234void cpu_save(QEMUFile *f, void *opaque);
235int cpu_load(QEMUFile *f, void *opaque, int version_id);
236
aliguori9e472e12008-10-08 19:50:24 +0000237/* Force QEMU to stop what it's doing and service IO */
238void qemu_service_io(void);
239
aliguorid9f75a42009-04-24 18:03:11 +0000240/* Force QEMU to process pending events */
241void qemu_notify_event(void);
242
aliguori8edac962009-04-24 18:03:45 +0000243/* Unblock cpu */
244void qemu_cpu_kick(void *env);
245int qemu_cpu_self(void *env);
246
aliguori0bf46a42009-04-24 18:03:41 +0000247#ifdef CONFIG_USER_ONLY
248#define qemu_init_vcpu(env) do { } while (0)
249#else
250void qemu_init_vcpu(void *env);
251#endif
252
aliguori44e3ee82009-01-22 16:59:20 +0000253typedef struct QEMUIOVector {
254 struct iovec *iov;
255 int niov;
256 int nalloc;
aliguori249aa742009-01-26 17:17:52 +0000257 size_t size;
aliguori44e3ee82009-01-22 16:59:20 +0000258} QEMUIOVector;
259
260void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
aliguori522584a2009-03-28 17:46:10 +0000261void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
aliguori44e3ee82009-01-22 16:59:20 +0000262void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
Kevin Wolf40b4f532009-09-09 17:53:37 +0200263void qemu_iovec_concat(QEMUIOVector *dst, QEMUIOVector *src, size_t size);
aliguori44e3ee82009-01-22 16:59:20 +0000264void qemu_iovec_destroy(QEMUIOVector *qiov);
aliguoribe959462009-02-05 21:23:54 +0000265void qemu_iovec_reset(QEMUIOVector *qiov);
aliguori44e3ee82009-01-22 16:59:20 +0000266void qemu_iovec_to_buffer(QEMUIOVector *qiov, void *buf);
aliguori249aa742009-01-26 17:17:52 +0000267void qemu_iovec_from_buffer(QEMUIOVector *qiov, const void *buf, size_t count);
aliguori44e3ee82009-01-22 16:59:20 +0000268
aliguori376253e2009-03-05 23:01:23 +0000269struct Monitor;
270typedef struct Monitor Monitor;
271
Paul Brookabd0c6b2009-11-20 00:03:47 +0000272/* Convert a byte between binary and BCD. */
273static inline uint8_t to_bcd(uint8_t val)
274{
275 return ((val / 10) << 4) | (val % 10);
276}
277
278static inline uint8_t from_bcd(uint8_t val)
279{
280 return ((val >> 4) * 10) + (val & 0x0f);
281}
282
Anthony Liguori0bfe3ca2009-05-14 19:29:53 +0100283#include "module.h"
284
blueswir17d99a002009-01-14 19:00:36 +0000285#endif /* dyngen-exec.h hack */
286
pbrookfaf07962007-11-11 02:51:17 +0000287#endif