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