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