blob: a4888e5e5cdbd27c665e29671926c2f809975397 [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
Blue Swirl29e922b2010-03-29 19:24:00 +000016typedef struct QEMUTimer QEMUTimer;
17typedef struct QEMUFile QEMUFile;
18typedef struct QEMUBH QEMUBH;
19
malca5e50b22009-02-01 22:19:27 +000020/* Hack around the mess dyngen-exec.h causes: We need QEMU_NORETURN in files that
blueswir17d99a002009-01-14 19:00:36 +000021 cannot include the following headers without conflicts. This condition has
22 to be removed once dyngen is gone. */
23#ifndef __DYNGEN_EXEC_H__
24
pbrookfaf07962007-11-11 02:51:17 +000025/* we put basic includes here to avoid repeating them in device drivers */
26#include <stdlib.h>
27#include <stdio.h>
28#include <stdarg.h>
29#include <string.h>
balrogc8906842008-11-12 17:18:41 +000030#include <strings.h>
pbrookfaf07962007-11-11 02:51:17 +000031#include <inttypes.h>
32#include <limits.h>
33#include <time.h>
34#include <ctype.h>
35#include <errno.h>
36#include <unistd.h>
37#include <fcntl.h>
38#include <sys/stat.h>
Paul Brook55616502009-05-13 20:51:49 +010039#include <assert.h>
pbrookfaf07962007-11-11 02:51:17 +000040
41#ifndef O_LARGEFILE
42#define O_LARGEFILE 0
43#endif
44#ifndef O_BINARY
45#define O_BINARY 0
46#endif
Juan Quintela0e74e662009-07-27 16:12:57 +020047#ifndef MAP_ANONYMOUS
48#define MAP_ANONYMOUS MAP_ANON
49#endif
pbrookfaf07962007-11-11 02:51:17 +000050#ifndef ENOMEDIUM
51#define ENOMEDIUM ENODEV
52#endif
Anthony Liguori4c955382009-07-28 15:48:31 -050053#if !defined(ENOTSUP)
Juan Quintela2880bc32009-07-27 16:13:22 +020054#define ENOTSUP 4096
55#endif
pbrookfaf07962007-11-11 02:51:17 +000056
Juan Quintela6114fdb2009-07-27 16:12:59 +020057#ifndef CONFIG_IOVEC
58#define CONFIG_IOVEC
aliguoribf9298b2008-12-05 20:05:26 +000059struct iovec {
60 void *iov_base;
61 size_t iov_len;
62};
Christoph Hellwige2a305f2010-01-26 14:49:08 +010063/*
64 * Use the same value as Linux for now.
65 */
66#define IOV_MAX 1024
blueswir1331dadd2008-12-06 19:44:56 +000067#else
68#include <sys/uio.h>
aliguoribf9298b2008-12-05 20:05:26 +000069#endif
70
pbrookfaf07962007-11-11 02:51:17 +000071#ifdef _WIN32
pbrookfaf07962007-11-11 02:51:17 +000072#define fsync _commit
73#define lseek _lseeki64
pbrookfaf07962007-11-11 02:51:17 +000074extern int qemu_ftruncate64(int, int64_t);
75#define ftruncate qemu_ftruncate64
76
pbrookfaf07962007-11-11 02:51:17 +000077static inline char *realpath(const char *path, char *resolved_path)
78{
79 _fullpath(resolved_path, path, _MAX_PATH);
80 return resolved_path;
81}
82
83#define PRId64 "I64d"
84#define PRIx64 "I64x"
85#define PRIu64 "I64u"
86#define PRIo64 "I64o"
87#endif
88
89/* FIXME: Remove NEED_CPU_H. */
90#ifndef NEED_CPU_H
91
pbrookfaf07962007-11-11 02:51:17 +000092#include <setjmp.h>
93#include "osdep.h"
94#include "bswap.h"
95
96#else
97
98#include "cpu.h"
99
100#endif /* !defined(NEED_CPU_H) */
101
102/* bottom halves */
pbrookfaf07962007-11-11 02:51:17 +0000103typedef void QEMUBHFunc(void *opaque);
104
Kevin Wolf9a1e9482009-10-22 17:54:38 +0200105void async_context_push(void);
106void async_context_pop(void);
107int get_async_context_id(void);
108
pbrookfaf07962007-11-11 02:51:17 +0000109QEMUBH *qemu_bh_new(QEMUBHFunc *cb, void *opaque);
110void qemu_bh_schedule(QEMUBH *bh);
aliguori80d35802008-10-31 17:42:00 +0000111/* Bottom halfs that are scheduled from a bottom half handler are instantly
112 * invoked. This can create an infinite loop if a bottom half handler
113 * schedules itself. qemu_bh_schedule_idle() avoids this infinite loop by
114 * ensuring that the bottom half isn't executed until the next main loop
115 * iteration.
116 */
aliguori1b435b12008-10-31 17:24:21 +0000117void qemu_bh_schedule_idle(QEMUBH *bh);
pbrookfaf07962007-11-11 02:51:17 +0000118void qemu_bh_cancel(QEMUBH *bh);
119void qemu_bh_delete(QEMUBH *bh);
120int qemu_bh_poll(void);
Kevin Wolf4f999d02009-10-22 17:54:37 +0200121void qemu_bh_update_timeout(int *timeout);
pbrookfaf07962007-11-11 02:51:17 +0000122
pbrook87ecb682007-11-17 17:14:51 +0000123uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c);
124
balrogf6503052008-02-17 11:42:19 +0000125void qemu_get_timedate(struct tm *tm, int offset);
126int qemu_timedate_diff(struct tm *tm);
127
pbrookfaf07962007-11-11 02:51:17 +0000128/* cutils.c */
129void pstrcpy(char *buf, int buf_size, const char *str);
130char *pstrcat(char *buf, int buf_size, const char *s);
131int strstart(const char *str, const char *val, const char **ptr);
132int stristart(const char *str, const char *val, const char **ptr);
Blue Swirld43277c2009-07-01 18:24:44 +0000133int qemu_strnlen(const char *s, int max_len);
pbrookfaf07962007-11-11 02:51:17 +0000134time_t mktimegm(struct tm *tm);
blueswir1ad46db92008-12-11 19:37:54 +0000135int qemu_fls(int i);
Christoph Hellwig6f1953c2009-09-04 19:01:32 +0200136int qemu_fdatasync(int fd);
Paolo Bonzinidb1a4972010-03-10 11:38:55 +0100137int fcntl_setfl(int fd, int flag);
pbrookfaf07962007-11-11 02:51:17 +0000138
Blue Swirl37022082009-08-15 07:51:59 +0000139/* path.c */
140void init_paths(const char *prefix);
141const char *path(const char *pathname);
142
blueswir1cd390082008-11-16 13:53:32 +0000143#define qemu_isalnum(c) isalnum((unsigned char)(c))
144#define qemu_isalpha(c) isalpha((unsigned char)(c))
145#define qemu_iscntrl(c) iscntrl((unsigned char)(c))
146#define qemu_isdigit(c) isdigit((unsigned char)(c))
147#define qemu_isgraph(c) isgraph((unsigned char)(c))
148#define qemu_islower(c) islower((unsigned char)(c))
149#define qemu_isprint(c) isprint((unsigned char)(c))
150#define qemu_ispunct(c) ispunct((unsigned char)(c))
151#define qemu_isspace(c) isspace((unsigned char)(c))
152#define qemu_isupper(c) isupper((unsigned char)(c))
153#define qemu_isxdigit(c) isxdigit((unsigned char)(c))
154#define qemu_tolower(c) tolower((unsigned char)(c))
155#define qemu_toupper(c) toupper((unsigned char)(c))
156#define qemu_isascii(c) isascii((unsigned char)(c))
157#define qemu_toascii(c) toascii((unsigned char)(c))
158
aurel32ca10f862008-04-11 21:35:42 +0000159void *qemu_malloc(size_t size);
ths2137b4c2008-08-06 08:37:17 +0000160void *qemu_realloc(void *ptr, size_t size);
aurel32ca10f862008-04-11 21:35:42 +0000161void *qemu_mallocz(size_t size);
162void qemu_free(void *ptr);
163char *qemu_strdup(const char *str);
balrogac4b0d02008-11-09 00:28:40 +0000164char *qemu_strndup(const char *str, size_t size);
aurel32ca10f862008-04-11 21:35:42 +0000165
166void *get_mmap_addr(unsigned long size);
167
168
Glauber Costad549db52009-10-07 16:38:03 -0300169void qemu_mutex_lock_iothread(void);
170void qemu_mutex_unlock_iothread(void);
171
Kevin Wolf40ff6d72009-12-02 12:24:42 +0100172int qemu_open(const char *name, int flags, ...);
Juan Quintela7c7c0622010-01-20 00:56:09 +0100173ssize_t qemu_write_full(int fd, const void *buf, size_t count)
174 QEMU_WARN_UNUSED_RESULT;
Kevin Wolf40ff6d72009-12-02 12:24:42 +0100175void qemu_set_cloexec(int fd);
176
177#ifndef _WIN32
Paolo Bonzinif3dfda62010-02-11 00:23:46 +0100178int qemu_eventfd(int pipefd[2]);
Kevin Wolf40ff6d72009-12-02 12:24:42 +0100179int qemu_pipe(int pipefd[2]);
180#endif
181
pbrook87ecb682007-11-17 17:14:51 +0000182/* Error handling. */
183
malca5e50b22009-02-01 22:19:27 +0000184void QEMU_NORETURN hw_error(const char *fmt, ...)
blueswir17d99a002009-01-14 19:00:36 +0000185 __attribute__ ((__format__ (__printf__, 1, 2)));
pbrook87ecb682007-11-17 17:14:51 +0000186
187/* IO callbacks. */
188typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size);
Juan Quintela7b27a762010-03-11 17:55:39 +0100189typedef int IOCanReadHandler(void *opaque);
pbrook87ecb682007-11-17 17:14:51 +0000190typedef void IOHandler(void *opaque);
191
192struct ParallelIOArg {
193 void *buffer;
194 int count;
195};
196
197typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
198
199/* A load of opaque types so that device init declarations don't have to
200 pull in all the real definitions. */
201typedef struct NICInfo NICInfo;
balrog1ae26a12008-09-28 23:19:47 +0000202typedef struct HCIInfo HCIInfo;
pbrook87ecb682007-11-17 17:14:51 +0000203typedef struct AudioState AudioState;
204typedef struct BlockDriverState BlockDriverState;
205typedef struct DisplayState DisplayState;
aliguori7d957bd2009-01-15 22:14:11 +0000206typedef struct DisplayChangeListener DisplayChangeListener;
207typedef struct DisplaySurface DisplaySurface;
aliguori7b5d76d2009-03-13 15:02:13 +0000208typedef struct DisplayAllocator DisplayAllocator;
aliguori7d957bd2009-01-15 22:14:11 +0000209typedef struct PixelFormat PixelFormat;
pbrook87ecb682007-11-17 17:14:51 +0000210typedef struct TextConsole TextConsole;
pbrookc60e08d2008-07-01 16:24:38 +0000211typedef TextConsole QEMUConsole;
pbrook87ecb682007-11-17 17:14:51 +0000212typedef struct CharDriverState CharDriverState;
Gerd Hoffmann76d32cb2009-10-21 15:25:22 +0200213typedef struct MACAddr MACAddr;
pbrook87ecb682007-11-17 17:14:51 +0000214typedef struct VLANState VLANState;
Mark McLoughlinf7105842009-10-08 19:58:31 +0100215typedef struct VLANClientState VLANClientState;
pbrook87ecb682007-11-17 17:14:51 +0000216typedef struct i2c_bus i2c_bus;
217typedef struct i2c_slave i2c_slave;
218typedef struct SMBusDevice SMBusDevice;
Isaku Yamahatafb47a2e2009-11-12 14:58:41 +0900219typedef struct PCIHostState PCIHostState;
220typedef struct PCIExpressHost PCIExpressHost;
pbrook87ecb682007-11-17 17:14:51 +0000221typedef struct PCIBus PCIBus;
222typedef struct PCIDevice PCIDevice;
223typedef struct SerialState SerialState;
224typedef struct IRQState *qemu_irq;
Paul Brookbc24a222009-05-10 01:44:56 +0100225typedef struct PCMCIACardState PCMCIACardState;
226typedef struct MouseTransformInfo MouseTransformInfo;
227typedef struct uWireSlave uWireSlave;
228typedef struct I2SCodec I2SCodec;
Paul Brookaae94602009-05-14 22:35:06 +0100229typedef struct DeviceState DeviceState;
Paul Brook90d37232009-05-14 22:35:09 +0100230typedef struct SSIBus SSIBus;
Michael S. Tsirkin2292b332010-03-17 13:07:58 +0200231typedef struct EventNotifier EventNotifier;
Michael S. Tsirkin2be24aa2010-03-17 13:08:10 +0200232typedef struct VirtIODevice VirtIODevice;
pbrook87ecb682007-11-17 17:14:51 +0000233
Michael S. Tsirkin186993e2010-02-10 21:25:42 +0200234typedef uint64_t pcibus_t;
235
Blue Swirld2053c32010-03-29 19:23:48 +0000236void cpu_exec_init_all(unsigned long tb_size);
237
pbrookb3c77242008-06-30 16:31:04 +0000238/* CPU save/load. */
239void cpu_save(QEMUFile *f, void *opaque);
240int cpu_load(QEMUFile *f, void *opaque, int version_id);
241
aliguori9e472e12008-10-08 19:50:24 +0000242/* Force QEMU to stop what it's doing and service IO */
243void qemu_service_io(void);
244
aliguorid9f75a42009-04-24 18:03:11 +0000245/* Force QEMU to process pending events */
246void qemu_notify_event(void);
247
aliguori8edac962009-04-24 18:03:45 +0000248/* Unblock cpu */
249void qemu_cpu_kick(void *env);
250int qemu_cpu_self(void *env);
251
Marcelo Tosattie82bcec2010-05-04 09:45:22 -0300252/* work queue */
253struct qemu_work_item {
254 struct qemu_work_item *next;
255 void (*func)(void *data);
256 void *data;
257 int done;
258};
259
aliguori0bf46a42009-04-24 18:03:41 +0000260#ifdef CONFIG_USER_ONLY
261#define qemu_init_vcpu(env) do { } while (0)
262#else
263void qemu_init_vcpu(void *env);
264#endif
265
aliguori44e3ee82009-01-22 16:59:20 +0000266typedef struct QEMUIOVector {
267 struct iovec *iov;
268 int niov;
269 int nalloc;
aliguori249aa742009-01-26 17:17:52 +0000270 size_t size;
aliguori44e3ee82009-01-22 16:59:20 +0000271} QEMUIOVector;
272
273void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
aliguori522584a2009-03-28 17:46:10 +0000274void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
aliguori44e3ee82009-01-22 16:59:20 +0000275void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
Kevin Wolf40b4f532009-09-09 17:53:37 +0200276void qemu_iovec_concat(QEMUIOVector *dst, QEMUIOVector *src, size_t size);
aliguori44e3ee82009-01-22 16:59:20 +0000277void qemu_iovec_destroy(QEMUIOVector *qiov);
aliguoribe959462009-02-05 21:23:54 +0000278void qemu_iovec_reset(QEMUIOVector *qiov);
aliguori44e3ee82009-01-22 16:59:20 +0000279void qemu_iovec_to_buffer(QEMUIOVector *qiov, void *buf);
aliguori249aa742009-01-26 17:17:52 +0000280void qemu_iovec_from_buffer(QEMUIOVector *qiov, const void *buf, size_t count);
aliguori44e3ee82009-01-22 16:59:20 +0000281
aliguori376253e2009-03-05 23:01:23 +0000282struct Monitor;
283typedef struct Monitor Monitor;
284
Paul Brookabd0c6b2009-11-20 00:03:47 +0000285/* Convert a byte between binary and BCD. */
286static inline uint8_t to_bcd(uint8_t val)
287{
288 return ((val / 10) << 4) | (val % 10);
289}
290
291static inline uint8_t from_bcd(uint8_t val)
292{
293 return ((val >> 4) * 10) + (val & 0x0f);
294}
295
Anthony Liguori0bfe3ca2009-05-14 19:29:53 +0100296#include "module.h"
297
blueswir17d99a002009-01-14 19:00:36 +0000298#endif /* dyngen-exec.h hack */
299
pbrookfaf07962007-11-11 02:51:17 +0000300#endif