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 */
46 #include "sysemu/os-win32.h"
50 #include "sysemu/os-posix.h"
60 #define MAP_ANONYMOUS MAP_ANON
63 #define ENOMEDIUM ENODEV
68 #if !defined(ECANCELED)
69 #define ECANCELED 4097
71 #if !defined(EMEDIUMTYPE)
72 #define EMEDIUMTYPE 4098
75 #define TIME_MAX LONG_MAX
78 /* HOST_LONG_BITS is the size of a native pointer in bits. */
79 #if UINTPTR_MAX == UINT32_MAX
80 # define HOST_LONG_BITS 32
81 #elif UINTPTR_MAX == UINT64_MAX
82 # define HOST_LONG_BITS 64
84 # error Unknown pointer size
94 * Use the same value as Linux for now.
101 typedef int (*fprintf_function
)(FILE *f
, const char *fmt
, ...)
105 #define fsync _commit
107 # define lseek _lseeki64
109 int qemu_ftruncate64(int, int64_t);
110 #if !defined(ftruncate)
111 # define ftruncate qemu_ftruncate64
114 static inline char *realpath(const char *path
, char *resolved_path
)
116 _fullpath(resolved_path
, path
, _MAX_PATH
);
117 return resolved_path
;
122 void configure_icount(const char *option
);
123 extern int use_icount
;
125 /* FIXME: Remove NEED_CPU_H. */
128 #include "qemu/osdep.h"
129 #include "qemu/bswap.h"
135 #endif /* !defined(NEED_CPU_H) */
137 /* main function, renamed */
138 #if defined(CONFIG_COCOA)
139 int qemu_main(int argc
, char **argv
, char **envp
);
142 void qemu_get_timedate(struct tm
*tm
, int offset
);
143 int qemu_timedate_diff(struct tm
*tm
);
149 * Check whether @s is one of the standard strings which indicate
150 * that the user is asking for a list of the valid values for a
151 * command option like -cpu or -M. The current accepted strings
152 * are 'help' and '?'. '?' is deprecated (it is a shell wildcard
153 * which makes it annoying to use in a reliable way) but provided
154 * for backwards compatibility.
156 * Returns: true if @s is a request for a list.
158 static inline bool is_help_option(const char *s
)
160 return !strcmp(s
, "?") || !strcmp(s
, "help");
164 void pstrcpy(char *buf
, int buf_size
, const char *str
);
165 void strpadcpy(char *buf
, int buf_size
, const char *str
, char pad
);
166 char *pstrcat(char *buf
, int buf_size
, const char *s
);
167 int strstart(const char *str
, const char *val
, const char **ptr
);
168 int stristart(const char *str
, const char *val
, const char **ptr
);
169 int qemu_strnlen(const char *s
, int max_len
);
170 time_t mktimegm(struct tm
*tm
);
172 int qemu_fdatasync(int fd
);
173 int fcntl_setfl(int fd
, int flag
);
174 int qemu_parse_fd(const char *param
);
176 int parse_uint(const char *s
, unsigned long long *value
, char **endptr
,
178 int parse_uint_full(const char *s
, unsigned long long *value
, int base
);
181 * strtosz() suffixes used to specify the default treatment of an
182 * argument passed to strtosz() without an explicit suffix.
183 * These should be defined using upper case characters in the range
184 * A-Z, as strtosz() will use qemu_toupper() on the given argument
185 * prior to comparison.
187 #define STRTOSZ_DEFSUFFIX_TB 'T'
188 #define STRTOSZ_DEFSUFFIX_GB 'G'
189 #define STRTOSZ_DEFSUFFIX_MB 'M'
190 #define STRTOSZ_DEFSUFFIX_KB 'K'
191 #define STRTOSZ_DEFSUFFIX_B 'B'
192 int64_t strtosz(const char *nptr
, char **end
);
193 int64_t strtosz_suffix(const char *nptr
, char **end
, const char default_suffix
);
194 int64_t strtosz_suffix_unit(const char *nptr
, char **end
,
195 const char default_suffix
, int64_t unit
);
198 void init_paths(const char *prefix
);
199 const char *path(const char *pathname
);
201 #define qemu_isalnum(c) isalnum((unsigned char)(c))
202 #define qemu_isalpha(c) isalpha((unsigned char)(c))
203 #define qemu_iscntrl(c) iscntrl((unsigned char)(c))
204 #define qemu_isdigit(c) isdigit((unsigned char)(c))
205 #define qemu_isgraph(c) isgraph((unsigned char)(c))
206 #define qemu_islower(c) islower((unsigned char)(c))
207 #define qemu_isprint(c) isprint((unsigned char)(c))
208 #define qemu_ispunct(c) ispunct((unsigned char)(c))
209 #define qemu_isspace(c) isspace((unsigned char)(c))
210 #define qemu_isupper(c) isupper((unsigned char)(c))
211 #define qemu_isxdigit(c) isxdigit((unsigned char)(c))
212 #define qemu_tolower(c) tolower((unsigned char)(c))
213 #define qemu_toupper(c) toupper((unsigned char)(c))
214 #define qemu_isascii(c) isascii((unsigned char)(c))
215 #define qemu_toascii(c) toascii((unsigned char)(c))
217 void *qemu_oom_check(void *ptr
);
219 ssize_t
qemu_write_full(int fd
, const void *buf
, size_t count
)
220 QEMU_WARN_UNUSED_RESULT
;
221 ssize_t
qemu_send_full(int fd
, const void *buf
, size_t count
, int flags
)
222 QEMU_WARN_UNUSED_RESULT
;
223 ssize_t
qemu_recv_full(int fd
, void *buf
, size_t count
, int flags
)
224 QEMU_WARN_UNUSED_RESULT
;
227 int qemu_pipe(int pipefd
[2]);
231 /* MinGW needs type casts for the 'buf' and 'optval' arguments. */
232 #define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
233 getsockopt(sockfd, level, optname, (void *)optval, optlen)
234 #define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
235 setsockopt(sockfd, level, optname, (const void *)optval, optlen)
236 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags)
237 #define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
238 sendto(sockfd, (const void *)buf, len, flags, destaddr, addrlen)
240 #define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
241 getsockopt(sockfd, level, optname, optval, optlen)
242 #define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
243 setsockopt(sockfd, level, optname, optval, optlen)
244 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags)
245 #define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
246 sendto(sockfd, buf, len, flags, destaddr, addrlen)
249 /* Error handling. */
251 void QEMU_NORETURN
hw_error(const char *fmt
, ...) GCC_FMT_ATTR(1, 2);
253 struct ParallelIOArg
{
258 typedef int (*DMA_transfer_handler
) (void *opaque
, int nchan
, int pos
, int size
);
260 typedef uint64_t pcibus_t
;
262 typedef enum LostTickPolicy
{
270 typedef struct PCIHostDeviceAddress
{
274 unsigned int function
;
275 } PCIHostDeviceAddress
;
277 void tcg_exec_init(unsigned long tb_size
);
278 bool tcg_enabled(void);
280 void cpu_exec_init_all(void);
283 void cpu_save(QEMUFile
*f
, void *opaque
);
284 int cpu_load(QEMUFile
*f
, void *opaque
, int version_id
);
287 void qemu_cpu_kick_self(void);
290 struct qemu_work_item
{
291 struct qemu_work_item
*next
;
292 void (*func
)(void *data
);
297 #ifdef CONFIG_USER_ONLY
298 static inline void qemu_init_vcpu(void *env
)
302 void qemu_init_vcpu(void *env
);
307 * Sends a (part of) iovec down a socket, yielding when the socket is full, or
308 * Receives data into a (part of) iovec from a socket,
309 * yielding when there is no data in the socket.
310 * The same interface as qemu_sendv_recvv(), with added yielding.
311 * XXX should mark these as coroutine_fn
313 ssize_t
qemu_co_sendv_recvv(int sockfd
, struct iovec
*iov
, unsigned iov_cnt
,
314 size_t offset
, size_t bytes
, bool do_send
);
315 #define qemu_co_recvv(sockfd, iov, iov_cnt, offset, bytes) \
316 qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, false)
317 #define qemu_co_sendv(sockfd, iov, iov_cnt, offset, bytes) \
318 qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, true)
321 * The same as above, but with just a single buffer
323 ssize_t
qemu_co_send_recv(int sockfd
, void *buf
, size_t bytes
, bool do_send
);
324 #define qemu_co_recv(sockfd, buf, bytes) \
325 qemu_co_send_recv(sockfd, buf, bytes, false)
326 #define qemu_co_send(sockfd, buf, bytes) \
327 qemu_co_send_recv(sockfd, buf, bytes, true)
329 typedef struct QEMUIOVector
{
336 void qemu_iovec_init(QEMUIOVector
*qiov
, int alloc_hint
);
337 void qemu_iovec_init_external(QEMUIOVector
*qiov
, struct iovec
*iov
, int niov
);
338 void qemu_iovec_add(QEMUIOVector
*qiov
, void *base
, size_t len
);
339 void qemu_iovec_concat(QEMUIOVector
*dst
,
340 QEMUIOVector
*src
, size_t soffset
, size_t sbytes
);
341 void qemu_iovec_concat_iov(QEMUIOVector
*dst
,
342 struct iovec
*src_iov
, unsigned int src_cnt
,
343 size_t soffset
, size_t sbytes
);
344 void qemu_iovec_destroy(QEMUIOVector
*qiov
);
345 void qemu_iovec_reset(QEMUIOVector
*qiov
);
346 size_t qemu_iovec_to_buf(QEMUIOVector
*qiov
, size_t offset
,
347 void *buf
, size_t bytes
);
348 size_t qemu_iovec_from_buf(QEMUIOVector
*qiov
, size_t offset
,
349 const void *buf
, size_t bytes
);
350 size_t qemu_iovec_memset(QEMUIOVector
*qiov
, size_t offset
,
351 int fillc
, size_t bytes
);
353 bool buffer_is_zero(const void *buf
, size_t len
);
355 void qemu_progress_init(int enabled
, float min_skip
);
356 void qemu_progress_end(void);
357 void qemu_progress_print(float delta
, int max
);
358 const char *qemu_get_vm_name(void);
360 #define QEMU_FILE_TYPE_BIOS 0
361 #define QEMU_FILE_TYPE_KEYMAP 1
362 char *qemu_find_file(int type
, const char *name
);
364 /* OS specific functions */
365 void os_setup_early_signal_handling(void);
366 char *os_find_datadir(const char *argv0
);
367 void os_parse_cmd_args(int index
, const char *optarg
);
368 void os_pidfile_error(void);
370 /* Convert a byte between binary and BCD. */
371 static inline uint8_t to_bcd(uint8_t val
)
373 return ((val
/ 10) << 4) | (val
% 10);
376 static inline uint8_t from_bcd(uint8_t val
)
378 return ((val
>> 4) * 10) + (val
& 0x0f);
381 /* compute with 96 bit intermediate result: (a*b)/c */
382 static inline uint64_t muldiv64(uint64_t a
, uint32_t b
, uint32_t c
)
387 #ifdef HOST_WORDS_BIGENDIAN
397 rl
= (uint64_t)u
.l
.low
* (uint64_t)b
;
398 rh
= (uint64_t)u
.l
.high
* (uint64_t)b
;
401 res
.l
.low
= (((rh
% c
) << 32) + (rl
& 0xffffffff)) / c
;
405 /* Round number down to multiple */
406 #define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
408 /* Round number up to multiple */
409 #define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
411 static inline bool is_power_of_2(uint64_t value
)
417 return !(value
& (value
- 1));
420 /* round down to the nearest power of 2*/
421 int64_t pow2floor(int64_t value
);
423 #include "qemu/module.h"
426 * Implementation of ULEB128 (http://en.wikipedia.org/wiki/LEB128)
427 * Input is limited to 14-bit numbers
430 int uleb128_encode_small(uint8_t *out
, uint32_t n
);
431 int uleb128_decode_small(const uint8_t *in
, uint32_t *n
);