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