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 /* we put basic includes here to avoid repeating them in device drivers */
   6 #include <stdlib.h>
   7 #include <stdio.h>
   8 #include <stdarg.h>
   9 #include <string.h>
  10 #include <strings.h>
  11 #include <inttypes.h>
  12 #include <limits.h>
  13 #include <time.h>
  14 #include <ctype.h>
  15 #include <errno.h>
  16 #include <unistd.h>
  17 #include <fcntl.h>
  18 #include <sys/stat.h>
  19 #include "config-host.h"
  20
  21 #ifndef O_LARGEFILE
  22 #define O_LARGEFILE 0
  23 #endif
  24 #ifndef O_BINARY
  25 #define O_BINARY 0
  26 #endif
  27
  28 #ifndef ENOMEDIUM
  29 #define ENOMEDIUM ENODEV
  30 #endif
  31
  32 #ifndef HAVE_IOVEC
  33 #define HAVE_IOVEC
  34 struct iovec {
  35     void *iov_base;
  36     size_t iov_len;
  37 };
  38 #else
  39 #include <sys/uio.h>
  40 #endif
  41
  42 #ifdef _WIN32
  43 #define WIN32_LEAN_AND_MEAN
  44 #define WINVER 0x0501  /* needed for ipv6 bits */
  45 #include <windows.h>
  46 #define fsync _commit
  47 #define lseek _lseeki64
  48 #define ENOTSUP 4096
  49 extern int qemu_ftruncate64(int, int64_t);
  50 #define ftruncate qemu_ftruncate64
  51
  52
  53 static inline char *realpath(const char *path, char *resolved_path)
  54 {
  55     _fullpath(resolved_path, path, _MAX_PATH);
  56     return resolved_path;
  57 }
  58
  59 #define PRId64 "I64d"
  60 #define PRIx64 "I64x"
  61 #define PRIu64 "I64u"
  62 #define PRIo64 "I64o"
  63 #endif
  64
  65 /* FIXME: Remove NEED_CPU_H.  */
  66 #ifndef NEED_CPU_H
  67
  68 #include <setjmp.h>
  69 #include "osdep.h"
  70 #include "bswap.h"
  71
  72 #else
  73
  74 #include "cpu.h"
  75
  76 #endif /* !defined(NEED_CPU_H) */
  77
  78 /* bottom halves */
  79 typedef struct QEMUBH QEMUBH;
  80
  81 typedef void QEMUBHFunc(void *opaque);
  82
  83 QEMUBH *qemu_bh_new(QEMUBHFunc *cb, void *opaque);
  84 void qemu_bh_schedule(QEMUBH *bh);
  85 /* Bottom halfs that are scheduled from a bottom half handler are instantly
  86  * invoked.  This can create an infinite loop if a bottom half handler
  87  * schedules itself.  qemu_bh_schedule_idle() avoids this infinite loop by
  88  * ensuring that the bottom half isn't executed until the next main loop
  89  * iteration.
  90  */
  91 void qemu_bh_schedule_idle(QEMUBH *bh);
  92 void qemu_bh_cancel(QEMUBH *bh);
  93 void qemu_bh_delete(QEMUBH *bh);
  94 int qemu_bh_poll(void);
  95
  96 uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c);
  97
  98 void qemu_get_timedate(struct tm *tm, int offset);
  99 int qemu_timedate_diff(struct tm *tm);
 100
 101 /* cutils.c */
 102 void pstrcpy(char *buf, int buf_size, const char *str);
 103 char *pstrcat(char *buf, int buf_size, const char *s);
 104 int strstart(const char *str, const char *val, const char **ptr);
 105 int stristart(const char *str, const char *val, const char **ptr);
 106 time_t mktimegm(struct tm *tm);
 107 int qemu_fls(int i);
 108 int hex2bin(char ch);
 109 char *urldecode(const char *ptr);
 110
 111 #define qemu_isalnum(c)         isalnum((unsigned char)(c))
 112 #define qemu_isalpha(c)         isalpha((unsigned char)(c))
 113 #define qemu_iscntrl(c)         iscntrl((unsigned char)(c))
 114 #define qemu_isdigit(c)         isdigit((unsigned char)(c))
 115 #define qemu_isgraph(c)         isgraph((unsigned char)(c))
 116 #define qemu_islower(c)         islower((unsigned char)(c))
 117 #define qemu_isprint(c)         isprint((unsigned char)(c))
 118 #define qemu_ispunct(c)         ispunct((unsigned char)(c))
 119 #define qemu_isspace(c)         isspace((unsigned char)(c))
 120 #define qemu_isupper(c)         isupper((unsigned char)(c))
 121 #define qemu_isxdigit(c)        isxdigit((unsigned char)(c))
 122 #define qemu_tolower(c)         tolower((unsigned char)(c))
 123 #define qemu_toupper(c)         toupper((unsigned char)(c))
 124 #define qemu_isascii(c)         isascii((unsigned char)(c))
 125 #define qemu_toascii(c)         toascii((unsigned char)(c))
 126
 127 void *qemu_malloc(size_t size);
 128 void *qemu_realloc(void *ptr, size_t size);
 129 void *qemu_mallocz(size_t size);
 130 void qemu_free(void *ptr);
 131 char *qemu_strdup(const char *str);
 132 char *qemu_strndup(const char *str, size_t size);
 133
 134 void *get_mmap_addr(unsigned long size);
 135
 136
 137 /* Error handling.  */
 138
 139 void hw_error(const char *fmt, ...)
 140     __attribute__ ((__format__ (__printf__, 1, 2)))
 141     __attribute__ ((__noreturn__));
 142
 143 /* IO callbacks.  */
 144 typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size);
 145 typedef int IOCanRWHandler(void *opaque);
 146 typedef void IOHandler(void *opaque);
 147
 148 struct ParallelIOArg {
 149     void *buffer;
 150     int count;
 151 };
 152
 153 typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
 154
 155 /* A load of opaque types so that device init declarations don't have to
 156    pull in all the real definitions.  */
 157 typedef struct NICInfo NICInfo;
 158 typedef struct HCIInfo HCIInfo;
 159 typedef struct AudioState AudioState;
 160 typedef struct BlockDriverState BlockDriverState;
 161 typedef struct DisplayState DisplayState;
 162 typedef struct TextConsole TextConsole;
 163 typedef TextConsole QEMUConsole;
 164 typedef struct CharDriverState CharDriverState;
 165 typedef struct VLANState VLANState;
 166 typedef struct QEMUFile QEMUFile;
 167 typedef struct i2c_bus i2c_bus;
 168 typedef struct i2c_slave i2c_slave;
 169 typedef struct SMBusDevice SMBusDevice;
 170 typedef struct QEMUTimer QEMUTimer;
 171 typedef struct PCIBus PCIBus;
 172 typedef struct PCIDevice PCIDevice;
 173 typedef struct SerialState SerialState;
 174 typedef struct IRQState *qemu_irq;
 175 struct pcmcia_card_s;
 176
 177 /* CPU save/load.  */
 178 void cpu_save(QEMUFile *f, void *opaque);
 179 int cpu_load(QEMUFile *f, void *opaque, int version_id);
 180
 181 /* work queue */
 182 struct qemu_work_item {
 183     struct qemu_work_item *next;
 184     void (*func)(void *data);
 185     void *data;
 186     int done;
 187 };
 188
 189 #endif