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