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 "config-host.h"
   6
   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
  13
  14 #define QEMU_BUILD_BUG_ON(x) typedef char __build_bug_on__##__LINE__[(x)?-1:1];
  15
  16 typedef struct QEMUTimer QEMUTimer;
  17 typedef struct QEMUFile QEMUFile;
  18 typedef struct QEMUBH QEMUBH;
  19 typedef struct DeviceState DeviceState;
  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 <assert.h>
  37
  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
  53
  54 #ifndef CONFIG_IOVEC
  55 #define CONFIG_IOVEC
  56 struct iovec {
  57     void *iov_base;
  58     size_t iov_len;
  59 };
  60 /*
  61  * Use the same value as Linux for now.
  62  */
  63 #define IOV_MAX         1024
  64 #else
  65 #include <sys/uio.h>
  66 #endif
  67
  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
  83
  84 typedef int (*fprintf_function)(FILE *f, const char *fmt, ...)
  85     GCC_FMT_ATTR(2, 3);
  86
  87 #ifdef _WIN32
  88 #define fsync _commit
  89 #define lseek _lseeki64
  90 extern int qemu_ftruncate64(int, int64_t);
  91 #define ftruncate qemu_ftruncate64
  92
  93 static inline char *realpath(const char *path, char *resolved_path)
  94 {
  95     _fullpath(resolved_path, path, _MAX_PATH);
  96     return resolved_path;
  97 }
  98
  99 #define PRId64 "I64d"
 100 #define PRIx64 "I64x"
 101 #define PRIu64 "I64u"
 102 #define PRIo64 "I64o"
 103 #endif
 104
 105 /* FIXME: Remove NEED_CPU_H.  */
 106 #ifndef NEED_CPU_H
 107
 108 #include <setjmp.h>
 109 #include "osdep.h"
 110 #include "bswap.h"
 111
 112 #else
 113
 114 #include "cpu.h"
 115
 116 #endif /* !defined(NEED_CPU_H) */
 117
 118 /* bottom halves */
 119 typedef void QEMUBHFunc(void *opaque);
 120
 121 void async_context_push(void);
 122 void async_context_pop(void);
 123 int get_async_context_id(void);
 124
 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.
 132  */
 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);
 138
 139 void qemu_get_timedate(struct tm *tm, int offset);
 140 int qemu_timedate_diff(struct tm *tm);
 141
 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);
 153
 154 /* path.c */
 155 void init_paths(const char *prefix);
 156 const char *path(const char *pathname);
 157
 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))
 173
 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
 178
 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);
 186
 187 void qemu_mutex_lock_iothread(void);
 188 void qemu_mutex_unlock_iothread(void);
 189
 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);
 194
 195 #ifndef _WIN32
 196 int qemu_eventfd(int pipefd[2]);
 197 int qemu_pipe(int pipefd[2]);
 198 #endif
 199
 200 /* Error handling.  */
 201
 202 void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
 203
 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);
 208
 209 struct ParallelIOArg {
 210     void *buffer;
 211     int count;
 212 };
 213
 214 typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
 215
 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 PCIEAERMsg PCIEAERMsg;
 244 typedef struct PCIEAERLog PCIEAERLog;
 245 typedef struct PCIEAERErr PCIEAERErr;
 246 typedef struct PCIEPort PCIEPort;
 247 typedef struct PCIESlot PCIESlot;
 248 typedef struct SerialState SerialState;
 249 typedef struct IRQState *qemu_irq;
 250 typedef struct PCMCIACardState PCMCIACardState;
 251 typedef struct MouseTransformInfo MouseTransformInfo;
 252 typedef struct uWireSlave uWireSlave;
 253 typedef struct I2SCodec I2SCodec;
 254 typedef struct SSIBus SSIBus;
 255 typedef struct EventNotifier EventNotifier;
 256 typedef struct VirtIODevice VirtIODevice;
 257
 258 typedef uint64_t pcibus_t;
 259
 260 typedef enum {
 261     IF_NONE,
 262     IF_IDE, IF_SCSI, IF_FLOPPY, IF_PFLASH, IF_MTD, IF_SD, IF_VIRTIO, IF_XEN,
 263     IF_COUNT
 264 } BlockInterfaceType;
 265
 266 void cpu_exec_init_all(unsigned long tb_size);
 267
 268 /* CPU save/load.  */
 269 void cpu_save(QEMUFile *f, void *opaque);
 270 int cpu_load(QEMUFile *f, void *opaque, int version_id);
 271
 272 /* Force QEMU to stop what it's doing and service IO */
 273 void qemu_service_io(void);
 274
 275 /* Force QEMU to process pending events */
 276 void qemu_notify_event(void);
 277
 278 /* Unblock cpu */
 279 void qemu_cpu_kick(void *env);
 280 int qemu_cpu_self(void *env);
 281
 282 /* work queue */
 283 struct qemu_work_item {
 284     struct qemu_work_item *next;
 285     void (*func)(void *data);
 286     void *data;
 287     int done;
 288 };
 289
 290 #ifdef CONFIG_USER_ONLY
 291 #define qemu_init_vcpu(env) do { } while (0)
 292 #else
 293 void qemu_init_vcpu(void *env);
 294 #endif
 295
 296 typedef struct QEMUIOVector {
 297     struct iovec *iov;
 298     int niov;
 299     int nalloc;
 300     size_t size;
 301 } QEMUIOVector;
 302
 303 void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
 304 void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
 305 void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
 306 void qemu_iovec_copy(QEMUIOVector *dst, QEMUIOVector *src, uint64_t skip,
 307     size_t size);
 308 void qemu_iovec_concat(QEMUIOVector *dst, QEMUIOVector *src, size_t size);
 309 void qemu_iovec_destroy(QEMUIOVector *qiov);
 310 void qemu_iovec_reset(QEMUIOVector *qiov);
 311 void qemu_iovec_to_buffer(QEMUIOVector *qiov, void *buf);
 312 void qemu_iovec_from_buffer(QEMUIOVector *qiov, const void *buf, size_t count);
 313 void qemu_iovec_memset(QEMUIOVector *qiov, int c, size_t count);
 314
 315 struct Monitor;
 316 typedef struct Monitor Monitor;
 317
 318 /* Convert a byte between binary and BCD.  */
 319 static inline uint8_t to_bcd(uint8_t val)
 320 {
 321     return ((val / 10) << 4) | (val % 10);
 322 }
 323
 324 static inline uint8_t from_bcd(uint8_t val)
 325 {
 326     return ((val >> 4) * 10) + (val & 0x0f);
 327 }
 328
 329 /* compute with 96 bit intermediate result: (a*b)/c */
 330 static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
 331 {
 332     union {
 333         uint64_t ll;
 334         struct {
 335 #ifdef HOST_WORDS_BIGENDIAN
 336             uint32_t high, low;
 337 #else
 338             uint32_t low, high;
 339 #endif
 340         } l;
 341     } u, res;
 342     uint64_t rl, rh;
 343
 344     u.ll = a;
 345     rl = (uint64_t)u.l.low * (uint64_t)b;
 346     rh = (uint64_t)u.l.high * (uint64_t)b;
 347     rh += (rl >> 32);
 348     res.l.high = rh / c;
 349     res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
 350     return res.ll;
 351 }
 352
 353 #include "module.h"
 354
 355 #endif