]> git.proxmox.com Git - qemu.git/blame - qemu-common.h
Consolidate oom_check() functions
[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
beb6f0de
KW
5#include "config-host.h"
6
a5e50b26 7#define QEMU_NORETURN __attribute__ ((__noreturn__))
747bbdf7
BS
8#ifdef CONFIG_GCC_ATTRIBUTE_WARN_UNUSED_RESULT
9#define QEMU_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
10#else
11#define QEMU_WARN_UNUSED_RESULT
12#endif
7d99a001 13
24ebf5f3
PB
14#define QEMU_BUILD_BUG_ON(x) typedef char __build_bug_on__##__LINE__[(x)?-1:1];
15
29e922b6
BS
16typedef struct QEMUTimer QEMUTimer;
17typedef struct QEMUFile QEMUFile;
18typedef struct QEMUBH QEMUBH;
92a16d7a 19typedef struct DeviceState DeviceState;
29e922b6 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>
55616505 36#include <assert.h>
faf07963
PB
37
38#ifndef O_LARGEFILE
39#define O_LARGEFILE 0
40#endif
41#ifndef O_BINARY
42#define O_BINARY 0
43#endif
0e74e66b
JQ
44#ifndef MAP_ANONYMOUS
45#define MAP_ANONYMOUS MAP_ANON
46#endif
faf07963
PB
47#ifndef ENOMEDIUM
48#define ENOMEDIUM ENODEV
49#endif
4c955388 50#if !defined(ENOTSUP)
2880bc32
JQ
51#define ENOTSUP 4096
52#endif
faf07963 53
6114fdb0
JQ
54#ifndef CONFIG_IOVEC
55#define CONFIG_IOVEC
bf9298b9
AL
56struct iovec {
57 void *iov_base;
58 size_t iov_len;
59};
e2a305fb
CH
60/*
61 * Use the same value as Linux for now.
62 */
63#define IOV_MAX 1024
331dadde
BS
64#else
65#include <sys/uio.h>
bf9298b9
AL
66#endif
67
9c9e7d51
SW
68#if defined __GNUC__
69# if (__GNUC__ < 4) || \
70 defined(__GNUC_MINOR__) && (__GNUC__ == 4) && (__GNUC_MINOR__ < 4)
71 /* gcc versions before 4.4.x don't support gnu_printf, so use printf. */
72# define GCC_ATTR __attribute__((__unused__, format(printf, 1, 2)))
73# define GCC_FMT_ATTR(n, m) __attribute__((format(printf, n, m)))
74# else
75 /* Use gnu_printf when supported (qemu uses standard format strings). */
76# define GCC_ATTR __attribute__((__unused__, format(gnu_printf, 1, 2)))
77# define GCC_FMT_ATTR(n, m) __attribute__((format(gnu_printf, n, m)))
78# endif
79#else
80#define GCC_ATTR /**/
81#define GCC_FMT_ATTR(n, m)
82#endif
83
f868445a
SW
84typedef int (*fprintf_function)(FILE *f, const char *fmt, ...)
85 GCC_FMT_ATTR(2, 3);
86
faf07963 87#ifdef _WIN32
faf07963
PB
88#define fsync _commit
89#define lseek _lseeki64
faf07963
PB
90extern int qemu_ftruncate64(int, int64_t);
91#define ftruncate qemu_ftruncate64
92
faf07963
PB
93static inline char *realpath(const char *path, char *resolved_path)
94{
95 _fullpath(resolved_path, path, _MAX_PATH);
96 return resolved_path;
97}
98
99#define PRId64 "I64d"
100#define PRIx64 "I64x"
101#define PRIu64 "I64u"
102#define PRIo64 "I64o"
103#endif
104
105/* FIXME: Remove NEED_CPU_H. */
106#ifndef NEED_CPU_H
107
faf07963
PB
108#include <setjmp.h>
109#include "osdep.h"
110#include "bswap.h"
111
112#else
113
114#include "cpu.h"
115
116#endif /* !defined(NEED_CPU_H) */
117
118/* bottom halves */
faf07963
PB
119typedef void QEMUBHFunc(void *opaque);
120
9a1e9481
KW
121void async_context_push(void);
122void async_context_pop(void);
123int get_async_context_id(void);
124
faf07963
PB
125QEMUBH *qemu_bh_new(QEMUBHFunc *cb, void *opaque);
126void qemu_bh_schedule(QEMUBH *bh);
80d3580b
AL
127/* Bottom halfs that are scheduled from a bottom half handler are instantly
128 * invoked. This can create an infinite loop if a bottom half handler
129 * schedules itself. qemu_bh_schedule_idle() avoids this infinite loop by
130 * ensuring that the bottom half isn't executed until the next main loop
131 * iteration.
132 */
1b435b10 133void qemu_bh_schedule_idle(QEMUBH *bh);
faf07963
PB
134void qemu_bh_cancel(QEMUBH *bh);
135void qemu_bh_delete(QEMUBH *bh);
136int qemu_bh_poll(void);
4f999d05 137void qemu_bh_update_timeout(int *timeout);
faf07963 138
f6503059
AZ
139void qemu_get_timedate(struct tm *tm, int offset);
140int qemu_timedate_diff(struct tm *tm);
141
faf07963
PB
142/* cutils.c */
143void pstrcpy(char *buf, int buf_size, const char *str);
144char *pstrcat(char *buf, int buf_size, const char *s);
145int strstart(const char *str, const char *val, const char **ptr);
146int stristart(const char *str, const char *val, const char **ptr);
d43277c5 147int qemu_strnlen(const char *s, int max_len);
faf07963 148time_t mktimegm(struct tm *tm);
ad46db9a 149int qemu_fls(int i);
6f1953c4 150int qemu_fdatasync(int fd);
db1a4972 151int fcntl_setfl(int fd, int flag);
faf07963 152
37022086
BS
153/* path.c */
154void init_paths(const char *prefix);
155const char *path(const char *pathname);
156
cd390083
BS
157#define qemu_isalnum(c) isalnum((unsigned char)(c))
158#define qemu_isalpha(c) isalpha((unsigned char)(c))
159#define qemu_iscntrl(c) iscntrl((unsigned char)(c))
160#define qemu_isdigit(c) isdigit((unsigned char)(c))
161#define qemu_isgraph(c) isgraph((unsigned char)(c))
162#define qemu_islower(c) islower((unsigned char)(c))
163#define qemu_isprint(c) isprint((unsigned char)(c))
164#define qemu_ispunct(c) ispunct((unsigned char)(c))
165#define qemu_isspace(c) isspace((unsigned char)(c))
166#define qemu_isupper(c) isupper((unsigned char)(c))
167#define qemu_isxdigit(c) isxdigit((unsigned char)(c))
168#define qemu_tolower(c) tolower((unsigned char)(c))
169#define qemu_toupper(c) toupper((unsigned char)(c))
170#define qemu_isascii(c) isascii((unsigned char)(c))
171#define qemu_toascii(c) toascii((unsigned char)(c))
172
dc786bc9
JS
173#ifdef _WIN32
174/* ffs() in oslib-win32.c for WIN32, strings.h for the rest of the world */
175int ffs(int i);
176#endif
177
b152aa84 178void *qemu_oom_check(void *ptr);
ca10f867 179void *qemu_malloc(size_t size);
2137b4cc 180void *qemu_realloc(void *ptr, size_t size);
ca10f867
AJ
181void *qemu_mallocz(size_t size);
182void qemu_free(void *ptr);
183char *qemu_strdup(const char *str);
ac4b0d0c 184char *qemu_strndup(const char *str, size_t size);
ca10f867 185
d549db5a
GC
186void qemu_mutex_lock_iothread(void);
187void qemu_mutex_unlock_iothread(void);
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;
40ff6d7e
KW
192void qemu_set_cloexec(int fd);
193
194#ifndef _WIN32
f3dfda61 195int qemu_eventfd(int pipefd[2]);
40ff6d7e
KW
196int qemu_pipe(int pipefd[2]);
197#endif
198
87ecb68b
PB
199/* Error handling. */
200
e5924d89 201void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
87ecb68b
PB
202
203/* IO callbacks. */
204typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size);
7b27a769 205typedef int IOCanReadHandler(void *opaque);
87ecb68b
PB
206typedef void IOHandler(void *opaque);
207
208struct ParallelIOArg {
209 void *buffer;
210 int count;
211};
212
213typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
214
215/* A load of opaque types so that device init declarations don't have to
216 pull in all the real definitions. */
217typedef struct NICInfo NICInfo;
1ae26a18 218typedef struct HCIInfo HCIInfo;
87ecb68b
PB
219typedef struct AudioState AudioState;
220typedef struct BlockDriverState BlockDriverState;
2446333c 221typedef struct DriveInfo DriveInfo;
87ecb68b 222typedef struct DisplayState DisplayState;
7d957bd8
AL
223typedef struct DisplayChangeListener DisplayChangeListener;
224typedef struct DisplaySurface DisplaySurface;
7b5d76da 225typedef struct DisplayAllocator DisplayAllocator;
7d957bd8 226typedef struct PixelFormat PixelFormat;
87ecb68b 227typedef struct TextConsole TextConsole;
c60e08d9 228typedef TextConsole QEMUConsole;
87ecb68b 229typedef struct CharDriverState CharDriverState;
76d32cba 230typedef struct MACAddr MACAddr;
87ecb68b 231typedef struct VLANState VLANState;
f7105843 232typedef struct VLANClientState VLANClientState;
87ecb68b
PB
233typedef struct i2c_bus i2c_bus;
234typedef struct i2c_slave i2c_slave;
235typedef struct SMBusDevice SMBusDevice;
fb47a2e9
IY
236typedef struct PCIHostState PCIHostState;
237typedef struct PCIExpressHost PCIExpressHost;
87ecb68b
PB
238typedef struct PCIBus PCIBus;
239typedef struct PCIDevice PCIDevice;
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;
87ecb68b 249
186993ee
MT
250typedef uint64_t pcibus_t;
251
2446333c
BS
252typedef enum {
253 IF_NONE,
254 IF_IDE, IF_SCSI, IF_FLOPPY, IF_PFLASH, IF_MTD, IF_SD, IF_VIRTIO, IF_XEN,
255 IF_COUNT
256} BlockInterfaceType;
257
d2053c3c
BS
258void cpu_exec_init_all(unsigned long tb_size);
259
b3c7724c
PB
260/* CPU save/load. */
261void cpu_save(QEMUFile *f, void *opaque);
262int cpu_load(QEMUFile *f, void *opaque, int version_id);
263
9e472e10
AL
264/* Force QEMU to stop what it's doing and service IO */
265void qemu_service_io(void);
266
d9f75a4e
AL
267/* Force QEMU to process pending events */
268void qemu_notify_event(void);
269
8edac960
AL
270/* Unblock cpu */
271void qemu_cpu_kick(void *env);
272int qemu_cpu_self(void *env);
273
e82bcec2
MT
274/* work queue */
275struct qemu_work_item {
276 struct qemu_work_item *next;
277 void (*func)(void *data);
278 void *data;
279 int done;
280};
281
0bf46a40
AL
282#ifdef CONFIG_USER_ONLY
283#define qemu_init_vcpu(env) do { } while (0)
284#else
285void qemu_init_vcpu(void *env);
286#endif
287
44e3ee8a
AL
288typedef struct QEMUIOVector {
289 struct iovec *iov;
290 int niov;
291 int nalloc;
249aa745 292 size_t size;
44e3ee8a
AL
293} QEMUIOVector;
294
295void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
522584a5 296void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
44e3ee8a 297void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
b8a83a4f
KW
298void qemu_iovec_copy(QEMUIOVector *dst, QEMUIOVector *src, uint64_t skip,
299 size_t size);
40b4f539 300void qemu_iovec_concat(QEMUIOVector *dst, QEMUIOVector *src, size_t size);
44e3ee8a 301void qemu_iovec_destroy(QEMUIOVector *qiov);
be959463 302void qemu_iovec_reset(QEMUIOVector *qiov);
44e3ee8a 303void qemu_iovec_to_buffer(QEMUIOVector *qiov, void *buf);
249aa745 304void qemu_iovec_from_buffer(QEMUIOVector *qiov, const void *buf, size_t count);
b8a83a4f 305void qemu_iovec_memset(QEMUIOVector *qiov, int c, size_t count);
44e3ee8a 306
376253ec
AL
307struct Monitor;
308typedef struct Monitor Monitor;
309
abd0c6bd
PB
310/* Convert a byte between binary and BCD. */
311static inline uint8_t to_bcd(uint8_t val)
312{
313 return ((val / 10) << 4) | (val % 10);
314}
315
316static inline uint8_t from_bcd(uint8_t val)
317{
318 return ((val >> 4) * 10) + (val & 0x0f);
319}
320
338b922e 321/* compute with 96 bit intermediate result: (a*b)/c */
322static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
323{
324 union {
325 uint64_t ll;
326 struct {
327#ifdef HOST_WORDS_BIGENDIAN
328 uint32_t high, low;
329#else
330 uint32_t low, high;
331#endif
332 } l;
333 } u, res;
334 uint64_t rl, rh;
335
336 u.ll = a;
337 rl = (uint64_t)u.l.low * (uint64_t)b;
338 rh = (uint64_t)u.l.high * (uint64_t)b;
339 rh += (rl >> 32);
340 res.l.high = rh / c;
341 res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
342 return res.ll;
343}
344
0bfe3ca5
AL
345#include "module.h"
346
faf07963 347#endif