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