qemu-common.h

   1 /* Common header file that is included by all of qemu.  */
   2 #ifndef QEMU_COMMON_H
   3 #define QEMU_COMMON_H
   4
   5 #include "config-host.h"
   6
   7 #define QEMU_NORETURN __attribute__ ((__noreturn__))
   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
  13
  14 #define QEMU_BUILD_BUG_ON(x) typedef char __build_bug_on__##__LINE__[(x)?-1:1];
  15
  16 typedef struct QEMUTimer QEMUTimer;
  17 typedef struct QEMUFile QEMUFile;
  18 typedef struct QEMUBH QEMUBH;
  19
  20 /* Hack around the mess dyngen-exec.h causes: We need QEMU_NORETURN in files that
  21    cannot include the following headers without conflicts. This condition has
  22    to be removed once dyngen is gone. */
  23 #ifndef __DYNGEN_EXEC_H__
  24
  25 /* we put basic includes here to avoid repeating them in device drivers */
  26 #include <stdlib.h>
  27 #include <stdio.h>
  28 #include <stdarg.h>
  29 #include <string.h>
  30 #include <strings.h>
  31 #include <inttypes.h>
  32 #include <limits.h>
  33 #include <time.h>
  34 #include <ctype.h>
  35 #include <errno.h>
  36 #include <unistd.h>
  37 #include <fcntl.h>
  38 #include <sys/stat.h>
  39 #include <assert.h>
  40
  41 #ifndef O_LARGEFILE
  42 #define O_LARGEFILE 0
  43 #endif
  44 #ifndef O_BINARY
  45 #define O_BINARY 0
  46 #endif
  47 #ifndef MAP_ANONYMOUS
  48 #define MAP_ANONYMOUS MAP_ANON
  49 #endif
  50 #ifndef ENOMEDIUM
  51 #define ENOMEDIUM ENODEV
  52 #endif
  53 #if !defined(ENOTSUP)
  54 #define ENOTSUP 4096
  55 #endif
  56
  57 #ifndef CONFIG_IOVEC
  58 #define CONFIG_IOVEC
  59 struct iovec {
  60     void *iov_base;
  61     size_t iov_len;
  62 };
  63 /*
  64  * Use the same value as Linux for now.
  65  */
  66 #define IOV_MAX         1024
  67 #else
  68 #include <sys/uio.h>
  69 #endif
  70
  71 #ifdef _WIN32
  72 #define fsync _commit
  73 #define lseek _lseeki64
  74 extern int qemu_ftruncate64(int, int64_t);
  75 #define ftruncate qemu_ftruncate64
  76
  77 static inline char *realpath(const char *path, char *resolved_path)
  78 {
  79     _fullpath(resolved_path, path, _MAX_PATH);
  80     return resolved_path;
  81 }
  82
  83 #define PRId64 "I64d"
  84 #define PRIx64 "I64x"
  85 #define PRIu64 "I64u"
  86 #define PRIo64 "I64o"
  87 #endif
  88
  89 /* FIXME: Remove NEED_CPU_H.  */
  90 #ifndef NEED_CPU_H
  91
  92 #include <setjmp.h>
  93 #include "osdep.h"
  94 #include "bswap.h"
  95
  96 #else
  97
  98 #include "cpu.h"
  99
 100 #endif /* !defined(NEED_CPU_H) */
 101
 102 /* bottom halves */
 103 typedef void QEMUBHFunc(void *opaque);
 104
 105 void async_context_push(void);
 106 void async_context_pop(void);
 107 int get_async_context_id(void);
 108
 109 QEMUBH *qemu_bh_new(QEMUBHFunc *cb, void *opaque);
 110 void qemu_bh_schedule(QEMUBH *bh);
 111 /* Bottom halfs that are scheduled from a bottom half handler are instantly
 112  * invoked.  This can create an infinite loop if a bottom half handler
 113  * schedules itself.  qemu_bh_schedule_idle() avoids this infinite loop by
 114  * ensuring that the bottom half isn't executed until the next main loop
 115  * iteration.
 116  */
 117 void qemu_bh_schedule_idle(QEMUBH *bh);
 118 void qemu_bh_cancel(QEMUBH *bh);
 119 void qemu_bh_delete(QEMUBH *bh);
 120 int qemu_bh_poll(void);
 121 void qemu_bh_update_timeout(int *timeout);
 122
 123 uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c);
 124
 125 void qemu_get_timedate(struct tm *tm, int offset);
 126 int qemu_timedate_diff(struct tm *tm);
 127
 128 /* cutils.c */
 129 void pstrcpy(char *buf, int buf_size, const char *str);
 130 char *pstrcat(char *buf, int buf_size, const char *s);
 131 int strstart(const char *str, const char *val, const char **ptr);
 132 int stristart(const char *str, const char *val, const char **ptr);
 133 int qemu_strnlen(const char *s, int max_len);
 134 time_t mktimegm(struct tm *tm);
 135 int qemu_fls(int i);
 136 int qemu_fdatasync(int fd);
 137 int fcntl_setfl(int fd, int flag);
 138
 139 /* path.c */
 140 void init_paths(const char *prefix);
 141 const char *path(const char *pathname);
 142
 143 #define qemu_isalnum(c)         isalnum((unsigned char)(c))
 144 #define qemu_isalpha(c)         isalpha((unsigned char)(c))
 145 #define qemu_iscntrl(c)         iscntrl((unsigned char)(c))
 146 #define qemu_isdigit(c)         isdigit((unsigned char)(c))
 147 #define qemu_isgraph(c)         isgraph((unsigned char)(c))
 148 #define qemu_islower(c)         islower((unsigned char)(c))
 149 #define qemu_isprint(c)         isprint((unsigned char)(c))
 150 #define qemu_ispunct(c)         ispunct((unsigned char)(c))
 151 #define qemu_isspace(c)         isspace((unsigned char)(c))
 152 #define qemu_isupper(c)         isupper((unsigned char)(c))
 153 #define qemu_isxdigit(c)        isxdigit((unsigned char)(c))
 154 #define qemu_tolower(c)         tolower((unsigned char)(c))
 155 #define qemu_toupper(c)         toupper((unsigned char)(c))
 156 #define qemu_isascii(c)         isascii((unsigned char)(c))
 157 #define qemu_toascii(c)         toascii((unsigned char)(c))
 158
 159 void *qemu_malloc(size_t size);
 160 void *qemu_realloc(void *ptr, size_t size);
 161 void *qemu_mallocz(size_t size);
 162 void qemu_free(void *ptr);
 163 char *qemu_strdup(const char *str);
 164 char *qemu_strndup(const char *str, size_t size);
 165
 166 void *get_mmap_addr(unsigned long size);
 167
 168
 169 void qemu_mutex_lock_iothread(void);
 170 void qemu_mutex_unlock_iothread(void);
 171
 172 int qemu_open(const char *name, int flags, ...);
 173 ssize_t qemu_write_full(int fd, const void *buf, size_t count)
 174     QEMU_WARN_UNUSED_RESULT;
 175 void qemu_set_cloexec(int fd);
 176
 177 #ifndef _WIN32
 178 int qemu_eventfd(int pipefd[2]);
 179 int qemu_pipe(int pipefd[2]);
 180 #endif
 181
 182 /* Error handling.  */
 183
 184 void QEMU_NORETURN hw_error(const char *fmt, ...)
 185     __attribute__ ((__format__ (__printf__, 1, 2)));
 186
 187 /* IO callbacks.  */
 188 typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size);
 189 typedef int IOCanReadHandler(void *opaque);
 190 typedef void IOHandler(void *opaque);
 191
 192 struct ParallelIOArg {
 193     void *buffer;
 194     int count;
 195 };
 196
 197 typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
 198
 199 /* A load of opaque types so that device init declarations don't have to
 200    pull in all the real definitions.  */
 201 typedef struct NICInfo NICInfo;
 202 typedef struct HCIInfo HCIInfo;
 203 typedef struct AudioState AudioState;
 204 typedef struct BlockDriverState BlockDriverState;
 205 typedef struct DisplayState DisplayState;
 206 typedef struct DisplayChangeListener DisplayChangeListener;
 207 typedef struct DisplaySurface DisplaySurface;
 208 typedef struct DisplayAllocator DisplayAllocator;
 209 typedef struct PixelFormat PixelFormat;
 210 typedef struct TextConsole TextConsole;
 211 typedef TextConsole QEMUConsole;
 212 typedef struct CharDriverState CharDriverState;
 213 typedef struct MACAddr MACAddr;
 214 typedef struct VLANState VLANState;
 215 typedef struct VLANClientState VLANClientState;
 216 typedef struct i2c_bus i2c_bus;
 217 typedef struct i2c_slave i2c_slave;
 218 typedef struct SMBusDevice SMBusDevice;
 219 typedef struct PCIHostState PCIHostState;
 220 typedef struct PCIExpressHost PCIExpressHost;
 221 typedef struct PCIBus PCIBus;
 222 typedef struct PCIDevice PCIDevice;
 223 typedef struct SerialState SerialState;
 224 typedef struct IRQState *qemu_irq;
 225 typedef struct PCMCIACardState PCMCIACardState;
 226 typedef struct MouseTransformInfo MouseTransformInfo;
 227 typedef struct uWireSlave uWireSlave;
 228 typedef struct I2SCodec I2SCodec;
 229 typedef struct DeviceState DeviceState;
 230 typedef struct SSIBus SSIBus;
 231 typedef struct EventNotifier EventNotifier;
 232 typedef struct VirtIODevice VirtIODevice;
 233
 234 typedef uint64_t pcibus_t;
 235
 236 void cpu_exec_init_all(unsigned long tb_size);
 237
 238 /* CPU save/load.  */
 239 void cpu_save(QEMUFile *f, void *opaque);
 240 int cpu_load(QEMUFile *f, void *opaque, int version_id);
 241
 242 /* Force QEMU to stop what it's doing and service IO */
 243 void qemu_service_io(void);
 244
 245 /* Force QEMU to process pending events */
 246 void qemu_notify_event(void);
 247
 248 /* Unblock cpu */
 249 void qemu_cpu_kick(void *env);
 250 int qemu_cpu_self(void *env);
 251
 252 /* work queue */
 253 struct qemu_work_item {
 254     struct qemu_work_item *next;
 255     void (*func)(void *data);
 256     void *data;
 257     int done;
 258 };
 259
 260 #ifdef CONFIG_USER_ONLY
 261 #define qemu_init_vcpu(env) do { } while (0)
 262 #else
 263 void qemu_init_vcpu(void *env);
 264 #endif
 265
 266 typedef struct QEMUIOVector {
 267     struct iovec *iov;
 268     int niov;
 269     int nalloc;
 270     size_t size;
 271 } QEMUIOVector;
 272
 273 void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
 274 void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
 275 void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
 276 void qemu_iovec_concat(QEMUIOVector *dst, QEMUIOVector *src, size_t size);
 277 void qemu_iovec_destroy(QEMUIOVector *qiov);
 278 void qemu_iovec_reset(QEMUIOVector *qiov);
 279 void qemu_iovec_to_buffer(QEMUIOVector *qiov, void *buf);
 280 void qemu_iovec_from_buffer(QEMUIOVector *qiov, const void *buf, size_t count);
 281
 282 struct Monitor;
 283 typedef struct Monitor Monitor;
 284
 285 /* Convert a byte between binary and BCD.  */
 286 static inline uint8_t to_bcd(uint8_t val)
 287 {
 288     return ((val / 10) << 4) | (val % 10);
 289 }
 290
 291 static inline uint8_t from_bcd(uint8_t val)
 292 {
 293     return ((val >> 4) * 10) + (val & 0x0f);
 294 }
 295
 296 #include "module.h"
 297
 298 #endif /* dyngen-exec.h hack */
 299
 300 #endif