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