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