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-compat.h"
  44 #include "qemu/option.h"
  45
  46 #ifdef _WIN32
  47 #include "sysemu/os-win32.h"
  48 #endif
  49
  50 #ifdef CONFIG_POSIX
  51 #include "sysemu/os-posix.h"
  52 #endif
  53
  54 #ifndef O_LARGEFILE
  55 #define O_LARGEFILE 0
  56 #endif
  57 #ifndef O_BINARY
  58 #define O_BINARY 0
  59 #endif
  60 #ifndef MAP_ANONYMOUS
  61 #define MAP_ANONYMOUS MAP_ANON
  62 #endif
  63 #ifndef ENOMEDIUM
  64 #define ENOMEDIUM ENODEV
  65 #endif
  66 #if !defined(ENOTSUP)
  67 #define ENOTSUP 4096
  68 #endif
  69 #if !defined(ECANCELED)
  70 #define ECANCELED 4097
  71 #endif
  72 #if !defined(EMEDIUMTYPE)
  73 #define EMEDIUMTYPE 4098
  74 #endif
  75 #ifndef TIME_MAX
  76 #define TIME_MAX LONG_MAX
  77 #endif
  78
  79 /* HOST_LONG_BITS is the size of a native pointer in bits. */
  80 #if UINTPTR_MAX == UINT32_MAX
  81 # define HOST_LONG_BITS 32
  82 #elif UINTPTR_MAX == UINT64_MAX
  83 # define HOST_LONG_BITS 64
  84 #else
  85 # error Unknown pointer size
  86 #endif
  87
  88 typedef int (*fprintf_function)(FILE *f, const char *fmt, ...)
  89     GCC_FMT_ATTR(2, 3);
  90
  91 #ifdef _WIN32
  92 #define fsync _commit
  93 #if !defined(lseek)
  94 # define lseek _lseeki64
  95 #endif
  96 int qemu_ftruncate64(int, int64_t);
  97 #if !defined(ftruncate)
  98 # define ftruncate qemu_ftruncate64
  99 #endif
 100
 101 static inline char *realpath(const char *path, char *resolved_path)
 102 {
 103     _fullpath(resolved_path, path, _MAX_PATH);
 104     return resolved_path;
 105 }
 106 #endif
 107
 108 void cpu_ticks_init(void);
 109
 110 /* icount */
 111 void configure_icount(QemuOpts *opts, Error **errp);
 112 extern int use_icount;
 113 extern int icount_align_option;
 114 /* drift information for info jit command */
 115 extern int64_t max_delay;
 116 extern int64_t max_advance;
 117 void dump_drift_info(FILE *f, fprintf_function cpu_fprintf);
 118
 119 #include "qemu/osdep.h"
 120 #include "qemu/bswap.h"
 121
 122 /* FIXME: Remove NEED_CPU_H.  */
 123 #ifdef NEED_CPU_H
 124 #include "cpu.h"
 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 /**
 136  * is_help_option:
 137  * @s: string to test
 138  *
 139  * Check whether @s is one of the standard strings which indicate
 140  * that the user is asking for a list of the valid values for a
 141  * command option like -cpu or -M. The current accepted strings
 142  * are 'help' and '?'. '?' is deprecated (it is a shell wildcard
 143  * which makes it annoying to use in a reliable way) but provided
 144  * for backwards compatibility.
 145  *
 146  * Returns: true if @s is a request for a list.
 147  */
 148 static inline bool is_help_option(const char *s)
 149 {
 150     return !strcmp(s, "?") || !strcmp(s, "help");
 151 }
 152
 153 /* cutils.c */
 154 void pstrcpy(char *buf, int buf_size, const char *str);
 155 void strpadcpy(char *buf, int buf_size, const char *str, char pad);
 156 char *pstrcat(char *buf, int buf_size, const char *s);
 157 int strstart(const char *str, const char *val, const char **ptr);
 158 int stristart(const char *str, const char *val, const char **ptr);
 159 int qemu_strnlen(const char *s, int max_len);
 160 char *qemu_strsep(char **input, const char *delim);
 161 time_t mktimegm(struct tm *tm);
 162 int qemu_fls(int i);
 163 int qemu_fdatasync(int fd);
 164 int fcntl_setfl(int fd, int flag);
 165 int qemu_parse_fd(const char *param);
 166
 167 int parse_uint(const char *s, unsigned long long *value, char **endptr,
 168                int base);
 169 int parse_uint_full(const char *s, unsigned long long *value, int base);
 170
 171 /*
 172  * strtosz() suffixes used to specify the default treatment of an
 173  * argument passed to strtosz() without an explicit suffix.
 174  * These should be defined using upper case characters in the range
 175  * A-Z, as strtosz() will use qemu_toupper() on the given argument
 176  * prior to comparison.
 177  */
 178 #define STRTOSZ_DEFSUFFIX_EB    'E'
 179 #define STRTOSZ_DEFSUFFIX_PB    'P'
 180 #define STRTOSZ_DEFSUFFIX_TB    'T'
 181 #define STRTOSZ_DEFSUFFIX_GB    'G'
 182 #define STRTOSZ_DEFSUFFIX_MB    'M'
 183 #define STRTOSZ_DEFSUFFIX_KB    'K'
 184 #define STRTOSZ_DEFSUFFIX_B     'B'
 185 int64_t strtosz(const char *nptr, char **end);
 186 int64_t strtosz_suffix(const char *nptr, char **end, const char default_suffix);
 187 int64_t strtosz_suffix_unit(const char *nptr, char **end,
 188                             const char default_suffix, int64_t unit);
 189
 190 /* used to print char* safely */
 191 #define STR_OR_NULL(str) ((str) ? (str) : "null")
 192
 193 /* id.c */
 194 bool id_wellformed(const char *id);
 195
 196 /* path.c */
 197 void init_paths(const char *prefix);
 198 const char *path(const char *pathname);
 199
 200 #define qemu_isalnum(c)         isalnum((unsigned char)(c))
 201 #define qemu_isalpha(c)         isalpha((unsigned char)(c))
 202 #define qemu_iscntrl(c)         iscntrl((unsigned char)(c))
 203 #define qemu_isdigit(c)         isdigit((unsigned char)(c))
 204 #define qemu_isgraph(c)         isgraph((unsigned char)(c))
 205 #define qemu_islower(c)         islower((unsigned char)(c))
 206 #define qemu_isprint(c)         isprint((unsigned char)(c))
 207 #define qemu_ispunct(c)         ispunct((unsigned char)(c))
 208 #define qemu_isspace(c)         isspace((unsigned char)(c))
 209 #define qemu_isupper(c)         isupper((unsigned char)(c))
 210 #define qemu_isxdigit(c)        isxdigit((unsigned char)(c))
 211 #define qemu_tolower(c)         tolower((unsigned char)(c))
 212 #define qemu_toupper(c)         toupper((unsigned char)(c))
 213 #define qemu_isascii(c)         isascii((unsigned char)(c))
 214 #define qemu_toascii(c)         toascii((unsigned char)(c))
 215
 216 void *qemu_oom_check(void *ptr);
 217
 218 ssize_t qemu_write_full(int fd, const void *buf, size_t count)
 219     QEMU_WARN_UNUSED_RESULT;
 220 ssize_t qemu_send_full(int fd, const void *buf, size_t count, int flags)
 221     QEMU_WARN_UNUSED_RESULT;
 222 ssize_t qemu_recv_full(int fd, void *buf, size_t count, int flags)
 223     QEMU_WARN_UNUSED_RESULT;
 224
 225 #ifndef _WIN32
 226 int qemu_pipe(int pipefd[2]);
 227 /* like openpty() but also makes it raw; return master fd */
 228 int qemu_openpty_raw(int *aslave, char *pty_name);
 229 #endif
 230
 231 #ifdef _WIN32
 232 /* MinGW needs type casts for the 'buf' and 'optval' arguments. */
 233 #define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
 234     getsockopt(sockfd, level, optname, (void *)optval, optlen)
 235 #define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
 236     setsockopt(sockfd, level, optname, (const void *)optval, optlen)
 237 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags)
 238 #define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
 239     sendto(sockfd, (const void *)buf, len, flags, destaddr, addrlen)
 240 #else
 241 #define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
 242     getsockopt(sockfd, level, optname, optval, optlen)
 243 #define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
 244     setsockopt(sockfd, level, optname, optval, optlen)
 245 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags)
 246 #define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
 247     sendto(sockfd, buf, len, flags, destaddr, addrlen)
 248 #endif
 249
 250 /* Error handling.  */
 251
 252 void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
 253
 254 struct ParallelIOArg {
 255     void *buffer;
 256     int count;
 257 };
 258
 259 typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
 260
 261 typedef uint64_t pcibus_t;
 262
 263 typedef struct PCIHostDeviceAddress {
 264     unsigned int domain;
 265     unsigned int bus;
 266     unsigned int slot;
 267     unsigned int function;
 268 } PCIHostDeviceAddress;
 269
 270 void tcg_exec_init(unsigned long tb_size);
 271 bool tcg_enabled(void);
 272
 273 void cpu_exec_init_all(void);
 274
 275 /* CPU save/load.  */
 276 #ifdef CPU_SAVE_VERSION
 277 void cpu_save(QEMUFile *f, void *opaque);
 278 int cpu_load(QEMUFile *f, void *opaque, int version_id);
 279 #endif
 280
 281 /* Unblock cpu */
 282 void qemu_cpu_kick_self(void);
 283
 284 /* work queue */
 285 struct qemu_work_item {
 286     struct qemu_work_item *next;
 287     void (*func)(void *data);
 288     void *data;
 289     int done;
 290     bool free;
 291 };
 292
 293
 294 /**
 295  * Sends a (part of) iovec down a socket, yielding when the socket is full, or
 296  * Receives data into a (part of) iovec from a socket,
 297  * yielding when there is no data in the socket.
 298  * The same interface as qemu_sendv_recvv(), with added yielding.
 299  * XXX should mark these as coroutine_fn
 300  */
 301 ssize_t qemu_co_sendv_recvv(int sockfd, struct iovec *iov, unsigned iov_cnt,
 302                             size_t offset, size_t bytes, bool do_send);
 303 #define qemu_co_recvv(sockfd, iov, iov_cnt, offset, bytes) \
 304   qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, false)
 305 #define qemu_co_sendv(sockfd, iov, iov_cnt, offset, bytes) \
 306   qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, true)
 307
 308 /**
 309  * The same as above, but with just a single buffer
 310  */
 311 ssize_t qemu_co_send_recv(int sockfd, void *buf, size_t bytes, bool do_send);
 312 #define qemu_co_recv(sockfd, buf, bytes) \
 313   qemu_co_send_recv(sockfd, buf, bytes, false)
 314 #define qemu_co_send(sockfd, buf, bytes) \
 315   qemu_co_send_recv(sockfd, buf, bytes, true)
 316
 317 typedef struct QEMUIOVector {
 318     struct iovec *iov;
 319     int niov;
 320     int nalloc;
 321     size_t size;
 322 } QEMUIOVector;
 323
 324 void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
 325 void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
 326 void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
 327 void qemu_iovec_concat(QEMUIOVector *dst,
 328                        QEMUIOVector *src, size_t soffset, size_t sbytes);
 329 size_t qemu_iovec_concat_iov(QEMUIOVector *dst,
 330                              struct iovec *src_iov, unsigned int src_cnt,
 331                              size_t soffset, size_t sbytes);
 332 bool qemu_iovec_is_zero(QEMUIOVector *qiov);
 333 void qemu_iovec_destroy(QEMUIOVector *qiov);
 334 void qemu_iovec_reset(QEMUIOVector *qiov);
 335 size_t qemu_iovec_to_buf(QEMUIOVector *qiov, size_t offset,
 336                          void *buf, size_t bytes);
 337 size_t qemu_iovec_from_buf(QEMUIOVector *qiov, size_t offset,
 338                            const void *buf, size_t bytes);
 339 size_t qemu_iovec_memset(QEMUIOVector *qiov, size_t offset,
 340                          int fillc, size_t bytes);
 341 ssize_t qemu_iovec_compare(QEMUIOVector *a, QEMUIOVector *b);
 342 void qemu_iovec_clone(QEMUIOVector *dest, const QEMUIOVector *src, void *buf);
 343 void qemu_iovec_discard_back(QEMUIOVector *qiov, size_t bytes);
 344
 345 bool buffer_is_zero(const void *buf, size_t len);
 346
 347 void qemu_progress_init(int enabled, float min_skip);
 348 void qemu_progress_end(void);
 349 void qemu_progress_print(float delta, int max);
 350 const char *qemu_get_vm_name(void);
 351
 352 #define QEMU_FILE_TYPE_BIOS   0
 353 #define QEMU_FILE_TYPE_KEYMAP 1
 354 char *qemu_find_file(int type, const char *name);
 355
 356 /* OS specific functions */
 357 void os_setup_early_signal_handling(void);
 358 char *os_find_datadir(void);
 359 void os_parse_cmd_args(int index, const char *optarg);
 360
 361 /* Convert a byte between binary and BCD.  */
 362 static inline uint8_t to_bcd(uint8_t val)
 363 {
 364     return ((val / 10) << 4) | (val % 10);
 365 }
 366
 367 static inline uint8_t from_bcd(uint8_t val)
 368 {
 369     return ((val >> 4) * 10) + (val & 0x0f);
 370 }
 371
 372 /* compute with 96 bit intermediate result: (a*b)/c */
 373 #ifdef CONFIG_INT128
 374 static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
 375 {
 376     return (__int128_t)a * b / c;
 377 }
 378 #else
 379 static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
 380 {
 381     union {
 382         uint64_t ll;
 383         struct {
 384 #ifdef HOST_WORDS_BIGENDIAN
 385             uint32_t high, low;
 386 #else
 387             uint32_t low, high;
 388 #endif
 389         } l;
 390     } u, res;
 391     uint64_t rl, rh;
 392
 393     u.ll = a;
 394     rl = (uint64_t)u.l.low * (uint64_t)b;
 395     rh = (uint64_t)u.l.high * (uint64_t)b;
 396     rh += (rl >> 32);
 397     res.l.high = rh / c;
 398     res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
 399     return res.ll;
 400 }
 401 #endif
 402
 403 /* Round number down to multiple */
 404 #define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
 405
 406 /* Round number up to multiple */
 407 #define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
 408
 409 static inline bool is_power_of_2(uint64_t value)
 410 {
 411     if (!value) {
 412         return 0;
 413     }
 414
 415     return !(value & (value - 1));
 416 }
 417
 418 /* round down to the nearest power of 2*/
 419 int64_t pow2floor(int64_t value);
 420
 421 /* round up to the nearest power of 2 (0 if overflow) */
 422 uint64_t pow2ceil(uint64_t value);
 423
 424 #include "qemu/module.h"
 425
 426 /*
 427  * Implementation of ULEB128 (http://en.wikipedia.org/wiki/LEB128)
 428  * Input is limited to 14-bit numbers
 429  */
 430
 431 int uleb128_encode_small(uint8_t *out, uint32_t n);
 432 int uleb128_decode_small(const uint8_t *in, uint32_t *n);
 433
 434 /* unicode.c */
 435 int mod_utf8_codepoint(const char *s, size_t n, char **end);
 436
 437 /*
 438  * Hexdump a buffer to a file. An optional string prefix is added to every line
 439  */
 440
 441 void qemu_hexdump(const char *buf, FILE *fp, const char *prefix, size_t size);
 442
 443 /* vector definitions */
 444 #ifdef __ALTIVEC__
 445 #include <altivec.h>
 446 /* The altivec.h header says we're allowed to undef these for
 447  * C++ compatibility.  Here we don't care about C++, but we
 448  * undef them anyway to avoid namespace pollution.
 449  */
 450 #undef vector
 451 #undef pixel
 452 #undef bool
 453 #define VECTYPE        __vector unsigned char
 454 #define SPLAT(p)       vec_splat(vec_ld(0, p), 0)
 455 #define ALL_EQ(v1, v2) vec_all_eq(v1, v2)
 456 /* altivec.h may redefine the bool macro as vector type.
 457  * Reset it to POSIX semantics. */
 458 #define bool _Bool
 459 #elif defined __SSE2__
 460 #include <emmintrin.h>
 461 #define VECTYPE        __m128i
 462 #define SPLAT(p)       _mm_set1_epi8(*(p))
 463 #define ALL_EQ(v1, v2) (_mm_movemask_epi8(_mm_cmpeq_epi8(v1, v2)) == 0xFFFF)
 464 #else
 465 #define VECTYPE        unsigned long
 466 #define SPLAT(p)       (*(p) * (~0UL / 255))
 467 #define ALL_EQ(v1, v2) ((v1) == (v2))
 468 #endif
 469
 470 #define BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR 8
 471 static inline bool
 472 can_use_buffer_find_nonzero_offset(const void *buf, size_t len)
 473 {
 474     return (len % (BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR
 475                    * sizeof(VECTYPE)) == 0
 476             && ((uintptr_t) buf) % sizeof(VECTYPE) == 0);
 477 }
 478 size_t buffer_find_nonzero_offset(const void *buf, size_t len);
 479
 480 /*
 481  * helper to parse debug environment variables
 482  */
 483 int parse_debug_env(const char *name, int max, int initial);
 484
 485 const char *qemu_ether_ntoa(const MACAddr *mac);
 486
 487 #endif