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