[qemu.git] / block.h

#ifndef BLOCK_H
#define BLOCK_H

#include "qemu-aio.h"
#include "qemu-common.h"
#include "qemu-option.h"
#include "qemu-coroutine.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 chosen name */
    uint64_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;

/* Callbacks for block device models */
typedef struct BlockDevOps {
    /*
     * Runs when virtual media changed (monitor commands eject, change)
     * Argument load is true on load and false on eject.
     * Beware: doesn't run when a host device's physical media
     * changes.  Sure would be useful if it did.
     * Device models with removable media must implement this callback.
     */
    void (*change_media_cb)(void *opaque, bool load);
    /*
     * Runs when an eject request is issued from the monitor, the tray
     * is closed, and the medium is locked.
     * Device models that do not implement is_medium_locked will not need
     * this callback.  Device models that can lock the medium or tray might
     * want to implement the callback and unlock the tray when "force" is
     * true, even if they do not support eject requests.
     */
    void (*eject_request_cb)(void *opaque, bool force);
    /*
     * Is the virtual tray open?
     * Device models implement this only when the device has a tray.
     */
    bool (*is_tray_open)(void *opaque);
    /*
     * Is the virtual medium locked into the device?
     * Device models implement this only when device has such a lock.
     */
    bool (*is_medium_locked)(void *opaque);
    /*
     * Runs when the size changed (e.g. monitor command block_resize)
     */
    void (*resize_cb)(void *opaque);
} BlockDevOps;

#define BDRV_O_RDWR        0x0002
#define BDRV_O_SNAPSHOT    0x0008 /* open the file read only and save writes in a snapshot */
#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_NO_BACKING  0x0100 /* don't open the backing file */
#define BDRV_O_NO_FLUSH    0x0200 /* disable flushing on this disk */
#define BDRV_O_COPY_ON_READ 0x0400 /* copy read backing sectors into image */

#define BDRV_O_CACHE_MASK  (BDRV_O_NOCACHE | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH)

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

typedef enum {
    BLOCK_ERR_REPORT, BLOCK_ERR_IGNORE, BLOCK_ERR_STOP_ENOSPC,
    BLOCK_ERR_STOP_ANY
} BlockErrorAction;

typedef enum {
    BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP
} BlockQMPEventAction;

void bdrv_iostatus_enable(BlockDriverState *bs);
void bdrv_iostatus_reset(BlockDriverState *bs);
void bdrv_iostatus_disable(BlockDriverState *bs);
bool bdrv_iostatus_is_enabled(const BlockDriverState *bs);
void bdrv_iostatus_set_err(BlockDriverState *bs, int error);
void bdrv_emit_qmp_error_event(const BlockDriverState *bdrv,
                               BlockQMPEventAction action, int is_read);
void bdrv_info_print(Monitor *mon, const QObject *data);
void bdrv_info(Monitor *mon, QObject **ret_data);
void bdrv_stats_print(Monitor *mon, const QObject *data);
void bdrv_info_stats(Monitor *mon, QObject **ret_data);

/* disk I/O throttling */
void bdrv_io_limits_enable(BlockDriverState *bs);
void bdrv_io_limits_disable(BlockDriverState *bs);
bool bdrv_io_limits_enabled(BlockDriverState *bs);

void bdrv_init(void);
void bdrv_init_with_whitelist(void);
BlockDriver *bdrv_find_protocol(const char *filename);
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_create_file(const char* filename, QEMUOptionParameter *options);
BlockDriverState *bdrv_new(const char *device_name);
void bdrv_make_anon(BlockDriverState *bs);
void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top);
void bdrv_delete(BlockDriverState *bs);
int bdrv_parse_cache_flags(const char *mode, int *flags);
int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags);
int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
              BlockDriver *drv);
void bdrv_close(BlockDriverState *bs);
int bdrv_attach_dev(BlockDriverState *bs, void *dev);
void bdrv_attach_dev_nofail(BlockDriverState *bs, void *dev);
void bdrv_detach_dev(BlockDriverState *bs, void *dev);
void *bdrv_get_attached_dev(BlockDriverState *bs);
void bdrv_set_dev_ops(BlockDriverState *bs, const BlockDevOps *ops,
                      void *opaque);
void bdrv_dev_eject_request(BlockDriverState *bs, bool force);
bool bdrv_dev_has_removable_media(BlockDriverState *bs);
bool bdrv_dev_is_tray_open(BlockDriverState *bs);
bool bdrv_dev_is_medium_locked(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_pwrite_sync(BlockDriverState *bs, int64_t offset,
    const void *buf, int count);
int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
    int nb_sectors, QEMUIOVector *qiov);
int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
    int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
    int nb_sectors, QEMUIOVector *qiov);
/*
 * Efficiently zero a region of the disk image.  Note that this is a regular
 * I/O request like read or write and should have a reasonable size.  This
 * function is not suitable for zeroing the entire image in a single request
 * because it may allocate memory for the entire region.
 */
int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs, int64_t sector_num,
    int nb_sectors);
int coroutine_fn bdrv_co_is_allocated(BlockDriverState *bs, int64_t sector_num,
    int nb_sectors, int *pnum);
BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
    const char *backing_file);
int bdrv_truncate(BlockDriverState *bs, int64_t offset);
int64_t bdrv_getlength(BlockDriverState *bs);
int64_t bdrv_get_allocated_file_size(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);
int bdrv_commit_all(void);
int bdrv_change_backing_file(BlockDriverState *bs,
    const char *backing_file, const char *backing_fmt);
void bdrv_register(BlockDriver *bdrv);


typedef struct BdrvCheckResult {
    int corruptions;
    int leaks;
    int check_errors;
} BdrvCheckResult;

int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res);

/* 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);
BlockDriverAIOCB *bdrv_aio_discard(BlockDriverState *bs,
                                   int64_t sector_num, int nb_sectors,
                                   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);

/* Invalidate any cached metadata used by image formats */
void bdrv_invalidate_cache(BlockDriverState *bs);
void bdrv_invalidate_cache_all(void);

/* Ensure contents are flushed to disk.  */
int bdrv_flush(BlockDriverState *bs);
int coroutine_fn bdrv_co_flush(BlockDriverState *bs);
void bdrv_flush_all(void);
void bdrv_close_all(void);
void bdrv_drain_all(void);

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

#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_translation_hint(BlockDriverState *bs, int translation);
void bdrv_get_geometry_hint(BlockDriverState *bs,
                            int *pcyls, int *pheads, int *psecs);
typedef enum FDriveType {
    FDRIVE_DRV_144  = 0x00,   /* 1.44 MB 3"5 drive      */
    FDRIVE_DRV_288  = 0x01,   /* 2.88 MB 3"5 drive      */
    FDRIVE_DRV_120  = 0x02,   /* 1.2  MB 5"25 drive     */
    FDRIVE_DRV_NONE = 0x03,   /* No drive connected     */
} FDriveType;

typedef enum FDriveRate {
    FDRIVE_RATE_500K = 0x00,  /* 500 Kbps */
    FDRIVE_RATE_300K = 0x01,  /* 300 Kbps */
    FDRIVE_RATE_250K = 0x02,  /* 250 Kbps */
    FDRIVE_RATE_1M   = 0x03,  /*   1 Mbps */
} FDriveRate;

void bdrv_get_floppy_geometry_hint(BlockDriverState *bs, int *nb_heads,
                                   int *max_track, int *last_sect,
                                   FDriveType drive_in, FDriveType *drive,
                                   FDriveRate *rate);
int bdrv_get_translation_hint(BlockDriverState *bs);
void bdrv_set_on_error(BlockDriverState *bs, BlockErrorAction on_read_error,
                       BlockErrorAction on_write_error);
BlockErrorAction bdrv_get_on_error(BlockDriverState *bs, int is_read);
int bdrv_is_read_only(BlockDriverState *bs);
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);
void bdrv_lock_medium(BlockDriverState *bs, bool locked);
void bdrv_eject(BlockDriverState *bs, bool eject_flag);
void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size);
BlockDriverState *bdrv_find(const char *name);
BlockDriverState *bdrv_next(BlockDriverState *bs);
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_can_snapshot(BlockDriverState *bs);
int bdrv_is_snapshot(BlockDriverState *bs);
BlockDriverState *bdrv_snapshots(void);
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);
int bdrv_snapshot_load_tmp(BlockDriverState *bs,
                           const char *snapshot_name);
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);

int bdrv_img_create(const char *filename, const char *fmt,
                    const char *base_filename, const char *base_fmt,
                    char *options, uint64_t img_size, int flags);

void bdrv_set_buffer_alignment(BlockDriverState *bs, int align);
void *qemu_blockalign(BlockDriverState *bs, size_t 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);
int64_t bdrv_get_dirty_count(BlockDriverState *bs);

void bdrv_enable_copy_on_read(BlockDriverState *bs);
void bdrv_disable_copy_on_read(BlockDriverState *bs);

void bdrv_set_in_use(BlockDriverState *bs, int in_use);
int bdrv_in_use(BlockDriverState *bs);

enum BlockAcctType {
    BDRV_ACCT_READ,
    BDRV_ACCT_WRITE,
    BDRV_ACCT_FLUSH,
    BDRV_MAX_IOTYPE,
};

typedef struct BlockAcctCookie {
    int64_t bytes;
    int64_t start_time_ns;
    enum BlockAcctType type;
} BlockAcctCookie;

void bdrv_acct_start(BlockDriverState *bs, BlockAcctCookie *cookie,
        int64_t bytes, enum BlockAcctType type);
void bdrv_acct_done(BlockDriverState *bs, BlockAcctCookie *cookie);

typedef enum {
    BLKDBG_L1_UPDATE,

    BLKDBG_L1_GROW_ALLOC_TABLE,
    BLKDBG_L1_GROW_WRITE_TABLE,
    BLKDBG_L1_GROW_ACTIVATE_TABLE,

    BLKDBG_L2_LOAD,
    BLKDBG_L2_UPDATE,
    BLKDBG_L2_UPDATE_COMPRESSED,
    BLKDBG_L2_ALLOC_COW_READ,
    BLKDBG_L2_ALLOC_WRITE,

    BLKDBG_READ,
    BLKDBG_READ_AIO,
    BLKDBG_READ_BACKING,
    BLKDBG_READ_BACKING_AIO,
    BLKDBG_READ_COMPRESSED,

    BLKDBG_WRITE_AIO,
    BLKDBG_WRITE_COMPRESSED,

    BLKDBG_VMSTATE_LOAD,
    BLKDBG_VMSTATE_SAVE,

    BLKDBG_COW_READ,
    BLKDBG_COW_WRITE,

    BLKDBG_REFTABLE_LOAD,
    BLKDBG_REFTABLE_GROW,

    BLKDBG_REFBLOCK_LOAD,
    BLKDBG_REFBLOCK_UPDATE,
    BLKDBG_REFBLOCK_UPDATE_PART,
    BLKDBG_REFBLOCK_ALLOC,
    BLKDBG_REFBLOCK_ALLOC_HOOKUP,
    BLKDBG_REFBLOCK_ALLOC_WRITE,
    BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
    BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
    BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,

    BLKDBG_CLUSTER_ALLOC,
    BLKDBG_CLUSTER_ALLOC_BYTES,
    BLKDBG_CLUSTER_FREE,

    BLKDBG_EVENT_MAX,
} BlkDebugEvent;

#define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);


/* Convenience for block device models */

typedef struct BlockConf {
    BlockDriverState *bs;
    uint16_t physical_block_size;
    uint16_t logical_block_size;
    uint16_t min_io_size;
    uint32_t opt_io_size;
    int32_t bootindex;
    uint32_t discard_granularity;
} BlockConf;

static inline unsigned int get_physical_block_exp(BlockConf *conf)
{
    unsigned int exp = 0, size;

    for (size = conf->physical_block_size;
        size > conf->logical_block_size;
        size >>= 1) {
        exp++;
    }

    return exp;
}

#define DEFINE_BLOCK_PROPERTIES(_state, _conf)                          \
    DEFINE_PROP_DRIVE("drive", _state, _conf.bs),                       \
    DEFINE_PROP_UINT16("logical_block_size", _state,                    \
                       _conf.logical_block_size, 512),                  \
    DEFINE_PROP_UINT16("physical_block_size", _state,                   \
                       _conf.physical_block_size, 512),                 \
    DEFINE_PROP_UINT16("min_io_size", _state, _conf.min_io_size, 0),  \
    DEFINE_PROP_UINT32("opt_io_size", _state, _conf.opt_io_size, 0),    \
    DEFINE_PROP_INT32("bootindex", _state, _conf.bootindex, -1),        \
    DEFINE_PROP_UINT32("discard_granularity", _state, \
                       _conf.discard_granularity, 0)

#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"
da1fa91d	7	#include "qemu-coroutine.h"
d15e5465	8	#include "qobject.h"
a76bab49	9
faf07963	10	/* block.c */
faf07963 PB	11	typedef struct BlockDriver BlockDriver;
faf07963 PB	12
faf07963 PB	13	typedef struct BlockDriverInfo {
	14	/* in bytes, 0 if irrelevant */
	15	int cluster_size;
	16	/* offset at which the VM state can be saved (0 if not possible) */
	17	int64_t vm_state_offset;
	18	} BlockDriverInfo;
	19
	20	typedef struct QEMUSnapshotInfo {
	21	char id_str[128]; /* unique snapshot id */
	22	/* the following fields are informative. They are not needed for
	23	the consistency of the snapshot */
e7d81004	24	char name[256]; /* user chosen name */
c2c9a466	25	uint64_t vm_state_size; /* VM state info size */
faf07963 PB	26	uint32_t date_sec; /* UTC date of the snapshot */
	27	uint32_t date_nsec;
	28	uint64_t vm_clock_nsec; /* VM clock relative to boot */
	29	} QEMUSnapshotInfo;
	30
145feb17	31	/* Callbacks for block device models */
0e49de52	32	typedef struct BlockDevOps {
145feb17 MA	33	/*
145feb17 MA	34	* Runs when virtual media changed (monitor commands eject, change)
7d4b4ba5	35	* Argument load is true on load and false on eject.
145feb17 MA	36	* Beware: doesn't run when a host device's physical media
145feb17 MA	37	* changes. Sure would be useful if it did.
2c6942fa	38	* Device models with removable media must implement this callback.
145feb17	39	*/
7d4b4ba5	40	void (change_media_cb)(void opaque, bool load);
025ccaa7 PB	41	/*
	42	* Runs when an eject request is issued from the monitor, the tray
	43	* is closed, and the medium is locked.
	44	* Device models that do not implement is_medium_locked will not need
	45	* this callback. Device models that can lock the medium or tray might
	46	* want to implement the callback and unlock the tray when "force" is
	47	* true, even if they do not support eject requests.
	48	*/
	49	void (eject_request_cb)(void opaque, bool force);
e4def80b MA	50	/*
	51	* Is the virtual tray open?
	52	* Device models implement this only when the device has a tray.
	53	*/
	54	bool (is_tray_open)(void opaque);
f107639a MA	55	/*
	56	* Is the virtual medium locked into the device?
	57	* Device models implement this only when device has such a lock.
	58	*/
	59	bool (is_medium_locked)(void opaque);
145feb17 MA	60	/*
	61	* Runs when the size changed (e.g. monitor command block_resize)
	62	*/
	63	void (resize_cb)(void opaque);
0e49de52 MA	64	} BlockDevOps;
0e49de52 MA	65
faf07963	66	#define BDRV_O_RDWR 0x0002
faf07963	67	#define BDRV_O_SNAPSHOT 0x0008 /* open the file read only and save writes in a snapshot */
9f7965c7 AL	68	#define BDRV_O_NOCACHE 0x0020 /* do not use the host page cache */
9f7965c7 AL	69	#define BDRV_O_CACHE_WB 0x0040 /* use write-back caching */
5c6c3a6c	70	#define BDRV_O_NATIVE_AIO 0x0080 /* use native AIO instead of the thread pool */
b783e409	71	#define BDRV_O_NO_BACKING 0x0100 /* don't open the backing file */
016f5cf6	72	#define BDRV_O_NO_FLUSH 0x0200 /* disable flushing on this disk */
53fec9d3	73	#define BDRV_O_COPY_ON_READ 0x0400 /* copy read backing sectors into image */
9f7965c7	74
ceb25e5c	75	#define BDRV_O_CACHE_MASK (BDRV_O_NOCACHE \| BDRV_O_CACHE_WB \| BDRV_O_NO_FLUSH)
faf07963	76
6ea44308	77	#define BDRV_SECTOR_BITS 9
c63782cb	78	#define BDRV_SECTOR_SIZE (1ULL << BDRV_SECTOR_BITS)
3abbc4d9	79	#define BDRV_SECTOR_MASK ~(BDRV_SECTOR_SIZE - 1)
6ea44308	80
abd7f68d MA	81	typedef enum {
	82	BLOCK_ERR_REPORT, BLOCK_ERR_IGNORE, BLOCK_ERR_STOP_ENOSPC,
	83	BLOCK_ERR_STOP_ANY
	84	} BlockErrorAction;
	85
2582bfed LC	86	typedef enum {
2582bfed LC	87	BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP
329c0a48	88	} BlockQMPEventAction;
2582bfed	89
28a7282a LC	90	void bdrv_iostatus_enable(BlockDriverState *bs);
	91	void bdrv_iostatus_reset(BlockDriverState *bs);
	92	void bdrv_iostatus_disable(BlockDriverState *bs);
	93	bool bdrv_iostatus_is_enabled(const BlockDriverState *bs);
	94	void bdrv_iostatus_set_err(BlockDriverState *bs, int error);
329c0a48 LC	95	void bdrv_emit_qmp_error_event(const BlockDriverState *bdrv,
329c0a48 LC	96	BlockQMPEventAction action, int is_read);
d15e5465 LC	97	void bdrv_info_print(Monitor mon, const QObject data);
d15e5465 LC	98	void bdrv_info(Monitor mon, QObject *ret_data);
218a536a LC	99	void bdrv_stats_print(Monitor mon, const QObject data);
218a536a LC	100	void bdrv_info_stats(Monitor mon, QObject *ret_data);
faf07963	101
0563e191 ZYW	102	/* disk I/O throttling */
0563e191 ZYW	103	void bdrv_io_limits_enable(BlockDriverState *bs);
98f90dba	104	void bdrv_io_limits_disable(BlockDriverState *bs);
0563e191 ZYW	105	bool bdrv_io_limits_enabled(BlockDriverState *bs);
0563e191 ZYW	106
faf07963	107	void bdrv_init(void);
eb852011	108	void bdrv_init_with_whitelist(void);
b50cbabc	109	BlockDriver bdrv_find_protocol(const char filename);
faf07963	110	BlockDriver bdrv_find_format(const char format_name);
eb852011	111	BlockDriver bdrv_find_whitelisted_format(const char format_name);
0e7e1989 KW	112	int bdrv_create(BlockDriver drv, const char filename,
0e7e1989 KW	113	QEMUOptionParameter *options);
84a12e66	114	int bdrv_create_file(const char* filename, QEMUOptionParameter *options);
faf07963	115	BlockDriverState bdrv_new(const char device_name);
d22b2f41	116	void bdrv_make_anon(BlockDriverState *bs);
8802d1fd	117	void bdrv_append(BlockDriverState bs_new, BlockDriverState bs_top);
faf07963	118	void bdrv_delete(BlockDriverState *bs);
c3993cdc	119	int bdrv_parse_cache_flags(const char mode, int flags);
faf07963	120	int bdrv_file_open(BlockDriverState *pbs, const char filename, int flags);
d6e9098e KW	121	int bdrv_open(BlockDriverState bs, const char filename, int flags,
d6e9098e KW	122	BlockDriver *drv);
faf07963	123	void bdrv_close(BlockDriverState *bs);
fa879d62 MA	124	int bdrv_attach_dev(BlockDriverState bs, void dev);
	125	void bdrv_attach_dev_nofail(BlockDriverState bs, void dev);
	126	void bdrv_detach_dev(BlockDriverState bs, void dev);
	127	void bdrv_get_attached_dev(BlockDriverState bs);
0e49de52 MA	128	void bdrv_set_dev_ops(BlockDriverState bs, const BlockDevOps ops,
0e49de52 MA	129	void *opaque);
025ccaa7	130	void bdrv_dev_eject_request(BlockDriverState *bs, bool force);
2c6942fa	131	bool bdrv_dev_has_removable_media(BlockDriverState *bs);
e4def80b	132	bool bdrv_dev_is_tray_open(BlockDriverState *bs);
f107639a	133	bool bdrv_dev_is_medium_locked(BlockDriverState *bs);
faf07963 PB	134	int bdrv_read(BlockDriverState *bs, int64_t sector_num,
	135	uint8_t *buf, int nb_sectors);
	136	int bdrv_write(BlockDriverState *bs, int64_t sector_num,
	137	const uint8_t *buf, int nb_sectors);
	138	int bdrv_pread(BlockDriverState *bs, int64_t offset,
	139	void *buf, int count);
	140	int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
	141	const void *buf, int count);
f08145fe KW	142	int bdrv_pwrite_sync(BlockDriverState *bs, int64_t offset,
f08145fe KW	143	const void *buf, int count);
da1fa91d KW	144	int coroutine_fn bdrv_co_readv(BlockDriverState *bs, int64_t sector_num,
da1fa91d KW	145	int nb_sectors, QEMUIOVector *qiov);
470c0504 SH	146	int coroutine_fn bdrv_co_copy_on_readv(BlockDriverState *bs,
470c0504 SH	147	int64_t sector_num, int nb_sectors, QEMUIOVector *qiov);
da1fa91d KW	148	int coroutine_fn bdrv_co_writev(BlockDriverState *bs, int64_t sector_num,
da1fa91d KW	149	int nb_sectors, QEMUIOVector *qiov);
f08f2dda SH	150	/*
	151	* Efficiently zero a region of the disk image. Note that this is a regular
	152	* I/O request like read or write and should have a reasonable size. This
	153	* function is not suitable for zeroing the entire image in a single request
	154	* because it may allocate memory for the entire region.
	155	*/
	156	int coroutine_fn bdrv_co_write_zeroes(BlockDriverState *bs, int64_t sector_num,
	157	int nb_sectors);
060f51c9 SH	158	int coroutine_fn bdrv_co_is_allocated(BlockDriverState *bs, int64_t sector_num,
060f51c9 SH	159	int nb_sectors, int *pnum);
e8a6bb9c MT	160	BlockDriverState bdrv_find_backing_image(BlockDriverState bs,
e8a6bb9c MT	161	const char *backing_file);
faf07963 PB	162	int bdrv_truncate(BlockDriverState *bs, int64_t offset);
faf07963 PB	163	int64_t bdrv_getlength(BlockDriverState *bs);
4a1d5e1f	164	int64_t bdrv_get_allocated_file_size(BlockDriverState *bs);
96b8f136	165	void bdrv_get_geometry(BlockDriverState bs, uint64_t nb_sectors_ptr);
f3d54fc4	166	void bdrv_guess_geometry(BlockDriverState bs, int pcyls, int pheads, int psecs);
faf07963	167	int bdrv_commit(BlockDriverState *bs);
e8877497	168	int bdrv_commit_all(void);
756e6736 KW	169	int bdrv_change_backing_file(BlockDriverState *bs,
756e6736 KW	170	const char backing_file, const char backing_fmt);
5efa9d5a AL	171	void bdrv_register(BlockDriver *bdrv);
5efa9d5a AL	172
e076f338 KW	173
	174	typedef struct BdrvCheckResult {
	175	int corruptions;
	176	int leaks;
	177	int check_errors;
	178	} BdrvCheckResult;
	179
	180	int bdrv_check(BlockDriverState bs, BdrvCheckResult res);
	181
faf07963 PB	182	/* async block I/O */
	183	typedef struct BlockDriverAIOCB BlockDriverAIOCB;
	184	typedef void BlockDriverCompletionFunc(void *opaque, int ret);
7cd1e32a	185	typedef void BlockDriverDirtyHandler(BlockDriverState *bs, int64_t sector,
39aa9a12	186	int sector_num);
3b69e4b9 AL	187	BlockDriverAIOCB bdrv_aio_readv(BlockDriverState bs, int64_t sector_num,
	188	QEMUIOVector *iov, int nb_sectors,
	189	BlockDriverCompletionFunc cb, void opaque);
	190	BlockDriverAIOCB bdrv_aio_writev(BlockDriverState bs, int64_t sector_num,
	191	QEMUIOVector *iov, int nb_sectors,
	192	BlockDriverCompletionFunc cb, void opaque);
b2e12bc6	193	BlockDriverAIOCB bdrv_aio_flush(BlockDriverState bs,
39aa9a12	194	BlockDriverCompletionFunc cb, void opaque);
4265d620 PB	195	BlockDriverAIOCB bdrv_aio_discard(BlockDriverState bs,
	196	int64_t sector_num, int nb_sectors,
	197	BlockDriverCompletionFunc cb, void opaque);
faf07963 PB	198	void bdrv_aio_cancel(BlockDriverAIOCB *acb);
faf07963 PB	199
40b4f539 KW	200	typedef struct BlockRequest {
	201	/* Fields to be filled by multiwrite caller */
	202	int64_t sector;
	203	int nb_sectors;
	204	QEMUIOVector *qiov;
	205	BlockDriverCompletionFunc *cb;
	206	void *opaque;
	207
	208	/* Filled by multiwrite implementation */
	209	int error;
	210	} BlockRequest;
	211
	212	int bdrv_aio_multiwrite(BlockDriverState bs, BlockRequest reqs,
	213	int num_reqs);
	214
7d780669	215	/* sg packet commands */
221f715d AL	216	int bdrv_ioctl(BlockDriverState bs, unsigned long int req, void buf);
	217	BlockDriverAIOCB bdrv_aio_ioctl(BlockDriverState bs,
	218	unsigned long int req, void *buf,
	219	BlockDriverCompletionFunc cb, void opaque);
7d780669	220
0f15423c AL	221	/* Invalidate any cached metadata used by image formats */
	222	void bdrv_invalidate_cache(BlockDriverState *bs);
	223	void bdrv_invalidate_cache_all(void);
	224
faf07963	225	/* Ensure contents are flushed to disk. */
205ef796	226	int bdrv_flush(BlockDriverState *bs);
07f07615	227	int coroutine_fn bdrv_co_flush(BlockDriverState *bs);
c6ca28d6	228	void bdrv_flush_all(void);
2bc93fed	229	void bdrv_close_all(void);
922453bc	230	void bdrv_drain_all(void);
c6ca28d6	231
bb8bf76f	232	int bdrv_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
4265d620	233	int bdrv_co_discard(BlockDriverState *bs, int64_t sector_num, int nb_sectors);
f2feebbd	234	int bdrv_has_zero_init(BlockDriverState *bs);
f58c7b35	235	int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
39aa9a12	236	int *pnum);
faf07963	237
faf07963 PB	238	#define BIOS_ATA_TRANSLATION_AUTO 0
	239	#define BIOS_ATA_TRANSLATION_NONE 1
	240	#define BIOS_ATA_TRANSLATION_LBA 2
	241	#define BIOS_ATA_TRANSLATION_LARGE 3
	242	#define BIOS_ATA_TRANSLATION_RECHS 4
	243
	244	void bdrv_set_geometry_hint(BlockDriverState *bs,
	245	int cyls, int heads, int secs);
faf07963 PB	246	void bdrv_set_translation_hint(BlockDriverState *bs, int translation);
	247	void bdrv_get_geometry_hint(BlockDriverState *bs,
	248	int pcyls, int pheads, int *psecs);
5bbdbb46 BS	249	typedef enum FDriveType {
	250	FDRIVE_DRV_144 = 0x00, /* 1.44 MB 3"5 drive */
	251	FDRIVE_DRV_288 = 0x01, /* 2.88 MB 3"5 drive */
	252	FDRIVE_DRV_120 = 0x02, /* 1.2 MB 5"25 drive */
	253	FDRIVE_DRV_NONE = 0x03, /* No drive connected */
	254	} FDriveType;
	255
f8d3d128 HP	256	typedef enum FDriveRate {
	257	FDRIVE_RATE_500K = 0x00, /* 500 Kbps */
	258	FDRIVE_RATE_300K = 0x01, /* 300 Kbps */
	259	FDRIVE_RATE_250K = 0x02, /* 250 Kbps */
	260	FDRIVE_RATE_1M = 0x03, /* 1 Mbps */
	261	} FDriveRate;
	262
5bbdbb46 BS	263	void bdrv_get_floppy_geometry_hint(BlockDriverState bs, int nb_heads,
5bbdbb46 BS	264	int max_track, int last_sect,
f8d3d128 HP	265	FDriveType drive_in, FDriveType *drive,
f8d3d128 HP	266	FDriveRate *rate);
faf07963	267	int bdrv_get_translation_hint(BlockDriverState *bs);
abd7f68d MA	268	void bdrv_set_on_error(BlockDriverState *bs, BlockErrorAction on_read_error,
	269	BlockErrorAction on_write_error);
	270	BlockErrorAction bdrv_get_on_error(BlockDriverState *bs, int is_read);
faf07963	271	int bdrv_is_read_only(BlockDriverState *bs);
985a03b0	272	int bdrv_is_sg(BlockDriverState *bs);
e900a7b7	273	int bdrv_enable_write_cache(BlockDriverState *bs);
faf07963 PB	274	int bdrv_is_inserted(BlockDriverState *bs);
faf07963 PB	275	int bdrv_media_changed(BlockDriverState *bs);
025e849a	276	void bdrv_lock_medium(BlockDriverState *bs, bool locked);
f36f3949	277	void bdrv_eject(BlockDriverState *bs, bool eject_flag);
faf07963 PB	278	void bdrv_get_format(BlockDriverState bs, char buf, int buf_size);
faf07963 PB	279	BlockDriverState bdrv_find(const char name);
2f399b0a	280	BlockDriverState bdrv_next(BlockDriverState bs);
51de9760 AL	281	void bdrv_iterate(void (it)(void opaque, BlockDriverState *bs),
51de9760 AL	282	void *opaque);
faf07963	283	int bdrv_is_encrypted(BlockDriverState *bs);
c0f4ce77	284	int bdrv_key_required(BlockDriverState *bs);
faf07963	285	int bdrv_set_key(BlockDriverState bs, const char key);
c0f4ce77	286	int bdrv_query_missing_keys(void);
faf07963 PB	287	void bdrv_iterate_format(void (it)(void opaque, const char *name),
	288	void *opaque);
	289	const char bdrv_get_device_name(BlockDriverState bs);
	290	int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
	291	const uint8_t *buf, int nb_sectors);
	292	int bdrv_get_info(BlockDriverState bs, BlockDriverInfo bdi);
	293
045df330	294	const char bdrv_get_encrypted_filename(BlockDriverState bs);
faf07963 PB	295	void bdrv_get_backing_filename(BlockDriverState *bs,
faf07963 PB	296	char *filename, int filename_size);
feeee5ac	297	int bdrv_can_snapshot(BlockDriverState *bs);
199630b6	298	int bdrv_is_snapshot(BlockDriverState *bs);
f9092b10	299	BlockDriverState *bdrv_snapshots(void);
faf07963 PB	300	int bdrv_snapshot_create(BlockDriverState *bs,
	301	QEMUSnapshotInfo *sn_info);
	302	int bdrv_snapshot_goto(BlockDriverState *bs,
	303	const char *snapshot_id);
	304	int bdrv_snapshot_delete(BlockDriverState bs, const char snapshot_id);
	305	int bdrv_snapshot_list(BlockDriverState *bs,
	306	QEMUSnapshotInfo **psn_info);
51ef6727	307	int bdrv_snapshot_load_tmp(BlockDriverState *bs,
51ef6727	308	const char *snapshot_name);
faf07963 PB	309	char bdrv_snapshot_dump(char buf, int buf_size, QEMUSnapshotInfo *sn);
	310
	311	char get_human_readable_size(char buf, int buf_size, int64_t size);
	312	int path_is_absolute(const char *path);
	313	void path_combine(char *dest, int dest_size,
	314	const char *base_path,
	315	const char *filename);
	316
45566e9c CH	317	int bdrv_save_vmstate(BlockDriverState bs, const uint8_t buf,
45566e9c CH	318	int64_t pos, int size);
178e08a5	319
45566e9c CH	320	int bdrv_load_vmstate(BlockDriverState bs, uint8_t buf,
45566e9c CH	321	int64_t pos, int size);
178e08a5	322
f88e1a42 JS	323	int bdrv_img_create(const char filename, const char fmt,
	324	const char base_filename, const char base_fmt,
	325	char *options, uint64_t img_size, int flags);
	326
7b6f9300	327	void bdrv_set_buffer_alignment(BlockDriverState *bs, int align);
ba5b7ad4 MA	328	void qemu_blockalign(BlockDriverState bs, size_t size);
ba5b7ad4 MA	329
23bd90d2	330	#define BDRV_SECTORS_PER_DIRTY_CHUNK 2048
6ea44308	331
7cd1e32a LS	332	void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable);
7cd1e32a LS	333	int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
a55eb92c JK	334	void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector,
a55eb92c JK	335	int nr_sectors);
aaa0eb75	336	int64_t bdrv_get_dirty_count(BlockDriverState *bs);
8b9b0cc2	337
53fec9d3 SH	338	void bdrv_enable_copy_on_read(BlockDriverState *bs);
	339	void bdrv_disable_copy_on_read(BlockDriverState *bs);
	340
db593f25 MT	341	void bdrv_set_in_use(BlockDriverState *bs, int in_use);
db593f25 MT	342	int bdrv_in_use(BlockDriverState *bs);
8b9b0cc2	343
a597e79c CH	344	enum BlockAcctType {
	345	BDRV_ACCT_READ,
	346	BDRV_ACCT_WRITE,
	347	BDRV_ACCT_FLUSH,
	348	BDRV_MAX_IOTYPE,
	349	};
	350
	351	typedef struct BlockAcctCookie {
	352	int64_t bytes;
c488c7f6	353	int64_t start_time_ns;
a597e79c CH	354	enum BlockAcctType type;
	355	} BlockAcctCookie;
	356
	357	void bdrv_acct_start(BlockDriverState bs, BlockAcctCookie cookie,
	358	int64_t bytes, enum BlockAcctType type);
	359	void bdrv_acct_done(BlockDriverState bs, BlockAcctCookie cookie);
	360
8b9b0cc2	361	typedef enum {
8252278a KW	362	BLKDBG_L1_UPDATE,
	363
	364	BLKDBG_L1_GROW_ALLOC_TABLE,
	365	BLKDBG_L1_GROW_WRITE_TABLE,
	366	BLKDBG_L1_GROW_ACTIVATE_TABLE,
	367
	368	BLKDBG_L2_LOAD,
	369	BLKDBG_L2_UPDATE,
	370	BLKDBG_L2_UPDATE_COMPRESSED,
	371	BLKDBG_L2_ALLOC_COW_READ,
	372	BLKDBG_L2_ALLOC_WRITE,
	373
	374	BLKDBG_READ,
	375	BLKDBG_READ_AIO,
	376	BLKDBG_READ_BACKING,
	377	BLKDBG_READ_BACKING_AIO,
	378	BLKDBG_READ_COMPRESSED,
	379
	380	BLKDBG_WRITE_AIO,
	381	BLKDBG_WRITE_COMPRESSED,
	382
	383	BLKDBG_VMSTATE_LOAD,
	384	BLKDBG_VMSTATE_SAVE,
	385
	386	BLKDBG_COW_READ,
	387	BLKDBG_COW_WRITE,
	388
	389	BLKDBG_REFTABLE_LOAD,
	390	BLKDBG_REFTABLE_GROW,
	391
	392	BLKDBG_REFBLOCK_LOAD,
	393	BLKDBG_REFBLOCK_UPDATE,
	394	BLKDBG_REFBLOCK_UPDATE_PART,
	395	BLKDBG_REFBLOCK_ALLOC,
	396	BLKDBG_REFBLOCK_ALLOC_HOOKUP,
	397	BLKDBG_REFBLOCK_ALLOC_WRITE,
	398	BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS,
	399	BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE,
	400	BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE,
	401
	402	BLKDBG_CLUSTER_ALLOC,
	403	BLKDBG_CLUSTER_ALLOC_BYTES,
	404	BLKDBG_CLUSTER_FREE,
	405
8b9b0cc2 KW	406	BLKDBG_EVENT_MAX,
	407	} BlkDebugEvent;
	408
	409	#define BLKDBG_EVENT(bs, evt) bdrv_debug_event(bs, evt)
	410	void bdrv_debug_event(BlockDriverState *bs, BlkDebugEvent event);
	411
d1a0739d MA	412
	413	/* Convenience for block device models */
	414
	415	typedef struct BlockConf {
	416	BlockDriverState *bs;
	417	uint16_t physical_block_size;
	418	uint16_t logical_block_size;
	419	uint16_t min_io_size;
	420	uint32_t opt_io_size;
	421	int32_t bootindex;
	422	uint32_t discard_granularity;
	423	} BlockConf;
	424
	425	static inline unsigned int get_physical_block_exp(BlockConf *conf)
	426	{
	427	unsigned int exp = 0, size;
	428
	429	for (size = conf->physical_block_size;
	430	size > conf->logical_block_size;
	431	size >>= 1) {
	432	exp++;
	433	}
	434
	435	return exp;
	436	}
	437
	438	#define DEFINE_BLOCK_PROPERTIES(_state, _conf) \
	439	DEFINE_PROP_DRIVE("drive", _state, _conf.bs), \
	440	DEFINE_PROP_UINT16("logical_block_size", _state, \
	441	_conf.logical_block_size, 512), \
	442	DEFINE_PROP_UINT16("physical_block_size", _state, \
	443	_conf.physical_block_size, 512), \
	444	DEFINE_PROP_UINT16("min_io_size", _state, _conf.min_io_size, 0), \
	445	DEFINE_PROP_UINT32("opt_io_size", _state, _conf.opt_io_size, 0), \
	446	DEFINE_PROP_INT32("bootindex", _state, _conf.bootindex, -1), \
	447	DEFINE_PROP_UINT32("discard_granularity", _state, \
	448	_conf.discard_granularity, 0)
	449
faf07963	450	#endif
a597e79c	451