4 * Copyright (C) 2014 Red Hat, Inc.
7 * Markus Armbruster <armbru@redhat.com>,
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.
13 #include "qemu/osdep.h"
14 #include "sysemu/block-backend.h"
15 #include "block/block_int.h"
16 #include "block/blockjob.h"
17 #include "block/throttle-groups.h"
18 #include "sysemu/blockdev.h"
19 #include "sysemu/sysemu.h"
20 #include "qapi-event.h"
23 /* Number of coroutines to reserve per attached device model */
24 #define COROUTINE_POOL_RESERVATION 64
26 #define NOT_DONE 0x7fffffff /* used while emulated sync operation in progress */
28 static AioContext
*blk_aiocb_get_aio_context(BlockAIOCB
*acb
);
34 DriveInfo
*legacy_dinfo
; /* null unless created by drive_new() */
35 QTAILQ_ENTRY(BlockBackend
) link
; /* for block_backends */
36 QTAILQ_ENTRY(BlockBackend
) monitor_link
; /* for monitor_block_backends */
38 void *dev
; /* attached device model, if any */
39 /* TODO change to DeviceState when all users are qdevified */
40 const BlockDevOps
*dev_ops
;
43 /* the block size for which the guest device expects atomicity */
46 /* If the BDS tree is removed, some of its options are stored here (which
47 * can be used to restore those options in the new BDS on insert) */
48 BlockBackendRootState root_state
;
50 /* I/O stats (display with "info blockstats"). */
53 BlockdevOnError on_read_error
, on_write_error
;
54 bool iostatus_enabled
;
55 BlockDeviceIoStatus iostatus
;
57 bool allow_write_beyond_eof
;
59 NotifierList remove_bs_notifiers
, insert_bs_notifiers
;
62 typedef struct BlockBackendAIOCB
{
69 static const AIOCBInfo block_backend_aiocb_info
= {
70 .get_aio_context
= blk_aiocb_get_aio_context
,
71 .aiocb_size
= sizeof(BlockBackendAIOCB
),
74 static void drive_info_del(DriveInfo
*dinfo
);
76 /* All BlockBackends */
77 static QTAILQ_HEAD(, BlockBackend
) block_backends
=
78 QTAILQ_HEAD_INITIALIZER(block_backends
);
80 /* All BlockBackends referenced by the monitor and which are iterated through by
82 static QTAILQ_HEAD(, BlockBackend
) monitor_block_backends
=
83 QTAILQ_HEAD_INITIALIZER(monitor_block_backends
);
85 static void blk_root_inherit_options(int *child_flags
, QDict
*child_options
,
86 int parent_flags
, QDict
*parent_options
)
88 /* We're not supposed to call this function for root nodes */
92 static const BdrvChildRole child_root
= {
93 .inherit_options
= blk_root_inherit_options
,
97 * Create a new BlockBackend with a reference count of one.
98 * Store an error through @errp on failure, unless it's null.
99 * Return the new BlockBackend on success, null on failure.
101 BlockBackend
*blk_new(Error
**errp
)
105 blk
= g_new0(BlockBackend
, 1);
107 notifier_list_init(&blk
->remove_bs_notifiers
);
108 notifier_list_init(&blk
->insert_bs_notifiers
);
109 QTAILQ_INSERT_TAIL(&block_backends
, blk
, link
);
114 * Create a new BlockBackend with a new BlockDriverState attached.
115 * Otherwise just like blk_new(), which see.
117 BlockBackend
*blk_new_with_bs(Error
**errp
)
120 BlockDriverState
*bs
;
127 bs
= bdrv_new_root();
128 blk
->root
= bdrv_root_attach_child(bs
, "root", &child_root
);
134 * Calls blk_new_with_bs() and then calls bdrv_open() on the BlockDriverState.
136 * Just as with bdrv_open(), after having called this function the reference to
137 * @options belongs to the block layer (even on failure).
139 * TODO: Remove @filename and @flags; it should be possible to specify a whole
140 * BDS tree just by specifying the @options QDict (or @reference,
141 * alternatively). At the time of adding this function, this is not possible,
142 * though, so callers of this function have to be able to specify @filename and
145 BlockBackend
*blk_new_open(const char *filename
, const char *reference
,
146 QDict
*options
, int flags
, Error
**errp
)
151 blk
= blk_new_with_bs(errp
);
157 ret
= bdrv_open(&blk
->root
->bs
, filename
, reference
, options
, flags
, errp
);
166 static void blk_delete(BlockBackend
*blk
)
168 assert(!blk
->refcnt
);
174 assert(QLIST_EMPTY(&blk
->remove_bs_notifiers
.notifiers
));
175 assert(QLIST_EMPTY(&blk
->insert_bs_notifiers
.notifiers
));
176 if (blk
->root_state
.throttle_state
) {
177 g_free(blk
->root_state
.throttle_group
);
178 throttle_group_unref(blk
->root_state
.throttle_state
);
180 QTAILQ_REMOVE(&block_backends
, blk
, link
);
181 drive_info_del(blk
->legacy_dinfo
);
182 block_acct_cleanup(&blk
->stats
);
186 static void drive_info_del(DriveInfo
*dinfo
)
191 qemu_opts_del(dinfo
->opts
);
192 g_free(dinfo
->serial
);
196 int blk_get_refcnt(BlockBackend
*blk
)
198 return blk
? blk
->refcnt
: 0;
202 * Increment @blk's reference count.
203 * @blk must not be null.
205 void blk_ref(BlockBackend
*blk
)
211 * Decrement @blk's reference count.
212 * If this drops it to zero, destroy @blk.
213 * For convenience, do nothing if @blk is null.
215 void blk_unref(BlockBackend
*blk
)
218 assert(blk
->refcnt
> 0);
219 if (!--blk
->refcnt
) {
226 * Behaves similarly to blk_next() but iterates over all BlockBackends, even the
227 * ones which are hidden (i.e. are not referenced by the monitor).
229 static BlockBackend
*blk_all_next(BlockBackend
*blk
)
231 return blk
? QTAILQ_NEXT(blk
, link
)
232 : QTAILQ_FIRST(&block_backends
);
235 void blk_remove_all_bs(void)
237 BlockBackend
*blk
= NULL
;
239 while ((blk
= blk_all_next(blk
)) != NULL
) {
240 AioContext
*ctx
= blk_get_aio_context(blk
);
242 aio_context_acquire(ctx
);
246 aio_context_release(ctx
);
251 * Return the monitor-owned BlockBackend after @blk.
252 * If @blk is null, return the first one.
253 * Else, return @blk's next sibling, which may be null.
255 * To iterate over all BlockBackends, do
256 * for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
260 BlockBackend
*blk_next(BlockBackend
*blk
)
262 return blk
? QTAILQ_NEXT(blk
, monitor_link
)
263 : QTAILQ_FIRST(&monitor_block_backends
);
267 * Iterates over all BlockDriverStates which are attached to a BlockBackend.
268 * This function is for use by bdrv_next().
270 * @bs must be NULL or a BDS that is attached to a BB.
272 BlockDriverState
*blk_next_root_bs(BlockDriverState
*bs
)
284 blk
= blk_all_next(blk
);
285 } while (blk
&& !blk
->root
);
287 return blk
? blk
->root
->bs
: NULL
;
291 * Add a BlockBackend into the list of backends referenced by the monitor, with
292 * the given @name acting as the handle for the monitor.
293 * Strictly for use by blockdev.c.
295 * @name must not be null or empty.
297 * Returns true on success and false on failure. In the latter case, an Error
298 * object is returned through @errp.
300 bool monitor_add_blk(BlockBackend
*blk
, const char *name
, Error
**errp
)
303 assert(name
&& name
[0]);
305 if (!id_wellformed(name
)) {
306 error_setg(errp
, "Invalid device name");
309 if (blk_by_name(name
)) {
310 error_setg(errp
, "Device with id '%s' already exists", name
);
313 if (bdrv_find_node(name
)) {
315 "Device name '%s' conflicts with an existing node name",
320 blk
->name
= g_strdup(name
);
321 QTAILQ_INSERT_TAIL(&monitor_block_backends
, blk
, monitor_link
);
326 * Remove a BlockBackend from the list of backends referenced by the monitor.
327 * Strictly for use by blockdev.c.
329 void monitor_remove_blk(BlockBackend
*blk
)
335 QTAILQ_REMOVE(&monitor_block_backends
, blk
, monitor_link
);
341 * Return @blk's name, a non-null string.
342 * Returns an empty string iff @blk is not referenced by the monitor.
344 const char *blk_name(BlockBackend
*blk
)
346 return blk
->name
?: "";
350 * Return the BlockBackend with name @name if it exists, else null.
351 * @name must not be null.
353 BlockBackend
*blk_by_name(const char *name
)
355 BlockBackend
*blk
= NULL
;
358 while ((blk
= blk_next(blk
)) != NULL
) {
359 if (!strcmp(name
, blk
->name
)) {
367 * Return the BlockDriverState attached to @blk if any, else null.
369 BlockDriverState
*blk_bs(BlockBackend
*blk
)
371 return blk
->root
? blk
->root
->bs
: NULL
;
375 * Changes the BlockDriverState attached to @blk
377 void blk_set_bs(BlockBackend
*blk
, BlockDriverState
*bs
)
382 blk
->root
->bs
->blk
= NULL
;
383 bdrv_root_unref_child(blk
->root
);
385 assert(bs
->blk
== NULL
);
387 blk
->root
= bdrv_root_attach_child(bs
, "root", &child_root
);
392 * Return @blk's DriveInfo if any, else null.
394 DriveInfo
*blk_legacy_dinfo(BlockBackend
*blk
)
396 return blk
->legacy_dinfo
;
400 * Set @blk's DriveInfo to @dinfo, and return it.
401 * @blk must not have a DriveInfo set already.
402 * No other BlockBackend may have the same DriveInfo set.
404 DriveInfo
*blk_set_legacy_dinfo(BlockBackend
*blk
, DriveInfo
*dinfo
)
406 assert(!blk
->legacy_dinfo
);
407 return blk
->legacy_dinfo
= dinfo
;
411 * Return the BlockBackend with DriveInfo @dinfo.
414 BlockBackend
*blk_by_legacy_dinfo(DriveInfo
*dinfo
)
416 BlockBackend
*blk
= NULL
;
418 while ((blk
= blk_next(blk
)) != NULL
) {
419 if (blk
->legacy_dinfo
== dinfo
) {
427 * Disassociates the currently associated BlockDriverState from @blk.
429 void blk_remove_bs(BlockBackend
*blk
)
431 assert(blk
->root
->bs
->blk
== blk
);
433 notifier_list_notify(&blk
->remove_bs_notifiers
, blk
);
435 blk_update_root_state(blk
);
437 blk
->root
->bs
->blk
= NULL
;
438 bdrv_root_unref_child(blk
->root
);
443 * Associates a new BlockDriverState with @blk.
445 void blk_insert_bs(BlockBackend
*blk
, BlockDriverState
*bs
)
447 assert(!blk
->root
&& !bs
->blk
);
449 blk
->root
= bdrv_root_attach_child(bs
, "root", &child_root
);
452 notifier_list_notify(&blk
->insert_bs_notifiers
, blk
);
456 * Attach device model @dev to @blk.
457 * Return 0 on success, -EBUSY when a device model is attached already.
459 int blk_attach_dev(BlockBackend
*blk
, void *dev
)
460 /* TODO change to DeviceState *dev when all users are qdevified */
467 blk_iostatus_reset(blk
);
472 * Attach device model @dev to @blk.
473 * @blk must not have a device model attached already.
474 * TODO qdevified devices don't use this, remove when devices are qdevified
476 void blk_attach_dev_nofail(BlockBackend
*blk
, void *dev
)
478 if (blk_attach_dev(blk
, dev
) < 0) {
484 * Detach device model @dev from @blk.
485 * @dev must be currently attached to @blk.
487 void blk_detach_dev(BlockBackend
*blk
, void *dev
)
488 /* TODO change to DeviceState *dev when all users are qdevified */
490 assert(blk
->dev
== dev
);
493 blk
->dev_opaque
= NULL
;
494 blk
->guest_block_size
= 512;
499 * Return the device model attached to @blk if any, else null.
501 void *blk_get_attached_dev(BlockBackend
*blk
)
502 /* TODO change to return DeviceState * when all users are qdevified */
508 * Set @blk's device model callbacks to @ops.
509 * @opaque is the opaque argument to pass to the callbacks.
510 * This is for use by device models.
512 void blk_set_dev_ops(BlockBackend
*blk
, const BlockDevOps
*ops
,
516 blk
->dev_opaque
= opaque
;
520 * Notify @blk's attached device model of media change.
521 * If @load is true, notify of media load.
522 * Else, notify of media eject.
523 * Also send DEVICE_TRAY_MOVED events as appropriate.
525 void blk_dev_change_media_cb(BlockBackend
*blk
, bool load
)
527 if (blk
->dev_ops
&& blk
->dev_ops
->change_media_cb
) {
528 bool tray_was_open
, tray_is_open
;
530 tray_was_open
= blk_dev_is_tray_open(blk
);
531 blk
->dev_ops
->change_media_cb(blk
->dev_opaque
, load
);
532 tray_is_open
= blk_dev_is_tray_open(blk
);
534 if (tray_was_open
!= tray_is_open
) {
535 qapi_event_send_device_tray_moved(blk_name(blk
), tray_is_open
,
542 * Does @blk's attached device model have removable media?
543 * %true if no device model is attached.
545 bool blk_dev_has_removable_media(BlockBackend
*blk
)
547 return !blk
->dev
|| (blk
->dev_ops
&& blk
->dev_ops
->change_media_cb
);
551 * Does @blk's attached device model have a tray?
553 bool blk_dev_has_tray(BlockBackend
*blk
)
555 return blk
->dev_ops
&& blk
->dev_ops
->is_tray_open
;
559 * Notify @blk's attached device model of a media eject request.
560 * If @force is true, the medium is about to be yanked out forcefully.
562 void blk_dev_eject_request(BlockBackend
*blk
, bool force
)
564 if (blk
->dev_ops
&& blk
->dev_ops
->eject_request_cb
) {
565 blk
->dev_ops
->eject_request_cb(blk
->dev_opaque
, force
);
570 * Does @blk's attached device model have a tray, and is it open?
572 bool blk_dev_is_tray_open(BlockBackend
*blk
)
574 if (blk_dev_has_tray(blk
)) {
575 return blk
->dev_ops
->is_tray_open(blk
->dev_opaque
);
581 * Does @blk's attached device model have the medium locked?
582 * %false if the device model has no such lock.
584 bool blk_dev_is_medium_locked(BlockBackend
*blk
)
586 if (blk
->dev_ops
&& blk
->dev_ops
->is_medium_locked
) {
587 return blk
->dev_ops
->is_medium_locked(blk
->dev_opaque
);
593 * Notify @blk's attached device model of a backend size change.
595 void blk_dev_resize_cb(BlockBackend
*blk
)
597 if (blk
->dev_ops
&& blk
->dev_ops
->resize_cb
) {
598 blk
->dev_ops
->resize_cb(blk
->dev_opaque
);
602 void blk_iostatus_enable(BlockBackend
*blk
)
604 blk
->iostatus_enabled
= true;
605 blk
->iostatus
= BLOCK_DEVICE_IO_STATUS_OK
;
608 /* The I/O status is only enabled if the drive explicitly
609 * enables it _and_ the VM is configured to stop on errors */
610 bool blk_iostatus_is_enabled(const BlockBackend
*blk
)
612 return (blk
->iostatus_enabled
&&
613 (blk
->on_write_error
== BLOCKDEV_ON_ERROR_ENOSPC
||
614 blk
->on_write_error
== BLOCKDEV_ON_ERROR_STOP
||
615 blk
->on_read_error
== BLOCKDEV_ON_ERROR_STOP
));
618 BlockDeviceIoStatus
blk_iostatus(const BlockBackend
*blk
)
620 return blk
->iostatus
;
623 void blk_iostatus_disable(BlockBackend
*blk
)
625 blk
->iostatus_enabled
= false;
628 void blk_iostatus_reset(BlockBackend
*blk
)
630 if (blk_iostatus_is_enabled(blk
)) {
631 BlockDriverState
*bs
= blk_bs(blk
);
632 blk
->iostatus
= BLOCK_DEVICE_IO_STATUS_OK
;
634 block_job_iostatus_reset(bs
->job
);
639 void blk_iostatus_set_err(BlockBackend
*blk
, int error
)
641 assert(blk_iostatus_is_enabled(blk
));
642 if (blk
->iostatus
== BLOCK_DEVICE_IO_STATUS_OK
) {
643 blk
->iostatus
= error
== ENOSPC
? BLOCK_DEVICE_IO_STATUS_NOSPACE
:
644 BLOCK_DEVICE_IO_STATUS_FAILED
;
648 void blk_set_allow_write_beyond_eof(BlockBackend
*blk
, bool allow
)
650 blk
->allow_write_beyond_eof
= allow
;
653 static int blk_check_byte_request(BlockBackend
*blk
, int64_t offset
,
658 if (size
> INT_MAX
) {
662 if (!blk_is_available(blk
)) {
670 if (!blk
->allow_write_beyond_eof
) {
671 len
= blk_getlength(blk
);
676 if (offset
> len
|| len
- offset
< size
) {
684 static int blk_check_request(BlockBackend
*blk
, int64_t sector_num
,
687 if (sector_num
< 0 || sector_num
> INT64_MAX
/ BDRV_SECTOR_SIZE
) {
691 if (nb_sectors
< 0 || nb_sectors
> INT_MAX
/ BDRV_SECTOR_SIZE
) {
695 return blk_check_byte_request(blk
, sector_num
* BDRV_SECTOR_SIZE
,
696 nb_sectors
* BDRV_SECTOR_SIZE
);
699 static int coroutine_fn
blk_co_preadv(BlockBackend
*blk
, int64_t offset
,
700 unsigned int bytes
, QEMUIOVector
*qiov
,
701 BdrvRequestFlags flags
)
703 int ret
= blk_check_byte_request(blk
, offset
, bytes
);
708 return bdrv_co_do_preadv(blk_bs(blk
), offset
, bytes
, qiov
, flags
);
711 static int coroutine_fn
blk_co_pwritev(BlockBackend
*blk
, int64_t offset
,
712 unsigned int bytes
, QEMUIOVector
*qiov
,
713 BdrvRequestFlags flags
)
715 int ret
= blk_check_byte_request(blk
, offset
, bytes
);
720 return bdrv_co_do_pwritev(blk_bs(blk
), offset
, bytes
, qiov
, flags
);
723 typedef struct BlkRwCo
{
728 BdrvRequestFlags flags
;
731 static void blk_read_entry(void *opaque
)
733 BlkRwCo
*rwco
= opaque
;
735 rwco
->ret
= blk_co_preadv(rwco
->blk
, rwco
->offset
, rwco
->qiov
->size
,
736 rwco
->qiov
, rwco
->flags
);
739 static void blk_write_entry(void *opaque
)
741 BlkRwCo
*rwco
= opaque
;
743 rwco
->ret
= blk_co_pwritev(rwco
->blk
, rwco
->offset
, rwco
->qiov
->size
,
744 rwco
->qiov
, rwco
->flags
);
747 static int blk_prw(BlockBackend
*blk
, int64_t offset
, uint8_t *buf
,
748 int64_t bytes
, CoroutineEntry co_entry
,
749 BdrvRequestFlags flags
)
751 AioContext
*aio_context
;
757 iov
= (struct iovec
) {
761 qemu_iovec_init_external(&qiov
, &iov
, 1);
771 co
= qemu_coroutine_create(co_entry
);
772 qemu_coroutine_enter(co
, &rwco
);
774 aio_context
= blk_get_aio_context(blk
);
775 while (rwco
.ret
== NOT_DONE
) {
776 aio_poll(aio_context
, true);
782 static int blk_rw(BlockBackend
*blk
, int64_t sector_num
, uint8_t *buf
,
783 int nb_sectors
, CoroutineEntry co_entry
,
784 BdrvRequestFlags flags
)
786 if (nb_sectors
< 0 || nb_sectors
> BDRV_REQUEST_MAX_SECTORS
) {
790 return blk_prw(blk
, sector_num
<< BDRV_SECTOR_BITS
, buf
,
791 nb_sectors
<< BDRV_SECTOR_BITS
, co_entry
, flags
);
794 int blk_read(BlockBackend
*blk
, int64_t sector_num
, uint8_t *buf
,
797 return blk_rw(blk
, sector_num
, buf
, nb_sectors
, blk_read_entry
, 0);
800 int blk_read_unthrottled(BlockBackend
*blk
, int64_t sector_num
, uint8_t *buf
,
803 BlockDriverState
*bs
= blk_bs(blk
);
807 ret
= blk_check_request(blk
, sector_num
, nb_sectors
);
812 enabled
= bs
->io_limits_enabled
;
813 bs
->io_limits_enabled
= false;
814 ret
= blk_read(blk
, sector_num
, buf
, nb_sectors
);
815 bs
->io_limits_enabled
= enabled
;
819 int blk_write(BlockBackend
*blk
, int64_t sector_num
, const uint8_t *buf
,
822 return blk_rw(blk
, sector_num
, (uint8_t*) buf
, nb_sectors
,
826 int blk_write_zeroes(BlockBackend
*blk
, int64_t sector_num
,
827 int nb_sectors
, BdrvRequestFlags flags
)
829 return blk_rw(blk
, sector_num
, NULL
, nb_sectors
, blk_write_entry
,
830 BDRV_REQ_ZERO_WRITE
);
833 static void error_callback_bh(void *opaque
)
835 struct BlockBackendAIOCB
*acb
= opaque
;
836 qemu_bh_delete(acb
->bh
);
837 acb
->common
.cb(acb
->common
.opaque
, acb
->ret
);
841 BlockAIOCB
*blk_abort_aio_request(BlockBackend
*blk
,
842 BlockCompletionFunc
*cb
,
843 void *opaque
, int ret
)
845 struct BlockBackendAIOCB
*acb
;
848 acb
= blk_aio_get(&block_backend_aiocb_info
, blk
, cb
, opaque
);
852 bh
= aio_bh_new(blk_get_aio_context(blk
), error_callback_bh
, acb
);
854 qemu_bh_schedule(bh
);
859 typedef struct BlkAioEmAIOCB
{
866 static const AIOCBInfo blk_aio_em_aiocb_info
= {
867 .aiocb_size
= sizeof(BlkAioEmAIOCB
),
870 static void blk_aio_complete(BlkAioEmAIOCB
*acb
)
873 assert(acb
->has_returned
);
874 qemu_bh_delete(acb
->bh
);
876 if (acb
->has_returned
) {
877 acb
->common
.cb(acb
->common
.opaque
, acb
->rwco
.ret
);
882 static void blk_aio_complete_bh(void *opaque
)
884 blk_aio_complete(opaque
);
887 static BlockAIOCB
*blk_aio_prwv(BlockBackend
*blk
, int64_t offset
,
888 QEMUIOVector
*qiov
, CoroutineEntry co_entry
,
889 BdrvRequestFlags flags
,
890 BlockCompletionFunc
*cb
, void *opaque
)
895 acb
= blk_aio_get(&blk_aio_em_aiocb_info
, blk
, cb
, opaque
);
896 acb
->rwco
= (BlkRwCo
) {
904 acb
->has_returned
= false;
906 co
= qemu_coroutine_create(co_entry
);
907 qemu_coroutine_enter(co
, acb
);
909 acb
->has_returned
= true;
910 if (acb
->rwco
.ret
!= NOT_DONE
) {
911 acb
->bh
= aio_bh_new(blk_get_aio_context(blk
), blk_aio_complete_bh
, acb
);
912 qemu_bh_schedule(acb
->bh
);
918 static void blk_aio_read_entry(void *opaque
)
920 BlkAioEmAIOCB
*acb
= opaque
;
921 BlkRwCo
*rwco
= &acb
->rwco
;
923 rwco
->ret
= blk_co_preadv(rwco
->blk
, rwco
->offset
, rwco
->qiov
->size
,
924 rwco
->qiov
, rwco
->flags
);
925 blk_aio_complete(acb
);
928 static void blk_aio_write_entry(void *opaque
)
930 BlkAioEmAIOCB
*acb
= opaque
;
931 BlkRwCo
*rwco
= &acb
->rwco
;
933 rwco
->ret
= blk_co_pwritev(rwco
->blk
, rwco
->offset
,
934 rwco
->qiov
? rwco
->qiov
->size
: 0,
935 rwco
->qiov
, rwco
->flags
);
936 blk_aio_complete(acb
);
939 BlockAIOCB
*blk_aio_write_zeroes(BlockBackend
*blk
, int64_t sector_num
,
940 int nb_sectors
, BdrvRequestFlags flags
,
941 BlockCompletionFunc
*cb
, void *opaque
)
943 if (nb_sectors
< 0 || nb_sectors
> BDRV_REQUEST_MAX_SECTORS
) {
944 return blk_abort_aio_request(blk
, cb
, opaque
, -EINVAL
);
947 return blk_aio_prwv(blk
, sector_num
<< BDRV_SECTOR_BITS
, NULL
,
948 blk_aio_write_entry
, BDRV_REQ_ZERO_WRITE
, cb
, opaque
);
951 int blk_pread(BlockBackend
*blk
, int64_t offset
, void *buf
, int count
)
953 int ret
= blk_prw(blk
, offset
, buf
, count
, blk_read_entry
, 0);
960 int blk_pwrite(BlockBackend
*blk
, int64_t offset
, const void *buf
, int count
)
962 int ret
= blk_prw(blk
, offset
, (void*) buf
, count
, blk_write_entry
, 0);
969 int64_t blk_getlength(BlockBackend
*blk
)
971 if (!blk_is_available(blk
)) {
975 return bdrv_getlength(blk_bs(blk
));
978 void blk_get_geometry(BlockBackend
*blk
, uint64_t *nb_sectors_ptr
)
983 bdrv_get_geometry(blk_bs(blk
), nb_sectors_ptr
);
987 int64_t blk_nb_sectors(BlockBackend
*blk
)
989 if (!blk_is_available(blk
)) {
993 return bdrv_nb_sectors(blk_bs(blk
));
996 BlockAIOCB
*blk_aio_readv(BlockBackend
*blk
, int64_t sector_num
,
997 QEMUIOVector
*iov
, int nb_sectors
,
998 BlockCompletionFunc
*cb
, void *opaque
)
1000 if (nb_sectors
< 0 || nb_sectors
> BDRV_REQUEST_MAX_SECTORS
) {
1001 return blk_abort_aio_request(blk
, cb
, opaque
, -EINVAL
);
1004 return blk_aio_prwv(blk
, sector_num
<< BDRV_SECTOR_BITS
, iov
,
1005 blk_aio_read_entry
, 0, cb
, opaque
);
1008 BlockAIOCB
*blk_aio_writev(BlockBackend
*blk
, int64_t sector_num
,
1009 QEMUIOVector
*iov
, int nb_sectors
,
1010 BlockCompletionFunc
*cb
, void *opaque
)
1012 if (nb_sectors
< 0 || nb_sectors
> BDRV_REQUEST_MAX_SECTORS
) {
1013 return blk_abort_aio_request(blk
, cb
, opaque
, -EINVAL
);
1016 return blk_aio_prwv(blk
, sector_num
<< BDRV_SECTOR_BITS
, iov
,
1017 blk_aio_write_entry
, 0, cb
, opaque
);
1020 BlockAIOCB
*blk_aio_flush(BlockBackend
*blk
,
1021 BlockCompletionFunc
*cb
, void *opaque
)
1023 if (!blk_is_available(blk
)) {
1024 return blk_abort_aio_request(blk
, cb
, opaque
, -ENOMEDIUM
);
1027 return bdrv_aio_flush(blk_bs(blk
), cb
, opaque
);
1030 BlockAIOCB
*blk_aio_discard(BlockBackend
*blk
,
1031 int64_t sector_num
, int nb_sectors
,
1032 BlockCompletionFunc
*cb
, void *opaque
)
1034 int ret
= blk_check_request(blk
, sector_num
, nb_sectors
);
1036 return blk_abort_aio_request(blk
, cb
, opaque
, ret
);
1039 return bdrv_aio_discard(blk_bs(blk
), sector_num
, nb_sectors
, cb
, opaque
);
1042 void blk_aio_cancel(BlockAIOCB
*acb
)
1044 bdrv_aio_cancel(acb
);
1047 void blk_aio_cancel_async(BlockAIOCB
*acb
)
1049 bdrv_aio_cancel_async(acb
);
1052 int blk_aio_multiwrite(BlockBackend
*blk
, BlockRequest
*reqs
, int num_reqs
)
1056 for (i
= 0; i
< num_reqs
; i
++) {
1057 ret
= blk_check_request(blk
, reqs
[i
].sector
, reqs
[i
].nb_sectors
);
1063 return bdrv_aio_multiwrite(blk_bs(blk
), reqs
, num_reqs
);
1066 int blk_ioctl(BlockBackend
*blk
, unsigned long int req
, void *buf
)
1068 if (!blk_is_available(blk
)) {
1072 return bdrv_ioctl(blk_bs(blk
), req
, buf
);
1075 BlockAIOCB
*blk_aio_ioctl(BlockBackend
*blk
, unsigned long int req
, void *buf
,
1076 BlockCompletionFunc
*cb
, void *opaque
)
1078 if (!blk_is_available(blk
)) {
1079 return blk_abort_aio_request(blk
, cb
, opaque
, -ENOMEDIUM
);
1082 return bdrv_aio_ioctl(blk_bs(blk
), req
, buf
, cb
, opaque
);
1085 int blk_co_discard(BlockBackend
*blk
, int64_t sector_num
, int nb_sectors
)
1087 int ret
= blk_check_request(blk
, sector_num
, nb_sectors
);
1092 return bdrv_co_discard(blk_bs(blk
), sector_num
, nb_sectors
);
1095 int blk_co_flush(BlockBackend
*blk
)
1097 if (!blk_is_available(blk
)) {
1101 return bdrv_co_flush(blk_bs(blk
));
1104 int blk_flush(BlockBackend
*blk
)
1106 if (!blk_is_available(blk
)) {
1110 return bdrv_flush(blk_bs(blk
));
1113 void blk_drain(BlockBackend
*blk
)
1116 bdrv_drain(blk_bs(blk
));
1120 void blk_drain_all(void)
1125 void blk_set_on_error(BlockBackend
*blk
, BlockdevOnError on_read_error
,
1126 BlockdevOnError on_write_error
)
1128 blk
->on_read_error
= on_read_error
;
1129 blk
->on_write_error
= on_write_error
;
1132 BlockdevOnError
blk_get_on_error(BlockBackend
*blk
, bool is_read
)
1134 return is_read
? blk
->on_read_error
: blk
->on_write_error
;
1137 BlockErrorAction
blk_get_error_action(BlockBackend
*blk
, bool is_read
,
1140 BlockdevOnError on_err
= blk_get_on_error(blk
, is_read
);
1143 case BLOCKDEV_ON_ERROR_ENOSPC
:
1144 return (error
== ENOSPC
) ?
1145 BLOCK_ERROR_ACTION_STOP
: BLOCK_ERROR_ACTION_REPORT
;
1146 case BLOCKDEV_ON_ERROR_STOP
:
1147 return BLOCK_ERROR_ACTION_STOP
;
1148 case BLOCKDEV_ON_ERROR_REPORT
:
1149 return BLOCK_ERROR_ACTION_REPORT
;
1150 case BLOCKDEV_ON_ERROR_IGNORE
:
1151 return BLOCK_ERROR_ACTION_IGNORE
;
1157 static void send_qmp_error_event(BlockBackend
*blk
,
1158 BlockErrorAction action
,
1159 bool is_read
, int error
)
1161 IoOperationType optype
;
1163 optype
= is_read
? IO_OPERATION_TYPE_READ
: IO_OPERATION_TYPE_WRITE
;
1164 qapi_event_send_block_io_error(blk_name(blk
), optype
, action
,
1165 blk_iostatus_is_enabled(blk
),
1166 error
== ENOSPC
, strerror(error
),
1170 /* This is done by device models because, while the block layer knows
1171 * about the error, it does not know whether an operation comes from
1172 * the device or the block layer (from a job, for example).
1174 void blk_error_action(BlockBackend
*blk
, BlockErrorAction action
,
1175 bool is_read
, int error
)
1179 if (action
== BLOCK_ERROR_ACTION_STOP
) {
1180 /* First set the iostatus, so that "info block" returns an iostatus
1181 * that matches the events raised so far (an additional error iostatus
1182 * is fine, but not a lost one).
1184 blk_iostatus_set_err(blk
, error
);
1186 /* Then raise the request to stop the VM and the event.
1187 * qemu_system_vmstop_request_prepare has two effects. First,
1188 * it ensures that the STOP event always comes after the
1189 * BLOCK_IO_ERROR event. Second, it ensures that even if management
1190 * can observe the STOP event and do a "cont" before the STOP
1191 * event is issued, the VM will not stop. In this case, vm_start()
1192 * also ensures that the STOP/RESUME pair of events is emitted.
1194 qemu_system_vmstop_request_prepare();
1195 send_qmp_error_event(blk
, action
, is_read
, error
);
1196 qemu_system_vmstop_request(RUN_STATE_IO_ERROR
);
1198 send_qmp_error_event(blk
, action
, is_read
, error
);
1202 int blk_is_read_only(BlockBackend
*blk
)
1204 BlockDriverState
*bs
= blk_bs(blk
);
1207 return bdrv_is_read_only(bs
);
1209 return blk
->root_state
.read_only
;
1213 int blk_is_sg(BlockBackend
*blk
)
1215 BlockDriverState
*bs
= blk_bs(blk
);
1221 return bdrv_is_sg(bs
);
1224 int blk_enable_write_cache(BlockBackend
*blk
)
1226 BlockDriverState
*bs
= blk_bs(blk
);
1229 return bdrv_enable_write_cache(bs
);
1231 return !!(blk
->root_state
.open_flags
& BDRV_O_CACHE_WB
);
1235 void blk_set_enable_write_cache(BlockBackend
*blk
, bool wce
)
1237 BlockDriverState
*bs
= blk_bs(blk
);
1240 bdrv_set_enable_write_cache(bs
, wce
);
1243 blk
->root_state
.open_flags
|= BDRV_O_CACHE_WB
;
1245 blk
->root_state
.open_flags
&= ~BDRV_O_CACHE_WB
;
1250 void blk_invalidate_cache(BlockBackend
*blk
, Error
**errp
)
1252 BlockDriverState
*bs
= blk_bs(blk
);
1255 error_setg(errp
, "Device '%s' has no medium", blk
->name
);
1259 bdrv_invalidate_cache(bs
, errp
);
1262 bool blk_is_inserted(BlockBackend
*blk
)
1264 BlockDriverState
*bs
= blk_bs(blk
);
1266 return bs
&& bdrv_is_inserted(bs
);
1269 bool blk_is_available(BlockBackend
*blk
)
1271 return blk_is_inserted(blk
) && !blk_dev_is_tray_open(blk
);
1274 void blk_lock_medium(BlockBackend
*blk
, bool locked
)
1276 BlockDriverState
*bs
= blk_bs(blk
);
1279 bdrv_lock_medium(bs
, locked
);
1283 void blk_eject(BlockBackend
*blk
, bool eject_flag
)
1285 BlockDriverState
*bs
= blk_bs(blk
);
1288 bdrv_eject(bs
, eject_flag
);
1292 int blk_get_flags(BlockBackend
*blk
)
1294 BlockDriverState
*bs
= blk_bs(blk
);
1297 return bdrv_get_flags(bs
);
1299 return blk
->root_state
.open_flags
;
1303 int blk_get_max_transfer_length(BlockBackend
*blk
)
1305 BlockDriverState
*bs
= blk_bs(blk
);
1308 return bs
->bl
.max_transfer_length
;
1314 int blk_get_max_iov(BlockBackend
*blk
)
1316 return blk
->root
->bs
->bl
.max_iov
;
1319 void blk_set_guest_block_size(BlockBackend
*blk
, int align
)
1321 blk
->guest_block_size
= align
;
1324 void *blk_try_blockalign(BlockBackend
*blk
, size_t size
)
1326 return qemu_try_blockalign(blk
? blk_bs(blk
) : NULL
, size
);
1329 void *blk_blockalign(BlockBackend
*blk
, size_t size
)
1331 return qemu_blockalign(blk
? blk_bs(blk
) : NULL
, size
);
1334 bool blk_op_is_blocked(BlockBackend
*blk
, BlockOpType op
, Error
**errp
)
1336 BlockDriverState
*bs
= blk_bs(blk
);
1342 return bdrv_op_is_blocked(bs
, op
, errp
);
1345 void blk_op_unblock(BlockBackend
*blk
, BlockOpType op
, Error
*reason
)
1347 BlockDriverState
*bs
= blk_bs(blk
);
1350 bdrv_op_unblock(bs
, op
, reason
);
1354 void blk_op_block_all(BlockBackend
*blk
, Error
*reason
)
1356 BlockDriverState
*bs
= blk_bs(blk
);
1359 bdrv_op_block_all(bs
, reason
);
1363 void blk_op_unblock_all(BlockBackend
*blk
, Error
*reason
)
1365 BlockDriverState
*bs
= blk_bs(blk
);
1368 bdrv_op_unblock_all(bs
, reason
);
1372 AioContext
*blk_get_aio_context(BlockBackend
*blk
)
1374 BlockDriverState
*bs
= blk_bs(blk
);
1377 return bdrv_get_aio_context(bs
);
1379 return qemu_get_aio_context();
1383 static AioContext
*blk_aiocb_get_aio_context(BlockAIOCB
*acb
)
1385 BlockBackendAIOCB
*blk_acb
= DO_UPCAST(BlockBackendAIOCB
, common
, acb
);
1386 return blk_get_aio_context(blk_acb
->blk
);
1389 void blk_set_aio_context(BlockBackend
*blk
, AioContext
*new_context
)
1391 BlockDriverState
*bs
= blk_bs(blk
);
1394 bdrv_set_aio_context(bs
, new_context
);
1398 void blk_add_aio_context_notifier(BlockBackend
*blk
,
1399 void (*attached_aio_context
)(AioContext
*new_context
, void *opaque
),
1400 void (*detach_aio_context
)(void *opaque
), void *opaque
)
1402 BlockDriverState
*bs
= blk_bs(blk
);
1405 bdrv_add_aio_context_notifier(bs
, attached_aio_context
,
1406 detach_aio_context
, opaque
);
1410 void blk_remove_aio_context_notifier(BlockBackend
*blk
,
1411 void (*attached_aio_context
)(AioContext
*,
1413 void (*detach_aio_context
)(void *),
1416 BlockDriverState
*bs
= blk_bs(blk
);
1419 bdrv_remove_aio_context_notifier(bs
, attached_aio_context
,
1420 detach_aio_context
, opaque
);
1424 void blk_add_remove_bs_notifier(BlockBackend
*blk
, Notifier
*notify
)
1426 notifier_list_add(&blk
->remove_bs_notifiers
, notify
);
1429 void blk_add_insert_bs_notifier(BlockBackend
*blk
, Notifier
*notify
)
1431 notifier_list_add(&blk
->insert_bs_notifiers
, notify
);
1434 void blk_io_plug(BlockBackend
*blk
)
1436 BlockDriverState
*bs
= blk_bs(blk
);
1443 void blk_io_unplug(BlockBackend
*blk
)
1445 BlockDriverState
*bs
= blk_bs(blk
);
1452 BlockAcctStats
*blk_get_stats(BlockBackend
*blk
)
1457 void *blk_aio_get(const AIOCBInfo
*aiocb_info
, BlockBackend
*blk
,
1458 BlockCompletionFunc
*cb
, void *opaque
)
1460 return qemu_aio_get(aiocb_info
, blk_bs(blk
), cb
, opaque
);
1463 int coroutine_fn
blk_co_write_zeroes(BlockBackend
*blk
, int64_t sector_num
,
1464 int nb_sectors
, BdrvRequestFlags flags
)
1466 if (nb_sectors
< 0 || nb_sectors
> BDRV_REQUEST_MAX_SECTORS
) {
1470 return blk_co_pwritev(blk
, sector_num
<< BDRV_SECTOR_BITS
,
1471 nb_sectors
<< BDRV_SECTOR_BITS
, NULL
,
1472 BDRV_REQ_ZERO_WRITE
);
1475 int blk_write_compressed(BlockBackend
*blk
, int64_t sector_num
,
1476 const uint8_t *buf
, int nb_sectors
)
1478 int ret
= blk_check_request(blk
, sector_num
, nb_sectors
);
1483 return bdrv_write_compressed(blk_bs(blk
), sector_num
, buf
, nb_sectors
);
1486 int blk_truncate(BlockBackend
*blk
, int64_t offset
)
1488 if (!blk_is_available(blk
)) {
1492 return bdrv_truncate(blk_bs(blk
), offset
);
1495 int blk_discard(BlockBackend
*blk
, int64_t sector_num
, int nb_sectors
)
1497 int ret
= blk_check_request(blk
, sector_num
, nb_sectors
);
1502 return bdrv_discard(blk_bs(blk
), sector_num
, nb_sectors
);
1505 int blk_save_vmstate(BlockBackend
*blk
, const uint8_t *buf
,
1506 int64_t pos
, int size
)
1508 if (!blk_is_available(blk
)) {
1512 return bdrv_save_vmstate(blk_bs(blk
), buf
, pos
, size
);
1515 int blk_load_vmstate(BlockBackend
*blk
, uint8_t *buf
, int64_t pos
, int size
)
1517 if (!blk_is_available(blk
)) {
1521 return bdrv_load_vmstate(blk_bs(blk
), buf
, pos
, size
);
1524 int blk_probe_blocksizes(BlockBackend
*blk
, BlockSizes
*bsz
)
1526 if (!blk_is_available(blk
)) {
1530 return bdrv_probe_blocksizes(blk_bs(blk
), bsz
);
1533 int blk_probe_geometry(BlockBackend
*blk
, HDGeometry
*geo
)
1535 if (!blk_is_available(blk
)) {
1539 return bdrv_probe_geometry(blk_bs(blk
), geo
);
1543 * Updates the BlockBackendRootState object with data from the currently
1544 * attached BlockDriverState.
1546 void blk_update_root_state(BlockBackend
*blk
)
1550 blk
->root_state
.open_flags
= blk
->root
->bs
->open_flags
;
1551 blk
->root_state
.read_only
= blk
->root
->bs
->read_only
;
1552 blk
->root_state
.detect_zeroes
= blk
->root
->bs
->detect_zeroes
;
1554 if (blk
->root_state
.throttle_group
) {
1555 g_free(blk
->root_state
.throttle_group
);
1556 throttle_group_unref(blk
->root_state
.throttle_state
);
1558 if (blk
->root
->bs
->throttle_state
) {
1559 const char *name
= throttle_group_get_name(blk
->root
->bs
);
1560 blk
->root_state
.throttle_group
= g_strdup(name
);
1561 blk
->root_state
.throttle_state
= throttle_group_incref(name
);
1563 blk
->root_state
.throttle_group
= NULL
;
1564 blk
->root_state
.throttle_state
= NULL
;
1569 * Applies the information in the root state to the given BlockDriverState. This
1570 * does not include the flags which have to be specified for bdrv_open(), use
1571 * blk_get_open_flags_from_root_state() to inquire them.
1573 void blk_apply_root_state(BlockBackend
*blk
, BlockDriverState
*bs
)
1575 bs
->detect_zeroes
= blk
->root_state
.detect_zeroes
;
1576 if (blk
->root_state
.throttle_group
) {
1577 bdrv_io_limits_enable(bs
, blk
->root_state
.throttle_group
);
1582 * Returns the flags to be used for bdrv_open() of a BlockDriverState which is
1583 * supposed to inherit the root state.
1585 int blk_get_open_flags_from_root_state(BlockBackend
*blk
)
1589 bs_flags
= blk
->root_state
.read_only
? 0 : BDRV_O_RDWR
;
1590 bs_flags
|= blk
->root_state
.open_flags
& ~BDRV_O_RDWR
;
1595 BlockBackendRootState
*blk_get_root_state(BlockBackend
*blk
)
1597 return &blk
->root_state
;
1600 int blk_commit_all(void)
1602 BlockBackend
*blk
= NULL
;
1604 while ((blk
= blk_all_next(blk
)) != NULL
) {
1605 AioContext
*aio_context
= blk_get_aio_context(blk
);
1607 aio_context_acquire(aio_context
);
1608 if (blk_is_inserted(blk
) && blk
->root
->bs
->backing
) {
1609 int ret
= bdrv_commit(blk
->root
->bs
);
1611 aio_context_release(aio_context
);
1615 aio_context_release(aio_context
);
1620 int blk_flush_all(void)
1622 BlockBackend
*blk
= NULL
;
1625 while ((blk
= blk_all_next(blk
)) != NULL
) {
1626 AioContext
*aio_context
= blk_get_aio_context(blk
);
1629 aio_context_acquire(aio_context
);
1630 if (blk_is_inserted(blk
)) {
1631 ret
= blk_flush(blk
);
1632 if (ret
< 0 && !result
) {
1636 aio_context_release(aio_context
);