include/qemu-common.h

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