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