]> git.ipfire.org Git - thirdparty/qemu.git/blame - qemu-common.h
net: Rename VLANClientState to NetClientState
[thirdparty/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);
2a025ae4 141void strpadcpy(char *buf, int buf_size, const char *str, char pad);
faf07963
PB
142char *pstrcat(char *buf, int buf_size, const char *s);
143int strstart(const char *str, const char *val, const char **ptr);
144int stristart(const char *str, const char *val, const char **ptr);
d43277c5 145int qemu_strnlen(const char *s, int max_len);
faf07963 146time_t mktimegm(struct tm *tm);
ad46db9a 147int qemu_fls(int i);
6f1953c4 148int qemu_fdatasync(int fd);
db1a4972 149int fcntl_setfl(int fd, int flag);
443916d1 150int qemu_parse_fd(const char *param);
d8427002 151
d7142456
JS
152/*
153 * strtosz() suffixes used to specify the default treatment of an
154 * argument passed to strtosz() without an explicit suffix.
155 * These should be defined using upper case characters in the range
156 * A-Z, as strtosz() will use qemu_toupper() on the given argument
157 * prior to comparison.
158 */
d8427002
JS
159#define STRTOSZ_DEFSUFFIX_TB 'T'
160#define STRTOSZ_DEFSUFFIX_GB 'G'
161#define STRTOSZ_DEFSUFFIX_MB 'M'
162#define STRTOSZ_DEFSUFFIX_KB 'K'
163#define STRTOSZ_DEFSUFFIX_B 'B'
70b4f4bb
JS
164int64_t strtosz(const char *nptr, char **end);
165int64_t strtosz_suffix(const char *nptr, char **end, const char default_suffix);
a732e1ba
JR
166int64_t strtosz_suffix_unit(const char *nptr, char **end,
167 const char default_suffix, int64_t unit);
faf07963 168
37022086
BS
169/* path.c */
170void init_paths(const char *prefix);
171const char *path(const char *pathname);
172
cd390083
BS
173#define qemu_isalnum(c) isalnum((unsigned char)(c))
174#define qemu_isalpha(c) isalpha((unsigned char)(c))
175#define qemu_iscntrl(c) iscntrl((unsigned char)(c))
176#define qemu_isdigit(c) isdigit((unsigned char)(c))
177#define qemu_isgraph(c) isgraph((unsigned char)(c))
178#define qemu_islower(c) islower((unsigned char)(c))
179#define qemu_isprint(c) isprint((unsigned char)(c))
180#define qemu_ispunct(c) ispunct((unsigned char)(c))
181#define qemu_isspace(c) isspace((unsigned char)(c))
182#define qemu_isupper(c) isupper((unsigned char)(c))
183#define qemu_isxdigit(c) isxdigit((unsigned char)(c))
184#define qemu_tolower(c) tolower((unsigned char)(c))
185#define qemu_toupper(c) toupper((unsigned char)(c))
186#define qemu_isascii(c) isascii((unsigned char)(c))
187#define qemu_toascii(c) toascii((unsigned char)(c))
188
b152aa84 189void *qemu_oom_check(void *ptr);
ca10f867 190
40ff6d7e 191int qemu_open(const char *name, int flags, ...);
7c7c0629
JQ
192ssize_t qemu_write_full(int fd, const void *buf, size_t count)
193 QEMU_WARN_UNUSED_RESULT;
993295fe
PB
194ssize_t qemu_send_full(int fd, const void *buf, size_t count, int flags)
195 QEMU_WARN_UNUSED_RESULT;
8c5135f9 196ssize_t qemu_recv_full(int fd, void *buf, size_t count, int flags)
993295fe 197 QEMU_WARN_UNUSED_RESULT;
40ff6d7e
KW
198
199#ifndef _WIN32
f3dfda61 200int qemu_eventfd(int pipefd[2]);
40ff6d7e
KW
201int qemu_pipe(int pipefd[2]);
202#endif
203
00aa0040
BS
204#ifdef _WIN32
205#define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags)
206#else
207#define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags)
208#endif
209
87ecb68b
PB
210/* Error handling. */
211
e5924d89 212void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
87ecb68b 213
87ecb68b
PB
214struct ParallelIOArg {
215 void *buffer;
216 int count;
217};
218
219typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
220
221/* A load of opaque types so that device init declarations don't have to
222 pull in all the real definitions. */
223typedef struct NICInfo NICInfo;
1ae26a18 224typedef struct HCIInfo HCIInfo;
87ecb68b
PB
225typedef struct AudioState AudioState;
226typedef struct BlockDriverState BlockDriverState;
2446333c 227typedef struct DriveInfo DriveInfo;
87ecb68b 228typedef struct DisplayState DisplayState;
7d957bd8
AL
229typedef struct DisplayChangeListener DisplayChangeListener;
230typedef struct DisplaySurface DisplaySurface;
7b5d76da 231typedef struct DisplayAllocator DisplayAllocator;
7d957bd8 232typedef struct PixelFormat PixelFormat;
87ecb68b 233typedef struct TextConsole TextConsole;
c60e08d9 234typedef TextConsole QEMUConsole;
87ecb68b 235typedef struct CharDriverState CharDriverState;
76d32cba 236typedef struct MACAddr MACAddr;
4e68f7a0 237typedef struct NetClientState NetClientState;
87ecb68b 238typedef struct i2c_bus i2c_bus;
48a18b3c 239typedef struct ISABus ISABus;
dfc65f1f 240typedef struct ISADevice ISADevice;
87ecb68b 241typedef struct SMBusDevice SMBusDevice;
fb47a2e9
IY
242typedef struct PCIHostState PCIHostState;
243typedef struct PCIExpressHost PCIExpressHost;
87ecb68b
PB
244typedef struct PCIBus PCIBus;
245typedef struct PCIDevice PCIDevice;
0428527c 246typedef struct PCIExpressDevice PCIExpressDevice;
68f79994 247typedef struct PCIBridge PCIBridge;
34e65944
IY
248typedef struct PCIEAERMsg PCIEAERMsg;
249typedef struct PCIEAERLog PCIEAERLog;
250typedef struct PCIEAERErr PCIEAERErr;
bc20ba98
IY
251typedef struct PCIEPort PCIEPort;
252typedef struct PCIESlot PCIESlot;
14de9bab 253typedef struct MSIMessage MSIMessage;
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
679042f0
AP
276typedef struct PCIHostDeviceAddress {
277 unsigned int domain;
278 unsigned int bus;
279 unsigned int slot;
280 unsigned int function;
281} PCIHostDeviceAddress;
282
d5ab9713
JK
283void tcg_exec_init(unsigned long tb_size);
284bool tcg_enabled(void);
285
286void cpu_exec_init_all(void);
d2053c3c 287
b3c7724c
PB
288/* CPU save/load. */
289void cpu_save(QEMUFile *f, void *opaque);
290int cpu_load(QEMUFile *f, void *opaque, int version_id);
291
8edac960
AL
292/* Unblock cpu */
293void qemu_cpu_kick(void *env);
46d62fac 294void qemu_cpu_kick_self(void);
b7680cb6 295int qemu_cpu_is_self(void *env);
8edac960 296
e82bcec2
MT
297/* work queue */
298struct qemu_work_item {
299 struct qemu_work_item *next;
300 void (*func)(void *data);
301 void *data;
302 int done;
303};
304
0bf46a40
AL
305#ifdef CONFIG_USER_ONLY
306#define qemu_init_vcpu(env) do { } while (0)
307#else
308void qemu_init_vcpu(void *env);
309#endif
310
8c5135f9
PB
311
312/**
2fc8ae1d
MT
313 * Sends a (part of) iovec down a socket, yielding when the socket is full, or
314 * Receives data into a (part of) iovec from a socket,
315 * yielding when there is no data in the socket.
316 * The same interface as qemu_sendv_recvv(), with added yielding.
317 * XXX should mark these as coroutine_fn
8c5135f9 318 */
2fc8ae1d
MT
319ssize_t qemu_co_sendv_recvv(int sockfd, struct iovec *iov, unsigned iov_cnt,
320 size_t offset, size_t bytes, bool do_send);
321#define qemu_co_recvv(sockfd, iov, iov_cnt, offset, bytes) \
322 qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, false)
323#define qemu_co_sendv(sockfd, iov, iov_cnt, offset, bytes) \
324 qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, true)
8c5135f9
PB
325
326/**
2fc8ae1d 327 * The same as above, but with just a single buffer
8c5135f9 328 */
2fc8ae1d
MT
329ssize_t qemu_co_send_recv(int sockfd, void *buf, size_t bytes, bool do_send);
330#define qemu_co_recv(sockfd, buf, bytes) \
331 qemu_co_send_recv(sockfd, buf, bytes, false)
332#define qemu_co_send(sockfd, buf, bytes) \
333 qemu_co_send_recv(sockfd, buf, bytes, true)
8c5135f9 334
44e3ee8a
AL
335typedef struct QEMUIOVector {
336 struct iovec *iov;
337 int niov;
338 int nalloc;
249aa745 339 size_t size;
44e3ee8a
AL
340} QEMUIOVector;
341
342void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
522584a5 343void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
44e3ee8a 344void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
1b093c48
MT
345void qemu_iovec_concat(QEMUIOVector *dst,
346 QEMUIOVector *src, size_t soffset, size_t sbytes);
44e3ee8a 347void qemu_iovec_destroy(QEMUIOVector *qiov);
be959463 348void qemu_iovec_reset(QEMUIOVector *qiov);
d5e6b161
MT
349size_t qemu_iovec_to_buf(QEMUIOVector *qiov, size_t offset,
350 void *buf, size_t bytes);
03396148
MT
351size_t qemu_iovec_from_buf(QEMUIOVector *qiov, size_t offset,
352 const void *buf, size_t bytes);
3d9b4925
MT
353size_t qemu_iovec_memset(QEMUIOVector *qiov, size_t offset,
354 int fillc, size_t bytes);
44e3ee8a 355
1a6d39fd
SH
356bool buffer_is_zero(const void *buf, size_t len);
357
6b837bc4
JS
358void qemu_progress_init(int enabled, float min_skip);
359void qemu_progress_end(void);
3bfe4dbf 360void qemu_progress_print(float delta, int max);
6b837bc4 361
082b5557
BS
362#define QEMU_FILE_TYPE_BIOS 0
363#define QEMU_FILE_TYPE_KEYMAP 1
364char *qemu_find_file(int type, const char *name);
365
366/* OS specific functions */
367void os_setup_early_signal_handling(void);
368char *os_find_datadir(const char *argv0);
369void os_parse_cmd_args(int index, const char *optarg);
370void os_pidfile_error(void);
371
abd0c6bd
PB
372/* Convert a byte between binary and BCD. */
373static inline uint8_t to_bcd(uint8_t val)
374{
375 return ((val / 10) << 4) | (val % 10);
376}
377
378static inline uint8_t from_bcd(uint8_t val)
379{
380 return ((val >> 4) * 10) + (val & 0x0f);
381}
382
338b922e 383/* compute with 96 bit intermediate result: (a*b)/c */
384static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
385{
386 union {
387 uint64_t ll;
388 struct {
389#ifdef HOST_WORDS_BIGENDIAN
390 uint32_t high, low;
391#else
392 uint32_t low, high;
393#endif
394 } l;
395 } u, res;
396 uint64_t rl, rh;
397
398 u.ll = a;
399 rl = (uint64_t)u.l.low * (uint64_t)b;
400 rh = (uint64_t)u.l.high * (uint64_t)b;
401 rh += (rl >> 32);
402 res.l.high = rh / c;
403 res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
404 return res.ll;
405}
406
3951690a
SH
407/* Round number down to multiple */
408#define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
409
410/* Round number up to multiple */
411#define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
412
0bfe3ca5
AL
413#include "module.h"
414
faf07963 415#endif