[qemu.git] / include / block / block.h

#ifndef BLOCK_H
#define BLOCK_H

#include "block/aio.h"
#include "qemu-common.h"
#include "qemu/option.h"
#include "block/coroutine.h"
#include "qapi/qmp/qobject.h"
#include "qapi-types.h"

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

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;
    bool is_dirty;
} BlockDriverInfo;

typedef struct BlockFragInfo {
    uint64_t allocated_clusters;
    uint64_t total_clusters;
    uint64_t fragmented_clusters;
} BlockFragInfo;

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_INCOMING    0x0800  /* consistency hint for incoming migration */
#define BDRV_O_CHECK       0x1000  /* open solely for consistency check */
#define BDRV_O_ALLOW_RDWR  0x2000  /* allow reopen to change from r/o to r/w */

#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 {
    BDRV_ACTION_REPORT, BDRV_ACTION_IGNORE, BDRV_ACTION_STOP
} BlockErrorAction;

typedef QSIMPLEQ_HEAD(BlockReopenQueue, BlockReopenQueueEntry) BlockReopenQueue;

typedef struct BDRVReopenState {
    BlockDriverState *bs;
    int flags;
    void *opaque;
} BDRVReopenState;


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_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_swap(BlockDriverState *bs_new, BlockDriverState *bs_old);
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_backing_file(BlockDriverState *bs);
int bdrv_open(BlockDriverState *bs, const char *filename, int flags,
              BlockDriver *drv);
BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue,
                                    BlockDriverState *bs, int flags);
int bdrv_reopen_multiple(BlockReopenQueue *bs_queue, Error **errp);
int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp);
int bdrv_reopen_prepare(BDRVReopenState *reopen_state,
                        BlockReopenQueue *queue, Error **errp);
void bdrv_reopen_commit(BDRVReopenState *reopen_state);
void bdrv_reopen_abort(BDRVReopenState *reopen_state);
void bdrv_close(BlockDriverState *bs);
void bdrv_add_close_notifier(BlockDriverState *bs, Notifier *notify);
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_read_unthrottled(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);
int coroutine_fn bdrv_co_is_allocated_above(BlockDriverState *top,
                                            BlockDriverState *base,
                                            int64_t sector_num,
                                            int nb_sectors, int *pnum);
BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
    const char *backing_file);
int bdrv_get_backing_file_depth(BlockDriverState *bs);
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);
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);
int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top,
                           BlockDriverState *base);
BlockDriverState *bdrv_find_overlay(BlockDriverState *active,
                                    BlockDriverState *bs);
BlockDriverState *bdrv_find_base(BlockDriverState *bs);


typedef struct BdrvCheckResult {
    int corruptions;
    int leaks;
    int check_errors;
    int corruptions_fixed;
    int leaks_fixed;
    BlockFragInfo bfi;
} BdrvCheckResult;

typedef enum {
    BDRV_FIX_LEAKS    = 1,
    BDRV_FIX_ERRORS   = 2,
} BdrvCheckMode;

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

/* async block I/O */
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);

void bdrv_clear_incoming_migration_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);

void bdrv_set_on_error(BlockDriverState *bs, BlockdevOnError on_read_error,
                       BlockdevOnError on_write_error);
BlockdevOnError bdrv_get_on_error(BlockDriverState *bs, bool is_read);
BlockErrorAction bdrv_get_error_action(BlockDriverState *bs, bool is_read, int error);
void bdrv_error_action(BlockDriverState *bs, BlockErrorAction action,
                       bool is_read, int error);
int bdrv_is_read_only(BlockDriverState *bs);
int bdrv_is_sg(BlockDriverState *bs);
int bdrv_enable_write_cache(BlockDriverState *bs);
void bdrv_set_enable_write_cache(BlockDriverState *bs, bool wce);
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);
const char *bdrv_get_format_name(BlockDriverState *bs);
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_get_flags(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);
void bdrv_get_full_backing_filename(BlockDriverState *bs,
                                    char *dest, size_t sz);
BlockInfo *bdrv_query_info(BlockDriverState *s);
BlockStats *bdrv_query_stats(const BlockDriverState *bs);
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);

void 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, Error **errp);

void bdrv_set_buffer_alignment(BlockDriverState *bs, int align);
void *qemu_blockalign(BlockDriverState *bs, size_t size);
bool bdrv_qiov_is_aligned(BlockDriverState *bs, QEMUIOVector *qiov);

#define BDRV_SECTORS_PER_DIRTY_CHUNK     (1 << BDRV_LOG_SECTORS_PER_DIRTY_CHUNK)
#define BDRV_LOG_SECTORS_PER_DIRTY_CHUNK 11

struct HBitmapIter;
void bdrv_set_dirty_tracking(BlockDriverState *bs, int enable);
int bdrv_get_dirty(BlockDriverState *bs, int64_t sector);
void bdrv_set_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors);
void bdrv_reset_dirty(BlockDriverState *bs, int64_t cur_sector, int nr_sectors);
void bdrv_dirty_iter_init(BlockDriverState *bs, struct HBitmapIter *hbi);
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);

#ifdef CONFIG_LINUX_AIO
int raw_get_aio_fd(BlockDriverState *bs);
#else
static inline int raw_get_aio_fd(BlockDriverState *bs)
{
    return -ENOTSUP;
}
#endif

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_AIO,
    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);

int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event,
                           const char *tag);
int bdrv_debug_resume(BlockDriverState *bs, const char *tag);
bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag);

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