]> git.proxmox.com Git - qemu.git/blame - qemu-common.h
cleanup qemu_co_sendv(), qemu_co_recvv() and friends
[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
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;
14de9bab 251typedef struct MSIMessage MSIMessage;
87ecb68b
PB
252typedef struct SerialState SerialState;
253typedef struct IRQState *qemu_irq;
bc24a225
PB
254typedef struct PCMCIACardState PCMCIACardState;
255typedef struct MouseTransformInfo MouseTransformInfo;
256typedef struct uWireSlave uWireSlave;
257typedef struct I2SCodec I2SCodec;
90d37239 258typedef struct SSIBus SSIBus;
2292b339 259typedef struct EventNotifier EventNotifier;
2be24aaa 260typedef struct VirtIODevice VirtIODevice;
d35bf9ad 261typedef struct QEMUSGList QEMUSGList;
1dc324d2 262typedef struct SHPCDevice SHPCDevice;
87ecb68b 263
186993ee
MT
264typedef uint64_t pcibus_t;
265
4e4fa398
JK
266typedef enum LostTickPolicy {
267 LOST_TICK_DISCARD,
268 LOST_TICK_DELAY,
269 LOST_TICK_MERGE,
270 LOST_TICK_SLEW,
1ce05125 271 LOST_TICK_MAX
4e4fa398
JK
272} LostTickPolicy;
273
d5ab9713
JK
274void tcg_exec_init(unsigned long tb_size);
275bool tcg_enabled(void);
276
277void cpu_exec_init_all(void);
d2053c3c 278
b3c7724c
PB
279/* CPU save/load. */
280void cpu_save(QEMUFile *f, void *opaque);
281int cpu_load(QEMUFile *f, void *opaque, int version_id);
282
8edac960
AL
283/* Unblock cpu */
284void qemu_cpu_kick(void *env);
46d62fac 285void qemu_cpu_kick_self(void);
b7680cb6 286int qemu_cpu_is_self(void *env);
ab33fcda 287bool all_cpu_threads_idle(void);
8edac960 288
e82bcec2
MT
289/* work queue */
290struct qemu_work_item {
291 struct qemu_work_item *next;
292 void (*func)(void *data);
293 void *data;
294 int done;
295};
296
0bf46a40
AL
297#ifdef CONFIG_USER_ONLY
298#define qemu_init_vcpu(env) do { } while (0)
299#else
300void qemu_init_vcpu(void *env);
301#endif
302
8c5135f9
PB
303
304/**
2fc8ae1d
MT
305 * Sends a (part of) iovec down a socket, yielding when the socket is full, or
306 * Receives data into a (part of) iovec from a socket,
307 * yielding when there is no data in the socket.
308 * The same interface as qemu_sendv_recvv(), with added yielding.
309 * XXX should mark these as coroutine_fn
8c5135f9 310 */
2fc8ae1d
MT
311ssize_t qemu_co_sendv_recvv(int sockfd, struct iovec *iov, unsigned iov_cnt,
312 size_t offset, size_t bytes, bool do_send);
313#define qemu_co_recvv(sockfd, iov, iov_cnt, offset, bytes) \
314 qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, false)
315#define qemu_co_sendv(sockfd, iov, iov_cnt, offset, bytes) \
316 qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, true)
8c5135f9
PB
317
318/**
2fc8ae1d 319 * The same as above, but with just a single buffer
8c5135f9 320 */
2fc8ae1d
MT
321ssize_t qemu_co_send_recv(int sockfd, void *buf, size_t bytes, bool do_send);
322#define qemu_co_recv(sockfd, buf, bytes) \
323 qemu_co_send_recv(sockfd, buf, bytes, false)
324#define qemu_co_send(sockfd, buf, bytes) \
325 qemu_co_send_recv(sockfd, buf, bytes, true)
8c5135f9 326
44e3ee8a
AL
327typedef struct QEMUIOVector {
328 struct iovec *iov;
329 int niov;
330 int nalloc;
249aa745 331 size_t size;
44e3ee8a
AL
332} QEMUIOVector;
333
334void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
522584a5 335void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
44e3ee8a 336void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
1b093c48
MT
337void qemu_iovec_concat(QEMUIOVector *dst,
338 QEMUIOVector *src, size_t soffset, size_t sbytes);
44e3ee8a 339void qemu_iovec_destroy(QEMUIOVector *qiov);
be959463 340void qemu_iovec_reset(QEMUIOVector *qiov);
d5e6b161
MT
341size_t qemu_iovec_to_buf(QEMUIOVector *qiov, size_t offset,
342 void *buf, size_t bytes);
03396148
MT
343size_t qemu_iovec_from_buf(QEMUIOVector *qiov, size_t offset,
344 const void *buf, size_t bytes);
3d9b4925
MT
345size_t qemu_iovec_memset(QEMUIOVector *qiov, size_t offset,
346 int fillc, size_t bytes);
44e3ee8a 347
1a6d39fd
SH
348bool buffer_is_zero(const void *buf, size_t len);
349
6b837bc4
JS
350void qemu_progress_init(int enabled, float min_skip);
351void qemu_progress_end(void);
3bfe4dbf 352void qemu_progress_print(float delta, int max);
6b837bc4 353
082b5557
BS
354#define QEMU_FILE_TYPE_BIOS 0
355#define QEMU_FILE_TYPE_KEYMAP 1
356char *qemu_find_file(int type, const char *name);
357
358/* OS specific functions */
359void os_setup_early_signal_handling(void);
360char *os_find_datadir(const char *argv0);
361void os_parse_cmd_args(int index, const char *optarg);
362void os_pidfile_error(void);
363
abd0c6bd
PB
364/* Convert a byte between binary and BCD. */
365static inline uint8_t to_bcd(uint8_t val)
366{
367 return ((val / 10) << 4) | (val % 10);
368}
369
370static inline uint8_t from_bcd(uint8_t val)
371{
372 return ((val >> 4) * 10) + (val & 0x0f);
373}
374
338b922e 375/* compute with 96 bit intermediate result: (a*b)/c */
376static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
377{
378 union {
379 uint64_t ll;
380 struct {
381#ifdef HOST_WORDS_BIGENDIAN
382 uint32_t high, low;
383#else
384 uint32_t low, high;
385#endif
386 } l;
387 } u, res;
388 uint64_t rl, rh;
389
390 u.ll = a;
391 rl = (uint64_t)u.l.low * (uint64_t)b;
392 rh = (uint64_t)u.l.high * (uint64_t)b;
393 rh += (rl >> 32);
394 res.l.high = rh / c;
395 res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
396 return res.ll;
397}
398
3951690a
SH
399/* Round number down to multiple */
400#define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
401
402/* Round number up to multiple */
403#define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
404
0bfe3ca5
AL
405#include "module.h"
406
faf07963 407#endif