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