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