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