Make struct iovec universally available
[qemu] / 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 /* we put basic includes here to avoid repeating them in device drivers */
6 #include <stdlib.h>
7 #include <stdio.h>
8 #include <stdarg.h>
9 #include <string.h>
10 #include <strings.h>
11 #include <inttypes.h>
12 #include <limits.h>
13 #include <time.h>
14 #include <ctype.h>
15 #include <errno.h>
16 #include <unistd.h>
17 #include <fcntl.h>
18 #include <sys/stat.h>
19 #include "config-host.h"
20
21 #ifndef O_LARGEFILE
22 #define O_LARGEFILE 0
23 #endif
24 #ifndef O_BINARY
25 #define O_BINARY 0
26 #endif
27
28 #ifndef ENOMEDIUM
29 #define ENOMEDIUM ENODEV
30 #endif
31
32 #ifndef HAVE_IOVEC
33 #define HAVE_IOVEC
34 struct iovec {
35     void *iov_base;
36     size_t iov_len;
37 };
38 #endif
39
40 #ifdef _WIN32
41 #define WIN32_LEAN_AND_MEAN
42 #define WINVER 0x0501  /* needed for ipv6 bits */
43 #include <windows.h>
44 #define fsync _commit
45 #define lseek _lseeki64
46 #define ENOTSUP 4096
47 extern int qemu_ftruncate64(int, int64_t);
48 #define ftruncate qemu_ftruncate64
49
50
51 static inline char *realpath(const char *path, char *resolved_path)
52 {
53     _fullpath(resolved_path, path, _MAX_PATH);
54     return resolved_path;
55 }
56
57 #define PRId64 "I64d"
58 #define PRIx64 "I64x"
59 #define PRIu64 "I64u"
60 #define PRIo64 "I64o"
61 #endif
62
63 /* FIXME: Remove NEED_CPU_H.  */
64 #ifndef NEED_CPU_H
65
66 #include <setjmp.h>
67 #include "osdep.h"
68 #include "bswap.h"
69
70 #else
71
72 #include "cpu.h"
73
74 #endif /* !defined(NEED_CPU_H) */
75
76 /* bottom halves */
77 typedef struct QEMUBH QEMUBH;
78
79 typedef void QEMUBHFunc(void *opaque);
80
81 QEMUBH *qemu_bh_new(QEMUBHFunc *cb, void *opaque);
82 void qemu_bh_schedule(QEMUBH *bh);
83 /* Bottom halfs that are scheduled from a bottom half handler are instantly
84  * invoked.  This can create an infinite loop if a bottom half handler
85  * schedules itself.  qemu_bh_schedule_idle() avoids this infinite loop by
86  * ensuring that the bottom half isn't executed until the next main loop
87  * iteration.
88  */
89 void qemu_bh_schedule_idle(QEMUBH *bh);
90 void qemu_bh_cancel(QEMUBH *bh);
91 void qemu_bh_delete(QEMUBH *bh);
92 int qemu_bh_poll(void);
93
94 uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c);
95
96 void qemu_get_timedate(struct tm *tm, int offset);
97 int qemu_timedate_diff(struct tm *tm);
98
99 /* cutils.c */
100 void pstrcpy(char *buf, int buf_size, const char *str);
101 char *pstrcat(char *buf, int buf_size, const char *s);
102 int strstart(const char *str, const char *val, const char **ptr);
103 int stristart(const char *str, const char *val, const char **ptr);
104 time_t mktimegm(struct tm *tm);
105 int fls(int i);
106
107 #define qemu_isalnum(c)         isalnum((unsigned char)(c))
108 #define qemu_isalpha(c)         isalpha((unsigned char)(c))
109 #define qemu_iscntrl(c)         iscntrl((unsigned char)(c))
110 #define qemu_isdigit(c)         isdigit((unsigned char)(c))
111 #define qemu_isgraph(c)         isgraph((unsigned char)(c))
112 #define qemu_islower(c)         islower((unsigned char)(c))
113 #define qemu_isprint(c)         isprint((unsigned char)(c))
114 #define qemu_ispunct(c)         ispunct((unsigned char)(c))
115 #define qemu_isspace(c)         isspace((unsigned char)(c))
116 #define qemu_isupper(c)         isupper((unsigned char)(c))
117 #define qemu_isxdigit(c)        isxdigit((unsigned char)(c))
118 #define qemu_tolower(c)         tolower((unsigned char)(c))
119 #define qemu_toupper(c)         toupper((unsigned char)(c))
120 #define qemu_isascii(c)         isascii((unsigned char)(c))
121 #define qemu_toascii(c)         toascii((unsigned char)(c))
122
123 void *qemu_malloc(size_t size);
124 void *qemu_realloc(void *ptr, size_t size);
125 void *qemu_mallocz(size_t size);
126 void qemu_free(void *ptr);
127 char *qemu_strdup(const char *str);
128 char *qemu_strndup(const char *str, size_t size);
129
130 void *get_mmap_addr(unsigned long size);
131
132
133 /* Error handling.  */
134
135 void hw_error(const char *fmt, ...)
136     __attribute__ ((__format__ (__printf__, 1, 2)))
137     __attribute__ ((__noreturn__));
138
139 /* IO callbacks.  */
140 typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size);
141 typedef int IOCanRWHandler(void *opaque);
142 typedef void IOHandler(void *opaque);
143
144 struct ParallelIOArg {
145     void *buffer;
146     int count;
147 };
148
149 typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
150
151 /* A load of opaque types so that device init declarations don't have to
152    pull in all the real definitions.  */
153 typedef struct NICInfo NICInfo;
154 typedef struct HCIInfo HCIInfo;
155 typedef struct AudioState AudioState;
156 typedef struct BlockDriverState BlockDriverState;
157 typedef struct DisplayState DisplayState;
158 typedef struct TextConsole TextConsole;
159 typedef TextConsole QEMUConsole;
160 typedef struct CharDriverState CharDriverState;
161 typedef struct VLANState VLANState;
162 typedef struct QEMUFile QEMUFile;
163 typedef struct i2c_bus i2c_bus;
164 typedef struct i2c_slave i2c_slave;
165 typedef struct SMBusDevice SMBusDevice;
166 typedef struct QEMUTimer QEMUTimer;
167 typedef struct PCIBus PCIBus;
168 typedef struct PCIDevice PCIDevice;
169 typedef struct SerialState SerialState;
170 typedef struct IRQState *qemu_irq;
171 struct pcmcia_card_s;
172
173 /* CPU save/load.  */
174 void cpu_save(QEMUFile *f, void *opaque);
175 int cpu_load(QEMUFile *f, void *opaque, int version_id);
176
177 /* Force QEMU to stop what it's doing and service IO */
178 void qemu_service_io(void);
179
180 #endif