2 /* Common header file that is included by all of qemu. */
7 #include "config-host.h"
9 #if defined(__arm__) || defined(__sparc__) || defined(__mips__) || defined(__hppa__) || defined(__ia64__)
13 #define TFR(expr) do { if ((expr) != -1) break; } while (errno == EINTR)
15 typedef struct QEMUTimer QEMUTimer;
16 typedef struct QEMUFile QEMUFile;
17 typedef struct DeviceState DeviceState;
20 typedef struct Monitor Monitor;
21 typedef struct MigrationParams MigrationParams;
23 /* we put basic includes here to avoid repeating them in device drivers */
44 #include "qemu-os-win32.h"
48 #include "qemu-os-posix.h"
58 #define MAP_ANONYMOUS MAP_ANON
61 #define ENOMEDIUM ENODEV
66 #if !defined(ECANCELED)
67 #define ECANCELED 4097
70 #define TIME_MAX LONG_MAX
73 /* HOST_LONG_BITS is the size of a native pointer in bits. */
74 #if UINTPTR_MAX == UINT32_MAX
75 # define HOST_LONG_BITS 32
76 #elif UINTPTR_MAX == UINT64_MAX
77 # define HOST_LONG_BITS 64
79 # error Unknown pointer size
89 * Use the same value as Linux for now.
96 typedef int (*fprintf_function)(FILE *f, const char *fmt, ...)
100 #define fsync _commit
102 # define lseek _lseeki64
104 int qemu_ftruncate64(int, int64_t);
105 #if !defined(ftruncate)
106 # define ftruncate qemu_ftruncate64
109 static inline char *realpath(const char *path, char *resolved_path)
111 _fullpath(resolved_path, path, _MAX_PATH);
112 return resolved_path;
117 void configure_icount(const char *option);
118 extern int use_icount;
120 /* 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);
144 * Check whether @s is one of the standard strings which indicate
145 * that the user is asking for a list of the valid values for a
146 * command option like -cpu or -M. The current accepted strings
147 * are 'help' and '?'. '?' is deprecated (it is a shell wildcard
148 * which makes it annoying to use in a reliable way) but provided
149 * for backwards compatibility.
151 * Returns: true if @s is a request for a list.
153 static inline bool is_help_option(const char *s)
155 return !strcmp(s, "?") || !strcmp(s, "help");
159 void pstrcpy(char *buf, int buf_size, const char *str);
160 void strpadcpy(char *buf, int buf_size, const char *str, char pad);
161 char *pstrcat(char *buf, int buf_size, const char *s);
162 int strstart(const char *str, const char *val, const char **ptr);
163 int stristart(const char *str, const char *val, const char **ptr);
164 int qemu_strnlen(const char *s, int max_len);
165 time_t mktimegm(struct tm *tm);
167 int qemu_fdatasync(int fd);
168 int fcntl_setfl(int fd, int flag);
169 int qemu_parse_fd(const char *param);
170 int qemu_parse_fdset(const char *param);
173 * strtosz() suffixes used to specify the default treatment of an
174 * argument passed to strtosz() without an explicit suffix.
175 * These should be defined using upper case characters in the range
176 * A-Z, as strtosz() will use qemu_toupper() on the given argument
177 * prior to comparison.
179 #define STRTOSZ_DEFSUFFIX_TB 'T'
180 #define STRTOSZ_DEFSUFFIX_GB 'G'
181 #define STRTOSZ_DEFSUFFIX_MB 'M'
182 #define STRTOSZ_DEFSUFFIX_KB 'K'
183 #define STRTOSZ_DEFSUFFIX_B 'B'
184 int64_t strtosz(const char *nptr, char **end);
185 int64_t strtosz_suffix(const char *nptr, char **end, const char default_suffix);
186 int64_t strtosz_suffix_unit(const char *nptr, char **end,
187 const char default_suffix, int64_t unit);
190 void init_paths(const char *prefix);
191 const char *path(const char *pathname);
193 #define qemu_isalnum(c) isalnum((unsigned char)(c))
194 #define qemu_isalpha(c) isalpha((unsigned char)(c))
195 #define qemu_iscntrl(c) iscntrl((unsigned char)(c))
196 #define qemu_isdigit(c) isdigit((unsigned char)(c))
197 #define qemu_isgraph(c) isgraph((unsigned char)(c))
198 #define qemu_islower(c) islower((unsigned char)(c))
199 #define qemu_isprint(c) isprint((unsigned char)(c))
200 #define qemu_ispunct(c) ispunct((unsigned char)(c))
201 #define qemu_isspace(c) isspace((unsigned char)(c))
202 #define qemu_isupper(c) isupper((unsigned char)(c))
203 #define qemu_isxdigit(c) isxdigit((unsigned char)(c))
204 #define qemu_tolower(c) tolower((unsigned char)(c))
205 #define qemu_toupper(c) toupper((unsigned char)(c))
206 #define qemu_isascii(c) isascii((unsigned char)(c))
207 #define qemu_toascii(c) toascii((unsigned char)(c))
209 void *qemu_oom_check(void *ptr);
211 int qemu_open(const char *name, int flags, ...);
212 int qemu_close(int fd);
213 ssize_t qemu_write_full(int fd, const void *buf, size_t count)
214 QEMU_WARN_UNUSED_RESULT;
215 ssize_t qemu_send_full(int fd, const void *buf, size_t count, int flags)
216 QEMU_WARN_UNUSED_RESULT;
217 ssize_t qemu_recv_full(int fd, void *buf, size_t count, int flags)
218 QEMU_WARN_UNUSED_RESULT;
221 int qemu_eventfd(int pipefd[2]);
222 int qemu_pipe(int pipefd[2]);
226 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags)
228 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags)
231 /* Error handling. */
233 void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
235 struct ParallelIOArg {
240 typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
242 /* A load of opaque types so that device init declarations don't have to
243 pull in all the real definitions. */
244 typedef struct NICInfo NICInfo;
245 typedef struct HCIInfo HCIInfo;
246 typedef struct AudioState AudioState;
247 typedef struct BlockDriverState BlockDriverState;
248 typedef struct DriveInfo DriveInfo;
249 typedef struct DisplayState DisplayState;
250 typedef struct DisplayChangeListener DisplayChangeListener;
251 typedef struct DisplaySurface DisplaySurface;
252 typedef struct DisplayAllocator DisplayAllocator;
253 typedef struct PixelFormat PixelFormat;
254 typedef struct TextConsole TextConsole;
255 typedef TextConsole QEMUConsole;
256 typedef struct CharDriverState CharDriverState;
257 typedef struct MACAddr MACAddr;
258 typedef struct NetClientState NetClientState;
259 typedef struct i2c_bus i2c_bus;
260 typedef struct ISABus ISABus;
261 typedef struct ISADevice ISADevice;
262 typedef struct SMBusDevice SMBusDevice;
263 typedef struct PCIHostState PCIHostState;
264 typedef struct PCIExpressHost PCIExpressHost;
265 typedef struct PCIBus PCIBus;
266 typedef struct PCIDevice PCIDevice;
267 typedef struct PCIExpressDevice PCIExpressDevice;
268 typedef struct PCIBridge PCIBridge;
269 typedef struct PCIEAERMsg PCIEAERMsg;
270 typedef struct PCIEAERLog PCIEAERLog;
271 typedef struct PCIEAERErr PCIEAERErr;
272 typedef struct PCIEPort PCIEPort;
273 typedef struct PCIESlot PCIESlot;
274 typedef struct MSIMessage MSIMessage;
275 typedef struct SerialState SerialState;
276 typedef struct IRQState *qemu_irq;
277 typedef struct PCMCIACardState PCMCIACardState;
278 typedef struct MouseTransformInfo MouseTransformInfo;
279 typedef struct uWireSlave uWireSlave;
280 typedef struct I2SCodec I2SCodec;
281 typedef struct SSIBus SSIBus;
282 typedef struct EventNotifier EventNotifier;
283 typedef struct VirtIODevice VirtIODevice;
284 typedef struct QEMUSGList QEMUSGList;
285 typedef struct SHPCDevice SHPCDevice;
287 typedef uint64_t pcibus_t;
289 typedef enum LostTickPolicy {
297 typedef struct PCIHostDeviceAddress {
301 unsigned int function;
302 } PCIHostDeviceAddress;
304 void tcg_exec_init(unsigned long tb_size);
305 bool tcg_enabled(void);
307 void cpu_exec_init_all(void);
310 void cpu_save(QEMUFile *f, void *opaque);
311 int cpu_load(QEMUFile *f, void *opaque, int version_id);
314 void qemu_cpu_kick(void *env);
315 void qemu_cpu_kick_self(void);
316 int qemu_cpu_is_self(void *env);
319 struct qemu_work_item {
320 struct qemu_work_item *next;
321 void (*func)(void *data);
326 #ifdef CONFIG_USER_ONLY
327 #define qemu_init_vcpu(env) do { } while (0)
329 void qemu_init_vcpu(void *env);
334 * Sends a (part of) iovec down a socket, yielding when the socket is full, or
335 * Receives data into a (part of) iovec from a socket,
336 * yielding when there is no data in the socket.
337 * The same interface as qemu_sendv_recvv(), with added yielding.
338 * XXX should mark these as coroutine_fn
340 ssize_t qemu_co_sendv_recvv(int sockfd, struct iovec *iov, unsigned iov_cnt,
341 size_t offset, size_t bytes, bool do_send);
342 #define qemu_co_recvv(sockfd, iov, iov_cnt, offset, bytes) \
343 qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, false)
344 #define qemu_co_sendv(sockfd, iov, iov_cnt, offset, bytes) \
345 qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, true)
348 * The same as above, but with just a single buffer
350 ssize_t qemu_co_send_recv(int sockfd, void *buf, size_t bytes, bool do_send);
351 #define qemu_co_recv(sockfd, buf, bytes) \
352 qemu_co_send_recv(sockfd, buf, bytes, false)
353 #define qemu_co_send(sockfd, buf, bytes) \
354 qemu_co_send_recv(sockfd, buf, bytes, true)
356 typedef struct QEMUIOVector {
363 void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
364 void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
365 void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
366 void qemu_iovec_concat(QEMUIOVector *dst,
367 QEMUIOVector *src, size_t soffset, size_t sbytes);
368 void qemu_iovec_destroy(QEMUIOVector *qiov);
369 void qemu_iovec_reset(QEMUIOVector *qiov);
370 size_t qemu_iovec_to_buf(QEMUIOVector *qiov, size_t offset,
371 void *buf, size_t bytes);
372 size_t qemu_iovec_from_buf(QEMUIOVector *qiov, size_t offset,
373 const void *buf, size_t bytes);
374 size_t qemu_iovec_memset(QEMUIOVector *qiov, size_t offset,
375 int fillc, size_t bytes);
377 bool buffer_is_zero(const void *buf, size_t len);
379 void qemu_progress_init(int enabled, float min_skip);
380 void qemu_progress_end(void);
381 void qemu_progress_print(float delta, int max);
382 const char *qemu_get_vm_name(void);
384 #define QEMU_FILE_TYPE_BIOS 0
385 #define QEMU_FILE_TYPE_KEYMAP 1
386 char *qemu_find_file(int type, const char *name);
388 /* OS specific functions */
389 void os_setup_early_signal_handling(void);
390 char *os_find_datadir(const char *argv0);
391 void os_parse_cmd_args(int index, const char *optarg);
392 void os_pidfile_error(void);
394 /* Convert a byte between binary and BCD. */
395 static inline uint8_t to_bcd(uint8_t val)
397 return ((val / 10) << 4) | (val % 10);
400 static inline uint8_t from_bcd(uint8_t val)
402 return ((val >> 4) * 10) + (val & 0x0f);
405 /* compute with 96 bit intermediate result: (a*b)/c */
406 static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
411 #ifdef HOST_WORDS_BIGENDIAN
421 rl = (uint64_t)u.l.low * (uint64_t)b;
422 rh = (uint64_t)u.l.high * (uint64_t)b;
425 res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
429 /* Round number down to multiple */
430 #define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
432 /* Round number up to multiple */
433 #define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
435 static inline bool is_power_of_2(uint64_t value)
441 return !(value & (value - 1));
444 /* round down to the nearest power of 2*/
445 int64_t pow2floor(int64_t value);
450 * Implementation of ULEB128 (http://en.wikipedia.org/wiki/LEB128)
451 * Input is limited to 14-bit numbers
454 int uleb128_encode_small(uint8_t *out, uint32_t n);
455 int uleb128_decode_small(const uint8_t *in, uint32_t *n);