]> git.proxmox.com Git - qemu.git/blame - block.h
sh4: r2d fix no ide/net case
[qemu.git] / block.h
CommitLineData
faf07963
PB
1#ifndef BLOCK_H
2#define BLOCK_H
3
a76bab49 4#include "qemu-aio.h"
3b69e4b9 5#include "qemu-common.h"
a76bab49 6
faf07963 7/* block.c */
faf07963
PB
8typedef struct BlockDriver BlockDriver;
9
10extern BlockDriver bdrv_raw;
11extern BlockDriver bdrv_host_device;
12extern BlockDriver bdrv_cow;
13extern BlockDriver bdrv_qcow;
14extern BlockDriver bdrv_vmdk;
15extern BlockDriver bdrv_cloop;
16extern BlockDriver bdrv_dmg;
17extern BlockDriver bdrv_bochs;
18extern BlockDriver bdrv_vpc;
19extern BlockDriver bdrv_vvfat;
20extern BlockDriver bdrv_qcow2;
21extern BlockDriver bdrv_parallels;
75818250 22extern BlockDriver bdrv_nbd;
faf07963
PB
23
24typedef 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;
c4218205 29 int64_t highest_alloc; /* highest allocated block offset (in bytes) */
1987530f 30 int64_t num_free_bytes; /* below highest_alloc */
faf07963
PB
31} BlockDriverInfo;
32
33typedef 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()) */
9f7965c7
AL
53#define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
54#define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */
4dc822d7 55#define BDRV_O_CACHE_DEF 0x0080 /* use default caching */
9f7965c7 56
4dc822d7 57#define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_CACHE_DEF)
faf07963 58
faf07963 59void bdrv_info(void);
a36e69dd 60void bdrv_info_stats(void);
faf07963
PB
61
62void bdrv_init(void);
63BlockDriver *bdrv_find_format(const char *format_name);
64int bdrv_create(BlockDriver *drv,
65 const char *filename, int64_t size_in_sectors,
66 const char *backing_file, int flags);
67BlockDriverState *bdrv_new(const char *device_name);
68void bdrv_delete(BlockDriverState *bs);
69int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags);
70int bdrv_open(BlockDriverState *bs, const char *filename, int flags);
71int bdrv_open2(BlockDriverState *bs, const char *filename, int flags,
72 BlockDriver *drv);
73void bdrv_close(BlockDriverState *bs);
74int bdrv_read(BlockDriverState *bs, int64_t sector_num,
75 uint8_t *buf, int nb_sectors);
76int bdrv_write(BlockDriverState *bs, int64_t sector_num,
77 const uint8_t *buf, int nb_sectors);
78int bdrv_pread(BlockDriverState *bs, int64_t offset,
79 void *buf, int count);
80int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
81 const void *buf, int count);
82int bdrv_truncate(BlockDriverState *bs, int64_t offset);
83int64_t bdrv_getlength(BlockDriverState *bs);
96b8f136 84void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
f3d54fc4 85void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs);
faf07963 86int bdrv_commit(BlockDriverState *bs);
faf07963
PB
87/* async block I/O */
88typedef struct BlockDriverAIOCB BlockDriverAIOCB;
89typedef void BlockDriverCompletionFunc(void *opaque, int ret);
90
3b69e4b9
AL
91BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
92 QEMUIOVector *iov, int nb_sectors,
93 BlockDriverCompletionFunc *cb, void *opaque);
94BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
95 QEMUIOVector *iov, int nb_sectors,
96 BlockDriverCompletionFunc *cb, void *opaque);
97
faf07963
PB
98BlockDriverAIOCB *bdrv_aio_read(BlockDriverState *bs, int64_t sector_num,
99 uint8_t *buf, int nb_sectors,
100 BlockDriverCompletionFunc *cb, void *opaque);
101BlockDriverAIOCB *bdrv_aio_write(BlockDriverState *bs, int64_t sector_num,
102 const uint8_t *buf, int nb_sectors,
103 BlockDriverCompletionFunc *cb, void *opaque);
104void bdrv_aio_cancel(BlockDriverAIOCB *acb);
105
faf07963
PB
106int qemu_key_check(BlockDriverState *bs, const char *name);
107
108/* Ensure contents are flushed to disk. */
109void bdrv_flush(BlockDriverState *bs);
c6ca28d6
AL
110void bdrv_flush_all(void);
111
f58c7b35
TS
112int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
113 int *pnum);
faf07963
PB
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
124void bdrv_set_geometry_hint(BlockDriverState *bs,
125 int cyls, int heads, int secs);
126void bdrv_set_type_hint(BlockDriverState *bs, int type);
127void bdrv_set_translation_hint(BlockDriverState *bs, int translation);
128void bdrv_get_geometry_hint(BlockDriverState *bs,
129 int *pcyls, int *pheads, int *psecs);
130int bdrv_get_type_hint(BlockDriverState *bs);
131int bdrv_get_translation_hint(BlockDriverState *bs);
132int bdrv_is_removable(BlockDriverState *bs);
133int bdrv_is_read_only(BlockDriverState *bs);
985a03b0 134int bdrv_is_sg(BlockDriverState *bs);
faf07963
PB
135int bdrv_is_inserted(BlockDriverState *bs);
136int bdrv_media_changed(BlockDriverState *bs);
137int bdrv_is_locked(BlockDriverState *bs);
138void bdrv_set_locked(BlockDriverState *bs, int locked);
139void bdrv_eject(BlockDriverState *bs, int eject_flag);
140void bdrv_set_change_cb(BlockDriverState *bs,
141 void (*change_cb)(void *opaque), void *opaque);
142void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size);
143BlockDriverState *bdrv_find(const char *name);
144void bdrv_iterate(void (*it)(void *opaque, const char *name), void *opaque);
145int bdrv_is_encrypted(BlockDriverState *bs);
146int bdrv_set_key(BlockDriverState *bs, const char *key);
147void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
148 void *opaque);
149const char *bdrv_get_device_name(BlockDriverState *bs);
150int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
151 const uint8_t *buf, int nb_sectors);
152int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);
153
154void bdrv_get_backing_filename(BlockDriverState *bs,
155 char *filename, int filename_size);
156int bdrv_snapshot_create(BlockDriverState *bs,
157 QEMUSnapshotInfo *sn_info);
158int bdrv_snapshot_goto(BlockDriverState *bs,
159 const char *snapshot_id);
160int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
161int bdrv_snapshot_list(BlockDriverState *bs,
162 QEMUSnapshotInfo **psn_info);
163char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);
985a03b0 164int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
faf07963
PB
165
166char *get_human_readable_size(char *buf, int buf_size, int64_t size);
167int path_is_absolute(const char *path);
168void path_combine(char *dest, int dest_size,
169 const char *base_path,
170 const char *filename);
171
172#endif