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 "compiler.h"
   6 #include "config-host.h"
   7
   8 #if defined(__arm__) || defined(__sparc__) || defined(__mips__) || defined(__hppa__) || defined(__ia64__)
   9 #define WORDS_ALIGNED
  10 #endif
  11
  12 #define TFR(expr) do { if ((expr) != -1) break; } while (errno == EINTR)
  13
  14 typedef struct QEMUTimer QEMUTimer;
  15 typedef struct QEMUFile QEMUFile;
  16 typedef struct DeviceState DeviceState;
  17
  18 struct Monitor;
  19 typedef struct Monitor Monitor;
  20
  21 /* we put basic includes here to avoid repeating them in device drivers */
  22 #include <stdlib.h>
  23 #include <stdio.h>
  24 #include <stdarg.h>
  25 #include <stdbool.h>
  26 #include <string.h>
  27 #include <strings.h>
  28 #include <inttypes.h>
  29 #include <limits.h>
  30 #include <time.h>
  31 #include <ctype.h>
  32 #include <errno.h>
  33 #include <unistd.h>
  34 #include <fcntl.h>
  35 #include <sys/stat.h>
  36 #include <sys/time.h>
  37 #include <assert.h>
  38 #include <signal.h>
  39 #include <glib.h>
  40
  41 #ifdef _WIN32
  42 #include "qemu-os-win32.h"
  43 #endif
  44
  45 #ifdef CONFIG_POSIX
  46 #include "qemu-os-posix.h"
  47 #endif
  48
  49 #ifndef O_LARGEFILE
  50 #define O_LARGEFILE 0
  51 #endif
  52 #ifndef O_BINARY
  53 #define O_BINARY 0
  54 #endif
  55 #ifndef MAP_ANONYMOUS
  56 #define MAP_ANONYMOUS MAP_ANON
  57 #endif
  58 #ifndef ENOMEDIUM
  59 #define ENOMEDIUM ENODEV
  60 #endif
  61 #if !defined(ENOTSUP)
  62 #define ENOTSUP 4096
  63 #endif
  64 #ifndef TIME_MAX
  65 #define TIME_MAX LONG_MAX
  66 #endif
  67
  68 /* HOST_LONG_BITS is the size of a native pointer in bits. */
  69 #if UINTPTR_MAX == UINT32_MAX
  70 # define HOST_LONG_BITS 32
  71 #elif UINTPTR_MAX == UINT64_MAX
  72 # define HOST_LONG_BITS 64
  73 #else
  74 # error Unknown pointer size
  75 #endif
  76
  77 #ifndef CONFIG_IOVEC
  78 #define CONFIG_IOVEC
  79 struct iovec {
  80     void *iov_base;
  81     size_t iov_len;
  82 };
  83 /*
  84  * Use the same value as Linux for now.
  85  */
  86 #define IOV_MAX         1024
  87 #else
  88 #include <sys/uio.h>
  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 #if !defined(lseek)
  97 # define lseek _lseeki64
  98 #endif
  99 int qemu_ftruncate64(int, int64_t);
 100 #if !defined(ftruncate)
 101 # define ftruncate qemu_ftruncate64
 102 #endif
 103
 104 static inline char *realpath(const char *path, char *resolved_path)
 105 {
 106     _fullpath(resolved_path, path, _MAX_PATH);
 107     return resolved_path;
 108 }
 109 #endif
 110
 111 /* icount */
 112 void configure_icount(const char *option);
 113 extern int use_icount;
 114
 115 /* FIXME: Remove NEED_CPU_H.  */
 116 #ifndef NEED_CPU_H
 117
 118 #include "osdep.h"
 119 #include "bswap.h"
 120
 121 #else
 122
 123 #include "cpu.h"
 124
 125 #endif /* !defined(NEED_CPU_H) */
 126
 127 /* main function, renamed */
 128 #if defined(CONFIG_COCOA)
 129 int qemu_main(int argc, char **argv, char **envp);
 130 #endif
 131
 132 void qemu_get_timedate(struct tm *tm, int offset);
 133 int qemu_timedate_diff(struct tm *tm);
 134
 135 /* cutils.c */
 136 void pstrcpy(char *buf, int buf_size, const char *str);
 137 char *pstrcat(char *buf, int buf_size, const char *s);
 138 int strstart(const char *str, const char *val, const char **ptr);
 139 int stristart(const char *str, const char *val, const char **ptr);
 140 int qemu_strnlen(const char *s, int max_len);
 141 time_t mktimegm(struct tm *tm);
 142 int qemu_fls(int i);
 143 int qemu_fdatasync(int fd);
 144 int fcntl_setfl(int fd, int flag);
 145 int qemu_parse_fd(const char *param);
 146
 147 /*
 148  * strtosz() suffixes used to specify the default treatment of an
 149  * argument passed to strtosz() without an explicit suffix.
 150  * These should be defined using upper case characters in the range
 151  * A-Z, as strtosz() will use qemu_toupper() on the given argument
 152  * prior to comparison.
 153  */
 154 #define STRTOSZ_DEFSUFFIX_TB    'T'
 155 #define STRTOSZ_DEFSUFFIX_GB    'G'
 156 #define STRTOSZ_DEFSUFFIX_MB    'M'
 157 #define STRTOSZ_DEFSUFFIX_KB    'K'
 158 #define STRTOSZ_DEFSUFFIX_B     'B'
 159 int64_t strtosz(const char *nptr, char **end);
 160 int64_t strtosz_suffix(const char *nptr, char **end, const char default_suffix);
 161 int64_t strtosz_suffix_unit(const char *nptr, char **end,
 162                             const char default_suffix, int64_t unit);
 163
 164 /* path.c */
 165 void init_paths(const char *prefix);
 166 const char *path(const char *pathname);
 167
 168 #define qemu_isalnum(c)         isalnum((unsigned char)(c))
 169 #define qemu_isalpha(c)         isalpha((unsigned char)(c))
 170 #define qemu_iscntrl(c)         iscntrl((unsigned char)(c))
 171 #define qemu_isdigit(c)         isdigit((unsigned char)(c))
 172 #define qemu_isgraph(c)         isgraph((unsigned char)(c))
 173 #define qemu_islower(c)         islower((unsigned char)(c))
 174 #define qemu_isprint(c)         isprint((unsigned char)(c))
 175 #define qemu_ispunct(c)         ispunct((unsigned char)(c))
 176 #define qemu_isspace(c)         isspace((unsigned char)(c))
 177 #define qemu_isupper(c)         isupper((unsigned char)(c))
 178 #define qemu_isxdigit(c)        isxdigit((unsigned char)(c))
 179 #define qemu_tolower(c)         tolower((unsigned char)(c))
 180 #define qemu_toupper(c)         toupper((unsigned char)(c))
 181 #define qemu_isascii(c)         isascii((unsigned char)(c))
 182 #define qemu_toascii(c)         toascii((unsigned char)(c))
 183
 184 void *qemu_oom_check(void *ptr);
 185
 186 int qemu_open(const char *name, int flags, ...);
 187 ssize_t qemu_write_full(int fd, const void *buf, size_t count)
 188     QEMU_WARN_UNUSED_RESULT;
 189 ssize_t qemu_send_full(int fd, const void *buf, size_t count, int flags)
 190     QEMU_WARN_UNUSED_RESULT;
 191 ssize_t qemu_recv_full(int fd, void *buf, size_t count, int flags)
 192     QEMU_WARN_UNUSED_RESULT;
 193
 194 #ifndef _WIN32
 195 int qemu_eventfd(int pipefd[2]);
 196 int qemu_pipe(int pipefd[2]);
 197 #endif
 198
 199 #ifdef _WIN32
 200 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags)
 201 #else
 202 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags)
 203 #endif
 204
 205 int qemu_recvv(int sockfd, struct iovec *iov, int len, int iov_offset);
 206 int qemu_sendv(int sockfd, struct iovec *iov, int len, int iov_offset);
 207
 208 /* Error handling.  */
 209
 210 void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
 211
 212 struct ParallelIOArg {
 213     void *buffer;
 214     int count;
 215 };
 216
 217 typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
 218
 219 /* A load of opaque types so that device init declarations don't have to
 220    pull in all the real definitions.  */
 221 typedef struct NICInfo NICInfo;
 222 typedef struct HCIInfo HCIInfo;
 223 typedef struct AudioState AudioState;
 224 typedef struct BlockDriverState BlockDriverState;
 225 typedef struct DriveInfo DriveInfo;
 226 typedef struct DisplayState DisplayState;
 227 typedef struct DisplayChangeListener DisplayChangeListener;
 228 typedef struct DisplaySurface DisplaySurface;
 229 typedef struct DisplayAllocator DisplayAllocator;
 230 typedef struct PixelFormat PixelFormat;
 231 typedef struct TextConsole TextConsole;
 232 typedef TextConsole QEMUConsole;
 233 typedef struct CharDriverState CharDriverState;
 234 typedef struct MACAddr MACAddr;
 235 typedef struct VLANState VLANState;
 236 typedef struct VLANClientState VLANClientState;
 237 typedef struct i2c_bus i2c_bus;
 238 typedef struct ISABus ISABus;
 239 typedef struct SMBusDevice SMBusDevice;
 240 typedef struct PCIHostState PCIHostState;
 241 typedef struct PCIExpressHost PCIExpressHost;
 242 typedef struct PCIBus PCIBus;
 243 typedef struct PCIDevice PCIDevice;
 244 typedef struct PCIExpressDevice PCIExpressDevice;
 245 typedef struct PCIBridge PCIBridge;
 246 typedef struct PCIEAERMsg PCIEAERMsg;
 247 typedef struct PCIEAERLog PCIEAERLog;
 248 typedef struct PCIEAERErr PCIEAERErr;
 249 typedef struct PCIEPort PCIEPort;
 250 typedef struct PCIESlot PCIESlot;
 251 typedef struct SerialState SerialState;
 252 typedef struct IRQState *qemu_irq;
 253 typedef struct PCMCIACardState PCMCIACardState;
 254 typedef struct MouseTransformInfo MouseTransformInfo;
 255 typedef struct uWireSlave uWireSlave;
 256 typedef struct I2SCodec I2SCodec;
 257 typedef struct SSIBus SSIBus;
 258 typedef struct EventNotifier EventNotifier;
 259 typedef struct VirtIODevice VirtIODevice;
 260 typedef struct QEMUSGList QEMUSGList;
 261 typedef struct SHPCDevice SHPCDevice;
 262
 263 typedef uint64_t pcibus_t;
 264
 265 typedef enum LostTickPolicy {
 266     LOST_TICK_DISCARD,
 267     LOST_TICK_DELAY,
 268     LOST_TICK_MERGE,
 269     LOST_TICK_SLEW,
 270     LOST_TICK_MAX
 271 } LostTickPolicy;
 272
 273 void tcg_exec_init(unsigned long tb_size);
 274 bool tcg_enabled(void);
 275
 276 void cpu_exec_init_all(void);
 277
 278 /* CPU save/load.  */
 279 void cpu_save(QEMUFile *f, void *opaque);
 280 int cpu_load(QEMUFile *f, void *opaque, int version_id);
 281
 282 /* Unblock cpu */
 283 void qemu_cpu_kick(void *env);
 284 void qemu_cpu_kick_self(void);
 285 int qemu_cpu_is_self(void *env);
 286 bool all_cpu_threads_idle(void);
 287
 288 /* work queue */
 289 struct qemu_work_item {
 290     struct qemu_work_item *next;
 291     void (*func)(void *data);
 292     void *data;
 293     int done;
 294 };
 295
 296 #ifdef CONFIG_USER_ONLY
 297 #define qemu_init_vcpu(env) do { } while (0)
 298 #else
 299 void qemu_init_vcpu(void *env);
 300 #endif
 301
 302 /**
 303  * Sends an iovec (or optionally a part of it) down a socket, yielding
 304  * when the socket is full.
 305  */
 306 int qemu_co_sendv(int sockfd, struct iovec *iov,
 307                   int len, int iov_offset);
 308
 309 /**
 310  * Receives data into an iovec (or optionally into a part of it) from
 311  * a socket, yielding when there is no data in the socket.
 312  */
 313 int qemu_co_recvv(int sockfd, struct iovec *iov,
 314                   int len, int iov_offset);
 315
 316
 317 /**
 318  * Sends a buffer down a socket, yielding when the socket is full.
 319  */
 320 int qemu_co_send(int sockfd, void *buf, int len);
 321
 322 /**
 323  * Receives data into a buffer from a socket, yielding when there
 324  * is no data in the socket.
 325  */
 326 int qemu_co_recv(int sockfd, void *buf, int len);
 327
 328
 329 typedef struct QEMUIOVector {
 330     struct iovec *iov;
 331     int niov;
 332     int nalloc;
 333     size_t size;
 334 } QEMUIOVector;
 335
 336 void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
 337 void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
 338 void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
 339 void qemu_iovec_copy(QEMUIOVector *dst, QEMUIOVector *src, uint64_t skip,
 340     size_t size);
 341 void qemu_iovec_concat(QEMUIOVector *dst, QEMUIOVector *src, size_t size);
 342 void qemu_iovec_destroy(QEMUIOVector *qiov);
 343 void qemu_iovec_reset(QEMUIOVector *qiov);
 344 void qemu_iovec_to_buffer(QEMUIOVector *qiov, void *buf);
 345 void qemu_iovec_from_buffer(QEMUIOVector *qiov, const void *buf, size_t count);
 346 void qemu_iovec_memset(QEMUIOVector *qiov, int c, size_t count);
 347 void qemu_iovec_memset_skip(QEMUIOVector *qiov, int c, size_t count,
 348                             size_t skip);
 349
 350 bool buffer_is_zero(const void *buf, size_t len);
 351
 352 void qemu_progress_init(int enabled, float min_skip);
 353 void qemu_progress_end(void);
 354 void qemu_progress_print(float delta, int max);
 355
 356 #define QEMU_FILE_TYPE_BIOS   0
 357 #define QEMU_FILE_TYPE_KEYMAP 1
 358 char *qemu_find_file(int type, const char *name);
 359
 360 /* OS specific functions */
 361 void os_setup_early_signal_handling(void);
 362 char *os_find_datadir(const char *argv0);
 363 void os_parse_cmd_args(int index, const char *optarg);
 364 void os_pidfile_error(void);
 365
 366 /* Convert a byte between binary and BCD.  */
 367 static inline uint8_t to_bcd(uint8_t val)
 368 {
 369     return ((val / 10) << 4) | (val % 10);
 370 }
 371
 372 static inline uint8_t from_bcd(uint8_t val)
 373 {
 374     return ((val >> 4) * 10) + (val & 0x0f);
 375 }
 376
 377 /* compute with 96 bit intermediate result: (a*b)/c */
 378 static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
 379 {
 380     union {
 381         uint64_t ll;
 382         struct {
 383 #ifdef HOST_WORDS_BIGENDIAN
 384             uint32_t high, low;
 385 #else
 386             uint32_t low, high;
 387 #endif
 388         } l;
 389     } u, res;
 390     uint64_t rl, rh;
 391
 392     u.ll = a;
 393     rl = (uint64_t)u.l.low * (uint64_t)b;
 394     rh = (uint64_t)u.l.high * (uint64_t)b;
 395     rh += (rl >> 32);
 396     res.l.high = rh / c;
 397     res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
 398     return res.ll;
 399 }
 400
 401 /* Round number down to multiple */
 402 #define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
 403
 404 /* Round number up to multiple */
 405 #define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
 406
 407 #include "module.h"
 408
 409 #endif