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

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

unix.superglobalmegacorp.com