qemu-common.h

   1
   2 /* Common header file that is included by all of qemu.  */
   3 #ifndef QEMU_COMMON_H
   4 #define QEMU_COMMON_H
   5
   6 #include "compiler.h"
   7 #include "config-host.h"
   8
   9 #if defined(__arm__) || defined(__sparc__) || defined(__mips__) || defined(__hppa__) || defined(__ia64__)
  10 #define WORDS_ALIGNED
  11 #endif
  12
  13 #define TFR(expr) do { if ((expr) != -1) break; } while (errno == EINTR)
  14
  15 typedef struct QEMUTimer QEMUTimer;
  16 typedef struct QEMUFile QEMUFile;
  17 typedef struct DeviceState DeviceState;
  18
  19 struct Monitor;
  20 typedef struct Monitor Monitor;
  21 typedef struct MigrationParams MigrationParams;
  22
  23 /* we put basic includes here to avoid repeating them in device drivers */
  24 #include <stdlib.h>
  25 #include <stdio.h>
  26 #include <stdarg.h>
  27 #include <stdbool.h>
  28 #include <string.h>
  29 #include <strings.h>
  30 #include <inttypes.h>
  31 #include <limits.h>
  32 #include <time.h>
  33 #include <ctype.h>
  34 #include <errno.h>
  35 #include <unistd.h>
  36 #include <fcntl.h>
  37 #include <sys/stat.h>
  38 #include <sys/time.h>
  39 #include <assert.h>
  40 #include <signal.h>
  41 #include <glib.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 #if !defined(ECANCELED)
  67 #define ECANCELED 4097
  68 #endif
  69 #ifndef TIME_MAX
  70 #define TIME_MAX LONG_MAX
  71 #endif
  72
  73 /* HOST_LONG_BITS is the size of a native pointer in bits. */
  74 #if UINTPTR_MAX == UINT32_MAX
  75 # define HOST_LONG_BITS 32
  76 #elif UINTPTR_MAX == UINT64_MAX
  77 # define HOST_LONG_BITS 64
  78 #else
  79 # error Unknown pointer size
  80 #endif
  81
  82 #ifndef CONFIG_IOVEC
  83 #define CONFIG_IOVEC
  84 struct iovec {
  85     void *iov_base;
  86     size_t iov_len;
  87 };
  88 /*
  89  * Use the same value as Linux for now.
  90  */
  91 #define IOV_MAX         1024
  92 #else
  93 #include <sys/uio.h>
  94 #endif
  95
  96 typedef int (*fprintf_function)(FILE *f, const char *fmt, ...)
  97     GCC_FMT_ATTR(2, 3);
  98
  99 #ifdef _WIN32
 100 #define fsync _commit
 101 #if !defined(lseek)
 102 # define lseek _lseeki64
 103 #endif
 104 int qemu_ftruncate64(int, int64_t);
 105 #if !defined(ftruncate)
 106 # define ftruncate qemu_ftruncate64
 107 #endif
 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 #endif
 115
 116 /* icount */
 117 void configure_icount(const char *option);
 118 extern int use_icount;
 119
 120 /* FIXME: Remove NEED_CPU_H.  */
 121 #ifndef NEED_CPU_H
 122
 123 #include "osdep.h"
 124 #include "bswap.h"
 125
 126 #else
 127
 128 #include "cpu.h"
 129
 130 #endif /* !defined(NEED_CPU_H) */
 131
 132 /* main function, renamed */
 133 #if defined(CONFIG_COCOA)
 134 int qemu_main(int argc, char **argv, char **envp);
 135 #endif
 136
 137 void qemu_get_timedate(struct tm *tm, int offset);
 138 int qemu_timedate_diff(struct tm *tm);
 139
 140 /**
 141  * is_help_option:
 142  * @s: string to test
 143  *
 144  * Check whether @s is one of the standard strings which indicate
 145  * that the user is asking for a list of the valid values for a
 146  * command option like -cpu or -M. The current accepted strings
 147  * are 'help' and '?'. '?' is deprecated (it is a shell wildcard
 148  * which makes it annoying to use in a reliable way) but provided
 149  * for backwards compatibility.
 150  *
 151  * Returns: true if @s is a request for a list.
 152  */
 153 static inline bool is_help_option(const char *s)
 154 {
 155     return !strcmp(s, "?") || !strcmp(s, "help");
 156 }
 157
 158 /* cutils.c */
 159 void pstrcpy(char *buf, int buf_size, const char *str);
 160 void strpadcpy(char *buf, int buf_size, const char *str, char pad);
 161 char *pstrcat(char *buf, int buf_size, const char *s);
 162 int strstart(const char *str, const char *val, const char **ptr);
 163 int stristart(const char *str, const char *val, const char **ptr);
 164 int qemu_strnlen(const char *s, int max_len);
 165 time_t mktimegm(struct tm *tm);
 166 int qemu_fls(int i);
 167 int qemu_fdatasync(int fd);
 168 int fcntl_setfl(int fd, int flag);
 169 int qemu_parse_fd(const char *param);
 170 int qemu_parse_fdset(const char *param);
 171
 172 /*
 173  * strtosz() suffixes used to specify the default treatment of an
 174  * argument passed to strtosz() without an explicit suffix.
 175  * These should be defined using upper case characters in the range
 176  * A-Z, as strtosz() will use qemu_toupper() on the given argument
 177  * prior to comparison.
 178  */
 179 #define STRTOSZ_DEFSUFFIX_TB    'T'
 180 #define STRTOSZ_DEFSUFFIX_GB    'G'
 181 #define STRTOSZ_DEFSUFFIX_MB    'M'
 182 #define STRTOSZ_DEFSUFFIX_KB    'K'
 183 #define STRTOSZ_DEFSUFFIX_B     'B'
 184 int64_t strtosz(const char *nptr, char **end);
 185 int64_t strtosz_suffix(const char *nptr, char **end, const char default_suffix);
 186 int64_t strtosz_suffix_unit(const char *nptr, char **end,
 187                             const char default_suffix, int64_t unit);
 188
 189 /* path.c */
 190 void init_paths(const char *prefix);
 191 const char *path(const char *pathname);
 192
 193 #define qemu_isalnum(c)         isalnum((unsigned char)(c))
 194 #define qemu_isalpha(c)         isalpha((unsigned char)(c))
 195 #define qemu_iscntrl(c)         iscntrl((unsigned char)(c))
 196 #define qemu_isdigit(c)         isdigit((unsigned char)(c))
 197 #define qemu_isgraph(c)         isgraph((unsigned char)(c))
 198 #define qemu_islower(c)         islower((unsigned char)(c))
 199 #define qemu_isprint(c)         isprint((unsigned char)(c))
 200 #define qemu_ispunct(c)         ispunct((unsigned char)(c))
 201 #define qemu_isspace(c)         isspace((unsigned char)(c))
 202 #define qemu_isupper(c)         isupper((unsigned char)(c))
 203 #define qemu_isxdigit(c)        isxdigit((unsigned char)(c))
 204 #define qemu_tolower(c)         tolower((unsigned char)(c))
 205 #define qemu_toupper(c)         toupper((unsigned char)(c))
 206 #define qemu_isascii(c)         isascii((unsigned char)(c))
 207 #define qemu_toascii(c)         toascii((unsigned char)(c))
 208
 209 void *qemu_oom_check(void *ptr);
 210
 211 int qemu_open(const char *name, int flags, ...);
 212 int qemu_close(int fd);
 213 ssize_t qemu_write_full(int fd, const void *buf, size_t count)
 214     QEMU_WARN_UNUSED_RESULT;
 215 ssize_t qemu_send_full(int fd, const void *buf, size_t count, int flags)
 216     QEMU_WARN_UNUSED_RESULT;
 217 ssize_t qemu_recv_full(int fd, void *buf, size_t count, int flags)
 218     QEMU_WARN_UNUSED_RESULT;
 219
 220 #ifndef _WIN32
 221 int qemu_eventfd(int pipefd[2]);
 222 int qemu_pipe(int pipefd[2]);
 223 #endif
 224
 225 #ifdef _WIN32
 226 /* MinGW needs type casts for the 'buf' and 'optval' arguments. */
 227 #define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
 228     getsockopt(sockfd, level, optname, (void *)optval, optlen)
 229 #define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
 230     setsockopt(sockfd, level, optname, (const void *)optval, optlen)
 231 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags)
 232 #define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
 233     sendto(sockfd, (const void *)buf, len, flags, destaddr, addrlen)
 234 #else
 235 #define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
 236     getsockopt(sockfd, level, optname, optval, optlen)
 237 #define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
 238     setsockopt(sockfd, level, optname, optval, optlen)
 239 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags)
 240 #define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
 241     sendto(sockfd, buf, len, flags, destaddr, addrlen)
 242 #endif
 243
 244 /* Error handling.  */
 245
 246 void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
 247
 248 struct ParallelIOArg {
 249     void *buffer;
 250     int count;
 251 };
 252
 253 typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
 254
 255 /* A load of opaque types so that device init declarations don't have to
 256    pull in all the real definitions.  */
 257 typedef struct NICInfo NICInfo;
 258 typedef struct HCIInfo HCIInfo;
 259 typedef struct AudioState AudioState;
 260 typedef struct BlockDriverState BlockDriverState;
 261 typedef struct DriveInfo DriveInfo;
 262 typedef struct DisplayState DisplayState;
 263 typedef struct DisplayChangeListener DisplayChangeListener;
 264 typedef struct DisplaySurface DisplaySurface;
 265 typedef struct DisplayAllocator DisplayAllocator;
 266 typedef struct PixelFormat PixelFormat;
 267 typedef struct TextConsole TextConsole;
 268 typedef TextConsole QEMUConsole;
 269 typedef struct CharDriverState CharDriverState;
 270 typedef struct MACAddr MACAddr;
 271 typedef struct NetClientState NetClientState;
 272 typedef struct i2c_bus i2c_bus;
 273 typedef struct ISABus ISABus;
 274 typedef struct ISADevice ISADevice;
 275 typedef struct SMBusDevice SMBusDevice;
 276 typedef struct PCIHostState PCIHostState;
 277 typedef struct PCIExpressHost PCIExpressHost;
 278 typedef struct PCIBus PCIBus;
 279 typedef struct PCIDevice PCIDevice;
 280 typedef struct PCIExpressDevice PCIExpressDevice;
 281 typedef struct PCIBridge PCIBridge;
 282 typedef struct PCIEAERMsg PCIEAERMsg;
 283 typedef struct PCIEAERLog PCIEAERLog;
 284 typedef struct PCIEAERErr PCIEAERErr;
 285 typedef struct PCIEPort PCIEPort;
 286 typedef struct PCIESlot PCIESlot;
 287 typedef struct MSIMessage MSIMessage;
 288 typedef struct SerialState SerialState;
 289 typedef struct IRQState *qemu_irq;
 290 typedef struct PCMCIACardState PCMCIACardState;
 291 typedef struct MouseTransformInfo MouseTransformInfo;
 292 typedef struct uWireSlave uWireSlave;
 293 typedef struct I2SCodec I2SCodec;
 294 typedef struct SSIBus SSIBus;
 295 typedef struct EventNotifier EventNotifier;
 296 typedef struct VirtIODevice VirtIODevice;
 297 typedef struct QEMUSGList QEMUSGList;
 298 typedef struct SHPCDevice SHPCDevice;
 299
 300 typedef uint64_t pcibus_t;
 301
 302 typedef enum LostTickPolicy {
 303     LOST_TICK_DISCARD,
 304     LOST_TICK_DELAY,
 305     LOST_TICK_MERGE,
 306     LOST_TICK_SLEW,
 307     LOST_TICK_MAX
 308 } LostTickPolicy;
 309
 310 typedef struct PCIHostDeviceAddress {
 311     unsigned int domain;
 312     unsigned int bus;
 313     unsigned int slot;
 314     unsigned int function;
 315 } PCIHostDeviceAddress;
 316
 317 void tcg_exec_init(unsigned long tb_size);
 318 bool tcg_enabled(void);
 319
 320 void cpu_exec_init_all(void);
 321
 322 /* CPU save/load.  */
 323 void cpu_save(QEMUFile *f, void *opaque);
 324 int cpu_load(QEMUFile *f, void *opaque, int version_id);
 325
 326 /* Unblock cpu */
 327 void qemu_cpu_kick(void *env);
 328 void qemu_cpu_kick_self(void);
 329 int qemu_cpu_is_self(void *env);
 330
 331 /* work queue */
 332 struct qemu_work_item {
 333     struct qemu_work_item *next;
 334     void (*func)(void *data);
 335     void *data;
 336     int done;
 337 };
 338
 339 #ifdef CONFIG_USER_ONLY
 340 #define qemu_init_vcpu(env) do { } while (0)
 341 #else
 342 void qemu_init_vcpu(void *env);
 343 #endif
 344
 345
 346 /**
 347  * Sends a (part of) iovec down a socket, yielding when the socket is full, or
 348  * Receives data into a (part of) iovec from a socket,
 349  * yielding when there is no data in the socket.
 350  * The same interface as qemu_sendv_recvv(), with added yielding.
 351  * XXX should mark these as coroutine_fn
 352  */
 353 ssize_t qemu_co_sendv_recvv(int sockfd, struct iovec *iov, unsigned iov_cnt,
 354                             size_t offset, size_t bytes, bool do_send);
 355 #define qemu_co_recvv(sockfd, iov, iov_cnt, offset, bytes) \
 356   qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, false)
 357 #define qemu_co_sendv(sockfd, iov, iov_cnt, offset, bytes) \
 358   qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, true)
 359
 360 /**
 361  * The same as above, but with just a single buffer
 362  */
 363 ssize_t qemu_co_send_recv(int sockfd, void *buf, size_t bytes, bool do_send);
 364 #define qemu_co_recv(sockfd, buf, bytes) \
 365   qemu_co_send_recv(sockfd, buf, bytes, false)
 366 #define qemu_co_send(sockfd, buf, bytes) \
 367   qemu_co_send_recv(sockfd, buf, bytes, true)
 368
 369 typedef struct QEMUIOVector {
 370     struct iovec *iov;
 371     int niov;
 372     int nalloc;
 373     size_t size;
 374 } QEMUIOVector;
 375
 376 void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
 377 void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
 378 void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
 379 void qemu_iovec_concat(QEMUIOVector *dst,
 380                        QEMUIOVector *src, size_t soffset, size_t sbytes);
 381 void qemu_iovec_destroy(QEMUIOVector *qiov);
 382 void qemu_iovec_reset(QEMUIOVector *qiov);
 383 size_t qemu_iovec_to_buf(QEMUIOVector *qiov, size_t offset,
 384                          void *buf, size_t bytes);
 385 size_t qemu_iovec_from_buf(QEMUIOVector *qiov, size_t offset,
 386                            const void *buf, size_t bytes);
 387 size_t qemu_iovec_memset(QEMUIOVector *qiov, size_t offset,
 388                          int fillc, size_t bytes);
 389
 390 bool buffer_is_zero(const void *buf, size_t len);
 391
 392 void qemu_progress_init(int enabled, float min_skip);
 393 void qemu_progress_end(void);
 394 void qemu_progress_print(float delta, int max);
 395 const char *qemu_get_vm_name(void);
 396
 397 #define QEMU_FILE_TYPE_BIOS   0
 398 #define QEMU_FILE_TYPE_KEYMAP 1
 399 char *qemu_find_file(int type, const char *name);
 400
 401 /* OS specific functions */
 402 void os_setup_early_signal_handling(void);
 403 char *os_find_datadir(const char *argv0);
 404 void os_parse_cmd_args(int index, const char *optarg);
 405 void os_pidfile_error(void);
 406
 407 /* Convert a byte between binary and BCD.  */
 408 static inline uint8_t to_bcd(uint8_t val)
 409 {
 410     return ((val / 10) << 4) | (val % 10);
 411 }
 412
 413 static inline uint8_t from_bcd(uint8_t val)
 414 {
 415     return ((val >> 4) * 10) + (val & 0x0f);
 416 }
 417
 418 /* compute with 96 bit intermediate result: (a*b)/c */
 419 static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
 420 {
 421     union {
 422         uint64_t ll;
 423         struct {
 424 #ifdef HOST_WORDS_BIGENDIAN
 425             uint32_t high, low;
 426 #else
 427             uint32_t low, high;
 428 #endif
 429         } l;
 430     } u, res;
 431     uint64_t rl, rh;
 432
 433     u.ll = a;
 434     rl = (uint64_t)u.l.low * (uint64_t)b;
 435     rh = (uint64_t)u.l.high * (uint64_t)b;
 436     rh += (rl >> 32);
 437     res.l.high = rh / c;
 438     res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
 439     return res.ll;
 440 }
 441
 442 /* Round number down to multiple */
 443 #define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
 444
 445 /* Round number up to multiple */
 446 #define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
 447
 448 static inline bool is_power_of_2(uint64_t value)
 449 {
 450     if (!value) {
 451         return 0;
 452     }
 453
 454     return !(value & (value - 1));
 455 }
 456
 457 /* round down to the nearest power of 2*/
 458 int64_t pow2floor(int64_t value);
 459
 460 #include "module.h"
 461
 462 /*
 463  * Implementation of ULEB128 (http://en.wikipedia.org/wiki/LEB128)
 464  * Input is limited to 14-bit numbers
 465  */
 466
 467 int uleb128_encode_small(uint8_t *out, uint32_t n);
 468 int uleb128_decode_small(const uint8_t *in, uint32_t *n);
 469
 470 #endif