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