block.h revision 8b23a6c7e1aee255004dd19098d4c2462b61b849
18b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project#ifndef BLOCK_H 28b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project#define BLOCK_H 38b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project 48b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project/* block.c */ 58b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projecttypedef struct BlockDriver BlockDriver; 68b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project 78b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectextern BlockDriver bdrv_raw; 88b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectextern BlockDriver bdrv_host_device; 98b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectextern BlockDriver bdrv_cow; 108b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectextern BlockDriver bdrv_qcow; 118b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectextern BlockDriver bdrv_vmdk; 128b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectextern BlockDriver bdrv_cloop; 138b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectextern BlockDriver bdrv_dmg; 148b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectextern BlockDriver bdrv_bochs; 158b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectextern BlockDriver bdrv_vpc; 168b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectextern BlockDriver bdrv_vvfat; 178b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectextern BlockDriver bdrv_qcow2; 188b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectextern BlockDriver bdrv_parallels; 198b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectextern BlockDriver bdrv_nbd; 208b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project 218b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projecttypedef struct BlockDriverInfo { 228b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project /* in bytes, 0 if irrelevant */ 238b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project int cluster_size; 248b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project /* offset at which the VM state can be saved (0 if not possible) */ 258b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project int64_t vm_state_offset; 268b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project} BlockDriverInfo; 278b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project 288b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projecttypedef struct QEMUSnapshotInfo { 298b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project char id_str[128]; /* unique snapshot id */ 308b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project /* the following fields are informative. They are not needed for 318b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project the consistency of the snapshot */ 328b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project char name[256]; /* user choosen name */ 338b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project uint32_t vm_state_size; /* VM state info size */ 348b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project uint32_t date_sec; /* UTC date of the snapshot */ 358b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project uint32_t date_nsec; 368b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project uint64_t vm_clock_nsec; /* VM clock relative to boot */ 378b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project} QEMUSnapshotInfo; 388b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project 398b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project#define BDRV_O_RDONLY 0x0000 408b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project#define BDRV_O_RDWR 0x0002 418b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project#define BDRV_O_ACCESS 0x0003 428b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project#define BDRV_O_CREAT 0x0004 /* create an empty file */ 438b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project#define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */ 448b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project#define BDRV_O_FILE 0x0010 /* open as a raw file (do not try to 458b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project use a disk image format on top of 468b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project it (default for 478b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project bdrv_file_open()) */ 488b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project#define BDRV_O_DIRECT 0x0020 498b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project 508b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid bdrv_info(void); 518b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid bdrv_info_stats(void); 528b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project 538b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid bdrv_init(void); 548b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source ProjectBlockDriver *bdrv_find_format(const char *format_name); 558b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_create(BlockDriver *drv, 568b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project const char *filename, int64_t size_in_sectors, 578b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project const char *backing_file, int flags); 588b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source ProjectBlockDriverState *bdrv_new(const char *device_name); 598b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid bdrv_delete(BlockDriverState *bs); 608b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags); 618b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_open(BlockDriverState *bs, const char *filename, int flags); 628b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_open2(BlockDriverState *bs, const char *filename, int flags, 638b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project BlockDriver *drv); 648b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid bdrv_close(BlockDriverState *bs); 658b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_read(BlockDriverState *bs, int64_t sector_num, 668b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project uint8_t *buf, int nb_sectors); 678b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_write(BlockDriverState *bs, int64_t sector_num, 688b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project const uint8_t *buf, int nb_sectors); 698b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_pread(BlockDriverState *bs, int64_t offset, 708b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project void *buf, int count); 718b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_pwrite(BlockDriverState *bs, int64_t offset, 728b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project const void *buf, int count); 738b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_truncate(BlockDriverState *bs, int64_t offset); 748b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint64_t bdrv_getlength(BlockDriverState *bs); 758b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr); 768b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_commit(BlockDriverState *bs); 778b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid bdrv_set_boot_sector(BlockDriverState *bs, const uint8_t *data, int size); 788b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project/* async block I/O */ 798b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projecttypedef struct BlockDriverAIOCB BlockDriverAIOCB; 808b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projecttypedef void BlockDriverCompletionFunc(void *opaque, int ret); 818b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project 828b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source ProjectBlockDriverAIOCB *bdrv_aio_read(BlockDriverState *bs, int64_t sector_num, 838b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project uint8_t *buf, int nb_sectors, 848b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project BlockDriverCompletionFunc *cb, void *opaque); 858b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source ProjectBlockDriverAIOCB *bdrv_aio_write(BlockDriverState *bs, int64_t sector_num, 868b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project const uint8_t *buf, int nb_sectors, 878b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project BlockDriverCompletionFunc *cb, void *opaque); 888b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid bdrv_aio_cancel(BlockDriverAIOCB *acb); 898b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project 908b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid qemu_aio_init(void); 918b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid qemu_aio_flush(void); 928b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid qemu_aio_wait(void); 938b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project 948b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint qemu_key_check(BlockDriverState *bs, const char *name); 958b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project 968b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project/* Ensure contents are flushed to disk. */ 978b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid bdrv_flush(BlockDriverState *bs); 988b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors, 998b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project int *pnum); 1008b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project 1018b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project#define BDRV_TYPE_HD 0 1028b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project#define BDRV_TYPE_CDROM 1 1038b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project#define BDRV_TYPE_FLOPPY 2 1048b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project#define BIOS_ATA_TRANSLATION_AUTO 0 1058b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project#define BIOS_ATA_TRANSLATION_NONE 1 1068b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project#define BIOS_ATA_TRANSLATION_LBA 2 1078b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project#define BIOS_ATA_TRANSLATION_LARGE 3 1088b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project#define BIOS_ATA_TRANSLATION_RECHS 4 1098b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project 1108b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid bdrv_set_geometry_hint(BlockDriverState *bs, 1118b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project int cyls, int heads, int secs); 1128b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid bdrv_set_type_hint(BlockDriverState *bs, int type); 1138b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid bdrv_set_translation_hint(BlockDriverState *bs, int translation); 1148b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid bdrv_get_geometry_hint(BlockDriverState *bs, 1158b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project int *pcyls, int *pheads, int *psecs); 1168b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_get_type_hint(BlockDriverState *bs); 1178b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_get_translation_hint(BlockDriverState *bs); 1188b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_is_removable(BlockDriverState *bs); 1198b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_is_read_only(BlockDriverState *bs); 1208b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_is_sg(BlockDriverState *bs); 1218b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_is_inserted(BlockDriverState *bs); 1228b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_media_changed(BlockDriverState *bs); 1238b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_is_locked(BlockDriverState *bs); 1248b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid bdrv_set_locked(BlockDriverState *bs, int locked); 1258b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid bdrv_eject(BlockDriverState *bs, int eject_flag); 1268b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid bdrv_set_change_cb(BlockDriverState *bs, 1278b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project void (*change_cb)(void *opaque), void *opaque); 1288b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size); 1298b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source ProjectBlockDriverState *bdrv_find(const char *name); 1308b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid bdrv_iterate(void (*it)(void *opaque, const char *name), void *opaque); 1318b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_is_encrypted(BlockDriverState *bs); 1328b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_set_key(BlockDriverState *bs, const char *key); 1338b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid bdrv_iterate_format(void (*it)(void *opaque, const char *name), 1348b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project void *opaque); 1358b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectconst char *bdrv_get_device_name(BlockDriverState *bs); 1368b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num, 1378b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project const uint8_t *buf, int nb_sectors); 1388b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi); 1398b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project 1408b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid bdrv_get_backing_filename(BlockDriverState *bs, 1418b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project char *filename, int filename_size); 1428b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_snapshot_create(BlockDriverState *bs, 1438b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project QEMUSnapshotInfo *sn_info); 1448b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_snapshot_goto(BlockDriverState *bs, 1458b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project const char *snapshot_id); 1468b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id); 1478b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_snapshot_list(BlockDriverState *bs, 1488b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project QEMUSnapshotInfo **psn_info); 1498b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectchar *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn); 1508b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectint bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf); 1518b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project 1528b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectchar *get_human_readable_size(char *buf, int buf_size, int64_t size); 1538b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project// don't remove below comment, it makes integration with upstream sources easier 1548b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project//int path_is_absolute(const char *path); 1558b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Projectvoid path_combine(char *dest, int dest_size, 1568b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project const char *base_path, 1578b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project const char *filename); 1588b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project 1598b23a6c7e1aee255004dd19098d4c2462b61b849The Android Open Source Project#endif 160