Documentation: Add missing texi description for command line options
[qemu/ar7.git] / qemu-common.h
blobae4f23b8e866b058bb7c6027fdb3b22a0e2b62d7
1 /* Common header file that is included by all of qemu. */
2 #ifndef QEMU_COMMON_H
3 #define QEMU_COMMON_H
5 #include "config-host.h"
7 #define QEMU_NORETURN __attribute__ ((__noreturn__))
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
14 /* Hack around the mess dyngen-exec.h causes: We need QEMU_NORETURN in files that
15 cannot include the following headers without conflicts. This condition has
16 to be removed once dyngen is gone. */
17 #ifndef __DYNGEN_EXEC_H__
19 /* we put basic includes here to avoid repeating them in device drivers */
20 #include <stdlib.h>
21 #include <stdio.h>
22 #include <stdarg.h>
23 #include <string.h>
24 #include <strings.h>
25 #include <inttypes.h>
26 #include <limits.h>
27 #include <time.h>
28 #include <ctype.h>
29 #include <errno.h>
30 #include <unistd.h>
31 #include <fcntl.h>
32 #include <sys/stat.h>
33 #include <assert.h>
35 #ifndef O_LARGEFILE
36 #define O_LARGEFILE 0
37 #endif
38 #ifndef O_BINARY
39 #define O_BINARY 0
40 #endif
41 #ifndef MAP_ANONYMOUS
42 #define MAP_ANONYMOUS MAP_ANON
43 #endif
44 #ifndef ENOMEDIUM
45 #define ENOMEDIUM ENODEV
46 #endif
47 #if !defined(ENOTSUP)
48 #define ENOTSUP 4096
49 #endif
51 #ifndef CONFIG_IOVEC
52 #define CONFIG_IOVEC
53 struct iovec {
54 void *iov_base;
55 size_t iov_len;
57 #else
58 #include <sys/uio.h>
59 #endif
61 #ifdef _WIN32
62 #define fsync _commit
63 #define lseek _lseeki64
64 extern int qemu_ftruncate64(int, int64_t);
65 #define ftruncate qemu_ftruncate64
67 static inline char *realpath(const char *path, char *resolved_path)
69 _fullpath(resolved_path, path, _MAX_PATH);
70 return resolved_path;
73 #define PRId64 "I64d"
74 #define PRIx64 "I64x"
75 #define PRIu64 "I64u"
76 #define PRIo64 "I64o"
77 #endif
79 /* FIXME: Remove NEED_CPU_H. */
80 #ifndef NEED_CPU_H
82 #include <setjmp.h>
83 #include "osdep.h"
84 #include "bswap.h"
86 #else
88 #include "cpu.h"
90 #endif /* !defined(NEED_CPU_H) */
92 /* bottom halves */
93 typedef struct QEMUBH QEMUBH;
95 typedef void QEMUBHFunc(void *opaque);
97 void async_context_push(void);
98 void async_context_pop(void);
99 int get_async_context_id(void);
101 QEMUBH *qemu_bh_new(QEMUBHFunc *cb, void *opaque);
102 void qemu_bh_schedule(QEMUBH *bh);
103 /* Bottom halfs that are scheduled from a bottom half handler are instantly
104 * invoked. This can create an infinite loop if a bottom half handler
105 * schedules itself. qemu_bh_schedule_idle() avoids this infinite loop by
106 * ensuring that the bottom half isn't executed until the next main loop
107 * iteration.
109 void qemu_bh_schedule_idle(QEMUBH *bh);
110 void qemu_bh_cancel(QEMUBH *bh);
111 void qemu_bh_delete(QEMUBH *bh);
112 int qemu_bh_poll(void);
113 void qemu_bh_update_timeout(int *timeout);
115 uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c);
117 void qemu_get_timedate(struct tm *tm, int offset);
118 int qemu_timedate_diff(struct tm *tm);
120 /* cutils.c */
121 void pstrcpy(char *buf, int buf_size, const char *str);
122 char *pstrcat(char *buf, int buf_size, const char *s);
123 int strstart(const char *str, const char *val, const char **ptr);
124 int stristart(const char *str, const char *val, const char **ptr);
125 int qemu_strnlen(const char *s, int max_len);
126 time_t mktimegm(struct tm *tm);
127 int qemu_fls(int i);
128 int qemu_fdatasync(int fd);
130 /* path.c */
131 void init_paths(const char *prefix);
132 const char *path(const char *pathname);
134 #define qemu_isalnum(c) isalnum((unsigned char)(c))
135 #define qemu_isalpha(c) isalpha((unsigned char)(c))
136 #define qemu_iscntrl(c) iscntrl((unsigned char)(c))
137 #define qemu_isdigit(c) isdigit((unsigned char)(c))
138 #define qemu_isgraph(c) isgraph((unsigned char)(c))
139 #define qemu_islower(c) islower((unsigned char)(c))
140 #define qemu_isprint(c) isprint((unsigned char)(c))
141 #define qemu_ispunct(c) ispunct((unsigned char)(c))
142 #define qemu_isspace(c) isspace((unsigned char)(c))
143 #define qemu_isupper(c) isupper((unsigned char)(c))
144 #define qemu_isxdigit(c) isxdigit((unsigned char)(c))
145 #define qemu_tolower(c) tolower((unsigned char)(c))
146 #define qemu_toupper(c) toupper((unsigned char)(c))
147 #define qemu_isascii(c) isascii((unsigned char)(c))
148 #define qemu_toascii(c) toascii((unsigned char)(c))
150 void *qemu_malloc(size_t size);
151 void *qemu_realloc(void *ptr, size_t size);
152 void *qemu_mallocz(size_t size);
153 void qemu_free(void *ptr);
154 char *qemu_strdup(const char *str);
155 char *qemu_strndup(const char *str, size_t size);
157 void *get_mmap_addr(unsigned long size);
160 void qemu_mutex_lock_iothread(void);
161 void qemu_mutex_unlock_iothread(void);
163 int qemu_open(const char *name, int flags, ...);
164 ssize_t qemu_write_full(int fd, const void *buf, size_t count)
165 QEMU_WARN_UNUSED_RESULT;
166 void qemu_set_cloexec(int fd);
168 #ifndef _WIN32
169 int qemu_pipe(int pipefd[2]);
170 #endif
172 /* Error handling. */
174 void QEMU_NORETURN hw_error(const char *fmt, ...)
175 __attribute__ ((__format__ (__printf__, 1, 2)));
177 /* IO callbacks. */
178 typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size);
179 typedef int IOCanRWHandler(void *opaque);
180 typedef void IOHandler(void *opaque);
182 struct ParallelIOArg {
183 void *buffer;
184 int count;
187 typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
189 /* A load of opaque types so that device init declarations don't have to
190 pull in all the real definitions. */
191 typedef struct NICInfo NICInfo;
192 typedef struct HCIInfo HCIInfo;
193 typedef struct AudioState AudioState;
194 typedef struct BlockDriverState BlockDriverState;
195 typedef struct DisplayState DisplayState;
196 typedef struct DisplayChangeListener DisplayChangeListener;
197 typedef struct DisplaySurface DisplaySurface;
198 typedef struct DisplayAllocator DisplayAllocator;
199 typedef struct PixelFormat PixelFormat;
200 typedef struct TextConsole TextConsole;
201 typedef TextConsole QEMUConsole;
202 typedef struct CharDriverState CharDriverState;
203 typedef struct MACAddr MACAddr;
204 typedef struct VLANState VLANState;
205 typedef struct VLANClientState VLANClientState;
206 typedef struct QEMUFile QEMUFile;
207 typedef struct i2c_bus i2c_bus;
208 typedef struct i2c_slave i2c_slave;
209 typedef struct SMBusDevice SMBusDevice;
210 typedef struct QEMUTimer QEMUTimer;
211 typedef struct PCIHostState PCIHostState;
212 typedef struct PCIExpressHost PCIExpressHost;
213 typedef struct PCIBus PCIBus;
214 typedef struct PCIDevice PCIDevice;
215 typedef struct SerialState SerialState;
216 typedef struct IRQState *qemu_irq;
217 typedef struct PCMCIACardState PCMCIACardState;
218 typedef struct MouseTransformInfo MouseTransformInfo;
219 typedef struct uWireSlave uWireSlave;
220 typedef struct I2SCodec I2SCodec;
221 typedef struct DeviceState DeviceState;
222 typedef struct SSIBus SSIBus;
224 /* CPU save/load. */
225 void cpu_save(QEMUFile *f, void *opaque);
226 int cpu_load(QEMUFile *f, void *opaque, int version_id);
228 /* Force QEMU to stop what it's doing and service IO */
229 void qemu_service_io(void);
231 /* Force QEMU to process pending events */
232 void qemu_notify_event(void);
234 /* Unblock cpu */
235 void qemu_cpu_kick(void *env);
236 int qemu_cpu_self(void *env);
238 #ifdef CONFIG_USER_ONLY
239 #define qemu_init_vcpu(env) do { } while (0)
240 #else
241 void qemu_init_vcpu(void *env);
242 #endif
244 typedef struct QEMUIOVector {
245 struct iovec *iov;
246 int niov;
247 int nalloc;
248 size_t size;
249 } QEMUIOVector;
251 void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
252 void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
253 void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
254 void qemu_iovec_concat(QEMUIOVector *dst, QEMUIOVector *src, size_t size);
255 void qemu_iovec_destroy(QEMUIOVector *qiov);
256 void qemu_iovec_reset(QEMUIOVector *qiov);
257 void qemu_iovec_to_buffer(QEMUIOVector *qiov, void *buf);
258 void qemu_iovec_from_buffer(QEMUIOVector *qiov, const void *buf, size_t count);
260 struct Monitor;
261 typedef struct Monitor Monitor;
263 /* Convert a byte between binary and BCD. */
264 static inline uint8_t to_bcd(uint8_t val)
266 return ((val / 10) << 4) | (val % 10);
269 static inline uint8_t from_bcd(uint8_t val)
271 return ((val >> 4) * 10) + (val & 0x0f);
274 #include "module.h"
276 #endif /* dyngen-exec.h hack */
278 #endif