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