1 #ifndef BLOCK_H 2 #define BLOCK_H 3 4 #include "qemu-aio.h" 5 #include "qemu-common.h" 6 #include "qemu-option.h" 7 8 /* block.c */ 9 typedef struct BlockDriver BlockDriver; 10 11 typedef struct BlockDriverInfo { 12 /* in bytes, 0 if irrelevant */ 13 int cluster_size; 14 /* offset at which the VM state can be saved (0 if not possible) */ 15 int64_t vm_state_offset; 16 } BlockDriverInfo; 17 18 typedef struct QEMUSnapshotInfo { 19 char id_str[128]; /* unique snapshot id */ 20 /* the following fields are informative. They are not needed for 21 the consistency of the snapshot */ 22 char name[256]; /* user choosen name */ 23 uint32_t vm_state_size; /* VM state info size */ 24 uint32_t date_sec; /* UTC date of the snapshot */ 25 uint32_t date_nsec; 26 uint64_t vm_clock_nsec; /* VM clock relative to boot */ 27 } QEMUSnapshotInfo; 28 29 #define BDRV_O_RDONLY 0x0000 30 #define BDRV_O_RDWR 0x0002 31 #define BDRV_O_ACCESS 0x0003 32 #define BDRV_O_CREAT 0x0004 /* create an empty file */ 33 #define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */ 34 #define BDRV_O_FILE 0x0010 /* open as a raw file (do not try to 35 use a disk image format on top of 36 it (default for 37 bdrv_file_open()) */ 38 #define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */ 39 #define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */ 40 #define BDRV_O_CACHE_DEF 0x0080 /* use default caching */ 41 42 #define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_CACHE_DEF) 43 44 void bdrv_info(Monitor *mon); 45 void bdrv_info_stats(Monitor *mon); 46 47 void bdrv_init(void); 48 BlockDriver *bdrv_find_format(const char *format_name); 49 int bdrv_create(BlockDriver *drv, const char* filename, 50 QEMUOptionParameter *options); 51 int bdrv_create2(BlockDriver *drv, 52 const char *filename, int64_t size_in_sectors, 53 const char *backing_file, const char *backing_format, 54 int flags); 55 BlockDriverState *bdrv_new(const char *device_name); 56 void bdrv_delete(BlockDriverState *bs); 57 int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags); 58 int bdrv_open(BlockDriverState *bs, const char *filename, int flags); 59 int bdrv_open2(BlockDriverState *bs, const char *filename, int flags, 60 BlockDriver *drv); 61 void bdrv_close(BlockDriverState *bs); 62 int bdrv_check(BlockDriverState *bs); 63 int bdrv_read(BlockDriverState *bs, int64_t sector_num, 64 uint8_t *buf, int nb_sectors); 65 int bdrv_write(BlockDriverState *bs, int64_t sector_num, 66 const uint8_t *buf, int nb_sectors); 67 int bdrv_pread(BlockDriverState *bs, int64_t offset, 68 void *buf, int count); 69 int bdrv_pwrite(BlockDriverState *bs, int64_t offset, 70 const void *buf, int count); 71 int bdrv_truncate(BlockDriverState *bs, int64_t offset); 72 int64_t bdrv_getlength(BlockDriverState *bs); 73 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr); 74 void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs); 75 int bdrv_commit(BlockDriverState *bs); 76 void bdrv_register(BlockDriver *bdrv); 77 78 /* async block I/O */ 79 typedef struct BlockDriverAIOCB BlockDriverAIOCB; 80 typedef void BlockDriverCompletionFunc(void *opaque, int ret); 81 82 BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num, 83 QEMUIOVector *iov, int nb_sectors, 84 BlockDriverCompletionFunc *cb, void *opaque); 85 BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num, 86 QEMUIOVector *iov, int nb_sectors, 87 BlockDriverCompletionFunc *cb, void *opaque); 88 void bdrv_aio_cancel(BlockDriverAIOCB *acb); 89 90 /* sg packet commands */ 91 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf); 92 BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs, 93 unsigned long int req, void *buf, 94 BlockDriverCompletionFunc *cb, void *opaque); 95 96 /* Ensure contents are flushed to disk. */ 97 void bdrv_flush(BlockDriverState *bs); 98 void bdrv_flush_all(void); 99 100 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors, 101 int *pnum); 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 int 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, BlockDriverState *bs), 133 void *opaque); 134 int bdrv_is_encrypted(BlockDriverState *bs); 135 int bdrv_key_required(BlockDriverState *bs); 136 int bdrv_set_key(BlockDriverState *bs, const char *key); 137 int bdrv_query_missing_keys(void); 138 void bdrv_iterate_format(void (*it)(void *opaque, const char *name), 139 void *opaque); 140 const char *bdrv_get_device_name(BlockDriverState *bs); 141 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num, 142 const uint8_t *buf, int nb_sectors); 143 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi); 144 145 const char *bdrv_get_encrypted_filename(BlockDriverState *bs); 146 void bdrv_get_backing_filename(BlockDriverState *bs, 147 char *filename, int filename_size); 148 int bdrv_snapshot_create(BlockDriverState *bs, 149 QEMUSnapshotInfo *sn_info); 150 int bdrv_snapshot_goto(BlockDriverState *bs, 151 const char *snapshot_id); 152 int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id); 153 int bdrv_snapshot_list(BlockDriverState *bs, 154 QEMUSnapshotInfo **psn_info); 155 char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn); 156 157 char *get_human_readable_size(char *buf, int buf_size, int64_t size); 158 int path_is_absolute(const char *path); 159 void path_combine(char *dest, int dest_size, 160 const char *base_path, 161 const char *filename); 162 163 int bdrv_put_buffer(BlockDriverState *bs, const uint8_t *buf, 164 int64_t pos, int size); 165 166 int bdrv_get_buffer(BlockDriverState *bs, uint8_t *buf, int64_t pos, int size); 167 168 #endif 169
