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