xref: /openbmc/qemu/block/block-backend.c (revision 8779fccb)
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/throttle-groups.h"
18 #include "sysemu/blockdev.h"
19 #include "sysemu/sysemu.h"
20 #include "qapi-event.h"
21 #include "qemu/id.h"
22 #include "trace.h"
23 
24 /* Number of coroutines to reserve per attached device model */
25 #define COROUTINE_POOL_RESERVATION 64
26 
27 #define NOT_DONE 0x7fffffff /* used while emulated sync operation in progress */
28 
29 static AioContext *blk_aiocb_get_aio_context(BlockAIOCB *acb);
30 
31 struct BlockBackend {
32     char *name;
33     int refcnt;
34     BdrvChild *root;
35     DriveInfo *legacy_dinfo;    /* null unless created by drive_new() */
36     QTAILQ_ENTRY(BlockBackend) link;         /* for block_backends */
37     QTAILQ_ENTRY(BlockBackend) monitor_link; /* for monitor_block_backends */
38     BlockBackendPublic public;
39 
40     void *dev;                  /* attached device model, if any */
41     bool legacy_dev;            /* true if dev is not a DeviceState */
42     /* TODO change to DeviceState when all users are qdevified */
43     const BlockDevOps *dev_ops;
44     void *dev_opaque;
45 
46     /* the block size for which the guest device expects atomicity */
47     int guest_block_size;
48 
49     /* If the BDS tree is removed, some of its options are stored here (which
50      * can be used to restore those options in the new BDS on insert) */
51     BlockBackendRootState root_state;
52 
53     bool enable_write_cache;
54 
55     /* I/O stats (display with "info blockstats"). */
56     BlockAcctStats stats;
57 
58     BlockdevOnError on_read_error, on_write_error;
59     bool iostatus_enabled;
60     BlockDeviceIoStatus iostatus;
61 
62     bool allow_write_beyond_eof;
63 
64     NotifierList remove_bs_notifiers, insert_bs_notifiers;
65 };
66 
67 typedef struct BlockBackendAIOCB {
68     BlockAIOCB common;
69     BlockBackend *blk;
70     int ret;
71 } BlockBackendAIOCB;
72 
73 static const AIOCBInfo block_backend_aiocb_info = {
74     .get_aio_context = blk_aiocb_get_aio_context,
75     .aiocb_size = sizeof(BlockBackendAIOCB),
76 };
77 
78 static void drive_info_del(DriveInfo *dinfo);
79 static BlockBackend *bdrv_first_blk(BlockDriverState *bs);
80 
81 /* All BlockBackends */
82 static QTAILQ_HEAD(, BlockBackend) block_backends =
83     QTAILQ_HEAD_INITIALIZER(block_backends);
84 
85 /* All BlockBackends referenced by the monitor and which are iterated through by
86  * blk_next() */
87 static QTAILQ_HEAD(, BlockBackend) monitor_block_backends =
88     QTAILQ_HEAD_INITIALIZER(monitor_block_backends);
89 
90 static void blk_root_inherit_options(int *child_flags, QDict *child_options,
91                                      int parent_flags, QDict *parent_options)
92 {
93     /* We're not supposed to call this function for root nodes */
94     abort();
95 }
96 static void blk_root_drained_begin(BdrvChild *child);
97 static void blk_root_drained_end(BdrvChild *child);
98 
99 static void blk_root_change_media(BdrvChild *child, bool load);
100 static void blk_root_resize(BdrvChild *child);
101 
102 static const char *blk_root_get_name(BdrvChild *child)
103 {
104     return blk_name(child->opaque);
105 }
106 
107 static const BdrvChildRole child_root = {
108     .inherit_options    = blk_root_inherit_options,
109 
110     .change_media       = blk_root_change_media,
111     .resize             = blk_root_resize,
112     .get_name           = blk_root_get_name,
113 
114     .drained_begin      = blk_root_drained_begin,
115     .drained_end        = blk_root_drained_end,
116 };
117 
118 /*
119  * Create a new BlockBackend with a reference count of one.
120  * Store an error through @errp on failure, unless it's null.
121  * Return the new BlockBackend on success, null on failure.
122  */
123 BlockBackend *blk_new(void)
124 {
125     BlockBackend *blk;
126 
127     blk = g_new0(BlockBackend, 1);
128     blk->refcnt = 1;
129     blk_set_enable_write_cache(blk, true);
130 
131     qemu_co_queue_init(&blk->public.throttled_reqs[0]);
132     qemu_co_queue_init(&blk->public.throttled_reqs[1]);
133 
134     notifier_list_init(&blk->remove_bs_notifiers);
135     notifier_list_init(&blk->insert_bs_notifiers);
136 
137     QTAILQ_INSERT_TAIL(&block_backends, blk, link);
138     return blk;
139 }
140 
141 /*
142  * Creates a new BlockBackend, opens a new BlockDriverState, and connects both.
143  *
144  * Just as with bdrv_open(), after having called this function the reference to
145  * @options belongs to the block layer (even on failure).
146  *
147  * TODO: Remove @filename and @flags; it should be possible to specify a whole
148  * BDS tree just by specifying the @options QDict (or @reference,
149  * alternatively). At the time of adding this function, this is not possible,
150  * though, so callers of this function have to be able to specify @filename and
151  * @flags.
152  */
153 BlockBackend *blk_new_open(const char *filename, const char *reference,
154                            QDict *options, int flags, Error **errp)
155 {
156     BlockBackend *blk;
157     BlockDriverState *bs;
158 
159     blk = blk_new();
160     bs = bdrv_open(filename, reference, options, flags, errp);
161     if (!bs) {
162         blk_unref(blk);
163         return NULL;
164     }
165 
166     blk->root = bdrv_root_attach_child(bs, "root", &child_root, blk);
167 
168     return blk;
169 }
170 
171 static void blk_delete(BlockBackend *blk)
172 {
173     assert(!blk->refcnt);
174     assert(!blk->name);
175     assert(!blk->dev);
176     if (blk->root) {
177         blk_remove_bs(blk);
178     }
179     assert(QLIST_EMPTY(&blk->remove_bs_notifiers.notifiers));
180     assert(QLIST_EMPTY(&blk->insert_bs_notifiers.notifiers));
181     QTAILQ_REMOVE(&block_backends, blk, link);
182     drive_info_del(blk->legacy_dinfo);
183     block_acct_cleanup(&blk->stats);
184     g_free(blk);
185 }
186 
187 static void drive_info_del(DriveInfo *dinfo)
188 {
189     if (!dinfo) {
190         return;
191     }
192     qemu_opts_del(dinfo->opts);
193     g_free(dinfo->serial);
194     g_free(dinfo);
195 }
196 
197 int blk_get_refcnt(BlockBackend *blk)
198 {
199     return blk ? blk->refcnt : 0;
200 }
201 
202 /*
203  * Increment @blk's reference count.
204  * @blk must not be null.
205  */
206 void blk_ref(BlockBackend *blk)
207 {
208     blk->refcnt++;
209 }
210 
211 /*
212  * Decrement @blk's reference count.
213  * If this drops it to zero, destroy @blk.
214  * For convenience, do nothing if @blk is null.
215  */
216 void blk_unref(BlockBackend *blk)
217 {
218     if (blk) {
219         assert(blk->refcnt > 0);
220         if (!--blk->refcnt) {
221             blk_delete(blk);
222         }
223     }
224 }
225 
226 /*
227  * Behaves similarly to blk_next() but iterates over all BlockBackends, even the
228  * ones which are hidden (i.e. are not referenced by the monitor).
229  */
230 static BlockBackend *blk_all_next(BlockBackend *blk)
231 {
232     return blk ? QTAILQ_NEXT(blk, link)
233                : QTAILQ_FIRST(&block_backends);
234 }
235 
236 void blk_remove_all_bs(void)
237 {
238     BlockBackend *blk = NULL;
239 
240     while ((blk = blk_all_next(blk)) != NULL) {
241         AioContext *ctx = blk_get_aio_context(blk);
242 
243         aio_context_acquire(ctx);
244         if (blk->root) {
245             blk_remove_bs(blk);
246         }
247         aio_context_release(ctx);
248     }
249 }
250 
251 /*
252  * Return the monitor-owned BlockBackend after @blk.
253  * If @blk is null, return the first one.
254  * Else, return @blk's next sibling, which may be null.
255  *
256  * To iterate over all BlockBackends, do
257  * for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
258  *     ...
259  * }
260  */
261 BlockBackend *blk_next(BlockBackend *blk)
262 {
263     return blk ? QTAILQ_NEXT(blk, monitor_link)
264                : QTAILQ_FIRST(&monitor_block_backends);
265 }
266 
267 /* Iterates over all top-level BlockDriverStates, i.e. BDSs that are owned by
268  * the monitor or attached to a BlockBackend */
269 BlockDriverState *bdrv_next(BdrvNextIterator *it)
270 {
271     BlockDriverState *bs;
272 
273     /* First, return all root nodes of BlockBackends. In order to avoid
274      * returning a BDS twice when multiple BBs refer to it, we only return it
275      * if the BB is the first one in the parent list of the BDS. */
276     if (it->phase == BDRV_NEXT_BACKEND_ROOTS) {
277         do {
278             it->blk = blk_all_next(it->blk);
279             bs = it->blk ? blk_bs(it->blk) : NULL;
280         } while (it->blk && (bs == NULL || bdrv_first_blk(bs) != it->blk));
281 
282         if (bs) {
283             return bs;
284         }
285         it->phase = BDRV_NEXT_MONITOR_OWNED;
286     }
287 
288     /* Then return the monitor-owned BDSes without a BB attached. Ignore all
289      * BDSes that are attached to a BlockBackend here; they have been handled
290      * by the above block already */
291     do {
292         it->bs = bdrv_next_monitor_owned(it->bs);
293         bs = it->bs;
294     } while (bs && bdrv_has_blk(bs));
295 
296     return bs;
297 }
298 
299 BlockDriverState *bdrv_first(BdrvNextIterator *it)
300 {
301     *it = (BdrvNextIterator) {
302         .phase = BDRV_NEXT_BACKEND_ROOTS,
303     };
304 
305     return bdrv_next(it);
306 }
307 
308 /*
309  * Add a BlockBackend into the list of backends referenced by the monitor, with
310  * the given @name acting as the handle for the monitor.
311  * Strictly for use by blockdev.c.
312  *
313  * @name must not be null or empty.
314  *
315  * Returns true on success and false on failure. In the latter case, an Error
316  * object is returned through @errp.
317  */
318 bool monitor_add_blk(BlockBackend *blk, const char *name, Error **errp)
319 {
320     assert(!blk->name);
321     assert(name && name[0]);
322 
323     if (!id_wellformed(name)) {
324         error_setg(errp, "Invalid device name");
325         return false;
326     }
327     if (blk_by_name(name)) {
328         error_setg(errp, "Device with id '%s' already exists", name);
329         return false;
330     }
331     if (bdrv_find_node(name)) {
332         error_setg(errp,
333                    "Device name '%s' conflicts with an existing node name",
334                    name);
335         return false;
336     }
337 
338     blk->name = g_strdup(name);
339     QTAILQ_INSERT_TAIL(&monitor_block_backends, blk, monitor_link);
340     return true;
341 }
342 
343 /*
344  * Remove a BlockBackend from the list of backends referenced by the monitor.
345  * Strictly for use by blockdev.c.
346  */
347 void monitor_remove_blk(BlockBackend *blk)
348 {
349     if (!blk->name) {
350         return;
351     }
352 
353     QTAILQ_REMOVE(&monitor_block_backends, blk, monitor_link);
354     g_free(blk->name);
355     blk->name = NULL;
356 }
357 
358 /*
359  * Return @blk's name, a non-null string.
360  * Returns an empty string iff @blk is not referenced by the monitor.
361  */
362 const char *blk_name(BlockBackend *blk)
363 {
364     return blk->name ?: "";
365 }
366 
367 /*
368  * Return the BlockBackend with name @name if it exists, else null.
369  * @name must not be null.
370  */
371 BlockBackend *blk_by_name(const char *name)
372 {
373     BlockBackend *blk = NULL;
374 
375     assert(name);
376     while ((blk = blk_next(blk)) != NULL) {
377         if (!strcmp(name, blk->name)) {
378             return blk;
379         }
380     }
381     return NULL;
382 }
383 
384 /*
385  * Return the BlockDriverState attached to @blk if any, else null.
386  */
387 BlockDriverState *blk_bs(BlockBackend *blk)
388 {
389     return blk->root ? blk->root->bs : NULL;
390 }
391 
392 static BlockBackend *bdrv_first_blk(BlockDriverState *bs)
393 {
394     BdrvChild *child;
395     QLIST_FOREACH(child, &bs->parents, next_parent) {
396         if (child->role == &child_root) {
397             return child->opaque;
398         }
399     }
400 
401     return NULL;
402 }
403 
404 /*
405  * Returns true if @bs has an associated BlockBackend.
406  */
407 bool bdrv_has_blk(BlockDriverState *bs)
408 {
409     return bdrv_first_blk(bs) != NULL;
410 }
411 
412 /*
413  * Returns true if @bs has only BlockBackends as parents.
414  */
415 bool bdrv_is_root_node(BlockDriverState *bs)
416 {
417     BdrvChild *c;
418 
419     QLIST_FOREACH(c, &bs->parents, next_parent) {
420         if (c->role != &child_root) {
421             return false;
422         }
423     }
424 
425     return true;
426 }
427 
428 /*
429  * Return @blk's DriveInfo if any, else null.
430  */
431 DriveInfo *blk_legacy_dinfo(BlockBackend *blk)
432 {
433     return blk->legacy_dinfo;
434 }
435 
436 /*
437  * Set @blk's DriveInfo to @dinfo, and return it.
438  * @blk must not have a DriveInfo set already.
439  * No other BlockBackend may have the same DriveInfo set.
440  */
441 DriveInfo *blk_set_legacy_dinfo(BlockBackend *blk, DriveInfo *dinfo)
442 {
443     assert(!blk->legacy_dinfo);
444     return blk->legacy_dinfo = dinfo;
445 }
446 
447 /*
448  * Return the BlockBackend with DriveInfo @dinfo.
449  * It must exist.
450  */
451 BlockBackend *blk_by_legacy_dinfo(DriveInfo *dinfo)
452 {
453     BlockBackend *blk = NULL;
454 
455     while ((blk = blk_next(blk)) != NULL) {
456         if (blk->legacy_dinfo == dinfo) {
457             return blk;
458         }
459     }
460     abort();
461 }
462 
463 /*
464  * Returns a pointer to the publicly accessible fields of @blk.
465  */
466 BlockBackendPublic *blk_get_public(BlockBackend *blk)
467 {
468     return &blk->public;
469 }
470 
471 /*
472  * Returns a BlockBackend given the associated @public fields.
473  */
474 BlockBackend *blk_by_public(BlockBackendPublic *public)
475 {
476     return container_of(public, BlockBackend, public);
477 }
478 
479 /*
480  * Disassociates the currently associated BlockDriverState from @blk.
481  */
482 void blk_remove_bs(BlockBackend *blk)
483 {
484     notifier_list_notify(&blk->remove_bs_notifiers, blk);
485     if (blk->public.throttle_state) {
486         throttle_timers_detach_aio_context(&blk->public.throttle_timers);
487     }
488 
489     blk_update_root_state(blk);
490 
491     bdrv_root_unref_child(blk->root);
492     blk->root = NULL;
493 }
494 
495 /*
496  * Associates a new BlockDriverState with @blk.
497  */
498 void blk_insert_bs(BlockBackend *blk, BlockDriverState *bs)
499 {
500     bdrv_ref(bs);
501     blk->root = bdrv_root_attach_child(bs, "root", &child_root, blk);
502 
503     notifier_list_notify(&blk->insert_bs_notifiers, blk);
504     if (blk->public.throttle_state) {
505         throttle_timers_attach_aio_context(
506             &blk->public.throttle_timers, bdrv_get_aio_context(bs));
507     }
508 }
509 
510 static int blk_do_attach_dev(BlockBackend *blk, void *dev)
511 {
512     if (blk->dev) {
513         return -EBUSY;
514     }
515     blk_ref(blk);
516     blk->dev = dev;
517     blk->legacy_dev = false;
518     blk_iostatus_reset(blk);
519     return 0;
520 }
521 
522 /*
523  * Attach device model @dev to @blk.
524  * Return 0 on success, -EBUSY when a device model is attached already.
525  */
526 int blk_attach_dev(BlockBackend *blk, DeviceState *dev)
527 {
528     return blk_do_attach_dev(blk, dev);
529 }
530 
531 /*
532  * Attach device model @dev to @blk.
533  * @blk must not have a device model attached already.
534  * TODO qdevified devices don't use this, remove when devices are qdevified
535  */
536 void blk_attach_dev_legacy(BlockBackend *blk, void *dev)
537 {
538     if (blk_do_attach_dev(blk, dev) < 0) {
539         abort();
540     }
541     blk->legacy_dev = true;
542 }
543 
544 /*
545  * Detach device model @dev from @blk.
546  * @dev must be currently attached to @blk.
547  */
548 void blk_detach_dev(BlockBackend *blk, void *dev)
549 /* TODO change to DeviceState *dev when all users are qdevified */
550 {
551     assert(blk->dev == dev);
552     blk->dev = NULL;
553     blk->dev_ops = NULL;
554     blk->dev_opaque = NULL;
555     blk->guest_block_size = 512;
556     blk_unref(blk);
557 }
558 
559 /*
560  * Return the device model attached to @blk if any, else null.
561  */
562 void *blk_get_attached_dev(BlockBackend *blk)
563 /* TODO change to return DeviceState * when all users are qdevified */
564 {
565     return blk->dev;
566 }
567 
568 /* Return the qdev ID, or if no ID is assigned the QOM path, of the block
569  * device attached to the BlockBackend. */
570 static char *blk_get_attached_dev_id(BlockBackend *blk)
571 {
572     DeviceState *dev;
573 
574     assert(!blk->legacy_dev);
575     dev = blk->dev;
576 
577     if (!dev) {
578         return g_strdup("");
579     } else if (dev->id) {
580         return g_strdup(dev->id);
581     }
582     return object_get_canonical_path(OBJECT(dev));
583 }
584 
585 /*
586  * Return the BlockBackend which has the device model @dev attached if it
587  * exists, else null.
588  *
589  * @dev must not be null.
590  */
591 BlockBackend *blk_by_dev(void *dev)
592 {
593     BlockBackend *blk = NULL;
594 
595     assert(dev != NULL);
596     while ((blk = blk_all_next(blk)) != NULL) {
597         if (blk->dev == dev) {
598             return blk;
599         }
600     }
601     return NULL;
602 }
603 
604 /*
605  * Set @blk's device model callbacks to @ops.
606  * @opaque is the opaque argument to pass to the callbacks.
607  * This is for use by device models.
608  */
609 void blk_set_dev_ops(BlockBackend *blk, const BlockDevOps *ops,
610                      void *opaque)
611 {
612     /* All drivers that use blk_set_dev_ops() are qdevified and we want to keep
613      * it that way, so we can assume blk->dev is a DeviceState if blk->dev_ops
614      * is set. */
615     assert(!blk->legacy_dev);
616 
617     blk->dev_ops = ops;
618     blk->dev_opaque = opaque;
619 }
620 
621 /*
622  * Notify @blk's attached device model of media change.
623  * If @load is true, notify of media load.
624  * Else, notify of media eject.
625  * Also send DEVICE_TRAY_MOVED events as appropriate.
626  */
627 void blk_dev_change_media_cb(BlockBackend *blk, bool load)
628 {
629     if (blk->dev_ops && blk->dev_ops->change_media_cb) {
630         bool tray_was_open, tray_is_open;
631 
632         assert(!blk->legacy_dev);
633 
634         tray_was_open = blk_dev_is_tray_open(blk);
635         blk->dev_ops->change_media_cb(blk->dev_opaque, load);
636         tray_is_open = blk_dev_is_tray_open(blk);
637 
638         if (tray_was_open != tray_is_open) {
639             char *id = blk_get_attached_dev_id(blk);
640             qapi_event_send_device_tray_moved(blk_name(blk), id, tray_is_open,
641                                               &error_abort);
642             g_free(id);
643         }
644     }
645 }
646 
647 static void blk_root_change_media(BdrvChild *child, bool load)
648 {
649     blk_dev_change_media_cb(child->opaque, load);
650 }
651 
652 /*
653  * Does @blk's attached device model have removable media?
654  * %true if no device model is attached.
655  */
656 bool blk_dev_has_removable_media(BlockBackend *blk)
657 {
658     return !blk->dev || (blk->dev_ops && blk->dev_ops->change_media_cb);
659 }
660 
661 /*
662  * Does @blk's attached device model have a tray?
663  */
664 bool blk_dev_has_tray(BlockBackend *blk)
665 {
666     return blk->dev_ops && blk->dev_ops->is_tray_open;
667 }
668 
669 /*
670  * Notify @blk's attached device model of a media eject request.
671  * If @force is true, the medium is about to be yanked out forcefully.
672  */
673 void blk_dev_eject_request(BlockBackend *blk, bool force)
674 {
675     if (blk->dev_ops && blk->dev_ops->eject_request_cb) {
676         blk->dev_ops->eject_request_cb(blk->dev_opaque, force);
677     }
678 }
679 
680 /*
681  * Does @blk's attached device model have a tray, and is it open?
682  */
683 bool blk_dev_is_tray_open(BlockBackend *blk)
684 {
685     if (blk_dev_has_tray(blk)) {
686         return blk->dev_ops->is_tray_open(blk->dev_opaque);
687     }
688     return false;
689 }
690 
691 /*
692  * Does @blk's attached device model have the medium locked?
693  * %false if the device model has no such lock.
694  */
695 bool blk_dev_is_medium_locked(BlockBackend *blk)
696 {
697     if (blk->dev_ops && blk->dev_ops->is_medium_locked) {
698         return blk->dev_ops->is_medium_locked(blk->dev_opaque);
699     }
700     return false;
701 }
702 
703 /*
704  * Notify @blk's attached device model of a backend size change.
705  */
706 static void blk_root_resize(BdrvChild *child)
707 {
708     BlockBackend *blk = child->opaque;
709 
710     if (blk->dev_ops && blk->dev_ops->resize_cb) {
711         blk->dev_ops->resize_cb(blk->dev_opaque);
712     }
713 }
714 
715 void blk_iostatus_enable(BlockBackend *blk)
716 {
717     blk->iostatus_enabled = true;
718     blk->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
719 }
720 
721 /* The I/O status is only enabled if the drive explicitly
722  * enables it _and_ the VM is configured to stop on errors */
723 bool blk_iostatus_is_enabled(const BlockBackend *blk)
724 {
725     return (blk->iostatus_enabled &&
726            (blk->on_write_error == BLOCKDEV_ON_ERROR_ENOSPC ||
727             blk->on_write_error == BLOCKDEV_ON_ERROR_STOP   ||
728             blk->on_read_error == BLOCKDEV_ON_ERROR_STOP));
729 }
730 
731 BlockDeviceIoStatus blk_iostatus(const BlockBackend *blk)
732 {
733     return blk->iostatus;
734 }
735 
736 void blk_iostatus_disable(BlockBackend *blk)
737 {
738     blk->iostatus_enabled = false;
739 }
740 
741 void blk_iostatus_reset(BlockBackend *blk)
742 {
743     if (blk_iostatus_is_enabled(blk)) {
744         BlockDriverState *bs = blk_bs(blk);
745         blk->iostatus = BLOCK_DEVICE_IO_STATUS_OK;
746         if (bs && bs->job) {
747             block_job_iostatus_reset(bs->job);
748         }
749     }
750 }
751 
752 void blk_iostatus_set_err(BlockBackend *blk, int error)
753 {
754     assert(blk_iostatus_is_enabled(blk));
755     if (blk->iostatus == BLOCK_DEVICE_IO_STATUS_OK) {
756         blk->iostatus = error == ENOSPC ? BLOCK_DEVICE_IO_STATUS_NOSPACE :
757                                           BLOCK_DEVICE_IO_STATUS_FAILED;
758     }
759 }
760 
761 void blk_set_allow_write_beyond_eof(BlockBackend *blk, bool allow)
762 {
763     blk->allow_write_beyond_eof = allow;
764 }
765 
766 static int blk_check_byte_request(BlockBackend *blk, int64_t offset,
767                                   size_t size)
768 {
769     int64_t len;
770 
771     if (size > INT_MAX) {
772         return -EIO;
773     }
774 
775     if (!blk_is_available(blk)) {
776         return -ENOMEDIUM;
777     }
778 
779     if (offset < 0) {
780         return -EIO;
781     }
782 
783     if (!blk->allow_write_beyond_eof) {
784         len = blk_getlength(blk);
785         if (len < 0) {
786             return len;
787         }
788 
789         if (offset > len || len - offset < size) {
790             return -EIO;
791         }
792     }
793 
794     return 0;
795 }
796 
797 int coroutine_fn blk_co_preadv(BlockBackend *blk, int64_t offset,
798                                unsigned int bytes, QEMUIOVector *qiov,
799                                BdrvRequestFlags flags)
800 {
801     int ret;
802     BlockDriverState *bs = blk_bs(blk);
803 
804     trace_blk_co_preadv(blk, bs, offset, bytes, flags);
805 
806     ret = blk_check_byte_request(blk, offset, bytes);
807     if (ret < 0) {
808         return ret;
809     }
810 
811     bdrv_inc_in_flight(bs);
812 
813     /* throttling disk I/O */
814     if (blk->public.throttle_state) {
815         throttle_group_co_io_limits_intercept(blk, bytes, false);
816     }
817 
818     ret = bdrv_co_preadv(blk->root, offset, bytes, qiov, flags);
819     bdrv_dec_in_flight(bs);
820     return ret;
821 }
822 
823 int coroutine_fn blk_co_pwritev(BlockBackend *blk, int64_t offset,
824                                 unsigned int bytes, QEMUIOVector *qiov,
825                                 BdrvRequestFlags flags)
826 {
827     int ret;
828     BlockDriverState *bs = blk_bs(blk);
829 
830     trace_blk_co_pwritev(blk, bs, offset, bytes, flags);
831 
832     ret = blk_check_byte_request(blk, offset, bytes);
833     if (ret < 0) {
834         return ret;
835     }
836 
837     bdrv_inc_in_flight(bs);
838 
839     /* throttling disk I/O */
840     if (blk->public.throttle_state) {
841         throttle_group_co_io_limits_intercept(blk, bytes, true);
842     }
843 
844     if (!blk->enable_write_cache) {
845         flags |= BDRV_REQ_FUA;
846     }
847 
848     ret = bdrv_co_pwritev(blk->root, offset, bytes, qiov, flags);
849     bdrv_dec_in_flight(bs);
850     return ret;
851 }
852 
853 typedef struct BlkRwCo {
854     BlockBackend *blk;
855     int64_t offset;
856     QEMUIOVector *qiov;
857     int ret;
858     BdrvRequestFlags flags;
859 } BlkRwCo;
860 
861 static void blk_read_entry(void *opaque)
862 {
863     BlkRwCo *rwco = opaque;
864 
865     rwco->ret = blk_co_preadv(rwco->blk, rwco->offset, rwco->qiov->size,
866                               rwco->qiov, rwco->flags);
867 }
868 
869 static void blk_write_entry(void *opaque)
870 {
871     BlkRwCo *rwco = opaque;
872 
873     rwco->ret = blk_co_pwritev(rwco->blk, rwco->offset, rwco->qiov->size,
874                                rwco->qiov, rwco->flags);
875 }
876 
877 static int blk_prw(BlockBackend *blk, int64_t offset, uint8_t *buf,
878                    int64_t bytes, CoroutineEntry co_entry,
879                    BdrvRequestFlags flags)
880 {
881     QEMUIOVector qiov;
882     struct iovec iov;
883     BlkRwCo rwco;
884 
885     iov = (struct iovec) {
886         .iov_base = buf,
887         .iov_len = bytes,
888     };
889     qemu_iovec_init_external(&qiov, &iov, 1);
890 
891     rwco = (BlkRwCo) {
892         .blk    = blk,
893         .offset = offset,
894         .qiov   = &qiov,
895         .flags  = flags,
896         .ret    = NOT_DONE,
897     };
898 
899     if (qemu_in_coroutine()) {
900         /* Fast-path if already in coroutine context */
901         co_entry(&rwco);
902     } else {
903         Coroutine *co = qemu_coroutine_create(co_entry, &rwco);
904         qemu_coroutine_enter(co);
905         BDRV_POLL_WHILE(blk_bs(blk), rwco.ret == NOT_DONE);
906     }
907 
908     return rwco.ret;
909 }
910 
911 int blk_pread_unthrottled(BlockBackend *blk, int64_t offset, uint8_t *buf,
912                           int count)
913 {
914     int ret;
915 
916     ret = blk_check_byte_request(blk, offset, count);
917     if (ret < 0) {
918         return ret;
919     }
920 
921     blk_root_drained_begin(blk->root);
922     ret = blk_pread(blk, offset, buf, count);
923     blk_root_drained_end(blk->root);
924     return ret;
925 }
926 
927 int blk_pwrite_zeroes(BlockBackend *blk, int64_t offset,
928                       int count, BdrvRequestFlags flags)
929 {
930     return blk_prw(blk, offset, NULL, count, blk_write_entry,
931                    flags | BDRV_REQ_ZERO_WRITE);
932 }
933 
934 int blk_make_zero(BlockBackend *blk, BdrvRequestFlags flags)
935 {
936     return bdrv_make_zero(blk->root, flags);
937 }
938 
939 static void error_callback_bh(void *opaque)
940 {
941     struct BlockBackendAIOCB *acb = opaque;
942 
943     bdrv_dec_in_flight(acb->common.bs);
944     acb->common.cb(acb->common.opaque, acb->ret);
945     qemu_aio_unref(acb);
946 }
947 
948 BlockAIOCB *blk_abort_aio_request(BlockBackend *blk,
949                                   BlockCompletionFunc *cb,
950                                   void *opaque, int ret)
951 {
952     struct BlockBackendAIOCB *acb;
953 
954     bdrv_inc_in_flight(blk_bs(blk));
955     acb = blk_aio_get(&block_backend_aiocb_info, blk, cb, opaque);
956     acb->blk = blk;
957     acb->ret = ret;
958 
959     aio_bh_schedule_oneshot(blk_get_aio_context(blk), error_callback_bh, acb);
960     return &acb->common;
961 }
962 
963 typedef struct BlkAioEmAIOCB {
964     BlockAIOCB common;
965     BlkRwCo rwco;
966     int bytes;
967     bool has_returned;
968 } BlkAioEmAIOCB;
969 
970 static const AIOCBInfo blk_aio_em_aiocb_info = {
971     .aiocb_size         = sizeof(BlkAioEmAIOCB),
972 };
973 
974 static void blk_aio_complete(BlkAioEmAIOCB *acb)
975 {
976     if (acb->has_returned) {
977         bdrv_dec_in_flight(acb->common.bs);
978         acb->common.cb(acb->common.opaque, acb->rwco.ret);
979         qemu_aio_unref(acb);
980     }
981 }
982 
983 static void blk_aio_complete_bh(void *opaque)
984 {
985     BlkAioEmAIOCB *acb = opaque;
986     assert(acb->has_returned);
987     blk_aio_complete(acb);
988 }
989 
990 static BlockAIOCB *blk_aio_prwv(BlockBackend *blk, int64_t offset, int bytes,
991                                 QEMUIOVector *qiov, CoroutineEntry co_entry,
992                                 BdrvRequestFlags flags,
993                                 BlockCompletionFunc *cb, void *opaque)
994 {
995     BlkAioEmAIOCB *acb;
996     Coroutine *co;
997 
998     bdrv_inc_in_flight(blk_bs(blk));
999     acb = blk_aio_get(&blk_aio_em_aiocb_info, blk, cb, opaque);
1000     acb->rwco = (BlkRwCo) {
1001         .blk    = blk,
1002         .offset = offset,
1003         .qiov   = qiov,
1004         .flags  = flags,
1005         .ret    = NOT_DONE,
1006     };
1007     acb->bytes = bytes;
1008     acb->has_returned = false;
1009 
1010     co = qemu_coroutine_create(co_entry, acb);
1011     qemu_coroutine_enter(co);
1012 
1013     acb->has_returned = true;
1014     if (acb->rwco.ret != NOT_DONE) {
1015         aio_bh_schedule_oneshot(blk_get_aio_context(blk),
1016                                 blk_aio_complete_bh, acb);
1017     }
1018 
1019     return &acb->common;
1020 }
1021 
1022 static void blk_aio_read_entry(void *opaque)
1023 {
1024     BlkAioEmAIOCB *acb = opaque;
1025     BlkRwCo *rwco = &acb->rwco;
1026 
1027     assert(rwco->qiov->size == acb->bytes);
1028     rwco->ret = blk_co_preadv(rwco->blk, rwco->offset, acb->bytes,
1029                               rwco->qiov, rwco->flags);
1030     blk_aio_complete(acb);
1031 }
1032 
1033 static void blk_aio_write_entry(void *opaque)
1034 {
1035     BlkAioEmAIOCB *acb = opaque;
1036     BlkRwCo *rwco = &acb->rwco;
1037 
1038     assert(!rwco->qiov || rwco->qiov->size == acb->bytes);
1039     rwco->ret = blk_co_pwritev(rwco->blk, rwco->offset, acb->bytes,
1040                                rwco->qiov, rwco->flags);
1041     blk_aio_complete(acb);
1042 }
1043 
1044 BlockAIOCB *blk_aio_pwrite_zeroes(BlockBackend *blk, int64_t offset,
1045                                   int count, BdrvRequestFlags flags,
1046                                   BlockCompletionFunc *cb, void *opaque)
1047 {
1048     return blk_aio_prwv(blk, offset, count, NULL, blk_aio_write_entry,
1049                         flags | BDRV_REQ_ZERO_WRITE, cb, opaque);
1050 }
1051 
1052 int blk_pread(BlockBackend *blk, int64_t offset, void *buf, int count)
1053 {
1054     int ret = blk_prw(blk, offset, buf, count, blk_read_entry, 0);
1055     if (ret < 0) {
1056         return ret;
1057     }
1058     return count;
1059 }
1060 
1061 int blk_pwrite(BlockBackend *blk, int64_t offset, const void *buf, int count,
1062                BdrvRequestFlags flags)
1063 {
1064     int ret = blk_prw(blk, offset, (void *) buf, count, blk_write_entry,
1065                       flags);
1066     if (ret < 0) {
1067         return ret;
1068     }
1069     return count;
1070 }
1071 
1072 int64_t blk_getlength(BlockBackend *blk)
1073 {
1074     if (!blk_is_available(blk)) {
1075         return -ENOMEDIUM;
1076     }
1077 
1078     return bdrv_getlength(blk_bs(blk));
1079 }
1080 
1081 void blk_get_geometry(BlockBackend *blk, uint64_t *nb_sectors_ptr)
1082 {
1083     if (!blk_bs(blk)) {
1084         *nb_sectors_ptr = 0;
1085     } else {
1086         bdrv_get_geometry(blk_bs(blk), nb_sectors_ptr);
1087     }
1088 }
1089 
1090 int64_t blk_nb_sectors(BlockBackend *blk)
1091 {
1092     if (!blk_is_available(blk)) {
1093         return -ENOMEDIUM;
1094     }
1095 
1096     return bdrv_nb_sectors(blk_bs(blk));
1097 }
1098 
1099 BlockAIOCB *blk_aio_preadv(BlockBackend *blk, int64_t offset,
1100                            QEMUIOVector *qiov, BdrvRequestFlags flags,
1101                            BlockCompletionFunc *cb, void *opaque)
1102 {
1103     return blk_aio_prwv(blk, offset, qiov->size, qiov,
1104                         blk_aio_read_entry, flags, cb, opaque);
1105 }
1106 
1107 BlockAIOCB *blk_aio_pwritev(BlockBackend *blk, int64_t offset,
1108                             QEMUIOVector *qiov, BdrvRequestFlags flags,
1109                             BlockCompletionFunc *cb, void *opaque)
1110 {
1111     return blk_aio_prwv(blk, offset, qiov->size, qiov,
1112                         blk_aio_write_entry, flags, cb, opaque);
1113 }
1114 
1115 static void blk_aio_flush_entry(void *opaque)
1116 {
1117     BlkAioEmAIOCB *acb = opaque;
1118     BlkRwCo *rwco = &acb->rwco;
1119 
1120     rwco->ret = blk_co_flush(rwco->blk);
1121     blk_aio_complete(acb);
1122 }
1123 
1124 BlockAIOCB *blk_aio_flush(BlockBackend *blk,
1125                           BlockCompletionFunc *cb, void *opaque)
1126 {
1127     return blk_aio_prwv(blk, 0, 0, NULL, blk_aio_flush_entry, 0, cb, opaque);
1128 }
1129 
1130 static void blk_aio_pdiscard_entry(void *opaque)
1131 {
1132     BlkAioEmAIOCB *acb = opaque;
1133     BlkRwCo *rwco = &acb->rwco;
1134 
1135     rwco->ret = blk_co_pdiscard(rwco->blk, rwco->offset, acb->bytes);
1136     blk_aio_complete(acb);
1137 }
1138 
1139 BlockAIOCB *blk_aio_pdiscard(BlockBackend *blk,
1140                              int64_t offset, int count,
1141                              BlockCompletionFunc *cb, void *opaque)
1142 {
1143     return blk_aio_prwv(blk, offset, count, NULL, blk_aio_pdiscard_entry, 0,
1144                         cb, opaque);
1145 }
1146 
1147 void blk_aio_cancel(BlockAIOCB *acb)
1148 {
1149     bdrv_aio_cancel(acb);
1150 }
1151 
1152 void blk_aio_cancel_async(BlockAIOCB *acb)
1153 {
1154     bdrv_aio_cancel_async(acb);
1155 }
1156 
1157 int blk_co_ioctl(BlockBackend *blk, unsigned long int req, void *buf)
1158 {
1159     if (!blk_is_available(blk)) {
1160         return -ENOMEDIUM;
1161     }
1162 
1163     return bdrv_co_ioctl(blk_bs(blk), req, buf);
1164 }
1165 
1166 static void blk_ioctl_entry(void *opaque)
1167 {
1168     BlkRwCo *rwco = opaque;
1169     rwco->ret = blk_co_ioctl(rwco->blk, rwco->offset,
1170                              rwco->qiov->iov[0].iov_base);
1171 }
1172 
1173 int blk_ioctl(BlockBackend *blk, unsigned long int req, void *buf)
1174 {
1175     return blk_prw(blk, req, buf, 0, blk_ioctl_entry, 0);
1176 }
1177 
1178 static void blk_aio_ioctl_entry(void *opaque)
1179 {
1180     BlkAioEmAIOCB *acb = opaque;
1181     BlkRwCo *rwco = &acb->rwco;
1182 
1183     rwco->ret = blk_co_ioctl(rwco->blk, rwco->offset,
1184                              rwco->qiov->iov[0].iov_base);
1185     blk_aio_complete(acb);
1186 }
1187 
1188 BlockAIOCB *blk_aio_ioctl(BlockBackend *blk, unsigned long int req, void *buf,
1189                           BlockCompletionFunc *cb, void *opaque)
1190 {
1191     QEMUIOVector qiov;
1192     struct iovec iov;
1193 
1194     iov = (struct iovec) {
1195         .iov_base = buf,
1196         .iov_len = 0,
1197     };
1198     qemu_iovec_init_external(&qiov, &iov, 1);
1199 
1200     return blk_aio_prwv(blk, req, 0, &qiov, blk_aio_ioctl_entry, 0, cb, opaque);
1201 }
1202 
1203 int blk_co_pdiscard(BlockBackend *blk, int64_t offset, int count)
1204 {
1205     int ret = blk_check_byte_request(blk, offset, count);
1206     if (ret < 0) {
1207         return ret;
1208     }
1209 
1210     return bdrv_co_pdiscard(blk_bs(blk), offset, count);
1211 }
1212 
1213 int blk_co_flush(BlockBackend *blk)
1214 {
1215     if (!blk_is_available(blk)) {
1216         return -ENOMEDIUM;
1217     }
1218 
1219     return bdrv_co_flush(blk_bs(blk));
1220 }
1221 
1222 static void blk_flush_entry(void *opaque)
1223 {
1224     BlkRwCo *rwco = opaque;
1225     rwco->ret = blk_co_flush(rwco->blk);
1226 }
1227 
1228 int blk_flush(BlockBackend *blk)
1229 {
1230     return blk_prw(blk, 0, NULL, 0, blk_flush_entry, 0);
1231 }
1232 
1233 void blk_drain(BlockBackend *blk)
1234 {
1235     if (blk_bs(blk)) {
1236         bdrv_drain(blk_bs(blk));
1237     }
1238 }
1239 
1240 void blk_drain_all(void)
1241 {
1242     bdrv_drain_all();
1243 }
1244 
1245 void blk_set_on_error(BlockBackend *blk, BlockdevOnError on_read_error,
1246                       BlockdevOnError on_write_error)
1247 {
1248     blk->on_read_error = on_read_error;
1249     blk->on_write_error = on_write_error;
1250 }
1251 
1252 BlockdevOnError blk_get_on_error(BlockBackend *blk, bool is_read)
1253 {
1254     return is_read ? blk->on_read_error : blk->on_write_error;
1255 }
1256 
1257 BlockErrorAction blk_get_error_action(BlockBackend *blk, bool is_read,
1258                                       int error)
1259 {
1260     BlockdevOnError on_err = blk_get_on_error(blk, is_read);
1261 
1262     switch (on_err) {
1263     case BLOCKDEV_ON_ERROR_ENOSPC:
1264         return (error == ENOSPC) ?
1265                BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT;
1266     case BLOCKDEV_ON_ERROR_STOP:
1267         return BLOCK_ERROR_ACTION_STOP;
1268     case BLOCKDEV_ON_ERROR_REPORT:
1269         return BLOCK_ERROR_ACTION_REPORT;
1270     case BLOCKDEV_ON_ERROR_IGNORE:
1271         return BLOCK_ERROR_ACTION_IGNORE;
1272     case BLOCKDEV_ON_ERROR_AUTO:
1273     default:
1274         abort();
1275     }
1276 }
1277 
1278 static void send_qmp_error_event(BlockBackend *blk,
1279                                  BlockErrorAction action,
1280                                  bool is_read, int error)
1281 {
1282     IoOperationType optype;
1283 
1284     optype = is_read ? IO_OPERATION_TYPE_READ : IO_OPERATION_TYPE_WRITE;
1285     qapi_event_send_block_io_error(blk_name(blk),
1286                                    bdrv_get_node_name(blk_bs(blk)), optype,
1287                                    action, blk_iostatus_is_enabled(blk),
1288                                    error == ENOSPC, strerror(error),
1289                                    &error_abort);
1290 }
1291 
1292 /* This is done by device models because, while the block layer knows
1293  * about the error, it does not know whether an operation comes from
1294  * the device or the block layer (from a job, for example).
1295  */
1296 void blk_error_action(BlockBackend *blk, BlockErrorAction action,
1297                       bool is_read, int error)
1298 {
1299     assert(error >= 0);
1300 
1301     if (action == BLOCK_ERROR_ACTION_STOP) {
1302         /* First set the iostatus, so that "info block" returns an iostatus
1303          * that matches the events raised so far (an additional error iostatus
1304          * is fine, but not a lost one).
1305          */
1306         blk_iostatus_set_err(blk, error);
1307 
1308         /* Then raise the request to stop the VM and the event.
1309          * qemu_system_vmstop_request_prepare has two effects.  First,
1310          * it ensures that the STOP event always comes after the
1311          * BLOCK_IO_ERROR event.  Second, it ensures that even if management
1312          * can observe the STOP event and do a "cont" before the STOP
1313          * event is issued, the VM will not stop.  In this case, vm_start()
1314          * also ensures that the STOP/RESUME pair of events is emitted.
1315          */
1316         qemu_system_vmstop_request_prepare();
1317         send_qmp_error_event(blk, action, is_read, error);
1318         qemu_system_vmstop_request(RUN_STATE_IO_ERROR);
1319     } else {
1320         send_qmp_error_event(blk, action, is_read, error);
1321     }
1322 }
1323 
1324 int blk_is_read_only(BlockBackend *blk)
1325 {
1326     BlockDriverState *bs = blk_bs(blk);
1327 
1328     if (bs) {
1329         return bdrv_is_read_only(bs);
1330     } else {
1331         return blk->root_state.read_only;
1332     }
1333 }
1334 
1335 int blk_is_sg(BlockBackend *blk)
1336 {
1337     BlockDriverState *bs = blk_bs(blk);
1338 
1339     if (!bs) {
1340         return 0;
1341     }
1342 
1343     return bdrv_is_sg(bs);
1344 }
1345 
1346 int blk_enable_write_cache(BlockBackend *blk)
1347 {
1348     return blk->enable_write_cache;
1349 }
1350 
1351 void blk_set_enable_write_cache(BlockBackend *blk, bool wce)
1352 {
1353     blk->enable_write_cache = wce;
1354 }
1355 
1356 void blk_invalidate_cache(BlockBackend *blk, Error **errp)
1357 {
1358     BlockDriverState *bs = blk_bs(blk);
1359 
1360     if (!bs) {
1361         error_setg(errp, "Device '%s' has no medium", blk->name);
1362         return;
1363     }
1364 
1365     bdrv_invalidate_cache(bs, errp);
1366 }
1367 
1368 bool blk_is_inserted(BlockBackend *blk)
1369 {
1370     BlockDriverState *bs = blk_bs(blk);
1371 
1372     return bs && bdrv_is_inserted(bs);
1373 }
1374 
1375 bool blk_is_available(BlockBackend *blk)
1376 {
1377     return blk_is_inserted(blk) && !blk_dev_is_tray_open(blk);
1378 }
1379 
1380 void blk_lock_medium(BlockBackend *blk, bool locked)
1381 {
1382     BlockDriverState *bs = blk_bs(blk);
1383 
1384     if (bs) {
1385         bdrv_lock_medium(bs, locked);
1386     }
1387 }
1388 
1389 void blk_eject(BlockBackend *blk, bool eject_flag)
1390 {
1391     BlockDriverState *bs = blk_bs(blk);
1392     char *id;
1393 
1394     /* blk_eject is only called by qdevified devices */
1395     assert(!blk->legacy_dev);
1396 
1397     if (bs) {
1398         bdrv_eject(bs, eject_flag);
1399     }
1400 
1401     /* Whether or not we ejected on the backend,
1402      * the frontend experienced a tray event. */
1403     id = blk_get_attached_dev_id(blk);
1404     qapi_event_send_device_tray_moved(blk_name(blk), id,
1405                                       eject_flag, &error_abort);
1406     g_free(id);
1407 }
1408 
1409 int blk_get_flags(BlockBackend *blk)
1410 {
1411     BlockDriverState *bs = blk_bs(blk);
1412 
1413     if (bs) {
1414         return bdrv_get_flags(bs);
1415     } else {
1416         return blk->root_state.open_flags;
1417     }
1418 }
1419 
1420 /* Returns the maximum transfer length, in bytes; guaranteed nonzero */
1421 uint32_t blk_get_max_transfer(BlockBackend *blk)
1422 {
1423     BlockDriverState *bs = blk_bs(blk);
1424     uint32_t max = 0;
1425 
1426     if (bs) {
1427         max = bs->bl.max_transfer;
1428     }
1429     return MIN_NON_ZERO(max, INT_MAX);
1430 }
1431 
1432 int blk_get_max_iov(BlockBackend *blk)
1433 {
1434     return blk->root->bs->bl.max_iov;
1435 }
1436 
1437 void blk_set_guest_block_size(BlockBackend *blk, int align)
1438 {
1439     blk->guest_block_size = align;
1440 }
1441 
1442 void *blk_try_blockalign(BlockBackend *blk, size_t size)
1443 {
1444     return qemu_try_blockalign(blk ? blk_bs(blk) : NULL, size);
1445 }
1446 
1447 void *blk_blockalign(BlockBackend *blk, size_t size)
1448 {
1449     return qemu_blockalign(blk ? blk_bs(blk) : NULL, size);
1450 }
1451 
1452 bool blk_op_is_blocked(BlockBackend *blk, BlockOpType op, Error **errp)
1453 {
1454     BlockDriverState *bs = blk_bs(blk);
1455 
1456     if (!bs) {
1457         return false;
1458     }
1459 
1460     return bdrv_op_is_blocked(bs, op, errp);
1461 }
1462 
1463 void blk_op_unblock(BlockBackend *blk, BlockOpType op, Error *reason)
1464 {
1465     BlockDriverState *bs = blk_bs(blk);
1466 
1467     if (bs) {
1468         bdrv_op_unblock(bs, op, reason);
1469     }
1470 }
1471 
1472 void blk_op_block_all(BlockBackend *blk, Error *reason)
1473 {
1474     BlockDriverState *bs = blk_bs(blk);
1475 
1476     if (bs) {
1477         bdrv_op_block_all(bs, reason);
1478     }
1479 }
1480 
1481 void blk_op_unblock_all(BlockBackend *blk, Error *reason)
1482 {
1483     BlockDriverState *bs = blk_bs(blk);
1484 
1485     if (bs) {
1486         bdrv_op_unblock_all(bs, reason);
1487     }
1488 }
1489 
1490 AioContext *blk_get_aio_context(BlockBackend *blk)
1491 {
1492     BlockDriverState *bs = blk_bs(blk);
1493 
1494     if (bs) {
1495         return bdrv_get_aio_context(bs);
1496     } else {
1497         return qemu_get_aio_context();
1498     }
1499 }
1500 
1501 static AioContext *blk_aiocb_get_aio_context(BlockAIOCB *acb)
1502 {
1503     BlockBackendAIOCB *blk_acb = DO_UPCAST(BlockBackendAIOCB, common, acb);
1504     return blk_get_aio_context(blk_acb->blk);
1505 }
1506 
1507 void blk_set_aio_context(BlockBackend *blk, AioContext *new_context)
1508 {
1509     BlockDriverState *bs = blk_bs(blk);
1510 
1511     if (bs) {
1512         if (blk->public.throttle_state) {
1513             throttle_timers_detach_aio_context(&blk->public.throttle_timers);
1514         }
1515         bdrv_set_aio_context(bs, new_context);
1516         if (blk->public.throttle_state) {
1517             throttle_timers_attach_aio_context(&blk->public.throttle_timers,
1518                                                new_context);
1519         }
1520     }
1521 }
1522 
1523 void blk_add_aio_context_notifier(BlockBackend *blk,
1524         void (*attached_aio_context)(AioContext *new_context, void *opaque),
1525         void (*detach_aio_context)(void *opaque), void *opaque)
1526 {
1527     BlockDriverState *bs = blk_bs(blk);
1528 
1529     if (bs) {
1530         bdrv_add_aio_context_notifier(bs, attached_aio_context,
1531                                       detach_aio_context, opaque);
1532     }
1533 }
1534 
1535 void blk_remove_aio_context_notifier(BlockBackend *blk,
1536                                      void (*attached_aio_context)(AioContext *,
1537                                                                   void *),
1538                                      void (*detach_aio_context)(void *),
1539                                      void *opaque)
1540 {
1541     BlockDriverState *bs = blk_bs(blk);
1542 
1543     if (bs) {
1544         bdrv_remove_aio_context_notifier(bs, attached_aio_context,
1545                                          detach_aio_context, opaque);
1546     }
1547 }
1548 
1549 void blk_add_remove_bs_notifier(BlockBackend *blk, Notifier *notify)
1550 {
1551     notifier_list_add(&blk->remove_bs_notifiers, notify);
1552 }
1553 
1554 void blk_add_insert_bs_notifier(BlockBackend *blk, Notifier *notify)
1555 {
1556     notifier_list_add(&blk->insert_bs_notifiers, notify);
1557 }
1558 
1559 void blk_io_plug(BlockBackend *blk)
1560 {
1561     BlockDriverState *bs = blk_bs(blk);
1562 
1563     if (bs) {
1564         bdrv_io_plug(bs);
1565     }
1566 }
1567 
1568 void blk_io_unplug(BlockBackend *blk)
1569 {
1570     BlockDriverState *bs = blk_bs(blk);
1571 
1572     if (bs) {
1573         bdrv_io_unplug(bs);
1574     }
1575 }
1576 
1577 BlockAcctStats *blk_get_stats(BlockBackend *blk)
1578 {
1579     return &blk->stats;
1580 }
1581 
1582 void *blk_aio_get(const AIOCBInfo *aiocb_info, BlockBackend *blk,
1583                   BlockCompletionFunc *cb, void *opaque)
1584 {
1585     return qemu_aio_get(aiocb_info, blk_bs(blk), cb, opaque);
1586 }
1587 
1588 int coroutine_fn blk_co_pwrite_zeroes(BlockBackend *blk, int64_t offset,
1589                                       int count, BdrvRequestFlags flags)
1590 {
1591     return blk_co_pwritev(blk, offset, count, NULL,
1592                           flags | BDRV_REQ_ZERO_WRITE);
1593 }
1594 
1595 int blk_pwrite_compressed(BlockBackend *blk, int64_t offset, const void *buf,
1596                           int count)
1597 {
1598     return blk_prw(blk, offset, (void *) buf, count, blk_write_entry,
1599                    BDRV_REQ_WRITE_COMPRESSED);
1600 }
1601 
1602 int blk_truncate(BlockBackend *blk, int64_t offset)
1603 {
1604     if (!blk_is_available(blk)) {
1605         return -ENOMEDIUM;
1606     }
1607 
1608     return bdrv_truncate(blk->root, offset);
1609 }
1610 
1611 static void blk_pdiscard_entry(void *opaque)
1612 {
1613     BlkRwCo *rwco = opaque;
1614     rwco->ret = blk_co_pdiscard(rwco->blk, rwco->offset, rwco->qiov->size);
1615 }
1616 
1617 int blk_pdiscard(BlockBackend *blk, int64_t offset, int count)
1618 {
1619     return blk_prw(blk, offset, NULL, count, blk_pdiscard_entry, 0);
1620 }
1621 
1622 int blk_save_vmstate(BlockBackend *blk, const uint8_t *buf,
1623                      int64_t pos, int size)
1624 {
1625     int ret;
1626 
1627     if (!blk_is_available(blk)) {
1628         return -ENOMEDIUM;
1629     }
1630 
1631     ret = bdrv_save_vmstate(blk_bs(blk), buf, pos, size);
1632     if (ret < 0) {
1633         return ret;
1634     }
1635 
1636     if (ret == size && !blk->enable_write_cache) {
1637         ret = bdrv_flush(blk_bs(blk));
1638     }
1639 
1640     return ret < 0 ? ret : size;
1641 }
1642 
1643 int blk_load_vmstate(BlockBackend *blk, uint8_t *buf, int64_t pos, int size)
1644 {
1645     if (!blk_is_available(blk)) {
1646         return -ENOMEDIUM;
1647     }
1648 
1649     return bdrv_load_vmstate(blk_bs(blk), buf, pos, size);
1650 }
1651 
1652 int blk_probe_blocksizes(BlockBackend *blk, BlockSizes *bsz)
1653 {
1654     if (!blk_is_available(blk)) {
1655         return -ENOMEDIUM;
1656     }
1657 
1658     return bdrv_probe_blocksizes(blk_bs(blk), bsz);
1659 }
1660 
1661 int blk_probe_geometry(BlockBackend *blk, HDGeometry *geo)
1662 {
1663     if (!blk_is_available(blk)) {
1664         return -ENOMEDIUM;
1665     }
1666 
1667     return bdrv_probe_geometry(blk_bs(blk), geo);
1668 }
1669 
1670 /*
1671  * Updates the BlockBackendRootState object with data from the currently
1672  * attached BlockDriverState.
1673  */
1674 void blk_update_root_state(BlockBackend *blk)
1675 {
1676     assert(blk->root);
1677 
1678     blk->root_state.open_flags    = blk->root->bs->open_flags;
1679     blk->root_state.read_only     = blk->root->bs->read_only;
1680     blk->root_state.detect_zeroes = blk->root->bs->detect_zeroes;
1681 }
1682 
1683 /*
1684  * Returns the detect-zeroes setting to be used for bdrv_open() of a
1685  * BlockDriverState which is supposed to inherit the root state.
1686  */
1687 bool blk_get_detect_zeroes_from_root_state(BlockBackend *blk)
1688 {
1689     return blk->root_state.detect_zeroes;
1690 }
1691 
1692 /*
1693  * Returns the flags to be used for bdrv_open() of a BlockDriverState which is
1694  * supposed to inherit the root state.
1695  */
1696 int blk_get_open_flags_from_root_state(BlockBackend *blk)
1697 {
1698     int bs_flags;
1699 
1700     bs_flags = blk->root_state.read_only ? 0 : BDRV_O_RDWR;
1701     bs_flags |= blk->root_state.open_flags & ~BDRV_O_RDWR;
1702 
1703     return bs_flags;
1704 }
1705 
1706 BlockBackendRootState *blk_get_root_state(BlockBackend *blk)
1707 {
1708     return &blk->root_state;
1709 }
1710 
1711 int blk_commit_all(void)
1712 {
1713     BlockBackend *blk = NULL;
1714 
1715     while ((blk = blk_all_next(blk)) != NULL) {
1716         AioContext *aio_context = blk_get_aio_context(blk);
1717 
1718         aio_context_acquire(aio_context);
1719         if (blk_is_inserted(blk) && blk->root->bs->backing) {
1720             int ret = bdrv_commit(blk->root->bs);
1721             if (ret < 0) {
1722                 aio_context_release(aio_context);
1723                 return ret;
1724             }
1725         }
1726         aio_context_release(aio_context);
1727     }
1728     return 0;
1729 }
1730 
1731 
1732 /* throttling disk I/O limits */
1733 void blk_set_io_limits(BlockBackend *blk, ThrottleConfig *cfg)
1734 {
1735     throttle_group_config(blk, cfg);
1736 }
1737 
1738 void blk_io_limits_disable(BlockBackend *blk)
1739 {
1740     assert(blk->public.throttle_state);
1741     bdrv_drained_begin(blk_bs(blk));
1742     throttle_group_unregister_blk(blk);
1743     bdrv_drained_end(blk_bs(blk));
1744 }
1745 
1746 /* should be called before blk_set_io_limits if a limit is set */
1747 void blk_io_limits_enable(BlockBackend *blk, const char *group)
1748 {
1749     assert(!blk->public.throttle_state);
1750     throttle_group_register_blk(blk, group);
1751 }
1752 
1753 void blk_io_limits_update_group(BlockBackend *blk, const char *group)
1754 {
1755     /* this BB is not part of any group */
1756     if (!blk->public.throttle_state) {
1757         return;
1758     }
1759 
1760     /* this BB is a part of the same group than the one we want */
1761     if (!g_strcmp0(throttle_group_get_name(blk), group)) {
1762         return;
1763     }
1764 
1765     /* need to change the group this bs belong to */
1766     blk_io_limits_disable(blk);
1767     blk_io_limits_enable(blk, group);
1768 }
1769 
1770 static void blk_root_drained_begin(BdrvChild *child)
1771 {
1772     BlockBackend *blk = child->opaque;
1773 
1774     /* Note that blk->root may not be accessible here yet if we are just
1775      * attaching to a BlockDriverState that is drained. Use child instead. */
1776 
1777     if (blk->public.io_limits_disabled++ == 0) {
1778         throttle_group_restart_blk(blk);
1779     }
1780 }
1781 
1782 static void blk_root_drained_end(BdrvChild *child)
1783 {
1784     BlockBackend *blk = child->opaque;
1785 
1786     assert(blk->public.io_limits_disabled);
1787     --blk->public.io_limits_disabled;
1788 }
1789