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 QEMUBH QEMUBH;
  18 typedef struct DeviceState DeviceState;
  19
  20 struct Monitor;
  21 typedef struct Monitor Monitor;
  22 typedef struct MigrationParams MigrationParams;
  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 #include <signal.h>
  42 #include <glib.h>
  43
  44 #ifdef _WIN32
  45 #include "qemu-os-win32.h"
  46 #endif
  47
  48 #ifdef CONFIG_POSIX
  49 #include "qemu-os-posix.h"
  50 #endif
  51
  52 #ifndef O_LARGEFILE
  53 #define O_LARGEFILE 0
  54 #endif
  55 #ifndef O_BINARY
  56 #define O_BINARY 0
  57 #endif
  58 #ifndef MAP_ANONYMOUS
  59 #define MAP_ANONYMOUS MAP_ANON
  60 #endif
  61 #ifndef ENOMEDIUM
  62 #define ENOMEDIUM ENODEV
  63 #endif
  64 #if !defined(ENOTSUP)
  65 #define ENOTSUP 4096
  66 #endif
  67 #if !defined(ECANCELED)
  68 #define ECANCELED 4097
  69 #endif
  70 #ifndef TIME_MAX
  71 #define TIME_MAX LONG_MAX
  72 #endif
  73
  74 /* HOST_LONG_BITS is the size of a native pointer in bits. */
  75 #if UINTPTR_MAX == UINT32_MAX
  76 # define HOST_LONG_BITS 32
  77 #elif UINTPTR_MAX == UINT64_MAX
  78 # define HOST_LONG_BITS 64
  79 #else
  80 # error Unknown pointer size
  81 #endif
  82
  83 #ifndef CONFIG_IOVEC
  84 #define CONFIG_IOVEC
  85 struct iovec {
  86     void *iov_base;
  87     size_t iov_len;
  88 };
  89 /*
  90  * Use the same value as Linux for now.
  91  */
  92 #define IOV_MAX         1024
  93 #else
  94 #include <sys/uio.h>
  95 #endif
  96
  97 typedef int (*fprintf_function)(FILE *f, const char *fmt, ...)
  98     GCC_FMT_ATTR(2, 3);
  99
 100 #ifdef _WIN32
 101 #define fsync _commit
 102 #if !defined(lseek)
 103 # define lseek _lseeki64
 104 #endif
 105 int qemu_ftruncate64(int, int64_t);
 106 #if !defined(ftruncate)
 107 # define ftruncate qemu_ftruncate64
 108 #endif
 109
 110 static inline char *realpath(const char *path, char *resolved_path)
 111 {
 112     _fullpath(resolved_path, path, _MAX_PATH);
 113     return resolved_path;
 114 }
 115 #endif
 116
 117 /* icount */
 118 void configure_icount(const char *option);
 119 extern int use_icount;
 120
 121 /* FIXME: Remove NEED_CPU_H.  */
 122 #ifndef NEED_CPU_H
 123
 124 #include "osdep.h"
 125 #include "bswap.h"
 126
 127 #else
 128
 129 #include "cpu.h"
 130
 131 #endif /* !defined(NEED_CPU_H) */
 132
 133 /* main function, renamed */
 134 #if defined(CONFIG_COCOA)
 135 int qemu_main(int argc, char **argv, char **envp);
 136 #endif
 137
 138 void qemu_get_timedate(struct tm *tm, int offset);
 139 int qemu_timedate_diff(struct tm *tm);
 140
 141 /**
 142  * is_help_option:
 143  * @s: string to test
 144  *
 145  * Check whether @s is one of the standard strings which indicate
 146  * that the user is asking for a list of the valid values for a
 147  * command option like -cpu or -M. The current accepted strings
 148  * are 'help' and '?'. '?' is deprecated (it is a shell wildcard
 149  * which makes it annoying to use in a reliable way) but provided
 150  * for backwards compatibility.
 151  *
 152  * Returns: true if @s is a request for a list.
 153  */
 154 static inline bool is_help_option(const char *s)
 155 {
 156     return !strcmp(s, "?") || !strcmp(s, "help");
 157 }
 158
 159 /* cutils.c */
 160 void pstrcpy(char *buf, int buf_size, const char *str);
 161 void strpadcpy(char *buf, int buf_size, const char *str, char pad);
 162 char *pstrcat(char *buf, int buf_size, const char *s);
 163 int strstart(const char *str, const char *val, const char **ptr);
 164 int stristart(const char *str, const char *val, const char **ptr);
 165 int qemu_strnlen(const char *s, int max_len);
 166 time_t mktimegm(struct tm *tm);
 167 int qemu_fls(int i);
 168 int qemu_fdatasync(int fd);
 169 int fcntl_setfl(int fd, int flag);
 170 int qemu_parse_fd(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_pipe(int pipefd[2]);
 222 #endif
 223
 224 #ifdef _WIN32
 225 /* MinGW needs type casts for the 'buf' and 'optval' arguments. */
 226 #define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
 227     getsockopt(sockfd, level, optname, (void *)optval, optlen)
 228 #define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
 229     setsockopt(sockfd, level, optname, (const void *)optval, optlen)
 230 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags)
 231 #define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
 232     sendto(sockfd, (const void *)buf, len, flags, destaddr, addrlen)
 233 #else
 234 #define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
 235     getsockopt(sockfd, level, optname, optval, optlen)
 236 #define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
 237     setsockopt(sockfd, level, optname, optval, optlen)
 238 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags)
 239 #define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
 240     sendto(sockfd, buf, len, flags, destaddr, addrlen)
 241 #endif
 242
 243 /* Error handling.  */
 244
 245 void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
 246
 247 struct ParallelIOArg {
 248     void *buffer;
 249     int count;
 250 };
 251
 252 typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
 253
 254 /* A load of opaque types so that device init declarations don't have to
 255    pull in all the real definitions.  */
 256 typedef struct NICInfo NICInfo;
 257 typedef struct HCIInfo HCIInfo;
 258 typedef struct AudioState AudioState;
 259 typedef struct BlockDriverState BlockDriverState;
 260 typedef struct DriveInfo DriveInfo;
 261 typedef struct DisplayState DisplayState;
 262 typedef struct DisplayChangeListener DisplayChangeListener;
 263 typedef struct DisplaySurface DisplaySurface;
 264 typedef struct DisplayAllocator DisplayAllocator;
 265 typedef struct PixelFormat PixelFormat;
 266 typedef struct TextConsole TextConsole;
 267 typedef TextConsole QEMUConsole;
 268 typedef struct CharDriverState CharDriverState;
 269 typedef struct MACAddr MACAddr;
 270 typedef struct NetClientState NetClientState;
 271 typedef struct i2c_bus i2c_bus;
 272 typedef struct ISABus ISABus;
 273 typedef struct ISADevice ISADevice;
 274 typedef struct SMBusDevice SMBusDevice;
 275 typedef struct PCIHostState PCIHostState;
 276 typedef struct PCIExpressHost PCIExpressHost;
 277 typedef struct PCIBus PCIBus;
 278 typedef struct PCIDevice PCIDevice;
 279 typedef struct PCIExpressDevice PCIExpressDevice;
 280 typedef struct PCIBridge PCIBridge;
 281 typedef struct PCIEAERMsg PCIEAERMsg;
 282 typedef struct PCIEAERLog PCIEAERLog;
 283 typedef struct PCIEAERErr PCIEAERErr;
 284 typedef struct PCIEPort PCIEPort;
 285 typedef struct PCIESlot PCIESlot;
 286 typedef struct MSIMessage MSIMessage;
 287 typedef struct SerialState SerialState;
 288 typedef struct IRQState *qemu_irq;
 289 typedef struct PCMCIACardState PCMCIACardState;
 290 typedef struct MouseTransformInfo MouseTransformInfo;
 291 typedef struct uWireSlave uWireSlave;
 292 typedef struct I2SCodec I2SCodec;
 293 typedef struct SSIBus SSIBus;
 294 typedef struct EventNotifier EventNotifier;
 295 typedef struct VirtIODevice VirtIODevice;
 296 typedef struct QEMUSGList QEMUSGList;
 297 typedef struct SHPCDevice SHPCDevice;
 298
 299 typedef uint64_t pcibus_t;
 300
 301 typedef enum LostTickPolicy {
 302     LOST_TICK_DISCARD,
 303     LOST_TICK_DELAY,
 304     LOST_TICK_MERGE,
 305     LOST_TICK_SLEW,
 306     LOST_TICK_MAX
 307 } LostTickPolicy;
 308
 309 typedef struct PCIHostDeviceAddress {
 310     unsigned int domain;
 311     unsigned int bus;
 312     unsigned int slot;
 313     unsigned int function;
 314 } PCIHostDeviceAddress;
 315
 316 void tcg_exec_init(unsigned long tb_size);
 317 bool tcg_enabled(void);
 318
 319 void cpu_exec_init_all(void);
 320
 321 /* CPU save/load.  */
 322 void cpu_save(QEMUFile *f, void *opaque);
 323 int cpu_load(QEMUFile *f, void *opaque, int version_id);
 324
 325 /* Unblock cpu */
 326 void qemu_cpu_kick_self(void);
 327
 328 /* work queue */
 329 struct qemu_work_item {
 330     struct qemu_work_item *next;
 331     void (*func)(void *data);
 332     void *data;
 333     int done;
 334 };
 335
 336 #ifdef CONFIG_USER_ONLY
 337 #define qemu_init_vcpu(env) do { } while (0)
 338 #else
 339 void qemu_init_vcpu(void *env);
 340 #endif
 341
 342
 343 /**
 344  * Sends a (part of) iovec down a socket, yielding when the socket is full, or
 345  * Receives data into a (part of) iovec from a socket,
 346  * yielding when there is no data in the socket.
 347  * The same interface as qemu_sendv_recvv(), with added yielding.
 348  * XXX should mark these as coroutine_fn
 349  */
 350 ssize_t qemu_co_sendv_recvv(int sockfd, struct iovec *iov, unsigned iov_cnt,
 351                             size_t offset, size_t bytes, bool do_send);
 352 #define qemu_co_recvv(sockfd, iov, iov_cnt, offset, bytes) \
 353   qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, false)
 354 #define qemu_co_sendv(sockfd, iov, iov_cnt, offset, bytes) \
 355   qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, true)
 356
 357 /**
 358  * The same as above, but with just a single buffer
 359  */
 360 ssize_t qemu_co_send_recv(int sockfd, void *buf, size_t bytes, bool do_send);
 361 #define qemu_co_recv(sockfd, buf, bytes) \
 362   qemu_co_send_recv(sockfd, buf, bytes, false)
 363 #define qemu_co_send(sockfd, buf, bytes) \
 364   qemu_co_send_recv(sockfd, buf, bytes, true)
 365
 366 typedef struct QEMUIOVector {
 367     struct iovec *iov;
 368     int niov;
 369     int nalloc;
 370     size_t size;
 371 } QEMUIOVector;
 372
 373 void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
 374 void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
 375 void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
 376 void qemu_iovec_concat(QEMUIOVector *dst,
 377                        QEMUIOVector *src, size_t soffset, size_t sbytes);
 378 void qemu_iovec_destroy(QEMUIOVector *qiov);
 379 void qemu_iovec_reset(QEMUIOVector *qiov);
 380 size_t qemu_iovec_to_buf(QEMUIOVector *qiov, size_t offset,
 381                          void *buf, size_t bytes);
 382 size_t qemu_iovec_from_buf(QEMUIOVector *qiov, size_t offset,
 383                            const void *buf, size_t bytes);
 384 size_t qemu_iovec_memset(QEMUIOVector *qiov, size_t offset,
 385                          int fillc, size_t bytes);
 386
 387 bool buffer_is_zero(const void *buf, size_t len);
 388
 389 void qemu_progress_init(int enabled, float min_skip);
 390 void qemu_progress_end(void);
 391 void qemu_progress_print(float delta, int max);
 392 const char *qemu_get_vm_name(void);
 393
 394 #define QEMU_FILE_TYPE_BIOS   0
 395 #define QEMU_FILE_TYPE_KEYMAP 1
 396 char *qemu_find_file(int type, const char *name);
 397
 398 /* OS specific functions */
 399 void os_setup_early_signal_handling(void);
 400 char *os_find_datadir(const char *argv0);
 401 void os_parse_cmd_args(int index, const char *optarg);
 402 void os_pidfile_error(void);
 403
 404 /* Convert a byte between binary and BCD.  */
 405 static inline uint8_t to_bcd(uint8_t val)
 406 {
 407     return ((val / 10) << 4) | (val % 10);
 408 }
 409
 410 static inline uint8_t from_bcd(uint8_t val)
 411 {
 412     return ((val >> 4) * 10) + (val & 0x0f);
 413 }
 414
 415 /* compute with 96 bit intermediate result: (a*b)/c */
 416 static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
 417 {
 418     union {
 419         uint64_t ll;
 420         struct {
 421 #ifdef HOST_WORDS_BIGENDIAN
 422             uint32_t high, low;
 423 #else
 424             uint32_t low, high;
 425 #endif
 426         } l;
 427     } u, res;
 428     uint64_t rl, rh;
 429
 430     u.ll = a;
 431     rl = (uint64_t)u.l.low * (uint64_t)b;
 432     rh = (uint64_t)u.l.high * (uint64_t)b;
 433     rh += (rl >> 32);
 434     res.l.high = rh / c;
 435     res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
 436     return res.ll;
 437 }
 438
 439 /* Round number down to multiple */
 440 #define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
 441
 442 /* Round number up to multiple */
 443 #define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
 444
 445 static inline bool is_power_of_2(uint64_t value)
 446 {
 447     if (!value) {
 448         return 0;
 449     }
 450
 451     return !(value & (value - 1));
 452 }
 453
 454 /* round down to the nearest power of 2*/
 455 int64_t pow2floor(int64_t value);
 456
 457 #include "module.h"
 458
 459 /*
 460  * Implementation of ULEB128 (http://en.wikipedia.org/wiki/LEB128)
 461  * Input is limited to 14-bit numbers
 462  */
 463
 464 int uleb128_encode_small(uint8_t *out, uint32_t n);
 465 int uleb128_decode_small(const uint8_t *in, uint32_t *n);
 466
 467 #endif