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