[qemu.git] / include / sysemu / block-backend.h

/*
 * QEMU Block backends
 *
 * Copyright (C) 2014 Red Hat, Inc.
 *
 * Authors:
 *  Markus Armbruster <[email protected]>,
 *
 * This work is licensed under the terms of the GNU LGPL, version 2.1
 * or later.  See the COPYING.LIB file in the top-level directory.
 */

#ifndef BLOCK_BACKEND_H
#define BLOCK_BACKEND_H

#include "qemu/typedefs.h"
#include "qapi/error.h"

/*
 * TODO Have to include block/block.h for a bunch of block layer
 * types.  Unfortunately, this pulls in the whole BlockDriverState
 * API, which we don't want used by many BlockBackend users.  Some of
 * the types belong here, and the rest should be split into a common
 * header and one for the BlockDriverState API.
 */
#include "block/block.h"

/* 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;

BlockBackend *blk_new(const char *name, Error **errp);
BlockBackend *blk_new_with_bs(const char *name, Error **errp);
BlockBackend *blk_new_open(const char *name, const char *filename,
                           const char *reference, QDict *options, int flags,
                           Error **errp);
void blk_ref(BlockBackend *blk);
void blk_unref(BlockBackend *blk);
const char *blk_name(BlockBackend *blk);
BlockBackend *blk_by_name(const char *name);
BlockBackend *blk_next(BlockBackend *blk);

BlockDriverState *blk_bs(BlockBackend *blk);

void blk_hide_on_behalf_of_hmp_drive_del(BlockBackend *blk);

void blk_iostatus_enable(BlockBackend *blk);
int blk_attach_dev(BlockBackend *blk, void *dev);
void blk_attach_dev_nofail(BlockBackend *blk, void *dev);
void blk_detach_dev(BlockBackend *blk, void *dev);
void *blk_get_attached_dev(BlockBackend *blk);
void blk_set_dev_ops(BlockBackend *blk, const BlockDevOps *ops, void *opaque);
int blk_read(BlockBackend *blk, int64_t sector_num, uint8_t *buf,
             int nb_sectors);
int blk_read_unthrottled(BlockBackend *blk, int64_t sector_num, uint8_t *buf,
                         int nb_sectors);
int blk_write(BlockBackend *blk, int64_t sector_num, const uint8_t *buf,
              int nb_sectors);
int blk_write_zeroes(BlockBackend *blk, int64_t sector_num,
                     int nb_sectors, BdrvRequestFlags flags);
BlockAIOCB *blk_aio_write_zeroes(BlockBackend *blk, int64_t sector_num,
                                 int nb_sectors, BdrvRequestFlags flags,
                                 BlockCompletionFunc *cb, void *opaque);
int blk_pread(BlockBackend *blk, int64_t offset, void *buf, int count);
int blk_pwrite(BlockBackend *blk, int64_t offset, const void *buf, int count);
int64_t blk_getlength(BlockBackend *blk);
void blk_get_geometry(BlockBackend *blk, uint64_t *nb_sectors_ptr);
int64_t blk_nb_sectors(BlockBackend *blk);
BlockAIOCB *blk_aio_readv(BlockBackend *blk, int64_t sector_num,
                          QEMUIOVector *iov, int nb_sectors,
                          BlockCompletionFunc *cb, void *opaque);
BlockAIOCB *blk_aio_writev(BlockBackend *blk, int64_t sector_num,
                           QEMUIOVector *iov, int nb_sectors,
                           BlockCompletionFunc *cb, void *opaque);
BlockAIOCB *blk_aio_flush(BlockBackend *blk,
                          BlockCompletionFunc *cb, void *opaque);
BlockAIOCB *blk_aio_discard(BlockBackend *blk,
                            int64_t sector_num, int nb_sectors,
                            BlockCompletionFunc *cb, void *opaque);
void blk_aio_cancel(BlockAIOCB *acb);
void blk_aio_cancel_async(BlockAIOCB *acb);
int blk_aio_multiwrite(BlockBackend *blk, BlockRequest *reqs, int num_reqs);
int blk_ioctl(BlockBackend *blk, unsigned long int req, void *buf);
BlockAIOCB *blk_aio_ioctl(BlockBackend *blk, unsigned long int req, void *buf,
                          BlockCompletionFunc *cb, void *opaque);
int blk_co_discard(BlockBackend *blk, int64_t sector_num, int nb_sectors);
int blk_co_flush(BlockBackend *blk);
int blk_flush(BlockBackend *blk);
int blk_flush_all(void);
void blk_drain_all(void);
BlockdevOnError blk_get_on_error(BlockBackend *blk, bool is_read);
BlockErrorAction blk_get_error_action(BlockBackend *blk, bool is_read,
                                      int error);
void blk_error_action(BlockBackend *blk, BlockErrorAction action,
                      bool is_read, int error);
int blk_is_read_only(BlockBackend *blk);
int blk_is_sg(BlockBackend *blk);
int blk_enable_write_cache(BlockBackend *blk);
void blk_set_enable_write_cache(BlockBackend *blk, bool wce);
void blk_invalidate_cache(BlockBackend *blk, Error **errp);
int blk_is_inserted(BlockBackend *blk);
void blk_lock_medium(BlockBackend *blk, bool locked);
void blk_eject(BlockBackend *blk, bool eject_flag);
int blk_get_flags(BlockBackend *blk);
int blk_get_max_transfer_length(BlockBackend *blk);
void blk_set_guest_block_size(BlockBackend *blk, int align);
void *blk_blockalign(BlockBackend *blk, size_t size);
bool blk_op_is_blocked(BlockBackend *blk, BlockOpType op, Error **errp);
void blk_op_unblock(BlockBackend *blk, BlockOpType op, Error *reason);
void blk_op_block_all(BlockBackend *blk, Error *reason);
void blk_op_unblock_all(BlockBackend *blk, Error *reason);
AioContext *blk_get_aio_context(BlockBackend *blk);
void blk_set_aio_context(BlockBackend *blk, AioContext *new_context);
void blk_add_aio_context_notifier(BlockBackend *blk,
        void (*attached_aio_context)(AioContext *new_context, void *opaque),
        void (*detach_aio_context)(void *opaque), void *opaque);
void blk_remove_aio_context_notifier(BlockBackend *blk,
                                     void (*attached_aio_context)(AioContext *,
                                                                  void *),
                                     void (*detach_aio_context)(void *),
                                     void *opaque);
void blk_add_close_notifier(BlockBackend *blk, Notifier *notify);
void blk_io_plug(BlockBackend *blk);
void blk_io_unplug(BlockBackend *blk);
BlockAcctStats *blk_get_stats(BlockBackend *blk);

void *blk_aio_get(const AIOCBInfo *aiocb_info, BlockBackend *blk,
                  BlockCompletionFunc *cb, void *opaque);
int coroutine_fn blk_co_write_zeroes(BlockBackend *blk, int64_t sector_num,
                                     int nb_sectors, BdrvRequestFlags flags);
int blk_write_compressed(BlockBackend *blk, int64_t sector_num,
                         const uint8_t *buf, int nb_sectors);
int blk_truncate(BlockBackend *blk, int64_t offset);
int blk_discard(BlockBackend *blk, int64_t sector_num, int nb_sectors);
int blk_save_vmstate(BlockBackend *blk, const uint8_t *buf,
                     int64_t pos, int size);
int blk_load_vmstate(BlockBackend *blk, uint8_t *buf, int64_t pos, int size);
int blk_probe_blocksizes(BlockBackend *blk, BlockSizes *bsz);
int blk_probe_geometry(BlockBackend *blk, HDGeometry *geo);

#endif
Commit	Line	Data
26f54e9a MA	1	/*
	2	* QEMU Block backends
	3	*
	4	* Copyright (C) 2014 Red Hat, Inc.
	5	*
	6	* Authors:
	7	* Markus Armbruster <[email protected]>,
	8	*
	9	* This work is licensed under the terms of the GNU LGPL, version 2.1
	10	* or later. See the COPYING.LIB file in the top-level directory.
	11	*/
	12
	13	#ifndef BLOCK_BACKEND_H
	14	#define BLOCK_BACKEND_H
	15
	16	#include "qemu/typedefs.h"
	17	#include "qapi/error.h"
	18
4be74634 MA	19	/*
	20	* TODO Have to include block/block.h for a bunch of block layer
	21	* types. Unfortunately, this pulls in the whole BlockDriverState
	22	* API, which we don't want used by many BlockBackend users. Some of
	23	* the types belong here, and the rest should be split into a common
	24	* header and one for the BlockDriverState API.
	25	*/
	26	#include "block/block.h"
	27
a7f53e26 MA	28	/* Callbacks for block device models */
	29	typedef struct BlockDevOps {
	30	/*
	31	* Runs when virtual media changed (monitor commands eject, change)
	32	* Argument load is true on load and false on eject.
	33	* Beware: doesn't run when a host device's physical media
	34	* changes. Sure would be useful if it did.
	35	* Device models with removable media must implement this callback.
	36	*/
	37	void (change_media_cb)(void opaque, bool load);
	38	/*
	39	* Runs when an eject request is issued from the monitor, the tray
	40	* is closed, and the medium is locked.
	41	* Device models that do not implement is_medium_locked will not need
	42	* this callback. Device models that can lock the medium or tray might
	43	* want to implement the callback and unlock the tray when "force" is
	44	* true, even if they do not support eject requests.
	45	*/
	46	void (eject_request_cb)(void opaque, bool force);
	47	/*
	48	* Is the virtual tray open?
	49	* Device models implement this only when the device has a tray.
	50	*/
	51	bool (is_tray_open)(void opaque);
	52	/*
	53	* Is the virtual medium locked into the device?
	54	* Device models implement this only when device has such a lock.
	55	*/
	56	bool (is_medium_locked)(void opaque);
	57	/*
	58	* Runs when the size changed (e.g. monitor command block_resize)
	59	*/
	60	void (resize_cb)(void opaque);
	61	} BlockDevOps;
	62
26f54e9a	63	BlockBackend blk_new(const char name, Error **errp);
7e7d56d9	64	BlockBackend blk_new_with_bs(const char name, Error **errp);
ca49a4fd HR	65	BlockBackend blk_new_open(const char name, const char *filename,
	66	const char reference, QDict options, int flags,
	67	Error **errp);
26f54e9a MA	68	void blk_ref(BlockBackend *blk);
	69	void blk_unref(BlockBackend *blk);
	70	const char blk_name(BlockBackend blk);
	71	BlockBackend blk_by_name(const char name);
	72	BlockBackend blk_next(BlockBackend blk);
	73
7e7d56d9 MA	74	BlockDriverState blk_bs(BlockBackend blk);
7e7d56d9 MA	75
3e5a50d6	76	void blk_hide_on_behalf_of_hmp_drive_del(BlockBackend *blk);
7e7d56d9	77
4be74634 MA	78	void blk_iostatus_enable(BlockBackend *blk);
	79	int blk_attach_dev(BlockBackend blk, void dev);
	80	void blk_attach_dev_nofail(BlockBackend blk, void dev);
	81	void blk_detach_dev(BlockBackend blk, void dev);
	82	void blk_get_attached_dev(BlockBackend blk);
	83	void blk_set_dev_ops(BlockBackend blk, const BlockDevOps ops, void *opaque);
	84	int blk_read(BlockBackend blk, int64_t sector_num, uint8_t buf,
	85	int nb_sectors);
	86	int blk_read_unthrottled(BlockBackend blk, int64_t sector_num, uint8_t buf,
	87	int nb_sectors);
	88	int blk_write(BlockBackend blk, int64_t sector_num, const uint8_t buf,
	89	int nb_sectors);
0df89e8e KW	90	int blk_write_zeroes(BlockBackend *blk, int64_t sector_num,
0df89e8e KW	91	int nb_sectors, BdrvRequestFlags flags);
4be74634 MA	92	BlockAIOCB blk_aio_write_zeroes(BlockBackend blk, int64_t sector_num,
	93	int nb_sectors, BdrvRequestFlags flags,
	94	BlockCompletionFunc cb, void opaque);
	95	int blk_pread(BlockBackend blk, int64_t offset, void buf, int count);
	96	int blk_pwrite(BlockBackend blk, int64_t offset, const void buf, int count);
	97	int64_t blk_getlength(BlockBackend *blk);
	98	void blk_get_geometry(BlockBackend blk, uint64_t nb_sectors_ptr);
1ef01253	99	int64_t blk_nb_sectors(BlockBackend *blk);
4be74634 MA	100	BlockAIOCB blk_aio_readv(BlockBackend blk, int64_t sector_num,
	101	QEMUIOVector *iov, int nb_sectors,
	102	BlockCompletionFunc cb, void opaque);
	103	BlockAIOCB blk_aio_writev(BlockBackend blk, int64_t sector_num,
	104	QEMUIOVector *iov, int nb_sectors,
	105	BlockCompletionFunc cb, void opaque);
	106	BlockAIOCB blk_aio_flush(BlockBackend blk,
	107	BlockCompletionFunc cb, void opaque);
	108	BlockAIOCB blk_aio_discard(BlockBackend blk,
	109	int64_t sector_num, int nb_sectors,
	110	BlockCompletionFunc cb, void opaque);
	111	void blk_aio_cancel(BlockAIOCB *acb);
	112	void blk_aio_cancel_async(BlockAIOCB *acb);
	113	int blk_aio_multiwrite(BlockBackend blk, BlockRequest reqs, int num_reqs);
	114	int blk_ioctl(BlockBackend blk, unsigned long int req, void buf);
	115	BlockAIOCB blk_aio_ioctl(BlockBackend blk, unsigned long int req, void *buf,
	116	BlockCompletionFunc cb, void opaque);
2bb0dce7 HR	117	int blk_co_discard(BlockBackend *blk, int64_t sector_num, int nb_sectors);
2bb0dce7 HR	118	int blk_co_flush(BlockBackend *blk);
4be74634 MA	119	int blk_flush(BlockBackend *blk);
	120	int blk_flush_all(void);
	121	void blk_drain_all(void);
	122	BlockdevOnError blk_get_on_error(BlockBackend *blk, bool is_read);
	123	BlockErrorAction blk_get_error_action(BlockBackend *blk, bool is_read,
	124	int error);
	125	void blk_error_action(BlockBackend *blk, BlockErrorAction action,
	126	bool is_read, int error);
	127	int blk_is_read_only(BlockBackend *blk);
	128	int blk_is_sg(BlockBackend *blk);
	129	int blk_enable_write_cache(BlockBackend *blk);
	130	void blk_set_enable_write_cache(BlockBackend *blk, bool wce);
2bb0dce7	131	void blk_invalidate_cache(BlockBackend blk, Error *errp);
4be74634 MA	132	int blk_is_inserted(BlockBackend *blk);
	133	void blk_lock_medium(BlockBackend *blk, bool locked);
	134	void blk_eject(BlockBackend *blk, bool eject_flag);
	135	int blk_get_flags(BlockBackend *blk);
454057b7	136	int blk_get_max_transfer_length(BlockBackend *blk);
4be74634 MA	137	void blk_set_guest_block_size(BlockBackend *blk, int align);
	138	void blk_blockalign(BlockBackend blk, size_t size);
	139	bool blk_op_is_blocked(BlockBackend blk, BlockOpType op, Error *errp);
	140	void blk_op_unblock(BlockBackend blk, BlockOpType op, Error reason);
	141	void blk_op_block_all(BlockBackend blk, Error reason);
	142	void blk_op_unblock_all(BlockBackend blk, Error reason);
	143	AioContext blk_get_aio_context(BlockBackend blk);
	144	void blk_set_aio_context(BlockBackend blk, AioContext new_context);
2019ba0a HR	145	void blk_add_aio_context_notifier(BlockBackend *blk,
	146	void (attached_aio_context)(AioContext new_context, void *opaque),
	147	void (detach_aio_context)(void opaque), void *opaque);
	148	void blk_remove_aio_context_notifier(BlockBackend *blk,
	149	void (attached_aio_context)(AioContext ,
	150	void *),
	151	void (detach_aio_context)(void ),
	152	void *opaque);
2c28b21f	153	void blk_add_close_notifier(BlockBackend blk, Notifier notify);
4be74634 MA	154	void blk_io_plug(BlockBackend *blk);
	155	void blk_io_unplug(BlockBackend *blk);
	156	BlockAcctStats blk_get_stats(BlockBackend blk);
	157
	158	void blk_aio_get(const AIOCBInfo aiocb_info, BlockBackend *blk,
	159	BlockCompletionFunc cb, void opaque);
1ef01253 HR	160	int coroutine_fn blk_co_write_zeroes(BlockBackend *blk, int64_t sector_num,
	161	int nb_sectors, BdrvRequestFlags flags);
	162	int blk_write_compressed(BlockBackend *blk, int64_t sector_num,
	163	const uint8_t *buf, int nb_sectors);
	164	int blk_truncate(BlockBackend *blk, int64_t offset);
	165	int blk_discard(BlockBackend *blk, int64_t sector_num, int nb_sectors);
	166	int blk_save_vmstate(BlockBackend blk, const uint8_t buf,
	167	int64_t pos, int size);
	168	int blk_load_vmstate(BlockBackend blk, uint8_t buf, int64_t pos, int size);
f0272c4d ET	169	int blk_probe_blocksizes(BlockBackend blk, BlockSizes bsz);
f0272c4d ET	170	int blk_probe_geometry(BlockBackend blk, HDGeometry geo);
4be74634	171
26f54e9a	172	#endif