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