Merge remote-tracking branch 'remotes/ericb/tags/pull-nbd-2021-10-15' into staging
[qemu.git] / 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-2021 " \
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_get_timedate(struct tm *tm, int offset);
30 int qemu_timedate_diff(struct tm *tm);
31
32 void *qemu_oom_check(void *ptr);
33
34 ssize_t qemu_write_full(int fd, const void *buf, size_t count)
35 QEMU_WARN_UNUSED_RESULT;
36
37 #ifndef _WIN32
38 int qemu_pipe(int pipefd[2]);
39 /* like openpty() but also makes it raw; return master fd */
40 int qemu_openpty_raw(int *aslave, char *pty_name);
41 #endif
42
43 #ifdef _WIN32
44 /* MinGW needs type casts for the 'buf' and 'optval' arguments. */
45 #define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
46 getsockopt(sockfd, level, optname, (void *)optval, optlen)
47 #define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
48 setsockopt(sockfd, level, optname, (const void *)optval, optlen)
49 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags)
50 #define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
51 sendto(sockfd, (const void *)buf, len, flags, destaddr, addrlen)
52 #else
53 #define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
54 getsockopt(sockfd, level, optname, optval, optlen)
55 #define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
56 setsockopt(sockfd, level, optname, optval, optlen)
57 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags)
58 #define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
59 sendto(sockfd, buf, len, flags, destaddr, addrlen)
60 #endif
61
62 void cpu_exec_init_all(void);
63 void cpu_exec_step_atomic(CPUState *cpu);
64
65 /**
66 * set_preferred_target_page_bits:
67 * @bits: number of bits needed to represent an address within the page
68 *
69 * Set the preferred target page size (the actual target page
70 * size may be smaller than any given CPU's preference).
71 * Returns true on success, false on failure (which can only happen
72 * if this is called after the system has already finalized its
73 * choice of page size and the requested page size is smaller than that).
74 */
75 bool set_preferred_target_page_bits(int bits);
76
77 /**
78 * finalize_target_page_bits:
79 * Commit the final value set by set_preferred_target_page_bits.
80 */
81 void finalize_target_page_bits(void);
82
83 /**
84 * Sends a (part of) iovec down a socket, yielding when the socket is full, or
85 * Receives data into a (part of) iovec from a socket,
86 * yielding when there is no data in the socket.
87 * The same interface as qemu_sendv_recvv(), with added yielding.
88 * XXX should mark these as coroutine_fn
89 */
90 ssize_t qemu_co_sendv_recvv(int sockfd, struct iovec *iov, unsigned iov_cnt,
91 size_t offset, size_t bytes, bool do_send);
92 #define qemu_co_recvv(sockfd, iov, iov_cnt, offset, bytes) \
93 qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, false)
94 #define qemu_co_sendv(sockfd, iov, iov_cnt, offset, bytes) \
95 qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, true)
96
97 /**
98 * The same as above, but with just a single buffer
99 */
100 ssize_t qemu_co_send_recv(int sockfd, void *buf, size_t bytes, bool do_send);
101 #define qemu_co_recv(sockfd, buf, bytes) \
102 qemu_co_send_recv(sockfd, buf, bytes, false)
103 #define qemu_co_send(sockfd, buf, bytes) \
104 qemu_co_send_recv(sockfd, buf, bytes, true)
105
106 void qemu_progress_init(int enabled, float min_skip);
107 void qemu_progress_end(void);
108 void qemu_progress_print(float delta, int max);
109 const char *qemu_get_vm_name(void);
110
111 /* OS specific functions */
112 void os_setup_early_signal_handling(void);
113 int os_parse_cmd_args(int index, const char *optarg);
114
115 /*
116 * Hexdump a line of a byte buffer into a hexadecimal/ASCII buffer
117 */
118 #define QEMU_HEXDUMP_LINE_BYTES 16 /* Number of bytes to dump */
119 #define QEMU_HEXDUMP_LINE_LEN 75 /* Number of characters in line */
120 void qemu_hexdump_line(char *line, unsigned int b, const void *bufptr,
121 unsigned int len, bool ascii);
122
123 /*
124 * Hexdump a buffer to a file. An optional string prefix is added to every line
125 */
126
127 void qemu_hexdump(FILE *fp, const char *prefix,
128 const void *bufptr, size_t size);
129
130 /*
131 * helper to parse debug environment variables
132 */
133 int parse_debug_env(const char *name, int max, int initial);
134
135 const char *qemu_ether_ntoa(const MACAddr *mac);
136 void page_size_init(void);
137
138 /* returns non-zero if dump is in progress, otherwise zero is
139 * returned. */
140 bool dump_in_progress(void);
141
142 #endif