block/block-backend.c

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