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 /* Hack around the mess dyngen-exec.h causes: We need QEMU_NORETURN in files that
  22    cannot include the following headers without conflicts. This condition has
  23    to be removed once dyngen is gone. */
  24 #ifndef __DYNGEN_EXEC_H__
  25
  26 /* we put basic includes here to avoid repeating them in device drivers */
  27 #include <stdlib.h>
  28 #include <stdio.h>
  29 #include <stdarg.h>
  30 #include <stdbool.h>
  31 #include <string.h>
  32 #include <strings.h>
  33 #include <inttypes.h>
  34 #include <limits.h>
  35 #include <time.h>
  36 #include <ctype.h>
  37 #include <errno.h>
  38 #include <unistd.h>
  39 #include <fcntl.h>
  40 #include <sys/stat.h>
  41 #include <assert.h>
  42
  43 #ifndef O_LARGEFILE
  44 #define O_LARGEFILE 0
  45 #endif
  46 #ifndef O_BINARY
  47 #define O_BINARY 0
  48 #endif
  49 #ifndef MAP_ANONYMOUS
  50 #define MAP_ANONYMOUS MAP_ANON
  51 #endif
  52 #ifndef ENOMEDIUM
  53 #define ENOMEDIUM ENODEV
  54 #endif
  55 #if !defined(ENOTSUP)
  56 #define ENOTSUP 4096
  57 #endif
  58
  59 #ifndef CONFIG_IOVEC
  60 #define CONFIG_IOVEC
  61 struct iovec {
  62     void *iov_base;
  63     size_t iov_len;
  64 };
  65 /*
  66  * Use the same value as Linux for now.
  67  */
  68 #define IOV_MAX         1024
  69 #else
  70 #include <sys/uio.h>
  71 #endif
  72
  73 #if defined __GNUC__
  74 # if (__GNUC__ < 4) || \
  75      defined(__GNUC_MINOR__) && (__GNUC__ == 4) && (__GNUC_MINOR__ < 4)
  76    /* gcc versions before 4.4.x don't support gnu_printf, so use printf. */
  77 #  define GCC_ATTR __attribute__((__unused__, format(printf, 1, 2)))
  78 #  define GCC_FMT_ATTR(n, m) __attribute__((format(printf, n, m)))
  79 # else
  80    /* Use gnu_printf when supported (qemu uses standard format strings). */
  81 #  define GCC_ATTR __attribute__((__unused__, format(gnu_printf, 1, 2)))
  82 #  define GCC_FMT_ATTR(n, m) __attribute__((format(gnu_printf, n, m)))
  83 # endif
  84 #else
  85 #define GCC_ATTR /**/
  86 #define GCC_FMT_ATTR(n, m)
  87 #endif
  88
  89 #ifdef _WIN32
  90 #define fsync _commit
  91 #define lseek _lseeki64
  92 extern int qemu_ftruncate64(int, int64_t);
  93 #define ftruncate qemu_ftruncate64
  94
  95 static inline char *realpath(const char *path, char *resolved_path)
  96 {
  97     _fullpath(resolved_path, path, _MAX_PATH);
  98     return resolved_path;
  99 }
 100
 101 #define PRId64 "I64d"
 102 #define PRIx64 "I64x"
 103 #define PRIu64 "I64u"
 104 #define PRIo64 "I64o"
 105 #endif
 106
 107 /* FIXME: Remove NEED_CPU_H.  */
 108 #ifndef NEED_CPU_H
 109
 110 #include <setjmp.h>
 111 #include "osdep.h"
 112 #include "bswap.h"
 113
 114 #else
 115
 116 #include "cpu.h"
 117
 118 #endif /* !defined(NEED_CPU_H) */
 119
 120 /* bottom halves */
 121 typedef void QEMUBHFunc(void *opaque);
 122
 123 void async_context_push(void);
 124 void async_context_pop(void);
 125 int get_async_context_id(void);
 126
 127 QEMUBH *qemu_bh_new(QEMUBHFunc *cb, void *opaque);
 128 void qemu_bh_schedule(QEMUBH *bh);
 129 /* Bottom halfs that are scheduled from a bottom half handler are instantly
 130  * invoked.  This can create an infinite loop if a bottom half handler
 131  * schedules itself.  qemu_bh_schedule_idle() avoids this infinite loop by
 132  * ensuring that the bottom half isn't executed until the next main loop
 133  * iteration.
 134  */
 135 void qemu_bh_schedule_idle(QEMUBH *bh);
 136 void qemu_bh_cancel(QEMUBH *bh);
 137 void qemu_bh_delete(QEMUBH *bh);
 138 int qemu_bh_poll(void);
 139 void qemu_bh_update_timeout(int *timeout);
 140
 141 uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c);
 142
 143 void qemu_get_timedate(struct tm *tm, int offset);
 144 int qemu_timedate_diff(struct tm *tm);
 145
 146 /* cutils.c */
 147 void pstrcpy(char *buf, int buf_size, const char *str);
 148 char *pstrcat(char *buf, int buf_size, const char *s);
 149 int strstart(const char *str, const char *val, const char **ptr);
 150 int stristart(const char *str, const char *val, const char **ptr);
 151 int qemu_strnlen(const char *s, int max_len);
 152 time_t mktimegm(struct tm *tm);
 153 int qemu_fls(int i);
 154 int qemu_fdatasync(int fd);
 155 int fcntl_setfl(int fd, int flag);
 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 void *qemu_malloc(size_t size);
 178 void *qemu_realloc(void *ptr, size_t size);
 179 void *qemu_mallocz(size_t size);
 180 void qemu_free(void *ptr);
 181 char *qemu_strdup(const char *str);
 182 char *qemu_strndup(const char *str, size_t size);
 183
 184 void qemu_mutex_lock_iothread(void);
 185 void qemu_mutex_unlock_iothread(void);
 186
 187 int qemu_open(const char *name, int flags, ...);
 188 ssize_t qemu_write_full(int fd, const void *buf, size_t count)
 189     QEMU_WARN_UNUSED_RESULT;
 190 void qemu_set_cloexec(int fd);
 191
 192 #ifndef _WIN32
 193 int qemu_eventfd(int pipefd[2]);
 194 int qemu_pipe(int pipefd[2]);
 195 #endif
 196
 197 /* Error handling.  */
 198
 199 void QEMU_NORETURN hw_error(const char *fmt, ...)
 200     __attribute__ ((__format__ (__printf__, 1, 2)));
 201
 202 /* IO callbacks.  */
 203 typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size);
 204 typedef int IOCanReadHandler(void *opaque);
 205 typedef void IOHandler(void *opaque);
 206
 207 struct ParallelIOArg {
 208     void *buffer;
 209     int count;
 210 };
 211
 212 typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
 213
 214 /* A load of opaque types so that device init declarations don't have to
 215    pull in all the real definitions.  */
 216 typedef struct NICInfo NICInfo;
 217 typedef struct HCIInfo HCIInfo;
 218 typedef struct AudioState AudioState;
 219 typedef struct BlockDriverState BlockDriverState;
 220 typedef struct DriveInfo DriveInfo;
 221 typedef struct DisplayState DisplayState;
 222 typedef struct DisplayChangeListener DisplayChangeListener;
 223 typedef struct DisplaySurface DisplaySurface;
 224 typedef struct DisplayAllocator DisplayAllocator;
 225 typedef struct PixelFormat PixelFormat;
 226 typedef struct TextConsole TextConsole;
 227 typedef TextConsole QEMUConsole;
 228 typedef struct CharDriverState CharDriverState;
 229 typedef struct MACAddr MACAddr;
 230 typedef struct VLANState VLANState;
 231 typedef struct VLANClientState VLANClientState;
 232 typedef struct i2c_bus i2c_bus;
 233 typedef struct i2c_slave i2c_slave;
 234 typedef struct SMBusDevice SMBusDevice;
 235 typedef struct PCIHostState PCIHostState;
 236 typedef struct PCIExpressHost PCIExpressHost;
 237 typedef struct PCIBus PCIBus;
 238 typedef struct PCIDevice PCIDevice;
 239 typedef struct SerialState SerialState;
 240 typedef struct IRQState *qemu_irq;
 241 typedef struct PCMCIACardState PCMCIACardState;
 242 typedef struct MouseTransformInfo MouseTransformInfo;
 243 typedef struct uWireSlave uWireSlave;
 244 typedef struct I2SCodec I2SCodec;
 245 typedef struct SSIBus SSIBus;
 246 typedef struct EventNotifier EventNotifier;
 247 typedef struct VirtIODevice VirtIODevice;
 248
 249 typedef uint64_t pcibus_t;
 250
 251 typedef enum {
 252     IF_NONE,
 253     IF_IDE, IF_SCSI, IF_FLOPPY, IF_PFLASH, IF_MTD, IF_SD, IF_VIRTIO, IF_XEN,
 254     IF_COUNT
 255 } BlockInterfaceType;
 256
 257 void cpu_exec_init_all(unsigned long tb_size);
 258
 259 /* CPU save/load.  */
 260 void cpu_save(QEMUFile *f, void *opaque);
 261 int cpu_load(QEMUFile *f, void *opaque, int version_id);
 262
 263 /* Force QEMU to stop what it's doing and service IO */
 264 void qemu_service_io(void);
 265
 266 /* Force QEMU to process pending events */
 267 void qemu_notify_event(void);
 268
 269 /* Unblock cpu */
 270 void qemu_cpu_kick(void *env);
 271 int qemu_cpu_self(void *env);
 272
 273 /* work queue */
 274 struct qemu_work_item {
 275     struct qemu_work_item *next;
 276     void (*func)(void *data);
 277     void *data;
 278     int done;
 279 };
 280
 281 #ifdef CONFIG_USER_ONLY
 282 #define qemu_init_vcpu(env) do { } while (0)
 283 #else
 284 void qemu_init_vcpu(void *env);
 285 #endif
 286
 287 typedef struct QEMUIOVector {
 288     struct iovec *iov;
 289     int niov;
 290     int nalloc;
 291     size_t size;
 292 } QEMUIOVector;
 293
 294 void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
 295 void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
 296 void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
 297 void qemu_iovec_copy(QEMUIOVector *dst, QEMUIOVector *src, uint64_t skip,
 298     size_t size);
 299 void qemu_iovec_concat(QEMUIOVector *dst, QEMUIOVector *src, size_t size);
 300 void qemu_iovec_destroy(QEMUIOVector *qiov);
 301 void qemu_iovec_reset(QEMUIOVector *qiov);
 302 void qemu_iovec_to_buffer(QEMUIOVector *qiov, void *buf);
 303 void qemu_iovec_from_buffer(QEMUIOVector *qiov, const void *buf, size_t count);
 304 void qemu_iovec_memset(QEMUIOVector *qiov, int c, size_t count);
 305
 306 struct Monitor;
 307 typedef struct Monitor Monitor;
 308
 309 /* Convert a byte between binary and BCD.  */
 310 static inline uint8_t to_bcd(uint8_t val)
 311 {
 312     return ((val / 10) << 4) | (val % 10);
 313 }
 314
 315 static inline uint8_t from_bcd(uint8_t val)
 316 {
 317     return ((val >> 4) * 10) + (val & 0x0f);
 318 }
 319
 320 #include "module.h"
 321
 322 #endif /* dyngen-exec.h hack */
 323
 324 #endif