LXR qemu/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
  15typedef struct QEMUTimer QEMUTimer;
  16typedef struct QEMUFile QEMUFile;
  17typedef struct DeviceState DeviceState;
  18
  19struct Monitor;
  20typedef struct Monitor Monitor;
  21typedef 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
  84struct 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
  96typedef 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
 104int qemu_ftruncate64(int, int64_t);
 105#if !defined(ftruncate)
 106# define ftruncate qemu_ftruncate64
 107#endif
 108
 109static 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 */
 117void configure_icount(const char *option);
 118extern 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)
 134int qemu_main(int argc, char **argv, char **envp);
 135#endif
 136
 137void qemu_get_timedate(struct tm *tm, int offset);
 138int 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 */
 153static inline bool is_help_option(const char *s)
 154{
 155    return !strcmp(s, "?") || !strcmp(s, "help");
 156}
 157
 158/* cutils.c */
 159void pstrcpy(char *buf, int buf_size, const char *str);
 160void strpadcpy(char *buf, int buf_size, const char *str, char pad);
 161char *pstrcat(char *buf, int buf_size, const char *s);
 162int strstart(const char *str, const char *val, const char **ptr);
 163int stristart(const char *str, const char *val, const char **ptr);
 164int qemu_strnlen(const char *s, int max_len);
 165time_t mktimegm(struct tm *tm);
 166int qemu_fls(int i);
 167int qemu_fdatasync(int fd);
 168int fcntl_setfl(int fd, int flag);
 169int qemu_parse_fd(const char *param);
 170int 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'
 184int64_t strtosz(const char *nptr, char **end);
 185int64_t strtosz_suffix(const char *nptr, char **end, const char default_suffix);
 186int64_t strtosz_suffix_unit(const char *nptr, char **end,
 187                            const char default_suffix, int64_t unit);
 188
 189/* path.c */
 190void init_paths(const char *prefix);
 191const 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
 209void *qemu_oom_check(void *ptr);
 210
 211int qemu_open(const char *name, int flags, ...);
 212int qemu_close(int fd);
 213ssize_t qemu_write_full(int fd, const void *buf, size_t count)
 214    QEMU_WARN_UNUSED_RESULT;
 215ssize_t qemu_send_full(int fd, const void *buf, size_t count, int flags)
 216    QEMU_WARN_UNUSED_RESULT;
 217ssize_t qemu_recv_full(int fd, void *buf, size_t count, int flags)
 218    QEMU_WARN_UNUSED_RESULT;
 219
 220#ifndef _WIN32
 221int qemu_eventfd(int pipefd[2]);
 222int qemu_pipe(int pipefd[2]);
 223#endif
 224
 225#ifdef _WIN32
 226#define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags)
 227#else
 228#define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags)
 229#endif
 230
 231/* Error handling.  */
 232
 233void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
 234
 235struct ParallelIOArg {
 236    void *buffer;
 237    int count;
 238};
 239
 240typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
 241
 242/* A load of opaque types so that device init declarations don't have to
 243   pull in all the real definitions.  */
 244typedef struct NICInfo NICInfo;
 245typedef struct HCIInfo HCIInfo;
 246typedef struct AudioState AudioState;
 247typedef struct BlockDriverState BlockDriverState;
 248typedef struct DriveInfo DriveInfo;
 249typedef struct DisplayState DisplayState;
 250typedef struct DisplayChangeListener DisplayChangeListener;
 251typedef struct DisplaySurface DisplaySurface;
 252typedef struct DisplayAllocator DisplayAllocator;
 253typedef struct PixelFormat PixelFormat;
 254typedef struct TextConsole TextConsole;
 255typedef TextConsole QEMUConsole;
 256typedef struct CharDriverState CharDriverState;
 257typedef struct MACAddr MACAddr;
 258typedef struct NetClientState NetClientState;
 259typedef struct i2c_bus i2c_bus;
 260typedef struct ISABus ISABus;
 261typedef struct ISADevice ISADevice;
 262typedef struct SMBusDevice SMBusDevice;
 263typedef struct PCIHostState PCIHostState;
 264typedef struct PCIExpressHost PCIExpressHost;
 265typedef struct PCIBus PCIBus;
 266typedef struct PCIDevice PCIDevice;
 267typedef struct PCIExpressDevice PCIExpressDevice;
 268typedef struct PCIBridge PCIBridge;
 269typedef struct PCIEAERMsg PCIEAERMsg;
 270typedef struct PCIEAERLog PCIEAERLog;
 271typedef struct PCIEAERErr PCIEAERErr;
 272typedef struct PCIEPort PCIEPort;
 273typedef struct PCIESlot PCIESlot;
 274typedef struct MSIMessage MSIMessage;
 275typedef struct SerialState SerialState;
 276typedef struct IRQState *qemu_irq;
 277typedef struct PCMCIACardState PCMCIACardState;
 278typedef struct MouseTransformInfo MouseTransformInfo;
 279typedef struct uWireSlave uWireSlave;
 280typedef struct I2SCodec I2SCodec;
 281typedef struct SSIBus SSIBus;
 282typedef struct EventNotifier EventNotifier;
 283typedef struct VirtIODevice VirtIODevice;
 284typedef struct QEMUSGList QEMUSGList;
 285typedef struct SHPCDevice SHPCDevice;
 286
 287typedef uint64_t pcibus_t;
 288
 289typedef enum LostTickPolicy {
 290    LOST_TICK_DISCARD,
 291    LOST_TICK_DELAY,
 292    LOST_TICK_MERGE,
 293    LOST_TICK_SLEW,
 294    LOST_TICK_MAX
 295} LostTickPolicy;
 296
 297typedef struct PCIHostDeviceAddress {
 298    unsigned int domain;
 299    unsigned int bus;
 300    unsigned int slot;
 301    unsigned int function;
 302} PCIHostDeviceAddress;
 303
 304void tcg_exec_init(unsigned long tb_size);
 305bool tcg_enabled(void);
 306
 307void cpu_exec_init_all(void);
 308
 309/* CPU save/load.  */
 310void cpu_save(QEMUFile *f, void *opaque);
 311int cpu_load(QEMUFile *f, void *opaque, int version_id);
 312
 313/* Unblock cpu */
 314void qemu_cpu_kick(void *env);
 315void qemu_cpu_kick_self(void);
 316int qemu_cpu_is_self(void *env);
 317
 318/* work queue */
 319struct qemu_work_item {
 320    struct qemu_work_item *next;
 321    void (*func)(void *data);
 322    void *data;
 323    int done;
 324};
 325
 326#ifdef CONFIG_USER_ONLY
 327#define qemu_init_vcpu(env) do { } while (0)
 328#else
 329void qemu_init_vcpu(void *env);
 330#endif
 331
 332
 333/**
 334 * Sends a (part of) iovec down a socket, yielding when the socket is full, or
 335 * Receives data into a (part of) iovec from a socket,
 336 * yielding when there is no data in the socket.
 337 * The same interface as qemu_sendv_recvv(), with added yielding.
 338 * XXX should mark these as coroutine_fn
 339 */
 340ssize_t qemu_co_sendv_recvv(int sockfd, struct iovec *iov, unsigned iov_cnt,
 341                            size_t offset, size_t bytes, bool do_send);
 342#define qemu_co_recvv(sockfd, iov, iov_cnt, offset, bytes) \
 343  qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, false)
 344#define qemu_co_sendv(sockfd, iov, iov_cnt, offset, bytes) \
 345  qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, true)
 346
 347/**
 348 * The same as above, but with just a single buffer
 349 */
 350ssize_t qemu_co_send_recv(int sockfd, void *buf, size_t bytes, bool do_send);
 351#define qemu_co_recv(sockfd, buf, bytes) \
 352  qemu_co_send_recv(sockfd, buf, bytes, false)
 353#define qemu_co_send(sockfd, buf, bytes) \
 354  qemu_co_send_recv(sockfd, buf, bytes, true)
 355
 356typedef struct QEMUIOVector {
 357    struct iovec *iov;
 358    int niov;
 359    int nalloc;
 360    size_t size;
 361} QEMUIOVector;
 362
 363void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
 364void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
 365void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
 366void qemu_iovec_concat(QEMUIOVector *dst,
 367                       QEMUIOVector *src, size_t soffset, size_t sbytes);
 368void qemu_iovec_destroy(QEMUIOVector *qiov);
 369void qemu_iovec_reset(QEMUIOVector *qiov);
 370size_t qemu_iovec_to_buf(QEMUIOVector *qiov, size_t offset,
 371                         void *buf, size_t bytes);
 372size_t qemu_iovec_from_buf(QEMUIOVector *qiov, size_t offset,
 373                           const void *buf, size_t bytes);
 374size_t qemu_iovec_memset(QEMUIOVector *qiov, size_t offset,
 375                         int fillc, size_t bytes);
 376
 377bool buffer_is_zero(const void *buf, size_t len);
 378
 379void qemu_progress_init(int enabled, float min_skip);
 380void qemu_progress_end(void);
 381void qemu_progress_print(float delta, int max);
 382const char *qemu_get_vm_name(void);
 383
 384#define QEMU_FILE_TYPE_BIOS   0
 385#define QEMU_FILE_TYPE_KEYMAP 1
 386char *qemu_find_file(int type, const char *name);
 387
 388/* OS specific functions */
 389void os_setup_early_signal_handling(void);
 390char *os_find_datadir(const char *argv0);
 391void os_parse_cmd_args(int index, const char *optarg);
 392void os_pidfile_error(void);
 393
 394/* Convert a byte between binary and BCD.  */
 395static inline uint8_t to_bcd(uint8_t val)
 396{
 397    return ((val / 10) << 4) | (val % 10);
 398}
 399
 400static inline uint8_t from_bcd(uint8_t val)
 401{
 402    return ((val >> 4) * 10) + (val & 0x0f);
 403}
 404
 405/* compute with 96 bit intermediate result: (a*b)/c */
 406static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
 407{
 408    union {
 409        uint64_t ll;
 410        struct {
 411#ifdef HOST_WORDS_BIGENDIAN
 412            uint32_t high, low;
 413#else
 414            uint32_t low, high;
 415#endif
 416        } l;
 417    } u, res;
 418    uint64_t rl, rh;
 419
 420    u.ll = a;
 421    rl = (uint64_t)u.l.low * (uint64_t)b;
 422    rh = (uint64_t)u.l.high * (uint64_t)b;
 423    rh += (rl >> 32);
 424    res.l.high = rh / c;
 425    res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
 426    return res.ll;
 427}
 428
 429/* Round number down to multiple */
 430#define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
 431
 432/* Round number up to multiple */
 433#define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
 434
 435static inline bool is_power_of_2(uint64_t value)
 436{
 437    if (!value) {
 438        return 0;
 439    }
 440
 441    return !(value & (value - 1));
 442}
 443
 444/* round down to the nearest power of 2*/
 445int64_t pow2floor(int64_t value);
 446
 447#include "module.h"
 448
 449/*
 450 * Implementation of ULEB128 (http://en.wikipedia.org/wiki/LEB128)
 451 * Input is limited to 14-bit numbers
 452 */
 453
 454int uleb128_encode_small(uint8_t *out, uint32_t n);
 455int uleb128_decode_small(const uint8_t *in, uint32_t *n);
 456
 457#endif
 458