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 "compiler.h"
   6 #include "config-host.h"
   7
   8 #define TFR(expr) do { if ((expr) != -1) break; } while (errno == EINTR)
   9
  10 typedef struct QEMUTimer QEMUTimer;
  11 typedef struct QEMUFile QEMUFile;
  12 typedef struct QEMUBH QEMUBH;
  13 typedef struct DeviceState DeviceState;
  14
  15 struct Monitor;
  16 typedef struct Monitor Monitor;
  17
  18 /* we put basic includes here to avoid repeating them in device drivers */
  19 #include <stdlib.h>
  20 #include <stdio.h>
  21 #include <stdarg.h>
  22 #include <stdbool.h>
  23 #include <string.h>
  24 #include <strings.h>
  25 #include <inttypes.h>
  26 #include <limits.h>
  27 #include <time.h>
  28 #include <ctype.h>
  29 #include <errno.h>
  30 #include <unistd.h>
  31 #include <fcntl.h>
  32 #include <sys/stat.h>
  33 #include <sys/time.h>
  34 #include <assert.h>
  35 #include <signal.h>
  36
  37 #ifdef _WIN32
  38 #include "qemu-os-win32.h"
  39 #endif
  40
  41 #ifdef CONFIG_POSIX
  42 #include "qemu-os-posix.h"
  43 #endif
  44
  45 #ifndef O_LARGEFILE
  46 #define O_LARGEFILE 0
  47 #endif
  48 #ifndef O_BINARY
  49 #define O_BINARY 0
  50 #endif
  51 #ifndef MAP_ANONYMOUS
  52 #define MAP_ANONYMOUS MAP_ANON
  53 #endif
  54 #ifndef ENOMEDIUM
  55 #define ENOMEDIUM ENODEV
  56 #endif
  57 #if !defined(ENOTSUP)
  58 #define ENOTSUP 4096
  59 #endif
  60 #ifndef TIME_MAX
  61 #define TIME_MAX LONG_MAX
  62 #endif
  63
  64 #ifndef CONFIG_IOVEC
  65 #define CONFIG_IOVEC
  66 struct iovec {
  67     void *iov_base;
  68     size_t iov_len;
  69 };
  70 /*
  71  * Use the same value as Linux for now.
  72  */
  73 #define IOV_MAX         1024
  74 #else
  75 #include <sys/uio.h>
  76 #endif
  77
  78 typedef int (*fprintf_function)(FILE *f, const char *fmt, ...)
  79     GCC_FMT_ATTR(2, 3);
  80
  81 #ifdef _WIN32
  82 #define fsync _commit
  83 #define lseek _lseeki64
  84 int qemu_ftruncate64(int, int64_t);
  85 #define ftruncate qemu_ftruncate64
  86
  87 static inline char *realpath(const char *path, char *resolved_path)
  88 {
  89     _fullpath(resolved_path, path, _MAX_PATH);
  90     return resolved_path;
  91 }
  92 #endif
  93
  94 /* FIXME: Remove NEED_CPU_H.  */
  95 #ifndef NEED_CPU_H
  96
  97 #include "osdep.h"
  98 #include "bswap.h"
  99
 100 #else
 101
 102 #include "cpu.h"
 103
 104 #endif /* !defined(NEED_CPU_H) */
 105
 106 /* main function, renamed */
 107 #if defined(CONFIG_COCOA)
 108 int qemu_main(int argc, char **argv, char **envp);
 109 #endif
 110
 111 /* bottom halves */
 112 typedef void QEMUBHFunc(void *opaque);
 113
 114 void async_context_push(void);
 115 void async_context_pop(void);
 116 int get_async_context_id(void);
 117
 118 QEMUBH *qemu_bh_new(QEMUBHFunc *cb, void *opaque);
 119 void qemu_bh_schedule(QEMUBH *bh);
 120 /* Bottom halfs that are scheduled from a bottom half handler are instantly
 121  * invoked.  This can create an infinite loop if a bottom half handler
 122  * schedules itself.  qemu_bh_schedule_idle() avoids this infinite loop by
 123  * ensuring that the bottom half isn't executed until the next main loop
 124  * iteration.
 125  */
 126 void qemu_bh_schedule_idle(QEMUBH *bh);
 127 void qemu_bh_cancel(QEMUBH *bh);
 128 void qemu_bh_delete(QEMUBH *bh);
 129 int qemu_bh_poll(void);
 130 void qemu_bh_update_timeout(int *timeout);
 131
 132 void qemu_get_timedate(struct tm *tm, int offset);
 133 int qemu_timedate_diff(struct tm *tm);
 134
 135 /* cutils.c */
 136 void pstrcpy(char *buf, int buf_size, const char *str);
 137 char *pstrcat(char *buf, int buf_size, const char *s);
 138 int strstart(const char *str, const char *val, const char **ptr);
 139 int stristart(const char *str, const char *val, const char **ptr);
 140 int qemu_strnlen(const char *s, int max_len);
 141 time_t mktimegm(struct tm *tm);
 142 int qemu_fls(int i);
 143 int qemu_fdatasync(int fd);
 144 int fcntl_setfl(int fd, int flag);
 145
 146 /*
 147  * strtosz() suffixes used to specify the default treatment of an
 148  * argument passed to strtosz() without an explicit suffix.
 149  * These should be defined using upper case characters in the range
 150  * A-Z, as strtosz() will use qemu_toupper() on the given argument
 151  * prior to comparison.
 152  */
 153 #define STRTOSZ_DEFSUFFIX_TB    'T'
 154 #define STRTOSZ_DEFSUFFIX_GB    'G'
 155 #define STRTOSZ_DEFSUFFIX_MB    'M'
 156 #define STRTOSZ_DEFSUFFIX_KB    'K'
 157 #define STRTOSZ_DEFSUFFIX_B     'B'
 158 int64_t strtosz(const char *nptr, char **end);
 159 int64_t strtosz_suffix(const char *nptr, char **end, const char default_suffix);
 160
 161 /* path.c */
 162 void init_paths(const char *prefix);
 163 const char *path(const char *pathname);
 164
 165 #define qemu_isalnum(c)         isalnum((unsigned char)(c))
 166 #define qemu_isalpha(c)         isalpha((unsigned char)(c))
 167 #define qemu_iscntrl(c)         iscntrl((unsigned char)(c))
 168 #define qemu_isdigit(c)         isdigit((unsigned char)(c))
 169 #define qemu_isgraph(c)         isgraph((unsigned char)(c))
 170 #define qemu_islower(c)         islower((unsigned char)(c))
 171 #define qemu_isprint(c)         isprint((unsigned char)(c))
 172 #define qemu_ispunct(c)         ispunct((unsigned char)(c))
 173 #define qemu_isspace(c)         isspace((unsigned char)(c))
 174 #define qemu_isupper(c)         isupper((unsigned char)(c))
 175 #define qemu_isxdigit(c)        isxdigit((unsigned char)(c))
 176 #define qemu_tolower(c)         tolower((unsigned char)(c))
 177 #define qemu_toupper(c)         toupper((unsigned char)(c))
 178 #define qemu_isascii(c)         isascii((unsigned char)(c))
 179 #define qemu_toascii(c)         toascii((unsigned char)(c))
 180
 181 void *qemu_oom_check(void *ptr);
 182 void *qemu_malloc(size_t size);
 183 void *qemu_realloc(void *ptr, size_t size);
 184 void *qemu_mallocz(size_t size);
 185 void qemu_free(void *ptr);
 186 char *qemu_strdup(const char *str);
 187 char *qemu_strndup(const char *str, size_t size);
 188
 189 void qemu_mutex_lock_iothread(void);
 190 void qemu_mutex_unlock_iothread(void);
 191
 192 int qemu_open(const char *name, int flags, ...);
 193 ssize_t qemu_write_full(int fd, const void *buf, size_t count)
 194     QEMU_WARN_UNUSED_RESULT;
 195 void qemu_set_cloexec(int fd);
 196
 197 #ifndef _WIN32
 198 int qemu_add_child_watch(pid_t pid);
 199 int qemu_eventfd(int pipefd[2]);
 200 int qemu_pipe(int pipefd[2]);
 201 #endif
 202
 203 /* Error handling.  */
 204
 205 void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
 206
 207 /* IO callbacks.  */
 208 typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size);
 209 typedef int IOCanReadHandler(void *opaque);
 210 typedef void IOHandler(void *opaque);
 211
 212 void qemu_iohandler_fill(int *pnfds, fd_set *readfds, fd_set *writefds, fd_set *xfds);
 213 void qemu_iohandler_poll(fd_set *readfds, fd_set *writefds, fd_set *xfds, int rc);
 214
 215 struct ParallelIOArg {
 216     void *buffer;
 217     int count;
 218 };
 219
 220 typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
 221
 222 /* A load of opaque types so that device init declarations don't have to
 223    pull in all the real definitions.  */
 224 typedef struct NICInfo NICInfo;
 225 typedef struct HCIInfo HCIInfo;
 226 typedef struct AudioState AudioState;
 227 typedef struct BlockDriverState BlockDriverState;
 228 typedef struct DriveInfo DriveInfo;
 229 typedef struct DisplayState DisplayState;
 230 typedef struct DisplayChangeListener DisplayChangeListener;
 231 typedef struct DisplaySurface DisplaySurface;
 232 typedef struct DisplayAllocator DisplayAllocator;
 233 typedef struct PixelFormat PixelFormat;
 234 typedef struct TextConsole TextConsole;
 235 typedef TextConsole QEMUConsole;
 236 typedef struct CharDriverState CharDriverState;
 237 typedef struct MACAddr MACAddr;
 238 typedef struct VLANState VLANState;
 239 typedef struct VLANClientState VLANClientState;
 240 typedef struct i2c_bus i2c_bus;
 241 typedef struct i2c_slave i2c_slave;
 242 typedef struct SMBusDevice SMBusDevice;
 243 typedef struct PCIHostState PCIHostState;
 244 typedef struct PCIExpressHost PCIExpressHost;
 245 typedef struct PCIBus PCIBus;
 246 typedef struct PCIDevice PCIDevice;
 247 typedef struct PCIExpressDevice PCIExpressDevice;
 248 typedef struct PCIBridge PCIBridge;
 249 typedef struct PCIEAERMsg PCIEAERMsg;
 250 typedef struct PCIEAERLog PCIEAERLog;
 251 typedef struct PCIEAERErr PCIEAERErr;
 252 typedef struct PCIEPort PCIEPort;
 253 typedef struct PCIESlot PCIESlot;
 254 typedef struct SerialState SerialState;
 255 typedef struct IRQState *qemu_irq;
 256 typedef struct PCMCIACardState PCMCIACardState;
 257 typedef struct MouseTransformInfo MouseTransformInfo;
 258 typedef struct uWireSlave uWireSlave;
 259 typedef struct I2SCodec I2SCodec;
 260 typedef struct SSIBus SSIBus;
 261 typedef struct EventNotifier EventNotifier;
 262 typedef struct VirtIODevice VirtIODevice;
 263
 264 typedef uint64_t pcibus_t;
 265
 266 void cpu_exec_init_all(unsigned long tb_size);
 267
 268 /* CPU save/load.  */
 269 void cpu_save(QEMUFile *f, void *opaque);
 270 int cpu_load(QEMUFile *f, void *opaque, int version_id);
 271
 272 /* Force QEMU to stop what it's doing and service IO */
 273 void qemu_service_io(void);
 274
 275 /* Force QEMU to process pending events */
 276 void qemu_notify_event(void);
 277
 278 /* Unblock cpu */
 279 void qemu_cpu_kick(void *env);
 280 void qemu_cpu_kick_self(void);
 281 int qemu_cpu_is_self(void *env);
 282 bool all_cpu_threads_idle(void);
 283
 284 /* work queue */
 285 struct qemu_work_item {
 286     struct qemu_work_item *next;
 287     void (*func)(void *data);
 288     void *data;
 289     int done;
 290 };
 291
 292 #ifdef CONFIG_USER_ONLY
 293 #define qemu_init_vcpu(env) do { } while (0)
 294 #else
 295 void qemu_init_vcpu(void *env);
 296 #endif
 297
 298 typedef struct QEMUIOVector {
 299     struct iovec *iov;
 300     int niov;
 301     int nalloc;
 302     size_t size;
 303 } QEMUIOVector;
 304
 305 void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
 306 void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
 307 void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
 308 void qemu_iovec_copy(QEMUIOVector *dst, QEMUIOVector *src, uint64_t skip,
 309     size_t size);
 310 void qemu_iovec_concat(QEMUIOVector *dst, QEMUIOVector *src, size_t size);
 311 void qemu_iovec_destroy(QEMUIOVector *qiov);
 312 void qemu_iovec_reset(QEMUIOVector *qiov);
 313 void qemu_iovec_to_buffer(QEMUIOVector *qiov, void *buf);
 314 void qemu_iovec_from_buffer(QEMUIOVector *qiov, const void *buf, size_t count);
 315 void qemu_iovec_memset(QEMUIOVector *qiov, int c, size_t count);
 316 void qemu_iovec_memset_skip(QEMUIOVector *qiov, int c, size_t count,
 317                             size_t skip);
 318
 319 void qemu_progress_init(int enabled, float min_skip);
 320 void qemu_progress_end(void);
 321 void qemu_progress_print(float delta, int max);
 322
 323 #define QEMU_FILE_TYPE_BIOS   0
 324 #define QEMU_FILE_TYPE_KEYMAP 1
 325 char *qemu_find_file(int type, const char *name);
 326
 327 /* OS specific functions */
 328 void os_setup_early_signal_handling(void);
 329 char *os_find_datadir(const char *argv0);
 330 void os_parse_cmd_args(int index, const char *optarg);
 331 void os_pidfile_error(void);
 332
 333 /* Convert a byte between binary and BCD.  */
 334 static inline uint8_t to_bcd(uint8_t val)
 335 {
 336     return ((val / 10) << 4) | (val % 10);
 337 }
 338
 339 static inline uint8_t from_bcd(uint8_t val)
 340 {
 341     return ((val >> 4) * 10) + (val & 0x0f);
 342 }
 343
 344 /* compute with 96 bit intermediate result: (a*b)/c */
 345 static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
 346 {
 347     union {
 348         uint64_t ll;
 349         struct {
 350 #ifdef HOST_WORDS_BIGENDIAN
 351             uint32_t high, low;
 352 #else
 353             uint32_t low, high;
 354 #endif
 355         } l;
 356     } u, res;
 357     uint64_t rl, rh;
 358
 359     u.ll = a;
 360     rl = (uint64_t)u.l.low * (uint64_t)b;
 361     rh = (uint64_t)u.l.high * (uint64_t)b;
 362     rh += (rl >> 32);
 363     res.l.high = rh / c;
 364     res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
 365     return res.ll;
 366 }
 367
 368 #include "module.h"
 369
 370 #endif