loader: Check access size when calling rom_ptr() to avoid crashes
[qemu.git] / 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/fprintf-fn.h"
16
17 #define TFR(expr) do { if ((expr) != -1) break; } while (errno == EINTR)
18
19 /* Copyright string for -version arguments, About dialogs, etc */
20 #define QEMU_COPYRIGHT "Copyright (c) 2003-2017 " \
21 "Fabrice Bellard and the QEMU Project developers"
22
23 /* Bug reporting information for --help arguments, About dialogs, etc */
24 #define QEMU_HELP_BOTTOM \
25 "See <https://qemu.org/contribute/report-a-bug> for how to report bugs.\n" \
26 "More information on the QEMU project at <https://qemu.org>."
27
28 /* main function, renamed */
29 #if defined(CONFIG_COCOA)
30 int qemu_main(int argc, char **argv, char **envp);
31 #endif
32
33 void qemu_get_timedate(struct tm *tm, int offset);
34 int qemu_timedate_diff(struct tm *tm);
35
36 #define qemu_isalnum(c) isalnum((unsigned char)(c))
37 #define qemu_isalpha(c) isalpha((unsigned char)(c))
38 #define qemu_iscntrl(c) iscntrl((unsigned char)(c))
39 #define qemu_isdigit(c) isdigit((unsigned char)(c))
40 #define qemu_isgraph(c) isgraph((unsigned char)(c))
41 #define qemu_islower(c) islower((unsigned char)(c))
42 #define qemu_isprint(c) isprint((unsigned char)(c))
43 #define qemu_ispunct(c) ispunct((unsigned char)(c))
44 #define qemu_isspace(c) isspace((unsigned char)(c))
45 #define qemu_isupper(c) isupper((unsigned char)(c))
46 #define qemu_isxdigit(c) isxdigit((unsigned char)(c))
47 #define qemu_tolower(c) tolower((unsigned char)(c))
48 #define qemu_toupper(c) toupper((unsigned char)(c))
49 #define qemu_isascii(c) isascii((unsigned char)(c))
50 #define qemu_toascii(c) toascii((unsigned char)(c))
51
52 void *qemu_oom_check(void *ptr);
53
54 ssize_t qemu_write_full(int fd, const void *buf, size_t count)
55 QEMU_WARN_UNUSED_RESULT;
56
57 #ifndef _WIN32
58 int qemu_pipe(int pipefd[2]);
59 /* like openpty() but also makes it raw; return master fd */
60 int qemu_openpty_raw(int *aslave, char *pty_name);
61 #endif
62
63 #ifdef _WIN32
64 /* MinGW needs type casts for the 'buf' and 'optval' arguments. */
65 #define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
66 getsockopt(sockfd, level, optname, (void *)optval, optlen)
67 #define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
68 setsockopt(sockfd, level, optname, (const void *)optval, optlen)
69 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags)
70 #define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
71 sendto(sockfd, (const void *)buf, len, flags, destaddr, addrlen)
72 #else
73 #define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
74 getsockopt(sockfd, level, optname, optval, optlen)
75 #define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
76 setsockopt(sockfd, level, optname, optval, optlen)
77 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags)
78 #define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
79 sendto(sockfd, buf, len, flags, destaddr, addrlen)
80 #endif
81
82 extern bool tcg_allowed;
83 void tcg_exec_init(unsigned long tb_size);
84 #ifdef CONFIG_TCG
85 #define tcg_enabled() (tcg_allowed)
86 #else
87 #define tcg_enabled() 0
88 #endif
89
90 void cpu_exec_init_all(void);
91 void cpu_exec_step_atomic(CPUState *cpu);
92
93 /**
94 * set_preferred_target_page_bits:
95 * @bits: number of bits needed to represent an address within the page
96 *
97 * Set the preferred target page size (the actual target page
98 * size may be smaller than any given CPU's preference).
99 * Returns true on success, false on failure (which can only happen
100 * if this is called after the system has already finalized its
101 * choice of page size and the requested page size is smaller than that).
102 */
103 bool set_preferred_target_page_bits(int bits);
104
105 /**
106 * Sends a (part of) iovec down a socket, yielding when the socket is full, or
107 * Receives data into a (part of) iovec from a socket,
108 * yielding when there is no data in the socket.
109 * The same interface as qemu_sendv_recvv(), with added yielding.
110 * XXX should mark these as coroutine_fn
111 */
112 ssize_t qemu_co_sendv_recvv(int sockfd, struct iovec *iov, unsigned iov_cnt,
113 size_t offset, size_t bytes, bool do_send);
114 #define qemu_co_recvv(sockfd, iov, iov_cnt, offset, bytes) \
115 qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, false)
116 #define qemu_co_sendv(sockfd, iov, iov_cnt, offset, bytes) \
117 qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, true)
118
119 /**
120 * The same as above, but with just a single buffer
121 */
122 ssize_t qemu_co_send_recv(int sockfd, void *buf, size_t bytes, bool do_send);
123 #define qemu_co_recv(sockfd, buf, bytes) \
124 qemu_co_send_recv(sockfd, buf, bytes, false)
125 #define qemu_co_send(sockfd, buf, bytes) \
126 qemu_co_send_recv(sockfd, buf, bytes, true)
127
128 void qemu_progress_init(int enabled, float min_skip);
129 void qemu_progress_end(void);
130 void qemu_progress_print(float delta, int max);
131 const char *qemu_get_vm_name(void);
132
133 #define QEMU_FILE_TYPE_BIOS 0
134 #define QEMU_FILE_TYPE_KEYMAP 1
135 char *qemu_find_file(int type, const char *name);
136
137 /* OS specific functions */
138 void os_setup_early_signal_handling(void);
139 char *os_find_datadir(void);
140 int os_parse_cmd_args(int index, const char *optarg);
141
142 #include "qemu/module.h"
143
144 /*
145 * Hexdump a buffer to a file. An optional string prefix is added to every line
146 */
147
148 void qemu_hexdump(const char *buf, FILE *fp, const char *prefix, size_t size);
149
150 /*
151 * helper to parse debug environment variables
152 */
153 int parse_debug_env(const char *name, int max, int initial);
154
155 const char *qemu_ether_ntoa(const MACAddr *mac);
156 char *size_to_str(uint64_t val);
157 void page_size_init(void);
158
159 /* returns non-zero if dump is in progress, otherwise zero is
160 * returned. */
161 bool dump_in_progress(void);
162
163 #endif