]> git.proxmox.com Git - mirror_qemu.git/blame - block/block-backend.c
ahci-test: test atapi read_cd with bcl, nb_sectors = 0
[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 801 int ret;
99723548 802 BlockDriverState *bs = blk_bs(blk);
1e98fefd 803
99723548 804 trace_blk_co_preadv(blk, bs, offset, bytes, flags);
1e98fefd
KW
805
806 ret = blk_check_byte_request(blk, offset, bytes);
e7f7d676
HR
807 if (ret < 0) {
808 return ret;
809 }
810
99723548
PB
811 bdrv_inc_in_flight(bs);
812
441565b2
KW
813 /* throttling disk I/O */
814 if (blk->public.throttle_state) {
815 throttle_group_co_io_limits_intercept(blk, bytes, false);
816 }
817
99723548
PB
818 ret = bdrv_co_preadv(blk->root, offset, bytes, qiov, flags);
819 bdrv_dec_in_flight(bs);
820 return ret;
1bf1cbc9
KW
821}
822
1e98fefd
KW
823int coroutine_fn blk_co_pwritev(BlockBackend *blk, int64_t offset,
824 unsigned int bytes, QEMUIOVector *qiov,
825 BdrvRequestFlags flags)
a8823a3b 826{
bfd18d1e 827 int ret;
99723548 828 BlockDriverState *bs = blk_bs(blk);
bfd18d1e 829
99723548 830 trace_blk_co_pwritev(blk, bs, offset, bytes, flags);
1e98fefd 831
bfd18d1e 832 ret = blk_check_byte_request(blk, offset, bytes);
a8823a3b
KW
833 if (ret < 0) {
834 return ret;
835 }
836
99723548
PB
837 bdrv_inc_in_flight(bs);
838
441565b2
KW
839 /* throttling disk I/O */
840 if (blk->public.throttle_state) {
841 throttle_group_co_io_limits_intercept(blk, bytes, true);
842 }
843
bfd18d1e
KW
844 if (!blk->enable_write_cache) {
845 flags |= BDRV_REQ_FUA;
846 }
847
99723548
PB
848 ret = bdrv_co_pwritev(blk->root, offset, bytes, qiov, flags);
849 bdrv_dec_in_flight(bs);
850 return ret;
a8823a3b
KW
851}
852
1bf1cbc9
KW
853typedef struct BlkRwCo {
854 BlockBackend *blk;
855 int64_t offset;
856 QEMUIOVector *qiov;
857 int ret;
858 BdrvRequestFlags flags;
859} BlkRwCo;
860
861static void blk_read_entry(void *opaque)
862{
863 BlkRwCo *rwco = opaque;
864
865 rwco->ret = blk_co_preadv(rwco->blk, rwco->offset, rwco->qiov->size,
866 rwco->qiov, rwco->flags);
867}
868
a8823a3b
KW
869static void blk_write_entry(void *opaque)
870{
871 BlkRwCo *rwco = opaque;
872
873 rwco->ret = blk_co_pwritev(rwco->blk, rwco->offset, rwco->qiov->size,
874 rwco->qiov, rwco->flags);
875}
876
a55d3fba
KW
877static int blk_prw(BlockBackend *blk, int64_t offset, uint8_t *buf,
878 int64_t bytes, CoroutineEntry co_entry,
879 BdrvRequestFlags flags)
1bf1cbc9 880{
1bf1cbc9
KW
881 QEMUIOVector qiov;
882 struct iovec iov;
883 Coroutine *co;
884 BlkRwCo rwco;
885
1bf1cbc9
KW
886 iov = (struct iovec) {
887 .iov_base = buf,
a55d3fba 888 .iov_len = bytes,
1bf1cbc9
KW
889 };
890 qemu_iovec_init_external(&qiov, &iov, 1);
891
892 rwco = (BlkRwCo) {
893 .blk = blk,
a55d3fba 894 .offset = offset,
1bf1cbc9 895 .qiov = &qiov,
fc1453cd 896 .flags = flags,
1bf1cbc9
KW
897 .ret = NOT_DONE,
898 };
899
0b8b8753
PB
900 co = qemu_coroutine_create(co_entry, &rwco);
901 qemu_coroutine_enter(co);
88b062c2 902 BDRV_POLL_WHILE(blk_bs(blk), rwco.ret == NOT_DONE);
1bf1cbc9
KW
903
904 return rwco.ret;
4be74634
MA
905}
906
b7d17f9f
EB
907int blk_pread_unthrottled(BlockBackend *blk, int64_t offset, uint8_t *buf,
908 int count)
4be74634 909{
5bd51196
KW
910 int ret;
911
b7d17f9f 912 ret = blk_check_byte_request(blk, offset, count);
e7f7d676
HR
913 if (ret < 0) {
914 return ret;
915 }
916
c2066af0 917 blk_root_drained_begin(blk->root);
b7d17f9f 918 ret = blk_pread(blk, offset, buf, count);
c2066af0 919 blk_root_drained_end(blk->root);
5bd51196 920 return ret;
4be74634
MA
921}
922
d004bd52
EB
923int blk_pwrite_zeroes(BlockBackend *blk, int64_t offset,
924 int count, BdrvRequestFlags flags)
0df89e8e 925{
983a1600
EB
926 return blk_prw(blk, offset, NULL, count, blk_write_entry,
927 flags | BDRV_REQ_ZERO_WRITE);
0df89e8e
KW
928}
929
720ff280
KW
930int blk_make_zero(BlockBackend *blk, BdrvRequestFlags flags)
931{
932 return bdrv_make_zero(blk->root, flags);
933}
934
e7f7d676
HR
935static void error_callback_bh(void *opaque)
936{
937 struct BlockBackendAIOCB *acb = opaque;
99723548
PB
938
939 bdrv_dec_in_flight(acb->common.bs);
e7f7d676
HR
940 acb->common.cb(acb->common.opaque, acb->ret);
941 qemu_aio_unref(acb);
942}
943
ca78ecfa
PL
944BlockAIOCB *blk_abort_aio_request(BlockBackend *blk,
945 BlockCompletionFunc *cb,
946 void *opaque, int ret)
e7f7d676
HR
947{
948 struct BlockBackendAIOCB *acb;
e7f7d676 949
99723548 950 bdrv_inc_in_flight(blk_bs(blk));
e7f7d676 951 acb = blk_aio_get(&block_backend_aiocb_info, blk, cb, opaque);
4981bdec 952 acb->blk = blk;
e7f7d676
HR
953 acb->ret = ret;
954
fffb6e12 955 aio_bh_schedule_oneshot(blk_get_aio_context(blk), error_callback_bh, acb);
e7f7d676
HR
956 return &acb->common;
957}
958
57d6a428
KW
959typedef struct BlkAioEmAIOCB {
960 BlockAIOCB common;
961 BlkRwCo rwco;
7fa84cd8 962 int bytes;
57d6a428 963 bool has_returned;
57d6a428
KW
964} BlkAioEmAIOCB;
965
966static const AIOCBInfo blk_aio_em_aiocb_info = {
967 .aiocb_size = sizeof(BlkAioEmAIOCB),
968};
969
970static void blk_aio_complete(BlkAioEmAIOCB *acb)
971{
57d6a428 972 if (acb->has_returned) {
99723548 973 bdrv_dec_in_flight(acb->common.bs);
57d6a428
KW
974 acb->common.cb(acb->common.opaque, acb->rwco.ret);
975 qemu_aio_unref(acb);
976 }
977}
978
979static void blk_aio_complete_bh(void *opaque)
980{
fffb6e12
PB
981 BlkAioEmAIOCB *acb = opaque;
982
983 assert(acb->has_returned);
984 blk_aio_complete(acb);
57d6a428
KW
985}
986
7fa84cd8 987static BlockAIOCB *blk_aio_prwv(BlockBackend *blk, int64_t offset, int bytes,
57d6a428
KW
988 QEMUIOVector *qiov, CoroutineEntry co_entry,
989 BdrvRequestFlags flags,
990 BlockCompletionFunc *cb, void *opaque)
991{
992 BlkAioEmAIOCB *acb;
993 Coroutine *co;
994
99723548 995 bdrv_inc_in_flight(blk_bs(blk));
57d6a428
KW
996 acb = blk_aio_get(&blk_aio_em_aiocb_info, blk, cb, opaque);
997 acb->rwco = (BlkRwCo) {
998 .blk = blk,
999 .offset = offset,
1000 .qiov = qiov,
1001 .flags = flags,
1002 .ret = NOT_DONE,
1003 };
7fa84cd8 1004 acb->bytes = bytes;
57d6a428
KW
1005 acb->has_returned = false;
1006
0b8b8753
PB
1007 co = qemu_coroutine_create(co_entry, acb);
1008 qemu_coroutine_enter(co);
57d6a428
KW
1009
1010 acb->has_returned = true;
1011 if (acb->rwco.ret != NOT_DONE) {
fffb6e12
PB
1012 aio_bh_schedule_oneshot(blk_get_aio_context(blk),
1013 blk_aio_complete_bh, acb);
57d6a428
KW
1014 }
1015
1016 return &acb->common;
1017}
1018
1019static void blk_aio_read_entry(void *opaque)
1020{
1021 BlkAioEmAIOCB *acb = opaque;
1022 BlkRwCo *rwco = &acb->rwco;
1023
7fa84cd8
KW
1024 assert(rwco->qiov->size == acb->bytes);
1025 rwco->ret = blk_co_preadv(rwco->blk, rwco->offset, acb->bytes,
57d6a428
KW
1026 rwco->qiov, rwco->flags);
1027 blk_aio_complete(acb);
1028}
1029
1030static void blk_aio_write_entry(void *opaque)
1031{
1032 BlkAioEmAIOCB *acb = opaque;
1033 BlkRwCo *rwco = &acb->rwco;
1034
7fa84cd8
KW
1035 assert(!rwco->qiov || rwco->qiov->size == acb->bytes);
1036 rwco->ret = blk_co_pwritev(rwco->blk, rwco->offset, acb->bytes,
57d6a428
KW
1037 rwco->qiov, rwco->flags);
1038 blk_aio_complete(acb);
1039}
1040
d004bd52
EB
1041BlockAIOCB *blk_aio_pwrite_zeroes(BlockBackend *blk, int64_t offset,
1042 int count, BdrvRequestFlags flags,
1043 BlockCompletionFunc *cb, void *opaque)
4be74634 1044{
983a1600
EB
1045 return blk_aio_prwv(blk, offset, count, NULL, blk_aio_write_entry,
1046 flags | BDRV_REQ_ZERO_WRITE, cb, opaque);
4be74634
MA
1047}
1048
1049int blk_pread(BlockBackend *blk, int64_t offset, void *buf, int count)
1050{
a55d3fba 1051 int ret = blk_prw(blk, offset, buf, count, blk_read_entry, 0);
e7f7d676
HR
1052 if (ret < 0) {
1053 return ret;
1054 }
a55d3fba 1055 return count;
4be74634
MA
1056}
1057
8341f00d
EB
1058int blk_pwrite(BlockBackend *blk, int64_t offset, const void *buf, int count,
1059 BdrvRequestFlags flags)
4be74634 1060{
8341f00d
EB
1061 int ret = blk_prw(blk, offset, (void *) buf, count, blk_write_entry,
1062 flags);
e7f7d676
HR
1063 if (ret < 0) {
1064 return ret;
1065 }
a55d3fba 1066 return count;
4be74634
MA
1067}
1068
1069int64_t blk_getlength(BlockBackend *blk)
1070{
c09ba36c
HR
1071 if (!blk_is_available(blk)) {
1072 return -ENOMEDIUM;
1073 }
1074
f21d96d0 1075 return bdrv_getlength(blk_bs(blk));
4be74634
MA
1076}
1077
1078void blk_get_geometry(BlockBackend *blk, uint64_t *nb_sectors_ptr)
1079{
f21d96d0 1080 if (!blk_bs(blk)) {
a46fc9c9
HR
1081 *nb_sectors_ptr = 0;
1082 } else {
f21d96d0 1083 bdrv_get_geometry(blk_bs(blk), nb_sectors_ptr);
a46fc9c9 1084 }
4be74634
MA
1085}
1086
1ef01253
HR
1087int64_t blk_nb_sectors(BlockBackend *blk)
1088{
c09ba36c
HR
1089 if (!blk_is_available(blk)) {
1090 return -ENOMEDIUM;
1091 }
1092
f21d96d0 1093 return bdrv_nb_sectors(blk_bs(blk));
1ef01253
HR
1094}
1095
60cb2fa7
EB
1096BlockAIOCB *blk_aio_preadv(BlockBackend *blk, int64_t offset,
1097 QEMUIOVector *qiov, BdrvRequestFlags flags,
1098 BlockCompletionFunc *cb, void *opaque)
1099{
1100 return blk_aio_prwv(blk, offset, qiov->size, qiov,
1101 blk_aio_read_entry, flags, cb, opaque);
1102}
1103
60cb2fa7
EB
1104BlockAIOCB *blk_aio_pwritev(BlockBackend *blk, int64_t offset,
1105 QEMUIOVector *qiov, BdrvRequestFlags flags,
1106 BlockCompletionFunc *cb, void *opaque)
1107{
1108 return blk_aio_prwv(blk, offset, qiov->size, qiov,
1109 blk_aio_write_entry, flags, cb, opaque);
1110}
1111
be07a889
KW
1112static void blk_aio_flush_entry(void *opaque)
1113{
1114 BlkAioEmAIOCB *acb = opaque;
1115 BlkRwCo *rwco = &acb->rwco;
1116
1117 rwco->ret = blk_co_flush(rwco->blk);
1118 blk_aio_complete(acb);
1119}
1120
4be74634
MA
1121BlockAIOCB *blk_aio_flush(BlockBackend *blk,
1122 BlockCompletionFunc *cb, void *opaque)
1123{
be07a889 1124 return blk_aio_prwv(blk, 0, 0, NULL, blk_aio_flush_entry, 0, cb, opaque);
4be74634
MA
1125}
1126
8c2e3dd5
KW
1127static void blk_aio_pdiscard_entry(void *opaque)
1128{
1129 BlkAioEmAIOCB *acb = opaque;
1130 BlkRwCo *rwco = &acb->rwco;
1131
1132 rwco->ret = blk_co_pdiscard(rwco->blk, rwco->offset, acb->bytes);
1133 blk_aio_complete(acb);
1134}
1135
1c6c4bb7
EB
1136BlockAIOCB *blk_aio_pdiscard(BlockBackend *blk,
1137 int64_t offset, int count,
1138 BlockCompletionFunc *cb, void *opaque)
4be74634 1139{
8c2e3dd5
KW
1140 return blk_aio_prwv(blk, offset, count, NULL, blk_aio_pdiscard_entry, 0,
1141 cb, opaque);
4be74634
MA
1142}
1143
1144void blk_aio_cancel(BlockAIOCB *acb)
1145{
1146 bdrv_aio_cancel(acb);
1147}
1148
1149void blk_aio_cancel_async(BlockAIOCB *acb)
1150{
1151 bdrv_aio_cancel_async(acb);
1152}
1153
48af776a 1154int blk_co_ioctl(BlockBackend *blk, unsigned long int req, void *buf)
4be74634 1155{
c09ba36c
HR
1156 if (!blk_is_available(blk)) {
1157 return -ENOMEDIUM;
1158 }
1159
48af776a
KW
1160 return bdrv_co_ioctl(blk_bs(blk), req, buf);
1161}
1162
1163static void blk_ioctl_entry(void *opaque)
1164{
1165 BlkRwCo *rwco = opaque;
1166 rwco->ret = blk_co_ioctl(rwco->blk, rwco->offset,
1167 rwco->qiov->iov[0].iov_base);
1168}
1169
1170int blk_ioctl(BlockBackend *blk, unsigned long int req, void *buf)
1171{
1172 return blk_prw(blk, req, buf, 0, blk_ioctl_entry, 0);
1173}
1174
1175static void blk_aio_ioctl_entry(void *opaque)
1176{
1177 BlkAioEmAIOCB *acb = opaque;
1178 BlkRwCo *rwco = &acb->rwco;
1179
1180 rwco->ret = blk_co_ioctl(rwco->blk, rwco->offset,
1181 rwco->qiov->iov[0].iov_base);
1182 blk_aio_complete(acb);
4be74634
MA
1183}
1184
1185BlockAIOCB *blk_aio_ioctl(BlockBackend *blk, unsigned long int req, void *buf,
1186 BlockCompletionFunc *cb, void *opaque)
1187{
48af776a
KW
1188 QEMUIOVector qiov;
1189 struct iovec iov;
1190
1191 iov = (struct iovec) {
1192 .iov_base = buf,
1193 .iov_len = 0,
1194 };
1195 qemu_iovec_init_external(&qiov, &iov, 1);
c09ba36c 1196
48af776a 1197 return blk_aio_prwv(blk, req, 0, &qiov, blk_aio_ioctl_entry, 0, cb, opaque);
4be74634
MA
1198}
1199
1c6c4bb7 1200int blk_co_pdiscard(BlockBackend *blk, int64_t offset, int count)
2bb0dce7 1201{
1c6c4bb7 1202 int ret = blk_check_byte_request(blk, offset, count);
e7f7d676
HR
1203 if (ret < 0) {
1204 return ret;
1205 }
1206
1c6c4bb7 1207 return bdrv_co_pdiscard(blk_bs(blk), offset, count);
2bb0dce7
HR
1208}
1209
1210int blk_co_flush(BlockBackend *blk)
1211{
c09ba36c
HR
1212 if (!blk_is_available(blk)) {
1213 return -ENOMEDIUM;
1214 }
1215
f21d96d0 1216 return bdrv_co_flush(blk_bs(blk));
2bb0dce7
HR
1217}
1218
be07a889 1219static void blk_flush_entry(void *opaque)
4be74634 1220{
be07a889
KW
1221 BlkRwCo *rwco = opaque;
1222 rwco->ret = blk_co_flush(rwco->blk);
1223}
c09ba36c 1224
be07a889
KW
1225int blk_flush(BlockBackend *blk)
1226{
1227 return blk_prw(blk, 0, NULL, 0, blk_flush_entry, 0);
4be74634
MA
1228}
1229
97b0385a
AY
1230void blk_drain(BlockBackend *blk)
1231{
f21d96d0
KW
1232 if (blk_bs(blk)) {
1233 bdrv_drain(blk_bs(blk));
a46fc9c9 1234 }
97b0385a
AY
1235}
1236
4be74634
MA
1237void blk_drain_all(void)
1238{
1239 bdrv_drain_all();
1240}
1241
373340b2
HR
1242void blk_set_on_error(BlockBackend *blk, BlockdevOnError on_read_error,
1243 BlockdevOnError on_write_error)
1244{
1245 blk->on_read_error = on_read_error;
1246 blk->on_write_error = on_write_error;
1247}
1248
4be74634
MA
1249BlockdevOnError blk_get_on_error(BlockBackend *blk, bool is_read)
1250{
373340b2 1251 return is_read ? blk->on_read_error : blk->on_write_error;
4be74634
MA
1252}
1253
1254BlockErrorAction blk_get_error_action(BlockBackend *blk, bool is_read,
1255 int error)
1256{
373340b2
HR
1257 BlockdevOnError on_err = blk_get_on_error(blk, is_read);
1258
1259 switch (on_err) {
1260 case BLOCKDEV_ON_ERROR_ENOSPC:
1261 return (error == ENOSPC) ?
1262 BLOCK_ERROR_ACTION_STOP : BLOCK_ERROR_ACTION_REPORT;
1263 case BLOCKDEV_ON_ERROR_STOP:
1264 return BLOCK_ERROR_ACTION_STOP;
1265 case BLOCKDEV_ON_ERROR_REPORT:
1266 return BLOCK_ERROR_ACTION_REPORT;
1267 case BLOCKDEV_ON_ERROR_IGNORE:
1268 return BLOCK_ERROR_ACTION_IGNORE;
8c398252 1269 case BLOCKDEV_ON_ERROR_AUTO:
373340b2
HR
1270 default:
1271 abort();
1272 }
4be74634
MA
1273}
1274
373340b2
HR
1275static void send_qmp_error_event(BlockBackend *blk,
1276 BlockErrorAction action,
1277 bool is_read, int error)
1278{
1279 IoOperationType optype;
1280
1281 optype = is_read ? IO_OPERATION_TYPE_READ : IO_OPERATION_TYPE_WRITE;
2bf7e10f
KW
1282 qapi_event_send_block_io_error(blk_name(blk),
1283 bdrv_get_node_name(blk_bs(blk)), optype,
1284 action, blk_iostatus_is_enabled(blk),
373340b2
HR
1285 error == ENOSPC, strerror(error),
1286 &error_abort);
1287}
1288
1289/* This is done by device models because, while the block layer knows
1290 * about the error, it does not know whether an operation comes from
1291 * the device or the block layer (from a job, for example).
1292 */
4be74634
MA
1293void blk_error_action(BlockBackend *blk, BlockErrorAction action,
1294 bool is_read, int error)
1295{
373340b2
HR
1296 assert(error >= 0);
1297
1298 if (action == BLOCK_ERROR_ACTION_STOP) {
1299 /* First set the iostatus, so that "info block" returns an iostatus
1300 * that matches the events raised so far (an additional error iostatus
1301 * is fine, but not a lost one).
1302 */
1303 blk_iostatus_set_err(blk, error);
1304
1305 /* Then raise the request to stop the VM and the event.
1306 * qemu_system_vmstop_request_prepare has two effects. First,
1307 * it ensures that the STOP event always comes after the
1308 * BLOCK_IO_ERROR event. Second, it ensures that even if management
1309 * can observe the STOP event and do a "cont" before the STOP
1310 * event is issued, the VM will not stop. In this case, vm_start()
1311 * also ensures that the STOP/RESUME pair of events is emitted.
1312 */
1313 qemu_system_vmstop_request_prepare();
1314 send_qmp_error_event(blk, action, is_read, error);
1315 qemu_system_vmstop_request(RUN_STATE_IO_ERROR);
1316 } else {
1317 send_qmp_error_event(blk, action, is_read, error);
1318 }
4be74634
MA
1319}
1320
1321int blk_is_read_only(BlockBackend *blk)
1322{
f21d96d0
KW
1323 BlockDriverState *bs = blk_bs(blk);
1324
1325 if (bs) {
1326 return bdrv_is_read_only(bs);
061959e8
HR
1327 } else {
1328 return blk->root_state.read_only;
1329 }
4be74634
MA
1330}
1331
1332int blk_is_sg(BlockBackend *blk)
1333{
f21d96d0
KW
1334 BlockDriverState *bs = blk_bs(blk);
1335
1336 if (!bs) {
a46fc9c9
HR
1337 return 0;
1338 }
1339
f21d96d0 1340 return bdrv_is_sg(bs);
4be74634
MA
1341}
1342
1343int blk_enable_write_cache(BlockBackend *blk)
1344{
bfd18d1e 1345 return blk->enable_write_cache;
4be74634
MA
1346}
1347
1348void blk_set_enable_write_cache(BlockBackend *blk, bool wce)
1349{
bfd18d1e 1350 blk->enable_write_cache = wce;
4be74634
MA
1351}
1352
2bb0dce7
HR
1353void blk_invalidate_cache(BlockBackend *blk, Error **errp)
1354{
f21d96d0
KW
1355 BlockDriverState *bs = blk_bs(blk);
1356
1357 if (!bs) {
c09ba36c
HR
1358 error_setg(errp, "Device '%s' has no medium", blk->name);
1359 return;
1360 }
1361
f21d96d0 1362 bdrv_invalidate_cache(bs, errp);
2bb0dce7
HR
1363}
1364
e031f750 1365bool blk_is_inserted(BlockBackend *blk)
4be74634 1366{
f21d96d0
KW
1367 BlockDriverState *bs = blk_bs(blk);
1368
1369 return bs && bdrv_is_inserted(bs);
db0284f8
HR
1370}
1371
1372bool blk_is_available(BlockBackend *blk)
1373{
1374 return blk_is_inserted(blk) && !blk_dev_is_tray_open(blk);
4be74634
MA
1375}
1376
1377void blk_lock_medium(BlockBackend *blk, bool locked)
1378{
f21d96d0
KW
1379 BlockDriverState *bs = blk_bs(blk);
1380
1381 if (bs) {
1382 bdrv_lock_medium(bs, locked);
a46fc9c9 1383 }
4be74634
MA
1384}
1385
1386void blk_eject(BlockBackend *blk, bool eject_flag)
1387{
f21d96d0 1388 BlockDriverState *bs = blk_bs(blk);
2d76e724
KW
1389 char *id;
1390
1391 /* blk_eject is only called by qdevified devices */
1392 assert(!blk->legacy_dev);
f21d96d0
KW
1393
1394 if (bs) {
1395 bdrv_eject(bs, eject_flag);
2d76e724
KW
1396
1397 id = blk_get_attached_dev_id(blk);
1398 qapi_event_send_device_tray_moved(blk_name(blk), id,
1399 eject_flag, &error_abort);
1400 g_free(id);
1401
a46fc9c9 1402 }
4be74634
MA
1403}
1404
1405int blk_get_flags(BlockBackend *blk)
1406{
f21d96d0
KW
1407 BlockDriverState *bs = blk_bs(blk);
1408
1409 if (bs) {
1410 return bdrv_get_flags(bs);
061959e8
HR
1411 } else {
1412 return blk->root_state.open_flags;
1413 }
4be74634
MA
1414}
1415
5def6b80
EB
1416/* Returns the maximum transfer length, in bytes; guaranteed nonzero */
1417uint32_t blk_get_max_transfer(BlockBackend *blk)
454057b7 1418{
f21d96d0 1419 BlockDriverState *bs = blk_bs(blk);
5def6b80 1420 uint32_t max = 0;
f21d96d0
KW
1421
1422 if (bs) {
5def6b80 1423 max = bs->bl.max_transfer;
a46fc9c9 1424 }
5def6b80 1425 return MIN_NON_ZERO(max, INT_MAX);
454057b7
PL
1426}
1427
648296e0
SH
1428int blk_get_max_iov(BlockBackend *blk)
1429{
f21d96d0 1430 return blk->root->bs->bl.max_iov;
648296e0
SH
1431}
1432
4be74634
MA
1433void blk_set_guest_block_size(BlockBackend *blk, int align)
1434{
68e9ec01 1435 blk->guest_block_size = align;
4be74634
MA
1436}
1437
f1c17521
PB
1438void *blk_try_blockalign(BlockBackend *blk, size_t size)
1439{
f21d96d0 1440 return qemu_try_blockalign(blk ? blk_bs(blk) : NULL, size);
f1c17521
PB
1441}
1442
4be74634
MA
1443void *blk_blockalign(BlockBackend *blk, size_t size)
1444{
f21d96d0 1445 return qemu_blockalign(blk ? blk_bs(blk) : NULL, size);
4be74634
MA
1446}
1447
1448bool blk_op_is_blocked(BlockBackend *blk, BlockOpType op, Error **errp)
1449{
f21d96d0
KW
1450 BlockDriverState *bs = blk_bs(blk);
1451
1452 if (!bs) {
a46fc9c9
HR
1453 return false;
1454 }
1455
f21d96d0 1456 return bdrv_op_is_blocked(bs, op, errp);
4be74634
MA
1457}
1458
1459void blk_op_unblock(BlockBackend *blk, BlockOpType op, Error *reason)
1460{
f21d96d0
KW
1461 BlockDriverState *bs = blk_bs(blk);
1462
1463 if (bs) {
1464 bdrv_op_unblock(bs, op, reason);
a46fc9c9 1465 }
4be74634
MA
1466}
1467
1468void blk_op_block_all(BlockBackend *blk, Error *reason)
1469{
f21d96d0
KW
1470 BlockDriverState *bs = blk_bs(blk);
1471
1472 if (bs) {
1473 bdrv_op_block_all(bs, reason);
a46fc9c9 1474 }
4be74634
MA
1475}
1476
1477void blk_op_unblock_all(BlockBackend *blk, Error *reason)
1478{
f21d96d0
KW
1479 BlockDriverState *bs = blk_bs(blk);
1480
1481 if (bs) {
1482 bdrv_op_unblock_all(bs, reason);
a46fc9c9 1483 }
4be74634
MA
1484}
1485
1486AioContext *blk_get_aio_context(BlockBackend *blk)
1487{
f21d96d0
KW
1488 BlockDriverState *bs = blk_bs(blk);
1489
1490 if (bs) {
1491 return bdrv_get_aio_context(bs);
4981bdec
HR
1492 } else {
1493 return qemu_get_aio_context();
1494 }
1495}
1496
1497static AioContext *blk_aiocb_get_aio_context(BlockAIOCB *acb)
1498{
1499 BlockBackendAIOCB *blk_acb = DO_UPCAST(BlockBackendAIOCB, common, acb);
1500 return blk_get_aio_context(blk_acb->blk);
4be74634
MA
1501}
1502
1503void blk_set_aio_context(BlockBackend *blk, AioContext *new_context)
1504{
f21d96d0
KW
1505 BlockDriverState *bs = blk_bs(blk);
1506
1507 if (bs) {
7ca7f0f6
KW
1508 if (blk->public.throttle_state) {
1509 throttle_timers_detach_aio_context(&blk->public.throttle_timers);
1510 }
f21d96d0 1511 bdrv_set_aio_context(bs, new_context);
7ca7f0f6
KW
1512 if (blk->public.throttle_state) {
1513 throttle_timers_attach_aio_context(&blk->public.throttle_timers,
1514 new_context);
1515 }
a46fc9c9 1516 }
4be74634
MA
1517}
1518
2019ba0a
HR
1519void blk_add_aio_context_notifier(BlockBackend *blk,
1520 void (*attached_aio_context)(AioContext *new_context, void *opaque),
1521 void (*detach_aio_context)(void *opaque), void *opaque)
1522{
f21d96d0
KW
1523 BlockDriverState *bs = blk_bs(blk);
1524
1525 if (bs) {
1526 bdrv_add_aio_context_notifier(bs, attached_aio_context,
a46fc9c9
HR
1527 detach_aio_context, opaque);
1528 }
2019ba0a
HR
1529}
1530
1531void blk_remove_aio_context_notifier(BlockBackend *blk,
1532 void (*attached_aio_context)(AioContext *,
1533 void *),
1534 void (*detach_aio_context)(void *),
1535 void *opaque)
1536{
f21d96d0
KW
1537 BlockDriverState *bs = blk_bs(blk);
1538
1539 if (bs) {
1540 bdrv_remove_aio_context_notifier(bs, attached_aio_context,
a46fc9c9
HR
1541 detach_aio_context, opaque);
1542 }
2019ba0a
HR
1543}
1544
3301f6c6
HR
1545void blk_add_remove_bs_notifier(BlockBackend *blk, Notifier *notify)
1546{
1547 notifier_list_add(&blk->remove_bs_notifiers, notify);
1548}
1549
1550void blk_add_insert_bs_notifier(BlockBackend *blk, Notifier *notify)
1551{
1552 notifier_list_add(&blk->insert_bs_notifiers, notify);
1553}
1554
4be74634
MA
1555void blk_io_plug(BlockBackend *blk)
1556{
f21d96d0
KW
1557 BlockDriverState *bs = blk_bs(blk);
1558
1559 if (bs) {
1560 bdrv_io_plug(bs);
a46fc9c9 1561 }
4be74634
MA
1562}
1563
1564void blk_io_unplug(BlockBackend *blk)
1565{
f21d96d0
KW
1566 BlockDriverState *bs = blk_bs(blk);
1567
1568 if (bs) {
1569 bdrv_io_unplug(bs);
a46fc9c9 1570 }
4be74634
MA
1571}
1572
1573BlockAcctStats *blk_get_stats(BlockBackend *blk)
1574{
7f0e9da6 1575 return &blk->stats;
4be74634
MA
1576}
1577
1578void *blk_aio_get(const AIOCBInfo *aiocb_info, BlockBackend *blk,
1579 BlockCompletionFunc *cb, void *opaque)
1580{
1581 return qemu_aio_get(aiocb_info, blk_bs(blk), cb, opaque);
1582}
1ef01253 1583
d004bd52
EB
1584int coroutine_fn blk_co_pwrite_zeroes(BlockBackend *blk, int64_t offset,
1585 int count, BdrvRequestFlags flags)
1ef01253 1586{
983a1600 1587 return blk_co_pwritev(blk, offset, count, NULL,
16aaf975 1588 flags | BDRV_REQ_ZERO_WRITE);
1ef01253
HR
1589}
1590
fe5c1355
PB
1591int blk_pwrite_compressed(BlockBackend *blk, int64_t offset, const void *buf,
1592 int count)
1ef01253 1593{
35fadca8
PB
1594 return blk_prw(blk, offset, (void *) buf, count, blk_write_entry,
1595 BDRV_REQ_WRITE_COMPRESSED);
1ef01253
HR
1596}
1597
1598int blk_truncate(BlockBackend *blk, int64_t offset)
1599{
c09ba36c
HR
1600 if (!blk_is_available(blk)) {
1601 return -ENOMEDIUM;
1602 }
1603
f21d96d0 1604 return bdrv_truncate(blk_bs(blk), offset);
1ef01253
HR
1605}
1606
8c2e3dd5 1607static void blk_pdiscard_entry(void *opaque)
1ef01253 1608{
8c2e3dd5
KW
1609 BlkRwCo *rwco = opaque;
1610 rwco->ret = blk_co_pdiscard(rwco->blk, rwco->offset, rwco->qiov->size);
1611}
e7f7d676 1612
8c2e3dd5
KW
1613int blk_pdiscard(BlockBackend *blk, int64_t offset, int count)
1614{
1615 return blk_prw(blk, offset, NULL, count, blk_pdiscard_entry, 0);
1ef01253
HR
1616}
1617
1618int blk_save_vmstate(BlockBackend *blk, const uint8_t *buf,
1619 int64_t pos, int size)
1620{
bfd18d1e
KW
1621 int ret;
1622
c09ba36c
HR
1623 if (!blk_is_available(blk)) {
1624 return -ENOMEDIUM;
1625 }
1626
bfd18d1e
KW
1627 ret = bdrv_save_vmstate(blk_bs(blk), buf, pos, size);
1628 if (ret < 0) {
1629 return ret;
1630 }
1631
1632 if (ret == size && !blk->enable_write_cache) {
1633 ret = bdrv_flush(blk_bs(blk));
1634 }
1635
1636 return ret < 0 ? ret : size;
1ef01253
HR
1637}
1638
1639int blk_load_vmstate(BlockBackend *blk, uint8_t *buf, int64_t pos, int size)
1640{
c09ba36c
HR
1641 if (!blk_is_available(blk)) {
1642 return -ENOMEDIUM;
1643 }
1644
f21d96d0 1645 return bdrv_load_vmstate(blk_bs(blk), buf, pos, size);
1ef01253 1646}
f0272c4d
ET
1647
1648int blk_probe_blocksizes(BlockBackend *blk, BlockSizes *bsz)
1649{
c09ba36c
HR
1650 if (!blk_is_available(blk)) {
1651 return -ENOMEDIUM;
1652 }
1653
f21d96d0 1654 return bdrv_probe_blocksizes(blk_bs(blk), bsz);
f0272c4d
ET
1655}
1656
1657int blk_probe_geometry(BlockBackend *blk, HDGeometry *geo)
1658{
c09ba36c
HR
1659 if (!blk_is_available(blk)) {
1660 return -ENOMEDIUM;
1661 }
1662
f21d96d0 1663 return bdrv_probe_geometry(blk_bs(blk), geo);
f0272c4d 1664}
281d22d8
HR
1665
1666/*
1667 * Updates the BlockBackendRootState object with data from the currently
1668 * attached BlockDriverState.
1669 */
1670void blk_update_root_state(BlockBackend *blk)
1671{
f21d96d0 1672 assert(blk->root);
281d22d8 1673
f21d96d0
KW
1674 blk->root_state.open_flags = blk->root->bs->open_flags;
1675 blk->root_state.read_only = blk->root->bs->read_only;
1676 blk->root_state.detect_zeroes = blk->root->bs->detect_zeroes;
281d22d8
HR
1677}
1678
38cb18f5 1679/*
b85114f8
KW
1680 * Returns the detect-zeroes setting to be used for bdrv_open() of a
1681 * BlockDriverState which is supposed to inherit the root state.
38cb18f5 1682 */
b85114f8 1683bool blk_get_detect_zeroes_from_root_state(BlockBackend *blk)
38cb18f5 1684{
b85114f8 1685 return blk->root_state.detect_zeroes;
38cb18f5
HR
1686}
1687
1688/*
1689 * Returns the flags to be used for bdrv_open() of a BlockDriverState which is
1690 * supposed to inherit the root state.
1691 */
1692int blk_get_open_flags_from_root_state(BlockBackend *blk)
1693{
1694 int bs_flags;
1695
1696 bs_flags = blk->root_state.read_only ? 0 : BDRV_O_RDWR;
1697 bs_flags |= blk->root_state.open_flags & ~BDRV_O_RDWR;
1698
1699 return bs_flags;
1700}
1701
281d22d8
HR
1702BlockBackendRootState *blk_get_root_state(BlockBackend *blk)
1703{
1704 return &blk->root_state;
1705}
1393f212
HR
1706
1707int blk_commit_all(void)
1708{
fe1a9cbc
HR
1709 BlockBackend *blk = NULL;
1710
1711 while ((blk = blk_all_next(blk)) != NULL) {
1712 AioContext *aio_context = blk_get_aio_context(blk);
1713
1714 aio_context_acquire(aio_context);
f21d96d0
KW
1715 if (blk_is_inserted(blk) && blk->root->bs->backing) {
1716 int ret = bdrv_commit(blk->root->bs);
fe1a9cbc
HR
1717 if (ret < 0) {
1718 aio_context_release(aio_context);
1719 return ret;
1720 }
1721 }
1722 aio_context_release(aio_context);
1723 }
1724 return 0;
1725}
1726
97148076
KW
1727
1728/* throttling disk I/O limits */
1729void blk_set_io_limits(BlockBackend *blk, ThrottleConfig *cfg)
1730{
1731 throttle_group_config(blk, cfg);
1732}
1733
1734void blk_io_limits_disable(BlockBackend *blk)
1735{
1736 assert(blk->public.throttle_state);
c2066af0 1737 bdrv_drained_begin(blk_bs(blk));
97148076 1738 throttle_group_unregister_blk(blk);
c2066af0 1739 bdrv_drained_end(blk_bs(blk));
97148076
KW
1740}
1741
1742/* should be called before blk_set_io_limits if a limit is set */
1743void blk_io_limits_enable(BlockBackend *blk, const char *group)
1744{
1745 assert(!blk->public.throttle_state);
1746 throttle_group_register_blk(blk, group);
1747}
1748
1749void blk_io_limits_update_group(BlockBackend *blk, const char *group)
1750{
1751 /* this BB is not part of any group */
1752 if (!blk->public.throttle_state) {
1753 return;
1754 }
1755
1756 /* this BB is a part of the same group than the one we want */
1757 if (!g_strcmp0(throttle_group_get_name(blk), group)) {
1758 return;
1759 }
1760
1761 /* need to change the group this bs belong to */
1762 blk_io_limits_disable(blk);
1763 blk_io_limits_enable(blk, group);
1764}
c2066af0
KW
1765
1766static void blk_root_drained_begin(BdrvChild *child)
1767{
1768 BlockBackend *blk = child->opaque;
1769
36fe1331
KW
1770 /* Note that blk->root may not be accessible here yet if we are just
1771 * attaching to a BlockDriverState that is drained. Use child instead. */
1772
c2066af0
KW
1773 if (blk->public.io_limits_disabled++ == 0) {
1774 throttle_group_restart_blk(blk);
1775 }
1776}
1777
1778static void blk_root_drained_end(BdrvChild *child)
1779{
1780 BlockBackend *blk = child->opaque;
1781
1782 assert(blk->public.io_limits_disabled);
1783 --blk->public.io_limits_disabled;
1784}