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