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