block: tidy ThrottleGroupMember initializations
[qemu/ericb.git] / block / block-backend.c
blob45d9101be3e337078379fc25fe838d9c908f2452
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 block_acct_init(&blk->stats);
278 notifier_list_init(&blk->remove_bs_notifiers);
279 notifier_list_init(&blk->insert_bs_notifiers);
281 QTAILQ_INSERT_TAIL(&block_backends, blk, link);
282 return blk;
286 * Creates a new BlockBackend, opens a new BlockDriverState, and connects both.
288 * Just as with bdrv_open(), after having called this function the reference to
289 * @options belongs to the block layer (even on failure).
291 * TODO: Remove @filename and @flags; it should be possible to specify a whole
292 * BDS tree just by specifying the @options QDict (or @reference,
293 * alternatively). At the time of adding this function, this is not possible,
294 * though, so callers of this function have to be able to specify @filename and
295 * @flags.
297 BlockBackend *blk_new_open(const char *filename, const char *reference,
298 QDict *options, int flags, Error **errp)
300 BlockBackend *blk;
301 BlockDriverState *bs;
302 uint64_t perm;
304 /* blk_new_open() is mainly used in .bdrv_create implementations and the
305 * tools where sharing isn't a concern because the BDS stays private, so we
306 * just request permission according to the flags.
308 * The exceptions are xen_disk and blockdev_init(); in these cases, the
309 * caller of blk_new_open() doesn't make use of the permissions, but they
310 * shouldn't hurt either. We can still share everything here because the
311 * guest devices will add their own blockers if they can't share. */
312 perm = BLK_PERM_CONSISTENT_READ;
313 if (flags & BDRV_O_RDWR) {
314 perm |= BLK_PERM_WRITE;
316 if (flags & BDRV_O_RESIZE) {
317 perm |= BLK_PERM_RESIZE;
320 blk = blk_new(perm, BLK_PERM_ALL);
321 bs = bdrv_open(filename, reference, options, flags, errp);
322 if (!bs) {
323 blk_unref(blk);
324 return NULL;
327 blk->root = bdrv_root_attach_child(bs, "root", &child_root,
328 perm, BLK_PERM_ALL, blk, errp);
329 if (!blk->root) {
330 bdrv_unref(bs);
331 blk_unref(blk);
332 return NULL;
335 return blk;
338 static void blk_delete(BlockBackend *blk)
340 assert(!blk->refcnt);
341 assert(!blk->name);
342 assert(!blk->dev);
343 if (blk->public.throttle_group_member.throttle_state) {
344 blk_io_limits_disable(blk);
346 if (blk->root) {
347 blk_remove_bs(blk);
349 if (blk->vmsh) {
350 qemu_del_vm_change_state_handler(blk->vmsh);
351 blk->vmsh = NULL;
353 assert(QLIST_EMPTY(&blk->remove_bs_notifiers.notifiers));
354 assert(QLIST_EMPTY(&blk->insert_bs_notifiers.notifiers));
355 QTAILQ_REMOVE(&block_backends, blk, link);
356 drive_info_del(blk->legacy_dinfo);
357 block_acct_cleanup(&blk->stats);
358 g_free(blk);
361 static void drive_info_del(DriveInfo *dinfo)
363 if (!dinfo) {
364 return;
366 qemu_opts_del(dinfo->opts);
367 g_free(dinfo->serial);
368 g_free(dinfo);
371 int blk_get_refcnt(BlockBackend *blk)
373 return blk ? blk->refcnt : 0;
377 * Increment @blk's reference count.
378 * @blk must not be null.
380 void blk_ref(BlockBackend *blk)
382 blk->refcnt++;
386 * Decrement @blk's reference count.
387 * If this drops it to zero, destroy @blk.
388 * For convenience, do nothing if @blk is null.
390 void blk_unref(BlockBackend *blk)
392 if (blk) {
393 assert(blk->refcnt > 0);
394 if (!--blk->refcnt) {
395 blk_delete(blk);
401 * Behaves similarly to blk_next() but iterates over all BlockBackends, even the
402 * ones which are hidden (i.e. are not referenced by the monitor).
404 BlockBackend *blk_all_next(BlockBackend *blk)
406 return blk ? QTAILQ_NEXT(blk, link)
407 : QTAILQ_FIRST(&block_backends);
410 void blk_remove_all_bs(void)
412 BlockBackend *blk = NULL;
414 while ((blk = blk_all_next(blk)) != NULL) {
415 AioContext *ctx = blk_get_aio_context(blk);
417 aio_context_acquire(ctx);
418 if (blk->root) {
419 blk_remove_bs(blk);
421 aio_context_release(ctx);
426 * Return the monitor-owned BlockBackend after @blk.
427 * If @blk is null, return the first one.
428 * Else, return @blk's next sibling, which may be null.
430 * To iterate over all BlockBackends, do
431 * for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
432 * ...
435 BlockBackend *blk_next(BlockBackend *blk)
437 return blk ? QTAILQ_NEXT(blk, monitor_link)
438 : QTAILQ_FIRST(&monitor_block_backends);
441 /* Iterates over all top-level BlockDriverStates, i.e. BDSs that are owned by
442 * the monitor or attached to a BlockBackend */
443 BlockDriverState *bdrv_next(BdrvNextIterator *it)
445 BlockDriverState *bs;
447 /* First, return all root nodes of BlockBackends. In order to avoid
448 * returning a BDS twice when multiple BBs refer to it, we only return it
449 * if the BB is the first one in the parent list of the BDS. */
450 if (it->phase == BDRV_NEXT_BACKEND_ROOTS) {
451 do {
452 it->blk = blk_all_next(it->blk);
453 bs = it->blk ? blk_bs(it->blk) : NULL;
454 } while (it->blk && (bs == NULL || bdrv_first_blk(bs) != it->blk));
456 if (bs) {
457 return bs;
459 it->phase = BDRV_NEXT_MONITOR_OWNED;
462 /* Then return the monitor-owned BDSes without a BB attached. Ignore all
463 * BDSes that are attached to a BlockBackend here; they have been handled
464 * by the above block already */
465 do {
466 it->bs = bdrv_next_monitor_owned(it->bs);
467 bs = it->bs;
468 } while (bs && bdrv_has_blk(bs));
470 return bs;
473 BlockDriverState *bdrv_first(BdrvNextIterator *it)
475 *it = (BdrvNextIterator) {
476 .phase = BDRV_NEXT_BACKEND_ROOTS,
479 return bdrv_next(it);
483 * Add a BlockBackend into the list of backends referenced by the monitor, with
484 * the given @name acting as the handle for the monitor.
485 * Strictly for use by blockdev.c.
487 * @name must not be null or empty.
489 * Returns true on success and false on failure. In the latter case, an Error
490 * object is returned through @errp.
492 bool monitor_add_blk(BlockBackend *blk, const char *name, Error **errp)
494 assert(!blk->name);
495 assert(name && name[0]);
497 if (!id_wellformed(name)) {
498 error_setg(errp, "Invalid device name");
499 return false;
501 if (blk_by_name(name)) {
502 error_setg(errp, "Device with id '%s' already exists", name);
503 return false;
505 if (bdrv_find_node(name)) {
506 error_setg(errp,
507 "Device name '%s' conflicts with an existing node name",
508 name);
509 return false;
512 blk->name = g_strdup(name);
513 QTAILQ_INSERT_TAIL(&monitor_block_backends, blk, monitor_link);
514 return true;
518 * Remove a BlockBackend from the list of backends referenced by the monitor.
519 * Strictly for use by blockdev.c.
521 void monitor_remove_blk(BlockBackend *blk)
523 if (!blk->name) {
524 return;
527 QTAILQ_REMOVE(&monitor_block_backends, blk, monitor_link);
528 g_free(blk->name);
529 blk->name = NULL;
533 * Return @blk's name, a non-null string.
534 * Returns an empty string iff @blk is not referenced by the monitor.
536 const char *blk_name(const BlockBackend *blk)
538 return blk->name ?: "";
542 * Return the BlockBackend with name @name if it exists, else null.
543 * @name must not be null.
545 BlockBackend *blk_by_name(const char *name)
547 BlockBackend *blk = NULL;
549 assert(name);
550 while ((blk = blk_next(blk)) != NULL) {
551 if (!strcmp(name, blk->name)) {
552 return blk;
555 return NULL;
559 * Return the BlockDriverState attached to @blk if any, else null.
561 BlockDriverState *blk_bs(BlockBackend *blk)
563 return blk->root ? blk->root->bs : NULL;
566 static BlockBackend *bdrv_first_blk(BlockDriverState *bs)
568 BdrvChild *child;
569 QLIST_FOREACH(child, &bs->parents, next_parent) {
570 if (child->role == &child_root) {
571 return child->opaque;
575 return NULL;
579 * Returns true if @bs has an associated BlockBackend.
581 bool bdrv_has_blk(BlockDriverState *bs)
583 return bdrv_first_blk(bs) != NULL;
587 * Returns true if @bs has only BlockBackends as parents.
589 bool bdrv_is_root_node(BlockDriverState *bs)
591 BdrvChild *c;
593 QLIST_FOREACH(c, &bs->parents, next_parent) {
594 if (c->role != &child_root) {
595 return false;
599 return true;
603 * Return @blk's DriveInfo if any, else null.
605 DriveInfo *blk_legacy_dinfo(BlockBackend *blk)
607 return blk->legacy_dinfo;
611 * Set @blk's DriveInfo to @dinfo, and return it.
612 * @blk must not have a DriveInfo set already.
613 * No other BlockBackend may have the same DriveInfo set.
615 DriveInfo *blk_set_legacy_dinfo(BlockBackend *blk, DriveInfo *dinfo)
617 assert(!blk->legacy_dinfo);
618 return blk->legacy_dinfo = dinfo;
622 * Return the BlockBackend with DriveInfo @dinfo.
623 * It must exist.
625 BlockBackend *blk_by_legacy_dinfo(DriveInfo *dinfo)
627 BlockBackend *blk = NULL;
629 while ((blk = blk_next(blk)) != NULL) {
630 if (blk->legacy_dinfo == dinfo) {
631 return blk;
634 abort();
638 * Returns a pointer to the publicly accessible fields of @blk.
640 BlockBackendPublic *blk_get_public(BlockBackend *blk)
642 return &blk->public;
646 * Returns a BlockBackend given the associated @public fields.
648 BlockBackend *blk_by_public(BlockBackendPublic *public)
650 return container_of(public, BlockBackend, public);
654 * Disassociates the currently associated BlockDriverState from @blk.
656 void blk_remove_bs(BlockBackend *blk)
658 ThrottleTimers *tt;
660 notifier_list_notify(&blk->remove_bs_notifiers, blk);
661 if (blk->public.throttle_group_member.throttle_state) {
662 tt = &blk->public.throttle_group_member.throttle_timers;
663 throttle_timers_detach_aio_context(tt);
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_group_member.throttle_state) {
686 throttle_timers_attach_aio_context(
687 &blk->public.throttle_group_member.throttle_timers,
688 bdrv_get_aio_context(bs));
691 return 0;
695 * Sets the permission bitmasks that the user of the BlockBackend needs.
697 int blk_set_perm(BlockBackend *blk, uint64_t perm, uint64_t shared_perm,
698 Error **errp)
700 int ret;
702 if (blk->root && !blk->disable_perm) {
703 ret = bdrv_child_try_set_perm(blk->root, perm, shared_perm, errp);
704 if (ret < 0) {
705 return ret;
709 blk->perm = perm;
710 blk->shared_perm = shared_perm;
712 return 0;
715 void blk_get_perm(BlockBackend *blk, uint64_t *perm, uint64_t *shared_perm)
717 *perm = blk->perm;
718 *shared_perm = blk->shared_perm;
721 static int blk_do_attach_dev(BlockBackend *blk, void *dev)
723 if (blk->dev) {
724 return -EBUSY;
727 /* While migration is still incoming, we don't need to apply the
728 * permissions of guest device BlockBackends. We might still have a block
729 * job or NBD server writing to the image for storage migration. */
730 if (runstate_check(RUN_STATE_INMIGRATE)) {
731 blk->disable_perm = true;
734 blk_ref(blk);
735 blk->dev = dev;
736 blk->legacy_dev = false;
737 blk_iostatus_reset(blk);
739 return 0;
743 * Attach device model @dev to @blk.
744 * Return 0 on success, -EBUSY when a device model is attached already.
746 int blk_attach_dev(BlockBackend *blk, DeviceState *dev)
748 return blk_do_attach_dev(blk, dev);
752 * Attach device model @dev to @blk.
753 * @blk must not have a device model attached already.
754 * TODO qdevified devices don't use this, remove when devices are qdevified
756 void blk_attach_dev_legacy(BlockBackend *blk, void *dev)
758 if (blk_do_attach_dev(blk, dev) < 0) {
759 abort();
761 blk->legacy_dev = true;
765 * Detach device model @dev from @blk.
766 * @dev must be currently attached to @blk.
768 void blk_detach_dev(BlockBackend *blk, void *dev)
769 /* TODO change to DeviceState *dev when all users are qdevified */
771 assert(blk->dev == dev);
772 blk->dev = NULL;
773 blk->dev_ops = NULL;
774 blk->dev_opaque = NULL;
775 blk->guest_block_size = 512;
776 blk_set_perm(blk, 0, BLK_PERM_ALL, &error_abort);
777 blk_unref(blk);
781 * Return the device model attached to @blk if any, else null.
783 void *blk_get_attached_dev(BlockBackend *blk)
784 /* TODO change to return DeviceState * when all users are qdevified */
786 return blk->dev;
789 /* Return the qdev ID, or if no ID is assigned the QOM path, of the block
790 * device attached to the BlockBackend. */
791 char *blk_get_attached_dev_id(BlockBackend *blk)
793 DeviceState *dev;
795 assert(!blk->legacy_dev);
796 dev = blk->dev;
798 if (!dev) {
799 return g_strdup("");
800 } else if (dev->id) {
801 return g_strdup(dev->id);
803 return object_get_canonical_path(OBJECT(dev));
807 * Return the BlockBackend which has the device model @dev attached if it
808 * exists, else null.
810 * @dev must not be null.
812 BlockBackend *blk_by_dev(void *dev)
814 BlockBackend *blk = NULL;
816 assert(dev != NULL);
817 while ((blk = blk_all_next(blk)) != NULL) {
818 if (blk->dev == dev) {
819 return blk;
822 return NULL;
826 * Set @blk's device model callbacks to @ops.
827 * @opaque is the opaque argument to pass to the callbacks.
828 * This is for use by device models.
830 void blk_set_dev_ops(BlockBackend *blk, const BlockDevOps *ops,
831 void *opaque)
833 /* All drivers that use blk_set_dev_ops() are qdevified and we want to keep
834 * it that way, so we can assume blk->dev, if present, is a DeviceState if
835 * blk->dev_ops is set. Non-device users may use dev_ops without device. */
836 assert(!blk->legacy_dev);
838 blk->dev_ops = ops;
839 blk->dev_opaque = opaque;
841 /* Are we currently quiesced? Should we enforce this right now? */
842 if (blk->quiesce_counter && ops->drained_begin) {
843 ops->drained_begin(opaque);
848 * Notify @blk's attached device model of media change.
850 * If @load is true, notify of media load. This action can fail, meaning that
851 * the medium cannot be loaded. @errp is set then.
853 * If @load is false, notify of media eject. This can never fail.
855 * Also send DEVICE_TRAY_MOVED events as appropriate.
857 void blk_dev_change_media_cb(BlockBackend *blk, bool load, Error **errp)
859 if (blk->dev_ops && blk->dev_ops->change_media_cb) {
860 bool tray_was_open, tray_is_open;
861 Error *local_err = NULL;
863 assert(!blk->legacy_dev);
865 tray_was_open = blk_dev_is_tray_open(blk);
866 blk->dev_ops->change_media_cb(blk->dev_opaque, load, &local_err);
867 if (local_err) {
868 assert(load == true);
869 error_propagate(errp, local_err);
870 return;
872 tray_is_open = blk_dev_is_tray_open(blk);
874 if (tray_was_open != tray_is_open) {
875 char *id = blk_get_attached_dev_id(blk);
876 qapi_event_send_device_tray_moved(blk_name(blk), id, tray_is_open,
877 &error_abort);
878 g_free(id);
883 static void blk_root_change_media(BdrvChild *child, bool load)
885 blk_dev_change_media_cb(child->opaque, load, NULL);
889 * Does @blk's attached device model have removable media?
890 * %true if no device model is attached.
892 bool blk_dev_has_removable_media(BlockBackend *blk)
894 return !blk->dev || (blk->dev_ops && blk->dev_ops->change_media_cb);
898 * Does @blk's attached device model have a tray?
900 bool blk_dev_has_tray(BlockBackend *blk)
902 return blk->dev_ops && blk->dev_ops->is_tray_open;
906 * Notify @blk's attached device model of a media eject request.
907 * If @force is true, the medium is about to be yanked out forcefully.
909 void blk_dev_eject_request(BlockBackend *blk, bool force)
911 if (blk->dev_ops && blk->dev_ops->eject_request_cb) {
912 blk->dev_ops->eject_request_cb(blk->dev_opaque, force);
917 * Does @blk's attached device model have a tray, and is it open?
919 bool blk_dev_is_tray_open(BlockBackend *blk)
921 if (blk_dev_has_tray(blk)) {
922 return blk->dev_ops->is_tray_open(blk->dev_opaque);
924 return false;
928 * Does @blk's attached device model have the medium locked?
929 * %false if the device model has no such lock.
931 bool blk_dev_is_medium_locked(BlockBackend *blk)
933 if (blk->dev_ops && blk->dev_ops->is_medium_locked) {
934 return blk->dev_ops->is_medium_locked(blk->dev_opaque);
936 return false;
940 * Notify @blk's attached device model of a backend size change.
942 static void blk_root_resize(BdrvChild *child)
944 BlockBackend *blk = child->opaque;
946 if (blk->dev_ops && blk->dev_ops->resize_cb) {
947 blk->dev_ops->resize_cb(blk->dev_opaque);
951 void blk_iostatus_enable(BlockBackend *blk)
953 blk->iostatus_enabled = true;
954 blk->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
957 /* The I/O status is only enabled if the drive explicitly
958 * enables it _and_ the VM is configured to stop on errors */
959 bool blk_iostatus_is_enabled(const BlockBackend *blk)
961 return (blk->iostatus_enabled &&
962 (blk->on_write_error == BLOCKDEV_ON_ERROR_ENOSPC ||
963 blk->on_write_error == BLOCKDEV_ON_ERROR_STOP ||
964 blk->on_read_error == BLOCKDEV_ON_ERROR_STOP));
967 BlockDeviceIoStatus blk_iostatus(const BlockBackend *blk)
969 return blk->iostatus;
972 void blk_iostatus_disable(BlockBackend *blk)
974 blk->iostatus_enabled = false;
977 void blk_iostatus_reset(BlockBackend *blk)
979 if (blk_iostatus_is_enabled(blk)) {
980 BlockDriverState *bs = blk_bs(blk);
981 blk->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
982 if (bs && bs->job) {
983 block_job_iostatus_reset(bs->job);
988 void blk_iostatus_set_err(BlockBackend *blk, int error)
990 assert(blk_iostatus_is_enabled(blk));
991 if (blk->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
992 blk->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
993 BLOCK_DEVICE_IO_STATUS_FAILED;
997 void blk_set_allow_write_beyond_eof(BlockBackend *blk, bool allow)
999 blk->allow_write_beyond_eof = allow;
1002 static int blk_check_byte_request(BlockBackend *blk, int64_t offset,
1003 size_t size)
1005 int64_t len;
1007 if (size > INT_MAX) {
1008 return -EIO;
1011 if (!blk_is_available(blk)) {
1012 return -ENOMEDIUM;
1015 if (offset < 0) {
1016 return -EIO;
1019 if (!blk->allow_write_beyond_eof) {
1020 len = blk_getlength(blk);
1021 if (len < 0) {
1022 return len;
1025 if (offset > len || len - offset < size) {
1026 return -EIO;
1030 return 0;
1033 int coroutine_fn blk_co_preadv(BlockBackend *blk, int64_t offset,
1034 unsigned int bytes, QEMUIOVector *qiov,
1035 BdrvRequestFlags flags)
1037 int ret;
1038 BlockDriverState *bs = blk_bs(blk);
1040 trace_blk_co_preadv(blk, bs, offset, bytes, flags);
1042 ret = blk_check_byte_request(blk, offset, bytes);
1043 if (ret < 0) {
1044 return ret;
1047 bdrv_inc_in_flight(bs);
1049 /* throttling disk I/O */
1050 if (blk->public.throttle_group_member.throttle_state) {
1051 throttle_group_co_io_limits_intercept(&blk->public.throttle_group_member,
1052 bytes, false);
1055 ret = bdrv_co_preadv(blk->root, offset, bytes, qiov, flags);
1056 bdrv_dec_in_flight(bs);
1057 return ret;
1060 int coroutine_fn blk_co_pwritev(BlockBackend *blk, int64_t offset,
1061 unsigned int bytes, QEMUIOVector *qiov,
1062 BdrvRequestFlags flags)
1064 int ret;
1065 BlockDriverState *bs = blk_bs(blk);
1067 trace_blk_co_pwritev(blk, bs, offset, bytes, flags);
1069 ret = blk_check_byte_request(blk, offset, bytes);
1070 if (ret < 0) {
1071 return ret;
1074 bdrv_inc_in_flight(bs);
1075 /* throttling disk I/O */
1076 if (blk->public.throttle_group_member.throttle_state) {
1077 throttle_group_co_io_limits_intercept(&blk->public.throttle_group_member,
1078 bytes, true);
1081 if (!blk->enable_write_cache) {
1082 flags |= BDRV_REQ_FUA;
1085 ret = bdrv_co_pwritev(blk->root, offset, bytes, qiov, flags);
1086 bdrv_dec_in_flight(bs);
1087 return ret;
1090 typedef struct BlkRwCo {
1091 BlockBackend *blk;
1092 int64_t offset;
1093 QEMUIOVector *qiov;
1094 int ret;
1095 BdrvRequestFlags flags;
1096 } BlkRwCo;
1098 static void blk_read_entry(void *opaque)
1100 BlkRwCo *rwco = opaque;
1102 rwco->ret = blk_co_preadv(rwco->blk, rwco->offset, rwco->qiov->size,
1103 rwco->qiov, rwco->flags);
1106 static void blk_write_entry(void *opaque)
1108 BlkRwCo *rwco = opaque;
1110 rwco->ret = blk_co_pwritev(rwco->blk, rwco->offset, rwco->qiov->size,
1111 rwco->qiov, rwco->flags);
1114 static int blk_prw(BlockBackend *blk, int64_t offset, uint8_t *buf,
1115 int64_t bytes, CoroutineEntry co_entry,
1116 BdrvRequestFlags flags)
1118 QEMUIOVector qiov;
1119 struct iovec iov;
1120 BlkRwCo rwco;
1122 iov = (struct iovec) {
1123 .iov_base = buf,
1124 .iov_len = bytes,
1126 qemu_iovec_init_external(&qiov, &iov, 1);
1128 rwco = (BlkRwCo) {
1129 .blk = blk,
1130 .offset = offset,
1131 .qiov = &qiov,
1132 .flags = flags,
1133 .ret = NOT_DONE,
1136 if (qemu_in_coroutine()) {
1137 /* Fast-path if already in coroutine context */
1138 co_entry(&rwco);
1139 } else {
1140 Coroutine *co = qemu_coroutine_create(co_entry, &rwco);
1141 bdrv_coroutine_enter(blk_bs(blk), co);
1142 BDRV_POLL_WHILE(blk_bs(blk), rwco.ret == NOT_DONE);
1145 return rwco.ret;
1148 int blk_pread_unthrottled(BlockBackend *blk, int64_t offset, uint8_t *buf,
1149 int count)
1151 int ret;
1153 ret = blk_check_byte_request(blk, offset, count);
1154 if (ret < 0) {
1155 return ret;
1158 blk_root_drained_begin(blk->root);
1159 ret = blk_pread(blk, offset, buf, count);
1160 blk_root_drained_end(blk->root);
1161 return ret;
1164 int blk_pwrite_zeroes(BlockBackend *blk, int64_t offset,
1165 int bytes, BdrvRequestFlags flags)
1167 return blk_prw(blk, offset, NULL, bytes, blk_write_entry,
1168 flags | BDRV_REQ_ZERO_WRITE);
1171 int blk_make_zero(BlockBackend *blk, BdrvRequestFlags flags)
1173 return bdrv_make_zero(blk->root, flags);
1176 static void error_callback_bh(void *opaque)
1178 struct BlockBackendAIOCB *acb = opaque;
1180 bdrv_dec_in_flight(acb->common.bs);
1181 acb->common.cb(acb->common.opaque, acb->ret);
1182 qemu_aio_unref(acb);
1185 BlockAIOCB *blk_abort_aio_request(BlockBackend *blk,
1186 BlockCompletionFunc *cb,
1187 void *opaque, int ret)
1189 struct BlockBackendAIOCB *acb;
1191 bdrv_inc_in_flight(blk_bs(blk));
1192 acb = blk_aio_get(&block_backend_aiocb_info, blk, cb, opaque);
1193 acb->blk = blk;
1194 acb->ret = ret;
1196 aio_bh_schedule_oneshot(blk_get_aio_context(blk), error_callback_bh, acb);
1197 return &acb->common;
1200 typedef struct BlkAioEmAIOCB {
1201 BlockAIOCB common;
1202 BlkRwCo rwco;
1203 int bytes;
1204 bool has_returned;
1205 } BlkAioEmAIOCB;
1207 static const AIOCBInfo blk_aio_em_aiocb_info = {
1208 .aiocb_size = sizeof(BlkAioEmAIOCB),
1211 static void blk_aio_complete(BlkAioEmAIOCB *acb)
1213 if (acb->has_returned) {
1214 bdrv_dec_in_flight(acb->common.bs);
1215 acb->common.cb(acb->common.opaque, acb->rwco.ret);
1216 qemu_aio_unref(acb);
1220 static void blk_aio_complete_bh(void *opaque)
1222 BlkAioEmAIOCB *acb = opaque;
1223 assert(acb->has_returned);
1224 blk_aio_complete(acb);
1227 static BlockAIOCB *blk_aio_prwv(BlockBackend *blk, int64_t offset, int bytes,
1228 QEMUIOVector *qiov, CoroutineEntry co_entry,
1229 BdrvRequestFlags flags,
1230 BlockCompletionFunc *cb, void *opaque)
1232 BlkAioEmAIOCB *acb;
1233 Coroutine *co;
1235 bdrv_inc_in_flight(blk_bs(blk));
1236 acb = blk_aio_get(&blk_aio_em_aiocb_info, blk, cb, opaque);
1237 acb->rwco = (BlkRwCo) {
1238 .blk = blk,
1239 .offset = offset,
1240 .qiov = qiov,
1241 .flags = flags,
1242 .ret = NOT_DONE,
1244 acb->bytes = bytes;
1245 acb->has_returned = false;
1247 co = qemu_coroutine_create(co_entry, acb);
1248 bdrv_coroutine_enter(blk_bs(blk), co);
1250 acb->has_returned = true;
1251 if (acb->rwco.ret != NOT_DONE) {
1252 aio_bh_schedule_oneshot(blk_get_aio_context(blk),
1253 blk_aio_complete_bh, acb);
1256 return &acb->common;
1259 static void blk_aio_read_entry(void *opaque)
1261 BlkAioEmAIOCB *acb = opaque;
1262 BlkRwCo *rwco = &acb->rwco;
1264 assert(rwco->qiov->size == acb->bytes);
1265 rwco->ret = blk_co_preadv(rwco->blk, rwco->offset, acb->bytes,
1266 rwco->qiov, rwco->flags);
1267 blk_aio_complete(acb);
1270 static void blk_aio_write_entry(void *opaque)
1272 BlkAioEmAIOCB *acb = opaque;
1273 BlkRwCo *rwco = &acb->rwco;
1275 assert(!rwco->qiov || rwco->qiov->size == acb->bytes);
1276 rwco->ret = blk_co_pwritev(rwco->blk, rwco->offset, acb->bytes,
1277 rwco->qiov, rwco->flags);
1278 blk_aio_complete(acb);
1281 BlockAIOCB *blk_aio_pwrite_zeroes(BlockBackend *blk, int64_t offset,
1282 int count, BdrvRequestFlags flags,
1283 BlockCompletionFunc *cb, void *opaque)
1285 return blk_aio_prwv(blk, offset, count, NULL, blk_aio_write_entry,
1286 flags | BDRV_REQ_ZERO_WRITE, cb, opaque);
1289 int blk_pread(BlockBackend *blk, int64_t offset, void *buf, int count)
1291 int ret = blk_prw(blk, offset, buf, count, blk_read_entry, 0);
1292 if (ret < 0) {
1293 return ret;
1295 return count;
1298 int blk_pwrite(BlockBackend *blk, int64_t offset, const void *buf, int count,
1299 BdrvRequestFlags flags)
1301 int ret = blk_prw(blk, offset, (void *) buf, count, blk_write_entry,
1302 flags);
1303 if (ret < 0) {
1304 return ret;
1306 return count;
1309 int64_t blk_getlength(BlockBackend *blk)
1311 if (!blk_is_available(blk)) {
1312 return -ENOMEDIUM;
1315 return bdrv_getlength(blk_bs(blk));
1318 void blk_get_geometry(BlockBackend *blk, uint64_t *nb_sectors_ptr)
1320 if (!blk_bs(blk)) {
1321 *nb_sectors_ptr = 0;
1322 } else {
1323 bdrv_get_geometry(blk_bs(blk), nb_sectors_ptr);
1327 int64_t blk_nb_sectors(BlockBackend *blk)
1329 if (!blk_is_available(blk)) {
1330 return -ENOMEDIUM;
1333 return bdrv_nb_sectors(blk_bs(blk));
1336 BlockAIOCB *blk_aio_preadv(BlockBackend *blk, int64_t offset,
1337 QEMUIOVector *qiov, BdrvRequestFlags flags,
1338 BlockCompletionFunc *cb, void *opaque)
1340 return blk_aio_prwv(blk, offset, qiov->size, qiov,
1341 blk_aio_read_entry, flags, cb, opaque);
1344 BlockAIOCB *blk_aio_pwritev(BlockBackend *blk, int64_t offset,
1345 QEMUIOVector *qiov, BdrvRequestFlags flags,
1346 BlockCompletionFunc *cb, void *opaque)
1348 return blk_aio_prwv(blk, offset, qiov->size, qiov,
1349 blk_aio_write_entry, flags, cb, opaque);
1352 static void blk_aio_flush_entry(void *opaque)
1354 BlkAioEmAIOCB *acb = opaque;
1355 BlkRwCo *rwco = &acb->rwco;
1357 rwco->ret = blk_co_flush(rwco->blk);
1358 blk_aio_complete(acb);
1361 BlockAIOCB *blk_aio_flush(BlockBackend *blk,
1362 BlockCompletionFunc *cb, void *opaque)
1364 return blk_aio_prwv(blk, 0, 0, NULL, blk_aio_flush_entry, 0, cb, opaque);
1367 static void blk_aio_pdiscard_entry(void *opaque)
1369 BlkAioEmAIOCB *acb = opaque;
1370 BlkRwCo *rwco = &acb->rwco;
1372 rwco->ret = blk_co_pdiscard(rwco->blk, rwco->offset, acb->bytes);
1373 blk_aio_complete(acb);
1376 BlockAIOCB *blk_aio_pdiscard(BlockBackend *blk,
1377 int64_t offset, int bytes,
1378 BlockCompletionFunc *cb, void *opaque)
1380 return blk_aio_prwv(blk, offset, bytes, NULL, blk_aio_pdiscard_entry, 0,
1381 cb, opaque);
1384 void blk_aio_cancel(BlockAIOCB *acb)
1386 bdrv_aio_cancel(acb);
1389 void blk_aio_cancel_async(BlockAIOCB *acb)
1391 bdrv_aio_cancel_async(acb);
1394 int blk_co_ioctl(BlockBackend *blk, unsigned long int req, void *buf)
1396 if (!blk_is_available(blk)) {
1397 return -ENOMEDIUM;
1400 return bdrv_co_ioctl(blk_bs(blk), req, buf);
1403 static void blk_ioctl_entry(void *opaque)
1405 BlkRwCo *rwco = opaque;
1406 rwco->ret = blk_co_ioctl(rwco->blk, rwco->offset,
1407 rwco->qiov->iov[0].iov_base);
1410 int blk_ioctl(BlockBackend *blk, unsigned long int req, void *buf)
1412 return blk_prw(blk, req, buf, 0, blk_ioctl_entry, 0);
1415 static void blk_aio_ioctl_entry(void *opaque)
1417 BlkAioEmAIOCB *acb = opaque;
1418 BlkRwCo *rwco = &acb->rwco;
1420 rwco->ret = blk_co_ioctl(rwco->blk, rwco->offset,
1421 rwco->qiov->iov[0].iov_base);
1422 blk_aio_complete(acb);
1425 BlockAIOCB *blk_aio_ioctl(BlockBackend *blk, unsigned long int req, void *buf,
1426 BlockCompletionFunc *cb, void *opaque)
1428 QEMUIOVector qiov;
1429 struct iovec iov;
1431 iov = (struct iovec) {
1432 .iov_base = buf,
1433 .iov_len = 0,
1435 qemu_iovec_init_external(&qiov, &iov, 1);
1437 return blk_aio_prwv(blk, req, 0, &qiov, blk_aio_ioctl_entry, 0, cb, opaque);
1440 int blk_co_pdiscard(BlockBackend *blk, int64_t offset, int bytes)
1442 int ret = blk_check_byte_request(blk, offset, bytes);
1443 if (ret < 0) {
1444 return ret;
1447 return bdrv_co_pdiscard(blk_bs(blk), offset, bytes);
1450 int blk_co_flush(BlockBackend *blk)
1452 if (!blk_is_available(blk)) {
1453 return -ENOMEDIUM;
1456 return bdrv_co_flush(blk_bs(blk));
1459 static void blk_flush_entry(void *opaque)
1461 BlkRwCo *rwco = opaque;
1462 rwco->ret = blk_co_flush(rwco->blk);
1465 int blk_flush(BlockBackend *blk)
1467 return blk_prw(blk, 0, NULL, 0, blk_flush_entry, 0);
1470 void blk_drain(BlockBackend *blk)
1472 if (blk_bs(blk)) {
1473 bdrv_drain(blk_bs(blk));
1477 void blk_drain_all(void)
1479 bdrv_drain_all();
1482 void blk_set_on_error(BlockBackend *blk, BlockdevOnError on_read_error,
1483 BlockdevOnError on_write_error)
1485 blk->on_read_error = on_read_error;
1486 blk->on_write_error = on_write_error;
1489 BlockdevOnError blk_get_on_error(BlockBackend *blk, bool is_read)
1491 return is_read ? blk->on_read_error : blk->on_write_error;
1494 BlockErrorAction blk_get_error_action(BlockBackend *blk, bool is_read,
1495 int error)
1497 BlockdevOnError on_err = blk_get_on_error(blk, is_read);
1499 switch (on_err) {
1500 case BLOCKDEV_ON_ERROR_ENOSPC:
1501 return (error == ENOSPC) ?
1502 BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT;
1503 case BLOCKDEV_ON_ERROR_STOP:
1504 return BLOCK_ERROR_ACTION_STOP;
1505 case BLOCKDEV_ON_ERROR_REPORT:
1506 return BLOCK_ERROR_ACTION_REPORT;
1507 case BLOCKDEV_ON_ERROR_IGNORE:
1508 return BLOCK_ERROR_ACTION_IGNORE;
1509 case BLOCKDEV_ON_ERROR_AUTO:
1510 default:
1511 abort();
1515 static void send_qmp_error_event(BlockBackend *blk,
1516 BlockErrorAction action,
1517 bool is_read, int error)
1519 IoOperationType optype;
1521 optype = is_read ? IO_OPERATION_TYPE_READ : IO_OPERATION_TYPE_WRITE;
1522 qapi_event_send_block_io_error(blk_name(blk),
1523 bdrv_get_node_name(blk_bs(blk)), optype,
1524 action, blk_iostatus_is_enabled(blk),
1525 error == ENOSPC, strerror(error),
1526 &error_abort);
1529 /* This is done by device models because, while the block layer knows
1530 * about the error, it does not know whether an operation comes from
1531 * the device or the block layer (from a job, for example).
1533 void blk_error_action(BlockBackend *blk, BlockErrorAction action,
1534 bool is_read, int error)
1536 assert(error >= 0);
1538 if (action == BLOCK_ERROR_ACTION_STOP) {
1539 /* First set the iostatus, so that "info block" returns an iostatus
1540 * that matches the events raised so far (an additional error iostatus
1541 * is fine, but not a lost one).
1543 blk_iostatus_set_err(blk, error);
1545 /* Then raise the request to stop the VM and the event.
1546 * qemu_system_vmstop_request_prepare has two effects. First,
1547 * it ensures that the STOP event always comes after the
1548 * BLOCK_IO_ERROR event. Second, it ensures that even if management
1549 * can observe the STOP event and do a "cont" before the STOP
1550 * event is issued, the VM will not stop. In this case, vm_start()
1551 * also ensures that the STOP/RESUME pair of events is emitted.
1553 qemu_system_vmstop_request_prepare();
1554 send_qmp_error_event(blk, action, is_read, error);
1555 qemu_system_vmstop_request(RUN_STATE_IO_ERROR);
1556 } else {
1557 send_qmp_error_event(blk, action, is_read, error);
1561 int blk_is_read_only(BlockBackend *blk)
1563 BlockDriverState *bs = blk_bs(blk);
1565 if (bs) {
1566 return bdrv_is_read_only(bs);
1567 } else {
1568 return blk->root_state.read_only;
1572 int blk_is_sg(BlockBackend *blk)
1574 BlockDriverState *bs = blk_bs(blk);
1576 if (!bs) {
1577 return 0;
1580 return bdrv_is_sg(bs);
1583 int blk_enable_write_cache(BlockBackend *blk)
1585 return blk->enable_write_cache;
1588 void blk_set_enable_write_cache(BlockBackend *blk, bool wce)
1590 blk->enable_write_cache = wce;
1593 void blk_invalidate_cache(BlockBackend *blk, Error **errp)
1595 BlockDriverState *bs = blk_bs(blk);
1597 if (!bs) {
1598 error_setg(errp, "Device '%s' has no medium", blk->name);
1599 return;
1602 bdrv_invalidate_cache(bs, errp);
1605 bool blk_is_inserted(BlockBackend *blk)
1607 BlockDriverState *bs = blk_bs(blk);
1609 return bs && bdrv_is_inserted(bs);
1612 bool blk_is_available(BlockBackend *blk)
1614 return blk_is_inserted(blk) && !blk_dev_is_tray_open(blk);
1617 void blk_lock_medium(BlockBackend *blk, bool locked)
1619 BlockDriverState *bs = blk_bs(blk);
1621 if (bs) {
1622 bdrv_lock_medium(bs, locked);
1626 void blk_eject(BlockBackend *blk, bool eject_flag)
1628 BlockDriverState *bs = blk_bs(blk);
1629 char *id;
1631 /* blk_eject is only called by qdevified devices */
1632 assert(!blk->legacy_dev);
1634 if (bs) {
1635 bdrv_eject(bs, eject_flag);
1638 /* Whether or not we ejected on the backend,
1639 * the frontend experienced a tray event. */
1640 id = blk_get_attached_dev_id(blk);
1641 qapi_event_send_device_tray_moved(blk_name(blk), id,
1642 eject_flag, &error_abort);
1643 g_free(id);
1646 int blk_get_flags(BlockBackend *blk)
1648 BlockDriverState *bs = blk_bs(blk);
1650 if (bs) {
1651 return bdrv_get_flags(bs);
1652 } else {
1653 return blk->root_state.open_flags;
1657 /* Returns the maximum transfer length, in bytes; guaranteed nonzero */
1658 uint32_t blk_get_max_transfer(BlockBackend *blk)
1660 BlockDriverState *bs = blk_bs(blk);
1661 uint32_t max = 0;
1663 if (bs) {
1664 max = bs->bl.max_transfer;
1666 return MIN_NON_ZERO(max, INT_MAX);
1669 int blk_get_max_iov(BlockBackend *blk)
1671 return blk->root->bs->bl.max_iov;
1674 void blk_set_guest_block_size(BlockBackend *blk, int align)
1676 blk->guest_block_size = align;
1679 void *blk_try_blockalign(BlockBackend *blk, size_t size)
1681 return qemu_try_blockalign(blk ? blk_bs(blk) : NULL, size);
1684 void *blk_blockalign(BlockBackend *blk, size_t size)
1686 return qemu_blockalign(blk ? blk_bs(blk) : NULL, size);
1689 bool blk_op_is_blocked(BlockBackend *blk, BlockOpType op, Error **errp)
1691 BlockDriverState *bs = blk_bs(blk);
1693 if (!bs) {
1694 return false;
1697 return bdrv_op_is_blocked(bs, op, errp);
1700 void blk_op_unblock(BlockBackend *blk, BlockOpType op, Error *reason)
1702 BlockDriverState *bs = blk_bs(blk);
1704 if (bs) {
1705 bdrv_op_unblock(bs, op, reason);
1709 void blk_op_block_all(BlockBackend *blk, Error *reason)
1711 BlockDriverState *bs = blk_bs(blk);
1713 if (bs) {
1714 bdrv_op_block_all(bs, reason);
1718 void blk_op_unblock_all(BlockBackend *blk, Error *reason)
1720 BlockDriverState *bs = blk_bs(blk);
1722 if (bs) {
1723 bdrv_op_unblock_all(bs, reason);
1727 AioContext *blk_get_aio_context(BlockBackend *blk)
1729 BlockDriverState *bs = blk_bs(blk);
1731 if (bs) {
1732 return bdrv_get_aio_context(bs);
1733 } else {
1734 return qemu_get_aio_context();
1738 static AioContext *blk_aiocb_get_aio_context(BlockAIOCB *acb)
1740 BlockBackendAIOCB *blk_acb = DO_UPCAST(BlockBackendAIOCB, common, acb);
1741 return blk_get_aio_context(blk_acb->blk);
1744 void blk_set_aio_context(BlockBackend *blk, AioContext *new_context)
1746 BlockDriverState *bs = blk_bs(blk);
1747 ThrottleGroupMember *tgm = &blk->public.throttle_group_member;
1749 if (bs) {
1750 if (tgm->throttle_state) {
1751 throttle_group_detach_aio_context(tgm);
1752 throttle_group_attach_aio_context(tgm, new_context);
1754 bdrv_set_aio_context(bs, 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->public.throttle_group_member, cfg);
1975 void blk_io_limits_disable(BlockBackend *blk)
1977 assert(blk->public.throttle_group_member.throttle_state);
1978 bdrv_drained_begin(blk_bs(blk));
1979 throttle_group_unregister_tgm(&blk->public.throttle_group_member);
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_group_member.throttle_state);
1987 throttle_group_register_tgm(&blk->public.throttle_group_member,
1988 group, blk_get_aio_context(blk));
1991 void blk_io_limits_update_group(BlockBackend *blk, const char *group)
1993 /* this BB is not part of any group */
1994 if (!blk->public.throttle_group_member.throttle_state) {
1995 return;
1998 /* this BB is a part of the same group than the one we want */
1999 if (!g_strcmp0(throttle_group_get_name(&blk->public.throttle_group_member),
2000 group)) {
2001 return;
2004 /* need to change the group this bs belong to */
2005 blk_io_limits_disable(blk);
2006 blk_io_limits_enable(blk, group);
2009 static void blk_root_drained_begin(BdrvChild *child)
2011 BlockBackend *blk = child->opaque;
2013 if (++blk->quiesce_counter == 1) {
2014 if (blk->dev_ops && blk->dev_ops->drained_begin) {
2015 blk->dev_ops->drained_begin(blk->dev_opaque);
2019 /* Note that blk->root may not be accessible here yet if we are just
2020 * attaching to a BlockDriverState that is drained. Use child instead. */
2022 if (atomic_fetch_inc(&blk->public.throttle_group_member.io_limits_disabled) == 0) {
2023 throttle_group_restart_tgm(&blk->public.throttle_group_member);
2027 static void blk_root_drained_end(BdrvChild *child)
2029 BlockBackend *blk = child->opaque;
2030 assert(blk->quiesce_counter);
2032 assert(blk->public.throttle_group_member.io_limits_disabled);
2033 atomic_dec(&blk->public.throttle_group_member.io_limits_disabled);
2035 if (--blk->quiesce_counter == 0) {
2036 if (blk->dev_ops && blk->dev_ops->drained_end) {
2037 blk->dev_ops->drained_end(blk->dev_opaque);