Annotation of qemu/block.h, revision 1.1

1.1     ! root        1: #ifndef BLOCK_H
        !             2: #define BLOCK_H
        !             3: 
        !             4: /* block.c */
        !             5: typedef struct BlockDriver BlockDriver;
        !             6: 
        !             7: extern BlockDriver bdrv_raw;
        !             8: extern BlockDriver bdrv_host_device;
        !             9: extern BlockDriver bdrv_cow;
        !            10: extern BlockDriver bdrv_qcow;
        !            11: extern BlockDriver bdrv_vmdk;
        !            12: extern BlockDriver bdrv_cloop;
        !            13: extern BlockDriver bdrv_dmg;
        !            14: extern BlockDriver bdrv_bochs;
        !            15: extern BlockDriver bdrv_vpc;
        !            16: extern BlockDriver bdrv_vvfat;
        !            17: extern BlockDriver bdrv_qcow2;
        !            18: extern BlockDriver bdrv_parallels;
        !            19: 
        !            20: typedef struct BlockDriverInfo {
        !            21:     /* in bytes, 0 if irrelevant */
        !            22:     int cluster_size;
        !            23:     /* offset at which the VM state can be saved (0 if not possible) */
        !            24:     int64_t vm_state_offset;
        !            25: } BlockDriverInfo;
        !            26: 
        !            27: typedef struct QEMUSnapshotInfo {
        !            28:     char id_str[128]; /* unique snapshot id */
        !            29:     /* the following fields are informative. They are not needed for
        !            30:        the consistency of the snapshot */
        !            31:     char name[256]; /* user choosen name */
        !            32:     uint32_t vm_state_size; /* VM state info size */
        !            33:     uint32_t date_sec; /* UTC date of the snapshot */
        !            34:     uint32_t date_nsec;
        !            35:     uint64_t vm_clock_nsec; /* VM clock relative to boot */
        !            36: } QEMUSnapshotInfo;
        !            37: 
        !            38: #define BDRV_O_RDONLY      0x0000
        !            39: #define BDRV_O_RDWR        0x0002
        !            40: #define BDRV_O_ACCESS      0x0003
        !            41: #define BDRV_O_CREAT       0x0004 /* create an empty file */
        !            42: #define BDRV_O_SNAPSHOT    0x0008 /* open the file read only and save writes in a snapshot */
        !            43: #define BDRV_O_FILE        0x0010 /* open as a raw file (do not try to
        !            44:                                      use a disk image format on top of
        !            45:                                      it (default for
        !            46:                                      bdrv_file_open()) */
        !            47: #define BDRV_O_DIRECT      0x0020
        !            48: 
        !            49: #ifndef QEMU_IMG
        !            50: void bdrv_info(void);
        !            51: void bdrv_info_stats(void);
        !            52: #endif
        !            53: 
        !            54: void bdrv_init(void);
        !            55: BlockDriver *bdrv_find_format(const char *format_name);
        !            56: int bdrv_create(BlockDriver *drv,
        !            57:                 const char *filename, int64_t size_in_sectors,
        !            58:                 const char *backing_file, int flags);
        !            59: BlockDriverState *bdrv_new(const char *device_name);
        !            60: void bdrv_delete(BlockDriverState *bs);
        !            61: int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags);
        !            62: int bdrv_open(BlockDriverState *bs, const char *filename, int flags);
        !            63: int bdrv_open2(BlockDriverState *bs, const char *filename, int flags,
        !            64:                BlockDriver *drv);
        !            65: void bdrv_close(BlockDriverState *bs);
        !            66: int bdrv_read(BlockDriverState *bs, int64_t sector_num,
        !            67:               uint8_t *buf, int nb_sectors);
        !            68: int bdrv_write(BlockDriverState *bs, int64_t sector_num,
        !            69:                const uint8_t *buf, int nb_sectors);
        !            70: int bdrv_pread(BlockDriverState *bs, int64_t offset,
        !            71:                void *buf, int count);
        !            72: int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
        !            73:                 const void *buf, int count);
        !            74: int bdrv_truncate(BlockDriverState *bs, int64_t offset);
        !            75: int64_t bdrv_getlength(BlockDriverState *bs);
        !            76: void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
        !            77: int bdrv_commit(BlockDriverState *bs);
        !            78: void bdrv_set_boot_sector(BlockDriverState *bs, const uint8_t *data, int size);
        !            79: /* async block I/O */
        !            80: typedef struct BlockDriverAIOCB BlockDriverAIOCB;
        !            81: typedef void BlockDriverCompletionFunc(void *opaque, int ret);
        !            82: 
        !            83: BlockDriverAIOCB *bdrv_aio_read(BlockDriverState *bs, int64_t sector_num,
        !            84:                                 uint8_t *buf, int nb_sectors,
        !            85:                                 BlockDriverCompletionFunc *cb, void *opaque);
        !            86: BlockDriverAIOCB *bdrv_aio_write(BlockDriverState *bs, int64_t sector_num,
        !            87:                                  const uint8_t *buf, int nb_sectors,
        !            88:                                  BlockDriverCompletionFunc *cb, void *opaque);
        !            89: void bdrv_aio_cancel(BlockDriverAIOCB *acb);
        !            90: 
        !            91: void qemu_aio_init(void);
        !            92: void qemu_aio_poll(void);
        !            93: void qemu_aio_flush(void);
        !            94: void qemu_aio_wait_start(void);
        !            95: void qemu_aio_wait(void);
        !            96: void qemu_aio_wait_end(void);
        !            97: 
        !            98: int qemu_key_check(BlockDriverState *bs, const char *name);
        !            99: 
        !           100: /* Ensure contents are flushed to disk.  */
        !           101: void bdrv_flush(BlockDriverState *bs);
        !           102: 
        !           103: #define BDRV_TYPE_HD     0
        !           104: #define BDRV_TYPE_CDROM  1
        !           105: #define BDRV_TYPE_FLOPPY 2
        !           106: #define BIOS_ATA_TRANSLATION_AUTO   0
        !           107: #define BIOS_ATA_TRANSLATION_NONE   1
        !           108: #define BIOS_ATA_TRANSLATION_LBA    2
        !           109: #define BIOS_ATA_TRANSLATION_LARGE  3
        !           110: #define BIOS_ATA_TRANSLATION_RECHS  4
        !           111: 
        !           112: void bdrv_set_geometry_hint(BlockDriverState *bs,
        !           113:                             int cyls, int heads, int secs);
        !           114: void bdrv_set_type_hint(BlockDriverState *bs, int type);
        !           115: void bdrv_set_translation_hint(BlockDriverState *bs, int translation);
        !           116: void bdrv_get_geometry_hint(BlockDriverState *bs,
        !           117:                             int *pcyls, int *pheads, int *psecs);
        !           118: int bdrv_get_type_hint(BlockDriverState *bs);
        !           119: int bdrv_get_translation_hint(BlockDriverState *bs);
        !           120: int bdrv_is_removable(BlockDriverState *bs);
        !           121: int bdrv_is_read_only(BlockDriverState *bs);
        !           122: int bdrv_is_sg(BlockDriverState *bs);
        !           123: int bdrv_is_inserted(BlockDriverState *bs);
        !           124: int bdrv_media_changed(BlockDriverState *bs);
        !           125: int bdrv_is_locked(BlockDriverState *bs);
        !           126: void bdrv_set_locked(BlockDriverState *bs, int locked);
        !           127: void bdrv_eject(BlockDriverState *bs, int eject_flag);
        !           128: void bdrv_set_change_cb(BlockDriverState *bs,
        !           129:                         void (*change_cb)(void *opaque), void *opaque);
        !           130: void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size);
        !           131: BlockDriverState *bdrv_find(const char *name);
        !           132: void bdrv_iterate(void (*it)(void *opaque, const char *name), void *opaque);
        !           133: int bdrv_is_encrypted(BlockDriverState *bs);
        !           134: int bdrv_set_key(BlockDriverState *bs, const char *key);
        !           135: void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
        !           136:                          void *opaque);
        !           137: const char *bdrv_get_device_name(BlockDriverState *bs);
        !           138: int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
        !           139:                           const uint8_t *buf, int nb_sectors);
        !           140: int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
        !           141: 
        !           142: void bdrv_get_backing_filename(BlockDriverState *bs,
        !           143:                                char *filename, int filename_size);
        !           144: int bdrv_snapshot_create(BlockDriverState *bs,
        !           145:                          QEMUSnapshotInfo *sn_info);
        !           146: int bdrv_snapshot_goto(BlockDriverState *bs,
        !           147:                        const char *snapshot_id);
        !           148: int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
        !           149: int bdrv_snapshot_list(BlockDriverState *bs,
        !           150:                        QEMUSnapshotInfo **psn_info);
        !           151: char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);
        !           152: int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
        !           153: 
        !           154: char *get_human_readable_size(char *buf, int buf_size, int64_t size);
        !           155: int path_is_absolute(const char *path);
        !           156: void path_combine(char *dest, int dest_size,
        !           157:                   const char *base_path,
        !           158:                   const char *filename);
        !           159: 
        !           160: #endif

unix.superglobalmegacorp.com