vga: improve documentation
[qemu.git] / qemu-common.h
1 /* Common header file that is included by all of qemu. */
2 #ifndef QEMU_COMMON_H
3 #define QEMU_COMMON_H
4
5 #include "compiler.h"
6 #include "config-host.h"
7
8 #if defined(__arm__) || defined(__sparc__) || defined(__mips__) || defined(__hppa__) || defined(__ia64__)
9 #define WORDS_ALIGNED
10 #endif
11
12 #define TFR(expr) do { if ((expr) != -1) break; } while (errno == EINTR)
13
14 typedef struct QEMUTimer QEMUTimer;
15 typedef struct QEMUFile QEMUFile;
16 typedef struct DeviceState DeviceState;
17
18 struct Monitor;
19 typedef struct Monitor Monitor;
20
21 /* 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 <stdbool.h>
26 #include <string.h>
27 #include <strings.h>
28 #include <inttypes.h>
29 #include <limits.h>
30 #include <time.h>
31 #include <ctype.h>
32 #include <errno.h>
33 #include <unistd.h>
34 #include <fcntl.h>
35 #include <sys/stat.h>
36 #include <sys/time.h>
37 #include <assert.h>
38 #include <signal.h>
39 #include <glib.h>
40
41 #ifdef _WIN32
42 #include "qemu-os-win32.h"
43 #endif
44
45 #ifdef CONFIG_POSIX
46 #include "qemu-os-posix.h"
47 #endif
48
49 #ifndef O_LARGEFILE
50 #define O_LARGEFILE 0
51 #endif
52 #ifndef O_BINARY
53 #define O_BINARY 0
54 #endif
55 #ifndef MAP_ANONYMOUS
56 #define MAP_ANONYMOUS MAP_ANON
57 #endif
58 #ifndef ENOMEDIUM
59 #define ENOMEDIUM ENODEV
60 #endif
61 #if !defined(ENOTSUP)
62 #define ENOTSUP 4096
63 #endif
64 #ifndef TIME_MAX
65 #define TIME_MAX LONG_MAX
66 #endif
67
68 #ifndef CONFIG_IOVEC
69 #define CONFIG_IOVEC
70 struct iovec {
71 void *iov_base;
72 size_t iov_len;
73 };
74 /*
75 * Use the same value as Linux for now.
76 */
77 #define IOV_MAX 1024
78 #else
79 #include <sys/uio.h>
80 #endif
81
82 typedef int (*fprintf_function)(FILE *f, const char *fmt, ...)
83 GCC_FMT_ATTR(2, 3);
84
85 #ifdef _WIN32
86 #define fsync _commit
87 #define lseek _lseeki64
88 int qemu_ftruncate64(int, int64_t);
89 #define ftruncate qemu_ftruncate64
90
91 static inline char *realpath(const char *path, char *resolved_path)
92 {
93 _fullpath(resolved_path, path, _MAX_PATH);
94 return resolved_path;
95 }
96 #endif
97
98 /* icount */
99 void configure_icount(const char *option);
100 extern int use_icount;
101
102 /* FIXME: Remove NEED_CPU_H. */
103 #ifndef NEED_CPU_H
104
105 #include "osdep.h"
106 #include "bswap.h"
107
108 #else
109
110 #include "cpu.h"
111
112 #endif /* !defined(NEED_CPU_H) */
113
114 /* main function, renamed */
115 #if defined(CONFIG_COCOA)
116 int qemu_main(int argc, char **argv, char **envp);
117 #endif
118
119 void qemu_get_timedate(struct tm *tm, int offset);
120 int qemu_timedate_diff(struct tm *tm);
121
122 /* cutils.c */
123 void pstrcpy(char *buf, int buf_size, const char *str);
124 char *pstrcat(char *buf, int buf_size, const char *s);
125 int strstart(const char *str, const char *val, const char **ptr);
126 int stristart(const char *str, const char *val, const char **ptr);
127 int qemu_strnlen(const char *s, int max_len);
128 time_t mktimegm(struct tm *tm);
129 int qemu_fls(int i);
130 int qemu_fdatasync(int fd);
131 int fcntl_setfl(int fd, int flag);
132 int qemu_parse_fd(const char *param);
133
134 /*
135 * strtosz() suffixes used to specify the default treatment of an
136 * argument passed to strtosz() without an explicit suffix.
137 * These should be defined using upper case characters in the range
138 * A-Z, as strtosz() will use qemu_toupper() on the given argument
139 * prior to comparison.
140 */
141 #define STRTOSZ_DEFSUFFIX_TB 'T'
142 #define STRTOSZ_DEFSUFFIX_GB 'G'
143 #define STRTOSZ_DEFSUFFIX_MB 'M'
144 #define STRTOSZ_DEFSUFFIX_KB 'K'
145 #define STRTOSZ_DEFSUFFIX_B 'B'
146 int64_t strtosz(const char *nptr, char **end);
147 int64_t strtosz_suffix(const char *nptr, char **end, const char default_suffix);
148 int64_t strtosz_suffix_unit(const char *nptr, char **end,
149 const char default_suffix, int64_t unit);
150
151 /* path.c */
152 void init_paths(const char *prefix);
153 const char *path(const char *pathname);
154
155 #define qemu_isalnum(c) isalnum((unsigned char)(c))
156 #define qemu_isalpha(c) isalpha((unsigned char)(c))
157 #define qemu_iscntrl(c) iscntrl((unsigned char)(c))
158 #define qemu_isdigit(c) isdigit((unsigned char)(c))
159 #define qemu_isgraph(c) isgraph((unsigned char)(c))
160 #define qemu_islower(c) islower((unsigned char)(c))
161 #define qemu_isprint(c) isprint((unsigned char)(c))
162 #define qemu_ispunct(c) ispunct((unsigned char)(c))
163 #define qemu_isspace(c) isspace((unsigned char)(c))
164 #define qemu_isupper(c) isupper((unsigned char)(c))
165 #define qemu_isxdigit(c) isxdigit((unsigned char)(c))
166 #define qemu_tolower(c) tolower((unsigned char)(c))
167 #define qemu_toupper(c) toupper((unsigned char)(c))
168 #define qemu_isascii(c) isascii((unsigned char)(c))
169 #define qemu_toascii(c) toascii((unsigned char)(c))
170
171 void *qemu_oom_check(void *ptr);
172
173 int qemu_open(const char *name, int flags, ...);
174 ssize_t qemu_write_full(int fd, const void *buf, size_t count)
175 QEMU_WARN_UNUSED_RESULT;
176 ssize_t qemu_send_full(int fd, const void *buf, size_t count, int flags)
177 QEMU_WARN_UNUSED_RESULT;
178 ssize_t qemu_recv_full(int fd, void *buf, size_t count, int flags)
179 QEMU_WARN_UNUSED_RESULT;
180 void qemu_set_cloexec(int fd);
181
182 #ifndef _WIN32
183 int qemu_eventfd(int pipefd[2]);
184 int qemu_pipe(int pipefd[2]);
185 #endif
186
187 #ifdef _WIN32
188 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags)
189 #else
190 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags)
191 #endif
192
193 int qemu_recvv(int sockfd, struct iovec *iov, int len, int iov_offset);
194 int qemu_sendv(int sockfd, struct iovec *iov, int len, int iov_offset);
195
196 /* Error handling. */
197
198 void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
199
200 struct ParallelIOArg {
201 void *buffer;
202 int count;
203 };
204
205 typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
206
207 /* A load of opaque types so that device init declarations don't have to
208 pull in all the real definitions. */
209 typedef struct NICInfo NICInfo;
210 typedef struct HCIInfo HCIInfo;
211 typedef struct AudioState AudioState;
212 typedef struct BlockDriverState BlockDriverState;
213 typedef struct DriveInfo DriveInfo;
214 typedef struct DisplayState DisplayState;
215 typedef struct DisplayChangeListener DisplayChangeListener;
216 typedef struct DisplaySurface DisplaySurface;
217 typedef struct DisplayAllocator DisplayAllocator;
218 typedef struct PixelFormat PixelFormat;
219 typedef struct TextConsole TextConsole;
220 typedef TextConsole QEMUConsole;
221 typedef struct CharDriverState CharDriverState;
222 typedef struct MACAddr MACAddr;
223 typedef struct VLANState VLANState;
224 typedef struct VLANClientState VLANClientState;
225 typedef struct i2c_bus i2c_bus;
226 typedef struct i2c_slave i2c_slave;
227 typedef struct ISABus ISABus;
228 typedef struct SMBusDevice SMBusDevice;
229 typedef struct PCIHostState PCIHostState;
230 typedef struct PCIExpressHost PCIExpressHost;
231 typedef struct PCIBus PCIBus;
232 typedef struct PCIDevice PCIDevice;
233 typedef struct PCIExpressDevice PCIExpressDevice;
234 typedef struct PCIBridge PCIBridge;
235 typedef struct PCIEAERMsg PCIEAERMsg;
236 typedef struct PCIEAERLog PCIEAERLog;
237 typedef struct PCIEAERErr PCIEAERErr;
238 typedef struct PCIEPort PCIEPort;
239 typedef struct PCIESlot PCIESlot;
240 typedef struct SerialState SerialState;
241 typedef struct IRQState *qemu_irq;
242 typedef struct PCMCIACardState PCMCIACardState;
243 typedef struct MouseTransformInfo MouseTransformInfo;
244 typedef struct uWireSlave uWireSlave;
245 typedef struct I2SCodec I2SCodec;
246 typedef struct SSIBus SSIBus;
247 typedef struct EventNotifier EventNotifier;
248 typedef struct VirtIODevice VirtIODevice;
249 typedef struct QEMUSGList QEMUSGList;
250
251 typedef uint64_t pcibus_t;
252
253 typedef enum LostTickPolicy {
254 LOST_TICK_DISCARD,
255 LOST_TICK_DELAY,
256 LOST_TICK_MERGE,
257 LOST_TICK_SLEW,
258 } LostTickPolicy;
259
260 void tcg_exec_init(unsigned long tb_size);
261 bool tcg_enabled(void);
262
263 void cpu_exec_init_all(void);
264
265 /* CPU save/load. */
266 void cpu_save(QEMUFile *f, void *opaque);
267 int cpu_load(QEMUFile *f, void *opaque, int version_id);
268
269 /* Unblock cpu */
270 void qemu_cpu_kick(void *env);
271 void qemu_cpu_kick_self(void);
272 int qemu_cpu_is_self(void *env);
273 bool all_cpu_threads_idle(void);
274
275 /* work queue */
276 struct qemu_work_item {
277 struct qemu_work_item *next;
278 void (*func)(void *data);
279 void *data;
280 int done;
281 };
282
283 #ifdef CONFIG_USER_ONLY
284 #define qemu_init_vcpu(env) do { } while (0)
285 #else
286 void qemu_init_vcpu(void *env);
287 #endif
288
289 /**
290 * Sends an iovec (or optionally a part of it) down a socket, yielding
291 * when the socket is full.
292 */
293 int qemu_co_sendv(int sockfd, struct iovec *iov,
294 int len, int iov_offset);
295
296 /**
297 * Receives data into an iovec (or optionally into a part of it) from
298 * a socket, yielding when there is no data in the socket.
299 */
300 int qemu_co_recvv(int sockfd, struct iovec *iov,
301 int len, int iov_offset);
302
303
304 /**
305 * Sends a buffer down a socket, yielding when the socket is full.
306 */
307 int qemu_co_send(int sockfd, void *buf, int len);
308
309 /**
310 * Receives data into a buffer from a socket, yielding when there
311 * is no data in the socket.
312 */
313 int qemu_co_recv(int sockfd, void *buf, int len);
314
315
316 typedef struct QEMUIOVector {
317 struct iovec *iov;
318 int niov;
319 int nalloc;
320 size_t size;
321 } QEMUIOVector;
322
323 void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
324 void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
325 void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
326 void qemu_iovec_copy(QEMUIOVector *dst, QEMUIOVector *src, uint64_t skip,
327 size_t size);
328 void qemu_iovec_concat(QEMUIOVector *dst, QEMUIOVector *src, size_t size);
329 void qemu_iovec_destroy(QEMUIOVector *qiov);
330 void qemu_iovec_reset(QEMUIOVector *qiov);
331 void qemu_iovec_to_buffer(QEMUIOVector *qiov, void *buf);
332 void qemu_iovec_from_buffer(QEMUIOVector *qiov, const void *buf, size_t count);
333 void qemu_iovec_memset(QEMUIOVector *qiov, int c, size_t count);
334 void qemu_iovec_memset_skip(QEMUIOVector *qiov, int c, size_t count,
335 size_t skip);
336
337 void qemu_progress_init(int enabled, float min_skip);
338 void qemu_progress_end(void);
339 void qemu_progress_print(float delta, int max);
340
341 #define QEMU_FILE_TYPE_BIOS 0
342 #define QEMU_FILE_TYPE_KEYMAP 1
343 char *qemu_find_file(int type, const char *name);
344
345 /* OS specific functions */
346 void os_setup_early_signal_handling(void);
347 char *os_find_datadir(const char *argv0);
348 void os_parse_cmd_args(int index, const char *optarg);
349 void os_pidfile_error(void);
350
351 /* Convert a byte between binary and BCD. */
352 static inline uint8_t to_bcd(uint8_t val)
353 {
354 return ((val / 10) << 4) | (val % 10);
355 }
356
357 static inline uint8_t from_bcd(uint8_t val)
358 {
359 return ((val >> 4) * 10) + (val & 0x0f);
360 }
361
362 /* compute with 96 bit intermediate result: (a*b)/c */
363 static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
364 {
365 union {
366 uint64_t ll;
367 struct {
368 #ifdef HOST_WORDS_BIGENDIAN
369 uint32_t high, low;
370 #else
371 uint32_t low, high;
372 #endif
373 } l;
374 } u, res;
375 uint64_t rl, rh;
376
377 u.ll = a;
378 rl = (uint64_t)u.l.low * (uint64_t)b;
379 rh = (uint64_t)u.l.high * (uint64_t)b;
380 rh += (rl >> 32);
381 res.l.high = rh / c;
382 res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
383 return res.ll;
384 }
385
386 /* Round number down to multiple */
387 #define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
388
389 /* Round number up to multiple */
390 #define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
391
392 #include "module.h"
393
394 #endif