]> git.proxmox.com Git - qemu.git/blame - qemu-common.h
x86: Small cleanups of MCE helpers
[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>
dcfd0865 36#include <sys/time.h>
55616505 37#include <assert.h>
faf07963
PB
38
39#ifndef O_LARGEFILE
40#define O_LARGEFILE 0
41#endif
42#ifndef O_BINARY
43#define O_BINARY 0
44#endif
0e74e66b
JQ
45#ifndef MAP_ANONYMOUS
46#define MAP_ANONYMOUS MAP_ANON
47#endif
faf07963
PB
48#ifndef ENOMEDIUM
49#define ENOMEDIUM ENODEV
50#endif
4c955388 51#if !defined(ENOTSUP)
2880bc32
JQ
52#define ENOTSUP 4096
53#endif
3c9405a0
GH
54#ifndef TIME_MAX
55#define TIME_MAX LONG_MAX
56#endif
faf07963 57
6114fdb0
JQ
58#ifndef CONFIG_IOVEC
59#define CONFIG_IOVEC
bf9298b9
AL
60struct iovec {
61 void *iov_base;
62 size_t iov_len;
63};
e2a305fb
CH
64/*
65 * Use the same value as Linux for now.
66 */
67#define IOV_MAX 1024
331dadde
BS
68#else
69#include <sys/uio.h>
bf9298b9
AL
70#endif
71
9c9e7d51
SW
72#if defined __GNUC__
73# if (__GNUC__ < 4) || \
74 defined(__GNUC_MINOR__) && (__GNUC__ == 4) && (__GNUC_MINOR__ < 4)
75 /* gcc versions before 4.4.x don't support gnu_printf, so use printf. */
76# define GCC_ATTR __attribute__((__unused__, format(printf, 1, 2)))
77# define GCC_FMT_ATTR(n, m) __attribute__((format(printf, n, m)))
78# else
79 /* Use gnu_printf when supported (qemu uses standard format strings). */
80# define GCC_ATTR __attribute__((__unused__, format(gnu_printf, 1, 2)))
81# define GCC_FMT_ATTR(n, m) __attribute__((format(gnu_printf, n, m)))
82# endif
83#else
84#define GCC_ATTR /**/
85#define GCC_FMT_ATTR(n, m)
86#endif
87
f868445a
SW
88typedef int (*fprintf_function)(FILE *f, const char *fmt, ...)
89 GCC_FMT_ATTR(2, 3);
90
faf07963 91#ifdef _WIN32
faf07963
PB
92#define fsync _commit
93#define lseek _lseeki64
64b85a8f 94int qemu_ftruncate64(int, int64_t);
faf07963
PB
95#define ftruncate qemu_ftruncate64
96
faf07963
PB
97static inline char *realpath(const char *path, char *resolved_path)
98{
99 _fullpath(resolved_path, path, _MAX_PATH);
100 return resolved_path;
101}
102
103#define PRId64 "I64d"
104#define PRIx64 "I64x"
105#define PRIu64 "I64u"
106#define PRIo64 "I64o"
107#endif
108
109/* FIXME: Remove NEED_CPU_H. */
110#ifndef NEED_CPU_H
111
faf07963
PB
112#include <setjmp.h>
113#include "osdep.h"
114#include "bswap.h"
115
116#else
117
118#include "cpu.h"
119
120#endif /* !defined(NEED_CPU_H) */
121
122/* bottom halves */
faf07963
PB
123typedef void QEMUBHFunc(void *opaque);
124
9a1e9481
KW
125void async_context_push(void);
126void async_context_pop(void);
127int get_async_context_id(void);
128
faf07963
PB
129QEMUBH *qemu_bh_new(QEMUBHFunc *cb, void *opaque);
130void qemu_bh_schedule(QEMUBH *bh);
80d3580b
AL
131/* Bottom halfs that are scheduled from a bottom half handler are instantly
132 * invoked. This can create an infinite loop if a bottom half handler
133 * schedules itself. qemu_bh_schedule_idle() avoids this infinite loop by
134 * ensuring that the bottom half isn't executed until the next main loop
135 * iteration.
136 */
1b435b10 137void qemu_bh_schedule_idle(QEMUBH *bh);
faf07963
PB
138void qemu_bh_cancel(QEMUBH *bh);
139void qemu_bh_delete(QEMUBH *bh);
140int qemu_bh_poll(void);
4f999d05 141void qemu_bh_update_timeout(int *timeout);
faf07963 142
f6503059
AZ
143void qemu_get_timedate(struct tm *tm, int offset);
144int qemu_timedate_diff(struct tm *tm);
145
faf07963
PB
146/* cutils.c */
147void pstrcpy(char *buf, int buf_size, const char *str);
148char *pstrcat(char *buf, int buf_size, const char *s);
149int strstart(const char *str, const char *val, const char **ptr);
150int stristart(const char *str, const char *val, const char **ptr);
d43277c5 151int qemu_strnlen(const char *s, int max_len);
faf07963 152time_t mktimegm(struct tm *tm);
ad46db9a 153int qemu_fls(int i);
6f1953c4 154int qemu_fdatasync(int fd);
db1a4972 155int fcntl_setfl(int fd, int flag);
d8427002 156
d7142456
JS
157/*
158 * strtosz() suffixes used to specify the default treatment of an
159 * argument passed to strtosz() without an explicit suffix.
160 * These should be defined using upper case characters in the range
161 * A-Z, as strtosz() will use qemu_toupper() on the given argument
162 * prior to comparison.
163 */
d8427002
JS
164#define STRTOSZ_DEFSUFFIX_TB 'T'
165#define STRTOSZ_DEFSUFFIX_GB 'G'
166#define STRTOSZ_DEFSUFFIX_MB 'M'
167#define STRTOSZ_DEFSUFFIX_KB 'K'
168#define STRTOSZ_DEFSUFFIX_B 'B'
70b4f4bb
JS
169int64_t strtosz(const char *nptr, char **end);
170int64_t strtosz_suffix(const char *nptr, char **end, const char default_suffix);
faf07963 171
37022086
BS
172/* path.c */
173void init_paths(const char *prefix);
174const char *path(const char *pathname);
175
cd390083
BS
176#define qemu_isalnum(c) isalnum((unsigned char)(c))
177#define qemu_isalpha(c) isalpha((unsigned char)(c))
178#define qemu_iscntrl(c) iscntrl((unsigned char)(c))
179#define qemu_isdigit(c) isdigit((unsigned char)(c))
180#define qemu_isgraph(c) isgraph((unsigned char)(c))
181#define qemu_islower(c) islower((unsigned char)(c))
182#define qemu_isprint(c) isprint((unsigned char)(c))
183#define qemu_ispunct(c) ispunct((unsigned char)(c))
184#define qemu_isspace(c) isspace((unsigned char)(c))
185#define qemu_isupper(c) isupper((unsigned char)(c))
186#define qemu_isxdigit(c) isxdigit((unsigned char)(c))
187#define qemu_tolower(c) tolower((unsigned char)(c))
188#define qemu_toupper(c) toupper((unsigned char)(c))
189#define qemu_isascii(c) isascii((unsigned char)(c))
190#define qemu_toascii(c) toascii((unsigned char)(c))
191
dc786bc9
JS
192#ifdef _WIN32
193/* ffs() in oslib-win32.c for WIN32, strings.h for the rest of the world */
194int ffs(int i);
195#endif
196
b152aa84 197void *qemu_oom_check(void *ptr);
ca10f867 198void *qemu_malloc(size_t size);
2137b4cc 199void *qemu_realloc(void *ptr, size_t size);
ca10f867
AJ
200void *qemu_mallocz(size_t size);
201void qemu_free(void *ptr);
202char *qemu_strdup(const char *str);
ac4b0d0c 203char *qemu_strndup(const char *str, size_t size);
ca10f867 204
d549db5a
GC
205void qemu_mutex_lock_iothread(void);
206void qemu_mutex_unlock_iothread(void);
207
40ff6d7e 208int qemu_open(const char *name, int flags, ...);
7c7c0629
JQ
209ssize_t qemu_write_full(int fd, const void *buf, size_t count)
210 QEMU_WARN_UNUSED_RESULT;
40ff6d7e
KW
211void qemu_set_cloexec(int fd);
212
213#ifndef _WIN32
f3dfda61 214int qemu_eventfd(int pipefd[2]);
40ff6d7e
KW
215int qemu_pipe(int pipefd[2]);
216#endif
217
87ecb68b
PB
218/* Error handling. */
219
e5924d89 220void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
87ecb68b
PB
221
222/* IO callbacks. */
223typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size);
7b27a769 224typedef int IOCanReadHandler(void *opaque);
87ecb68b
PB
225typedef void IOHandler(void *opaque);
226
227struct ParallelIOArg {
228 void *buffer;
229 int count;
230};
231
232typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
233
234/* A load of opaque types so that device init declarations don't have to
235 pull in all the real definitions. */
236typedef struct NICInfo NICInfo;
1ae26a18 237typedef struct HCIInfo HCIInfo;
87ecb68b
PB
238typedef struct AudioState AudioState;
239typedef struct BlockDriverState BlockDriverState;
2446333c 240typedef struct DriveInfo DriveInfo;
87ecb68b 241typedef struct DisplayState DisplayState;
7d957bd8
AL
242typedef struct DisplayChangeListener DisplayChangeListener;
243typedef struct DisplaySurface DisplaySurface;
7b5d76da 244typedef struct DisplayAllocator DisplayAllocator;
7d957bd8 245typedef struct PixelFormat PixelFormat;
87ecb68b 246typedef struct TextConsole TextConsole;
c60e08d9 247typedef TextConsole QEMUConsole;
87ecb68b 248typedef struct CharDriverState CharDriverState;
76d32cba 249typedef struct MACAddr MACAddr;
87ecb68b 250typedef struct VLANState VLANState;
f7105843 251typedef struct VLANClientState VLANClientState;
87ecb68b
PB
252typedef struct i2c_bus i2c_bus;
253typedef struct i2c_slave i2c_slave;
254typedef struct SMBusDevice SMBusDevice;
fb47a2e9
IY
255typedef struct PCIHostState PCIHostState;
256typedef struct PCIExpressHost PCIExpressHost;
87ecb68b
PB
257typedef struct PCIBus PCIBus;
258typedef struct PCIDevice PCIDevice;
0428527c 259typedef struct PCIExpressDevice PCIExpressDevice;
68f79994 260typedef struct PCIBridge PCIBridge;
34e65944
IY
261typedef struct PCIEAERMsg PCIEAERMsg;
262typedef struct PCIEAERLog PCIEAERLog;
263typedef struct PCIEAERErr PCIEAERErr;
bc20ba98
IY
264typedef struct PCIEPort PCIEPort;
265typedef struct PCIESlot PCIESlot;
87ecb68b
PB
266typedef struct SerialState SerialState;
267typedef struct IRQState *qemu_irq;
bc24a225
PB
268typedef struct PCMCIACardState PCMCIACardState;
269typedef struct MouseTransformInfo MouseTransformInfo;
270typedef struct uWireSlave uWireSlave;
271typedef struct I2SCodec I2SCodec;
90d37239 272typedef struct SSIBus SSIBus;
2292b339 273typedef struct EventNotifier EventNotifier;
2be24aaa 274typedef struct VirtIODevice VirtIODevice;
87ecb68b 275
186993ee
MT
276typedef uint64_t pcibus_t;
277
d2053c3c
BS
278void cpu_exec_init_all(unsigned long tb_size);
279
b3c7724c
PB
280/* CPU save/load. */
281void cpu_save(QEMUFile *f, void *opaque);
282int cpu_load(QEMUFile *f, void *opaque, int version_id);
283
9e472e10
AL
284/* Force QEMU to stop what it's doing and service IO */
285void qemu_service_io(void);
286
d9f75a4e
AL
287/* Force QEMU to process pending events */
288void qemu_notify_event(void);
289
8edac960
AL
290/* Unblock cpu */
291void qemu_cpu_kick(void *env);
46d62fac 292void qemu_cpu_kick_self(void);
b7680cb6 293int qemu_cpu_is_self(void *env);
8edac960 294
e82bcec2
MT
295/* work queue */
296struct qemu_work_item {
297 struct qemu_work_item *next;
298 void (*func)(void *data);
299 void *data;
300 int done;
301};
302
0bf46a40
AL
303#ifdef CONFIG_USER_ONLY
304#define qemu_init_vcpu(env) do { } while (0)
305#else
306void qemu_init_vcpu(void *env);
307#endif
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
376253ec
AL
330struct Monitor;
331typedef struct Monitor Monitor;
332
abd0c6bd
PB
333/* Convert a byte between binary and BCD. */
334static inline uint8_t to_bcd(uint8_t val)
335{
336 return ((val / 10) << 4) | (val % 10);
337}
338
339static inline uint8_t from_bcd(uint8_t val)
340{
341 return ((val >> 4) * 10) + (val & 0x0f);
342}
343
338b922e 344/* compute with 96 bit intermediate result: (a*b)/c */
345static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
346{
347 union {
348 uint64_t ll;
349 struct {
350#ifdef HOST_WORDS_BIGENDIAN
351 uint32_t high, low;
352#else
353 uint32_t low, high;
354#endif
355 } l;
356 } u, res;
357 uint64_t rl, rh;
358
359 u.ll = a;
360 rl = (uint64_t)u.l.low * (uint64_t)b;
361 rh = (uint64_t)u.l.high * (uint64_t)b;
362 rh += (rl >> 32);
363 res.l.high = rh / c;
364 res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
365 return res.ll;
366}
367
0bfe3ca5
AL
368#include "module.h"
369
faf07963 370#endif