xref: /openbmc/qemu/block/block-backend.c (revision 7200fb21)
1 /*
2  * QEMU Block backends
3  *
4  * Copyright (C) 2014-2016 Red Hat, Inc.
5  *
6  * Authors:
7  *  Markus Armbruster <armbru@redhat.com>,
8  *
9  * This work is licensed under the terms of the GNU LGPL, version 2.1
10  * or later.  See the COPYING.LIB file in the top-level directory.
11  */
12 
13 #include "qemu/osdep.h"
14 #include "sysemu/block-backend.h"
15 #include "block/block_int.h"
16 #include "block/blockjob.h"
17 #include "block/coroutines.h"
18 #include "block/throttle-groups.h"
19 #include "hw/qdev-core.h"
20 #include "sysemu/blockdev.h"
21 #include "sysemu/runstate.h"
22 #include "sysemu/replay.h"
23 #include "qapi/error.h"
24 #include "qapi/qapi-events-block.h"
25 #include "qemu/id.h"
26 #include "qemu/main-loop.h"
27 #include "qemu/option.h"
28 #include "trace.h"
29 #include "migration/misc.h"
30 
31 /* Number of coroutines to reserve per attached device model */
32 #define COROUTINE_POOL_RESERVATION 64
33 
34 #define NOT_DONE 0x7fffffff /* used while emulated sync operation in progress */
35 
36 typedef struct BlockBackendAioNotifier {
37     void (*attached_aio_context)(AioContext *new_context, void *opaque);
38     void (*detach_aio_context)(void *opaque);
39     void *opaque;
40     QLIST_ENTRY(BlockBackendAioNotifier) list;
41 } BlockBackendAioNotifier;
42 
43 struct BlockBackend {
44     char *name;
45     int refcnt;
46     BdrvChild *root;
47     AioContext *ctx;
48     DriveInfo *legacy_dinfo;    /* null unless created by drive_new() */
49     QTAILQ_ENTRY(BlockBackend) link;         /* for block_backends */
50     QTAILQ_ENTRY(BlockBackend) monitor_link; /* for monitor_block_backends */
51     BlockBackendPublic public;
52 
53     DeviceState *dev;           /* attached device model, if any */
54     const BlockDevOps *dev_ops;
55     void *dev_opaque;
56 
57     /* If the BDS tree is removed, some of its options are stored here (which
58      * can be used to restore those options in the new BDS on insert) */
59     BlockBackendRootState root_state;
60 
61     bool enable_write_cache;
62 
63     /* I/O stats (display with "info blockstats"). */
64     BlockAcctStats stats;
65 
66     BlockdevOnError on_read_error, on_write_error;
67     bool iostatus_enabled;
68     BlockDeviceIoStatus iostatus;
69 
70     uint64_t perm;
71     uint64_t shared_perm;
72     bool disable_perm;
73 
74     bool allow_aio_context_change;
75     bool allow_write_beyond_eof;
76 
77     /* Protected by BQL */
78     NotifierList remove_bs_notifiers, insert_bs_notifiers;
79     QLIST_HEAD(, BlockBackendAioNotifier) aio_notifiers;
80 
81     int quiesce_counter; /* atomic: written under BQL, read by other threads */
82     QemuMutex queued_requests_lock; /* protects queued_requests */
83     CoQueue queued_requests;
84     bool disable_request_queuing; /* atomic */
85 
86     VMChangeStateEntry *vmsh;
87     bool force_allow_inactivate;
88 
89     /* Number of in-flight aio requests.  BlockDriverState also counts
90      * in-flight requests but aio requests can exist even when blk->root is
91      * NULL, so we cannot rely on its counter for that case.
92      * Accessed with atomic ops.
93      */
94     unsigned int in_flight;
95 };
96 
97 typedef struct BlockBackendAIOCB {
98     BlockAIOCB common;
99     BlockBackend *blk;
100     int ret;
101 } BlockBackendAIOCB;
102 
103 static const AIOCBInfo block_backend_aiocb_info = {
104     .aiocb_size = sizeof(BlockBackendAIOCB),
105 };
106 
107 static void drive_info_del(DriveInfo *dinfo);
108 static BlockBackend *bdrv_first_blk(BlockDriverState *bs);
109 
110 /* All BlockBackends. Protected by BQL. */
111 static QTAILQ_HEAD(, BlockBackend) block_backends =
112     QTAILQ_HEAD_INITIALIZER(block_backends);
113 
114 /*
115  * All BlockBackends referenced by the monitor and which are iterated through by
116  * blk_next(). Protected by BQL.
117  */
118 static QTAILQ_HEAD(, BlockBackend) monitor_block_backends =
119     QTAILQ_HEAD_INITIALIZER(monitor_block_backends);
120 
121 static int coroutine_mixed_fn GRAPH_RDLOCK
122 blk_set_perm_locked(BlockBackend *blk, uint64_t perm, uint64_t shared_perm,
123                     Error **errp);
124 
125 static void blk_root_inherit_options(BdrvChildRole role, bool parent_is_format,
126                                      int *child_flags, QDict *child_options,
127                                      int parent_flags, QDict *parent_options)
128 {
129     /* We're not supposed to call this function for root nodes */
130     abort();
131 }
132 static void blk_root_drained_begin(BdrvChild *child);
133 static bool blk_root_drained_poll(BdrvChild *child);
134 static void blk_root_drained_end(BdrvChild *child);
135 
136 static void blk_root_change_media(BdrvChild *child, bool load);
137 static void blk_root_resize(BdrvChild *child);
138 
139 static bool blk_root_change_aio_ctx(BdrvChild *child, AioContext *ctx,
140                                     GHashTable *visited, Transaction *tran,
141                                     Error **errp);
142 
143 static char *blk_root_get_parent_desc(BdrvChild *child)
144 {
145     BlockBackend *blk = child->opaque;
146     g_autofree char *dev_id = NULL;
147 
148     if (blk->name) {
149         return g_strdup_printf("block device '%s'", blk->name);
150     }
151 
152     dev_id = blk_get_attached_dev_id(blk);
153     if (*dev_id) {
154         return g_strdup_printf("block device '%s'", dev_id);
155     } else {
156         /* TODO Callback into the BB owner for something more detailed */
157         return g_strdup("an unnamed block device");
158     }
159 }
160 
161 static const char *blk_root_get_name(BdrvChild *child)
162 {
163     return blk_name(child->opaque);
164 }
165 
166 static void blk_vm_state_changed(void *opaque, bool running, RunState state)
167 {
168     Error *local_err = NULL;
169     BlockBackend *blk = opaque;
170 
171     if (state == RUN_STATE_INMIGRATE) {
172         return;
173     }
174 
175     qemu_del_vm_change_state_handler(blk->vmsh);
176     blk->vmsh = NULL;
177     blk_set_perm(blk, blk->perm, blk->shared_perm, &local_err);
178     if (local_err) {
179         error_report_err(local_err);
180     }
181 }
182 
183 /*
184  * Notifies the user of the BlockBackend that migration has completed. qdev
185  * devices can tighten their permissions in response (specifically revoke
186  * shared write permissions that we needed for storage migration).
187  *
188  * If an error is returned, the VM cannot be allowed to be resumed.
189  */
190 static void GRAPH_RDLOCK blk_root_activate(BdrvChild *child, Error **errp)
191 {
192     BlockBackend *blk = child->opaque;
193     Error *local_err = NULL;
194     uint64_t saved_shared_perm;
195 
196     if (!blk->disable_perm) {
197         return;
198     }
199 
200     blk->disable_perm = false;
201 
202     /*
203      * blk->shared_perm contains the permissions we want to share once
204      * migration is really completely done.  For now, we need to share
205      * all; but we also need to retain blk->shared_perm, which is
206      * overwritten by a successful blk_set_perm() call.  Save it and
207      * restore it below.
208      */
209     saved_shared_perm = blk->shared_perm;
210 
211     blk_set_perm_locked(blk, blk->perm, BLK_PERM_ALL, &local_err);
212     if (local_err) {
213         error_propagate(errp, local_err);
214         blk->disable_perm = true;
215         return;
216     }
217     blk->shared_perm = saved_shared_perm;
218 
219     if (runstate_check(RUN_STATE_INMIGRATE)) {
220         /* Activation can happen when migration process is still active, for
221          * example when nbd_server_add is called during non-shared storage
222          * migration. Defer the shared_perm update to migration completion. */
223         if (!blk->vmsh) {
224             blk->vmsh = qemu_add_vm_change_state_handler(blk_vm_state_changed,
225                                                          blk);
226         }
227         return;
228     }
229 
230     blk_set_perm_locked(blk, blk->perm, blk->shared_perm, &local_err);
231     if (local_err) {
232         error_propagate(errp, local_err);
233         blk->disable_perm = true;
234         return;
235     }
236 }
237 
238 void blk_set_force_allow_inactivate(BlockBackend *blk)
239 {
240     GLOBAL_STATE_CODE();
241     blk->force_allow_inactivate = true;
242 }
243 
244 static bool blk_can_inactivate(BlockBackend *blk)
245 {
246     /* If it is a guest device, inactivate is ok. */
247     if (blk->dev || blk_name(blk)[0]) {
248         return true;
249     }
250 
251     /* Inactivating means no more writes to the image can be done,
252      * even if those writes would be changes invisible to the
253      * guest.  For block job BBs that satisfy this, we can just allow
254      * it.  This is the case for mirror job source, which is required
255      * by libvirt non-shared block migration. */
256     if (!(blk->perm & (BLK_PERM_WRITE | BLK_PERM_WRITE_UNCHANGED))) {
257         return true;
258     }
259 
260     return blk->force_allow_inactivate;
261 }
262 
263 static int GRAPH_RDLOCK blk_root_inactivate(BdrvChild *child)
264 {
265     BlockBackend *blk = child->opaque;
266 
267     if (blk->disable_perm) {
268         return 0;
269     }
270 
271     if (!blk_can_inactivate(blk)) {
272         return -EPERM;
273     }
274 
275     blk->disable_perm = true;
276     if (blk->root) {
277         bdrv_child_try_set_perm(blk->root, 0, BLK_PERM_ALL, &error_abort);
278     }
279 
280     return 0;
281 }
282 
283 static void blk_root_attach(BdrvChild *child)
284 {
285     BlockBackend *blk = child->opaque;
286     BlockBackendAioNotifier *notifier;
287 
288     trace_blk_root_attach(child, blk, child->bs);
289 
290     QLIST_FOREACH(notifier, &blk->aio_notifiers, list) {
291         bdrv_add_aio_context_notifier(child->bs,
292                 notifier->attached_aio_context,
293                 notifier->detach_aio_context,
294                 notifier->opaque);
295     }
296 }
297 
298 static void blk_root_detach(BdrvChild *child)
299 {
300     BlockBackend *blk = child->opaque;
301     BlockBackendAioNotifier *notifier;
302 
303     trace_blk_root_detach(child, blk, child->bs);
304 
305     QLIST_FOREACH(notifier, &blk->aio_notifiers, list) {
306         bdrv_remove_aio_context_notifier(child->bs,
307                 notifier->attached_aio_context,
308                 notifier->detach_aio_context,
309                 notifier->opaque);
310     }
311 }
312 
313 static AioContext *blk_root_get_parent_aio_context(BdrvChild *c)
314 {
315     BlockBackend *blk = c->opaque;
316     IO_CODE();
317 
318     return blk_get_aio_context(blk);
319 }
320 
321 static const BdrvChildClass child_root = {
322     .inherit_options    = blk_root_inherit_options,
323 
324     .change_media       = blk_root_change_media,
325     .resize             = blk_root_resize,
326     .get_name           = blk_root_get_name,
327     .get_parent_desc    = blk_root_get_parent_desc,
328 
329     .drained_begin      = blk_root_drained_begin,
330     .drained_poll       = blk_root_drained_poll,
331     .drained_end        = blk_root_drained_end,
332 
333     .activate           = blk_root_activate,
334     .inactivate         = blk_root_inactivate,
335 
336     .attach             = blk_root_attach,
337     .detach             = blk_root_detach,
338 
339     .change_aio_ctx     = blk_root_change_aio_ctx,
340 
341     .get_parent_aio_context = blk_root_get_parent_aio_context,
342 };
343 
344 /*
345  * Create a new BlockBackend with a reference count of one.
346  *
347  * @perm is a bitmasks of BLK_PERM_* constants which describes the permissions
348  * to request for a block driver node that is attached to this BlockBackend.
349  * @shared_perm is a bitmask which describes which permissions may be granted
350  * to other users of the attached node.
351  * Both sets of permissions can be changed later using blk_set_perm().
352  *
353  * Return the new BlockBackend on success, null on failure.
354  */
355 BlockBackend *blk_new(AioContext *ctx, uint64_t perm, uint64_t shared_perm)
356 {
357     BlockBackend *blk;
358 
359     GLOBAL_STATE_CODE();
360 
361     blk = g_new0(BlockBackend, 1);
362     blk->refcnt = 1;
363     blk->ctx = ctx;
364     blk->perm = perm;
365     blk->shared_perm = shared_perm;
366     blk_set_enable_write_cache(blk, true);
367 
368     blk->on_read_error = BLOCKDEV_ON_ERROR_REPORT;
369     blk->on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
370 
371     block_acct_init(&blk->stats);
372 
373     qemu_mutex_init(&blk->queued_requests_lock);
374     qemu_co_queue_init(&blk->queued_requests);
375     notifier_list_init(&blk->remove_bs_notifiers);
376     notifier_list_init(&blk->insert_bs_notifiers);
377     QLIST_INIT(&blk->aio_notifiers);
378 
379     QTAILQ_INSERT_TAIL(&block_backends, blk, link);
380     return blk;
381 }
382 
383 /*
384  * Create a new BlockBackend connected to an existing BlockDriverState.
385  *
386  * @perm is a bitmasks of BLK_PERM_* constants which describes the
387  * permissions to request for @bs that is attached to this
388  * BlockBackend.  @shared_perm is a bitmask which describes which
389  * permissions may be granted to other users of the attached node.
390  * Both sets of permissions can be changed later using blk_set_perm().
391  *
392  * Return the new BlockBackend on success, null on failure.
393  *
394  * Callers must hold the AioContext lock of @bs.
395  */
396 BlockBackend *blk_new_with_bs(BlockDriverState *bs, uint64_t perm,
397                               uint64_t shared_perm, Error **errp)
398 {
399     BlockBackend *blk = blk_new(bdrv_get_aio_context(bs), perm, shared_perm);
400 
401     GLOBAL_STATE_CODE();
402 
403     if (blk_insert_bs(blk, bs, errp) < 0) {
404         blk_unref(blk);
405         return NULL;
406     }
407     return blk;
408 }
409 
410 /*
411  * Creates a new BlockBackend, opens a new BlockDriverState, and connects both.
412  * By default, the new BlockBackend is in the main AioContext, but if the
413  * parameters connect it with any existing node in a different AioContext, it
414  * may end up there instead.
415  *
416  * Just as with bdrv_open(), after having called this function the reference to
417  * @options belongs to the block layer (even on failure).
418  *
419  * Called without holding an AioContext lock.
420  *
421  * TODO: Remove @filename and @flags; it should be possible to specify a whole
422  * BDS tree just by specifying the @options QDict (or @reference,
423  * alternatively). At the time of adding this function, this is not possible,
424  * though, so callers of this function have to be able to specify @filename and
425  * @flags.
426  */
427 BlockBackend *blk_new_open(const char *filename, const char *reference,
428                            QDict *options, int flags, Error **errp)
429 {
430     BlockBackend *blk;
431     BlockDriverState *bs;
432     AioContext *ctx;
433     uint64_t perm = 0;
434     uint64_t shared = BLK_PERM_ALL;
435 
436     GLOBAL_STATE_CODE();
437 
438     /*
439      * blk_new_open() is mainly used in .bdrv_create implementations and the
440      * tools where sharing isn't a major concern because the BDS stays private
441      * and the file is generally not supposed to be used by a second process,
442      * so we just request permission according to the flags.
443      *
444      * The exceptions are xen_disk and blockdev_init(); in these cases, the
445      * caller of blk_new_open() doesn't make use of the permissions, but they
446      * shouldn't hurt either. We can still share everything here because the
447      * guest devices will add their own blockers if they can't share.
448      */
449     if ((flags & BDRV_O_NO_IO) == 0) {
450         perm |= BLK_PERM_CONSISTENT_READ;
451         if (flags & BDRV_O_RDWR) {
452             perm |= BLK_PERM_WRITE;
453         }
454     }
455     if (flags & BDRV_O_RESIZE) {
456         perm |= BLK_PERM_RESIZE;
457     }
458     if (flags & BDRV_O_NO_SHARE) {
459         shared = BLK_PERM_CONSISTENT_READ | BLK_PERM_WRITE_UNCHANGED;
460     }
461 
462     aio_context_acquire(qemu_get_aio_context());
463     bs = bdrv_open(filename, reference, options, flags, errp);
464     aio_context_release(qemu_get_aio_context());
465     if (!bs) {
466         return NULL;
467     }
468 
469     /* bdrv_open() could have moved bs to a different AioContext */
470     ctx = bdrv_get_aio_context(bs);
471     blk = blk_new(bdrv_get_aio_context(bs), perm, shared);
472     blk->perm = perm;
473     blk->shared_perm = shared;
474 
475     aio_context_acquire(ctx);
476     blk_insert_bs(blk, bs, errp);
477     bdrv_unref(bs);
478     aio_context_release(ctx);
479 
480     if (!blk->root) {
481         blk_unref(blk);
482         return NULL;
483     }
484 
485     return blk;
486 }
487 
488 static void blk_delete(BlockBackend *blk)
489 {
490     assert(!blk->refcnt);
491     assert(!blk->name);
492     assert(!blk->dev);
493     if (blk->public.throttle_group_member.throttle_state) {
494         blk_io_limits_disable(blk);
495     }
496     if (blk->root) {
497         blk_remove_bs(blk);
498     }
499     if (blk->vmsh) {
500         qemu_del_vm_change_state_handler(blk->vmsh);
501         blk->vmsh = NULL;
502     }
503     assert(QLIST_EMPTY(&blk->remove_bs_notifiers.notifiers));
504     assert(QLIST_EMPTY(&blk->insert_bs_notifiers.notifiers));
505     assert(QLIST_EMPTY(&blk->aio_notifiers));
506     assert(qemu_co_queue_empty(&blk->queued_requests));
507     qemu_mutex_destroy(&blk->queued_requests_lock);
508     QTAILQ_REMOVE(&block_backends, blk, link);
509     drive_info_del(blk->legacy_dinfo);
510     block_acct_cleanup(&blk->stats);
511     g_free(blk);
512 }
513 
514 static void drive_info_del(DriveInfo *dinfo)
515 {
516     if (!dinfo) {
517         return;
518     }
519     qemu_opts_del(dinfo->opts);
520     g_free(dinfo);
521 }
522 
523 int blk_get_refcnt(BlockBackend *blk)
524 {
525     GLOBAL_STATE_CODE();
526     return blk ? blk->refcnt : 0;
527 }
528 
529 /*
530  * Increment @blk's reference count.
531  * @blk must not be null.
532  */
533 void blk_ref(BlockBackend *blk)
534 {
535     assert(blk->refcnt > 0);
536     GLOBAL_STATE_CODE();
537     blk->refcnt++;
538 }
539 
540 /*
541  * Decrement @blk's reference count.
542  * If this drops it to zero, destroy @blk.
543  * For convenience, do nothing if @blk is null.
544  */
545 void blk_unref(BlockBackend *blk)
546 {
547     GLOBAL_STATE_CODE();
548     if (blk) {
549         assert(blk->refcnt > 0);
550         if (blk->refcnt > 1) {
551             blk->refcnt--;
552         } else {
553             blk_drain(blk);
554             /* blk_drain() cannot resurrect blk, nobody held a reference */
555             assert(blk->refcnt == 1);
556             blk->refcnt = 0;
557             blk_delete(blk);
558         }
559     }
560 }
561 
562 /*
563  * Behaves similarly to blk_next() but iterates over all BlockBackends, even the
564  * ones which are hidden (i.e. are not referenced by the monitor).
565  */
566 BlockBackend *blk_all_next(BlockBackend *blk)
567 {
568     GLOBAL_STATE_CODE();
569     return blk ? QTAILQ_NEXT(blk, link)
570                : QTAILQ_FIRST(&block_backends);
571 }
572 
573 void blk_remove_all_bs(void)
574 {
575     BlockBackend *blk = NULL;
576 
577     GLOBAL_STATE_CODE();
578 
579     while ((blk = blk_all_next(blk)) != NULL) {
580         AioContext *ctx = blk_get_aio_context(blk);
581 
582         aio_context_acquire(ctx);
583         if (blk->root) {
584             blk_remove_bs(blk);
585         }
586         aio_context_release(ctx);
587     }
588 }
589 
590 /*
591  * Return the monitor-owned BlockBackend after @blk.
592  * If @blk is null, return the first one.
593  * Else, return @blk's next sibling, which may be null.
594  *
595  * To iterate over all BlockBackends, do
596  * for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
597  *     ...
598  * }
599  */
600 BlockBackend *blk_next(BlockBackend *blk)
601 {
602     GLOBAL_STATE_CODE();
603     return blk ? QTAILQ_NEXT(blk, monitor_link)
604                : QTAILQ_FIRST(&monitor_block_backends);
605 }
606 
607 /* Iterates over all top-level BlockDriverStates, i.e. BDSs that are owned by
608  * the monitor or attached to a BlockBackend */
609 BlockDriverState *bdrv_next(BdrvNextIterator *it)
610 {
611     BlockDriverState *bs, *old_bs;
612 
613     /* Must be called from the main loop */
614     assert(qemu_get_current_aio_context() == qemu_get_aio_context());
615 
616     /* First, return all root nodes of BlockBackends. In order to avoid
617      * returning a BDS twice when multiple BBs refer to it, we only return it
618      * if the BB is the first one in the parent list of the BDS. */
619     if (it->phase == BDRV_NEXT_BACKEND_ROOTS) {
620         BlockBackend *old_blk = it->blk;
621 
622         old_bs = old_blk ? blk_bs(old_blk) : NULL;
623 
624         do {
625             it->blk = blk_all_next(it->blk);
626             bs = it->blk ? blk_bs(it->blk) : NULL;
627         } while (it->blk && (bs == NULL || bdrv_first_blk(bs) != it->blk));
628 
629         if (it->blk) {
630             blk_ref(it->blk);
631         }
632         blk_unref(old_blk);
633 
634         if (bs) {
635             bdrv_ref(bs);
636             bdrv_unref(old_bs);
637             return bs;
638         }
639         it->phase = BDRV_NEXT_MONITOR_OWNED;
640     } else {
641         old_bs = it->bs;
642     }
643 
644     /* Then return the monitor-owned BDSes without a BB attached. Ignore all
645      * BDSes that are attached to a BlockBackend here; they have been handled
646      * by the above block already */
647     do {
648         it->bs = bdrv_next_monitor_owned(it->bs);
649         bs = it->bs;
650     } while (bs && bdrv_has_blk(bs));
651 
652     if (bs) {
653         bdrv_ref(bs);
654     }
655     bdrv_unref(old_bs);
656 
657     return bs;
658 }
659 
660 static void bdrv_next_reset(BdrvNextIterator *it)
661 {
662     *it = (BdrvNextIterator) {
663         .phase = BDRV_NEXT_BACKEND_ROOTS,
664     };
665 }
666 
667 BlockDriverState *bdrv_first(BdrvNextIterator *it)
668 {
669     GLOBAL_STATE_CODE();
670     bdrv_next_reset(it);
671     return bdrv_next(it);
672 }
673 
674 /* Must be called when aborting a bdrv_next() iteration before
675  * bdrv_next() returns NULL */
676 void bdrv_next_cleanup(BdrvNextIterator *it)
677 {
678     /* Must be called from the main loop */
679     assert(qemu_get_current_aio_context() == qemu_get_aio_context());
680 
681     if (it->phase == BDRV_NEXT_BACKEND_ROOTS) {
682         if (it->blk) {
683             bdrv_unref(blk_bs(it->blk));
684             blk_unref(it->blk);
685         }
686     } else {
687         bdrv_unref(it->bs);
688     }
689 
690     bdrv_next_reset(it);
691 }
692 
693 /*
694  * Add a BlockBackend into the list of backends referenced by the monitor, with
695  * the given @name acting as the handle for the monitor.
696  * Strictly for use by blockdev.c.
697  *
698  * @name must not be null or empty.
699  *
700  * Returns true on success and false on failure. In the latter case, an Error
701  * object is returned through @errp.
702  */
703 bool monitor_add_blk(BlockBackend *blk, const char *name, Error **errp)
704 {
705     assert(!blk->name);
706     assert(name && name[0]);
707     GLOBAL_STATE_CODE();
708 
709     if (!id_wellformed(name)) {
710         error_setg(errp, "Invalid device name");
711         return false;
712     }
713     if (blk_by_name(name)) {
714         error_setg(errp, "Device with id '%s' already exists", name);
715         return false;
716     }
717     if (bdrv_find_node(name)) {
718         error_setg(errp,
719                    "Device name '%s' conflicts with an existing node name",
720                    name);
721         return false;
722     }
723 
724     blk->name = g_strdup(name);
725     QTAILQ_INSERT_TAIL(&monitor_block_backends, blk, monitor_link);
726     return true;
727 }
728 
729 /*
730  * Remove a BlockBackend from the list of backends referenced by the monitor.
731  * Strictly for use by blockdev.c.
732  */
733 void monitor_remove_blk(BlockBackend *blk)
734 {
735     GLOBAL_STATE_CODE();
736 
737     if (!blk->name) {
738         return;
739     }
740 
741     QTAILQ_REMOVE(&monitor_block_backends, blk, monitor_link);
742     g_free(blk->name);
743     blk->name = NULL;
744 }
745 
746 /*
747  * Return @blk's name, a non-null string.
748  * Returns an empty string iff @blk is not referenced by the monitor.
749  */
750 const char *blk_name(const BlockBackend *blk)
751 {
752     IO_CODE();
753     return blk->name ?: "";
754 }
755 
756 /*
757  * Return the BlockBackend with name @name if it exists, else null.
758  * @name must not be null.
759  */
760 BlockBackend *blk_by_name(const char *name)
761 {
762     BlockBackend *blk = NULL;
763 
764     GLOBAL_STATE_CODE();
765     assert(name);
766     while ((blk = blk_next(blk)) != NULL) {
767         if (!strcmp(name, blk->name)) {
768             return blk;
769         }
770     }
771     return NULL;
772 }
773 
774 /*
775  * Return the BlockDriverState attached to @blk if any, else null.
776  */
777 BlockDriverState *blk_bs(BlockBackend *blk)
778 {
779     IO_CODE();
780     return blk->root ? blk->root->bs : NULL;
781 }
782 
783 static BlockBackend * GRAPH_RDLOCK bdrv_first_blk(BlockDriverState *bs)
784 {
785     BdrvChild *child;
786 
787     GLOBAL_STATE_CODE();
788     assert_bdrv_graph_readable();
789 
790     QLIST_FOREACH(child, &bs->parents, next_parent) {
791         if (child->klass == &child_root) {
792             return child->opaque;
793         }
794     }
795 
796     return NULL;
797 }
798 
799 /*
800  * Returns true if @bs has an associated BlockBackend.
801  */
802 bool bdrv_has_blk(BlockDriverState *bs)
803 {
804     GLOBAL_STATE_CODE();
805     return bdrv_first_blk(bs) != NULL;
806 }
807 
808 /*
809  * Returns true if @bs has only BlockBackends as parents.
810  */
811 bool bdrv_is_root_node(BlockDriverState *bs)
812 {
813     BdrvChild *c;
814 
815     GLOBAL_STATE_CODE();
816     assert_bdrv_graph_readable();
817 
818     QLIST_FOREACH(c, &bs->parents, next_parent) {
819         if (c->klass != &child_root) {
820             return false;
821         }
822     }
823 
824     return true;
825 }
826 
827 /*
828  * Return @blk's DriveInfo if any, else null.
829  */
830 DriveInfo *blk_legacy_dinfo(BlockBackend *blk)
831 {
832     GLOBAL_STATE_CODE();
833     return blk->legacy_dinfo;
834 }
835 
836 /*
837  * Set @blk's DriveInfo to @dinfo, and return it.
838  * @blk must not have a DriveInfo set already.
839  * No other BlockBackend may have the same DriveInfo set.
840  */
841 DriveInfo *blk_set_legacy_dinfo(BlockBackend *blk, DriveInfo *dinfo)
842 {
843     assert(!blk->legacy_dinfo);
844     GLOBAL_STATE_CODE();
845     return blk->legacy_dinfo = dinfo;
846 }
847 
848 /*
849  * Return the BlockBackend with DriveInfo @dinfo.
850  * It must exist.
851  */
852 BlockBackend *blk_by_legacy_dinfo(DriveInfo *dinfo)
853 {
854     BlockBackend *blk = NULL;
855     GLOBAL_STATE_CODE();
856 
857     while ((blk = blk_next(blk)) != NULL) {
858         if (blk->legacy_dinfo == dinfo) {
859             return blk;
860         }
861     }
862     abort();
863 }
864 
865 /*
866  * Returns a pointer to the publicly accessible fields of @blk.
867  */
868 BlockBackendPublic *blk_get_public(BlockBackend *blk)
869 {
870     GLOBAL_STATE_CODE();
871     return &blk->public;
872 }
873 
874 /*
875  * Returns a BlockBackend given the associated @public fields.
876  */
877 BlockBackend *blk_by_public(BlockBackendPublic *public)
878 {
879     GLOBAL_STATE_CODE();
880     return container_of(public, BlockBackend, public);
881 }
882 
883 /*
884  * Disassociates the currently associated BlockDriverState from @blk.
885  */
886 void blk_remove_bs(BlockBackend *blk)
887 {
888     ThrottleGroupMember *tgm = &blk->public.throttle_group_member;
889     BdrvChild *root;
890 
891     GLOBAL_STATE_CODE();
892 
893     notifier_list_notify(&blk->remove_bs_notifiers, blk);
894     if (tgm->throttle_state) {
895         BlockDriverState *bs = blk_bs(blk);
896 
897         /*
898          * Take a ref in case blk_bs() changes across bdrv_drained_begin(), for
899          * example, if a temporary filter node is removed by a blockjob.
900          */
901         bdrv_ref(bs);
902         bdrv_drained_begin(bs);
903         throttle_group_detach_aio_context(tgm);
904         throttle_group_attach_aio_context(tgm, qemu_get_aio_context());
905         bdrv_drained_end(bs);
906         bdrv_unref(bs);
907     }
908 
909     blk_update_root_state(blk);
910 
911     /* bdrv_root_unref_child() will cause blk->root to become stale and may
912      * switch to a completion coroutine later on. Let's drain all I/O here
913      * to avoid that and a potential QEMU crash.
914      */
915     blk_drain(blk);
916     root = blk->root;
917     blk->root = NULL;
918 
919     bdrv_graph_wrlock(NULL);
920     bdrv_root_unref_child(root);
921     bdrv_graph_wrunlock();
922 }
923 
924 /*
925  * Associates a new BlockDriverState with @blk.
926  *
927  * Callers must hold the AioContext lock of @bs.
928  */
929 int blk_insert_bs(BlockBackend *blk, BlockDriverState *bs, Error **errp)
930 {
931     ThrottleGroupMember *tgm = &blk->public.throttle_group_member;
932     GLOBAL_STATE_CODE();
933     bdrv_ref(bs);
934     bdrv_graph_wrlock(bs);
935     blk->root = bdrv_root_attach_child(bs, "root", &child_root,
936                                        BDRV_CHILD_FILTERED | BDRV_CHILD_PRIMARY,
937                                        blk->perm, blk->shared_perm,
938                                        blk, errp);
939     bdrv_graph_wrunlock();
940     if (blk->root == NULL) {
941         return -EPERM;
942     }
943 
944     notifier_list_notify(&blk->insert_bs_notifiers, blk);
945     if (tgm->throttle_state) {
946         throttle_group_detach_aio_context(tgm);
947         throttle_group_attach_aio_context(tgm, bdrv_get_aio_context(bs));
948     }
949 
950     return 0;
951 }
952 
953 /*
954  * Change BlockDriverState associated with @blk.
955  */
956 int blk_replace_bs(BlockBackend *blk, BlockDriverState *new_bs, Error **errp)
957 {
958     GLOBAL_STATE_CODE();
959     return bdrv_replace_child_bs(blk->root, new_bs, errp);
960 }
961 
962 /*
963  * Sets the permission bitmasks that the user of the BlockBackend needs.
964  */
965 static int coroutine_mixed_fn GRAPH_RDLOCK
966 blk_set_perm_locked(BlockBackend *blk, uint64_t perm, uint64_t shared_perm,
967                     Error **errp)
968 {
969     int ret;
970     GLOBAL_STATE_CODE();
971 
972     if (blk->root && !blk->disable_perm) {
973         ret = bdrv_child_try_set_perm(blk->root, perm, shared_perm, errp);
974         if (ret < 0) {
975             return ret;
976         }
977     }
978 
979     blk->perm = perm;
980     blk->shared_perm = shared_perm;
981 
982     return 0;
983 }
984 
985 int blk_set_perm(BlockBackend *blk, uint64_t perm, uint64_t shared_perm,
986                  Error **errp)
987 {
988     GLOBAL_STATE_CODE();
989     GRAPH_RDLOCK_GUARD_MAINLOOP();
990 
991     return blk_set_perm_locked(blk, perm, shared_perm, errp);
992 }
993 
994 void blk_get_perm(BlockBackend *blk, uint64_t *perm, uint64_t *shared_perm)
995 {
996     GLOBAL_STATE_CODE();
997     *perm = blk->perm;
998     *shared_perm = blk->shared_perm;
999 }
1000 
1001 /*
1002  * Attach device model @dev to @blk.
1003  * Return 0 on success, -EBUSY when a device model is attached already.
1004  */
1005 int blk_attach_dev(BlockBackend *blk, DeviceState *dev)
1006 {
1007     GLOBAL_STATE_CODE();
1008     if (blk->dev) {
1009         return -EBUSY;
1010     }
1011 
1012     /* While migration is still incoming, we don't need to apply the
1013      * permissions of guest device BlockBackends. We might still have a block
1014      * job or NBD server writing to the image for storage migration. */
1015     if (runstate_check(RUN_STATE_INMIGRATE)) {
1016         blk->disable_perm = true;
1017     }
1018 
1019     blk_ref(blk);
1020     blk->dev = dev;
1021     blk_iostatus_reset(blk);
1022 
1023     return 0;
1024 }
1025 
1026 /*
1027  * Detach device model @dev from @blk.
1028  * @dev must be currently attached to @blk.
1029  */
1030 void blk_detach_dev(BlockBackend *blk, DeviceState *dev)
1031 {
1032     assert(blk->dev == dev);
1033     GLOBAL_STATE_CODE();
1034     blk->dev = NULL;
1035     blk->dev_ops = NULL;
1036     blk->dev_opaque = NULL;
1037     blk_set_perm(blk, 0, BLK_PERM_ALL, &error_abort);
1038     blk_unref(blk);
1039 }
1040 
1041 /*
1042  * Return the device model attached to @blk if any, else null.
1043  */
1044 DeviceState *blk_get_attached_dev(BlockBackend *blk)
1045 {
1046     GLOBAL_STATE_CODE();
1047     return blk->dev;
1048 }
1049 
1050 /* Return the qdev ID, or if no ID is assigned the QOM path, of the block
1051  * device attached to the BlockBackend. */
1052 char *blk_get_attached_dev_id(BlockBackend *blk)
1053 {
1054     DeviceState *dev = blk->dev;
1055     IO_CODE();
1056 
1057     if (!dev) {
1058         return g_strdup("");
1059     } else if (dev->id) {
1060         return g_strdup(dev->id);
1061     }
1062 
1063     return object_get_canonical_path(OBJECT(dev)) ?: g_strdup("");
1064 }
1065 
1066 /*
1067  * Return the BlockBackend which has the device model @dev attached if it
1068  * exists, else null.
1069  *
1070  * @dev must not be null.
1071  */
1072 BlockBackend *blk_by_dev(void *dev)
1073 {
1074     BlockBackend *blk = NULL;
1075 
1076     GLOBAL_STATE_CODE();
1077 
1078     assert(dev != NULL);
1079     while ((blk = blk_all_next(blk)) != NULL) {
1080         if (blk->dev == dev) {
1081             return blk;
1082         }
1083     }
1084     return NULL;
1085 }
1086 
1087 /*
1088  * Set @blk's device model callbacks to @ops.
1089  * @opaque is the opaque argument to pass to the callbacks.
1090  * This is for use by device models.
1091  */
1092 void blk_set_dev_ops(BlockBackend *blk, const BlockDevOps *ops,
1093                      void *opaque)
1094 {
1095     GLOBAL_STATE_CODE();
1096     blk->dev_ops = ops;
1097     blk->dev_opaque = opaque;
1098 
1099     /* Are we currently quiesced? Should we enforce this right now? */
1100     if (qatomic_read(&blk->quiesce_counter) && ops && ops->drained_begin) {
1101         ops->drained_begin(opaque);
1102     }
1103 }
1104 
1105 /*
1106  * Notify @blk's attached device model of media change.
1107  *
1108  * If @load is true, notify of media load. This action can fail, meaning that
1109  * the medium cannot be loaded. @errp is set then.
1110  *
1111  * If @load is false, notify of media eject. This can never fail.
1112  *
1113  * Also send DEVICE_TRAY_MOVED events as appropriate.
1114  */
1115 void blk_dev_change_media_cb(BlockBackend *blk, bool load, Error **errp)
1116 {
1117     GLOBAL_STATE_CODE();
1118     if (blk->dev_ops && blk->dev_ops->change_media_cb) {
1119         bool tray_was_open, tray_is_open;
1120         Error *local_err = NULL;
1121 
1122         tray_was_open = blk_dev_is_tray_open(blk);
1123         blk->dev_ops->change_media_cb(blk->dev_opaque, load, &local_err);
1124         if (local_err) {
1125             assert(load == true);
1126             error_propagate(errp, local_err);
1127             return;
1128         }
1129         tray_is_open = blk_dev_is_tray_open(blk);
1130 
1131         if (tray_was_open != tray_is_open) {
1132             char *id = blk_get_attached_dev_id(blk);
1133             qapi_event_send_device_tray_moved(blk_name(blk), id, tray_is_open);
1134             g_free(id);
1135         }
1136     }
1137 }
1138 
1139 static void blk_root_change_media(BdrvChild *child, bool load)
1140 {
1141     blk_dev_change_media_cb(child->opaque, load, NULL);
1142 }
1143 
1144 /*
1145  * Does @blk's attached device model have removable media?
1146  * %true if no device model is attached.
1147  */
1148 bool blk_dev_has_removable_media(BlockBackend *blk)
1149 {
1150     GLOBAL_STATE_CODE();
1151     return !blk->dev || (blk->dev_ops && blk->dev_ops->change_media_cb);
1152 }
1153 
1154 /*
1155  * Does @blk's attached device model have a tray?
1156  */
1157 bool blk_dev_has_tray(BlockBackend *blk)
1158 {
1159     IO_CODE();
1160     return blk->dev_ops && blk->dev_ops->is_tray_open;
1161 }
1162 
1163 /*
1164  * Notify @blk's attached device model of a media eject request.
1165  * If @force is true, the medium is about to be yanked out forcefully.
1166  */
1167 void blk_dev_eject_request(BlockBackend *blk, bool force)
1168 {
1169     GLOBAL_STATE_CODE();
1170     if (blk->dev_ops && blk->dev_ops->eject_request_cb) {
1171         blk->dev_ops->eject_request_cb(blk->dev_opaque, force);
1172     }
1173 }
1174 
1175 /*
1176  * Does @blk's attached device model have a tray, and is it open?
1177  */
1178 bool blk_dev_is_tray_open(BlockBackend *blk)
1179 {
1180     IO_CODE();
1181     if (blk_dev_has_tray(blk)) {
1182         return blk->dev_ops->is_tray_open(blk->dev_opaque);
1183     }
1184     return false;
1185 }
1186 
1187 /*
1188  * Does @blk's attached device model have the medium locked?
1189  * %false if the device model has no such lock.
1190  */
1191 bool blk_dev_is_medium_locked(BlockBackend *blk)
1192 {
1193     GLOBAL_STATE_CODE();
1194     if (blk->dev_ops && blk->dev_ops->is_medium_locked) {
1195         return blk->dev_ops->is_medium_locked(blk->dev_opaque);
1196     }
1197     return false;
1198 }
1199 
1200 /*
1201  * Notify @blk's attached device model of a backend size change.
1202  */
1203 static void blk_root_resize(BdrvChild *child)
1204 {
1205     BlockBackend *blk = child->opaque;
1206 
1207     if (blk->dev_ops && blk->dev_ops->resize_cb) {
1208         blk->dev_ops->resize_cb(blk->dev_opaque);
1209     }
1210 }
1211 
1212 void blk_iostatus_enable(BlockBackend *blk)
1213 {
1214     GLOBAL_STATE_CODE();
1215     blk->iostatus_enabled = true;
1216     blk->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
1217 }
1218 
1219 /* The I/O status is only enabled if the drive explicitly
1220  * enables it _and_ the VM is configured to stop on errors */
1221 bool blk_iostatus_is_enabled(const BlockBackend *blk)
1222 {
1223     IO_CODE();
1224     return (blk->iostatus_enabled &&
1225            (blk->on_write_error == BLOCKDEV_ON_ERROR_ENOSPC ||
1226             blk->on_write_error == BLOCKDEV_ON_ERROR_STOP   ||
1227             blk->on_read_error == BLOCKDEV_ON_ERROR_STOP));
1228 }
1229 
1230 BlockDeviceIoStatus blk_iostatus(const BlockBackend *blk)
1231 {
1232     GLOBAL_STATE_CODE();
1233     return blk->iostatus;
1234 }
1235 
1236 void blk_iostatus_disable(BlockBackend *blk)
1237 {
1238     GLOBAL_STATE_CODE();
1239     blk->iostatus_enabled = false;
1240 }
1241 
1242 void blk_iostatus_reset(BlockBackend *blk)
1243 {
1244     GLOBAL_STATE_CODE();
1245     if (blk_iostatus_is_enabled(blk)) {
1246         blk->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
1247     }
1248 }
1249 
1250 void blk_iostatus_set_err(BlockBackend *blk, int error)
1251 {
1252     IO_CODE();
1253     assert(blk_iostatus_is_enabled(blk));
1254     if (blk->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
1255         blk->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
1256                                           BLOCK_DEVICE_IO_STATUS_FAILED;
1257     }
1258 }
1259 
1260 void blk_set_allow_write_beyond_eof(BlockBackend *blk, bool allow)
1261 {
1262     IO_CODE();
1263     blk->allow_write_beyond_eof = allow;
1264 }
1265 
1266 void blk_set_allow_aio_context_change(BlockBackend *blk, bool allow)
1267 {
1268     IO_CODE();
1269     blk->allow_aio_context_change = allow;
1270 }
1271 
1272 void blk_set_disable_request_queuing(BlockBackend *blk, bool disable)
1273 {
1274     IO_CODE();
1275     qatomic_set(&blk->disable_request_queuing, disable);
1276 }
1277 
1278 static int coroutine_fn GRAPH_RDLOCK
1279 blk_check_byte_request(BlockBackend *blk, int64_t offset, int64_t bytes)
1280 {
1281     int64_t len;
1282 
1283     if (bytes < 0) {
1284         return -EIO;
1285     }
1286 
1287     if (!blk_co_is_available(blk)) {
1288         return -ENOMEDIUM;
1289     }
1290 
1291     if (offset < 0) {
1292         return -EIO;
1293     }
1294 
1295     if (!blk->allow_write_beyond_eof) {
1296         len = bdrv_co_getlength(blk_bs(blk));
1297         if (len < 0) {
1298             return len;
1299         }
1300 
1301         if (offset > len || len - offset < bytes) {
1302             return -EIO;
1303         }
1304     }
1305 
1306     return 0;
1307 }
1308 
1309 /* Are we currently in a drained section? */
1310 bool blk_in_drain(BlockBackend *blk)
1311 {
1312     GLOBAL_STATE_CODE(); /* change to IO_OR_GS_CODE(), if necessary */
1313     return qatomic_read(&blk->quiesce_counter);
1314 }
1315 
1316 /* To be called between exactly one pair of blk_inc/dec_in_flight() */
1317 static void coroutine_fn blk_wait_while_drained(BlockBackend *blk)
1318 {
1319     assert(blk->in_flight > 0);
1320 
1321     if (qatomic_read(&blk->quiesce_counter) &&
1322         !qatomic_read(&blk->disable_request_queuing)) {
1323         /*
1324          * Take lock before decrementing in flight counter so main loop thread
1325          * waits for us to enqueue ourselves before it can leave the drained
1326          * section.
1327          */
1328         qemu_mutex_lock(&blk->queued_requests_lock);
1329         blk_dec_in_flight(blk);
1330         qemu_co_queue_wait(&blk->queued_requests, &blk->queued_requests_lock);
1331         blk_inc_in_flight(blk);
1332         qemu_mutex_unlock(&blk->queued_requests_lock);
1333     }
1334 }
1335 
1336 /* To be called between exactly one pair of blk_inc/dec_in_flight() */
1337 static int coroutine_fn
1338 blk_co_do_preadv_part(BlockBackend *blk, int64_t offset, int64_t bytes,
1339                       QEMUIOVector *qiov, size_t qiov_offset,
1340                       BdrvRequestFlags flags)
1341 {
1342     int ret;
1343     BlockDriverState *bs;
1344     IO_CODE();
1345 
1346     blk_wait_while_drained(blk);
1347     GRAPH_RDLOCK_GUARD();
1348 
1349     /* Call blk_bs() only after waiting, the graph may have changed */
1350     bs = blk_bs(blk);
1351     trace_blk_co_preadv(blk, bs, offset, bytes, flags);
1352 
1353     ret = blk_check_byte_request(blk, offset, bytes);
1354     if (ret < 0) {
1355         return ret;
1356     }
1357 
1358     bdrv_inc_in_flight(bs);
1359 
1360     /* throttling disk I/O */
1361     if (blk->public.throttle_group_member.throttle_state) {
1362         throttle_group_co_io_limits_intercept(&blk->public.throttle_group_member,
1363                 bytes, THROTTLE_READ);
1364     }
1365 
1366     ret = bdrv_co_preadv_part(blk->root, offset, bytes, qiov, qiov_offset,
1367                               flags);
1368     bdrv_dec_in_flight(bs);
1369     return ret;
1370 }
1371 
1372 int coroutine_fn blk_co_pread(BlockBackend *blk, int64_t offset, int64_t bytes,
1373                               void *buf, BdrvRequestFlags flags)
1374 {
1375     QEMUIOVector qiov = QEMU_IOVEC_INIT_BUF(qiov, buf, bytes);
1376     IO_OR_GS_CODE();
1377 
1378     assert(bytes <= SIZE_MAX);
1379 
1380     return blk_co_preadv(blk, offset, bytes, &qiov, flags);
1381 }
1382 
1383 int coroutine_fn blk_co_preadv(BlockBackend *blk, int64_t offset,
1384                                int64_t bytes, QEMUIOVector *qiov,
1385                                BdrvRequestFlags flags)
1386 {
1387     int ret;
1388     IO_OR_GS_CODE();
1389 
1390     blk_inc_in_flight(blk);
1391     ret = blk_co_do_preadv_part(blk, offset, bytes, qiov, 0, flags);
1392     blk_dec_in_flight(blk);
1393 
1394     return ret;
1395 }
1396 
1397 int coroutine_fn blk_co_preadv_part(BlockBackend *blk, int64_t offset,
1398                                     int64_t bytes, QEMUIOVector *qiov,
1399                                     size_t qiov_offset, BdrvRequestFlags flags)
1400 {
1401     int ret;
1402     IO_OR_GS_CODE();
1403 
1404     blk_inc_in_flight(blk);
1405     ret = blk_co_do_preadv_part(blk, offset, bytes, qiov, qiov_offset, flags);
1406     blk_dec_in_flight(blk);
1407 
1408     return ret;
1409 }
1410 
1411 /* To be called between exactly one pair of blk_inc/dec_in_flight() */
1412 static int coroutine_fn
1413 blk_co_do_pwritev_part(BlockBackend *blk, int64_t offset, int64_t bytes,
1414                        QEMUIOVector *qiov, size_t qiov_offset,
1415                        BdrvRequestFlags flags)
1416 {
1417     int ret;
1418     BlockDriverState *bs;
1419     IO_CODE();
1420 
1421     blk_wait_while_drained(blk);
1422     GRAPH_RDLOCK_GUARD();
1423 
1424     /* Call blk_bs() only after waiting, the graph may have changed */
1425     bs = blk_bs(blk);
1426     trace_blk_co_pwritev(blk, bs, offset, bytes, flags);
1427 
1428     ret = blk_check_byte_request(blk, offset, bytes);
1429     if (ret < 0) {
1430         return ret;
1431     }
1432 
1433     bdrv_inc_in_flight(bs);
1434     /* throttling disk I/O */
1435     if (blk->public.throttle_group_member.throttle_state) {
1436         throttle_group_co_io_limits_intercept(&blk->public.throttle_group_member,
1437                 bytes, THROTTLE_WRITE);
1438     }
1439 
1440     if (!blk->enable_write_cache) {
1441         flags |= BDRV_REQ_FUA;
1442     }
1443 
1444     ret = bdrv_co_pwritev_part(blk->root, offset, bytes, qiov, qiov_offset,
1445                                flags);
1446     bdrv_dec_in_flight(bs);
1447     return ret;
1448 }
1449 
1450 int coroutine_fn blk_co_pwritev_part(BlockBackend *blk, int64_t offset,
1451                                      int64_t bytes,
1452                                      QEMUIOVector *qiov, size_t qiov_offset,
1453                                      BdrvRequestFlags flags)
1454 {
1455     int ret;
1456     IO_OR_GS_CODE();
1457 
1458     blk_inc_in_flight(blk);
1459     ret = blk_co_do_pwritev_part(blk, offset, bytes, qiov, qiov_offset, flags);
1460     blk_dec_in_flight(blk);
1461 
1462     return ret;
1463 }
1464 
1465 int coroutine_fn blk_co_pwrite(BlockBackend *blk, int64_t offset, int64_t bytes,
1466                                const void *buf, BdrvRequestFlags flags)
1467 {
1468     QEMUIOVector qiov = QEMU_IOVEC_INIT_BUF(qiov, buf, bytes);
1469     IO_OR_GS_CODE();
1470 
1471     assert(bytes <= SIZE_MAX);
1472 
1473     return blk_co_pwritev(blk, offset, bytes, &qiov, flags);
1474 }
1475 
1476 int coroutine_fn blk_co_pwritev(BlockBackend *blk, int64_t offset,
1477                                 int64_t bytes, QEMUIOVector *qiov,
1478                                 BdrvRequestFlags flags)
1479 {
1480     IO_OR_GS_CODE();
1481     return blk_co_pwritev_part(blk, offset, bytes, qiov, 0, flags);
1482 }
1483 
1484 int coroutine_fn blk_co_block_status_above(BlockBackend *blk,
1485                                            BlockDriverState *base,
1486                                            int64_t offset, int64_t bytes,
1487                                            int64_t *pnum, int64_t *map,
1488                                            BlockDriverState **file)
1489 {
1490     IO_CODE();
1491     GRAPH_RDLOCK_GUARD();
1492     return bdrv_co_block_status_above(blk_bs(blk), base, offset, bytes, pnum,
1493                                       map, file);
1494 }
1495 
1496 int coroutine_fn blk_co_is_allocated_above(BlockBackend *blk,
1497                                            BlockDriverState *base,
1498                                            bool include_base, int64_t offset,
1499                                            int64_t bytes, int64_t *pnum)
1500 {
1501     IO_CODE();
1502     GRAPH_RDLOCK_GUARD();
1503     return bdrv_co_is_allocated_above(blk_bs(blk), base, include_base, offset,
1504                                       bytes, pnum);
1505 }
1506 
1507 typedef struct BlkRwCo {
1508     BlockBackend *blk;
1509     int64_t offset;
1510     void *iobuf;
1511     int ret;
1512     BdrvRequestFlags flags;
1513 } BlkRwCo;
1514 
1515 int blk_make_zero(BlockBackend *blk, BdrvRequestFlags flags)
1516 {
1517     GLOBAL_STATE_CODE();
1518     return bdrv_make_zero(blk->root, flags);
1519 }
1520 
1521 void blk_inc_in_flight(BlockBackend *blk)
1522 {
1523     IO_CODE();
1524     qatomic_inc(&blk->in_flight);
1525 }
1526 
1527 void blk_dec_in_flight(BlockBackend *blk)
1528 {
1529     IO_CODE();
1530     qatomic_dec(&blk->in_flight);
1531     aio_wait_kick();
1532 }
1533 
1534 static void error_callback_bh(void *opaque)
1535 {
1536     struct BlockBackendAIOCB *acb = opaque;
1537 
1538     blk_dec_in_flight(acb->blk);
1539     acb->common.cb(acb->common.opaque, acb->ret);
1540     qemu_aio_unref(acb);
1541 }
1542 
1543 BlockAIOCB *blk_abort_aio_request(BlockBackend *blk,
1544                                   BlockCompletionFunc *cb,
1545                                   void *opaque, int ret)
1546 {
1547     struct BlockBackendAIOCB *acb;
1548     IO_CODE();
1549 
1550     blk_inc_in_flight(blk);
1551     acb = blk_aio_get(&block_backend_aiocb_info, blk, cb, opaque);
1552     acb->blk = blk;
1553     acb->ret = ret;
1554 
1555     replay_bh_schedule_oneshot_event(qemu_get_current_aio_context(),
1556                                      error_callback_bh, acb);
1557     return &acb->common;
1558 }
1559 
1560 typedef struct BlkAioEmAIOCB {
1561     BlockAIOCB common;
1562     BlkRwCo rwco;
1563     int64_t bytes;
1564     bool has_returned;
1565 } BlkAioEmAIOCB;
1566 
1567 static const AIOCBInfo blk_aio_em_aiocb_info = {
1568     .aiocb_size         = sizeof(BlkAioEmAIOCB),
1569 };
1570 
1571 static void blk_aio_complete(BlkAioEmAIOCB *acb)
1572 {
1573     if (acb->has_returned) {
1574         acb->common.cb(acb->common.opaque, acb->rwco.ret);
1575         blk_dec_in_flight(acb->rwco.blk);
1576         qemu_aio_unref(acb);
1577     }
1578 }
1579 
1580 static void blk_aio_complete_bh(void *opaque)
1581 {
1582     BlkAioEmAIOCB *acb = opaque;
1583     assert(acb->has_returned);
1584     blk_aio_complete(acb);
1585 }
1586 
1587 static BlockAIOCB *blk_aio_prwv(BlockBackend *blk, int64_t offset,
1588                                 int64_t bytes,
1589                                 void *iobuf, CoroutineEntry co_entry,
1590                                 BdrvRequestFlags flags,
1591                                 BlockCompletionFunc *cb, void *opaque)
1592 {
1593     BlkAioEmAIOCB *acb;
1594     Coroutine *co;
1595 
1596     blk_inc_in_flight(blk);
1597     acb = blk_aio_get(&blk_aio_em_aiocb_info, blk, cb, opaque);
1598     acb->rwco = (BlkRwCo) {
1599         .blk    = blk,
1600         .offset = offset,
1601         .iobuf  = iobuf,
1602         .flags  = flags,
1603         .ret    = NOT_DONE,
1604     };
1605     acb->bytes = bytes;
1606     acb->has_returned = false;
1607 
1608     co = qemu_coroutine_create(co_entry, acb);
1609     aio_co_enter(qemu_get_current_aio_context(), co);
1610 
1611     acb->has_returned = true;
1612     if (acb->rwco.ret != NOT_DONE) {
1613         replay_bh_schedule_oneshot_event(qemu_get_current_aio_context(),
1614                                          blk_aio_complete_bh, acb);
1615     }
1616 
1617     return &acb->common;
1618 }
1619 
1620 static void coroutine_fn blk_aio_read_entry(void *opaque)
1621 {
1622     BlkAioEmAIOCB *acb = opaque;
1623     BlkRwCo *rwco = &acb->rwco;
1624     QEMUIOVector *qiov = rwco->iobuf;
1625 
1626     assert(qiov->size == acb->bytes);
1627     rwco->ret = blk_co_do_preadv_part(rwco->blk, rwco->offset, acb->bytes, qiov,
1628                                       0, rwco->flags);
1629     blk_aio_complete(acb);
1630 }
1631 
1632 static void coroutine_fn blk_aio_write_entry(void *opaque)
1633 {
1634     BlkAioEmAIOCB *acb = opaque;
1635     BlkRwCo *rwco = &acb->rwco;
1636     QEMUIOVector *qiov = rwco->iobuf;
1637 
1638     assert(!qiov || qiov->size == acb->bytes);
1639     rwco->ret = blk_co_do_pwritev_part(rwco->blk, rwco->offset, acb->bytes,
1640                                        qiov, 0, rwco->flags);
1641     blk_aio_complete(acb);
1642 }
1643 
1644 BlockAIOCB *blk_aio_pwrite_zeroes(BlockBackend *blk, int64_t offset,
1645                                   int64_t bytes, BdrvRequestFlags flags,
1646                                   BlockCompletionFunc *cb, void *opaque)
1647 {
1648     IO_CODE();
1649     return blk_aio_prwv(blk, offset, bytes, NULL, blk_aio_write_entry,
1650                         flags | BDRV_REQ_ZERO_WRITE, cb, opaque);
1651 }
1652 
1653 int64_t coroutine_fn blk_co_getlength(BlockBackend *blk)
1654 {
1655     IO_CODE();
1656     GRAPH_RDLOCK_GUARD();
1657 
1658     if (!blk_co_is_available(blk)) {
1659         return -ENOMEDIUM;
1660     }
1661 
1662     return bdrv_co_getlength(blk_bs(blk));
1663 }
1664 
1665 int64_t coroutine_fn blk_co_nb_sectors(BlockBackend *blk)
1666 {
1667     BlockDriverState *bs = blk_bs(blk);
1668 
1669     IO_CODE();
1670     GRAPH_RDLOCK_GUARD();
1671 
1672     if (!bs) {
1673         return -ENOMEDIUM;
1674     } else {
1675         return bdrv_co_nb_sectors(bs);
1676     }
1677 }
1678 
1679 /*
1680  * This wrapper is written by hand because this function is in the hot I/O path,
1681  * via blk_get_geometry.
1682  */
1683 int64_t coroutine_mixed_fn blk_nb_sectors(BlockBackend *blk)
1684 {
1685     BlockDriverState *bs = blk_bs(blk);
1686 
1687     IO_CODE();
1688 
1689     if (!bs) {
1690         return -ENOMEDIUM;
1691     } else {
1692         return bdrv_nb_sectors(bs);
1693     }
1694 }
1695 
1696 /* return 0 as number of sectors if no device present or error */
1697 void coroutine_fn blk_co_get_geometry(BlockBackend *blk,
1698                                       uint64_t *nb_sectors_ptr)
1699 {
1700     int64_t ret = blk_co_nb_sectors(blk);
1701     *nb_sectors_ptr = ret < 0 ? 0 : ret;
1702 }
1703 
1704 /*
1705  * This wrapper is written by hand because this function is in the hot I/O path.
1706  */
1707 void coroutine_mixed_fn blk_get_geometry(BlockBackend *blk,
1708                                          uint64_t *nb_sectors_ptr)
1709 {
1710     int64_t ret = blk_nb_sectors(blk);
1711     *nb_sectors_ptr = ret < 0 ? 0 : ret;
1712 }
1713 
1714 BlockAIOCB *blk_aio_preadv(BlockBackend *blk, int64_t offset,
1715                            QEMUIOVector *qiov, BdrvRequestFlags flags,
1716                            BlockCompletionFunc *cb, void *opaque)
1717 {
1718     IO_CODE();
1719     assert((uint64_t)qiov->size <= INT64_MAX);
1720     return blk_aio_prwv(blk, offset, qiov->size, qiov,
1721                         blk_aio_read_entry, flags, cb, opaque);
1722 }
1723 
1724 BlockAIOCB *blk_aio_pwritev(BlockBackend *blk, int64_t offset,
1725                             QEMUIOVector *qiov, BdrvRequestFlags flags,
1726                             BlockCompletionFunc *cb, void *opaque)
1727 {
1728     IO_CODE();
1729     assert((uint64_t)qiov->size <= INT64_MAX);
1730     return blk_aio_prwv(blk, offset, qiov->size, qiov,
1731                         blk_aio_write_entry, flags, cb, opaque);
1732 }
1733 
1734 void blk_aio_cancel(BlockAIOCB *acb)
1735 {
1736     GLOBAL_STATE_CODE();
1737     bdrv_aio_cancel(acb);
1738 }
1739 
1740 void blk_aio_cancel_async(BlockAIOCB *acb)
1741 {
1742     IO_CODE();
1743     bdrv_aio_cancel_async(acb);
1744 }
1745 
1746 /* To be called between exactly one pair of blk_inc/dec_in_flight() */
1747 static int coroutine_fn
1748 blk_co_do_ioctl(BlockBackend *blk, unsigned long int req, void *buf)
1749 {
1750     IO_CODE();
1751 
1752     blk_wait_while_drained(blk);
1753     GRAPH_RDLOCK_GUARD();
1754 
1755     if (!blk_co_is_available(blk)) {
1756         return -ENOMEDIUM;
1757     }
1758 
1759     return bdrv_co_ioctl(blk_bs(blk), req, buf);
1760 }
1761 
1762 int coroutine_fn blk_co_ioctl(BlockBackend *blk, unsigned long int req,
1763                               void *buf)
1764 {
1765     int ret;
1766     IO_OR_GS_CODE();
1767 
1768     blk_inc_in_flight(blk);
1769     ret = blk_co_do_ioctl(blk, req, buf);
1770     blk_dec_in_flight(blk);
1771 
1772     return ret;
1773 }
1774 
1775 static void coroutine_fn blk_aio_ioctl_entry(void *opaque)
1776 {
1777     BlkAioEmAIOCB *acb = opaque;
1778     BlkRwCo *rwco = &acb->rwco;
1779 
1780     rwco->ret = blk_co_do_ioctl(rwco->blk, rwco->offset, rwco->iobuf);
1781 
1782     blk_aio_complete(acb);
1783 }
1784 
1785 BlockAIOCB *blk_aio_ioctl(BlockBackend *blk, unsigned long int req, void *buf,
1786                           BlockCompletionFunc *cb, void *opaque)
1787 {
1788     IO_CODE();
1789     return blk_aio_prwv(blk, req, 0, buf, blk_aio_ioctl_entry, 0, cb, opaque);
1790 }
1791 
1792 /* To be called between exactly one pair of blk_inc/dec_in_flight() */
1793 static int coroutine_fn
1794 blk_co_do_pdiscard(BlockBackend *blk, int64_t offset, int64_t bytes)
1795 {
1796     int ret;
1797     IO_CODE();
1798 
1799     blk_wait_while_drained(blk);
1800     GRAPH_RDLOCK_GUARD();
1801 
1802     ret = blk_check_byte_request(blk, offset, bytes);
1803     if (ret < 0) {
1804         return ret;
1805     }
1806 
1807     return bdrv_co_pdiscard(blk->root, offset, bytes);
1808 }
1809 
1810 static void coroutine_fn blk_aio_pdiscard_entry(void *opaque)
1811 {
1812     BlkAioEmAIOCB *acb = opaque;
1813     BlkRwCo *rwco = &acb->rwco;
1814 
1815     rwco->ret = blk_co_do_pdiscard(rwco->blk, rwco->offset, acb->bytes);
1816     blk_aio_complete(acb);
1817 }
1818 
1819 BlockAIOCB *blk_aio_pdiscard(BlockBackend *blk,
1820                              int64_t offset, int64_t bytes,
1821                              BlockCompletionFunc *cb, void *opaque)
1822 {
1823     IO_CODE();
1824     return blk_aio_prwv(blk, offset, bytes, NULL, blk_aio_pdiscard_entry, 0,
1825                         cb, opaque);
1826 }
1827 
1828 int coroutine_fn blk_co_pdiscard(BlockBackend *blk, int64_t offset,
1829                                  int64_t bytes)
1830 {
1831     int ret;
1832     IO_OR_GS_CODE();
1833 
1834     blk_inc_in_flight(blk);
1835     ret = blk_co_do_pdiscard(blk, offset, bytes);
1836     blk_dec_in_flight(blk);
1837 
1838     return ret;
1839 }
1840 
1841 /* To be called between exactly one pair of blk_inc/dec_in_flight() */
1842 static int coroutine_fn blk_co_do_flush(BlockBackend *blk)
1843 {
1844     IO_CODE();
1845     blk_wait_while_drained(blk);
1846     GRAPH_RDLOCK_GUARD();
1847 
1848     if (!blk_co_is_available(blk)) {
1849         return -ENOMEDIUM;
1850     }
1851 
1852     return bdrv_co_flush(blk_bs(blk));
1853 }
1854 
1855 static void coroutine_fn blk_aio_flush_entry(void *opaque)
1856 {
1857     BlkAioEmAIOCB *acb = opaque;
1858     BlkRwCo *rwco = &acb->rwco;
1859 
1860     rwco->ret = blk_co_do_flush(rwco->blk);
1861     blk_aio_complete(acb);
1862 }
1863 
1864 BlockAIOCB *blk_aio_flush(BlockBackend *blk,
1865                           BlockCompletionFunc *cb, void *opaque)
1866 {
1867     IO_CODE();
1868     return blk_aio_prwv(blk, 0, 0, NULL, blk_aio_flush_entry, 0, cb, opaque);
1869 }
1870 
1871 int coroutine_fn blk_co_flush(BlockBackend *blk)
1872 {
1873     int ret;
1874     IO_OR_GS_CODE();
1875 
1876     blk_inc_in_flight(blk);
1877     ret = blk_co_do_flush(blk);
1878     blk_dec_in_flight(blk);
1879 
1880     return ret;
1881 }
1882 
1883 static void coroutine_fn blk_aio_zone_report_entry(void *opaque)
1884 {
1885     BlkAioEmAIOCB *acb = opaque;
1886     BlkRwCo *rwco = &acb->rwco;
1887 
1888     rwco->ret = blk_co_zone_report(rwco->blk, rwco->offset,
1889                                    (unsigned int*)(uintptr_t)acb->bytes,
1890                                    rwco->iobuf);
1891     blk_aio_complete(acb);
1892 }
1893 
1894 BlockAIOCB *blk_aio_zone_report(BlockBackend *blk, int64_t offset,
1895                                 unsigned int *nr_zones,
1896                                 BlockZoneDescriptor  *zones,
1897                                 BlockCompletionFunc *cb, void *opaque)
1898 {
1899     BlkAioEmAIOCB *acb;
1900     Coroutine *co;
1901     IO_CODE();
1902 
1903     blk_inc_in_flight(blk);
1904     acb = blk_aio_get(&blk_aio_em_aiocb_info, blk, cb, opaque);
1905     acb->rwco = (BlkRwCo) {
1906         .blk    = blk,
1907         .offset = offset,
1908         .iobuf  = zones,
1909         .ret    = NOT_DONE,
1910     };
1911     acb->bytes = (int64_t)(uintptr_t)nr_zones,
1912     acb->has_returned = false;
1913 
1914     co = qemu_coroutine_create(blk_aio_zone_report_entry, acb);
1915     aio_co_enter(qemu_get_current_aio_context(), co);
1916 
1917     acb->has_returned = true;
1918     if (acb->rwco.ret != NOT_DONE) {
1919         replay_bh_schedule_oneshot_event(qemu_get_current_aio_context(),
1920                                          blk_aio_complete_bh, acb);
1921     }
1922 
1923     return &acb->common;
1924 }
1925 
1926 static void coroutine_fn blk_aio_zone_mgmt_entry(void *opaque)
1927 {
1928     BlkAioEmAIOCB *acb = opaque;
1929     BlkRwCo *rwco = &acb->rwco;
1930 
1931     rwco->ret = blk_co_zone_mgmt(rwco->blk,
1932                                  (BlockZoneOp)(uintptr_t)rwco->iobuf,
1933                                  rwco->offset, acb->bytes);
1934     blk_aio_complete(acb);
1935 }
1936 
1937 BlockAIOCB *blk_aio_zone_mgmt(BlockBackend *blk, BlockZoneOp op,
1938                               int64_t offset, int64_t len,
1939                               BlockCompletionFunc *cb, void *opaque) {
1940     BlkAioEmAIOCB *acb;
1941     Coroutine *co;
1942     IO_CODE();
1943 
1944     blk_inc_in_flight(blk);
1945     acb = blk_aio_get(&blk_aio_em_aiocb_info, blk, cb, opaque);
1946     acb->rwco = (BlkRwCo) {
1947         .blk    = blk,
1948         .offset = offset,
1949         .iobuf  = (void *)(uintptr_t)op,
1950         .ret    = NOT_DONE,
1951     };
1952     acb->bytes = len;
1953     acb->has_returned = false;
1954 
1955     co = qemu_coroutine_create(blk_aio_zone_mgmt_entry, acb);
1956     aio_co_enter(qemu_get_current_aio_context(), co);
1957 
1958     acb->has_returned = true;
1959     if (acb->rwco.ret != NOT_DONE) {
1960         replay_bh_schedule_oneshot_event(qemu_get_current_aio_context(),
1961                                          blk_aio_complete_bh, acb);
1962     }
1963 
1964     return &acb->common;
1965 }
1966 
1967 static void coroutine_fn blk_aio_zone_append_entry(void *opaque)
1968 {
1969     BlkAioEmAIOCB *acb = opaque;
1970     BlkRwCo *rwco = &acb->rwco;
1971 
1972     rwco->ret = blk_co_zone_append(rwco->blk, (int64_t *)(uintptr_t)acb->bytes,
1973                                    rwco->iobuf, rwco->flags);
1974     blk_aio_complete(acb);
1975 }
1976 
1977 BlockAIOCB *blk_aio_zone_append(BlockBackend *blk, int64_t *offset,
1978                                 QEMUIOVector *qiov, BdrvRequestFlags flags,
1979                                 BlockCompletionFunc *cb, void *opaque) {
1980     BlkAioEmAIOCB *acb;
1981     Coroutine *co;
1982     IO_CODE();
1983 
1984     blk_inc_in_flight(blk);
1985     acb = blk_aio_get(&blk_aio_em_aiocb_info, blk, cb, opaque);
1986     acb->rwco = (BlkRwCo) {
1987         .blk    = blk,
1988         .ret    = NOT_DONE,
1989         .flags  = flags,
1990         .iobuf  = qiov,
1991     };
1992     acb->bytes = (int64_t)(uintptr_t)offset;
1993     acb->has_returned = false;
1994 
1995     co = qemu_coroutine_create(blk_aio_zone_append_entry, acb);
1996     aio_co_enter(qemu_get_current_aio_context(), co);
1997     acb->has_returned = true;
1998     if (acb->rwco.ret != NOT_DONE) {
1999         replay_bh_schedule_oneshot_event(qemu_get_current_aio_context(),
2000                                          blk_aio_complete_bh, acb);
2001     }
2002 
2003     return &acb->common;
2004 }
2005 
2006 /*
2007  * Send a zone_report command.
2008  * offset is a byte offset from the start of the device. No alignment
2009  * required for offset.
2010  * nr_zones represents IN maximum and OUT actual.
2011  */
2012 int coroutine_fn blk_co_zone_report(BlockBackend *blk, int64_t offset,
2013                                     unsigned int *nr_zones,
2014                                     BlockZoneDescriptor *zones)
2015 {
2016     int ret;
2017     IO_CODE();
2018 
2019     blk_inc_in_flight(blk); /* increase before waiting */
2020     blk_wait_while_drained(blk);
2021     GRAPH_RDLOCK_GUARD();
2022     if (!blk_is_available(blk)) {
2023         blk_dec_in_flight(blk);
2024         return -ENOMEDIUM;
2025     }
2026     ret = bdrv_co_zone_report(blk_bs(blk), offset, nr_zones, zones);
2027     blk_dec_in_flight(blk);
2028     return ret;
2029 }
2030 
2031 /*
2032  * Send a zone_management command.
2033  * op is the zone operation;
2034  * offset is the byte offset from the start of the zoned device;
2035  * len is the maximum number of bytes the command should operate on. It
2036  * should be aligned with the device zone size.
2037  */
2038 int coroutine_fn blk_co_zone_mgmt(BlockBackend *blk, BlockZoneOp op,
2039         int64_t offset, int64_t len)
2040 {
2041     int ret;
2042     IO_CODE();
2043 
2044     blk_inc_in_flight(blk);
2045     blk_wait_while_drained(blk);
2046     GRAPH_RDLOCK_GUARD();
2047 
2048     ret = blk_check_byte_request(blk, offset, len);
2049     if (ret < 0) {
2050         blk_dec_in_flight(blk);
2051         return ret;
2052     }
2053 
2054     ret = bdrv_co_zone_mgmt(blk_bs(blk), op, offset, len);
2055     blk_dec_in_flight(blk);
2056     return ret;
2057 }
2058 
2059 /*
2060  * Send a zone_append command.
2061  */
2062 int coroutine_fn blk_co_zone_append(BlockBackend *blk, int64_t *offset,
2063         QEMUIOVector *qiov, BdrvRequestFlags flags)
2064 {
2065     int ret;
2066     IO_CODE();
2067 
2068     blk_inc_in_flight(blk);
2069     blk_wait_while_drained(blk);
2070     GRAPH_RDLOCK_GUARD();
2071     if (!blk_is_available(blk)) {
2072         blk_dec_in_flight(blk);
2073         return -ENOMEDIUM;
2074     }
2075 
2076     ret = bdrv_co_zone_append(blk_bs(blk), offset, qiov, flags);
2077     blk_dec_in_flight(blk);
2078     return ret;
2079 }
2080 
2081 void blk_drain(BlockBackend *blk)
2082 {
2083     BlockDriverState *bs = blk_bs(blk);
2084     GLOBAL_STATE_CODE();
2085 
2086     if (bs) {
2087         bdrv_ref(bs);
2088         bdrv_drained_begin(bs);
2089     }
2090 
2091     /* We may have -ENOMEDIUM completions in flight */
2092     AIO_WAIT_WHILE(blk_get_aio_context(blk),
2093                    qatomic_read(&blk->in_flight) > 0);
2094 
2095     if (bs) {
2096         bdrv_drained_end(bs);
2097         bdrv_unref(bs);
2098     }
2099 }
2100 
2101 void blk_drain_all(void)
2102 {
2103     BlockBackend *blk = NULL;
2104 
2105     GLOBAL_STATE_CODE();
2106 
2107     bdrv_drain_all_begin();
2108 
2109     while ((blk = blk_all_next(blk)) != NULL) {
2110         /* We may have -ENOMEDIUM completions in flight */
2111         AIO_WAIT_WHILE_UNLOCKED(NULL, qatomic_read(&blk->in_flight) > 0);
2112     }
2113 
2114     bdrv_drain_all_end();
2115 }
2116 
2117 void blk_set_on_error(BlockBackend *blk, BlockdevOnError on_read_error,
2118                       BlockdevOnError on_write_error)
2119 {
2120     GLOBAL_STATE_CODE();
2121     blk->on_read_error = on_read_error;
2122     blk->on_write_error = on_write_error;
2123 }
2124 
2125 BlockdevOnError blk_get_on_error(BlockBackend *blk, bool is_read)
2126 {
2127     IO_CODE();
2128     return is_read ? blk->on_read_error : blk->on_write_error;
2129 }
2130 
2131 BlockErrorAction blk_get_error_action(BlockBackend *blk, bool is_read,
2132                                       int error)
2133 {
2134     BlockdevOnError on_err = blk_get_on_error(blk, is_read);
2135     IO_CODE();
2136 
2137     switch (on_err) {
2138     case BLOCKDEV_ON_ERROR_ENOSPC:
2139         return (error == ENOSPC) ?
2140                BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT;
2141     case BLOCKDEV_ON_ERROR_STOP:
2142         return BLOCK_ERROR_ACTION_STOP;
2143     case BLOCKDEV_ON_ERROR_REPORT:
2144         return BLOCK_ERROR_ACTION_REPORT;
2145     case BLOCKDEV_ON_ERROR_IGNORE:
2146         return BLOCK_ERROR_ACTION_IGNORE;
2147     case BLOCKDEV_ON_ERROR_AUTO:
2148     default:
2149         abort();
2150     }
2151 }
2152 
2153 static void send_qmp_error_event(BlockBackend *blk,
2154                                  BlockErrorAction action,
2155                                  bool is_read, int error)
2156 {
2157     IoOperationType optype;
2158     BlockDriverState *bs = blk_bs(blk);
2159 
2160     optype = is_read ? IO_OPERATION_TYPE_READ : IO_OPERATION_TYPE_WRITE;
2161     qapi_event_send_block_io_error(blk_name(blk),
2162                                    bs ? bdrv_get_node_name(bs) : NULL, optype,
2163                                    action, blk_iostatus_is_enabled(blk),
2164                                    error == ENOSPC, strerror(error));
2165 }
2166 
2167 /* This is done by device models because, while the block layer knows
2168  * about the error, it does not know whether an operation comes from
2169  * the device or the block layer (from a job, for example).
2170  */
2171 void blk_error_action(BlockBackend *blk, BlockErrorAction action,
2172                       bool is_read, int error)
2173 {
2174     assert(error >= 0);
2175     IO_CODE();
2176 
2177     if (action == BLOCK_ERROR_ACTION_STOP) {
2178         /* First set the iostatus, so that "info block" returns an iostatus
2179          * that matches the events raised so far (an additional error iostatus
2180          * is fine, but not a lost one).
2181          */
2182         blk_iostatus_set_err(blk, error);
2183 
2184         /* Then raise the request to stop the VM and the event.
2185          * qemu_system_vmstop_request_prepare has two effects.  First,
2186          * it ensures that the STOP event always comes after the
2187          * BLOCK_IO_ERROR event.  Second, it ensures that even if management
2188          * can observe the STOP event and do a "cont" before the STOP
2189          * event is issued, the VM will not stop.  In this case, vm_start()
2190          * also ensures that the STOP/RESUME pair of events is emitted.
2191          */
2192         qemu_system_vmstop_request_prepare();
2193         send_qmp_error_event(blk, action, is_read, error);
2194         qemu_system_vmstop_request(RUN_STATE_IO_ERROR);
2195     } else {
2196         send_qmp_error_event(blk, action, is_read, error);
2197     }
2198 }
2199 
2200 /*
2201  * Returns true if the BlockBackend can support taking write permissions
2202  * (because its root node is not read-only).
2203  */
2204 bool blk_supports_write_perm(BlockBackend *blk)
2205 {
2206     BlockDriverState *bs = blk_bs(blk);
2207     GLOBAL_STATE_CODE();
2208 
2209     if (bs) {
2210         return !bdrv_is_read_only(bs);
2211     } else {
2212         return blk->root_state.open_flags & BDRV_O_RDWR;
2213     }
2214 }
2215 
2216 /*
2217  * Returns true if the BlockBackend can be written to in its current
2218  * configuration (i.e. if write permission have been requested)
2219  */
2220 bool blk_is_writable(BlockBackend *blk)
2221 {
2222     IO_CODE();
2223     return blk->perm & BLK_PERM_WRITE;
2224 }
2225 
2226 bool blk_is_sg(BlockBackend *blk)
2227 {
2228     BlockDriverState *bs = blk_bs(blk);
2229     GLOBAL_STATE_CODE();
2230 
2231     if (!bs) {
2232         return false;
2233     }
2234 
2235     return bdrv_is_sg(bs);
2236 }
2237 
2238 bool blk_enable_write_cache(BlockBackend *blk)
2239 {
2240     IO_CODE();
2241     return blk->enable_write_cache;
2242 }
2243 
2244 void blk_set_enable_write_cache(BlockBackend *blk, bool wce)
2245 {
2246     IO_CODE();
2247     blk->enable_write_cache = wce;
2248 }
2249 
2250 void blk_activate(BlockBackend *blk, Error **errp)
2251 {
2252     BlockDriverState *bs = blk_bs(blk);
2253     GLOBAL_STATE_CODE();
2254 
2255     if (!bs) {
2256         error_setg(errp, "Device '%s' has no medium", blk->name);
2257         return;
2258     }
2259 
2260     /*
2261      * Migration code can call this function in coroutine context, so leave
2262      * coroutine context if necessary.
2263      */
2264     if (qemu_in_coroutine()) {
2265         bdrv_co_activate(bs, errp);
2266     } else {
2267         GRAPH_RDLOCK_GUARD_MAINLOOP();
2268         bdrv_activate(bs, errp);
2269     }
2270 }
2271 
2272 bool coroutine_fn blk_co_is_inserted(BlockBackend *blk)
2273 {
2274     BlockDriverState *bs = blk_bs(blk);
2275     IO_CODE();
2276     assert_bdrv_graph_readable();
2277 
2278     return bs && bdrv_co_is_inserted(bs);
2279 }
2280 
2281 bool coroutine_fn blk_co_is_available(BlockBackend *blk)
2282 {
2283     IO_CODE();
2284     return blk_co_is_inserted(blk) && !blk_dev_is_tray_open(blk);
2285 }
2286 
2287 void coroutine_fn blk_co_lock_medium(BlockBackend *blk, bool locked)
2288 {
2289     BlockDriverState *bs = blk_bs(blk);
2290     IO_CODE();
2291     GRAPH_RDLOCK_GUARD();
2292 
2293     if (bs) {
2294         bdrv_co_lock_medium(bs, locked);
2295     }
2296 }
2297 
2298 void coroutine_fn blk_co_eject(BlockBackend *blk, bool eject_flag)
2299 {
2300     BlockDriverState *bs = blk_bs(blk);
2301     char *id;
2302     IO_CODE();
2303     GRAPH_RDLOCK_GUARD();
2304 
2305     if (bs) {
2306         bdrv_co_eject(bs, eject_flag);
2307     }
2308 
2309     /* Whether or not we ejected on the backend,
2310      * the frontend experienced a tray event. */
2311     id = blk_get_attached_dev_id(blk);
2312     qapi_event_send_device_tray_moved(blk_name(blk), id,
2313                                       eject_flag);
2314     g_free(id);
2315 }
2316 
2317 int blk_get_flags(BlockBackend *blk)
2318 {
2319     BlockDriverState *bs = blk_bs(blk);
2320     GLOBAL_STATE_CODE();
2321 
2322     if (bs) {
2323         return bdrv_get_flags(bs);
2324     } else {
2325         return blk->root_state.open_flags;
2326     }
2327 }
2328 
2329 /* Returns the minimum request alignment, in bytes; guaranteed nonzero */
2330 uint32_t blk_get_request_alignment(BlockBackend *blk)
2331 {
2332     BlockDriverState *bs = blk_bs(blk);
2333     IO_CODE();
2334     return bs ? bs->bl.request_alignment : BDRV_SECTOR_SIZE;
2335 }
2336 
2337 /* Returns the maximum hardware transfer length, in bytes; guaranteed nonzero */
2338 uint64_t blk_get_max_hw_transfer(BlockBackend *blk)
2339 {
2340     BlockDriverState *bs = blk_bs(blk);
2341     uint64_t max = INT_MAX;
2342     IO_CODE();
2343 
2344     if (bs) {
2345         max = MIN_NON_ZERO(max, bs->bl.max_hw_transfer);
2346         max = MIN_NON_ZERO(max, bs->bl.max_transfer);
2347     }
2348     return ROUND_DOWN(max, blk_get_request_alignment(blk));
2349 }
2350 
2351 /* Returns the maximum transfer length, in bytes; guaranteed nonzero */
2352 uint32_t blk_get_max_transfer(BlockBackend *blk)
2353 {
2354     BlockDriverState *bs = blk_bs(blk);
2355     uint32_t max = INT_MAX;
2356     IO_CODE();
2357 
2358     if (bs) {
2359         max = MIN_NON_ZERO(max, bs->bl.max_transfer);
2360     }
2361     return ROUND_DOWN(max, blk_get_request_alignment(blk));
2362 }
2363 
2364 int blk_get_max_hw_iov(BlockBackend *blk)
2365 {
2366     IO_CODE();
2367     return MIN_NON_ZERO(blk->root->bs->bl.max_hw_iov,
2368                         blk->root->bs->bl.max_iov);
2369 }
2370 
2371 int blk_get_max_iov(BlockBackend *blk)
2372 {
2373     IO_CODE();
2374     return blk->root->bs->bl.max_iov;
2375 }
2376 
2377 void *blk_try_blockalign(BlockBackend *blk, size_t size)
2378 {
2379     IO_CODE();
2380     return qemu_try_blockalign(blk ? blk_bs(blk) : NULL, size);
2381 }
2382 
2383 void *blk_blockalign(BlockBackend *blk, size_t size)
2384 {
2385     IO_CODE();
2386     return qemu_blockalign(blk ? blk_bs(blk) : NULL, size);
2387 }
2388 
2389 bool blk_op_is_blocked(BlockBackend *blk, BlockOpType op, Error **errp)
2390 {
2391     BlockDriverState *bs = blk_bs(blk);
2392     GLOBAL_STATE_CODE();
2393     GRAPH_RDLOCK_GUARD_MAINLOOP();
2394 
2395     if (!bs) {
2396         return false;
2397     }
2398 
2399     return bdrv_op_is_blocked(bs, op, errp);
2400 }
2401 
2402 void blk_op_unblock(BlockBackend *blk, BlockOpType op, Error *reason)
2403 {
2404     BlockDriverState *bs = blk_bs(blk);
2405     GLOBAL_STATE_CODE();
2406 
2407     if (bs) {
2408         bdrv_op_unblock(bs, op, reason);
2409     }
2410 }
2411 
2412 void blk_op_block_all(BlockBackend *blk, Error *reason)
2413 {
2414     BlockDriverState *bs = blk_bs(blk);
2415     GLOBAL_STATE_CODE();
2416 
2417     if (bs) {
2418         bdrv_op_block_all(bs, reason);
2419     }
2420 }
2421 
2422 void blk_op_unblock_all(BlockBackend *blk, Error *reason)
2423 {
2424     BlockDriverState *bs = blk_bs(blk);
2425     GLOBAL_STATE_CODE();
2426 
2427     if (bs) {
2428         bdrv_op_unblock_all(bs, reason);
2429     }
2430 }
2431 
2432 AioContext *blk_get_aio_context(BlockBackend *blk)
2433 {
2434     BlockDriverState *bs;
2435     IO_CODE();
2436 
2437     if (!blk) {
2438         return qemu_get_aio_context();
2439     }
2440 
2441     bs = blk_bs(blk);
2442     if (bs) {
2443         AioContext *ctx = bdrv_get_aio_context(blk_bs(blk));
2444         assert(ctx == blk->ctx);
2445     }
2446 
2447     return blk->ctx;
2448 }
2449 
2450 int blk_set_aio_context(BlockBackend *blk, AioContext *new_context,
2451                         Error **errp)
2452 {
2453     bool old_allow_change;
2454     BlockDriverState *bs = blk_bs(blk);
2455     int ret;
2456 
2457     GLOBAL_STATE_CODE();
2458 
2459     if (!bs) {
2460         blk->ctx = new_context;
2461         return 0;
2462     }
2463 
2464     bdrv_ref(bs);
2465 
2466     old_allow_change = blk->allow_aio_context_change;
2467     blk->allow_aio_context_change = true;
2468 
2469     ret = bdrv_try_change_aio_context(bs, new_context, NULL, errp);
2470 
2471     blk->allow_aio_context_change = old_allow_change;
2472 
2473     bdrv_unref(bs);
2474     return ret;
2475 }
2476 
2477 typedef struct BdrvStateBlkRootContext {
2478     AioContext *new_ctx;
2479     BlockBackend *blk;
2480 } BdrvStateBlkRootContext;
2481 
2482 static void blk_root_set_aio_ctx_commit(void *opaque)
2483 {
2484     BdrvStateBlkRootContext *s = opaque;
2485     BlockBackend *blk = s->blk;
2486     AioContext *new_context = s->new_ctx;
2487     ThrottleGroupMember *tgm = &blk->public.throttle_group_member;
2488 
2489     blk->ctx = new_context;
2490     if (tgm->throttle_state) {
2491         throttle_group_detach_aio_context(tgm);
2492         throttle_group_attach_aio_context(tgm, new_context);
2493     }
2494 }
2495 
2496 static TransactionActionDrv set_blk_root_context = {
2497     .commit = blk_root_set_aio_ctx_commit,
2498     .clean = g_free,
2499 };
2500 
2501 static bool blk_root_change_aio_ctx(BdrvChild *child, AioContext *ctx,
2502                                     GHashTable *visited, Transaction *tran,
2503                                     Error **errp)
2504 {
2505     BlockBackend *blk = child->opaque;
2506     BdrvStateBlkRootContext *s;
2507 
2508     if (!blk->allow_aio_context_change) {
2509         /*
2510          * Manually created BlockBackends (those with a name) that are not
2511          * attached to anything can change their AioContext without updating
2512          * their user; return an error for others.
2513          */
2514         if (!blk->name || blk->dev) {
2515             /* TODO Add BB name/QOM path */
2516             error_setg(errp, "Cannot change iothread of active block backend");
2517             return false;
2518         }
2519     }
2520 
2521     s = g_new(BdrvStateBlkRootContext, 1);
2522     *s = (BdrvStateBlkRootContext) {
2523         .new_ctx = ctx,
2524         .blk = blk,
2525     };
2526 
2527     tran_add(tran, &set_blk_root_context, s);
2528     return true;
2529 }
2530 
2531 void blk_add_aio_context_notifier(BlockBackend *blk,
2532         void (*attached_aio_context)(AioContext *new_context, void *opaque),
2533         void (*detach_aio_context)(void *opaque), void *opaque)
2534 {
2535     BlockBackendAioNotifier *notifier;
2536     BlockDriverState *bs = blk_bs(blk);
2537     GLOBAL_STATE_CODE();
2538 
2539     notifier = g_new(BlockBackendAioNotifier, 1);
2540     notifier->attached_aio_context = attached_aio_context;
2541     notifier->detach_aio_context = detach_aio_context;
2542     notifier->opaque = opaque;
2543     QLIST_INSERT_HEAD(&blk->aio_notifiers, notifier, list);
2544 
2545     if (bs) {
2546         bdrv_add_aio_context_notifier(bs, attached_aio_context,
2547                                       detach_aio_context, opaque);
2548     }
2549 }
2550 
2551 void blk_remove_aio_context_notifier(BlockBackend *blk,
2552                                      void (*attached_aio_context)(AioContext *,
2553                                                                   void *),
2554                                      void (*detach_aio_context)(void *),
2555                                      void *opaque)
2556 {
2557     BlockBackendAioNotifier *notifier;
2558     BlockDriverState *bs = blk_bs(blk);
2559 
2560     GLOBAL_STATE_CODE();
2561 
2562     if (bs) {
2563         bdrv_remove_aio_context_notifier(bs, attached_aio_context,
2564                                          detach_aio_context, opaque);
2565     }
2566 
2567     QLIST_FOREACH(notifier, &blk->aio_notifiers, list) {
2568         if (notifier->attached_aio_context == attached_aio_context &&
2569             notifier->detach_aio_context == detach_aio_context &&
2570             notifier->opaque == opaque) {
2571             QLIST_REMOVE(notifier, list);
2572             g_free(notifier);
2573             return;
2574         }
2575     }
2576 
2577     abort();
2578 }
2579 
2580 void blk_add_remove_bs_notifier(BlockBackend *blk, Notifier *notify)
2581 {
2582     GLOBAL_STATE_CODE();
2583     notifier_list_add(&blk->remove_bs_notifiers, notify);
2584 }
2585 
2586 void blk_add_insert_bs_notifier(BlockBackend *blk, Notifier *notify)
2587 {
2588     GLOBAL_STATE_CODE();
2589     notifier_list_add(&blk->insert_bs_notifiers, notify);
2590 }
2591 
2592 BlockAcctStats *blk_get_stats(BlockBackend *blk)
2593 {
2594     IO_CODE();
2595     return &blk->stats;
2596 }
2597 
2598 void *blk_aio_get(const AIOCBInfo *aiocb_info, BlockBackend *blk,
2599                   BlockCompletionFunc *cb, void *opaque)
2600 {
2601     IO_CODE();
2602     return qemu_aio_get(aiocb_info, blk_bs(blk), cb, opaque);
2603 }
2604 
2605 int coroutine_fn blk_co_pwrite_zeroes(BlockBackend *blk, int64_t offset,
2606                                       int64_t bytes, BdrvRequestFlags flags)
2607 {
2608     IO_OR_GS_CODE();
2609     return blk_co_pwritev(blk, offset, bytes, NULL,
2610                           flags | BDRV_REQ_ZERO_WRITE);
2611 }
2612 
2613 int coroutine_fn blk_co_pwrite_compressed(BlockBackend *blk, int64_t offset,
2614                                           int64_t bytes, const void *buf)
2615 {
2616     QEMUIOVector qiov = QEMU_IOVEC_INIT_BUF(qiov, buf, bytes);
2617     IO_OR_GS_CODE();
2618     return blk_co_pwritev_part(blk, offset, bytes, &qiov, 0,
2619                                BDRV_REQ_WRITE_COMPRESSED);
2620 }
2621 
2622 int coroutine_fn blk_co_truncate(BlockBackend *blk, int64_t offset, bool exact,
2623                                  PreallocMode prealloc, BdrvRequestFlags flags,
2624                                  Error **errp)
2625 {
2626     IO_OR_GS_CODE();
2627     GRAPH_RDLOCK_GUARD();
2628     if (!blk_co_is_available(blk)) {
2629         error_setg(errp, "No medium inserted");
2630         return -ENOMEDIUM;
2631     }
2632 
2633     return bdrv_co_truncate(blk->root, offset, exact, prealloc, flags, errp);
2634 }
2635 
2636 int blk_save_vmstate(BlockBackend *blk, const uint8_t *buf,
2637                      int64_t pos, int size)
2638 {
2639     int ret;
2640     GLOBAL_STATE_CODE();
2641 
2642     if (!blk_is_available(blk)) {
2643         return -ENOMEDIUM;
2644     }
2645 
2646     ret = bdrv_save_vmstate(blk_bs(blk), buf, pos, size);
2647     if (ret < 0) {
2648         return ret;
2649     }
2650 
2651     if (ret == size && !blk->enable_write_cache) {
2652         ret = bdrv_flush(blk_bs(blk));
2653     }
2654 
2655     return ret < 0 ? ret : size;
2656 }
2657 
2658 int blk_load_vmstate(BlockBackend *blk, uint8_t *buf, int64_t pos, int size)
2659 {
2660     GLOBAL_STATE_CODE();
2661     if (!blk_is_available(blk)) {
2662         return -ENOMEDIUM;
2663     }
2664 
2665     return bdrv_load_vmstate(blk_bs(blk), buf, pos, size);
2666 }
2667 
2668 int blk_probe_blocksizes(BlockBackend *blk, BlockSizes *bsz)
2669 {
2670     GLOBAL_STATE_CODE();
2671     GRAPH_RDLOCK_GUARD_MAINLOOP();
2672 
2673     if (!blk_is_available(blk)) {
2674         return -ENOMEDIUM;
2675     }
2676 
2677     return bdrv_probe_blocksizes(blk_bs(blk), bsz);
2678 }
2679 
2680 int blk_probe_geometry(BlockBackend *blk, HDGeometry *geo)
2681 {
2682     GLOBAL_STATE_CODE();
2683     if (!blk_is_available(blk)) {
2684         return -ENOMEDIUM;
2685     }
2686 
2687     return bdrv_probe_geometry(blk_bs(blk), geo);
2688 }
2689 
2690 /*
2691  * Updates the BlockBackendRootState object with data from the currently
2692  * attached BlockDriverState.
2693  */
2694 void blk_update_root_state(BlockBackend *blk)
2695 {
2696     GLOBAL_STATE_CODE();
2697     assert(blk->root);
2698 
2699     blk->root_state.open_flags    = blk->root->bs->open_flags;
2700     blk->root_state.detect_zeroes = blk->root->bs->detect_zeroes;
2701 }
2702 
2703 /*
2704  * Returns the detect-zeroes setting to be used for bdrv_open() of a
2705  * BlockDriverState which is supposed to inherit the root state.
2706  */
2707 bool blk_get_detect_zeroes_from_root_state(BlockBackend *blk)
2708 {
2709     GLOBAL_STATE_CODE();
2710     return blk->root_state.detect_zeroes;
2711 }
2712 
2713 /*
2714  * Returns the flags to be used for bdrv_open() of a BlockDriverState which is
2715  * supposed to inherit the root state.
2716  */
2717 int blk_get_open_flags_from_root_state(BlockBackend *blk)
2718 {
2719     GLOBAL_STATE_CODE();
2720     return blk->root_state.open_flags;
2721 }
2722 
2723 BlockBackendRootState *blk_get_root_state(BlockBackend *blk)
2724 {
2725     GLOBAL_STATE_CODE();
2726     return &blk->root_state;
2727 }
2728 
2729 int blk_commit_all(void)
2730 {
2731     BlockBackend *blk = NULL;
2732     GLOBAL_STATE_CODE();
2733     GRAPH_RDLOCK_GUARD_MAINLOOP();
2734 
2735     while ((blk = blk_all_next(blk)) != NULL) {
2736         AioContext *aio_context = blk_get_aio_context(blk);
2737         BlockDriverState *unfiltered_bs = bdrv_skip_filters(blk_bs(blk));
2738 
2739         aio_context_acquire(aio_context);
2740         if (blk_is_inserted(blk) && bdrv_cow_child(unfiltered_bs)) {
2741             int ret;
2742 
2743             ret = bdrv_commit(unfiltered_bs);
2744             if (ret < 0) {
2745                 aio_context_release(aio_context);
2746                 return ret;
2747             }
2748         }
2749         aio_context_release(aio_context);
2750     }
2751     return 0;
2752 }
2753 
2754 
2755 /* throttling disk I/O limits */
2756 void blk_set_io_limits(BlockBackend *blk, ThrottleConfig *cfg)
2757 {
2758     GLOBAL_STATE_CODE();
2759     throttle_group_config(&blk->public.throttle_group_member, cfg);
2760 }
2761 
2762 void blk_io_limits_disable(BlockBackend *blk)
2763 {
2764     BlockDriverState *bs = blk_bs(blk);
2765     ThrottleGroupMember *tgm = &blk->public.throttle_group_member;
2766     assert(tgm->throttle_state);
2767     GLOBAL_STATE_CODE();
2768     if (bs) {
2769         bdrv_ref(bs);
2770         bdrv_drained_begin(bs);
2771     }
2772     throttle_group_unregister_tgm(tgm);
2773     if (bs) {
2774         bdrv_drained_end(bs);
2775         bdrv_unref(bs);
2776     }
2777 }
2778 
2779 /* should be called before blk_set_io_limits if a limit is set */
2780 void blk_io_limits_enable(BlockBackend *blk, const char *group)
2781 {
2782     assert(!blk->public.throttle_group_member.throttle_state);
2783     GLOBAL_STATE_CODE();
2784     throttle_group_register_tgm(&blk->public.throttle_group_member,
2785                                 group, blk_get_aio_context(blk));
2786 }
2787 
2788 void blk_io_limits_update_group(BlockBackend *blk, const char *group)
2789 {
2790     GLOBAL_STATE_CODE();
2791     /* this BB is not part of any group */
2792     if (!blk->public.throttle_group_member.throttle_state) {
2793         return;
2794     }
2795 
2796     /* this BB is a part of the same group than the one we want */
2797     if (!g_strcmp0(throttle_group_get_name(&blk->public.throttle_group_member),
2798                 group)) {
2799         return;
2800     }
2801 
2802     /* need to change the group this bs belong to */
2803     blk_io_limits_disable(blk);
2804     blk_io_limits_enable(blk, group);
2805 }
2806 
2807 static void blk_root_drained_begin(BdrvChild *child)
2808 {
2809     BlockBackend *blk = child->opaque;
2810     ThrottleGroupMember *tgm = &blk->public.throttle_group_member;
2811 
2812     if (qatomic_fetch_inc(&blk->quiesce_counter) == 0) {
2813         if (blk->dev_ops && blk->dev_ops->drained_begin) {
2814             blk->dev_ops->drained_begin(blk->dev_opaque);
2815         }
2816     }
2817 
2818     /* Note that blk->root may not be accessible here yet if we are just
2819      * attaching to a BlockDriverState that is drained. Use child instead. */
2820 
2821     if (qatomic_fetch_inc(&tgm->io_limits_disabled) == 0) {
2822         throttle_group_restart_tgm(tgm);
2823     }
2824 }
2825 
2826 static bool blk_root_drained_poll(BdrvChild *child)
2827 {
2828     BlockBackend *blk = child->opaque;
2829     bool busy = false;
2830     assert(qatomic_read(&blk->quiesce_counter));
2831 
2832     if (blk->dev_ops && blk->dev_ops->drained_poll) {
2833         busy = blk->dev_ops->drained_poll(blk->dev_opaque);
2834     }
2835     return busy || !!blk->in_flight;
2836 }
2837 
2838 static void blk_root_drained_end(BdrvChild *child)
2839 {
2840     BlockBackend *blk = child->opaque;
2841     assert(qatomic_read(&blk->quiesce_counter));
2842 
2843     assert(blk->public.throttle_group_member.io_limits_disabled);
2844     qatomic_dec(&blk->public.throttle_group_member.io_limits_disabled);
2845 
2846     if (qatomic_fetch_dec(&blk->quiesce_counter) == 1) {
2847         if (blk->dev_ops && blk->dev_ops->drained_end) {
2848             blk->dev_ops->drained_end(blk->dev_opaque);
2849         }
2850         qemu_mutex_lock(&blk->queued_requests_lock);
2851         while (qemu_co_enter_next(&blk->queued_requests,
2852                                   &blk->queued_requests_lock)) {
2853             /* Resume all queued requests */
2854         }
2855         qemu_mutex_unlock(&blk->queued_requests_lock);
2856     }
2857 }
2858 
2859 bool blk_register_buf(BlockBackend *blk, void *host, size_t size, Error **errp)
2860 {
2861     BlockDriverState *bs = blk_bs(blk);
2862 
2863     GLOBAL_STATE_CODE();
2864 
2865     if (bs) {
2866         return bdrv_register_buf(bs, host, size, errp);
2867     }
2868     return true;
2869 }
2870 
2871 void blk_unregister_buf(BlockBackend *blk, void *host, size_t size)
2872 {
2873     BlockDriverState *bs = blk_bs(blk);
2874 
2875     GLOBAL_STATE_CODE();
2876 
2877     if (bs) {
2878         bdrv_unregister_buf(bs, host, size);
2879     }
2880 }
2881 
2882 int coroutine_fn blk_co_copy_range(BlockBackend *blk_in, int64_t off_in,
2883                                    BlockBackend *blk_out, int64_t off_out,
2884                                    int64_t bytes, BdrvRequestFlags read_flags,
2885                                    BdrvRequestFlags write_flags)
2886 {
2887     int r;
2888     IO_CODE();
2889     GRAPH_RDLOCK_GUARD();
2890 
2891     r = blk_check_byte_request(blk_in, off_in, bytes);
2892     if (r) {
2893         return r;
2894     }
2895     r = blk_check_byte_request(blk_out, off_out, bytes);
2896     if (r) {
2897         return r;
2898     }
2899 
2900     return bdrv_co_copy_range(blk_in->root, off_in,
2901                               blk_out->root, off_out,
2902                               bytes, read_flags, write_flags);
2903 }
2904 
2905 const BdrvChild *blk_root(BlockBackend *blk)
2906 {
2907     GLOBAL_STATE_CODE();
2908     return blk->root;
2909 }
2910 
2911 int blk_make_empty(BlockBackend *blk, Error **errp)
2912 {
2913     GLOBAL_STATE_CODE();
2914     GRAPH_RDLOCK_GUARD_MAINLOOP();
2915 
2916     if (!blk_is_available(blk)) {
2917         error_setg(errp, "No medium inserted");
2918         return -ENOMEDIUM;
2919     }
2920 
2921     return bdrv_make_empty(blk->root, errp);
2922 }
2923