Annotation of qemu/qemu-common.h, revision 1.1.1.11

1.1       root        1: /* Common header file that is included by all of qemu.  */
                      2: #ifndef QEMU_COMMON_H
                      3: #define QEMU_COMMON_H
                      4: 
1.1.1.9   root        5: #include "compiler.h"
1.1.1.5   root        6: #include "config-host.h"
                      7: 
1.1.1.10  root        8: #if defined(__arm__) || defined(__sparc__) || defined(__mips__) || defined(__hppa__) || defined(__ia64__)
                      9: #define WORDS_ALIGNED
                     10: #endif
                     11: 
1.1.1.9   root       12: #define TFR(expr) do { if ((expr) != -1) break; } while (errno == EINTR)
1.1.1.7   root       13: 
                     14: typedef struct QEMUTimer QEMUTimer;
                     15: typedef struct QEMUFile QEMUFile;
                     16: typedef struct DeviceState DeviceState;
                     17: 
1.1.1.9   root       18: struct Monitor;
                     19: typedef struct Monitor Monitor;
                     20: 
1.1       root       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>
1.1.1.7   root       25: #include <stdbool.h>
1.1       root       26: #include <string.h>
1.1.1.2   root       27: #include <strings.h>
1.1       root       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>
1.1.1.9   root       36: #include <sys/time.h>
1.1.1.3   root       37: #include <assert.h>
1.1.1.9   root       38: #include <signal.h>
1.1.1.10  root       39: #include <glib.h>
1.1.1.9   root       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
1.1       root       48: 
                     49: #ifndef O_LARGEFILE
                     50: #define O_LARGEFILE 0
                     51: #endif
                     52: #ifndef O_BINARY
                     53: #define O_BINARY 0
                     54: #endif
1.1.1.4   root       55: #ifndef MAP_ANONYMOUS
                     56: #define MAP_ANONYMOUS MAP_ANON
                     57: #endif
1.1       root       58: #ifndef ENOMEDIUM
                     59: #define ENOMEDIUM ENODEV
                     60: #endif
1.1.1.4   root       61: #if !defined(ENOTSUP)
                     62: #define ENOTSUP 4096
                     63: #endif
1.1.1.11! root       64: #if !defined(ECANCELED)
        !            65: #define ECANCELED 4097
        !            66: #endif
1.1.1.8   root       67: #ifndef TIME_MAX
                     68: #define TIME_MAX LONG_MAX
                     69: #endif
1.1       root       70: 
1.1.1.11! root       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: 
1.1.1.4   root       80: #ifndef CONFIG_IOVEC
                     81: #define CONFIG_IOVEC
1.1.1.2   root       82: struct iovec {
                     83:     void *iov_base;
                     84:     size_t iov_len;
                     85: };
1.1.1.6   root       86: /*
                     87:  * Use the same value as Linux for now.
                     88:  */
                     89: #define IOV_MAX                1024
1.1.1.2   root       90: #else
                     91: #include <sys/uio.h>
                     92: #endif
                     93: 
1.1.1.8   root       94: typedef int (*fprintf_function)(FILE *f, const char *fmt, ...)
                     95:     GCC_FMT_ATTR(2, 3);
                     96: 
1.1       root       97: #ifdef _WIN32
                     98: #define fsync _commit
1.1.1.11! root       99: #if !defined(lseek)
        !           100: # define lseek _lseeki64
        !           101: #endif
1.1.1.8   root      102: int qemu_ftruncate64(int, int64_t);
1.1.1.11! root      103: #if !defined(ftruncate)
        !           104: # define ftruncate qemu_ftruncate64
        !           105: #endif
1.1       root      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: 
1.1.1.10  root      114: /* icount */
                    115: void configure_icount(const char *option);
                    116: extern int use_icount;
                    117: 
1.1       root      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: 
1.1.1.9   root      130: /* main function, renamed */
                    131: #if defined(CONFIG_COCOA)
                    132: int qemu_main(int argc, char **argv, char **envp);
                    133: #endif
                    134: 
1.1.1.2   root      135: void qemu_get_timedate(struct tm *tm, int offset);
                    136: int qemu_timedate_diff(struct tm *tm);
                    137: 
1.1       root      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);
1.1.1.3   root      143: int qemu_strnlen(const char *s, int max_len);
1.1       root      144: time_t mktimegm(struct tm *tm);
1.1.1.2   root      145: int qemu_fls(int i);
1.1.1.4   root      146: int qemu_fdatasync(int fd);
1.1.1.7   root      147: int fcntl_setfl(int fd, int flag);
1.1.1.10  root      148: int qemu_parse_fd(const char *param);
1.1.1.4   root      149: 
1.1.1.8   root      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);
1.1.1.10  root      164: int64_t strtosz_suffix_unit(const char *nptr, char **end,
                    165:                             const char default_suffix, int64_t unit);
1.1.1.8   root      166: 
1.1.1.4   root      167: /* path.c */
                    168: void init_paths(const char *prefix);
                    169: const char *path(const char *pathname);
1.1.1.2   root      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: 
1.1.1.8   root      187: void *qemu_oom_check(void *ptr);
1.1.1.4   root      188: 
                    189: int qemu_open(const char *name, int flags, ...);
1.1.1.7   root      190: ssize_t qemu_write_full(int fd, const void *buf, size_t count)
                    191:     QEMU_WARN_UNUSED_RESULT;
1.1.1.11! root      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;
1.1.1.4   root      196: 
                    197: #ifndef _WIN32
1.1.1.7   root      198: int qemu_eventfd(int pipefd[2]);
1.1.1.4   root      199: int qemu_pipe(int pipefd[2]);
                    200: #endif
                    201: 
1.1.1.9   root      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: 
1.1.1.11! root      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: 
1.1       root      211: /* Error handling.  */
                    212: 
1.1.1.8   root      213: void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
1.1       root      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;
1.1.1.2   root      225: typedef struct HCIInfo HCIInfo;
1.1       root      226: typedef struct AudioState AudioState;
                    227: typedef struct BlockDriverState BlockDriverState;
1.1.1.8   root      228: typedef struct DriveInfo DriveInfo;
1.1       root      229: typedef struct DisplayState DisplayState;
1.1.1.2   root      230: typedef struct DisplayChangeListener DisplayChangeListener;
                    231: typedef struct DisplaySurface DisplaySurface;
1.1.1.3   root      232: typedef struct DisplayAllocator DisplayAllocator;
1.1.1.2   root      233: typedef struct PixelFormat PixelFormat;
1.1       root      234: typedef struct TextConsole TextConsole;
1.1.1.2   root      235: typedef TextConsole QEMUConsole;
1.1       root      236: typedef struct CharDriverState CharDriverState;
1.1.1.4   root      237: typedef struct MACAddr MACAddr;
1.1       root      238: typedef struct VLANState VLANState;
1.1.1.4   root      239: typedef struct VLANClientState VLANClientState;
1.1       root      240: typedef struct i2c_bus i2c_bus;
1.1.1.11! root      241: typedef struct ISABus ISABus;
1.1       root      242: typedef struct SMBusDevice SMBusDevice;
1.1.1.4   root      243: typedef struct PCIHostState PCIHostState;
                    244: typedef struct PCIExpressHost PCIExpressHost;
1.1       root      245: typedef struct PCIBus PCIBus;
                    246: typedef struct PCIDevice PCIDevice;
1.1.1.8   root      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;
1.1       root      254: typedef struct SerialState SerialState;
                    255: typedef struct IRQState *qemu_irq;
1.1.1.3   root      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;
1.1.1.7   root      261: typedef struct EventNotifier EventNotifier;
                    262: typedef struct VirtIODevice VirtIODevice;
1.1.1.10  root      263: typedef struct QEMUSGList QEMUSGList;
1.1.1.11! root      264: typedef struct SHPCDevice SHPCDevice;
1.1.1.7   root      265: 
                    266: typedef uint64_t pcibus_t;
                    267: 
1.1.1.11! root      268: typedef enum LostTickPolicy {
        !           269:     LOST_TICK_DISCARD,
        !           270:     LOST_TICK_DELAY,
        !           271:     LOST_TICK_MERGE,
        !           272:     LOST_TICK_SLEW,
        !           273:     LOST_TICK_MAX
        !           274: } LostTickPolicy;
        !           275: 
1.1.1.10  root      276: void tcg_exec_init(unsigned long tb_size);
                    277: bool tcg_enabled(void);
                    278: 
                    279: void cpu_exec_init_all(void);
1.1       root      280: 
1.1.1.2   root      281: /* CPU save/load.  */
                    282: void cpu_save(QEMUFile *f, void *opaque);
                    283: int cpu_load(QEMUFile *f, void *opaque, int version_id);
                    284: 
1.1.1.3   root      285: /* Unblock cpu */
                    286: void qemu_cpu_kick(void *env);
1.1.1.9   root      287: void qemu_cpu_kick_self(void);
                    288: int qemu_cpu_is_self(void *env);
                    289: bool all_cpu_threads_idle(void);
1.1.1.3   root      290: 
1.1.1.7   root      291: /* work queue */
                    292: struct qemu_work_item {
                    293:     struct qemu_work_item *next;
                    294:     void (*func)(void *data);
                    295:     void *data;
                    296:     int done;
                    297: };
                    298: 
1.1.1.3   root      299: #ifdef CONFIG_USER_ONLY
                    300: #define qemu_init_vcpu(env) do { } while (0)
                    301: #else
                    302: void qemu_init_vcpu(void *env);
                    303: #endif
                    304: 
1.1.1.11! root      305: /**
        !           306:  * Sends an iovec (or optionally a part of it) down a socket, yielding
        !           307:  * when the socket is full.
        !           308:  */
        !           309: int qemu_co_sendv(int sockfd, struct iovec *iov,
        !           310:                   int len, int iov_offset);
        !           311: 
        !           312: /**
        !           313:  * Receives data into an iovec (or optionally into a part of it) from
        !           314:  * a socket, yielding when there is no data in the socket.
        !           315:  */
        !           316: int qemu_co_recvv(int sockfd, struct iovec *iov,
        !           317:                   int len, int iov_offset);
        !           318: 
        !           319: 
        !           320: /**
        !           321:  * Sends a buffer down a socket, yielding when the socket is full.
        !           322:  */
        !           323: int qemu_co_send(int sockfd, void *buf, int len);
        !           324: 
        !           325: /**
        !           326:  * Receives data into a buffer from a socket, yielding when there
        !           327:  * is no data in the socket.
        !           328:  */
        !           329: int qemu_co_recv(int sockfd, void *buf, int len);
        !           330: 
        !           331: 
1.1.1.2   root      332: typedef struct QEMUIOVector {
                    333:     struct iovec *iov;
                    334:     int niov;
                    335:     int nalloc;
                    336:     size_t size;
                    337: } QEMUIOVector;
                    338: 
                    339: void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
1.1.1.3   root      340: void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
1.1.1.2   root      341: void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
1.1.1.8   root      342: void qemu_iovec_copy(QEMUIOVector *dst, QEMUIOVector *src, uint64_t skip,
                    343:     size_t size);
1.1.1.4   root      344: void qemu_iovec_concat(QEMUIOVector *dst, QEMUIOVector *src, size_t size);
1.1.1.2   root      345: void qemu_iovec_destroy(QEMUIOVector *qiov);
                    346: void qemu_iovec_reset(QEMUIOVector *qiov);
                    347: void qemu_iovec_to_buffer(QEMUIOVector *qiov, void *buf);
                    348: void qemu_iovec_from_buffer(QEMUIOVector *qiov, const void *buf, size_t count);
1.1.1.8   root      349: void qemu_iovec_memset(QEMUIOVector *qiov, int c, size_t count);
                    350: void qemu_iovec_memset_skip(QEMUIOVector *qiov, int c, size_t count,
                    351:                             size_t skip);
1.1.1.2   root      352: 
1.1.1.11! root      353: bool buffer_is_zero(const void *buf, size_t len);
        !           354: 
1.1.1.9   root      355: void qemu_progress_init(int enabled, float min_skip);
                    356: void qemu_progress_end(void);
                    357: void qemu_progress_print(float delta, int max);
                    358: 
                    359: #define QEMU_FILE_TYPE_BIOS   0
                    360: #define QEMU_FILE_TYPE_KEYMAP 1
                    361: char *qemu_find_file(int type, const char *name);
                    362: 
                    363: /* OS specific functions */
                    364: void os_setup_early_signal_handling(void);
                    365: char *os_find_datadir(const char *argv0);
                    366: void os_parse_cmd_args(int index, const char *optarg);
                    367: void os_pidfile_error(void);
1.1.1.3   root      368: 
1.1.1.4   root      369: /* Convert a byte between binary and BCD.  */
                    370: static inline uint8_t to_bcd(uint8_t val)
                    371: {
                    372:     return ((val / 10) << 4) | (val % 10);
                    373: }
                    374: 
                    375: static inline uint8_t from_bcd(uint8_t val)
                    376: {
                    377:     return ((val >> 4) * 10) + (val & 0x0f);
                    378: }
                    379: 
1.1.1.8   root      380: /* compute with 96 bit intermediate result: (a*b)/c */
                    381: static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
                    382: {
                    383:     union {
                    384:         uint64_t ll;
                    385:         struct {
                    386: #ifdef HOST_WORDS_BIGENDIAN
                    387:             uint32_t high, low;
                    388: #else
                    389:             uint32_t low, high;
                    390: #endif
                    391:         } l;
                    392:     } u, res;
                    393:     uint64_t rl, rh;
                    394: 
                    395:     u.ll = a;
                    396:     rl = (uint64_t)u.l.low * (uint64_t)b;
                    397:     rh = (uint64_t)u.l.high * (uint64_t)b;
                    398:     rh += (rl >> 32);
                    399:     res.l.high = rh / c;
                    400:     res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
                    401:     return res.ll;
                    402: }
1.1.1.3   root      403: 
1.1.1.11! root      404: /* Round number down to multiple */
        !           405: #define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
        !           406: 
        !           407: /* Round number up to multiple */
        !           408: #define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
        !           409: 
1.1.1.8   root      410: #include "module.h"
1.1.1.2   root      411: 
1.1       root      412: #endif

unix.superglobalmegacorp.com