[qemu.git] / block.h

#ifndef BLOCK_H
#define BLOCK_H

#include "qemu-aio.h"
#include "qemu-common.h"
#include "qemu-option.h"
#include "qobject.h"

/* block.c */
typedef struct BlockDriver BlockDriver;

typedef struct BlockDriverInfo {
    /* in bytes, 0 if irrelevant */
    int cluster_size;
    /* offset at which the VM state can be saved (0 if not possible) */
    int64_t vm_state_offset;
} BlockDriverInfo;

typedef struct QEMUSnapshotInfo {
    char id_str[128]; /* unique snapshot id */
    /* the following fields are informative. They are not needed for
       the consistency of the snapshot */
    char name[256]; /* user choosen name */
    uint32_t vm_state_size; /* VM state info size */
    uint32_t date_sec; /* UTC date of the snapshot */
    uint32_t date_nsec;
    uint64_t vm_clock_nsec; /* VM clock relative to boot */
} QEMUSnapshotInfo;

#define BDRV_O_RDONLY      0x0000
#define BDRV_O_RDWR        0x0002
#define BDRV_O_ACCESS      0x0003
#define BDRV_O_CREAT       0x0004 /* create an empty file */
#define BDRV_O_SNAPSHOT    0x0008 /* open the file read only and save writes in a snapshot */
#define BDRV_O_FILE        0x0010 /* open as a raw file (do not try to
                                     use a disk image format on top of
                                     it (default for
                                     bdrv_file_open()) */
#define BDRV_O_NOCACHE     0x0020 /* do not use the host page cache */
#define BDRV_O_CACHE_WB    0x0040 /* use write-back caching */
#define BDRV_O_NATIVE_AIO  0x0080 /* use native AIO instead of the thread pool */

#define BDRV_O_CACHE_MASK  (BDRV_O_NOCACHE | BDRV_O_CACHE_WB)

#define BDRV_SECTOR_BITS   9
#define BDRV_SECTOR_SIZE   (1 << BDRV_SECTOR_BITS)
#define BDRV_SECTOR_MASK   ~(BDRV_SECTOR_SIZE - 1);

void bdrv_info_print(Monitor *mon, const QObject *data);
void bdrv_info(Monitor *mon, QObject **ret_data);
void bdrv_info_stats(Monitor *mon);

void bdrv_init(void);
void bdrv_init_with_whitelist(void);
BlockDriver *bdrv_find_format(const char *format_name);
BlockDriver *bdrv_find_whitelisted_format(const char *format_name);
int bdrv_create(BlockDriver *drv, const char* filename,
    QEMUOptionParameter *options);
int bdrv_create2(BlockDriver *drv,
                 const char *filename, int64_t size_in_sectors,
                 const char *backing_file, const char *backing_format,
                 int flags);
BlockDriverState *bdrv_new(const char *device_name);
void bdrv_delete(BlockDriverState *bs);
int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags);
int bdrv_open(BlockDriverState *bs, const char *filename, int flags);
int bdrv_open2(BlockDriverState *bs, const char *filename, int flags,
               BlockDriver *drv);
void bdrv_close(BlockDriverState *bs);
int bdrv_check(BlockDriverState *bs);
int bdrv_read(BlockDriverState *bs, int64_t sector_num,
              uint8_t *buf, int nb_sectors);
int bdrv_write(BlockDriverState *bs, int64_t sector_num,
               const uint8_t *buf, int nb_sectors);
int bdrv_pread(BlockDriverState *bs, int64_t offset,
               void *buf, int count);
int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
                const void *buf, int count);
int bdrv_truncate(BlockDriverState *bs, int64_t offset);
int64_t bdrv_getlength(BlockDriverState *bs);
void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs);
int bdrv_commit(BlockDriverState *bs);
void bdrv_register(BlockDriver *bdrv);

/* async block I/O */
typedef struct BlockDriverAIOCB BlockDriverAIOCB;
typedef void BlockDriverCompletionFunc(void *opaque, int ret);
typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
				     int sector_num);
BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
                                 QEMUIOVector *iov, int nb_sectors,
                                 BlockDriverCompletionFunc *cb, void *opaque);
BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
                                  QEMUIOVector *iov, int nb_sectors,
                                  BlockDriverCompletionFunc *cb, void *opaque);
BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
				 BlockDriverCompletionFunc *cb, void *opaque);
void bdrv_aio_cancel(BlockDriverAIOCB *acb);

typedef struct BlockRequest {
    /* Fields to be filled by multiwrite caller */
    int64_t sector;
    int nb_sectors;
    QEMUIOVector *qiov;
    BlockDriverCompletionFunc *cb;
    void *opaque;

    /* Filled by multiwrite implementation */
    int error;
} BlockRequest;

int bdrv_aio_multiwrite(BlockDriverState *bs, BlockRequest *reqs,
    int num_reqs);

/* sg packet commands */
int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf);
BlockDriverAIOCB *bdrv_aio_ioctl(BlockDriverState *bs,
        unsigned long int req, void *buf,
        BlockDriverCompletionFunc *cb, void *opaque);

/* Ensure contents are flushed to disk.  */
void bdrv_flush(BlockDriverState *bs);
void bdrv_flush_all(void);

int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
	int *pnum);

#define BDRV_TYPE_HD     0
#define BDRV_TYPE_CDROM  1
#define BDRV_TYPE_FLOPPY 2
#define BIOS_ATA_TRANSLATION_AUTO   0
#define BIOS_ATA_TRANSLATION_NONE   1
#define BIOS_ATA_TRANSLATION_LBA    2
#define BIOS_ATA_TRANSLATION_LARGE  3
#define BIOS_ATA_TRANSLATION_RECHS  4

void bdrv_set_geometry_hint(BlockDriverState *bs,
                            int cyls, int heads, int secs);
void bdrv_set_type_hint(BlockDriverState *bs, int type);
void bdrv_set_translation_hint(BlockDriverState *bs, int translation);
void bdrv_get_geometry_hint(BlockDriverState *bs,
                            int *pcyls, int *pheads, int *psecs);
int bdrv_get_type_hint(BlockDriverState *bs);
int bdrv_get_translation_hint(BlockDriverState *bs);
int bdrv_is_removable(BlockDriverState *bs);
int bdrv_is_read_only(BlockDriverState *bs);
int bdrv_set_read_only(BlockDriverState *bs, int read_only);
int bdrv_is_sg(BlockDriverState *bs);
int bdrv_enable_write_cache(BlockDriverState *bs);
int bdrv_is_inserted(BlockDriverState *bs);
int bdrv_media_changed(BlockDriverState *bs);
int bdrv_is_locked(BlockDriverState *bs);
void bdrv_set_locked(BlockDriverState *bs, int locked);
int bdrv_eject(BlockDriverState *bs, int eject_flag);
void bdrv_set_change_cb(BlockDriverState *bs,
                        void (*change_cb)(void *opaque), void *opaque);
void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size);
BlockDriverState *bdrv_find(const char *name);
void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
                  void *opaque);
int bdrv_is_encrypted(BlockDriverState *bs);
int bdrv_key_required(BlockDriverState *bs);
int bdrv_set_key(BlockDriverState *bs, const char *key);
int bdrv_query_missing_keys(void);
void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
                         void *opaque);
const char *bdrv_get_device_name(BlockDriverState *bs);
int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
                          const uint8_t *buf, int nb_sectors);
int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi);

const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
void bdrv_get_backing_filename(BlockDriverState *bs,
                               char *filename, int filename_size);
int bdrv_snapshot_create(BlockDriverState *bs,
                         QEMUSnapshotInfo *sn_info);
int bdrv_snapshot_goto(BlockDriverState *bs,
                       const char *snapshot_id);
int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id);
int bdrv_snapshot_list(BlockDriverState *bs,
                       QEMUSnapshotInfo **psn_info);
char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn);

char *get_human_readable_size(char *buf, int buf_size, int64_t size);
int path_is_absolute(const char *path);
void path_combine(char *dest, int dest_size,
                  const char *base_path,
                  const char *filename);

int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
                      int64_t pos, int size);

int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
                      int64_t pos, int size);

#define BDRV_SECTORS_PER_DIRTY_CHUNK 2048

void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable);
int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
                      int nr_sectors);
#endif
Commit	Line	Data
faf07963 PB	1	#ifndef BLOCK_H
	2	#define BLOCK_H
	3
a76bab49	4	#include "qemu-aio.h"
3b69e4b9	5	#include "qemu-common.h"
0e7e1989	6	#include "qemu-option.h"
d15e5465	7	#include "qobject.h"
a76bab49	8
faf07963	9	/* block.c */
faf07963 PB	10	typedef struct BlockDriver BlockDriver;
faf07963 PB	11
faf07963 PB	12	typedef struct BlockDriverInfo {
	13	/* in bytes, 0 if irrelevant */
	14	int cluster_size;
	15	/* offset at which the VM state can be saved (0 if not possible) */
	16	int64_t vm_state_offset;
	17	} BlockDriverInfo;
	18
	19	typedef struct QEMUSnapshotInfo {
	20	char id_str[128]; /* unique snapshot id */
	21	/* the following fields are informative. They are not needed for
	22	the consistency of the snapshot */
	23	char name[256]; /* user choosen name */
	24	uint32_t vm_state_size; /* VM state info size */
	25	uint32_t date_sec; /* UTC date of the snapshot */
	26	uint32_t date_nsec;
	27	uint64_t vm_clock_nsec; /* VM clock relative to boot */
	28	} QEMUSnapshotInfo;
	29
	30	#define BDRV_O_RDONLY 0x0000
	31	#define BDRV_O_RDWR 0x0002
	32	#define BDRV_O_ACCESS 0x0003
	33	#define BDRV_O_CREAT 0x0004 /* create an empty file */
	34	#define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */
	35	#define BDRV_O_FILE 0x0010 /* open as a raw file (do not try to
	36	use a disk image format on top of
	37	it (default for
	38	bdrv_file_open()) */
9f7965c7 AL	39	#define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
9f7965c7 AL	40	#define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */
5c6c3a6c	41	#define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */
9f7965c7	42
0aa217e4	43	#define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE \| BDRV_O_CACHE_WB)
faf07963	44
6ea44308 JK	45	#define BDRV_SECTOR_BITS 9
	46	#define BDRV_SECTOR_SIZE (1 << BDRV_SECTOR_BITS)
	47	#define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1);
	48
d15e5465 LC	49	void bdrv_info_print(Monitor mon, const QObject data);
d15e5465 LC	50	void bdrv_info(Monitor mon, QObject *ret_data);
376253ec	51	void bdrv_info_stats(Monitor *mon);
faf07963 PB	52
faf07963 PB	53	void bdrv_init(void);
eb852011	54	void bdrv_init_with_whitelist(void);
faf07963	55	BlockDriver bdrv_find_format(const char format_name);
eb852011	56	BlockDriver bdrv_find_whitelisted_format(const char format_name);
0e7e1989 KW	57	int bdrv_create(BlockDriver drv, const char filename,
0e7e1989 KW	58	QEMUOptionParameter *options);
5eb45639 AL	59	int bdrv_create2(BlockDriver *drv,
	60	const char *filename, int64_t size_in_sectors,
	61	const char backing_file, const char backing_format,
	62	int flags);
faf07963 PB	63	BlockDriverState bdrv_new(const char device_name);
	64	void bdrv_delete(BlockDriverState *bs);
	65	int bdrv_file_open(BlockDriverState *pbs, const char filename, int flags);
	66	int bdrv_open(BlockDriverState bs, const char filename, int flags);
	67	int bdrv_open2(BlockDriverState bs, const char filename, int flags,
	68	BlockDriver *drv);
	69	void bdrv_close(BlockDriverState *bs);
e97fc193	70	int bdrv_check(BlockDriverState *bs);
faf07963 PB	71	int bdrv_read(BlockDriverState *bs, int64_t sector_num,
	72	uint8_t *buf, int nb_sectors);
	73	int bdrv_write(BlockDriverState *bs, int64_t sector_num,
	74	const uint8_t *buf, int nb_sectors);
	75	int bdrv_pread(BlockDriverState *bs, int64_t offset,
	76	void *buf, int count);
	77	int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
	78	const void *buf, int count);
	79	int bdrv_truncate(BlockDriverState *bs, int64_t offset);
	80	int64_t bdrv_getlength(BlockDriverState *bs);
96b8f136	81	void bdrv_get_geometry(BlockDriverState bs, uint64_t nb_sectors_ptr);
f3d54fc4	82	void bdrv_guess_geometry(BlockDriverState bs, int pcyls, int pheads, int psecs);
faf07963	83	int bdrv_commit(BlockDriverState *bs);
5efa9d5a AL	84	void bdrv_register(BlockDriver *bdrv);
5efa9d5a AL	85
faf07963 PB	86	/* async block I/O */
	87	typedef struct BlockDriverAIOCB BlockDriverAIOCB;
	88	typedef void BlockDriverCompletionFunc(void *opaque, int ret);
7cd1e32a	89	typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
7cd1e32a	90	int sector_num);
3b69e4b9 AL	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);
b2e12bc6 CH	97	BlockDriverAIOCB bdrv_aio_flush(BlockDriverState bs,
b2e12bc6 CH	98	BlockDriverCompletionFunc cb, void opaque);
faf07963 PB	99	void bdrv_aio_cancel(BlockDriverAIOCB *acb);
faf07963 PB	100
40b4f539 KW	101	typedef struct BlockRequest {
	102	/* Fields to be filled by multiwrite caller */
	103	int64_t sector;
	104	int nb_sectors;
	105	QEMUIOVector *qiov;
	106	BlockDriverCompletionFunc *cb;
	107	void *opaque;
	108
	109	/* Filled by multiwrite implementation */
	110	int error;
	111	} BlockRequest;
	112
	113	int bdrv_aio_multiwrite(BlockDriverState bs, BlockRequest reqs,
	114	int num_reqs);
	115
7d780669	116	/* sg packet commands */
221f715d AL	117	int bdrv_ioctl(BlockDriverState bs, unsigned long int req, void buf);
	118	BlockDriverAIOCB bdrv_aio_ioctl(BlockDriverState bs,
	119	unsigned long int req, void *buf,
	120	BlockDriverCompletionFunc cb, void opaque);
7d780669	121
faf07963 PB	122	/* Ensure contents are flushed to disk. */
faf07963 PB	123	void bdrv_flush(BlockDriverState *bs);
c6ca28d6 AL	124	void bdrv_flush_all(void);
c6ca28d6 AL	125
f58c7b35 TS	126	int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
f58c7b35 TS	127	int *pnum);
faf07963 PB	128
	129	#define BDRV_TYPE_HD 0
	130	#define BDRV_TYPE_CDROM 1
	131	#define BDRV_TYPE_FLOPPY 2
	132	#define BIOS_ATA_TRANSLATION_AUTO 0
	133	#define BIOS_ATA_TRANSLATION_NONE 1
	134	#define BIOS_ATA_TRANSLATION_LBA 2
	135	#define BIOS_ATA_TRANSLATION_LARGE 3
	136	#define BIOS_ATA_TRANSLATION_RECHS 4
	137
	138	void bdrv_set_geometry_hint(BlockDriverState *bs,
	139	int cyls, int heads, int secs);
	140	void bdrv_set_type_hint(BlockDriverState *bs, int type);
	141	void bdrv_set_translation_hint(BlockDriverState *bs, int translation);
	142	void bdrv_get_geometry_hint(BlockDriverState *bs,
	143	int pcyls, int pheads, int *psecs);
	144	int bdrv_get_type_hint(BlockDriverState *bs);
	145	int bdrv_get_translation_hint(BlockDriverState *bs);
	146	int bdrv_is_removable(BlockDriverState *bs);
	147	int bdrv_is_read_only(BlockDriverState *bs);
59f2689d	148	int bdrv_set_read_only(BlockDriverState *bs, int read_only);
985a03b0	149	int bdrv_is_sg(BlockDriverState *bs);
e900a7b7	150	int bdrv_enable_write_cache(BlockDriverState *bs);
faf07963 PB	151	int bdrv_is_inserted(BlockDriverState *bs);
	152	int bdrv_media_changed(BlockDriverState *bs);
	153	int bdrv_is_locked(BlockDriverState *bs);
	154	void bdrv_set_locked(BlockDriverState *bs, int locked);
aea2a33c	155	int bdrv_eject(BlockDriverState *bs, int eject_flag);
faf07963 PB	156	void bdrv_set_change_cb(BlockDriverState *bs,
	157	void (change_cb)(void opaque), void *opaque);
	158	void bdrv_get_format(BlockDriverState bs, char buf, int buf_size);
	159	BlockDriverState bdrv_find(const char name);
51de9760 AL	160	void bdrv_iterate(void (it)(void opaque, BlockDriverState *bs),
51de9760 AL	161	void *opaque);
faf07963	162	int bdrv_is_encrypted(BlockDriverState *bs);
c0f4ce77	163	int bdrv_key_required(BlockDriverState *bs);
faf07963	164	int bdrv_set_key(BlockDriverState bs, const char key);
c0f4ce77	165	int bdrv_query_missing_keys(void);
faf07963 PB	166	void bdrv_iterate_format(void (it)(void opaque, const char *name),
	167	void *opaque);
	168	const char bdrv_get_device_name(BlockDriverState bs);
	169	int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
	170	const uint8_t *buf, int nb_sectors);
	171	int bdrv_get_info(BlockDriverState bs, BlockDriverInfo bdi);
	172
045df330	173	const char bdrv_get_encrypted_filename(BlockDriverState bs);
faf07963 PB	174	void bdrv_get_backing_filename(BlockDriverState *bs,
	175	char *filename, int filename_size);
	176	int bdrv_snapshot_create(BlockDriverState *bs,
	177	QEMUSnapshotInfo *sn_info);
	178	int bdrv_snapshot_goto(BlockDriverState *bs,
	179	const char *snapshot_id);
	180	int bdrv_snapshot_delete(BlockDriverState bs, const char snapshot_id);
	181	int bdrv_snapshot_list(BlockDriverState *bs,
	182	QEMUSnapshotInfo **psn_info);
	183	char bdrv_snapshot_dump(char buf, int buf_size, QEMUSnapshotInfo *sn);
	184
	185	char get_human_readable_size(char buf, int buf_size, int64_t size);
	186	int path_is_absolute(const char *path);
	187	void path_combine(char *dest, int dest_size,
	188	const char *base_path,
	189	const char *filename);
	190
45566e9c CH	191	int bdrv_save_vmstate(BlockDriverState bs, const uint8_t buf,
45566e9c CH	192	int64_t pos, int size);
178e08a5	193
45566e9c CH	194	int bdrv_load_vmstate(BlockDriverState bs, uint8_t buf,
45566e9c CH	195	int64_t pos, int size);
178e08a5	196
23bd90d2	197	#define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
6ea44308	198
7cd1e32a	199	void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable);
7cd1e32a	200	int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
a55eb92c JK	201	void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
a55eb92c JK	202	int nr_sectors);
faf07963	203	#endif