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