include/qemu-common.h

   1 /*
   2  * This file is supposed to be included only by .c files. No header file should
   3  * depend on qemu-common.h, as this would easily lead to circular header
   4  * dependencies.
   5  *
   6  * If a header file uses a definition from qemu-common.h, that definition
   7  * must be moved to a separate header file, and the header that uses it
   8  * must include that header.
   9  */
  10 #ifndef QEMU_COMMON_H
  11 #define QEMU_COMMON_H
  12
  13 #define TFR(expr) do { if ((expr) != -1) break; } while (errno == EINTR)
  14
  15 /* Copyright string for -version arguments, About dialogs, etc */
  16 #define QEMU_COPYRIGHT "Copyright (c) 2003-2022 " \
  17     "Fabrice Bellard and the QEMU Project developers"
  18
  19 /* Bug reporting information for --help arguments, About dialogs, etc */
  20 #define QEMU_HELP_BOTTOM \
  21     "See <https://qemu.org/contribute/report-a-bug> for how to report bugs.\n" \
  22     "More information on the QEMU project at <https://qemu.org>."
  23
  24 /* main function, renamed */
  25 #if defined(CONFIG_COCOA)
  26 int qemu_main(int argc, char **argv, char **envp);
  27 #endif
  28
  29 void *qemu_oom_check(void *ptr);
  30
  31 ssize_t qemu_write_full(int fd, const void *buf, size_t count)
  32     QEMU_WARN_UNUSED_RESULT;
  33
  34 #ifndef _WIN32
  35 int qemu_pipe(int pipefd[2]);
  36 /* like openpty() but also makes it raw; return master fd */
  37 int qemu_openpty_raw(int *aslave, char *pty_name);
  38 #endif
  39
  40 #ifdef _WIN32
  41 /* MinGW needs type casts for the 'buf' and 'optval' arguments. */
  42 #define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
  43     getsockopt(sockfd, level, optname, (void *)optval, optlen)
  44 #define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
  45     setsockopt(sockfd, level, optname, (const void *)optval, optlen)
  46 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags)
  47 #define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
  48     sendto(sockfd, (const void *)buf, len, flags, destaddr, addrlen)
  49 #else
  50 #define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
  51     getsockopt(sockfd, level, optname, optval, optlen)
  52 #define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
  53     setsockopt(sockfd, level, optname, optval, optlen)
  54 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags)
  55 #define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
  56     sendto(sockfd, buf, len, flags, destaddr, addrlen)
  57 #endif
  58
  59 void cpu_exec_init_all(void);
  60 void cpu_exec_step_atomic(CPUState *cpu);
  61
  62 /**
  63  * set_preferred_target_page_bits:
  64  * @bits: number of bits needed to represent an address within the page
  65  *
  66  * Set the preferred target page size (the actual target page
  67  * size may be smaller than any given CPU's preference).
  68  * Returns true on success, false on failure (which can only happen
  69  * if this is called after the system has already finalized its
  70  * choice of page size and the requested page size is smaller than that).
  71  */
  72 bool set_preferred_target_page_bits(int bits);
  73
  74 /**
  75  * finalize_target_page_bits:
  76  * Commit the final value set by set_preferred_target_page_bits.
  77  */
  78 void finalize_target_page_bits(void);
  79
  80 /**
  81  * Sends a (part of) iovec down a socket, yielding when the socket is full, or
  82  * Receives data into a (part of) iovec from a socket,
  83  * yielding when there is no data in the socket.
  84  * The same interface as qemu_sendv_recvv(), with added yielding.
  85  * XXX should mark these as coroutine_fn
  86  */
  87 ssize_t qemu_co_sendv_recvv(int sockfd, struct iovec *iov, unsigned iov_cnt,
  88                             size_t offset, size_t bytes, bool do_send);
  89 #define qemu_co_recvv(sockfd, iov, iov_cnt, offset, bytes) \
  90   qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, false)
  91 #define qemu_co_sendv(sockfd, iov, iov_cnt, offset, bytes) \
  92   qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, true)
  93
  94 /**
  95  * The same as above, but with just a single buffer
  96  */
  97 ssize_t qemu_co_send_recv(int sockfd, void *buf, size_t bytes, bool do_send);
  98 #define qemu_co_recv(sockfd, buf, bytes) \
  99   qemu_co_send_recv(sockfd, buf, bytes, false)
 100 #define qemu_co_send(sockfd, buf, bytes) \
 101   qemu_co_send_recv(sockfd, buf, bytes, true)
 102
 103 void qemu_progress_init(int enabled, float min_skip);
 104 void qemu_progress_end(void);
 105 void qemu_progress_print(float delta, int max);
 106 const char *qemu_get_vm_name(void);
 107
 108 /* OS specific functions */
 109 void os_setup_early_signal_handling(void);
 110 int os_parse_cmd_args(int index, const char *optarg);
 111
 112 /*
 113  * Hexdump a line of a byte buffer into a hexadecimal/ASCII buffer
 114  */
 115 #define QEMU_HEXDUMP_LINE_BYTES 16 /* Number of bytes to dump */
 116 #define QEMU_HEXDUMP_LINE_LEN 75   /* Number of characters in line */
 117 void qemu_hexdump_line(char *line, unsigned int b, const void *bufptr,
 118                        unsigned int len, bool ascii);
 119
 120 /*
 121  * Hexdump a buffer to a file. An optional string prefix is added to every line
 122  */
 123
 124 void qemu_hexdump(FILE *fp, const char *prefix,
 125                   const void *bufptr, size_t size);
 126
 127 /*
 128  * helper to parse debug environment variables
 129  */
 130 int parse_debug_env(const char *name, int max, int initial);
 131
 132 const char *qemu_ether_ntoa(const MACAddr *mac);
 133 void page_size_init(void);
 134
 135 /* returns non-zero if dump is in progress, otherwise zero is
 136  * returned. */
 137 bool dump_in_progress(void);
 138
 139 #endif