2007-11-11 03:51:17 +01:00
|
|
|
#ifndef BLOCK_H
|
|
|
|
#define BLOCK_H
|
|
|
|
|
2008-09-22 21:17:18 +02:00
|
|
|
#include "qemu-aio.h"
|
2009-01-22 17:59:24 +01:00
|
|
|
#include "qemu-common.h"
|
2009-05-18 16:42:10 +02:00
|
|
|
#include "qemu-option.h"
|
2009-12-10 20:16:06 +01:00
|
|
|
#include "qobject.h"
|
2008-09-22 21:17:18 +02:00
|
|
|
|
2007-11-11 03:51:17 +01:00
|
|
|
/* 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_RDWR 0x0002
|
|
|
|
#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()) */
|
2008-10-14 16:42:54 +02:00
|
|
|
#define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
|
|
|
|
#define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */
|
2009-08-20 16:58:35 +02:00
|
|
|
#define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */
|
2010-01-12 12:55:16 +01:00
|
|
|
#define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */
|
2008-10-14 16:42:54 +02:00
|
|
|
|
2009-06-30 13:06:04 +02:00
|
|
|
#define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE | BDRV_O_CACHE_WB)
|
2007-11-11 03:51:17 +01:00
|
|
|
|
2009-11-30 18:21:19 +01:00
|
|
|
#define BDRV_SECTOR_BITS 9
|
|
|
|
#define BDRV_SECTOR_SIZE (1 << BDRV_SECTOR_BITS)
|
|
|
|
#define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1);
|
|
|
|
|
2009-12-10 20:16:06 +01:00
|
|
|
void bdrv_info_print(Monitor *mon, const QObject *data);
|
|
|
|
void bdrv_info(Monitor *mon, QObject **ret_data);
|
2009-12-10 20:16:07 +01:00
|
|
|
void bdrv_stats_print(Monitor *mon, const QObject *data);
|
|
|
|
void bdrv_info_stats(Monitor *mon, QObject **ret_data);
|
2007-11-11 03:51:17 +01:00
|
|
|
|
|
|
|
void bdrv_init(void);
|
2009-10-27 18:41:44 +01:00
|
|
|
void bdrv_init_with_whitelist(void);
|
2007-11-11 03:51:17 +01:00
|
|
|
BlockDriver *bdrv_find_format(const char *format_name);
|
2009-10-27 18:41:44 +01:00
|
|
|
BlockDriver *bdrv_find_whitelisted_format(const char *format_name);
|
2009-05-18 16:42:10 +02:00
|
|
|
int bdrv_create(BlockDriver *drv, const char* filename,
|
|
|
|
QEMUOptionParameter *options);
|
2009-03-28 18:55:10 +01:00
|
|
|
int bdrv_create2(BlockDriver *drv,
|
|
|
|
const char *filename, int64_t size_in_sectors,
|
|
|
|
const char *backing_file, const char *backing_format,
|
|
|
|
int flags);
|
2007-11-11 03:51:17 +01:00
|
|
|
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);
|
2009-04-22 01:11:50 +02:00
|
|
|
int bdrv_check(BlockDriverState *bs);
|
2007-11-11 03:51:17 +01:00
|
|
|
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);
|
2007-12-17 02:35:20 +01:00
|
|
|
void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr);
|
2008-11-25 22:50:24 +01:00
|
|
|
void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs);
|
2007-11-11 03:51:17 +01:00
|
|
|
int bdrv_commit(BlockDriverState *bs);
|
2010-01-12 12:55:17 +01:00
|
|
|
int bdrv_change_backing_file(BlockDriverState *bs,
|
|
|
|
const char *backing_file, const char *backing_fmt);
|
2009-05-10 00:03:42 +02:00
|
|
|
void bdrv_register(BlockDriver *bdrv);
|
|
|
|
|
2007-11-11 03:51:17 +01:00
|
|
|
/* async block I/O */
|
|
|
|
typedef struct BlockDriverAIOCB BlockDriverAIOCB;
|
|
|
|
typedef void BlockDriverCompletionFunc(void *opaque, int ret);
|
2009-11-02 14:40:41 +01:00
|
|
|
typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
|
|
|
|
int sector_num);
|
2009-01-22 17:59:24 +01:00
|
|
|
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);
|
2009-09-04 19:01:49 +02:00
|
|
|
BlockDriverAIOCB *bdrv_aio_flush(BlockDriverState *bs,
|
|
|
|
BlockDriverCompletionFunc *cb, void *opaque);
|
2007-11-11 03:51:17 +01:00
|
|
|
void bdrv_aio_cancel(BlockDriverAIOCB *acb);
|
|
|
|
|
2009-09-09 17:53:37 +02:00
|
|
|
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);
|
|
|
|
|
2009-03-12 20:57:08 +01:00
|
|
|
/* sg packet commands */
|
2009-03-28 18:28:41 +01:00
|
|
|
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);
|
2009-03-12 20:57:08 +01:00
|
|
|
|
2007-11-11 03:51:17 +01:00
|
|
|
/* Ensure contents are flushed to disk. */
|
|
|
|
void bdrv_flush(BlockDriverState *bs);
|
2008-10-06 15:55:43 +02:00
|
|
|
void bdrv_flush_all(void);
|
|
|
|
|
2008-06-05 23:53:49 +02:00
|
|
|
int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
|
|
|
|
int *pnum);
|
2007-11-11 03:51:17 +01:00
|
|
|
|
|
|
|
#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);
|
2009-10-26 15:25:16 +01:00
|
|
|
int bdrv_set_read_only(BlockDriverState *bs, int read_only);
|
2007-12-24 17:10:43 +01:00
|
|
|
int bdrv_is_sg(BlockDriverState *bs);
|
2009-09-04 19:01:15 +02:00
|
|
|
int bdrv_enable_write_cache(BlockDriverState *bs);
|
2007-11-11 03:51:17 +01:00
|
|
|
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);
|
2009-05-27 11:06:11 +02:00
|
|
|
int bdrv_eject(BlockDriverState *bs, int eject_flag);
|
2007-11-11 03:51:17 +01:00
|
|
|
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);
|
2009-03-06 00:00:43 +01:00
|
|
|
void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs),
|
|
|
|
void *opaque);
|
2007-11-11 03:51:17 +01:00
|
|
|
int bdrv_is_encrypted(BlockDriverState *bs);
|
2009-03-06 00:01:01 +01:00
|
|
|
int bdrv_key_required(BlockDriverState *bs);
|
2007-11-11 03:51:17 +01:00
|
|
|
int bdrv_set_key(BlockDriverState *bs, const char *key);
|
2009-03-06 00:01:01 +01:00
|
|
|
int bdrv_query_missing_keys(void);
|
2007-11-11 03:51:17 +01:00
|
|
|
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);
|
|
|
|
|
2009-03-06 00:00:48 +01:00
|
|
|
const char *bdrv_get_encrypted_filename(BlockDriverState *bs);
|
2007-11-11 03:51:17 +01:00
|
|
|
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);
|
|
|
|
|
2009-07-10 23:11:57 +02:00
|
|
|
int bdrv_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
|
|
|
|
int64_t pos, int size);
|
2009-04-05 21:10:55 +02:00
|
|
|
|
2009-07-10 23:11:57 +02:00
|
|
|
int bdrv_load_vmstate(BlockDriverState *bs, uint8_t *buf,
|
|
|
|
int64_t pos, int size);
|
2009-04-05 21:10:55 +02:00
|
|
|
|
2009-11-30 18:21:22 +01:00
|
|
|
#define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
|
2009-11-30 18:21:19 +01:00
|
|
|
|
2009-11-02 14:40:41 +01:00
|
|
|
void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable);
|
|
|
|
int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
|
2009-11-30 18:21:19 +01:00
|
|
|
void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
|
|
|
|
int nr_sectors);
|
2007-11-11 03:51:17 +01:00
|
|
|
#endif
|