]> git.proxmox.com Git - qemu.git/blame - qemu-common.h
Add MigrationParams structure
[qemu.git] / qemu-common.h
CommitLineData
faf07963
PB
1/* Common header file that is included by all of qemu. */
2#ifndef QEMU_COMMON_H
3#define QEMU_COMMON_H
4
5c026320 5#include "compiler.h"
beb6f0de
KW
6#include "config-host.h"
7
332ae28d
PB
8#if defined(__arm__) || defined(__sparc__) || defined(__mips__) || defined(__hppa__) || defined(__ia64__)
9#define WORDS_ALIGNED
10#endif
11
082b5557 12#define TFR(expr) do { if ((expr) != -1) break; } while (errno == EINTR)
24ebf5f3 13
29e922b6
BS
14typedef struct QEMUTimer QEMUTimer;
15typedef struct QEMUFile QEMUFile;
92a16d7a 16typedef struct DeviceState DeviceState;
29e922b6 17
316378e4
JK
18struct Monitor;
19typedef struct Monitor Monitor;
6607ae23 20typedef struct MigrationParams MigrationParams;
316378e4 21
faf07963
PB
22/* we put basic includes here to avoid repeating them in device drivers */
23#include <stdlib.h>
24#include <stdio.h>
25#include <stdarg.h>
11165820 26#include <stdbool.h>
faf07963 27#include <string.h>
c8906845 28#include <strings.h>
faf07963
PB
29#include <inttypes.h>
30#include <limits.h>
31#include <time.h>
32#include <ctype.h>
33#include <errno.h>
34#include <unistd.h>
35#include <fcntl.h>
36#include <sys/stat.h>
dcfd0865 37#include <sys/time.h>
55616505 38#include <assert.h>
86f69a92 39#include <signal.h>
14015304 40#include <glib.h>
faf07963 41
082b5557
BS
42#ifdef _WIN32
43#include "qemu-os-win32.h"
44#endif
45
46#ifdef CONFIG_POSIX
47#include "qemu-os-posix.h"
48#endif
49
faf07963
PB
50#ifndef O_LARGEFILE
51#define O_LARGEFILE 0
52#endif
53#ifndef O_BINARY
54#define O_BINARY 0
55#endif
0e74e66b
JQ
56#ifndef MAP_ANONYMOUS
57#define MAP_ANONYMOUS MAP_ANON
58#endif
faf07963
PB
59#ifndef ENOMEDIUM
60#define ENOMEDIUM ENODEV
61#endif
4c955388 62#if !defined(ENOTSUP)
2880bc32
JQ
63#define ENOTSUP 4096
64#endif
2084a8e3
PB
65#if !defined(ECANCELED)
66#define ECANCELED 4097
67#endif
3c9405a0
GH
68#ifndef TIME_MAX
69#define TIME_MAX LONG_MAX
70#endif
faf07963 71
c0fd260e
SW
72/* HOST_LONG_BITS is the size of a native pointer in bits. */
73#if UINTPTR_MAX == UINT32_MAX
74# define HOST_LONG_BITS 32
75#elif UINTPTR_MAX == UINT64_MAX
76# define HOST_LONG_BITS 64
77#else
78# error Unknown pointer size
79#endif
80
6114fdb0
JQ
81#ifndef CONFIG_IOVEC
82#define CONFIG_IOVEC
bf9298b9
AL
83struct iovec {
84 void *iov_base;
85 size_t iov_len;
86};
e2a305fb
CH
87/*
88 * Use the same value as Linux for now.
89 */
90#define IOV_MAX 1024
331dadde
BS
91#else
92#include <sys/uio.h>
bf9298b9
AL
93#endif
94
f868445a
SW
95typedef int (*fprintf_function)(FILE *f, const char *fmt, ...)
96 GCC_FMT_ATTR(2, 3);
97
faf07963 98#ifdef _WIN32
faf07963 99#define fsync _commit
371c6489
SW
100#if !defined(lseek)
101# define lseek _lseeki64
102#endif
64b85a8f 103int qemu_ftruncate64(int, int64_t);
371c6489
SW
104#if !defined(ftruncate)
105# define ftruncate qemu_ftruncate64
106#endif
faf07963 107
faf07963
PB
108static inline char *realpath(const char *path, char *resolved_path)
109{
110 _fullpath(resolved_path, path, _MAX_PATH);
111 return resolved_path;
112}
faf07963
PB
113#endif
114
946fb27c
PB
115/* icount */
116void configure_icount(const char *option);
117extern int use_icount;
118
faf07963
PB
119/* FIXME: Remove NEED_CPU_H. */
120#ifndef NEED_CPU_H
121
faf07963
PB
122#include "osdep.h"
123#include "bswap.h"
124
125#else
126
127#include "cpu.h"
128
129#endif /* !defined(NEED_CPU_H) */
130
3bbbee18
AF
131/* main function, renamed */
132#if defined(CONFIG_COCOA)
133int qemu_main(int argc, char **argv, char **envp);
134#endif
135
f6503059
AZ
136void qemu_get_timedate(struct tm *tm, int offset);
137int qemu_timedate_diff(struct tm *tm);
138
faf07963
PB
139/* cutils.c */
140void pstrcpy(char *buf, int buf_size, const char *str);
141char *pstrcat(char *buf, int buf_size, const char *s);
142int strstart(const char *str, const char *val, const char **ptr);
143int stristart(const char *str, const char *val, const char **ptr);
d43277c5 144int qemu_strnlen(const char *s, int max_len);
faf07963 145time_t mktimegm(struct tm *tm);
ad46db9a 146int qemu_fls(int i);
6f1953c4 147int qemu_fdatasync(int fd);
db1a4972 148int fcntl_setfl(int fd, int flag);
443916d1 149int qemu_parse_fd(const char *param);
d8427002 150
d7142456
JS
151/*
152 * strtosz() suffixes used to specify the default treatment of an
153 * argument passed to strtosz() without an explicit suffix.
154 * These should be defined using upper case characters in the range
155 * A-Z, as strtosz() will use qemu_toupper() on the given argument
156 * prior to comparison.
157 */
d8427002
JS
158#define STRTOSZ_DEFSUFFIX_TB 'T'
159#define STRTOSZ_DEFSUFFIX_GB 'G'
160#define STRTOSZ_DEFSUFFIX_MB 'M'
161#define STRTOSZ_DEFSUFFIX_KB 'K'
162#define STRTOSZ_DEFSUFFIX_B 'B'
70b4f4bb
JS
163int64_t strtosz(const char *nptr, char **end);
164int64_t strtosz_suffix(const char *nptr, char **end, const char default_suffix);
a732e1ba
JR
165int64_t strtosz_suffix_unit(const char *nptr, char **end,
166 const char default_suffix, int64_t unit);
faf07963 167
37022086
BS
168/* path.c */
169void init_paths(const char *prefix);
170const char *path(const char *pathname);
171
cd390083
BS
172#define qemu_isalnum(c) isalnum((unsigned char)(c))
173#define qemu_isalpha(c) isalpha((unsigned char)(c))
174#define qemu_iscntrl(c) iscntrl((unsigned char)(c))
175#define qemu_isdigit(c) isdigit((unsigned char)(c))
176#define qemu_isgraph(c) isgraph((unsigned char)(c))
177#define qemu_islower(c) islower((unsigned char)(c))
178#define qemu_isprint(c) isprint((unsigned char)(c))
179#define qemu_ispunct(c) ispunct((unsigned char)(c))
180#define qemu_isspace(c) isspace((unsigned char)(c))
181#define qemu_isupper(c) isupper((unsigned char)(c))
182#define qemu_isxdigit(c) isxdigit((unsigned char)(c))
183#define qemu_tolower(c) tolower((unsigned char)(c))
184#define qemu_toupper(c) toupper((unsigned char)(c))
185#define qemu_isascii(c) isascii((unsigned char)(c))
186#define qemu_toascii(c) toascii((unsigned char)(c))
187
b152aa84 188void *qemu_oom_check(void *ptr);
ca10f867 189
40ff6d7e 190int qemu_open(const char *name, int flags, ...);
7c7c0629
JQ
191ssize_t qemu_write_full(int fd, const void *buf, size_t count)
192 QEMU_WARN_UNUSED_RESULT;
993295fe
PB
193ssize_t qemu_send_full(int fd, const void *buf, size_t count, int flags)
194 QEMU_WARN_UNUSED_RESULT;
8c5135f9 195ssize_t qemu_recv_full(int fd, void *buf, size_t count, int flags)
993295fe 196 QEMU_WARN_UNUSED_RESULT;
40ff6d7e
KW
197
198#ifndef _WIN32
f3dfda61 199int qemu_eventfd(int pipefd[2]);
40ff6d7e
KW
200int qemu_pipe(int pipefd[2]);
201#endif
202
00aa0040
BS
203#ifdef _WIN32
204#define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags)
205#else
206#define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags)
207#endif
208
8c5135f9
PB
209int qemu_recvv(int sockfd, struct iovec *iov, int len, int iov_offset);
210int qemu_sendv(int sockfd, struct iovec *iov, int len, int iov_offset);
211
87ecb68b
PB
212/* Error handling. */
213
e5924d89 214void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
87ecb68b 215
87ecb68b
PB
216struct ParallelIOArg {
217 void *buffer;
218 int count;
219};
220
221typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
222
223/* A load of opaque types so that device init declarations don't have to
224 pull in all the real definitions. */
225typedef struct NICInfo NICInfo;
1ae26a18 226typedef struct HCIInfo HCIInfo;
87ecb68b
PB
227typedef struct AudioState AudioState;
228typedef struct BlockDriverState BlockDriverState;
2446333c 229typedef struct DriveInfo DriveInfo;
87ecb68b 230typedef struct DisplayState DisplayState;
7d957bd8
AL
231typedef struct DisplayChangeListener DisplayChangeListener;
232typedef struct DisplaySurface DisplaySurface;
7b5d76da 233typedef struct DisplayAllocator DisplayAllocator;
7d957bd8 234typedef struct PixelFormat PixelFormat;
87ecb68b 235typedef struct TextConsole TextConsole;
c60e08d9 236typedef TextConsole QEMUConsole;
87ecb68b 237typedef struct CharDriverState CharDriverState;
76d32cba 238typedef struct MACAddr MACAddr;
87ecb68b 239typedef struct VLANState VLANState;
f7105843 240typedef struct VLANClientState VLANClientState;
87ecb68b 241typedef struct i2c_bus i2c_bus;
48a18b3c 242typedef struct ISABus ISABus;
dfc65f1f 243typedef struct ISADevice ISADevice;
87ecb68b 244typedef struct SMBusDevice SMBusDevice;
fb47a2e9
IY
245typedef struct PCIHostState PCIHostState;
246typedef struct PCIExpressHost PCIExpressHost;
87ecb68b
PB
247typedef struct PCIBus PCIBus;
248typedef struct PCIDevice PCIDevice;
0428527c 249typedef struct PCIExpressDevice PCIExpressDevice;
68f79994 250typedef struct PCIBridge PCIBridge;
34e65944
IY
251typedef struct PCIEAERMsg PCIEAERMsg;
252typedef struct PCIEAERLog PCIEAERLog;
253typedef struct PCIEAERErr PCIEAERErr;
bc20ba98
IY
254typedef struct PCIEPort PCIEPort;
255typedef struct PCIESlot PCIESlot;
14de9bab 256typedef struct MSIMessage MSIMessage;
87ecb68b
PB
257typedef struct SerialState SerialState;
258typedef struct IRQState *qemu_irq;
bc24a225
PB
259typedef struct PCMCIACardState PCMCIACardState;
260typedef struct MouseTransformInfo MouseTransformInfo;
261typedef struct uWireSlave uWireSlave;
262typedef struct I2SCodec I2SCodec;
90d37239 263typedef struct SSIBus SSIBus;
2292b339 264typedef struct EventNotifier EventNotifier;
2be24aaa 265typedef struct VirtIODevice VirtIODevice;
d35bf9ad 266typedef struct QEMUSGList QEMUSGList;
1dc324d2 267typedef struct SHPCDevice SHPCDevice;
87ecb68b 268
186993ee
MT
269typedef uint64_t pcibus_t;
270
4e4fa398
JK
271typedef enum LostTickPolicy {
272 LOST_TICK_DISCARD,
273 LOST_TICK_DELAY,
274 LOST_TICK_MERGE,
275 LOST_TICK_SLEW,
1ce05125 276 LOST_TICK_MAX
4e4fa398
JK
277} LostTickPolicy;
278
679042f0
AP
279typedef struct PCIHostDeviceAddress {
280 unsigned int domain;
281 unsigned int bus;
282 unsigned int slot;
283 unsigned int function;
284} PCIHostDeviceAddress;
285
d5ab9713
JK
286void tcg_exec_init(unsigned long tb_size);
287bool tcg_enabled(void);
288
289void cpu_exec_init_all(void);
d2053c3c 290
b3c7724c
PB
291/* CPU save/load. */
292void cpu_save(QEMUFile *f, void *opaque);
293int cpu_load(QEMUFile *f, void *opaque, int version_id);
294
8edac960
AL
295/* Unblock cpu */
296void qemu_cpu_kick(void *env);
46d62fac 297void qemu_cpu_kick_self(void);
b7680cb6 298int qemu_cpu_is_self(void *env);
ab33fcda 299bool all_cpu_threads_idle(void);
8edac960 300
e82bcec2
MT
301/* work queue */
302struct qemu_work_item {
303 struct qemu_work_item *next;
304 void (*func)(void *data);
305 void *data;
306 int done;
307};
308
0bf46a40
AL
309#ifdef CONFIG_USER_ONLY
310#define qemu_init_vcpu(env) do { } while (0)
311#else
312void qemu_init_vcpu(void *env);
313#endif
314
8c5135f9
PB
315/**
316 * Sends an iovec (or optionally a part of it) down a socket, yielding
317 * when the socket is full.
318 */
319int qemu_co_sendv(int sockfd, struct iovec *iov,
320 int len, int iov_offset);
321
322/**
323 * Receives data into an iovec (or optionally into a part of it) from
324 * a socket, yielding when there is no data in the socket.
325 */
326int qemu_co_recvv(int sockfd, struct iovec *iov,
327 int len, int iov_offset);
328
329
330/**
331 * Sends a buffer down a socket, yielding when the socket is full.
332 */
333int qemu_co_send(int sockfd, void *buf, int len);
334
335/**
336 * Receives data into a buffer from a socket, yielding when there
337 * is no data in the socket.
338 */
339int qemu_co_recv(int sockfd, void *buf, int len);
340
341
44e3ee8a
AL
342typedef struct QEMUIOVector {
343 struct iovec *iov;
344 int niov;
345 int nalloc;
249aa745 346 size_t size;
44e3ee8a
AL
347} QEMUIOVector;
348
349void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
522584a5 350void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
44e3ee8a 351void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
b8a83a4f
KW
352void qemu_iovec_copy(QEMUIOVector *dst, QEMUIOVector *src, uint64_t skip,
353 size_t size);
40b4f539 354void qemu_iovec_concat(QEMUIOVector *dst, QEMUIOVector *src, size_t size);
44e3ee8a 355void qemu_iovec_destroy(QEMUIOVector *qiov);
be959463 356void qemu_iovec_reset(QEMUIOVector *qiov);
44e3ee8a 357void qemu_iovec_to_buffer(QEMUIOVector *qiov, void *buf);
249aa745 358void qemu_iovec_from_buffer(QEMUIOVector *qiov, const void *buf, size_t count);
b8a83a4f 359void qemu_iovec_memset(QEMUIOVector *qiov, int c, size_t count);
e0d9c6f9
CT
360void qemu_iovec_memset_skip(QEMUIOVector *qiov, int c, size_t count,
361 size_t skip);
44e3ee8a 362
1a6d39fd
SH
363bool buffer_is_zero(const void *buf, size_t len);
364
6b837bc4
JS
365void qemu_progress_init(int enabled, float min_skip);
366void qemu_progress_end(void);
3bfe4dbf 367void qemu_progress_print(float delta, int max);
6b837bc4 368
082b5557
BS
369#define QEMU_FILE_TYPE_BIOS 0
370#define QEMU_FILE_TYPE_KEYMAP 1
371char *qemu_find_file(int type, const char *name);
372
373/* OS specific functions */
374void os_setup_early_signal_handling(void);
375char *os_find_datadir(const char *argv0);
376void os_parse_cmd_args(int index, const char *optarg);
377void os_pidfile_error(void);
378
abd0c6bd
PB
379/* Convert a byte between binary and BCD. */
380static inline uint8_t to_bcd(uint8_t val)
381{
382 return ((val / 10) << 4) | (val % 10);
383}
384
385static inline uint8_t from_bcd(uint8_t val)
386{
387 return ((val >> 4) * 10) + (val & 0x0f);
388}
389
338b922e 390/* compute with 96 bit intermediate result: (a*b)/c */
391static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
392{
393 union {
394 uint64_t ll;
395 struct {
396#ifdef HOST_WORDS_BIGENDIAN
397 uint32_t high, low;
398#else
399 uint32_t low, high;
400#endif
401 } l;
402 } u, res;
403 uint64_t rl, rh;
404
405 u.ll = a;
406 rl = (uint64_t)u.l.low * (uint64_t)b;
407 rh = (uint64_t)u.l.high * (uint64_t)b;
408 rh += (rl >> 32);
409 res.l.high = rh / c;
410 res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
411 return res.ll;
412}
413
3951690a
SH
414/* Round number down to multiple */
415#define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
416
417/* Round number up to multiple */
418#define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
419
0bfe3ca5
AL
420#include "module.h"
421
faf07963 422#endif