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/osdep.h"
  16 #include "qemu/typedefs.h"
  17 #include "qemu/fprintf-fn.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 #include "glib-compat.h"
  26 #include "qemu/option.h"
  27 #include "qemu/host-utils.h"
  28
  29 /* HOST_LONG_BITS is the size of a native pointer in bits. */
  30 #if UINTPTR_MAX == UINT32_MAX
  31 # define HOST_LONG_BITS 32
  32 #elif UINTPTR_MAX == UINT64_MAX
  33 # define HOST_LONG_BITS 64
  34 #else
  35 # error Unknown pointer size
  36 #endif
  37
  38 #define KiB     1024
  39 #define MiB     (KiB * KiB)
  40
  41 /* Trace unassigned memory or i/o accesses. */
  42 extern bool trace_unassigned;
  43
  44 void cpu_ticks_init(void);
  45
  46 /* icount */
  47 void configure_icount(QemuOpts *opts, Error **errp);
  48 extern int use_icount;
  49 extern int icount_align_option;
  50 /* drift information for info jit command */
  51 extern int64_t max_delay;
  52 extern int64_t max_advance;
  53 void dump_drift_info(FILE *f, fprintf_function cpu_fprintf);
  54
  55 #include "qemu/bswap.h"
  56
  57 /* FIXME: Remove NEED_CPU_H.  */
  58 #ifdef NEED_CPU_H
  59 #include "cpu.h"
  60 #endif /* !defined(NEED_CPU_H) */
  61
  62 /* main function, renamed */
  63 #if defined(CONFIG_COCOA)
  64 int qemu_main(int argc, char **argv, char **envp);
  65 #endif
  66
  67 void qemu_get_timedate(struct tm *tm, int offset);
  68 int qemu_timedate_diff(struct tm *tm);
  69
  70 /**
  71  * is_help_option:
  72  * @s: string to test
  73  *
  74  * Check whether @s is one of the standard strings which indicate
  75  * that the user is asking for a list of the valid values for a
  76  * command option like -cpu or -M. The current accepted strings
  77  * are 'help' and '?'. '?' is deprecated (it is a shell wildcard
  78  * which makes it annoying to use in a reliable way) but provided
  79  * for backwards compatibility.
  80  *
  81  * Returns: true if @s is a request for a list.
  82  */
  83 static inline bool is_help_option(const char *s)
  84 {
  85     return !strcmp(s, "?") || !strcmp(s, "help");
  86 }
  87
  88 /* util/cutils.c */
  89 /**
  90  * pstrcpy:
  91  * @buf: buffer to copy string into
  92  * @buf_size: size of @buf in bytes
  93  * @str: string to copy
  94  *
  95  * Copy @str into @buf, including the trailing NUL, but do not
  96  * write more than @buf_size bytes. The resulting buffer is
  97  * always NUL terminated (even if the source string was too long).
  98  * If @buf_size is zero or negative then no bytes are copied.
  99  *
 100  * This function is similar to strncpy(), but avoids two of that
 101  * function's problems:
 102  *  * if @str fits in the buffer, pstrcpy() does not zero-fill the
 103  *    remaining space at the end of @buf
 104  *  * if @str is too long, pstrcpy() will copy the first @buf_size-1
 105  *    bytes and then add a NUL
 106  */
 107 void pstrcpy(char *buf, int buf_size, const char *str);
 108 /**
 109  * strpadcpy:
 110  * @buf: buffer to copy string into
 111  * @buf_size: size of @buf in bytes
 112  * @str: string to copy
 113  * @pad: character to pad the remainder of @buf with
 114  *
 115  * Copy @str into @buf (but *not* its trailing NUL!), and then pad the
 116  * rest of the buffer with the @pad character. If @str is too large
 117  * for the buffer then it is truncated, so that @buf contains the
 118  * first @buf_size characters of @str, with no terminator.
 119  */
 120 void strpadcpy(char *buf, int buf_size, const char *str, char pad);
 121 /**
 122  * pstrcat:
 123  * @buf: buffer containing existing string
 124  * @buf_size: size of @buf in bytes
 125  * @s: string to concatenate to @buf
 126  *
 127  * Append a copy of @s to the string already in @buf, but do not
 128  * allow the buffer to overflow. If the existing contents of @buf
 129  * plus @str would total more than @buf_size bytes, then write
 130  * as much of @str as will fit followed by a NUL terminator.
 131  *
 132  * @buf must already contain a NUL-terminated string, or the
 133  * behaviour is undefined.
 134  *
 135  * Returns: @buf.
 136  */
 137 char *pstrcat(char *buf, int buf_size, const char *s);
 138 /**
 139  * strstart:
 140  * @str: string to test
 141  * @val: prefix string to look for
 142  * @ptr: NULL, or pointer to be written to indicate start of
 143  *       the remainder of the string
 144  *
 145  * Test whether @str starts with the prefix @val.
 146  * If it does (including the degenerate case where @str and @val
 147  * are equal) then return true. If @ptr is not NULL then a
 148  * pointer to the first character following the prefix is written
 149  * to it. If @val is not a prefix of @str then return false (and
 150  * @ptr is not written to).
 151  *
 152  * Returns: true if @str starts with prefix @val, false otherwise.
 153  */
 154 int strstart(const char *str, const char *val, const char **ptr);
 155 /**
 156  * stristart:
 157  * @str: string to test
 158  * @val: prefix string to look for
 159  * @ptr: NULL, or pointer to be written to indicate start of
 160  *       the remainder of the string
 161  *
 162  * Test whether @str starts with the case-insensitive prefix @val.
 163  * This function behaves identically to strstart(), except that the
 164  * comparison is made after calling qemu_toupper() on each pair of
 165  * characters.
 166  *
 167  * Returns: true if @str starts with case-insensitive prefix @val,
 168  *          false otherwise.
 169  */
 170 int stristart(const char *str, const char *val, const char **ptr);
 171 /**
 172  * qemu_strnlen:
 173  * @s: string
 174  * @max_len: maximum number of bytes in @s to scan
 175  *
 176  * Return the length of the string @s, like strlen(), but do not
 177  * examine more than @max_len bytes of the memory pointed to by @s.
 178  * If no NUL terminator is found within @max_len bytes, then return
 179  * @max_len instead.
 180  *
 181  * This function has the same behaviour as the POSIX strnlen()
 182  * function.
 183  *
 184  * Returns: length of @s in bytes, or @max_len, whichever is smaller.
 185  */
 186 int qemu_strnlen(const char *s, int max_len);
 187 /**
 188  * qemu_strsep:
 189  * @input: pointer to string to parse
 190  * @delim: string containing delimiter characters to search for
 191  *
 192  * Locate the first occurrence of any character in @delim within
 193  * the string referenced by @input, and replace it with a NUL.
 194  * The location of the next character after the delimiter character
 195  * is stored into @input.
 196  * If the end of the string was reached without finding a delimiter
 197  * character, then NULL is stored into @input.
 198  * If @input points to a NULL pointer on entry, return NULL.
 199  * The return value is always the original value of *@input (and
 200  * so now points to a NUL-terminated string corresponding to the
 201  * part of the input up to the first delimiter).
 202  *
 203  * This function has the same behaviour as the BSD strsep() function.
 204  *
 205  * Returns: the pointer originally in @input.
 206  */
 207 char *qemu_strsep(char **input, const char *delim);
 208 time_t mktimegm(struct tm *tm);
 209 int qemu_fdatasync(int fd);
 210 int fcntl_setfl(int fd, int flag);
 211 int qemu_parse_fd(const char *param);
 212 int qemu_strtol(const char *nptr, const char **endptr, int base,
 213                 long *result);
 214 int qemu_strtoul(const char *nptr, const char **endptr, int base,
 215                  unsigned long *result);
 216 int qemu_strtoll(const char *nptr, const char **endptr, int base,
 217                  int64_t *result);
 218 int qemu_strtoull(const char *nptr, const char **endptr, int base,
 219                   uint64_t *result);
 220
 221 int parse_uint(const char *s, unsigned long long *value, char **endptr,
 222                int base);
 223 int parse_uint_full(const char *s, unsigned long long *value, int base);
 224
 225 /*
 226  * qemu_strtosz() suffixes used to specify the default treatment of an
 227  * argument passed to qemu_strtosz() without an explicit suffix.
 228  * These should be defined using upper case characters in the range
 229  * A-Z, as qemu_strtosz() will use qemu_toupper() on the given argument
 230  * prior to comparison.
 231  */
 232 #define QEMU_STRTOSZ_DEFSUFFIX_EB 'E'
 233 #define QEMU_STRTOSZ_DEFSUFFIX_PB 'P'
 234 #define QEMU_STRTOSZ_DEFSUFFIX_TB 'T'
 235 #define QEMU_STRTOSZ_DEFSUFFIX_GB 'G'
 236 #define QEMU_STRTOSZ_DEFSUFFIX_MB 'M'
 237 #define QEMU_STRTOSZ_DEFSUFFIX_KB 'K'
 238 #define QEMU_STRTOSZ_DEFSUFFIX_B 'B'
 239 int64_t qemu_strtosz(const char *nptr, char **end);
 240 int64_t qemu_strtosz_suffix(const char *nptr, char **end,
 241                             const char default_suffix);
 242 int64_t qemu_strtosz_suffix_unit(const char *nptr, char **end,
 243                             const char default_suffix, int64_t unit);
 244 #define K_BYTE     (1ULL << 10)
 245 #define M_BYTE     (1ULL << 20)
 246 #define G_BYTE     (1ULL << 30)
 247 #define T_BYTE     (1ULL << 40)
 248 #define P_BYTE     (1ULL << 50)
 249 #define E_BYTE     (1ULL << 60)
 250
 251 /* used to print char* safely */
 252 #define STR_OR_NULL(str) ((str) ? (str) : "null")
 253
 254 /* id.c */
 255
 256 typedef enum IdSubSystems {
 257     ID_QDEV,
 258     ID_BLOCK,
 259     ID_MAX      /* last element, used as array size */
 260 } IdSubSystems;
 261
 262 char *id_generate(IdSubSystems id);
 263 bool id_wellformed(const char *id);
 264
 265 /* path.c */
 266 void init_paths(const char *prefix);
 267 const char *path(const char *pathname);
 268
 269 #define qemu_isalnum(c)         isalnum((unsigned char)(c))
 270 #define qemu_isalpha(c)         isalpha((unsigned char)(c))
 271 #define qemu_iscntrl(c)         iscntrl((unsigned char)(c))
 272 #define qemu_isdigit(c)         isdigit((unsigned char)(c))
 273 #define qemu_isgraph(c)         isgraph((unsigned char)(c))
 274 #define qemu_islower(c)         islower((unsigned char)(c))
 275 #define qemu_isprint(c)         isprint((unsigned char)(c))
 276 #define qemu_ispunct(c)         ispunct((unsigned char)(c))
 277 #define qemu_isspace(c)         isspace((unsigned char)(c))
 278 #define qemu_isupper(c)         isupper((unsigned char)(c))
 279 #define qemu_isxdigit(c)        isxdigit((unsigned char)(c))
 280 #define qemu_tolower(c)         tolower((unsigned char)(c))
 281 #define qemu_toupper(c)         toupper((unsigned char)(c))
 282 #define qemu_isascii(c)         isascii((unsigned char)(c))
 283 #define qemu_toascii(c)         toascii((unsigned char)(c))
 284
 285 void *qemu_oom_check(void *ptr);
 286
 287 ssize_t qemu_write_full(int fd, const void *buf, size_t count)
 288     QEMU_WARN_UNUSED_RESULT;
 289
 290 #ifndef _WIN32
 291 int qemu_pipe(int pipefd[2]);
 292 /* like openpty() but also makes it raw; return master fd */
 293 int qemu_openpty_raw(int *aslave, char *pty_name);
 294 #endif
 295
 296 /* Error handling.  */
 297
 298 void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
 299
 300 struct ParallelIOArg {
 301     void *buffer;
 302     int count;
 303 };
 304
 305 typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
 306
 307 typedef uint64_t pcibus_t;
 308
 309 typedef struct PCIHostDeviceAddress {
 310     unsigned int domain;
 311     unsigned int bus;
 312     unsigned int slot;
 313     unsigned int function;
 314 } PCIHostDeviceAddress;
 315
 316 void tcg_exec_init(uintptr_t tb_size);
 317 bool tcg_enabled(void);
 318
 319 void cpu_exec_init_all(void);
 320
 321 /* CPU save/load.  */
 322 #ifdef CPU_SAVE_VERSION
 323 void cpu_save(QEMUFile *f, void *opaque);
 324 int cpu_load(QEMUFile *f, void *opaque, int version_id);
 325 #endif
 326
 327 /* Unblock cpu */
 328 void qemu_cpu_kick_self(void);
 329
 330 /* work queue */
 331 struct qemu_work_item {
 332     struct qemu_work_item *next;
 333     void (*func)(void *data);
 334     void *data;
 335     int done;
 336     bool free;
 337 };
 338
 339
 340 /**
 341  * Sends a (part of) iovec down a socket, yielding when the socket is full, or
 342  * Receives data into a (part of) iovec from a socket,
 343  * yielding when there is no data in the socket.
 344  * The same interface as qemu_sendv_recvv(), with added yielding.
 345  * XXX should mark these as coroutine_fn
 346  */
 347 ssize_t qemu_co_sendv_recvv(int sockfd, struct iovec *iov, unsigned iov_cnt,
 348                             size_t offset, size_t bytes, bool do_send);
 349 #define qemu_co_recvv(sockfd, iov, iov_cnt, offset, bytes) \
 350   qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, false)
 351 #define qemu_co_sendv(sockfd, iov, iov_cnt, offset, bytes) \
 352   qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, true)
 353
 354 /**
 355  * The same as above, but with just a single buffer
 356  */
 357 ssize_t qemu_co_send_recv(int sockfd, void *buf, size_t bytes, bool do_send);
 358 #define qemu_co_recv(sockfd, buf, bytes) \
 359   qemu_co_send_recv(sockfd, buf, bytes, false)
 360 #define qemu_co_send(sockfd, buf, bytes) \
 361   qemu_co_send_recv(sockfd, buf, bytes, true)
 362
 363 typedef struct QEMUIOVector {
 364     struct iovec *iov;
 365     int niov;
 366     int nalloc;
 367     size_t size;
 368 } QEMUIOVector;
 369
 370 void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
 371 void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
 372 void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
 373 void qemu_iovec_concat(QEMUIOVector *dst,
 374                        QEMUIOVector *src, size_t soffset, size_t sbytes);
 375 size_t qemu_iovec_concat_iov(QEMUIOVector *dst,
 376                              struct iovec *src_iov, unsigned int src_cnt,
 377                              size_t soffset, size_t sbytes);
 378 bool qemu_iovec_is_zero(QEMUIOVector *qiov);
 379 void qemu_iovec_destroy(QEMUIOVector *qiov);
 380 void qemu_iovec_reset(QEMUIOVector *qiov);
 381 size_t qemu_iovec_to_buf(QEMUIOVector *qiov, size_t offset,
 382                          void *buf, size_t bytes);
 383 size_t qemu_iovec_from_buf(QEMUIOVector *qiov, size_t offset,
 384                            const void *buf, size_t bytes);
 385 size_t qemu_iovec_memset(QEMUIOVector *qiov, size_t offset,
 386                          int fillc, size_t bytes);
 387 ssize_t qemu_iovec_compare(QEMUIOVector *a, QEMUIOVector *b);
 388 void qemu_iovec_clone(QEMUIOVector *dest, const QEMUIOVector *src, void *buf);
 389 void qemu_iovec_discard_back(QEMUIOVector *qiov, size_t bytes);
 390
 391 bool buffer_is_zero(const void *buf, size_t len);
 392
 393 void qemu_progress_init(int enabled, float min_skip);
 394 void qemu_progress_end(void);
 395 void qemu_progress_print(float delta, int max);
 396 const char *qemu_get_vm_name(void);
 397
 398 #define QEMU_FILE_TYPE_BIOS   0
 399 #define QEMU_FILE_TYPE_KEYMAP 1
 400 char *qemu_find_file(int type, const char *name);
 401
 402 /* OS specific functions */
 403 void os_setup_early_signal_handling(void);
 404 char *os_find_datadir(void);
 405 void os_parse_cmd_args(int index, const char *optarg);
 406
 407 /* Convert a byte between binary and BCD.  */
 408 static inline uint8_t to_bcd(uint8_t val)
 409 {
 410     return ((val / 10) << 4) | (val % 10);
 411 }
 412
 413 static inline uint8_t from_bcd(uint8_t val)
 414 {
 415     return ((val >> 4) * 10) + (val & 0x0f);
 416 }
 417
 418 /* Round number down to multiple */
 419 #define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
 420
 421 /* Round number up to multiple */
 422 #define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
 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 #define VEC_OR(v1, v2) ((v1) | (v2))
 457 /* altivec.h may redefine the bool macro as vector type.
 458  * Reset it to POSIX semantics. */
 459 #define bool _Bool
 460 #elif defined __SSE2__
 461 #include <emmintrin.h>
 462 #define VECTYPE        __m128i
 463 #define SPLAT(p)       _mm_set1_epi8(*(p))
 464 #define ALL_EQ(v1, v2) (_mm_movemask_epi8(_mm_cmpeq_epi8(v1, v2)) == 0xFFFF)
 465 #define VEC_OR(v1, v2) (_mm_or_si128(v1, v2))
 466 #else
 467 #define VECTYPE        unsigned long
 468 #define SPLAT(p)       (*(p) * (~0UL / 255))
 469 #define ALL_EQ(v1, v2) ((v1) == (v2))
 470 #define VEC_OR(v1, v2) ((v1) | (v2))
 471 #endif
 472
 473 #define BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR 8
 474 static inline bool
 475 can_use_buffer_find_nonzero_offset(const void *buf, size_t len)
 476 {
 477     return (len % (BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR
 478                    * sizeof(VECTYPE)) == 0
 479             && ((uintptr_t) buf) % sizeof(VECTYPE) == 0);
 480 }
 481 size_t buffer_find_nonzero_offset(const void *buf, size_t len);
 482
 483 /*
 484  * helper to parse debug environment variables
 485  */
 486 int parse_debug_env(const char *name, int max, int initial);
 487
 488 const char *qemu_ether_ntoa(const MACAddr *mac);
 489 void page_size_init(void);
 490
 491 #endif