2 /* Common header file that is included by all of QEMU.
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
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.
15 #include "qemu/compiler.h"
16 #include "config-host.h"
17 #include "qemu/typedefs.h"
19 #if defined(__arm__) || defined(__sparc__) || defined(__mips__) || defined(__hppa__) || defined(__ia64__)
23 #define TFR(expr) do { if ((expr) != -1) break; } while (errno == EINTR)
25 /* we put basic includes here to avoid repeating them in device drivers */
43 #include "glib-compat.h"
45 #if defined(__GLIBC__)
47 #elif defined CONFIG_BSD
49 # if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
54 #elif defined CONFIG_SOLARIS
59 #include "sysemu/os-win32.h"
63 #include "sysemu/os-posix.h"
73 #define MAP_ANONYMOUS MAP_ANON
76 #define ENOMEDIUM ENODEV
81 #if !defined(ECANCELED)
82 #define ECANCELED 4097
84 #if !defined(EMEDIUMTYPE)
85 #define EMEDIUMTYPE 4098
88 #define TIME_MAX LONG_MAX
91 /* HOST_LONG_BITS is the size of a native pointer in bits. */
92 #if UINTPTR_MAX == UINT32_MAX
93 # define HOST_LONG_BITS 32
94 #elif UINTPTR_MAX == UINT64_MAX
95 # define HOST_LONG_BITS 64
97 # error Unknown pointer size
100 typedef int (*fprintf_function
)(FILE *f
, const char *fmt
, ...)
104 #define fsync _commit
106 # define lseek _lseeki64
108 int qemu_ftruncate64(int, int64_t);
109 #if !defined(ftruncate)
110 # define ftruncate qemu_ftruncate64
113 static inline char *realpath(const char *path
, char *resolved_path
)
115 _fullpath(resolved_path
, path
, _MAX_PATH
);
116 return resolved_path
;
121 void configure_icount(const char *option
);
122 extern int use_icount
;
124 #include "qemu/osdep.h"
125 #include "qemu/bswap.h"
127 /* FIXME: Remove NEED_CPU_H. */
130 #endif /* !defined(NEED_CPU_H) */
132 /* main function, renamed */
133 #if defined(CONFIG_COCOA)
134 int qemu_main(int argc
, char **argv
, char **envp
);
137 void qemu_get_timedate(struct tm
*tm
, int offset
);
138 int qemu_timedate_diff(struct tm
*tm
);
140 #if !GLIB_CHECK_VERSION(2, 20, 0)
142 * Glib before 2.20.0 doesn't implement g_poll, so wrap it to compile properly
145 static inline gint
g_poll(GPollFD
*fds
, guint nfds
, gint timeout
)
147 GMainContext
*ctx
= g_main_context_default();
148 return g_main_context_get_poll_func(ctx
)(fds
, nfds
, timeout
);
156 * Check whether @s is one of the standard strings which indicate
157 * that the user is asking for a list of the valid values for a
158 * command option like -cpu or -M. The current accepted strings
159 * are 'help' and '?'. '?' is deprecated (it is a shell wildcard
160 * which makes it annoying to use in a reliable way) but provided
161 * for backwards compatibility.
163 * Returns: true if @s is a request for a list.
165 static inline bool is_help_option(const char *s
)
167 return !strcmp(s
, "?") || !strcmp(s
, "help");
171 void pstrcpy(char *buf
, int buf_size
, const char *str
);
172 void strpadcpy(char *buf
, int buf_size
, const char *str
, char pad
);
173 char *pstrcat(char *buf
, int buf_size
, const char *s
);
174 int strstart(const char *str
, const char *val
, const char **ptr
);
175 int stristart(const char *str
, const char *val
, const char **ptr
);
176 int qemu_strnlen(const char *s
, int max_len
);
177 char *qemu_strsep(char **input
, const char *delim
);
178 time_t mktimegm(struct tm
*tm
);
180 int qemu_fdatasync(int fd
);
181 int fcntl_setfl(int fd
, int flag
);
182 int qemu_parse_fd(const char *param
);
184 int parse_uint(const char *s
, unsigned long long *value
, char **endptr
,
186 int parse_uint_full(const char *s
, unsigned long long *value
, int base
);
189 * strtosz() suffixes used to specify the default treatment of an
190 * argument passed to strtosz() without an explicit suffix.
191 * These should be defined using upper case characters in the range
192 * A-Z, as strtosz() will use qemu_toupper() on the given argument
193 * prior to comparison.
195 #define STRTOSZ_DEFSUFFIX_EB 'E'
196 #define STRTOSZ_DEFSUFFIX_PB 'P'
197 #define STRTOSZ_DEFSUFFIX_TB 'T'
198 #define STRTOSZ_DEFSUFFIX_GB 'G'
199 #define STRTOSZ_DEFSUFFIX_MB 'M'
200 #define STRTOSZ_DEFSUFFIX_KB 'K'
201 #define STRTOSZ_DEFSUFFIX_B 'B'
202 int64_t strtosz(const char *nptr
, char **end
);
203 int64_t strtosz_suffix(const char *nptr
, char **end
, const char default_suffix
);
204 int64_t strtosz_suffix_unit(const char *nptr
, char **end
,
205 const char default_suffix
, int64_t unit
);
208 void init_paths(const char *prefix
);
209 const char *path(const char *pathname
);
211 #define qemu_isalnum(c) isalnum((unsigned char)(c))
212 #define qemu_isalpha(c) isalpha((unsigned char)(c))
213 #define qemu_iscntrl(c) iscntrl((unsigned char)(c))
214 #define qemu_isdigit(c) isdigit((unsigned char)(c))
215 #define qemu_isgraph(c) isgraph((unsigned char)(c))
216 #define qemu_islower(c) islower((unsigned char)(c))
217 #define qemu_isprint(c) isprint((unsigned char)(c))
218 #define qemu_ispunct(c) ispunct((unsigned char)(c))
219 #define qemu_isspace(c) isspace((unsigned char)(c))
220 #define qemu_isupper(c) isupper((unsigned char)(c))
221 #define qemu_isxdigit(c) isxdigit((unsigned char)(c))
222 #define qemu_tolower(c) tolower((unsigned char)(c))
223 #define qemu_toupper(c) toupper((unsigned char)(c))
224 #define qemu_isascii(c) isascii((unsigned char)(c))
225 #define qemu_toascii(c) toascii((unsigned char)(c))
227 void *qemu_oom_check(void *ptr
);
229 ssize_t
qemu_write_full(int fd
, const void *buf
, size_t count
)
230 QEMU_WARN_UNUSED_RESULT
;
231 ssize_t
qemu_send_full(int fd
, const void *buf
, size_t count
, int flags
)
232 QEMU_WARN_UNUSED_RESULT
;
233 ssize_t
qemu_recv_full(int fd
, void *buf
, size_t count
, int flags
)
234 QEMU_WARN_UNUSED_RESULT
;
237 int qemu_pipe(int pipefd
[2]);
241 /* MinGW needs type casts for the 'buf' and 'optval' arguments. */
242 #define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
243 getsockopt(sockfd, level, optname, (void *)optval, optlen)
244 #define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
245 setsockopt(sockfd, level, optname, (const void *)optval, optlen)
246 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags)
247 #define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
248 sendto(sockfd, (const void *)buf, len, flags, destaddr, addrlen)
250 #define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
251 getsockopt(sockfd, level, optname, optval, optlen)
252 #define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
253 setsockopt(sockfd, level, optname, optval, optlen)
254 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags)
255 #define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
256 sendto(sockfd, buf, len, flags, destaddr, addrlen)
259 /* Error handling. */
261 void QEMU_NORETURN
hw_error(const char *fmt
, ...) GCC_FMT_ATTR(1, 2);
263 struct ParallelIOArg
{
268 typedef int (*DMA_transfer_handler
) (void *opaque
, int nchan
, int pos
, int size
);
270 typedef uint64_t pcibus_t
;
272 typedef enum LostTickPolicy
{
280 typedef struct PCIHostDeviceAddress
{
284 unsigned int function
;
285 } PCIHostDeviceAddress
;
287 void tcg_exec_init(unsigned long tb_size
);
288 bool tcg_enabled(void);
290 void cpu_exec_init_all(void);
293 void cpu_save(QEMUFile
*f
, void *opaque
);
294 int cpu_load(QEMUFile
*f
, void *opaque
, int version_id
);
297 void qemu_cpu_kick_self(void);
300 struct qemu_work_item
{
301 struct qemu_work_item
*next
;
302 void (*func
)(void *data
);
307 #ifdef CONFIG_USER_ONLY
308 static inline void qemu_init_vcpu(void *env
)
312 void qemu_init_vcpu(void *env
);
317 * Sends a (part of) iovec down a socket, yielding when the socket is full, or
318 * Receives data into a (part of) iovec from a socket,
319 * yielding when there is no data in the socket.
320 * The same interface as qemu_sendv_recvv(), with added yielding.
321 * XXX should mark these as coroutine_fn
323 ssize_t
qemu_co_sendv_recvv(int sockfd
, struct iovec
*iov
, unsigned iov_cnt
,
324 size_t offset
, size_t bytes
, bool do_send
);
325 #define qemu_co_recvv(sockfd, iov, iov_cnt, offset, bytes) \
326 qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, false)
327 #define qemu_co_sendv(sockfd, iov, iov_cnt, offset, bytes) \
328 qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, true)
331 * The same as above, but with just a single buffer
333 ssize_t
qemu_co_send_recv(int sockfd
, void *buf
, size_t bytes
, bool do_send
);
334 #define qemu_co_recv(sockfd, buf, bytes) \
335 qemu_co_send_recv(sockfd, buf, bytes, false)
336 #define qemu_co_send(sockfd, buf, bytes) \
337 qemu_co_send_recv(sockfd, buf, bytes, true)
339 typedef struct QEMUIOVector
{
346 void qemu_iovec_init(QEMUIOVector
*qiov
, int alloc_hint
);
347 void qemu_iovec_init_external(QEMUIOVector
*qiov
, struct iovec
*iov
, int niov
);
348 void qemu_iovec_add(QEMUIOVector
*qiov
, void *base
, size_t len
);
349 void qemu_iovec_concat(QEMUIOVector
*dst
,
350 QEMUIOVector
*src
, size_t soffset
, size_t sbytes
);
351 void qemu_iovec_concat_iov(QEMUIOVector
*dst
,
352 struct iovec
*src_iov
, unsigned int src_cnt
,
353 size_t soffset
, size_t sbytes
);
354 void qemu_iovec_destroy(QEMUIOVector
*qiov
);
355 void qemu_iovec_reset(QEMUIOVector
*qiov
);
356 size_t qemu_iovec_to_buf(QEMUIOVector
*qiov
, size_t offset
,
357 void *buf
, size_t bytes
);
358 size_t qemu_iovec_from_buf(QEMUIOVector
*qiov
, size_t offset
,
359 const void *buf
, size_t bytes
);
360 size_t qemu_iovec_memset(QEMUIOVector
*qiov
, size_t offset
,
361 int fillc
, size_t bytes
);
363 bool buffer_is_zero(const void *buf
, size_t len
);
365 void qemu_progress_init(int enabled
, float min_skip
);
366 void qemu_progress_end(void);
367 void qemu_progress_print(float delta
, int max
);
368 const char *qemu_get_vm_name(void);
370 #define QEMU_FILE_TYPE_BIOS 0
371 #define QEMU_FILE_TYPE_KEYMAP 1
372 char *qemu_find_file(int type
, const char *name
);
374 /* OS specific functions */
375 void os_setup_early_signal_handling(void);
376 char *os_find_datadir(const char *argv0
);
377 void os_parse_cmd_args(int index
, const char *optarg
);
378 void os_pidfile_error(void);
380 /* Convert a byte between binary and BCD. */
381 static inline uint8_t to_bcd(uint8_t val
)
383 return ((val
/ 10) << 4) | (val
% 10);
386 static inline uint8_t from_bcd(uint8_t val
)
388 return ((val
>> 4) * 10) + (val
& 0x0f);
391 /* compute with 96 bit intermediate result: (a*b)/c */
392 static inline uint64_t muldiv64(uint64_t a
, uint32_t b
, uint32_t c
)
397 #ifdef HOST_WORDS_BIGENDIAN
407 rl
= (uint64_t)u
.l
.low
* (uint64_t)b
;
408 rh
= (uint64_t)u
.l
.high
* (uint64_t)b
;
411 res
.l
.low
= (((rh
% c
) << 32) + (rl
& 0xffffffff)) / c
;
415 /* Round number down to multiple */
416 #define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
418 /* Round number up to multiple */
419 #define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
421 static inline bool is_power_of_2(uint64_t value
)
427 return !(value
& (value
- 1));
430 /* round down to the nearest power of 2*/
431 int64_t pow2floor(int64_t value
);
433 #include "qemu/module.h"
436 * Implementation of ULEB128 (http://en.wikipedia.org/wiki/LEB128)
437 * Input is limited to 14-bit numbers
440 int uleb128_encode_small(uint8_t *out
, uint32_t n
);
441 int uleb128_decode_small(const uint8_t *in
, uint32_t *n
);
444 int mod_utf8_codepoint(const char *s
, size_t n
, char **end
);
447 * Hexdump a buffer to a file. An optional string prefix is added to every line
450 void qemu_hexdump(const char *buf
, FILE *fp
, const char *prefix
, size_t size
);
452 /* vector definitions */
455 /* The altivec.h header says we're allowed to undef these for
456 * C++ compatibility. Here we don't care about C++, but we
457 * undef them anyway to avoid namespace pollution.
462 #define VECTYPE __vector unsigned char
463 #define SPLAT(p) vec_splat(vec_ld(0, p), 0)
464 #define ALL_EQ(v1, v2) vec_all_eq(v1, v2)
465 /* altivec.h may redefine the bool macro as vector type.
466 * Reset it to POSIX semantics. */
468 #elif defined __SSE2__
469 #include <emmintrin.h>
470 #define VECTYPE __m128i
471 #define SPLAT(p) _mm_set1_epi8(*(p))
472 #define ALL_EQ(v1, v2) (_mm_movemask_epi8(_mm_cmpeq_epi8(v1, v2)) == 0xFFFF)
474 #define VECTYPE unsigned long
475 #define SPLAT(p) (*(p) * (~0UL / 255))
476 #define ALL_EQ(v1, v2) ((v1) == (v2))
479 #define BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR 8
481 can_use_buffer_find_nonzero_offset(const void *buf
, size_t len
)
483 return (len
% (BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR
484 * sizeof(VECTYPE
)) == 0
485 && ((uintptr_t) buf
) % sizeof(VECTYPE
) == 0);
487 size_t buffer_find_nonzero_offset(const void *buf
, size_t len
);
490 * helper to parse debug environment variables
492 int parse_debug_env(const char *name
, int max
, int initial
);