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