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

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: 
                     14: /* Hack around the mess dyngen-exec.h causes: We need QEMU_NORETURN in files that
                     15:    cannot include the following headers without conflicts. This condition has
                     16:    to be removed once dyngen is gone. */
                     17: #ifndef __DYNGEN_EXEC_H__
                     18: 
1.1       root       19: /* we put basic includes here to avoid repeating them in device drivers */
                     20: #include <stdlib.h>
                     21: #include <stdio.h>
                     22: #include <stdarg.h>
                     23: #include <string.h>
1.1.1.2   root       24: #include <strings.h>
1.1       root       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>
1.1.1.3   root       33: #include <assert.h>
1.1       root       34: 
                     35: #ifndef O_LARGEFILE
                     36: #define O_LARGEFILE 0
                     37: #endif
                     38: #ifndef O_BINARY
                     39: #define O_BINARY 0
                     40: #endif
1.1.1.4   root       41: #ifndef MAP_ANONYMOUS
                     42: #define MAP_ANONYMOUS MAP_ANON
                     43: #endif
1.1       root       44: #ifndef ENOMEDIUM
                     45: #define ENOMEDIUM ENODEV
                     46: #endif
1.1.1.4   root       47: #if !defined(ENOTSUP)
                     48: #define ENOTSUP 4096
                     49: #endif
1.1       root       50: 
1.1.1.4   root       51: #ifndef CONFIG_IOVEC
                     52: #define CONFIG_IOVEC
1.1.1.2   root       53: struct iovec {
                     54:     void *iov_base;
                     55:     size_t iov_len;
                     56: };
1.1.1.6 ! root       57: /*
        !            58:  * Use the same value as Linux for now.
        !            59:  */
        !            60: #define IOV_MAX                1024
1.1.1.2   root       61: #else
                     62: #include <sys/uio.h>
                     63: #endif
                     64: 
1.1       root       65: #ifdef _WIN32
                     66: #define fsync _commit
                     67: #define lseek _lseeki64
                     68: extern int qemu_ftruncate64(int, int64_t);
                     69: #define ftruncate qemu_ftruncate64
                     70: 
                     71: static inline char *realpath(const char *path, char *resolved_path)
                     72: {
                     73:     _fullpath(resolved_path, path, _MAX_PATH);
                     74:     return resolved_path;
                     75: }
                     76: 
                     77: #define PRId64 "I64d"
                     78: #define PRIx64 "I64x"
                     79: #define PRIu64 "I64u"
                     80: #define PRIo64 "I64o"
                     81: #endif
                     82: 
                     83: /* FIXME: Remove NEED_CPU_H.  */
                     84: #ifndef NEED_CPU_H
                     85: 
                     86: #include <setjmp.h>
                     87: #include "osdep.h"
                     88: #include "bswap.h"
                     89: 
                     90: #else
                     91: 
                     92: #include "cpu.h"
                     93: 
                     94: #endif /* !defined(NEED_CPU_H) */
                     95: 
                     96: /* bottom halves */
                     97: typedef struct QEMUBH QEMUBH;
                     98: 
                     99: typedef void QEMUBHFunc(void *opaque);
                    100: 
1.1.1.4   root      101: void async_context_push(void);
                    102: void async_context_pop(void);
                    103: int get_async_context_id(void);
                    104: 
1.1       root      105: QEMUBH *qemu_bh_new(QEMUBHFunc *cb, void *opaque);
                    106: void qemu_bh_schedule(QEMUBH *bh);
1.1.1.2   root      107: /* Bottom halfs that are scheduled from a bottom half handler are instantly
                    108:  * invoked.  This can create an infinite loop if a bottom half handler
                    109:  * schedules itself.  qemu_bh_schedule_idle() avoids this infinite loop by
                    110:  * ensuring that the bottom half isn't executed until the next main loop
                    111:  * iteration.
                    112:  */
                    113: void qemu_bh_schedule_idle(QEMUBH *bh);
1.1       root      114: void qemu_bh_cancel(QEMUBH *bh);
                    115: void qemu_bh_delete(QEMUBH *bh);
                    116: int qemu_bh_poll(void);
1.1.1.4   root      117: void qemu_bh_update_timeout(int *timeout);
1.1       root      118: 
                    119: uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c);
                    120: 
1.1.1.2   root      121: void qemu_get_timedate(struct tm *tm, int offset);
                    122: int qemu_timedate_diff(struct tm *tm);
                    123: 
1.1       root      124: /* cutils.c */
                    125: void pstrcpy(char *buf, int buf_size, const char *str);
                    126: char *pstrcat(char *buf, int buf_size, const char *s);
                    127: int strstart(const char *str, const char *val, const char **ptr);
                    128: int stristart(const char *str, const char *val, const char **ptr);
1.1.1.3   root      129: int qemu_strnlen(const char *s, int max_len);
1.1       root      130: time_t mktimegm(struct tm *tm);
1.1.1.2   root      131: int qemu_fls(int i);
1.1.1.4   root      132: int qemu_fdatasync(int fd);
                    133: 
                    134: /* path.c */
                    135: void init_paths(const char *prefix);
                    136: const char *path(const char *pathname);
1.1.1.2   root      137: 
                    138: #define qemu_isalnum(c)                isalnum((unsigned char)(c))
                    139: #define qemu_isalpha(c)                isalpha((unsigned char)(c))
                    140: #define qemu_iscntrl(c)                iscntrl((unsigned char)(c))
                    141: #define qemu_isdigit(c)                isdigit((unsigned char)(c))
                    142: #define qemu_isgraph(c)                isgraph((unsigned char)(c))
                    143: #define qemu_islower(c)                islower((unsigned char)(c))
                    144: #define qemu_isprint(c)                isprint((unsigned char)(c))
                    145: #define qemu_ispunct(c)                ispunct((unsigned char)(c))
                    146: #define qemu_isspace(c)                isspace((unsigned char)(c))
                    147: #define qemu_isupper(c)                isupper((unsigned char)(c))
                    148: #define qemu_isxdigit(c)       isxdigit((unsigned char)(c))
                    149: #define qemu_tolower(c)                tolower((unsigned char)(c))
                    150: #define qemu_toupper(c)                toupper((unsigned char)(c))
                    151: #define qemu_isascii(c)                isascii((unsigned char)(c))
                    152: #define qemu_toascii(c)                toascii((unsigned char)(c))
                    153: 
                    154: void *qemu_malloc(size_t size);
                    155: void *qemu_realloc(void *ptr, size_t size);
                    156: void *qemu_mallocz(size_t size);
                    157: void qemu_free(void *ptr);
                    158: char *qemu_strdup(const char *str);
                    159: char *qemu_strndup(const char *str, size_t size);
                    160: 
                    161: void *get_mmap_addr(unsigned long size);
                    162: 
1.1       root      163: 
1.1.1.4   root      164: void qemu_mutex_lock_iothread(void);
                    165: void qemu_mutex_unlock_iothread(void);
                    166: 
                    167: int qemu_open(const char *name, int flags, ...);
                    168: void qemu_set_cloexec(int fd);
                    169: 
                    170: #ifndef _WIN32
                    171: int qemu_pipe(int pipefd[2]);
                    172: #endif
                    173: 
1.1       root      174: /* Error handling.  */
                    175: 
1.1.1.2   root      176: void QEMU_NORETURN hw_error(const char *fmt, ...)
                    177:     __attribute__ ((__format__ (__printf__, 1, 2)));
1.1       root      178: 
                    179: /* IO callbacks.  */
                    180: typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size);
                    181: typedef int IOCanRWHandler(void *opaque);
                    182: typedef void IOHandler(void *opaque);
                    183: 
                    184: struct ParallelIOArg {
                    185:     void *buffer;
                    186:     int count;
                    187: };
                    188: 
                    189: typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
                    190: 
                    191: /* A load of opaque types so that device init declarations don't have to
                    192:    pull in all the real definitions.  */
                    193: typedef struct NICInfo NICInfo;
1.1.1.2   root      194: typedef struct HCIInfo HCIInfo;
1.1       root      195: typedef struct AudioState AudioState;
                    196: typedef struct BlockDriverState BlockDriverState;
                    197: typedef struct DisplayState DisplayState;
1.1.1.2   root      198: typedef struct DisplayChangeListener DisplayChangeListener;
                    199: typedef struct DisplaySurface DisplaySurface;
1.1.1.3   root      200: typedef struct DisplayAllocator DisplayAllocator;
1.1.1.2   root      201: typedef struct PixelFormat PixelFormat;
1.1       root      202: typedef struct TextConsole TextConsole;
1.1.1.2   root      203: typedef TextConsole QEMUConsole;
1.1       root      204: typedef struct CharDriverState CharDriverState;
1.1.1.4   root      205: typedef struct MACAddr MACAddr;
1.1       root      206: typedef struct VLANState VLANState;
1.1.1.4   root      207: typedef struct VLANClientState VLANClientState;
1.1       root      208: typedef struct QEMUFile QEMUFile;
                    209: typedef struct i2c_bus i2c_bus;
                    210: typedef struct i2c_slave i2c_slave;
                    211: typedef struct SMBusDevice SMBusDevice;
                    212: typedef struct QEMUTimer QEMUTimer;
1.1.1.4   root      213: typedef struct PCIHostState PCIHostState;
                    214: typedef struct PCIExpressHost PCIExpressHost;
1.1       root      215: typedef struct PCIBus PCIBus;
                    216: typedef struct PCIDevice PCIDevice;
                    217: typedef struct SerialState SerialState;
                    218: typedef struct IRQState *qemu_irq;
1.1.1.3   root      219: typedef struct PCMCIACardState PCMCIACardState;
                    220: typedef struct MouseTransformInfo MouseTransformInfo;
                    221: typedef struct uWireSlave uWireSlave;
                    222: typedef struct I2SCodec I2SCodec;
                    223: typedef struct DeviceState DeviceState;
                    224: typedef struct SSIBus SSIBus;
1.1       root      225: 
1.1.1.2   root      226: /* CPU save/load.  */
                    227: void cpu_save(QEMUFile *f, void *opaque);
                    228: int cpu_load(QEMUFile *f, void *opaque, int version_id);
                    229: 
                    230: /* Force QEMU to stop what it's doing and service IO */
                    231: void qemu_service_io(void);
                    232: 
1.1.1.3   root      233: /* Force QEMU to process pending events */
                    234: void qemu_notify_event(void);
                    235: 
                    236: /* Unblock cpu */
                    237: void qemu_cpu_kick(void *env);
                    238: int qemu_cpu_self(void *env);
                    239: 
                    240: #ifdef CONFIG_USER_ONLY
                    241: #define qemu_init_vcpu(env) do { } while (0)
                    242: #else
                    243: void qemu_init_vcpu(void *env);
                    244: #endif
                    245: 
1.1.1.2   root      246: typedef struct QEMUIOVector {
                    247:     struct iovec *iov;
                    248:     int niov;
                    249:     int nalloc;
                    250:     size_t size;
                    251: } QEMUIOVector;
                    252: 
                    253: void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
1.1.1.3   root      254: void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
1.1.1.2   root      255: void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
1.1.1.4   root      256: void qemu_iovec_concat(QEMUIOVector *dst, QEMUIOVector *src, size_t size);
1.1.1.2   root      257: void qemu_iovec_destroy(QEMUIOVector *qiov);
                    258: void qemu_iovec_reset(QEMUIOVector *qiov);
                    259: void qemu_iovec_to_buffer(QEMUIOVector *qiov, void *buf);
                    260: void qemu_iovec_from_buffer(QEMUIOVector *qiov, const void *buf, size_t count);
                    261: 
1.1.1.3   root      262: struct Monitor;
                    263: typedef struct Monitor Monitor;
                    264: 
1.1.1.4   root      265: /* Convert a byte between binary and BCD.  */
                    266: static inline uint8_t to_bcd(uint8_t val)
                    267: {
                    268:     return ((val / 10) << 4) | (val % 10);
                    269: }
                    270: 
                    271: static inline uint8_t from_bcd(uint8_t val)
                    272: {
                    273:     return ((val >> 4) * 10) + (val & 0x0f);
                    274: }
                    275: 
1.1.1.3   root      276: #include "module.h"
                    277: 
1.1.1.2   root      278: #endif /* dyngen-exec.h hack */
                    279: 
1.1       root      280: #endif

unix.superglobalmegacorp.com