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
48 # if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
53 #elif defined CONFIG_SOLARIS
58 #include "sysemu/os-win32.h"
62 #include "sysemu/os-posix.h"
72 #define MAP_ANONYMOUS MAP_ANON
75 #define ENOMEDIUM ENODEV
80 #if !defined(ECANCELED)
81 #define ECANCELED 4097
83 #if !defined(EMEDIUMTYPE)
84 #define EMEDIUMTYPE 4098
87 #define TIME_MAX LONG_MAX
90 /* HOST_LONG_BITS is the size of a native pointer in bits. */
91 #if UINTPTR_MAX == UINT32_MAX
92 # define HOST_LONG_BITS 32
93 #elif UINTPTR_MAX == UINT64_MAX
94 # define HOST_LONG_BITS 64
96 # error Unknown pointer size
99 typedef int (*fprintf_function
)(FILE *f
, const char *fmt
, ...)
103 #define fsync _commit
105 # define lseek _lseeki64
107 int qemu_ftruncate64(int, int64_t);
108 #if !defined(ftruncate)
109 # define ftruncate qemu_ftruncate64
112 static inline char *realpath(const char *path
, char *resolved_path
)
114 _fullpath(resolved_path
, path
, _MAX_PATH
);
115 return resolved_path
;
120 void configure_icount(const char *option
);
121 extern int use_icount
;
123 #include "qemu/osdep.h"
124 #include "qemu/bswap.h"
126 /* FIXME: Remove NEED_CPU_H. */
129 #endif /* !defined(NEED_CPU_H) */
131 /* main function, renamed */
132 #if defined(CONFIG_COCOA)
133 int qemu_main(int argc
, char **argv
, char **envp
);
136 void qemu_get_timedate(struct tm
*tm
, int offset
);
137 int qemu_timedate_diff(struct tm
*tm
);
139 #if !GLIB_CHECK_VERSION(2, 20, 0)
141 * Glib before 2.20.0 doesn't implement g_poll, so wrap it to compile properly
144 static inline gint
g_poll(GPollFD
*fds
, guint nfds
, gint timeout
)
146 GMainContext
*ctx
= g_main_context_default();
147 return g_main_context_get_poll_func(ctx
)(fds
, nfds
, timeout
);
155 * Check whether @s is one of the standard strings which indicate
156 * that the user is asking for a list of the valid values for a
157 * command option like -cpu or -M. The current accepted strings
158 * are 'help' and '?'. '?' is deprecated (it is a shell wildcard
159 * which makes it annoying to use in a reliable way) but provided
160 * for backwards compatibility.
162 * Returns: true if @s is a request for a list.
164 static inline bool is_help_option(const char *s
)
166 return !strcmp(s
, "?") || !strcmp(s
, "help");
170 void pstrcpy(char *buf
, int buf_size
, const char *str
);
171 void strpadcpy(char *buf
, int buf_size
, const char *str
, char pad
);
172 char *pstrcat(char *buf
, int buf_size
, const char *s
);
173 int strstart(const char *str
, const char *val
, const char **ptr
);
174 int stristart(const char *str
, const char *val
, const char **ptr
);
175 int qemu_strnlen(const char *s
, int max_len
);
176 time_t mktimegm(struct tm
*tm
);
178 int qemu_fdatasync(int fd
);
179 int fcntl_setfl(int fd
, int flag
);
180 int qemu_parse_fd(const char *param
);
182 int parse_uint(const char *s
, unsigned long long *value
, char **endptr
,
184 int parse_uint_full(const char *s
, unsigned long long *value
, int base
);
187 * strtosz() suffixes used to specify the default treatment of an
188 * argument passed to strtosz() without an explicit suffix.
189 * These should be defined using upper case characters in the range
190 * A-Z, as strtosz() will use qemu_toupper() on the given argument
191 * prior to comparison.
193 #define STRTOSZ_DEFSUFFIX_TB 'T'
194 #define STRTOSZ_DEFSUFFIX_GB 'G'
195 #define STRTOSZ_DEFSUFFIX_MB 'M'
196 #define STRTOSZ_DEFSUFFIX_KB 'K'
197 #define STRTOSZ_DEFSUFFIX_B 'B'
198 int64_t strtosz(const char *nptr
, char **end
);
199 int64_t strtosz_suffix(const char *nptr
, char **end
, const char default_suffix
);
200 int64_t strtosz_suffix_unit(const char *nptr
, char **end
,
201 const char default_suffix
, int64_t unit
);
204 void init_paths(const char *prefix
);
205 const char *path(const char *pathname
);
207 #define qemu_isalnum(c) isalnum((unsigned char)(c))
208 #define qemu_isalpha(c) isalpha((unsigned char)(c))
209 #define qemu_iscntrl(c) iscntrl((unsigned char)(c))
210 #define qemu_isdigit(c) isdigit((unsigned char)(c))
211 #define qemu_isgraph(c) isgraph((unsigned char)(c))
212 #define qemu_islower(c) islower((unsigned char)(c))
213 #define qemu_isprint(c) isprint((unsigned char)(c))
214 #define qemu_ispunct(c) ispunct((unsigned char)(c))
215 #define qemu_isspace(c) isspace((unsigned char)(c))
216 #define qemu_isupper(c) isupper((unsigned char)(c))
217 #define qemu_isxdigit(c) isxdigit((unsigned char)(c))
218 #define qemu_tolower(c) tolower((unsigned char)(c))
219 #define qemu_toupper(c) toupper((unsigned char)(c))
220 #define qemu_isascii(c) isascii((unsigned char)(c))
221 #define qemu_toascii(c) toascii((unsigned char)(c))
223 void *qemu_oom_check(void *ptr
);
225 ssize_t
qemu_write_full(int fd
, const void *buf
, size_t count
)
226 QEMU_WARN_UNUSED_RESULT
;
227 ssize_t
qemu_send_full(int fd
, const void *buf
, size_t count
, int flags
)
228 QEMU_WARN_UNUSED_RESULT
;
229 ssize_t
qemu_recv_full(int fd
, void *buf
, size_t count
, int flags
)
230 QEMU_WARN_UNUSED_RESULT
;
233 int qemu_pipe(int pipefd
[2]);
237 /* MinGW needs type casts for the 'buf' and 'optval' arguments. */
238 #define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
239 getsockopt(sockfd, level, optname, (void *)optval, optlen)
240 #define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
241 setsockopt(sockfd, level, optname, (const void *)optval, optlen)
242 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags)
243 #define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
244 sendto(sockfd, (const void *)buf, len, flags, destaddr, addrlen)
246 #define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
247 getsockopt(sockfd, level, optname, optval, optlen)
248 #define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
249 setsockopt(sockfd, level, optname, optval, optlen)
250 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags)
251 #define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
252 sendto(sockfd, buf, len, flags, destaddr, addrlen)
255 /* Error handling. */
257 void QEMU_NORETURN
hw_error(const char *fmt
, ...) GCC_FMT_ATTR(1, 2);
259 struct ParallelIOArg
{
264 typedef int (*DMA_transfer_handler
) (void *opaque
, int nchan
, int pos
, int size
);
266 typedef uint64_t pcibus_t
;
268 typedef enum LostTickPolicy
{
276 typedef struct PCIHostDeviceAddress
{
280 unsigned int function
;
281 } PCIHostDeviceAddress
;
283 void tcg_exec_init(unsigned long tb_size
);
284 bool tcg_enabled(void);
286 void cpu_exec_init_all(void);
289 void cpu_save(QEMUFile
*f
, void *opaque
);
290 int cpu_load(QEMUFile
*f
, void *opaque
, int version_id
);
293 void qemu_cpu_kick_self(void);
296 struct qemu_work_item
{
297 struct qemu_work_item
*next
;
298 void (*func
)(void *data
);
303 #ifdef CONFIG_USER_ONLY
304 static inline void qemu_init_vcpu(void *env
)
308 void qemu_init_vcpu(void *env
);
313 * Sends a (part of) iovec down a socket, yielding when the socket is full, or
314 * Receives data into a (part of) iovec from a socket,
315 * yielding when there is no data in the socket.
316 * The same interface as qemu_sendv_recvv(), with added yielding.
317 * XXX should mark these as coroutine_fn
319 ssize_t
qemu_co_sendv_recvv(int sockfd
, struct iovec
*iov
, unsigned iov_cnt
,
320 size_t offset
, size_t bytes
, bool do_send
);
321 #define qemu_co_recvv(sockfd, iov, iov_cnt, offset, bytes) \
322 qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, false)
323 #define qemu_co_sendv(sockfd, iov, iov_cnt, offset, bytes) \
324 qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, true)
327 * The same as above, but with just a single buffer
329 ssize_t
qemu_co_send_recv(int sockfd
, void *buf
, size_t bytes
, bool do_send
);
330 #define qemu_co_recv(sockfd, buf, bytes) \
331 qemu_co_send_recv(sockfd, buf, bytes, false)
332 #define qemu_co_send(sockfd, buf, bytes) \
333 qemu_co_send_recv(sockfd, buf, bytes, true)
335 typedef struct QEMUIOVector
{
342 void qemu_iovec_init(QEMUIOVector
*qiov
, int alloc_hint
);
343 void qemu_iovec_init_external(QEMUIOVector
*qiov
, struct iovec
*iov
, int niov
);
344 void qemu_iovec_add(QEMUIOVector
*qiov
, void *base
, size_t len
);
345 void qemu_iovec_concat(QEMUIOVector
*dst
,
346 QEMUIOVector
*src
, size_t soffset
, size_t sbytes
);
347 void qemu_iovec_concat_iov(QEMUIOVector
*dst
,
348 struct iovec
*src_iov
, unsigned int src_cnt
,
349 size_t soffset
, size_t sbytes
);
350 void qemu_iovec_destroy(QEMUIOVector
*qiov
);
351 void qemu_iovec_reset(QEMUIOVector
*qiov
);
352 size_t qemu_iovec_to_buf(QEMUIOVector
*qiov
, size_t offset
,
353 void *buf
, size_t bytes
);
354 size_t qemu_iovec_from_buf(QEMUIOVector
*qiov
, size_t offset
,
355 const void *buf
, size_t bytes
);
356 size_t qemu_iovec_memset(QEMUIOVector
*qiov
, size_t offset
,
357 int fillc
, size_t bytes
);
359 bool buffer_is_zero(const void *buf
, size_t len
);
361 void qemu_progress_init(int enabled
, float min_skip
);
362 void qemu_progress_end(void);
363 void qemu_progress_print(float delta
, int max
);
364 const char *qemu_get_vm_name(void);
366 #define QEMU_FILE_TYPE_BIOS 0
367 #define QEMU_FILE_TYPE_KEYMAP 1
368 char *qemu_find_file(int type
, const char *name
);
370 /* OS specific functions */
371 void os_setup_early_signal_handling(void);
372 char *os_find_datadir(const char *argv0
);
373 void os_parse_cmd_args(int index
, const char *optarg
);
374 void os_pidfile_error(void);
376 /* Convert a byte between binary and BCD. */
377 static inline uint8_t to_bcd(uint8_t val
)
379 return ((val
/ 10) << 4) | (val
% 10);
382 static inline uint8_t from_bcd(uint8_t val
)
384 return ((val
>> 4) * 10) + (val
& 0x0f);
387 /* compute with 96 bit intermediate result: (a*b)/c */
388 static inline uint64_t muldiv64(uint64_t a
, uint32_t b
, uint32_t c
)
393 #ifdef HOST_WORDS_BIGENDIAN
403 rl
= (uint64_t)u
.l
.low
* (uint64_t)b
;
404 rh
= (uint64_t)u
.l
.high
* (uint64_t)b
;
407 res
.l
.low
= (((rh
% c
) << 32) + (rl
& 0xffffffff)) / c
;
411 /* Round number down to multiple */
412 #define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
414 /* Round number up to multiple */
415 #define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
417 static inline bool is_power_of_2(uint64_t value
)
423 return !(value
& (value
- 1));
426 /* round down to the nearest power of 2*/
427 int64_t pow2floor(int64_t value
);
429 #include "qemu/module.h"
432 * Implementation of ULEB128 (http://en.wikipedia.org/wiki/LEB128)
433 * Input is limited to 14-bit numbers
436 int uleb128_encode_small(uint8_t *out
, uint32_t n
);
437 int uleb128_decode_small(const uint8_t *in
, uint32_t *n
);
440 int mod_utf8_codepoint(const char *s
, size_t n
, char **end
);
443 * Hexdump a buffer to a file. An optional string prefix is added to every line
446 void hexdump(const char *buf
, FILE *fp
, const char *prefix
, size_t size
);
448 /* vector definitions */
451 #define VECTYPE vector unsigned char
452 #define SPLAT(p) vec_splat(vec_ld(0, p), 0)
453 #define ALL_EQ(v1, v2) vec_all_eq(v1, v2)
454 /* altivec.h may redefine the bool macro as vector type.
455 * Reset it to POSIX semantics. */
458 #elif defined __SSE2__
459 #include <emmintrin.h>
460 #define VECTYPE __m128i
461 #define SPLAT(p) _mm_set1_epi8(*(p))
462 #define ALL_EQ(v1, v2) (_mm_movemask_epi8(_mm_cmpeq_epi8(v1, v2)) == 0xFFFF)
464 #define VECTYPE unsigned long
465 #define SPLAT(p) (*(p) * (~0UL / 255))
466 #define ALL_EQ(v1, v2) ((v1) == (v2))
469 #define BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR 8
471 can_use_buffer_find_nonzero_offset(const void *buf
, size_t len
)
473 return (len
% (BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR
474 * sizeof(VECTYPE
)) == 0
475 && ((uintptr_t) buf
) % sizeof(VECTYPE
) == 0);
477 size_t buffer_find_nonzero_offset(const void *buf
, size_t len
);
480 * helper to parse debug environment variables
482 int parse_debug_env(const char *name
, int max
, int initial
);