scsi-disk: Complete failed requests in scsi_disk_emulate_command
[qemu.git] / qemu-common.h
blobb3957f18596b9f1d916d1437087236e8e714183a
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 #define QEMU_BUILD_BUG_ON(x) typedef char __build_bug_on__##__LINE__[(x)?-1:1];
16 typedef struct QEMUTimer QEMUTimer;
17 typedef struct QEMUFile QEMUFile;
18 typedef struct QEMUBH QEMUBH;
19 typedef struct DeviceState DeviceState;
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 <assert.h>
38 #ifndef O_LARGEFILE
39 #define O_LARGEFILE 0
40 #endif
41 #ifndef O_BINARY
42 #define O_BINARY 0
43 #endif
44 #ifndef MAP_ANONYMOUS
45 #define MAP_ANONYMOUS MAP_ANON
46 #endif
47 #ifndef ENOMEDIUM
48 #define ENOMEDIUM ENODEV
49 #endif
50 #if !defined(ENOTSUP)
51 #define ENOTSUP 4096
52 #endif
54 #ifndef CONFIG_IOVEC
55 #define CONFIG_IOVEC
56 struct iovec {
57 void *iov_base;
58 size_t iov_len;
61 * Use the same value as Linux for now.
63 #define IOV_MAX 1024
64 #else
65 #include <sys/uio.h>
66 #endif
68 #if defined __GNUC__
69 # if (__GNUC__ < 4) || \
70 defined(__GNUC_MINOR__) && (__GNUC__ == 4) && (__GNUC_MINOR__ < 4)
71 /* gcc versions before 4.4.x don't support gnu_printf, so use printf. */
72 # define GCC_ATTR __attribute__((__unused__, format(printf, 1, 2)))
73 # define GCC_FMT_ATTR(n, m) __attribute__((format(printf, n, m)))
74 # else
75 /* Use gnu_printf when supported (qemu uses standard format strings). */
76 # define GCC_ATTR __attribute__((__unused__, format(gnu_printf, 1, 2)))
77 # define GCC_FMT_ATTR(n, m) __attribute__((format(gnu_printf, n, m)))
78 # endif
79 #else
80 #define GCC_ATTR /**/
81 #define GCC_FMT_ATTR(n, m)
82 #endif
84 typedef int (*fprintf_function)(FILE *f, const char *fmt, ...)
85 GCC_FMT_ATTR(2, 3);
87 #ifdef _WIN32
88 #define fsync _commit
89 #define lseek _lseeki64
90 extern int qemu_ftruncate64(int, int64_t);
91 #define ftruncate qemu_ftruncate64
93 static inline char *realpath(const char *path, char *resolved_path)
95 _fullpath(resolved_path, path, _MAX_PATH);
96 return resolved_path;
99 #define PRId64 "I64d"
100 #define PRIx64 "I64x"
101 #define PRIu64 "I64u"
102 #define PRIo64 "I64o"
103 #endif
105 /* FIXME: Remove NEED_CPU_H. */
106 #ifndef NEED_CPU_H
108 #include <setjmp.h>
109 #include "osdep.h"
110 #include "bswap.h"
112 #else
114 #include "cpu.h"
116 #endif /* !defined(NEED_CPU_H) */
118 /* bottom halves */
119 typedef void QEMUBHFunc(void *opaque);
121 void async_context_push(void);
122 void async_context_pop(void);
123 int get_async_context_id(void);
125 QEMUBH *qemu_bh_new(QEMUBHFunc *cb, void *opaque);
126 void qemu_bh_schedule(QEMUBH *bh);
127 /* Bottom halfs that are scheduled from a bottom half handler are instantly
128 * invoked. This can create an infinite loop if a bottom half handler
129 * schedules itself. qemu_bh_schedule_idle() avoids this infinite loop by
130 * ensuring that the bottom half isn't executed until the next main loop
131 * iteration.
133 void qemu_bh_schedule_idle(QEMUBH *bh);
134 void qemu_bh_cancel(QEMUBH *bh);
135 void qemu_bh_delete(QEMUBH *bh);
136 int qemu_bh_poll(void);
137 void qemu_bh_update_timeout(int *timeout);
139 void qemu_get_timedate(struct tm *tm, int offset);
140 int qemu_timedate_diff(struct tm *tm);
142 /* cutils.c */
143 void pstrcpy(char *buf, int buf_size, const char *str);
144 char *pstrcat(char *buf, int buf_size, const char *s);
145 int strstart(const char *str, const char *val, const char **ptr);
146 int stristart(const char *str, const char *val, const char **ptr);
147 int qemu_strnlen(const char *s, int max_len);
148 time_t mktimegm(struct tm *tm);
149 int qemu_fls(int i);
150 int qemu_fdatasync(int fd);
151 int fcntl_setfl(int fd, int flag);
152 ssize_t strtosz(const char *nptr, char **end);
154 /* path.c */
155 void init_paths(const char *prefix);
156 const char *path(const char *pathname);
158 #define qemu_isalnum(c) isalnum((unsigned char)(c))
159 #define qemu_isalpha(c) isalpha((unsigned char)(c))
160 #define qemu_iscntrl(c) iscntrl((unsigned char)(c))
161 #define qemu_isdigit(c) isdigit((unsigned char)(c))
162 #define qemu_isgraph(c) isgraph((unsigned char)(c))
163 #define qemu_islower(c) islower((unsigned char)(c))
164 #define qemu_isprint(c) isprint((unsigned char)(c))
165 #define qemu_ispunct(c) ispunct((unsigned char)(c))
166 #define qemu_isspace(c) isspace((unsigned char)(c))
167 #define qemu_isupper(c) isupper((unsigned char)(c))
168 #define qemu_isxdigit(c) isxdigit((unsigned char)(c))
169 #define qemu_tolower(c) tolower((unsigned char)(c))
170 #define qemu_toupper(c) toupper((unsigned char)(c))
171 #define qemu_isascii(c) isascii((unsigned char)(c))
172 #define qemu_toascii(c) toascii((unsigned char)(c))
174 #ifdef _WIN32
175 /* ffs() in oslib-win32.c for WIN32, strings.h for the rest of the world */
176 int ffs(int i);
177 #endif
179 void *qemu_oom_check(void *ptr);
180 void *qemu_malloc(size_t size);
181 void *qemu_realloc(void *ptr, size_t size);
182 void *qemu_mallocz(size_t size);
183 void qemu_free(void *ptr);
184 char *qemu_strdup(const char *str);
185 char *qemu_strndup(const char *str, size_t size);
187 void qemu_mutex_lock_iothread(void);
188 void qemu_mutex_unlock_iothread(void);
190 int qemu_open(const char *name, int flags, ...);
191 ssize_t qemu_write_full(int fd, const void *buf, size_t count)
192 QEMU_WARN_UNUSED_RESULT;
193 void qemu_set_cloexec(int fd);
195 #ifndef _WIN32
196 int qemu_eventfd(int pipefd[2]);
197 int qemu_pipe(int pipefd[2]);
198 #endif
200 /* Error handling. */
202 void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
204 /* IO callbacks. */
205 typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size);
206 typedef int IOCanReadHandler(void *opaque);
207 typedef void IOHandler(void *opaque);
209 struct ParallelIOArg {
210 void *buffer;
211 int count;
214 typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
216 /* A load of opaque types so that device init declarations don't have to
217 pull in all the real definitions. */
218 typedef struct NICInfo NICInfo;
219 typedef struct HCIInfo HCIInfo;
220 typedef struct AudioState AudioState;
221 typedef struct BlockDriverState BlockDriverState;
222 typedef struct DriveInfo DriveInfo;
223 typedef struct DisplayState DisplayState;
224 typedef struct DisplayChangeListener DisplayChangeListener;
225 typedef struct DisplaySurface DisplaySurface;
226 typedef struct DisplayAllocator DisplayAllocator;
227 typedef struct PixelFormat PixelFormat;
228 typedef struct TextConsole TextConsole;
229 typedef TextConsole QEMUConsole;
230 typedef struct CharDriverState CharDriverState;
231 typedef struct MACAddr MACAddr;
232 typedef struct VLANState VLANState;
233 typedef struct VLANClientState VLANClientState;
234 typedef struct i2c_bus i2c_bus;
235 typedef struct i2c_slave i2c_slave;
236 typedef struct SMBusDevice SMBusDevice;
237 typedef struct PCIHostState PCIHostState;
238 typedef struct PCIExpressHost PCIExpressHost;
239 typedef struct PCIBus PCIBus;
240 typedef struct PCIDevice PCIDevice;
241 typedef struct PCIExpressDevice PCIExpressDevice;
242 typedef struct PCIBridge PCIBridge;
243 typedef struct PCIEPort PCIEPort;
244 typedef struct PCIESlot PCIESlot;
245 typedef struct SerialState SerialState;
246 typedef struct IRQState *qemu_irq;
247 typedef struct PCMCIACardState PCMCIACardState;
248 typedef struct MouseTransformInfo MouseTransformInfo;
249 typedef struct uWireSlave uWireSlave;
250 typedef struct I2SCodec I2SCodec;
251 typedef struct SSIBus SSIBus;
252 typedef struct EventNotifier EventNotifier;
253 typedef struct VirtIODevice VirtIODevice;
255 typedef uint64_t pcibus_t;
257 typedef enum {
258 IF_NONE,
259 IF_IDE, IF_SCSI, IF_FLOPPY, IF_PFLASH, IF_MTD, IF_SD, IF_VIRTIO, IF_XEN,
260 IF_COUNT
261 } BlockInterfaceType;
263 void cpu_exec_init_all(unsigned long tb_size);
265 /* CPU save/load. */
266 void cpu_save(QEMUFile *f, void *opaque);
267 int cpu_load(QEMUFile *f, void *opaque, int version_id);
269 /* Force QEMU to stop what it's doing and service IO */
270 void qemu_service_io(void);
272 /* Force QEMU to process pending events */
273 void qemu_notify_event(void);
275 /* Unblock cpu */
276 void qemu_cpu_kick(void *env);
277 int qemu_cpu_self(void *env);
279 /* work queue */
280 struct qemu_work_item {
281 struct qemu_work_item *next;
282 void (*func)(void *data);
283 void *data;
284 int done;
287 #ifdef CONFIG_USER_ONLY
288 #define qemu_init_vcpu(env) do { } while (0)
289 #else
290 void qemu_init_vcpu(void *env);
291 #endif
293 typedef struct QEMUIOVector {
294 struct iovec *iov;
295 int niov;
296 int nalloc;
297 size_t size;
298 } QEMUIOVector;
300 void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
301 void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
302 void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
303 void qemu_iovec_copy(QEMUIOVector *dst, QEMUIOVector *src, uint64_t skip,
304 size_t size);
305 void qemu_iovec_concat(QEMUIOVector *dst, QEMUIOVector *src, size_t size);
306 void qemu_iovec_destroy(QEMUIOVector *qiov);
307 void qemu_iovec_reset(QEMUIOVector *qiov);
308 void qemu_iovec_to_buffer(QEMUIOVector *qiov, void *buf);
309 void qemu_iovec_from_buffer(QEMUIOVector *qiov, const void *buf, size_t count);
310 void qemu_iovec_memset(QEMUIOVector *qiov, int c, size_t count);
312 struct Monitor;
313 typedef struct Monitor Monitor;
315 /* Convert a byte between binary and BCD. */
316 static inline uint8_t to_bcd(uint8_t val)
318 return ((val / 10) << 4) | (val % 10);
321 static inline uint8_t from_bcd(uint8_t val)
323 return ((val >> 4) * 10) + (val & 0x0f);
326 /* compute with 96 bit intermediate result: (a*b)/c */
327 static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
329 union {
330 uint64_t ll;
331 struct {
332 #ifdef HOST_WORDS_BIGENDIAN
333 uint32_t high, low;
334 #else
335 uint32_t low, high;
336 #endif
337 } l;
338 } u, res;
339 uint64_t rl, rh;
341 u.ll = a;
342 rl = (uint64_t)u.l.low * (uint64_t)b;
343 rh = (uint64_t)u.l.high * (uint64_t)b;
344 rh += (rl >> 32);
345 res.l.high = rh / c;
346 res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
347 return res.ll;
350 #include "module.h"
352 #endif