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