block: New BlockBackend
A block device consists of a frontend device model and a backend.
A block backend has a tree of block drivers doing the actual work.
The tree is managed by the block layer.
We currently use a single abstraction BlockDriverState both for tree
nodes and the backend as a whole. Drawbacks:
* Its API includes both stuff that makes sense only at the block
backend level (root of the tree) and stuff that's only for use
within the block layer. This makes the API bigger and more complex
than necessary. Moreover, it's not obvious which interfaces are
meant for device models, and which really aren't.
* Since device models keep a reference to their backend, the backend
object can't just be destroyed. But for media change, we need to
replace the tree. Our solution is to make the BlockDriverState
generic, with actual driver state in a separate object, pointed to
by member opaque. That lets us replace the tree by deinitializing
and reinitializing its root. This special need of the root makes
the data structure awkward everywhere in the tree.
The general plan is to separate the APIs into "block backend", for use
by device models, monitor and whatever other code dealing with block
backends, and "block driver", for use by the block layer and whatever
other code (if any) dealing with trees and tree nodes.
Code dealing with block backends, device models in particular, should
become completely oblivious of BlockDriverState. This should let us
clean up both APIs, and the tree data structures.
This commit is a first step. It creates a minimal "block backend"
API: type BlockBackend and functions to create, destroy and find them.
BlockBackend objects are created and destroyed exactly when root
BlockDriverState objects are created and destroyed. "Root" in the
sense of "in bdrv_states". They're not yet used for anything; that'll
come shortly.
A root BlockDriverState is created with bdrv_new_root(), so where to
create a BlockBackend is obvious. Where these roots get destroyed
isn't always as obvious.
It is obvious in qemu-img.c, qemu-io.c and qemu-nbd.c, and in error
paths of blockdev_init(), blk_connect(). That leaves destruction of
objects successfully created by blockdev_init() and blk_connect().
blockdev_init() is used only by drive_new() and qmp_blockdev_add().
Objects created by the latter are currently indestructible (see commit
48f364d "blockdev: Refuse to drive_del something added with
blockdev-add" and commit 2d246f0 "blockdev: Introduce
DriveInfo.enable_auto_del"). Objects created by the former get
destroyed by drive_del().
Objects created by blk_connect() get destroyed by blk_disconnect().
BlockBackend is reference-counted. Its reference count never exceeds
one so far, but that's going to change.
In drive_del(), the BB's reference count is surely one now. The BDS's
reference count is greater than one when something else is holding a
reference, such as a block job. In this case, the BB is destroyed
right away, but the BDS lives on until all extra references get
dropped.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Max Reitz <mreitz@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2014-10-07 13:59:04 +02:00
|
|
|
/*
|
|
|
|
|
* QEMU Block backends
|
|
|
|
|
*
|
|
|
|
|
* Copyright (C) 2014 Red Hat, Inc.
|
|
|
|
|
*
|
|
|
|
|
* Authors:
|
|
|
|
|
* Markus Armbruster <armbru@redhat.com>,
|
|
|
|
|
*
|
|
|
|
|
* 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"
|
|
|
|
|
|
2014-10-07 13:59:18 +02:00
|
|
|
/*
|
|
|
|
|
* 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"
|
|
|
|
|
|
2014-10-07 13:59:25 +02:00
|
|
|
/* 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;
|
|
|
|
|
|
block: New BlockBackend
A block device consists of a frontend device model and a backend.
A block backend has a tree of block drivers doing the actual work.
The tree is managed by the block layer.
We currently use a single abstraction BlockDriverState both for tree
nodes and the backend as a whole. Drawbacks:
* Its API includes both stuff that makes sense only at the block
backend level (root of the tree) and stuff that's only for use
within the block layer. This makes the API bigger and more complex
than necessary. Moreover, it's not obvious which interfaces are
meant for device models, and which really aren't.
* Since device models keep a reference to their backend, the backend
object can't just be destroyed. But for media change, we need to
replace the tree. Our solution is to make the BlockDriverState
generic, with actual driver state in a separate object, pointed to
by member opaque. That lets us replace the tree by deinitializing
and reinitializing its root. This special need of the root makes
the data structure awkward everywhere in the tree.
The general plan is to separate the APIs into "block backend", for use
by device models, monitor and whatever other code dealing with block
backends, and "block driver", for use by the block layer and whatever
other code (if any) dealing with trees and tree nodes.
Code dealing with block backends, device models in particular, should
become completely oblivious of BlockDriverState. This should let us
clean up both APIs, and the tree data structures.
This commit is a first step. It creates a minimal "block backend"
API: type BlockBackend and functions to create, destroy and find them.
BlockBackend objects are created and destroyed exactly when root
BlockDriverState objects are created and destroyed. "Root" in the
sense of "in bdrv_states". They're not yet used for anything; that'll
come shortly.
A root BlockDriverState is created with bdrv_new_root(), so where to
create a BlockBackend is obvious. Where these roots get destroyed
isn't always as obvious.
It is obvious in qemu-img.c, qemu-io.c and qemu-nbd.c, and in error
paths of blockdev_init(), blk_connect(). That leaves destruction of
objects successfully created by blockdev_init() and blk_connect().
blockdev_init() is used only by drive_new() and qmp_blockdev_add().
Objects created by the latter are currently indestructible (see commit
48f364d "blockdev: Refuse to drive_del something added with
blockdev-add" and commit 2d246f0 "blockdev: Introduce
DriveInfo.enable_auto_del"). Objects created by the former get
destroyed by drive_del().
Objects created by blk_connect() get destroyed by blk_disconnect().
BlockBackend is reference-counted. Its reference count never exceeds
one so far, but that's going to change.
In drive_del(), the BB's reference count is surely one now. The BDS's
reference count is greater than one when something else is holding a
reference, such as a block job. In this case, the BB is destroyed
right away, but the BDS lives on until all extra references get
dropped.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Max Reitz <mreitz@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2014-10-07 13:59:04 +02:00
|
|
|
BlockBackend *blk_new(const char *name, Error **errp);
|
2014-10-07 13:59:05 +02:00
|
|
|
BlockBackend *blk_new_with_bs(const char *name, Error **errp);
|
block: New BlockBackend
A block device consists of a frontend device model and a backend.
A block backend has a tree of block drivers doing the actual work.
The tree is managed by the block layer.
We currently use a single abstraction BlockDriverState both for tree
nodes and the backend as a whole. Drawbacks:
* Its API includes both stuff that makes sense only at the block
backend level (root of the tree) and stuff that's only for use
within the block layer. This makes the API bigger and more complex
than necessary. Moreover, it's not obvious which interfaces are
meant for device models, and which really aren't.
* Since device models keep a reference to their backend, the backend
object can't just be destroyed. But for media change, we need to
replace the tree. Our solution is to make the BlockDriverState
generic, with actual driver state in a separate object, pointed to
by member opaque. That lets us replace the tree by deinitializing
and reinitializing its root. This special need of the root makes
the data structure awkward everywhere in the tree.
The general plan is to separate the APIs into "block backend", for use
by device models, monitor and whatever other code dealing with block
backends, and "block driver", for use by the block layer and whatever
other code (if any) dealing with trees and tree nodes.
Code dealing with block backends, device models in particular, should
become completely oblivious of BlockDriverState. This should let us
clean up both APIs, and the tree data structures.
This commit is a first step. It creates a minimal "block backend"
API: type BlockBackend and functions to create, destroy and find them.
BlockBackend objects are created and destroyed exactly when root
BlockDriverState objects are created and destroyed. "Root" in the
sense of "in bdrv_states". They're not yet used for anything; that'll
come shortly.
A root BlockDriverState is created with bdrv_new_root(), so where to
create a BlockBackend is obvious. Where these roots get destroyed
isn't always as obvious.
It is obvious in qemu-img.c, qemu-io.c and qemu-nbd.c, and in error
paths of blockdev_init(), blk_connect(). That leaves destruction of
objects successfully created by blockdev_init() and blk_connect().
blockdev_init() is used only by drive_new() and qmp_blockdev_add().
Objects created by the latter are currently indestructible (see commit
48f364d "blockdev: Refuse to drive_del something added with
blockdev-add" and commit 2d246f0 "blockdev: Introduce
DriveInfo.enable_auto_del"). Objects created by the former get
destroyed by drive_del().
Objects created by blk_connect() get destroyed by blk_disconnect().
BlockBackend is reference-counted. Its reference count never exceeds
one so far, but that's going to change.
In drive_del(), the BB's reference count is surely one now. The BDS's
reference count is greater than one when something else is holding a
reference, such as a block job. In this case, the BB is destroyed
right away, but the BDS lives on until all extra references get
dropped.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Max Reitz <mreitz@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2014-10-07 13:59:04 +02:00
|
|
|
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);
|
|
|
|
|
|
2014-10-07 13:59:05 +02:00
|
|
|
BlockDriverState *blk_bs(BlockBackend *blk);
|
|
|
|
|
|
|
|
|
|
void blk_hide_on_behalf_of_do_drive_del(BlockBackend *blk);
|
|
|
|
|
|
2014-10-07 13:59:18 +02:00
|
|
|
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);
|
|
|
|
|
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);
|
|
|
|
|
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);
|
2014-11-18 12:21:14 +01:00
|
|
|
int blk_co_discard(BlockBackend *blk, int64_t sector_num, int nb_sectors);
|
|
|
|
|
int blk_co_flush(BlockBackend *blk);
|
2014-10-07 13:59:18 +02:00
|
|
|
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);
|
2014-11-18 12:21:14 +01:00
|
|
|
void blk_invalidate_cache(BlockBackend *blk, Error **errp);
|
2014-10-07 13:59:18 +02:00
|
|
|
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);
|
|
|
|
|
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);
|
2014-11-18 12:21:15 +01:00
|
|
|
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);
|
2014-10-07 13:59:18 +02:00
|
|
|
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);
|
|
|
|
|
|
block: New BlockBackend
A block device consists of a frontend device model and a backend.
A block backend has a tree of block drivers doing the actual work.
The tree is managed by the block layer.
We currently use a single abstraction BlockDriverState both for tree
nodes and the backend as a whole. Drawbacks:
* Its API includes both stuff that makes sense only at the block
backend level (root of the tree) and stuff that's only for use
within the block layer. This makes the API bigger and more complex
than necessary. Moreover, it's not obvious which interfaces are
meant for device models, and which really aren't.
* Since device models keep a reference to their backend, the backend
object can't just be destroyed. But for media change, we need to
replace the tree. Our solution is to make the BlockDriverState
generic, with actual driver state in a separate object, pointed to
by member opaque. That lets us replace the tree by deinitializing
and reinitializing its root. This special need of the root makes
the data structure awkward everywhere in the tree.
The general plan is to separate the APIs into "block backend", for use
by device models, monitor and whatever other code dealing with block
backends, and "block driver", for use by the block layer and whatever
other code (if any) dealing with trees and tree nodes.
Code dealing with block backends, device models in particular, should
become completely oblivious of BlockDriverState. This should let us
clean up both APIs, and the tree data structures.
This commit is a first step. It creates a minimal "block backend"
API: type BlockBackend and functions to create, destroy and find them.
BlockBackend objects are created and destroyed exactly when root
BlockDriverState objects are created and destroyed. "Root" in the
sense of "in bdrv_states". They're not yet used for anything; that'll
come shortly.
A root BlockDriverState is created with bdrv_new_root(), so where to
create a BlockBackend is obvious. Where these roots get destroyed
isn't always as obvious.
It is obvious in qemu-img.c, qemu-io.c and qemu-nbd.c, and in error
paths of blockdev_init(), blk_connect(). That leaves destruction of
objects successfully created by blockdev_init() and blk_connect().
blockdev_init() is used only by drive_new() and qmp_blockdev_add().
Objects created by the latter are currently indestructible (see commit
48f364d "blockdev: Refuse to drive_del something added with
blockdev-add" and commit 2d246f0 "blockdev: Introduce
DriveInfo.enable_auto_del"). Objects created by the former get
destroyed by drive_del().
Objects created by blk_connect() get destroyed by blk_disconnect().
BlockBackend is reference-counted. Its reference count never exceeds
one so far, but that's going to change.
In drive_del(), the BB's reference count is surely one now. The BDS's
reference count is greater than one when something else is holding a
reference, such as a block job. In this case, the BB is destroyed
right away, but the BDS lives on until all extra references get
dropped.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Max Reitz <mreitz@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2014-10-07 13:59:04 +02:00
|
|
|
#endif
|