s390x: wire up diag288 in tcg
[qemu.git] / block / block-backend.c
blob10317424011a34729ee2c9c643d3e1ea9e4ea19f
1 /*
2 * QEMU Block backends
4 * Copyright (C) 2014-2016 Red Hat, Inc.
6 * Authors:
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"
21 #include "qemu/id.h"
22 #include "trace.h"
23 #include "migration/misc.h"
25 /* Number of coroutines to reserve per attached device model */
26 #define COROUTINE_POOL_RESERVATION 64
28 #define NOT_DONE 0x7fffffff /* used while emulated sync operation in progress */
30 static AioContext *blk_aiocb_get_aio_context(BlockAIOCB *acb);
32 struct BlockBackend {
33 char *name;
34 int refcnt;
35 BdrvChild *root;
36 DriveInfo *legacy_dinfo; /* null unless created by drive_new() */
37 QTAILQ_ENTRY(BlockBackend) link; /* for block_backends */
38 QTAILQ_ENTRY(BlockBackend) monitor_link; /* for monitor_block_backends */
39 BlockBackendPublic public;
41 void *dev; /* attached device model, if any */
42 bool legacy_dev; /* true if dev is not a DeviceState */
43 /* TODO change to DeviceState when all users are qdevified */
44 const BlockDevOps *dev_ops;
45 void *dev_opaque;
47 /* the block size for which the guest device expects atomicity */
48 int guest_block_size;
50 /* If the BDS tree is removed, some of its options are stored here (which
51 * can be used to restore those options in the new BDS on insert) */
52 BlockBackendRootState root_state;
54 bool enable_write_cache;
56 /* I/O stats (display with "info blockstats"). */
57 BlockAcctStats stats;
59 BlockdevOnError on_read_error, on_write_error;
60 bool iostatus_enabled;
61 BlockDeviceIoStatus iostatus;
63 uint64_t perm;
64 uint64_t shared_perm;
65 bool disable_perm;
67 bool allow_write_beyond_eof;
69 NotifierList remove_bs_notifiers, insert_bs_notifiers;
71 int quiesce_counter;
72 VMChangeStateEntry *vmsh;
73 bool force_allow_inactivate;
76 typedef struct BlockBackendAIOCB {
77 BlockAIOCB common;
78 BlockBackend *blk;
79 int ret;
80 } BlockBackendAIOCB;
82 static const AIOCBInfo block_backend_aiocb_info = {
83 .get_aio_context = blk_aiocb_get_aio_context,
84 .aiocb_size = sizeof(BlockBackendAIOCB),
87 static void drive_info_del(DriveInfo *dinfo);
88 static BlockBackend *bdrv_first_blk(BlockDriverState *bs);
90 /* All BlockBackends */
91 static QTAILQ_HEAD(, BlockBackend) block_backends =
92 QTAILQ_HEAD_INITIALIZER(block_backends);
94 /* All BlockBackends referenced by the monitor and which are iterated through by
95 * blk_next() */
96 static QTAILQ_HEAD(, BlockBackend) monitor_block_backends =
97 QTAILQ_HEAD_INITIALIZER(monitor_block_backends);
99 static void blk_root_inherit_options(int *child_flags, QDict *child_options,
100 int parent_flags, QDict *parent_options)
102 /* We're not supposed to call this function for root nodes */
103 abort();
105 static void blk_root_drained_begin(BdrvChild *child);
106 static void blk_root_drained_end(BdrvChild *child);
108 static void blk_root_change_media(BdrvChild *child, bool load);
109 static void blk_root_resize(BdrvChild *child);
111 static char *blk_root_get_parent_desc(BdrvChild *child)
113 BlockBackend *blk = child->opaque;
114 char *dev_id;
116 if (blk->name) {
117 return g_strdup(blk->name);
120 dev_id = blk_get_attached_dev_id(blk);
121 if (*dev_id) {
122 return dev_id;
123 } else {
124 /* TODO Callback into the BB owner for something more detailed */
125 g_free(dev_id);
126 return g_strdup("a block device");
130 static const char *blk_root_get_name(BdrvChild *child)
132 return blk_name(child->opaque);
135 static void blk_vm_state_changed(void *opaque, int running, RunState state)
137 Error *local_err = NULL;
138 BlockBackend *blk = opaque;
140 if (state == RUN_STATE_INMIGRATE) {
141 return;
144 qemu_del_vm_change_state_handler(blk->vmsh);
145 blk->vmsh = NULL;
146 blk_set_perm(blk, blk->perm, blk->shared_perm, &local_err);
147 if (local_err) {
148 error_report_err(local_err);
153 * Notifies the user of the BlockBackend that migration has completed. qdev
154 * devices can tighten their permissions in response (specifically revoke
155 * shared write permissions that we needed for storage migration).
157 * If an error is returned, the VM cannot be allowed to be resumed.
159 static void blk_root_activate(BdrvChild *child, Error **errp)
161 BlockBackend *blk = child->opaque;
162 Error *local_err = NULL;
164 if (!blk->disable_perm) {
165 return;
168 blk->disable_perm = false;
170 blk_set_perm(blk, blk->perm, BLK_PERM_ALL, &local_err);
171 if (local_err) {
172 error_propagate(errp, local_err);
173 blk->disable_perm = true;
174 return;
177 if (runstate_check(RUN_STATE_INMIGRATE)) {
178 /* Activation can happen when migration process is still active, for
179 * example when nbd_server_add is called during non-shared storage
180 * migration. Defer the shared_perm update to migration completion. */
181 if (!blk->vmsh) {
182 blk->vmsh = qemu_add_vm_change_state_handler(blk_vm_state_changed,
183 blk);
185 return;
188 blk_set_perm(blk, blk->perm, blk->shared_perm, &local_err);
189 if (local_err) {
190 error_propagate(errp, local_err);
191 blk->disable_perm = true;
192 return;
196 void blk_set_force_allow_inactivate(BlockBackend *blk)
198 blk->force_allow_inactivate = true;
201 static bool blk_can_inactivate(BlockBackend *blk)
203 /* If it is a guest device, inactivate is ok. */
204 if (blk->dev || blk_name(blk)[0]) {
205 return true;
208 /* Inactivating means no more writes to the image can be done,
209 * even if those writes would be changes invisible to the
210 * guest. For block job BBs that satisfy this, we can just allow
211 * it. This is the case for mirror job source, which is required
212 * by libvirt non-shared block migration. */
213 if (!(blk->perm & (BLK_PERM_WRITE | BLK_PERM_WRITE_UNCHANGED))) {
214 return true;
217 return blk->force_allow_inactivate;
220 static int blk_root_inactivate(BdrvChild *child)
222 BlockBackend *blk = child->opaque;
224 if (blk->disable_perm) {
225 return 0;
228 if (!blk_can_inactivate(blk)) {
229 return -EPERM;
232 blk->disable_perm = true;
233 if (blk->root) {
234 bdrv_child_try_set_perm(blk->root, 0, BLK_PERM_ALL, &error_abort);
237 return 0;
240 static const BdrvChildRole child_root = {
241 .inherit_options = blk_root_inherit_options,
243 .change_media = blk_root_change_media,
244 .resize = blk_root_resize,
245 .get_name = blk_root_get_name,
246 .get_parent_desc = blk_root_get_parent_desc,
248 .drained_begin = blk_root_drained_begin,
249 .drained_end = blk_root_drained_end,
251 .activate = blk_root_activate,
252 .inactivate = blk_root_inactivate,
256 * Create a new BlockBackend with a reference count of one.
258 * @perm is a bitmasks of BLK_PERM_* constants which describes the permissions
259 * to request for a block driver node that is attached to this BlockBackend.
260 * @shared_perm is a bitmask which describes which permissions may be granted
261 * to other users of the attached node.
262 * Both sets of permissions can be changed later using blk_set_perm().
264 * Return the new BlockBackend on success, null on failure.
266 BlockBackend *blk_new(uint64_t perm, uint64_t shared_perm)
268 BlockBackend *blk;
270 blk = g_new0(BlockBackend, 1);
271 blk->refcnt = 1;
272 blk->perm = perm;
273 blk->shared_perm = shared_perm;
274 blk_set_enable_write_cache(blk, true);
276 qemu_co_mutex_init(&blk->public.throttled_reqs_lock);
277 qemu_co_queue_init(&blk->public.throttled_reqs[0]);
278 qemu_co_queue_init(&blk->public.throttled_reqs[1]);
279 block_acct_init(&blk->stats);
281 notifier_list_init(&blk->remove_bs_notifiers);
282 notifier_list_init(&blk->insert_bs_notifiers);
284 QTAILQ_INSERT_TAIL(&block_backends, blk, link);
285 return blk;
289 * Creates a new BlockBackend, opens a new BlockDriverState, and connects both.
291 * Just as with bdrv_open(), after having called this function the reference to
292 * @options belongs to the block layer (even on failure).
294 * TODO: Remove @filename and @flags; it should be possible to specify a whole
295 * BDS tree just by specifying the @options QDict (or @reference,
296 * alternatively). At the time of adding this function, this is not possible,
297 * though, so callers of this function have to be able to specify @filename and
298 * @flags.
300 BlockBackend *blk_new_open(const char *filename, const char *reference,
301 QDict *options, int flags, Error **errp)
303 BlockBackend *blk;
304 BlockDriverState *bs;
305 uint64_t perm;
307 /* blk_new_open() is mainly used in .bdrv_create implementations and the
308 * tools where sharing isn't a concern because the BDS stays private, so we
309 * just request permission according to the flags.
311 * The exceptions are xen_disk and blockdev_init(); in these cases, the
312 * caller of blk_new_open() doesn't make use of the permissions, but they
313 * shouldn't hurt either. We can still share everything here because the
314 * guest devices will add their own blockers if they can't share. */
315 perm = BLK_PERM_CONSISTENT_READ;
316 if (flags & BDRV_O_RDWR) {
317 perm |= BLK_PERM_WRITE;
319 if (flags & BDRV_O_RESIZE) {
320 perm |= BLK_PERM_RESIZE;
323 blk = blk_new(perm, BLK_PERM_ALL);
324 bs = bdrv_open(filename, reference, options, flags, errp);
325 if (!bs) {
326 blk_unref(blk);
327 return NULL;
330 blk->root = bdrv_root_attach_child(bs, "root", &child_root,
331 perm, BLK_PERM_ALL, blk, errp);
332 if (!blk->root) {
333 bdrv_unref(bs);
334 blk_unref(blk);
335 return NULL;
338 return blk;
341 static void blk_delete(BlockBackend *blk)
343 assert(!blk->refcnt);
344 assert(!blk->name);
345 assert(!blk->dev);
346 if (blk->public.throttle_state) {
347 blk_io_limits_disable(blk);
349 if (blk->root) {
350 blk_remove_bs(blk);
352 if (blk->vmsh) {
353 qemu_del_vm_change_state_handler(blk->vmsh);
354 blk->vmsh = NULL;
356 assert(QLIST_EMPTY(&blk->remove_bs_notifiers.notifiers));
357 assert(QLIST_EMPTY(&blk->insert_bs_notifiers.notifiers));
358 QTAILQ_REMOVE(&block_backends, blk, link);
359 drive_info_del(blk->legacy_dinfo);
360 block_acct_cleanup(&blk->stats);
361 g_free(blk);
364 static void drive_info_del(DriveInfo *dinfo)
366 if (!dinfo) {
367 return;
369 qemu_opts_del(dinfo->opts);
370 g_free(dinfo->serial);
371 g_free(dinfo);
374 int blk_get_refcnt(BlockBackend *blk)
376 return blk ? blk->refcnt : 0;
380 * Increment @blk's reference count.
381 * @blk must not be null.
383 void blk_ref(BlockBackend *blk)
385 blk->refcnt++;
389 * Decrement @blk's reference count.
390 * If this drops it to zero, destroy @blk.
391 * For convenience, do nothing if @blk is null.
393 void blk_unref(BlockBackend *blk)
395 if (blk) {
396 assert(blk->refcnt > 0);
397 if (!--blk->refcnt) {
398 blk_delete(blk);
404 * Behaves similarly to blk_next() but iterates over all BlockBackends, even the
405 * ones which are hidden (i.e. are not referenced by the monitor).
407 BlockBackend *blk_all_next(BlockBackend *blk)
409 return blk ? QTAILQ_NEXT(blk, link)
410 : QTAILQ_FIRST(&block_backends);
413 void blk_remove_all_bs(void)
415 BlockBackend *blk = NULL;
417 while ((blk = blk_all_next(blk)) != NULL) {
418 AioContext *ctx = blk_get_aio_context(blk);
420 aio_context_acquire(ctx);
421 if (blk->root) {
422 blk_remove_bs(blk);
424 aio_context_release(ctx);
429 * Return the monitor-owned BlockBackend after @blk.
430 * If @blk is null, return the first one.
431 * Else, return @blk's next sibling, which may be null.
433 * To iterate over all BlockBackends, do
434 * for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
435 * ...
438 BlockBackend *blk_next(BlockBackend *blk)
440 return blk ? QTAILQ_NEXT(blk, monitor_link)
441 : QTAILQ_FIRST(&monitor_block_backends);
444 /* Iterates over all top-level BlockDriverStates, i.e. BDSs that are owned by
445 * the monitor or attached to a BlockBackend */
446 BlockDriverState *bdrv_next(BdrvNextIterator *it)
448 BlockDriverState *bs;
450 /* First, return all root nodes of BlockBackends. In order to avoid
451 * returning a BDS twice when multiple BBs refer to it, we only return it
452 * if the BB is the first one in the parent list of the BDS. */
453 if (it->phase == BDRV_NEXT_BACKEND_ROOTS) {
454 do {
455 it->blk = blk_all_next(it->blk);
456 bs = it->blk ? blk_bs(it->blk) : NULL;
457 } while (it->blk && (bs == NULL || bdrv_first_blk(bs) != it->blk));
459 if (bs) {
460 return bs;
462 it->phase = BDRV_NEXT_MONITOR_OWNED;
465 /* Then return the monitor-owned BDSes without a BB attached. Ignore all
466 * BDSes that are attached to a BlockBackend here; they have been handled
467 * by the above block already */
468 do {
469 it->bs = bdrv_next_monitor_owned(it->bs);
470 bs = it->bs;
471 } while (bs && bdrv_has_blk(bs));
473 return bs;
476 BlockDriverState *bdrv_first(BdrvNextIterator *it)
478 *it = (BdrvNextIterator) {
479 .phase = BDRV_NEXT_BACKEND_ROOTS,
482 return bdrv_next(it);
486 * Add a BlockBackend into the list of backends referenced by the monitor, with
487 * the given @name acting as the handle for the monitor.
488 * Strictly for use by blockdev.c.
490 * @name must not be null or empty.
492 * Returns true on success and false on failure. In the latter case, an Error
493 * object is returned through @errp.
495 bool monitor_add_blk(BlockBackend *blk, const char *name, Error **errp)
497 assert(!blk->name);
498 assert(name && name[0]);
500 if (!id_wellformed(name)) {
501 error_setg(errp, "Invalid device name");
502 return false;
504 if (blk_by_name(name)) {
505 error_setg(errp, "Device with id '%s' already exists", name);
506 return false;
508 if (bdrv_find_node(name)) {
509 error_setg(errp,
510 "Device name '%s' conflicts with an existing node name",
511 name);
512 return false;
515 blk->name = g_strdup(name);
516 QTAILQ_INSERT_TAIL(&monitor_block_backends, blk, monitor_link);
517 return true;
521 * Remove a BlockBackend from the list of backends referenced by the monitor.
522 * Strictly for use by blockdev.c.
524 void monitor_remove_blk(BlockBackend *blk)
526 if (!blk->name) {
527 return;
530 QTAILQ_REMOVE(&monitor_block_backends, blk, monitor_link);
531 g_free(blk->name);
532 blk->name = NULL;
536 * Return @blk's name, a non-null string.
537 * Returns an empty string iff @blk is not referenced by the monitor.
539 const char *blk_name(const BlockBackend *blk)
541 return blk->name ?: "";
545 * Return the BlockBackend with name @name if it exists, else null.
546 * @name must not be null.
548 BlockBackend *blk_by_name(const char *name)
550 BlockBackend *blk = NULL;
552 assert(name);
553 while ((blk = blk_next(blk)) != NULL) {
554 if (!strcmp(name, blk->name)) {
555 return blk;
558 return NULL;
562 * Return the BlockDriverState attached to @blk if any, else null.
564 BlockDriverState *blk_bs(BlockBackend *blk)
566 return blk->root ? blk->root->bs : NULL;
569 static BlockBackend *bdrv_first_blk(BlockDriverState *bs)
571 BdrvChild *child;
572 QLIST_FOREACH(child, &bs->parents, next_parent) {
573 if (child->role == &child_root) {
574 return child->opaque;
578 return NULL;
582 * Returns true if @bs has an associated BlockBackend.
584 bool bdrv_has_blk(BlockDriverState *bs)
586 return bdrv_first_blk(bs) != NULL;
590 * Returns true if @bs has only BlockBackends as parents.
592 bool bdrv_is_root_node(BlockDriverState *bs)
594 BdrvChild *c;
596 QLIST_FOREACH(c, &bs->parents, next_parent) {
597 if (c->role != &child_root) {
598 return false;
602 return true;
606 * Return @blk's DriveInfo if any, else null.
608 DriveInfo *blk_legacy_dinfo(BlockBackend *blk)
610 return blk->legacy_dinfo;
614 * Set @blk's DriveInfo to @dinfo, and return it.
615 * @blk must not have a DriveInfo set already.
616 * No other BlockBackend may have the same DriveInfo set.
618 DriveInfo *blk_set_legacy_dinfo(BlockBackend *blk, DriveInfo *dinfo)
620 assert(!blk->legacy_dinfo);
621 return blk->legacy_dinfo = dinfo;
625 * Return the BlockBackend with DriveInfo @dinfo.
626 * It must exist.
628 BlockBackend *blk_by_legacy_dinfo(DriveInfo *dinfo)
630 BlockBackend *blk = NULL;
632 while ((blk = blk_next(blk)) != NULL) {
633 if (blk->legacy_dinfo == dinfo) {
634 return blk;
637 abort();
641 * Returns a pointer to the publicly accessible fields of @blk.
643 BlockBackendPublic *blk_get_public(BlockBackend *blk)
645 return &blk->public;
649 * Returns a BlockBackend given the associated @public fields.
651 BlockBackend *blk_by_public(BlockBackendPublic *public)
653 return container_of(public, BlockBackend, public);
657 * Disassociates the currently associated BlockDriverState from @blk.
659 void blk_remove_bs(BlockBackend *blk)
661 notifier_list_notify(&blk->remove_bs_notifiers, blk);
662 if (blk->public.throttle_state) {
663 throttle_timers_detach_aio_context(&blk->public.throttle_timers);
666 blk_update_root_state(blk);
668 bdrv_root_unref_child(blk->root);
669 blk->root = NULL;
673 * Associates a new BlockDriverState with @blk.
675 int blk_insert_bs(BlockBackend *blk, BlockDriverState *bs, Error **errp)
677 blk->root = bdrv_root_attach_child(bs, "root", &child_root,
678 blk->perm, blk->shared_perm, blk, errp);
679 if (blk->root == NULL) {
680 return -EPERM;
682 bdrv_ref(bs);
684 notifier_list_notify(&blk->insert_bs_notifiers, blk);
685 if (blk->public.throttle_state) {
686 throttle_timers_attach_aio_context(
687 &blk->public.throttle_timers, bdrv_get_aio_context(bs));
690 return 0;
694 * Sets the permission bitmasks that the user of the BlockBackend needs.
696 int blk_set_perm(BlockBackend *blk, uint64_t perm, uint64_t shared_perm,
697 Error **errp)
699 int ret;
701 if (blk->root && !blk->disable_perm) {
702 ret = bdrv_child_try_set_perm(blk->root, perm, shared_perm, errp);
703 if (ret < 0) {
704 return ret;
708 blk->perm = perm;
709 blk->shared_perm = shared_perm;
711 return 0;
714 void blk_get_perm(BlockBackend *blk, uint64_t *perm, uint64_t *shared_perm)
716 *perm = blk->perm;
717 *shared_perm = blk->shared_perm;
720 static int blk_do_attach_dev(BlockBackend *blk, void *dev)
722 if (blk->dev) {
723 return -EBUSY;
726 /* While migration is still incoming, we don't need to apply the
727 * permissions of guest device BlockBackends. We might still have a block
728 * job or NBD server writing to the image for storage migration. */
729 if (runstate_check(RUN_STATE_INMIGRATE)) {
730 blk->disable_perm = true;
733 blk_ref(blk);
734 blk->dev = dev;
735 blk->legacy_dev = false;
736 blk_iostatus_reset(blk);
738 return 0;
742 * Attach device model @dev to @blk.
743 * Return 0 on success, -EBUSY when a device model is attached already.
745 int blk_attach_dev(BlockBackend *blk, DeviceState *dev)
747 return blk_do_attach_dev(blk, dev);
751 * Attach device model @dev to @blk.
752 * @blk must not have a device model attached already.
753 * TODO qdevified devices don't use this, remove when devices are qdevified
755 void blk_attach_dev_legacy(BlockBackend *blk, void *dev)
757 if (blk_do_attach_dev(blk, dev) < 0) {
758 abort();
760 blk->legacy_dev = true;
764 * Detach device model @dev from @blk.
765 * @dev must be currently attached to @blk.
767 void blk_detach_dev(BlockBackend *blk, void *dev)
768 /* TODO change to DeviceState *dev when all users are qdevified */
770 assert(blk->dev == dev);
771 blk->dev = NULL;
772 blk->dev_ops = NULL;
773 blk->dev_opaque = NULL;
774 blk->guest_block_size = 512;
775 blk_set_perm(blk, 0, BLK_PERM_ALL, &error_abort);
776 blk_unref(blk);
780 * Return the device model attached to @blk if any, else null.
782 void *blk_get_attached_dev(BlockBackend *blk)
783 /* TODO change to return DeviceState * when all users are qdevified */
785 return blk->dev;
788 /* Return the qdev ID, or if no ID is assigned the QOM path, of the block
789 * device attached to the BlockBackend. */
790 char *blk_get_attached_dev_id(BlockBackend *blk)
792 DeviceState *dev;
794 assert(!blk->legacy_dev);
795 dev = blk->dev;
797 if (!dev) {
798 return g_strdup("");
799 } else if (dev->id) {
800 return g_strdup(dev->id);
802 return object_get_canonical_path(OBJECT(dev));
806 * Return the BlockBackend which has the device model @dev attached if it
807 * exists, else null.
809 * @dev must not be null.
811 BlockBackend *blk_by_dev(void *dev)
813 BlockBackend *blk = NULL;
815 assert(dev != NULL);
816 while ((blk = blk_all_next(blk)) != NULL) {
817 if (blk->dev == dev) {
818 return blk;
821 return NULL;
825 * Set @blk's device model callbacks to @ops.
826 * @opaque is the opaque argument to pass to the callbacks.
827 * This is for use by device models.
829 void blk_set_dev_ops(BlockBackend *blk, const BlockDevOps *ops,
830 void *opaque)
832 /* All drivers that use blk_set_dev_ops() are qdevified and we want to keep
833 * it that way, so we can assume blk->dev, if present, is a DeviceState if
834 * blk->dev_ops is set. Non-device users may use dev_ops without device. */
835 assert(!blk->legacy_dev);
837 blk->dev_ops = ops;
838 blk->dev_opaque = opaque;
840 /* Are we currently quiesced? Should we enforce this right now? */
841 if (blk->quiesce_counter && ops->drained_begin) {
842 ops->drained_begin(opaque);
847 * Notify @blk's attached device model of media change.
849 * If @load is true, notify of media load. This action can fail, meaning that
850 * the medium cannot be loaded. @errp is set then.
852 * If @load is false, notify of media eject. This can never fail.
854 * Also send DEVICE_TRAY_MOVED events as appropriate.
856 void blk_dev_change_media_cb(BlockBackend *blk, bool load, Error **errp)
858 if (blk->dev_ops && blk->dev_ops->change_media_cb) {
859 bool tray_was_open, tray_is_open;
860 Error *local_err = NULL;
862 assert(!blk->legacy_dev);
864 tray_was_open = blk_dev_is_tray_open(blk);
865 blk->dev_ops->change_media_cb(blk->dev_opaque, load, &local_err);
866 if (local_err) {
867 assert(load == true);
868 error_propagate(errp, local_err);
869 return;
871 tray_is_open = blk_dev_is_tray_open(blk);
873 if (tray_was_open != tray_is_open) {
874 char *id = blk_get_attached_dev_id(blk);
875 qapi_event_send_device_tray_moved(blk_name(blk), id, tray_is_open,
876 &error_abort);
877 g_free(id);
882 static void blk_root_change_media(BdrvChild *child, bool load)
884 blk_dev_change_media_cb(child->opaque, load, NULL);
888 * Does @blk's attached device model have removable media?
889 * %true if no device model is attached.
891 bool blk_dev_has_removable_media(BlockBackend *blk)
893 return !blk->dev || (blk->dev_ops && blk->dev_ops->change_media_cb);
897 * Does @blk's attached device model have a tray?
899 bool blk_dev_has_tray(BlockBackend *blk)
901 return blk->dev_ops && blk->dev_ops->is_tray_open;
905 * Notify @blk's attached device model of a media eject request.
906 * If @force is true, the medium is about to be yanked out forcefully.
908 void blk_dev_eject_request(BlockBackend *blk, bool force)
910 if (blk->dev_ops && blk->dev_ops->eject_request_cb) {
911 blk->dev_ops->eject_request_cb(blk->dev_opaque, force);
916 * Does @blk's attached device model have a tray, and is it open?
918 bool blk_dev_is_tray_open(BlockBackend *blk)
920 if (blk_dev_has_tray(blk)) {
921 return blk->dev_ops->is_tray_open(blk->dev_opaque);
923 return false;
927 * Does @blk's attached device model have the medium locked?
928 * %false if the device model has no such lock.
930 bool blk_dev_is_medium_locked(BlockBackend *blk)
932 if (blk->dev_ops && blk->dev_ops->is_medium_locked) {
933 return blk->dev_ops->is_medium_locked(blk->dev_opaque);
935 return false;
939 * Notify @blk's attached device model of a backend size change.
941 static void blk_root_resize(BdrvChild *child)
943 BlockBackend *blk = child->opaque;
945 if (blk->dev_ops && blk->dev_ops->resize_cb) {
946 blk->dev_ops->resize_cb(blk->dev_opaque);
950 void blk_iostatus_enable(BlockBackend *blk)
952 blk->iostatus_enabled = true;
953 blk->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
956 /* The I/O status is only enabled if the drive explicitly
957 * enables it _and_ the VM is configured to stop on errors */
958 bool blk_iostatus_is_enabled(const BlockBackend *blk)
960 return (blk->iostatus_enabled &&
961 (blk->on_write_error == BLOCKDEV_ON_ERROR_ENOSPC ||
962 blk->on_write_error == BLOCKDEV_ON_ERROR_STOP ||
963 blk->on_read_error == BLOCKDEV_ON_ERROR_STOP));
966 BlockDeviceIoStatus blk_iostatus(const BlockBackend *blk)
968 return blk->iostatus;
971 void blk_iostatus_disable(BlockBackend *blk)
973 blk->iostatus_enabled = false;
976 void blk_iostatus_reset(BlockBackend *blk)
978 if (blk_iostatus_is_enabled(blk)) {
979 BlockDriverState *bs = blk_bs(blk);
980 blk->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
981 if (bs && bs->job) {
982 block_job_iostatus_reset(bs->job);
987 void blk_iostatus_set_err(BlockBackend *blk, int error)
989 assert(blk_iostatus_is_enabled(blk));
990 if (blk->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
991 blk->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
992 BLOCK_DEVICE_IO_STATUS_FAILED;
996 void blk_set_allow_write_beyond_eof(BlockBackend *blk, bool allow)
998 blk->allow_write_beyond_eof = allow;
1001 static int blk_check_byte_request(BlockBackend *blk, int64_t offset,
1002 size_t size)
1004 int64_t len;
1006 if (size > INT_MAX) {
1007 return -EIO;
1010 if (!blk_is_available(blk)) {
1011 return -ENOMEDIUM;
1014 if (offset < 0) {
1015 return -EIO;
1018 if (!blk->allow_write_beyond_eof) {
1019 len = blk_getlength(blk);
1020 if (len < 0) {
1021 return len;
1024 if (offset > len || len - offset < size) {
1025 return -EIO;
1029 return 0;
1032 int coroutine_fn blk_co_preadv(BlockBackend *blk, int64_t offset,
1033 unsigned int bytes, QEMUIOVector *qiov,
1034 BdrvRequestFlags flags)
1036 int ret;
1037 BlockDriverState *bs = blk_bs(blk);
1039 trace_blk_co_preadv(blk, bs, offset, bytes, flags);
1041 ret = blk_check_byte_request(blk, offset, bytes);
1042 if (ret < 0) {
1043 return ret;
1046 bdrv_inc_in_flight(bs);
1048 /* throttling disk I/O */
1049 if (blk->public.throttle_state) {
1050 throttle_group_co_io_limits_intercept(blk, bytes, false);
1053 ret = bdrv_co_preadv(blk->root, offset, bytes, qiov, flags);
1054 bdrv_dec_in_flight(bs);
1055 return ret;
1058 int coroutine_fn blk_co_pwritev(BlockBackend *blk, int64_t offset,
1059 unsigned int bytes, QEMUIOVector *qiov,
1060 BdrvRequestFlags flags)
1062 int ret;
1063 BlockDriverState *bs = blk_bs(blk);
1065 trace_blk_co_pwritev(blk, bs, offset, bytes, flags);
1067 ret = blk_check_byte_request(blk, offset, bytes);
1068 if (ret < 0) {
1069 return ret;
1072 bdrv_inc_in_flight(bs);
1074 /* throttling disk I/O */
1075 if (blk->public.throttle_state) {
1076 throttle_group_co_io_limits_intercept(blk, bytes, true);
1079 if (!blk->enable_write_cache) {
1080 flags |= BDRV_REQ_FUA;
1083 ret = bdrv_co_pwritev(blk->root, offset, bytes, qiov, flags);
1084 bdrv_dec_in_flight(bs);
1085 return ret;
1088 typedef struct BlkRwCo {
1089 BlockBackend *blk;
1090 int64_t offset;
1091 QEMUIOVector *qiov;
1092 int ret;
1093 BdrvRequestFlags flags;
1094 } BlkRwCo;
1096 static void blk_read_entry(void *opaque)
1098 BlkRwCo *rwco = opaque;
1100 rwco->ret = blk_co_preadv(rwco->blk, rwco->offset, rwco->qiov->size,
1101 rwco->qiov, rwco->flags);
1104 static void blk_write_entry(void *opaque)
1106 BlkRwCo *rwco = opaque;
1108 rwco->ret = blk_co_pwritev(rwco->blk, rwco->offset, rwco->qiov->size,
1109 rwco->qiov, rwco->flags);
1112 static int blk_prw(BlockBackend *blk, int64_t offset, uint8_t *buf,
1113 int64_t bytes, CoroutineEntry co_entry,
1114 BdrvRequestFlags flags)
1116 QEMUIOVector qiov;
1117 struct iovec iov;
1118 BlkRwCo rwco;
1120 iov = (struct iovec) {
1121 .iov_base = buf,
1122 .iov_len = bytes,
1124 qemu_iovec_init_external(&qiov, &iov, 1);
1126 rwco = (BlkRwCo) {
1127 .blk = blk,
1128 .offset = offset,
1129 .qiov = &qiov,
1130 .flags = flags,
1131 .ret = NOT_DONE,
1134 if (qemu_in_coroutine()) {
1135 /* Fast-path if already in coroutine context */
1136 co_entry(&rwco);
1137 } else {
1138 Coroutine *co = qemu_coroutine_create(co_entry, &rwco);
1139 bdrv_coroutine_enter(blk_bs(blk), co);
1140 BDRV_POLL_WHILE(blk_bs(blk), rwco.ret == NOT_DONE);
1143 return rwco.ret;
1146 int blk_pread_unthrottled(BlockBackend *blk, int64_t offset, uint8_t *buf,
1147 int count)
1149 int ret;
1151 ret = blk_check_byte_request(blk, offset, count);
1152 if (ret < 0) {
1153 return ret;
1156 blk_root_drained_begin(blk->root);
1157 ret = blk_pread(blk, offset, buf, count);
1158 blk_root_drained_end(blk->root);
1159 return ret;
1162 int blk_pwrite_zeroes(BlockBackend *blk, int64_t offset,
1163 int bytes, BdrvRequestFlags flags)
1165 return blk_prw(blk, offset, NULL, bytes, blk_write_entry,
1166 flags | BDRV_REQ_ZERO_WRITE);
1169 int blk_make_zero(BlockBackend *blk, BdrvRequestFlags flags)
1171 return bdrv_make_zero(blk->root, flags);
1174 static void error_callback_bh(void *opaque)
1176 struct BlockBackendAIOCB *acb = opaque;
1178 bdrv_dec_in_flight(acb->common.bs);
1179 acb->common.cb(acb->common.opaque, acb->ret);
1180 qemu_aio_unref(acb);
1183 BlockAIOCB *blk_abort_aio_request(BlockBackend *blk,
1184 BlockCompletionFunc *cb,
1185 void *opaque, int ret)
1187 struct BlockBackendAIOCB *acb;
1189 bdrv_inc_in_flight(blk_bs(blk));
1190 acb = blk_aio_get(&block_backend_aiocb_info, blk, cb, opaque);
1191 acb->blk = blk;
1192 acb->ret = ret;
1194 aio_bh_schedule_oneshot(blk_get_aio_context(blk), error_callback_bh, acb);
1195 return &acb->common;
1198 typedef struct BlkAioEmAIOCB {
1199 BlockAIOCB common;
1200 BlkRwCo rwco;
1201 int bytes;
1202 bool has_returned;
1203 } BlkAioEmAIOCB;
1205 static const AIOCBInfo blk_aio_em_aiocb_info = {
1206 .aiocb_size = sizeof(BlkAioEmAIOCB),
1209 static void blk_aio_complete(BlkAioEmAIOCB *acb)
1211 if (acb->has_returned) {
1212 bdrv_dec_in_flight(acb->common.bs);
1213 acb->common.cb(acb->common.opaque, acb->rwco.ret);
1214 qemu_aio_unref(acb);
1218 static void blk_aio_complete_bh(void *opaque)
1220 BlkAioEmAIOCB *acb = opaque;
1221 assert(acb->has_returned);
1222 blk_aio_complete(acb);
1225 static BlockAIOCB *blk_aio_prwv(BlockBackend *blk, int64_t offset, int bytes,
1226 QEMUIOVector *qiov, CoroutineEntry co_entry,
1227 BdrvRequestFlags flags,
1228 BlockCompletionFunc *cb, void *opaque)
1230 BlkAioEmAIOCB *acb;
1231 Coroutine *co;
1233 bdrv_inc_in_flight(blk_bs(blk));
1234 acb = blk_aio_get(&blk_aio_em_aiocb_info, blk, cb, opaque);
1235 acb->rwco = (BlkRwCo) {
1236 .blk = blk,
1237 .offset = offset,
1238 .qiov = qiov,
1239 .flags = flags,
1240 .ret = NOT_DONE,
1242 acb->bytes = bytes;
1243 acb->has_returned = false;
1245 co = qemu_coroutine_create(co_entry, acb);
1246 bdrv_coroutine_enter(blk_bs(blk), co);
1248 acb->has_returned = true;
1249 if (acb->rwco.ret != NOT_DONE) {
1250 aio_bh_schedule_oneshot(blk_get_aio_context(blk),
1251 blk_aio_complete_bh, acb);
1254 return &acb->common;
1257 static void blk_aio_read_entry(void *opaque)
1259 BlkAioEmAIOCB *acb = opaque;
1260 BlkRwCo *rwco = &acb->rwco;
1262 assert(rwco->qiov->size == acb->bytes);
1263 rwco->ret = blk_co_preadv(rwco->blk, rwco->offset, acb->bytes,
1264 rwco->qiov, rwco->flags);
1265 blk_aio_complete(acb);
1268 static void blk_aio_write_entry(void *opaque)
1270 BlkAioEmAIOCB *acb = opaque;
1271 BlkRwCo *rwco = &acb->rwco;
1273 assert(!rwco->qiov || rwco->qiov->size == acb->bytes);
1274 rwco->ret = blk_co_pwritev(rwco->blk, rwco->offset, acb->bytes,
1275 rwco->qiov, rwco->flags);
1276 blk_aio_complete(acb);
1279 BlockAIOCB *blk_aio_pwrite_zeroes(BlockBackend *blk, int64_t offset,
1280 int count, BdrvRequestFlags flags,
1281 BlockCompletionFunc *cb, void *opaque)
1283 return blk_aio_prwv(blk, offset, count, NULL, blk_aio_write_entry,
1284 flags | BDRV_REQ_ZERO_WRITE, cb, opaque);
1287 int blk_pread(BlockBackend *blk, int64_t offset, void *buf, int count)
1289 int ret = blk_prw(blk, offset, buf, count, blk_read_entry, 0);
1290 if (ret < 0) {
1291 return ret;
1293 return count;
1296 int blk_pwrite(BlockBackend *blk, int64_t offset, const void *buf, int count,
1297 BdrvRequestFlags flags)
1299 int ret = blk_prw(blk, offset, (void *) buf, count, blk_write_entry,
1300 flags);
1301 if (ret < 0) {
1302 return ret;
1304 return count;
1307 int64_t blk_getlength(BlockBackend *blk)
1309 if (!blk_is_available(blk)) {
1310 return -ENOMEDIUM;
1313 return bdrv_getlength(blk_bs(blk));
1316 void blk_get_geometry(BlockBackend *blk, uint64_t *nb_sectors_ptr)
1318 if (!blk_bs(blk)) {
1319 *nb_sectors_ptr = 0;
1320 } else {
1321 bdrv_get_geometry(blk_bs(blk), nb_sectors_ptr);
1325 int64_t blk_nb_sectors(BlockBackend *blk)
1327 if (!blk_is_available(blk)) {
1328 return -ENOMEDIUM;
1331 return bdrv_nb_sectors(blk_bs(blk));
1334 BlockAIOCB *blk_aio_preadv(BlockBackend *blk, int64_t offset,
1335 QEMUIOVector *qiov, BdrvRequestFlags flags,
1336 BlockCompletionFunc *cb, void *opaque)
1338 return blk_aio_prwv(blk, offset, qiov->size, qiov,
1339 blk_aio_read_entry, flags, cb, opaque);
1342 BlockAIOCB *blk_aio_pwritev(BlockBackend *blk, int64_t offset,
1343 QEMUIOVector *qiov, BdrvRequestFlags flags,
1344 BlockCompletionFunc *cb, void *opaque)
1346 return blk_aio_prwv(blk, offset, qiov->size, qiov,
1347 blk_aio_write_entry, flags, cb, opaque);
1350 static void blk_aio_flush_entry(void *opaque)
1352 BlkAioEmAIOCB *acb = opaque;
1353 BlkRwCo *rwco = &acb->rwco;
1355 rwco->ret = blk_co_flush(rwco->blk);
1356 blk_aio_complete(acb);
1359 BlockAIOCB *blk_aio_flush(BlockBackend *blk,
1360 BlockCompletionFunc *cb, void *opaque)
1362 return blk_aio_prwv(blk, 0, 0, NULL, blk_aio_flush_entry, 0, cb, opaque);
1365 static void blk_aio_pdiscard_entry(void *opaque)
1367 BlkAioEmAIOCB *acb = opaque;
1368 BlkRwCo *rwco = &acb->rwco;
1370 rwco->ret = blk_co_pdiscard(rwco->blk, rwco->offset, acb->bytes);
1371 blk_aio_complete(acb);
1374 BlockAIOCB *blk_aio_pdiscard(BlockBackend *blk,
1375 int64_t offset, int bytes,
1376 BlockCompletionFunc *cb, void *opaque)
1378 return blk_aio_prwv(blk, offset, bytes, NULL, blk_aio_pdiscard_entry, 0,
1379 cb, opaque);
1382 void blk_aio_cancel(BlockAIOCB *acb)
1384 bdrv_aio_cancel(acb);
1387 void blk_aio_cancel_async(BlockAIOCB *acb)
1389 bdrv_aio_cancel_async(acb);
1392 int blk_co_ioctl(BlockBackend *blk, unsigned long int req, void *buf)
1394 if (!blk_is_available(blk)) {
1395 return -ENOMEDIUM;
1398 return bdrv_co_ioctl(blk_bs(blk), req, buf);
1401 static void blk_ioctl_entry(void *opaque)
1403 BlkRwCo *rwco = opaque;
1404 rwco->ret = blk_co_ioctl(rwco->blk, rwco->offset,
1405 rwco->qiov->iov[0].iov_base);
1408 int blk_ioctl(BlockBackend *blk, unsigned long int req, void *buf)
1410 return blk_prw(blk, req, buf, 0, blk_ioctl_entry, 0);
1413 static void blk_aio_ioctl_entry(void *opaque)
1415 BlkAioEmAIOCB *acb = opaque;
1416 BlkRwCo *rwco = &acb->rwco;
1418 rwco->ret = blk_co_ioctl(rwco->blk, rwco->offset,
1419 rwco->qiov->iov[0].iov_base);
1420 blk_aio_complete(acb);
1423 BlockAIOCB *blk_aio_ioctl(BlockBackend *blk, unsigned long int req, void *buf,
1424 BlockCompletionFunc *cb, void *opaque)
1426 QEMUIOVector qiov;
1427 struct iovec iov;
1429 iov = (struct iovec) {
1430 .iov_base = buf,
1431 .iov_len = 0,
1433 qemu_iovec_init_external(&qiov, &iov, 1);
1435 return blk_aio_prwv(blk, req, 0, &qiov, blk_aio_ioctl_entry, 0, cb, opaque);
1438 int blk_co_pdiscard(BlockBackend *blk, int64_t offset, int bytes)
1440 int ret = blk_check_byte_request(blk, offset, bytes);
1441 if (ret < 0) {
1442 return ret;
1445 return bdrv_co_pdiscard(blk_bs(blk), offset, bytes);
1448 int blk_co_flush(BlockBackend *blk)
1450 if (!blk_is_available(blk)) {
1451 return -ENOMEDIUM;
1454 return bdrv_co_flush(blk_bs(blk));
1457 static void blk_flush_entry(void *opaque)
1459 BlkRwCo *rwco = opaque;
1460 rwco->ret = blk_co_flush(rwco->blk);
1463 int blk_flush(BlockBackend *blk)
1465 return blk_prw(blk, 0, NULL, 0, blk_flush_entry, 0);
1468 void blk_drain(BlockBackend *blk)
1470 if (blk_bs(blk)) {
1471 bdrv_drain(blk_bs(blk));
1475 void blk_drain_all(void)
1477 bdrv_drain_all();
1480 void blk_set_on_error(BlockBackend *blk, BlockdevOnError on_read_error,
1481 BlockdevOnError on_write_error)
1483 blk->on_read_error = on_read_error;
1484 blk->on_write_error = on_write_error;
1487 BlockdevOnError blk_get_on_error(BlockBackend *blk, bool is_read)
1489 return is_read ? blk->on_read_error : blk->on_write_error;
1492 BlockErrorAction blk_get_error_action(BlockBackend *blk, bool is_read,
1493 int error)
1495 BlockdevOnError on_err = blk_get_on_error(blk, is_read);
1497 switch (on_err) {
1498 case BLOCKDEV_ON_ERROR_ENOSPC:
1499 return (error == ENOSPC) ?
1500 BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT;
1501 case BLOCKDEV_ON_ERROR_STOP:
1502 return BLOCK_ERROR_ACTION_STOP;
1503 case BLOCKDEV_ON_ERROR_REPORT:
1504 return BLOCK_ERROR_ACTION_REPORT;
1505 case BLOCKDEV_ON_ERROR_IGNORE:
1506 return BLOCK_ERROR_ACTION_IGNORE;
1507 case BLOCKDEV_ON_ERROR_AUTO:
1508 default:
1509 abort();
1513 static void send_qmp_error_event(BlockBackend *blk,
1514 BlockErrorAction action,
1515 bool is_read, int error)
1517 IoOperationType optype;
1519 optype = is_read ? IO_OPERATION_TYPE_READ : IO_OPERATION_TYPE_WRITE;
1520 qapi_event_send_block_io_error(blk_name(blk),
1521 bdrv_get_node_name(blk_bs(blk)), optype,
1522 action, blk_iostatus_is_enabled(blk),
1523 error == ENOSPC, strerror(error),
1524 &error_abort);
1527 /* This is done by device models because, while the block layer knows
1528 * about the error, it does not know whether an operation comes from
1529 * the device or the block layer (from a job, for example).
1531 void blk_error_action(BlockBackend *blk, BlockErrorAction action,
1532 bool is_read, int error)
1534 assert(error >= 0);
1536 if (action == BLOCK_ERROR_ACTION_STOP) {
1537 /* First set the iostatus, so that "info block" returns an iostatus
1538 * that matches the events raised so far (an additional error iostatus
1539 * is fine, but not a lost one).
1541 blk_iostatus_set_err(blk, error);
1543 /* Then raise the request to stop the VM and the event.
1544 * qemu_system_vmstop_request_prepare has two effects. First,
1545 * it ensures that the STOP event always comes after the
1546 * BLOCK_IO_ERROR event. Second, it ensures that even if management
1547 * can observe the STOP event and do a "cont" before the STOP
1548 * event is issued, the VM will not stop. In this case, vm_start()
1549 * also ensures that the STOP/RESUME pair of events is emitted.
1551 qemu_system_vmstop_request_prepare();
1552 send_qmp_error_event(blk, action, is_read, error);
1553 qemu_system_vmstop_request(RUN_STATE_IO_ERROR);
1554 } else {
1555 send_qmp_error_event(blk, action, is_read, error);
1559 int blk_is_read_only(BlockBackend *blk)
1561 BlockDriverState *bs = blk_bs(blk);
1563 if (bs) {
1564 return bdrv_is_read_only(bs);
1565 } else {
1566 return blk->root_state.read_only;
1570 int blk_is_sg(BlockBackend *blk)
1572 BlockDriverState *bs = blk_bs(blk);
1574 if (!bs) {
1575 return 0;
1578 return bdrv_is_sg(bs);
1581 int blk_enable_write_cache(BlockBackend *blk)
1583 return blk->enable_write_cache;
1586 void blk_set_enable_write_cache(BlockBackend *blk, bool wce)
1588 blk->enable_write_cache = wce;
1591 void blk_invalidate_cache(BlockBackend *blk, Error **errp)
1593 BlockDriverState *bs = blk_bs(blk);
1595 if (!bs) {
1596 error_setg(errp, "Device '%s' has no medium", blk->name);
1597 return;
1600 bdrv_invalidate_cache(bs, errp);
1603 bool blk_is_inserted(BlockBackend *blk)
1605 BlockDriverState *bs = blk_bs(blk);
1607 return bs && bdrv_is_inserted(bs);
1610 bool blk_is_available(BlockBackend *blk)
1612 return blk_is_inserted(blk) && !blk_dev_is_tray_open(blk);
1615 void blk_lock_medium(BlockBackend *blk, bool locked)
1617 BlockDriverState *bs = blk_bs(blk);
1619 if (bs) {
1620 bdrv_lock_medium(bs, locked);
1624 void blk_eject(BlockBackend *blk, bool eject_flag)
1626 BlockDriverState *bs = blk_bs(blk);
1627 char *id;
1629 /* blk_eject is only called by qdevified devices */
1630 assert(!blk->legacy_dev);
1632 if (bs) {
1633 bdrv_eject(bs, eject_flag);
1636 /* Whether or not we ejected on the backend,
1637 * the frontend experienced a tray event. */
1638 id = blk_get_attached_dev_id(blk);
1639 qapi_event_send_device_tray_moved(blk_name(blk), id,
1640 eject_flag, &error_abort);
1641 g_free(id);
1644 int blk_get_flags(BlockBackend *blk)
1646 BlockDriverState *bs = blk_bs(blk);
1648 if (bs) {
1649 return bdrv_get_flags(bs);
1650 } else {
1651 return blk->root_state.open_flags;
1655 /* Returns the maximum transfer length, in bytes; guaranteed nonzero */
1656 uint32_t blk_get_max_transfer(BlockBackend *blk)
1658 BlockDriverState *bs = blk_bs(blk);
1659 uint32_t max = 0;
1661 if (bs) {
1662 max = bs->bl.max_transfer;
1664 return MIN_NON_ZERO(max, INT_MAX);
1667 int blk_get_max_iov(BlockBackend *blk)
1669 return blk->root->bs->bl.max_iov;
1672 void blk_set_guest_block_size(BlockBackend *blk, int align)
1674 blk->guest_block_size = align;
1677 void *blk_try_blockalign(BlockBackend *blk, size_t size)
1679 return qemu_try_blockalign(blk ? blk_bs(blk) : NULL, size);
1682 void *blk_blockalign(BlockBackend *blk, size_t size)
1684 return qemu_blockalign(blk ? blk_bs(blk) : NULL, size);
1687 bool blk_op_is_blocked(BlockBackend *blk, BlockOpType op, Error **errp)
1689 BlockDriverState *bs = blk_bs(blk);
1691 if (!bs) {
1692 return false;
1695 return bdrv_op_is_blocked(bs, op, errp);
1698 void blk_op_unblock(BlockBackend *blk, BlockOpType op, Error *reason)
1700 BlockDriverState *bs = blk_bs(blk);
1702 if (bs) {
1703 bdrv_op_unblock(bs, op, reason);
1707 void blk_op_block_all(BlockBackend *blk, Error *reason)
1709 BlockDriverState *bs = blk_bs(blk);
1711 if (bs) {
1712 bdrv_op_block_all(bs, reason);
1716 void blk_op_unblock_all(BlockBackend *blk, Error *reason)
1718 BlockDriverState *bs = blk_bs(blk);
1720 if (bs) {
1721 bdrv_op_unblock_all(bs, reason);
1725 AioContext *blk_get_aio_context(BlockBackend *blk)
1727 BlockDriverState *bs = blk_bs(blk);
1729 if (bs) {
1730 return bdrv_get_aio_context(bs);
1731 } else {
1732 return qemu_get_aio_context();
1736 static AioContext *blk_aiocb_get_aio_context(BlockAIOCB *acb)
1738 BlockBackendAIOCB *blk_acb = DO_UPCAST(BlockBackendAIOCB, common, acb);
1739 return blk_get_aio_context(blk_acb->blk);
1742 void blk_set_aio_context(BlockBackend *blk, AioContext *new_context)
1744 BlockDriverState *bs = blk_bs(blk);
1746 if (bs) {
1747 if (blk->public.throttle_state) {
1748 throttle_timers_detach_aio_context(&blk->public.throttle_timers);
1750 bdrv_set_aio_context(bs, new_context);
1751 if (blk->public.throttle_state) {
1752 throttle_timers_attach_aio_context(&blk->public.throttle_timers,
1753 new_context);
1758 void blk_add_aio_context_notifier(BlockBackend *blk,
1759 void (*attached_aio_context)(AioContext *new_context, void *opaque),
1760 void (*detach_aio_context)(void *opaque), void *opaque)
1762 BlockDriverState *bs = blk_bs(blk);
1764 if (bs) {
1765 bdrv_add_aio_context_notifier(bs, attached_aio_context,
1766 detach_aio_context, opaque);
1770 void blk_remove_aio_context_notifier(BlockBackend *blk,
1771 void (*attached_aio_context)(AioContext *,
1772 void *),
1773 void (*detach_aio_context)(void *),
1774 void *opaque)
1776 BlockDriverState *bs = blk_bs(blk);
1778 if (bs) {
1779 bdrv_remove_aio_context_notifier(bs, attached_aio_context,
1780 detach_aio_context, opaque);
1784 void blk_add_remove_bs_notifier(BlockBackend *blk, Notifier *notify)
1786 notifier_list_add(&blk->remove_bs_notifiers, notify);
1789 void blk_add_insert_bs_notifier(BlockBackend *blk, Notifier *notify)
1791 notifier_list_add(&blk->insert_bs_notifiers, notify);
1794 void blk_io_plug(BlockBackend *blk)
1796 BlockDriverState *bs = blk_bs(blk);
1798 if (bs) {
1799 bdrv_io_plug(bs);
1803 void blk_io_unplug(BlockBackend *blk)
1805 BlockDriverState *bs = blk_bs(blk);
1807 if (bs) {
1808 bdrv_io_unplug(bs);
1812 BlockAcctStats *blk_get_stats(BlockBackend *blk)
1814 return &blk->stats;
1817 void *blk_aio_get(const AIOCBInfo *aiocb_info, BlockBackend *blk,
1818 BlockCompletionFunc *cb, void *opaque)
1820 return qemu_aio_get(aiocb_info, blk_bs(blk), cb, opaque);
1823 int coroutine_fn blk_co_pwrite_zeroes(BlockBackend *blk, int64_t offset,
1824 int bytes, BdrvRequestFlags flags)
1826 return blk_co_pwritev(blk, offset, bytes, NULL,
1827 flags | BDRV_REQ_ZERO_WRITE);
1830 int blk_pwrite_compressed(BlockBackend *blk, int64_t offset, const void *buf,
1831 int count)
1833 return blk_prw(blk, offset, (void *) buf, count, blk_write_entry,
1834 BDRV_REQ_WRITE_COMPRESSED);
1837 int blk_truncate(BlockBackend *blk, int64_t offset, PreallocMode prealloc,
1838 Error **errp)
1840 if (!blk_is_available(blk)) {
1841 error_setg(errp, "No medium inserted");
1842 return -ENOMEDIUM;
1845 return bdrv_truncate(blk->root, offset, prealloc, errp);
1848 static void blk_pdiscard_entry(void *opaque)
1850 BlkRwCo *rwco = opaque;
1851 rwco->ret = blk_co_pdiscard(rwco->blk, rwco->offset, rwco->qiov->size);
1854 int blk_pdiscard(BlockBackend *blk, int64_t offset, int bytes)
1856 return blk_prw(blk, offset, NULL, bytes, blk_pdiscard_entry, 0);
1859 int blk_save_vmstate(BlockBackend *blk, const uint8_t *buf,
1860 int64_t pos, int size)
1862 int ret;
1864 if (!blk_is_available(blk)) {
1865 return -ENOMEDIUM;
1868 ret = bdrv_save_vmstate(blk_bs(blk), buf, pos, size);
1869 if (ret < 0) {
1870 return ret;
1873 if (ret == size && !blk->enable_write_cache) {
1874 ret = bdrv_flush(blk_bs(blk));
1877 return ret < 0 ? ret : size;
1880 int blk_load_vmstate(BlockBackend *blk, uint8_t *buf, int64_t pos, int size)
1882 if (!blk_is_available(blk)) {
1883 return -ENOMEDIUM;
1886 return bdrv_load_vmstate(blk_bs(blk), buf, pos, size);
1889 int blk_probe_blocksizes(BlockBackend *blk, BlockSizes *bsz)
1891 if (!blk_is_available(blk)) {
1892 return -ENOMEDIUM;
1895 return bdrv_probe_blocksizes(blk_bs(blk), bsz);
1898 int blk_probe_geometry(BlockBackend *blk, HDGeometry *geo)
1900 if (!blk_is_available(blk)) {
1901 return -ENOMEDIUM;
1904 return bdrv_probe_geometry(blk_bs(blk), geo);
1908 * Updates the BlockBackendRootState object with data from the currently
1909 * attached BlockDriverState.
1911 void blk_update_root_state(BlockBackend *blk)
1913 assert(blk->root);
1915 blk->root_state.open_flags = blk->root->bs->open_flags;
1916 blk->root_state.read_only = blk->root->bs->read_only;
1917 blk->root_state.detect_zeroes = blk->root->bs->detect_zeroes;
1921 * Returns the detect-zeroes setting to be used for bdrv_open() of a
1922 * BlockDriverState which is supposed to inherit the root state.
1924 bool blk_get_detect_zeroes_from_root_state(BlockBackend *blk)
1926 return blk->root_state.detect_zeroes;
1930 * Returns the flags to be used for bdrv_open() of a BlockDriverState which is
1931 * supposed to inherit the root state.
1933 int blk_get_open_flags_from_root_state(BlockBackend *blk)
1935 int bs_flags;
1937 bs_flags = blk->root_state.read_only ? 0 : BDRV_O_RDWR;
1938 bs_flags |= blk->root_state.open_flags & ~BDRV_O_RDWR;
1940 return bs_flags;
1943 BlockBackendRootState *blk_get_root_state(BlockBackend *blk)
1945 return &blk->root_state;
1948 int blk_commit_all(void)
1950 BlockBackend *blk = NULL;
1952 while ((blk = blk_all_next(blk)) != NULL) {
1953 AioContext *aio_context = blk_get_aio_context(blk);
1955 aio_context_acquire(aio_context);
1956 if (blk_is_inserted(blk) && blk->root->bs->backing) {
1957 int ret = bdrv_commit(blk->root->bs);
1958 if (ret < 0) {
1959 aio_context_release(aio_context);
1960 return ret;
1963 aio_context_release(aio_context);
1965 return 0;
1969 /* throttling disk I/O limits */
1970 void blk_set_io_limits(BlockBackend *blk, ThrottleConfig *cfg)
1972 throttle_group_config(blk, cfg);
1975 void blk_io_limits_disable(BlockBackend *blk)
1977 assert(blk->public.throttle_state);
1978 bdrv_drained_begin(blk_bs(blk));
1979 throttle_group_unregister_blk(blk);
1980 bdrv_drained_end(blk_bs(blk));
1983 /* should be called before blk_set_io_limits if a limit is set */
1984 void blk_io_limits_enable(BlockBackend *blk, const char *group)
1986 assert(!blk->public.throttle_state);
1987 throttle_group_register_blk(blk, group);
1990 void blk_io_limits_update_group(BlockBackend *blk, const char *group)
1992 /* this BB is not part of any group */
1993 if (!blk->public.throttle_state) {
1994 return;
1997 /* this BB is a part of the same group than the one we want */
1998 if (!g_strcmp0(throttle_group_get_name(blk), group)) {
1999 return;
2002 /* need to change the group this bs belong to */
2003 blk_io_limits_disable(blk);
2004 blk_io_limits_enable(blk, group);
2007 static void blk_root_drained_begin(BdrvChild *child)
2009 BlockBackend *blk = child->opaque;
2011 if (++blk->quiesce_counter == 1) {
2012 if (blk->dev_ops && blk->dev_ops->drained_begin) {
2013 blk->dev_ops->drained_begin(blk->dev_opaque);
2017 /* Note that blk->root may not be accessible here yet if we are just
2018 * attaching to a BlockDriverState that is drained. Use child instead. */
2020 if (atomic_fetch_inc(&blk->public.io_limits_disabled) == 0) {
2021 throttle_group_restart_blk(blk);
2025 static void blk_root_drained_end(BdrvChild *child)
2027 BlockBackend *blk = child->opaque;
2028 assert(blk->quiesce_counter);
2030 assert(blk->public.io_limits_disabled);
2031 atomic_dec(&blk->public.io_limits_disabled);
2033 if (--blk->quiesce_counter == 0) {
2034 if (blk->dev_ops && blk->dev_ops->drained_end) {
2035 blk->dev_ops->drained_end(blk->dev_opaque);