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 #if defined(__arm__) || defined(__sparc__) || defined(__mips__) || defined(__hppa__) || defined(__ia64__)
   9 #define WORDS_ALIGNED
  10 #endif
  11
  12 #define TFR(expr) do { if ((expr) != -1) break; } while (errno == EINTR)
  13
  14 typedef struct QEMUTimer QEMUTimer;
  15 typedef struct QEMUFile QEMUFile;
  16 typedef struct DeviceState DeviceState;
  17
  18 struct Monitor;
  19 typedef struct Monitor Monitor;
  20
  21 /* we put basic includes here to avoid repeating them in device drivers */
  22 #include <stdlib.h>
  23 #include <stdio.h>
  24 #include <stdarg.h>
  25 #include <stdbool.h>
  26 #include <string.h>
  27 #include <strings.h>
  28 #include <inttypes.h>
  29 #include <limits.h>
  30 #include <time.h>
  31 #include <ctype.h>
  32 #include <errno.h>
  33 #include <unistd.h>
  34 #include <fcntl.h>
  35 #include <sys/stat.h>
  36 #include <sys/time.h>
  37 #include <assert.h>
  38 #include <signal.h>
  39 #include <glib.h>
  40
  41 #ifdef _WIN32
  42 #include "qemu-os-win32.h"
  43 #endif
  44
  45 #ifdef CONFIG_POSIX
  46 #include "qemu-os-posix.h"
  47 #endif
  48
  49 #ifndef O_LARGEFILE
  50 #define O_LARGEFILE 0
  51 #endif
  52 #ifndef O_BINARY
  53 #define O_BINARY 0
  54 #endif
  55 #ifndef MAP_ANONYMOUS
  56 #define MAP_ANONYMOUS MAP_ANON
  57 #endif
  58 #ifndef ENOMEDIUM
  59 #define ENOMEDIUM ENODEV
  60 #endif
  61 #if !defined(ENOTSUP)
  62 #define ENOTSUP 4096
  63 #endif
  64 #if !defined(ECANCELED)
  65 #define ECANCELED 4097
  66 #endif
  67 #ifndef TIME_MAX
  68 #define TIME_MAX LONG_MAX
  69 #endif
  70
  71 /* HOST_LONG_BITS is the size of a native pointer in bits. */
  72 #if UINTPTR_MAX == UINT32_MAX
  73 # define HOST_LONG_BITS 32
  74 #elif UINTPTR_MAX == UINT64_MAX
  75 # define HOST_LONG_BITS 64
  76 #else
  77 # error Unknown pointer size
  78 #endif
  79
  80 #ifndef CONFIG_IOVEC
  81 #define CONFIG_IOVEC
  82 struct iovec {
  83     void *iov_base;
  84     size_t iov_len;
  85 };
  86 /*
  87  * Use the same value as Linux for now.
  88  */
  89 #define IOV_MAX         1024
  90 #else
  91 #include <sys/uio.h>
  92 #endif
  93
  94 typedef int (*fprintf_function)(FILE *f, const char *fmt, ...)
  95     GCC_FMT_ATTR(2, 3);
  96
  97 #ifdef _WIN32
  98 #define fsync _commit
  99 #if !defined(lseek)
 100 # define lseek _lseeki64
 101 #endif
 102 int qemu_ftruncate64(int, int64_t);
 103 #if !defined(ftruncate)
 104 # define ftruncate qemu_ftruncate64
 105 #endif
 106
 107 static inline char *realpath(const char *path, char *resolved_path)
 108 {
 109     _fullpath(resolved_path, path, _MAX_PATH);
 110     return resolved_path;
 111 }
 112 #endif
 113
 114 /* icount */
 115 void configure_icount(const char *option);
 116 extern int use_icount;
 117
 118 /* FIXME: Remove NEED_CPU_H.  */
 119 #ifndef NEED_CPU_H
 120
 121 #include "osdep.h"
 122 #include "bswap.h"
 123
 124 #else
 125
 126 #include "cpu.h"
 127
 128 #endif /* !defined(NEED_CPU_H) */
 129
 130 /* main function, renamed */
 131 #if defined(CONFIG_COCOA)
 132 int qemu_main(int argc, char **argv, char **envp);
 133 #endif
 134
 135 void qemu_get_timedate(struct tm *tm, int offset);
 136 int qemu_timedate_diff(struct tm *tm);
 137
 138 /* cutils.c */
 139 void pstrcpy(char *buf, int buf_size, const char *str);
 140 char *pstrcat(char *buf, int buf_size, const char *s);
 141 int strstart(const char *str, const char *val, const char **ptr);
 142 int stristart(const char *str, const char *val, const char **ptr);
 143 int qemu_strnlen(const char *s, int max_len);
 144 time_t mktimegm(struct tm *tm);
 145 int qemu_fls(int i);
 146 int qemu_fdatasync(int fd);
 147 int fcntl_setfl(int fd, int flag);
 148 int qemu_parse_fd(const char *param);
 149
 150 /*
 151  * strtosz() suffixes used to specify the default treatment of an
 152  * argument passed to strtosz() without an explicit suffix.
 153  * These should be defined using upper case characters in the range
 154  * A-Z, as strtosz() will use qemu_toupper() on the given argument
 155  * prior to comparison.
 156  */
 157 #define STRTOSZ_DEFSUFFIX_TB    'T'
 158 #define STRTOSZ_DEFSUFFIX_GB    'G'
 159 #define STRTOSZ_DEFSUFFIX_MB    'M'
 160 #define STRTOSZ_DEFSUFFIX_KB    'K'
 161 #define STRTOSZ_DEFSUFFIX_B     'B'
 162 int64_t strtosz(const char *nptr, char **end);
 163 int64_t strtosz_suffix(const char *nptr, char **end, const char default_suffix);
 164 int64_t strtosz_suffix_unit(const char *nptr, char **end,
 165                             const char default_suffix, int64_t unit);
 166
 167 /* path.c */
 168 void init_paths(const char *prefix);
 169 const char *path(const char *pathname);
 170
 171 #define qemu_isalnum(c)         isalnum((unsigned char)(c))
 172 #define qemu_isalpha(c)         isalpha((unsigned char)(c))
 173 #define qemu_iscntrl(c)         iscntrl((unsigned char)(c))
 174 #define qemu_isdigit(c)         isdigit((unsigned char)(c))
 175 #define qemu_isgraph(c)         isgraph((unsigned char)(c))
 176 #define qemu_islower(c)         islower((unsigned char)(c))
 177 #define qemu_isprint(c)         isprint((unsigned char)(c))
 178 #define qemu_ispunct(c)         ispunct((unsigned char)(c))
 179 #define qemu_isspace(c)         isspace((unsigned char)(c))
 180 #define qemu_isupper(c)         isupper((unsigned char)(c))
 181 #define qemu_isxdigit(c)        isxdigit((unsigned char)(c))
 182 #define qemu_tolower(c)         tolower((unsigned char)(c))
 183 #define qemu_toupper(c)         toupper((unsigned char)(c))
 184 #define qemu_isascii(c)         isascii((unsigned char)(c))
 185 #define qemu_toascii(c)         toascii((unsigned char)(c))
 186
 187 void *qemu_oom_check(void *ptr);
 188
 189 int qemu_open(const char *name, int flags, ...);
 190 ssize_t qemu_write_full(int fd, const void *buf, size_t count)
 191     QEMU_WARN_UNUSED_RESULT;
 192 ssize_t qemu_send_full(int fd, const void *buf, size_t count, int flags)
 193     QEMU_WARN_UNUSED_RESULT;
 194 ssize_t qemu_recv_full(int fd, void *buf, size_t count, int flags)
 195     QEMU_WARN_UNUSED_RESULT;
 196
 197 #ifndef _WIN32
 198 int qemu_eventfd(int pipefd[2]);
 199 int qemu_pipe(int pipefd[2]);
 200 #endif
 201
 202 #ifdef _WIN32
 203 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags)
 204 #else
 205 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags)
 206 #endif
 207
 208 int qemu_recvv(int sockfd, struct iovec *iov, int len, int iov_offset);
 209 int qemu_sendv(int sockfd, struct iovec *iov, int len, int iov_offset);
 210
 211 /* Error handling.  */
 212
 213 void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
 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 ISABus ISABus;
 242 typedef struct ISADevice ISADevice;
 243 typedef struct SMBusDevice SMBusDevice;
 244 typedef struct PCIHostState PCIHostState;
 245 typedef struct PCIExpressHost PCIExpressHost;
 246 typedef struct PCIBus PCIBus;
 247 typedef struct PCIDevice PCIDevice;
 248 typedef struct PCIExpressDevice PCIExpressDevice;
 249 typedef struct PCIBridge PCIBridge;
 250 typedef struct PCIEAERMsg PCIEAERMsg;
 251 typedef struct PCIEAERLog PCIEAERLog;
 252 typedef struct PCIEAERErr PCIEAERErr;
 253 typedef struct PCIEPort PCIEPort;
 254 typedef struct PCIESlot PCIESlot;
 255 typedef struct MSIMessage MSIMessage;
 256 typedef struct SerialState SerialState;
 257 typedef struct IRQState *qemu_irq;
 258 typedef struct PCMCIACardState PCMCIACardState;
 259 typedef struct MouseTransformInfo MouseTransformInfo;
 260 typedef struct uWireSlave uWireSlave;
 261 typedef struct I2SCodec I2SCodec;
 262 typedef struct SSIBus SSIBus;
 263 typedef struct EventNotifier EventNotifier;
 264 typedef struct VirtIODevice VirtIODevice;
 265 typedef struct QEMUSGList QEMUSGList;
 266 typedef struct SHPCDevice SHPCDevice;
 267
 268 typedef uint64_t pcibus_t;
 269
 270 typedef enum LostTickPolicy {
 271     LOST_TICK_DISCARD,
 272     LOST_TICK_DELAY,
 273     LOST_TICK_MERGE,
 274     LOST_TICK_SLEW,
 275     LOST_TICK_MAX
 276 } LostTickPolicy;
 277
 278 void tcg_exec_init(unsigned long tb_size);
 279 bool tcg_enabled(void);
 280
 281 void cpu_exec_init_all(void);
 282
 283 /* CPU save/load.  */
 284 void cpu_save(QEMUFile *f, void *opaque);
 285 int cpu_load(QEMUFile *f, void *opaque, int version_id);
 286
 287 /* Unblock cpu */
 288 void qemu_cpu_kick(void *env);
 289 void qemu_cpu_kick_self(void);
 290 int qemu_cpu_is_self(void *env);
 291 bool all_cpu_threads_idle(void);
 292
 293 /* work queue */
 294 struct qemu_work_item {
 295     struct qemu_work_item *next;
 296     void (*func)(void *data);
 297     void *data;
 298     int done;
 299 };
 300
 301 #ifdef CONFIG_USER_ONLY
 302 #define qemu_init_vcpu(env) do { } while (0)
 303 #else
 304 void qemu_init_vcpu(void *env);
 305 #endif
 306
 307 /**
 308  * Sends an iovec (or optionally a part of it) down a socket, yielding
 309  * when the socket is full.
 310  */
 311 int qemu_co_sendv(int sockfd, struct iovec *iov,
 312                   int len, int iov_offset);
 313
 314 /**
 315  * Receives data into an iovec (or optionally into a part of it) from
 316  * a socket, yielding when there is no data in the socket.
 317  */
 318 int qemu_co_recvv(int sockfd, struct iovec *iov,
 319                   int len, int iov_offset);
 320
 321
 322 /**
 323  * Sends a buffer down a socket, yielding when the socket is full.
 324  */
 325 int qemu_co_send(int sockfd, void *buf, int len);
 326
 327 /**
 328  * Receives data into a buffer from a socket, yielding when there
 329  * is no data in the socket.
 330  */
 331 int qemu_co_recv(int sockfd, void *buf, int len);
 332
 333
 334 typedef struct QEMUIOVector {
 335     struct iovec *iov;
 336     int niov;
 337     int nalloc;
 338     size_t size;
 339 } QEMUIOVector;
 340
 341 void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
 342 void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
 343 void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
 344 void qemu_iovec_copy(QEMUIOVector *dst, QEMUIOVector *src, uint64_t skip,
 345     size_t size);
 346 void qemu_iovec_concat(QEMUIOVector *dst, QEMUIOVector *src, size_t size);
 347 void qemu_iovec_destroy(QEMUIOVector *qiov);
 348 void qemu_iovec_reset(QEMUIOVector *qiov);
 349 void qemu_iovec_to_buffer(QEMUIOVector *qiov, void *buf);
 350 void qemu_iovec_from_buffer(QEMUIOVector *qiov, const void *buf, size_t count);
 351 void qemu_iovec_memset(QEMUIOVector *qiov, int c, size_t count);
 352 void qemu_iovec_memset_skip(QEMUIOVector *qiov, int c, size_t count,
 353                             size_t skip);
 354
 355 bool buffer_is_zero(const void *buf, size_t len);
 356
 357 void qemu_progress_init(int enabled, float min_skip);
 358 void qemu_progress_end(void);
 359 void qemu_progress_print(float delta, int max);
 360
 361 #define QEMU_FILE_TYPE_BIOS   0
 362 #define QEMU_FILE_TYPE_KEYMAP 1
 363 char *qemu_find_file(int type, const char *name);
 364
 365 /* OS specific functions */
 366 void os_setup_early_signal_handling(void);
 367 char *os_find_datadir(const char *argv0);
 368 void os_parse_cmd_args(int index, const char *optarg);
 369 void os_pidfile_error(void);
 370
 371 /* Convert a byte between binary and BCD.  */
 372 static inline uint8_t to_bcd(uint8_t val)
 373 {
 374     return ((val / 10) << 4) | (val % 10);
 375 }
 376
 377 static inline uint8_t from_bcd(uint8_t val)
 378 {
 379     return ((val >> 4) * 10) + (val & 0x0f);
 380 }
 381
 382 /* compute with 96 bit intermediate result: (a*b)/c */
 383 static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
 384 {
 385     union {
 386         uint64_t ll;
 387         struct {
 388 #ifdef HOST_WORDS_BIGENDIAN
 389             uint32_t high, low;
 390 #else
 391             uint32_t low, high;
 392 #endif
 393         } l;
 394     } u, res;
 395     uint64_t rl, rh;
 396
 397     u.ll = a;
 398     rl = (uint64_t)u.l.low * (uint64_t)b;
 399     rh = (uint64_t)u.l.high * (uint64_t)b;
 400     rh += (rl >> 32);
 401     res.l.high = rh / c;
 402     res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
 403     return res.ll;
 404 }
 405
 406 /* Round number down to multiple */
 407 #define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
 408
 409 /* Round number up to multiple */
 410 #define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
 411
 412 #include "module.h"
 413
 414 #endif