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