block.c

   1 /*
   2  * QEMU System Emulator block driver
   3  *
   4  * Copyright (c) 2003 Fabrice Bellard
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24 #include "qemu/osdep.h"
  25 #include "block/trace.h"
  26 #include "block/block_int.h"
  27 #include "block/blockjob.h"
  28 #include "block/nbd.h"
  29 #include "qemu/error-report.h"
  30 #include "module_block.h"
  31 #include "qemu/module.h"
  32 #include "qapi/qmp/qerror.h"
  33 #include "qapi/qmp/qbool.h"
  34 #include "qapi/qmp/qjson.h"
  35 #include "sysemu/block-backend.h"
  36 #include "sysemu/sysemu.h"
  37 #include "qemu/notify.h"
  38 #include "qemu/coroutine.h"
  39 #include "block/qapi.h"
  40 #include "qmp-commands.h"
  41 #include "qemu/timer.h"
  42 #include "qapi-event.h"
  43 #include "qemu/cutils.h"
  44 #include "qemu/id.h"
  45 #include "qapi/util.h"
  46
  47 #ifdef CONFIG_BSD
  48 #include <sys/ioctl.h>
  49 #include <sys/queue.h>
  50 #ifndef __DragonFly__
  51 #include <sys/disk.h>
  52 #endif
  53 #endif
  54
  55 #ifdef _WIN32
  56 #include <windows.h>
  57 #endif
  58
  59 #define NOT_DONE 0x7fffffff /* used while emulated sync operation in progress */
  60
  61 static QTAILQ_HEAD(, BlockDriverState) graph_bdrv_states =
  62     QTAILQ_HEAD_INITIALIZER(graph_bdrv_states);
  63
  64 static QTAILQ_HEAD(, BlockDriverState) all_bdrv_states =
  65     QTAILQ_HEAD_INITIALIZER(all_bdrv_states);
  66
  67 static QLIST_HEAD(, BlockDriver) bdrv_drivers =
  68     QLIST_HEAD_INITIALIZER(bdrv_drivers);
  69
  70 static BlockDriverState *bdrv_open_inherit(const char *filename,
  71                                            const char *reference,
  72                                            QDict *options, int flags,
  73                                            BlockDriverState *parent,
  74                                            const BdrvChildRole *child_role,
  75                                            Error **errp);
  76
  77 /* If non-zero, use only whitelisted block drivers */
  78 static int use_bdrv_whitelist;
  79
  80 #ifdef _WIN32
  81 static int is_windows_drive_prefix(const char *filename)
  82 {
  83     return (((filename[0] >= 'a' && filename[0] <= 'z') ||
  84              (filename[0] >= 'A' && filename[0] <= 'Z')) &&
  85             filename[1] == ':');
  86 }
  87
  88 int is_windows_drive(const char *filename)
  89 {
  90     if (is_windows_drive_prefix(filename) &&
  91         filename[2] == '\0')
  92         return 1;
  93     if (strstart(filename, "\\\\.\\", NULL) ||
  94         strstart(filename, "//./", NULL))
  95         return 1;
  96     return 0;
  97 }
  98 #endif
  99
 100 size_t bdrv_opt_mem_align(BlockDriverState *bs)
 101 {
 102     if (!bs || !bs->drv) {
 103         /* page size or 4k (hdd sector size) should be on the safe side */
 104         return MAX(4096, getpagesize());
 105     }
 106
 107     return bs->bl.opt_mem_alignment;
 108 }
 109
 110 size_t bdrv_min_mem_align(BlockDriverState *bs)
 111 {
 112     if (!bs || !bs->drv) {
 113         /* page size or 4k (hdd sector size) should be on the safe side */
 114         return MAX(4096, getpagesize());
 115     }
 116
 117     return bs->bl.min_mem_alignment;
 118 }
 119
 120 /* check if the path starts with "<protocol>:" */
 121 int path_has_protocol(const char *path)
 122 {
 123     const char *p;
 124
 125 #ifdef _WIN32
 126     if (is_windows_drive(path) ||
 127         is_windows_drive_prefix(path)) {
 128         return 0;
 129     }
 130     p = path + strcspn(path, ":/\\");
 131 #else
 132     p = path + strcspn(path, ":/");
 133 #endif
 134
 135     return *p == ':';
 136 }
 137
 138 int path_is_absolute(const char *path)
 139 {
 140 #ifdef _WIN32
 141     /* specific case for names like: "\\.\d:" */
 142     if (is_windows_drive(path) || is_windows_drive_prefix(path)) {
 143         return 1;
 144     }
 145     return (*path == '/' || *path == '\\');
 146 #else
 147     return (*path == '/');
 148 #endif
 149 }
 150
 151 /* if filename is absolute, just copy it to dest. Otherwise, build a
 152    path to it by considering it is relative to base_path. URL are
 153    supported. */
 154 void path_combine(char *dest, int dest_size,
 155                   const char *base_path,
 156                   const char *filename)
 157 {
 158     const char *p, *p1;
 159     int len;
 160
 161     if (dest_size <= 0)
 162         return;
 163     if (path_is_absolute(filename)) {
 164         pstrcpy(dest, dest_size, filename);
 165     } else {
 166         p = strchr(base_path, ':');
 167         if (p)
 168             p++;
 169         else
 170             p = base_path;
 171         p1 = strrchr(base_path, '/');
 172 #ifdef _WIN32
 173         {
 174             const char *p2;
 175             p2 = strrchr(base_path, '\\');
 176             if (!p1 || p2 > p1)
 177                 p1 = p2;
 178         }
 179 #endif
 180         if (p1)
 181             p1++;
 182         else
 183             p1 = base_path;
 184         if (p1 > p)
 185             p = p1;
 186         len = p - base_path;
 187         if (len > dest_size - 1)
 188             len = dest_size - 1;
 189         memcpy(dest, base_path, len);
 190         dest[len] = '\0';
 191         pstrcat(dest, dest_size, filename);
 192     }
 193 }
 194
 195 void bdrv_get_full_backing_filename_from_filename(const char *backed,
 196                                                   const char *backing,
 197                                                   char *dest, size_t sz,
 198                                                   Error **errp)
 199 {
 200     if (backing[0] == '\0' || path_has_protocol(backing) ||
 201         path_is_absolute(backing))
 202     {
 203         pstrcpy(dest, sz, backing);
 204     } else if (backed[0] == '\0' || strstart(backed, "json:", NULL)) {
 205         error_setg(errp, "Cannot use relative backing file names for '%s'",
 206                    backed);
 207     } else {
 208         path_combine(dest, sz, backed, backing);
 209     }
 210 }
 211
 212 void bdrv_get_full_backing_filename(BlockDriverState *bs, char *dest, size_t sz,
 213                                     Error **errp)
 214 {
 215     char *backed = bs->exact_filename[0] ? bs->exact_filename : bs->filename;
 216
 217     bdrv_get_full_backing_filename_from_filename(backed, bs->backing_file,
 218                                                  dest, sz, errp);
 219 }
 220
 221 void bdrv_register(BlockDriver *bdrv)
 222 {
 223     QLIST_INSERT_HEAD(&bdrv_drivers, bdrv, list);
 224 }
 225
 226 BlockDriverState *bdrv_new(void)
 227 {
 228     BlockDriverState *bs;
 229     int i;
 230
 231     bs = g_new0(BlockDriverState, 1);
 232     QLIST_INIT(&bs->dirty_bitmaps);
 233     for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) {
 234         QLIST_INIT(&bs->op_blockers[i]);
 235     }
 236     notifier_with_return_list_init(&bs->before_write_notifiers);
 237     bs->refcnt = 1;
 238     bs->aio_context = qemu_get_aio_context();
 239
 240     qemu_co_queue_init(&bs->flush_queue);
 241
 242     QTAILQ_INSERT_TAIL(&all_bdrv_states, bs, bs_list);
 243
 244     return bs;
 245 }
 246
 247 static BlockDriver *bdrv_do_find_format(const char *format_name)
 248 {
 249     BlockDriver *drv1;
 250
 251     QLIST_FOREACH(drv1, &bdrv_drivers, list) {
 252         if (!strcmp(drv1->format_name, format_name)) {
 253             return drv1;
 254         }
 255     }
 256
 257     return NULL;
 258 }
 259
 260 BlockDriver *bdrv_find_format(const char *format_name)
 261 {
 262     BlockDriver *drv1;
 263     int i;
 264
 265     drv1 = bdrv_do_find_format(format_name);
 266     if (drv1) {
 267         return drv1;
 268     }
 269
 270     /* The driver isn't registered, maybe we need to load a module */
 271     for (i = 0; i < (int)ARRAY_SIZE(block_driver_modules); ++i) {
 272         if (!strcmp(block_driver_modules[i].format_name, format_name)) {
 273             block_module_load_one(block_driver_modules[i].library_name);
 274             break;
 275         }
 276     }
 277
 278     return bdrv_do_find_format(format_name);
 279 }
 280
 281 static int bdrv_is_whitelisted(BlockDriver *drv, bool read_only)
 282 {
 283     static const char *whitelist_rw[] = {
 284         CONFIG_BDRV_RW_WHITELIST
 285     };
 286     static const char *whitelist_ro[] = {
 287         CONFIG_BDRV_RO_WHITELIST
 288     };
 289     const char **p;
 290
 291     if (!whitelist_rw[0] && !whitelist_ro[0]) {
 292         return 1;               /* no whitelist, anything goes */
 293     }
 294
 295     for (p = whitelist_rw; *p; p++) {
 296         if (!strcmp(drv->format_name, *p)) {
 297             return 1;
 298         }
 299     }
 300     if (read_only) {
 301         for (p = whitelist_ro; *p; p++) {
 302             if (!strcmp(drv->format_name, *p)) {
 303                 return 1;
 304             }
 305         }
 306     }
 307     return 0;
 308 }
 309
 310 bool bdrv_uses_whitelist(void)
 311 {
 312     return use_bdrv_whitelist;
 313 }
 314
 315 typedef struct CreateCo {
 316     BlockDriver *drv;
 317     char *filename;
 318     QemuOpts *opts;
 319     int ret;
 320     Error *err;
 321 } CreateCo;
 322
 323 static void coroutine_fn bdrv_create_co_entry(void *opaque)
 324 {
 325     Error *local_err = NULL;
 326     int ret;
 327
 328     CreateCo *cco = opaque;
 329     assert(cco->drv);
 330
 331     ret = cco->drv->bdrv_create(cco->filename, cco->opts, &local_err);
 332     error_propagate(&cco->err, local_err);
 333     cco->ret = ret;
 334 }
 335
 336 int bdrv_create(BlockDriver *drv, const char* filename,
 337                 QemuOpts *opts, Error **errp)
 338 {
 339     int ret;
 340
 341     Coroutine *co;
 342     CreateCo cco = {
 343         .drv = drv,
 344         .filename = g_strdup(filename),
 345         .opts = opts,
 346         .ret = NOT_DONE,
 347         .err = NULL,
 348     };
 349
 350     if (!drv->bdrv_create) {
 351         error_setg(errp, "Driver '%s' does not support image creation", drv->format_name);
 352         ret = -ENOTSUP;
 353         goto out;
 354     }
 355
 356     if (qemu_in_coroutine()) {
 357         /* Fast-path if already in coroutine context */
 358         bdrv_create_co_entry(&cco);
 359     } else {
 360         co = qemu_coroutine_create(bdrv_create_co_entry, &cco);
 361         qemu_coroutine_enter(co);
 362         while (cco.ret == NOT_DONE) {
 363             aio_poll(qemu_get_aio_context(), true);
 364         }
 365     }
 366
 367     ret = cco.ret;
 368     if (ret < 0) {
 369         if (cco.err) {
 370             error_propagate(errp, cco.err);
 371         } else {
 372             error_setg_errno(errp, -ret, "Could not create image");
 373         }
 374     }
 375
 376 out:
 377     g_free(cco.filename);
 378     return ret;
 379 }
 380
 381 int bdrv_create_file(const char *filename, QemuOpts *opts, Error **errp)
 382 {
 383     BlockDriver *drv;
 384     Error *local_err = NULL;
 385     int ret;
 386
 387     drv = bdrv_find_protocol(filename, true, errp);
 388     if (drv == NULL) {
 389         return -ENOENT;
 390     }
 391
 392     ret = bdrv_create(drv, filename, opts, &local_err);
 393     error_propagate(errp, local_err);
 394     return ret;
 395 }
 396
 397 /**
 398  * Try to get @bs's logical and physical block size.
 399  * On success, store them in @bsz struct and return 0.
 400  * On failure return -errno.
 401  * @bs must not be empty.
 402  */
 403 int bdrv_probe_blocksizes(BlockDriverState *bs, BlockSizes *bsz)
 404 {
 405     BlockDriver *drv = bs->drv;
 406
 407     if (drv && drv->bdrv_probe_blocksizes) {
 408         return drv->bdrv_probe_blocksizes(bs, bsz);
 409     }
 410
 411     return -ENOTSUP;
 412 }
 413
 414 /**
 415  * Try to get @bs's geometry (cyls, heads, sectors).
 416  * On success, store them in @geo struct and return 0.
 417  * On failure return -errno.
 418  * @bs must not be empty.
 419  */
 420 int bdrv_probe_geometry(BlockDriverState *bs, HDGeometry *geo)
 421 {
 422     BlockDriver *drv = bs->drv;
 423
 424     if (drv && drv->bdrv_probe_geometry) {
 425         return drv->bdrv_probe_geometry(bs, geo);
 426     }
 427
 428     return -ENOTSUP;
 429 }
 430
 431 /*
 432  * Create a uniquely-named empty temporary file.
 433  * Return 0 upon success, otherwise a negative errno value.
 434  */
 435 int get_tmp_filename(char *filename, int size)
 436 {
 437 #ifdef _WIN32
 438     char temp_dir[MAX_PATH];
 439     /* GetTempFileName requires that its output buffer (4th param)
 440        have length MAX_PATH or greater.  */
 441     assert(size >= MAX_PATH);
 442     return (GetTempPath(MAX_PATH, temp_dir)
 443             && GetTempFileName(temp_dir, "qem", 0, filename)
 444             ? 0 : -GetLastError());
 445 #else
 446     int fd;
 447     const char *tmpdir;
 448     tmpdir = getenv("TMPDIR");
 449     if (!tmpdir) {
 450         tmpdir = "/var/tmp";
 451     }
 452     if (snprintf(filename, size, "%s/vl.XXXXXX", tmpdir) >= size) {
 453         return -EOVERFLOW;
 454     }
 455     fd = mkstemp(filename);
 456     if (fd < 0) {
 457         return -errno;
 458     }
 459     if (close(fd) != 0) {
 460         unlink(filename);
 461         return -errno;
 462     }
 463     return 0;
 464 #endif
 465 }
 466
 467 /*
 468  * Detect host devices. By convention, /dev/cdrom[N] is always
 469  * recognized as a host CDROM.
 470  */
 471 static BlockDriver *find_hdev_driver(const char *filename)
 472 {
 473     int score_max = 0, score;
 474     BlockDriver *drv = NULL, *d;
 475
 476     QLIST_FOREACH(d, &bdrv_drivers, list) {
 477         if (d->bdrv_probe_device) {
 478             score = d->bdrv_probe_device(filename);
 479             if (score > score_max) {
 480                 score_max = score;
 481                 drv = d;
 482             }
 483         }
 484     }
 485
 486     return drv;
 487 }
 488
 489 static BlockDriver *bdrv_do_find_protocol(const char *protocol)
 490 {
 491     BlockDriver *drv1;
 492
 493     QLIST_FOREACH(drv1, &bdrv_drivers, list) {
 494         if (drv1->protocol_name && !strcmp(drv1->protocol_name, protocol)) {
 495             return drv1;
 496         }
 497     }
 498
 499     return NULL;
 500 }
 501
 502 BlockDriver *bdrv_find_protocol(const char *filename,
 503                                 bool allow_protocol_prefix,
 504                                 Error **errp)
 505 {
 506     BlockDriver *drv1;
 507     char protocol[128];
 508     int len;
 509     const char *p;
 510     int i;
 511
 512     /* TODO Drivers without bdrv_file_open must be specified explicitly */
 513
 514     /*
 515      * XXX(hch): we really should not let host device detection
 516      * override an explicit protocol specification, but moving this
 517      * later breaks access to device names with colons in them.
 518      * Thanks to the brain-dead persistent naming schemes on udev-
 519      * based Linux systems those actually are quite common.
 520      */
 521     drv1 = find_hdev_driver(filename);
 522     if (drv1) {
 523         return drv1;
 524     }
 525
 526     if (!path_has_protocol(filename) || !allow_protocol_prefix) {
 527         return &bdrv_file;
 528     }
 529
 530     p = strchr(filename, ':');
 531     assert(p != NULL);
 532     len = p - filename;
 533     if (len > sizeof(protocol) - 1)
 534         len = sizeof(protocol) - 1;
 535     memcpy(protocol, filename, len);
 536     protocol[len] = '\0';
 537
 538     drv1 = bdrv_do_find_protocol(protocol);
 539     if (drv1) {
 540         return drv1;
 541     }
 542
 543     for (i = 0; i < (int)ARRAY_SIZE(block_driver_modules); ++i) {
 544         if (block_driver_modules[i].protocol_name &&
 545             !strcmp(block_driver_modules[i].protocol_name, protocol)) {
 546             block_module_load_one(block_driver_modules[i].library_name);
 547             break;
 548         }
 549     }
 550
 551     drv1 = bdrv_do_find_protocol(protocol);
 552     if (!drv1) {
 553         error_setg(errp, "Unknown protocol '%s'", protocol);
 554     }
 555     return drv1;
 556 }
 557
 558 /*
 559  * Guess image format by probing its contents.
 560  * This is not a good idea when your image is raw (CVE-2008-2004), but
 561  * we do it anyway for backward compatibility.
 562  *
 563  * @buf         contains the image's first @buf_size bytes.
 564  * @buf_size    is the buffer size in bytes (generally BLOCK_PROBE_BUF_SIZE,
 565  *              but can be smaller if the image file is smaller)
 566  * @filename    is its filename.
 567  *
 568  * For all block drivers, call the bdrv_probe() method to get its
 569  * probing score.
 570  * Return the first block driver with the highest probing score.
 571  */
 572 BlockDriver *bdrv_probe_all(const uint8_t *buf, int buf_size,
 573                             const char *filename)
 574 {
 575     int score_max = 0, score;
 576     BlockDriver *drv = NULL, *d;
 577
 578     QLIST_FOREACH(d, &bdrv_drivers, list) {
 579         if (d->bdrv_probe) {
 580             score = d->bdrv_probe(buf, buf_size, filename);
 581             if (score > score_max) {
 582                 score_max = score;
 583                 drv = d;
 584             }
 585         }
 586     }
 587
 588     return drv;
 589 }
 590
 591 static int find_image_format(BlockBackend *file, const char *filename,
 592                              BlockDriver **pdrv, Error **errp)
 593 {
 594     BlockDriver *drv;
 595     uint8_t buf[BLOCK_PROBE_BUF_SIZE];
 596     int ret = 0;
 597
 598     /* Return the raw BlockDriver * to scsi-generic devices or empty drives */
 599     if (blk_is_sg(file) || !blk_is_inserted(file) || blk_getlength(file) == 0) {
 600         *pdrv = &bdrv_raw;
 601         return ret;
 602     }
 603
 604     ret = blk_pread(file, 0, buf, sizeof(buf));
 605     if (ret < 0) {
 606         error_setg_errno(errp, -ret, "Could not read image for determining its "
 607                          "format");
 608         *pdrv = NULL;
 609         return ret;
 610     }
 611
 612     drv = bdrv_probe_all(buf, ret, filename);
 613     if (!drv) {
 614         error_setg(errp, "Could not determine image format: No compatible "
 615                    "driver found");
 616         ret = -ENOENT;
 617     }
 618     *pdrv = drv;
 619     return ret;
 620 }
 621
 622 /**
 623  * Set the current 'total_sectors' value
 624  * Return 0 on success, -errno on error.
 625  */
 626 static int refresh_total_sectors(BlockDriverState *bs, int64_t hint)
 627 {
 628     BlockDriver *drv = bs->drv;
 629
 630     /* Do not attempt drv->bdrv_getlength() on scsi-generic devices */
 631     if (bdrv_is_sg(bs))
 632         return 0;
 633
 634     /* query actual device if possible, otherwise just trust the hint */
 635     if (drv->bdrv_getlength) {
 636         int64_t length = drv->bdrv_getlength(bs);
 637         if (length < 0) {
 638             return length;
 639         }
 640         hint = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE);
 641     }
 642
 643     bs->total_sectors = hint;
 644     return 0;
 645 }
 646
 647 /**
 648  * Combines a QDict of new block driver @options with any missing options taken
 649  * from @old_options, so that leaving out an option defaults to its old value.
 650  */
 651 static void bdrv_join_options(BlockDriverState *bs, QDict *options,
 652                               QDict *old_options)
 653 {
 654     if (bs->drv && bs->drv->bdrv_join_options) {
 655         bs->drv->bdrv_join_options(options, old_options);
 656     } else {
 657         qdict_join(options, old_options, false);
 658     }
 659 }
 660
 661 /**
 662  * Set open flags for a given discard mode
 663  *
 664  * Return 0 on success, -1 if the discard mode was invalid.
 665  */
 666 int bdrv_parse_discard_flags(const char *mode, int *flags)
 667 {
 668     *flags &= ~BDRV_O_UNMAP;
 669
 670     if (!strcmp(mode, "off") || !strcmp(mode, "ignore")) {
 671         /* do nothing */
 672     } else if (!strcmp(mode, "on") || !strcmp(mode, "unmap")) {
 673         *flags |= BDRV_O_UNMAP;
 674     } else {
 675         return -1;
 676     }
 677
 678     return 0;
 679 }
 680
 681 /**
 682  * Set open flags for a given cache mode
 683  *
 684  * Return 0 on success, -1 if the cache mode was invalid.
 685  */
 686 int bdrv_parse_cache_mode(const char *mode, int *flags, bool *writethrough)
 687 {
 688     *flags &= ~BDRV_O_CACHE_MASK;
 689
 690     if (!strcmp(mode, "off") || !strcmp(mode, "none")) {
 691         *writethrough = false;
 692         *flags |= BDRV_O_NOCACHE;
 693     } else if (!strcmp(mode, "directsync")) {
 694         *writethrough = true;
 695         *flags |= BDRV_O_NOCACHE;
 696     } else if (!strcmp(mode, "writeback")) {
 697         *writethrough = false;
 698     } else if (!strcmp(mode, "unsafe")) {
 699         *writethrough = false;
 700         *flags |= BDRV_O_NO_FLUSH;
 701     } else if (!strcmp(mode, "writethrough")) {
 702         *writethrough = true;
 703     } else {
 704         return -1;
 705     }
 706
 707     return 0;
 708 }
 709
 710 static void bdrv_child_cb_drained_begin(BdrvChild *child)
 711 {
 712     BlockDriverState *bs = child->opaque;
 713     bdrv_drained_begin(bs);
 714 }
 715
 716 static void bdrv_child_cb_drained_end(BdrvChild *child)
 717 {
 718     BlockDriverState *bs = child->opaque;
 719     bdrv_drained_end(bs);
 720 }
 721
 722 /*
 723  * Returns the options and flags that a temporary snapshot should get, based on
 724  * the originally requested flags (the originally requested image will have
 725  * flags like a backing file)
 726  */
 727 static void bdrv_temp_snapshot_options(int *child_flags, QDict *child_options,
 728                                        int parent_flags, QDict *parent_options)
 729 {
 730     *child_flags = (parent_flags & ~BDRV_O_SNAPSHOT) | BDRV_O_TEMPORARY;
 731
 732     /* For temporary files, unconditional cache=unsafe is fine */
 733     qdict_set_default_str(child_options, BDRV_OPT_CACHE_DIRECT, "off");
 734     qdict_set_default_str(child_options, BDRV_OPT_CACHE_NO_FLUSH, "on");
 735
 736     /* Copy the read-only option from the parent */
 737     qdict_copy_default(child_options, parent_options, BDRV_OPT_READ_ONLY);
 738
 739     /* aio=native doesn't work for cache.direct=off, so disable it for the
 740      * temporary snapshot */
 741     *child_flags &= ~BDRV_O_NATIVE_AIO;
 742 }
 743
 744 /*
 745  * Returns the options and flags that bs->file should get if a protocol driver
 746  * is expected, based on the given options and flags for the parent BDS
 747  */
 748 static void bdrv_inherited_options(int *child_flags, QDict *child_options,
 749                                    int parent_flags, QDict *parent_options)
 750 {
 751     int flags = parent_flags;
 752
 753     /* Enable protocol handling, disable format probing for bs->file */
 754     flags |= BDRV_O_PROTOCOL;
 755
 756     /* If the cache mode isn't explicitly set, inherit direct and no-flush from
 757      * the parent. */
 758     qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_DIRECT);
 759     qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_NO_FLUSH);
 760
 761     /* Inherit the read-only option from the parent if it's not set */
 762     qdict_copy_default(child_options, parent_options, BDRV_OPT_READ_ONLY);
 763
 764     /* Our block drivers take care to send flushes and respect unmap policy,
 765      * so we can default to enable both on lower layers regardless of the
 766      * corresponding parent options. */
 767     qdict_set_default_str(child_options, BDRV_OPT_DISCARD, "unmap");
 768
 769     /* Clear flags that only apply to the top layer */
 770     flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_COPY_ON_READ |
 771                BDRV_O_NO_IO);
 772
 773     *child_flags = flags;
 774 }
 775
 776 const BdrvChildRole child_file = {
 777     .inherit_options = bdrv_inherited_options,
 778     .drained_begin   = bdrv_child_cb_drained_begin,
 779     .drained_end     = bdrv_child_cb_drained_end,
 780 };
 781
 782 /*
 783  * Returns the options and flags that bs->file should get if the use of formats
 784  * (and not only protocols) is permitted for it, based on the given options and
 785  * flags for the parent BDS
 786  */
 787 static void bdrv_inherited_fmt_options(int *child_flags, QDict *child_options,
 788                                        int parent_flags, QDict *parent_options)
 789 {
 790     child_file.inherit_options(child_flags, child_options,
 791                                parent_flags, parent_options);
 792
 793     *child_flags &= ~(BDRV_O_PROTOCOL | BDRV_O_NO_IO);
 794 }
 795
 796 const BdrvChildRole child_format = {
 797     .inherit_options = bdrv_inherited_fmt_options,
 798     .drained_begin   = bdrv_child_cb_drained_begin,
 799     .drained_end     = bdrv_child_cb_drained_end,
 800 };
 801
 802 /*
 803  * Returns the options and flags that bs->backing should get, based on the
 804  * given options and flags for the parent BDS
 805  */
 806 static void bdrv_backing_options(int *child_flags, QDict *child_options,
 807                                  int parent_flags, QDict *parent_options)
 808 {
 809     int flags = parent_flags;
 810
 811     /* The cache mode is inherited unmodified for backing files; except WCE,
 812      * which is only applied on the top level (BlockBackend) */
 813     qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_DIRECT);
 814     qdict_copy_default(child_options, parent_options, BDRV_OPT_CACHE_NO_FLUSH);
 815
 816     /* backing files always opened read-only */
 817     qdict_set_default_str(child_options, BDRV_OPT_READ_ONLY, "on");
 818     flags &= ~BDRV_O_COPY_ON_READ;
 819
 820     /* snapshot=on is handled on the top layer */
 821     flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_TEMPORARY);
 822
 823     *child_flags = flags;
 824 }
 825
 826 static const BdrvChildRole child_backing = {
 827     .inherit_options = bdrv_backing_options,
 828     .drained_begin   = bdrv_child_cb_drained_begin,
 829     .drained_end     = bdrv_child_cb_drained_end,
 830 };
 831
 832 static int bdrv_open_flags(BlockDriverState *bs, int flags)
 833 {
 834     int open_flags = flags;
 835
 836     /*
 837      * Clear flags that are internal to the block layer before opening the
 838      * image.
 839      */
 840     open_flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING | BDRV_O_PROTOCOL);
 841
 842     /*
 843      * Snapshots should be writable.
 844      */
 845     if (flags & BDRV_O_TEMPORARY) {
 846         open_flags |= BDRV_O_RDWR;
 847     }
 848
 849     return open_flags;
 850 }
 851
 852 static void update_flags_from_options(int *flags, QemuOpts *opts)
 853 {
 854     *flags &= ~BDRV_O_CACHE_MASK;
 855
 856     assert(qemu_opt_find(opts, BDRV_OPT_CACHE_NO_FLUSH));
 857     if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_NO_FLUSH, false)) {
 858         *flags |= BDRV_O_NO_FLUSH;
 859     }
 860
 861     assert(qemu_opt_find(opts, BDRV_OPT_CACHE_DIRECT));
 862     if (qemu_opt_get_bool(opts, BDRV_OPT_CACHE_DIRECT, false)) {
 863         *flags |= BDRV_O_NOCACHE;
 864     }
 865
 866     *flags &= ~BDRV_O_RDWR;
 867
 868     assert(qemu_opt_find(opts, BDRV_OPT_READ_ONLY));
 869     if (!qemu_opt_get_bool(opts, BDRV_OPT_READ_ONLY, false)) {
 870         *flags |= BDRV_O_RDWR;
 871     }
 872
 873 }
 874
 875 static void update_options_from_flags(QDict *options, int flags)
 876 {
 877     if (!qdict_haskey(options, BDRV_OPT_CACHE_DIRECT)) {
 878         qdict_put(options, BDRV_OPT_CACHE_DIRECT,
 879                   qbool_from_bool(flags & BDRV_O_NOCACHE));
 880     }
 881     if (!qdict_haskey(options, BDRV_OPT_CACHE_NO_FLUSH)) {
 882         qdict_put(options, BDRV_OPT_CACHE_NO_FLUSH,
 883                   qbool_from_bool(flags & BDRV_O_NO_FLUSH));
 884     }
 885     if (!qdict_haskey(options, BDRV_OPT_READ_ONLY)) {
 886         qdict_put(options, BDRV_OPT_READ_ONLY,
 887                   qbool_from_bool(!(flags & BDRV_O_RDWR)));
 888     }
 889 }
 890
 891 static void bdrv_assign_node_name(BlockDriverState *bs,
 892                                   const char *node_name,
 893                                   Error **errp)
 894 {
 895     char *gen_node_name = NULL;
 896
 897     if (!node_name) {
 898         node_name = gen_node_name = id_generate(ID_BLOCK);
 899     } else if (!id_wellformed(node_name)) {
 900         /*
 901          * Check for empty string or invalid characters, but not if it is
 902          * generated (generated names use characters not available to the user)
 903          */
 904         error_setg(errp, "Invalid node name");
 905         return;
 906     }
 907
 908     /* takes care of avoiding namespaces collisions */
 909     if (blk_by_name(node_name)) {
 910         error_setg(errp, "node-name=%s is conflicting with a device id",
 911                    node_name);
 912         goto out;
 913     }
 914
 915     /* takes care of avoiding duplicates node names */
 916     if (bdrv_find_node(node_name)) {
 917         error_setg(errp, "Duplicate node name");
 918         goto out;
 919     }
 920
 921     /* copy node name into the bs and insert it into the graph list */
 922     pstrcpy(bs->node_name, sizeof(bs->node_name), node_name);
 923     QTAILQ_INSERT_TAIL(&graph_bdrv_states, bs, node_list);
 924 out:
 925     g_free(gen_node_name);
 926 }
 927
 928 static int bdrv_open_driver(BlockDriverState *bs, BlockDriver *drv,
 929                             const char *node_name, QDict *options,
 930                             int open_flags, Error **errp)
 931 {
 932     Error *local_err = NULL;
 933     int ret;
 934
 935     bdrv_assign_node_name(bs, node_name, &local_err);
 936     if (local_err) {
 937         error_propagate(errp, local_err);
 938         return -EINVAL;
 939     }
 940
 941     bs->drv = drv;
 942     bs->read_only = !(bs->open_flags & BDRV_O_RDWR);
 943     bs->opaque = g_malloc0(drv->instance_size);
 944
 945     if (drv->bdrv_file_open) {
 946         assert(!drv->bdrv_needs_filename || bs->filename[0]);
 947         ret = drv->bdrv_file_open(bs, options, open_flags, &local_err);
 948     } else if (drv->bdrv_open) {
 949         ret = drv->bdrv_open(bs, options, open_flags, &local_err);
 950     } else {
 951         ret = 0;
 952     }
 953
 954     if (ret < 0) {
 955         if (local_err) {
 956             error_propagate(errp, local_err);
 957         } else if (bs->filename[0]) {
 958             error_setg_errno(errp, -ret, "Could not open '%s'", bs->filename);
 959         } else {
 960             error_setg_errno(errp, -ret, "Could not open image");
 961         }
 962         goto free_and_fail;
 963     }
 964
 965     ret = refresh_total_sectors(bs, bs->total_sectors);
 966     if (ret < 0) {
 967         error_setg_errno(errp, -ret, "Could not refresh total sector count");
 968         goto free_and_fail;
 969     }
 970
 971     bdrv_refresh_limits(bs, &local_err);
 972     if (local_err) {
 973         error_propagate(errp, local_err);
 974         ret = -EINVAL;
 975         goto free_and_fail;
 976     }
 977
 978     assert(bdrv_opt_mem_align(bs) != 0);
 979     assert(bdrv_min_mem_align(bs) != 0);
 980     assert(is_power_of_2(bs->bl.request_alignment));
 981
 982     return 0;
 983
 984 free_and_fail:
 985     /* FIXME Close bs first if already opened*/
 986     g_free(bs->opaque);
 987     bs->opaque = NULL;
 988     bs->drv = NULL;
 989     return ret;
 990 }
 991
 992 BlockDriverState *bdrv_new_open_driver(BlockDriver *drv, const char *node_name,
 993                                        int flags, Error **errp)
 994 {
 995     BlockDriverState *bs;
 996     int ret;
 997
 998     bs = bdrv_new();
 999     bs->open_flags = flags;
1000     bs->explicit_options = qdict_new();
1001     bs->options = qdict_new();
1002     bs->opaque = NULL;
1003
1004     update_options_from_flags(bs->options, flags);
1005
1006     ret = bdrv_open_driver(bs, drv, node_name, bs->options, flags, errp);
1007     if (ret < 0) {
1008         QDECREF(bs->explicit_options);
1009         QDECREF(bs->options);
1010         bdrv_unref(bs);
1011         return NULL;
1012     }
1013
1014     return bs;
1015 }
1016
1017 QemuOptsList bdrv_runtime_opts = {
1018     .name = "bdrv_common",
1019     .head = QTAILQ_HEAD_INITIALIZER(bdrv_runtime_opts.head),
1020     .desc = {
1021         {
1022             .name = "node-name",
1023             .type = QEMU_OPT_STRING,
1024             .help = "Node name of the block device node",
1025         },
1026         {
1027             .name = "driver",
1028             .type = QEMU_OPT_STRING,
1029             .help = "Block driver to use for the node",
1030         },
1031         {
1032             .name = BDRV_OPT_CACHE_DIRECT,
1033             .type = QEMU_OPT_BOOL,
1034             .help = "Bypass software writeback cache on the host",
1035         },
1036         {
1037             .name = BDRV_OPT_CACHE_NO_FLUSH,
1038             .type = QEMU_OPT_BOOL,
1039             .help = "Ignore flush requests",
1040         },
1041         {
1042             .name = BDRV_OPT_READ_ONLY,
1043             .type = QEMU_OPT_BOOL,
1044             .help = "Node is opened in read-only mode",
1045         },
1046         {
1047             .name = "detect-zeroes",
1048             .type = QEMU_OPT_STRING,
1049             .help = "try to optimize zero writes (off, on, unmap)",
1050         },
1051         {
1052             .name = "discard",
1053             .type = QEMU_OPT_STRING,
1054             .help = "discard operation (ignore/off, unmap/on)",
1055         },
1056         { /* end of list */ }
1057     },
1058 };
1059
1060 /*
1061  * Common part for opening disk images and files
1062  *
1063  * Removes all processed options from *options.
1064  */
1065 static int bdrv_open_common(BlockDriverState *bs, BlockBackend *file,
1066                             QDict *options, Error **errp)
1067 {
1068     int ret, open_flags;
1069     const char *filename;
1070     const char *driver_name = NULL;
1071     const char *node_name = NULL;
1072     const char *discard;
1073     const char *detect_zeroes;
1074     QemuOpts *opts;
1075     BlockDriver *drv;
1076     Error *local_err = NULL;
1077
1078     assert(bs->file == NULL);
1079     assert(options != NULL && bs->options != options);
1080
1081     opts = qemu_opts_create(&bdrv_runtime_opts, NULL, 0, &error_abort);
1082     qemu_opts_absorb_qdict(opts, options, &local_err);
1083     if (local_err) {
1084         error_propagate(errp, local_err);
1085         ret = -EINVAL;
1086         goto fail_opts;
1087     }
1088
1089     update_flags_from_options(&bs->open_flags, opts);
1090
1091     driver_name = qemu_opt_get(opts, "driver");
1092     drv = bdrv_find_format(driver_name);
1093     assert(drv != NULL);
1094
1095     if (file != NULL) {
1096         filename = blk_bs(file)->filename;
1097     } else {
1098         filename = qdict_get_try_str(options, "filename");
1099     }
1100
1101     if (drv->bdrv_needs_filename && !filename) {
1102         error_setg(errp, "The '%s' block driver requires a file name",
1103                    drv->format_name);
1104         ret = -EINVAL;
1105         goto fail_opts;
1106     }
1107
1108     trace_bdrv_open_common(bs, filename ?: "", bs->open_flags,
1109                            drv->format_name);
1110
1111     bs->read_only = !(bs->open_flags & BDRV_O_RDWR);
1112
1113     if (use_bdrv_whitelist && !bdrv_is_whitelisted(drv, bs->read_only)) {
1114         error_setg(errp,
1115                    !bs->read_only && bdrv_is_whitelisted(drv, true)
1116                         ? "Driver '%s' can only be used for read-only devices"
1117                         : "Driver '%s' is not whitelisted",
1118                    drv->format_name);
1119         ret = -ENOTSUP;
1120         goto fail_opts;
1121     }
1122
1123     assert(bs->copy_on_read == 0); /* bdrv_new() and bdrv_close() make it so */
1124     if (bs->open_flags & BDRV_O_COPY_ON_READ) {
1125         if (!bs->read_only) {
1126             bdrv_enable_copy_on_read(bs);
1127         } else {
1128             error_setg(errp, "Can't use copy-on-read on read-only device");
1129             ret = -EINVAL;
1130             goto fail_opts;
1131         }
1132     }
1133
1134     discard = qemu_opt_get(opts, "discard");
1135     if (discard != NULL) {
1136         if (bdrv_parse_discard_flags(discard, &bs->open_flags) != 0) {
1137             error_setg(errp, "Invalid discard option");
1138             ret = -EINVAL;
1139             goto fail_opts;
1140         }
1141     }
1142
1143     detect_zeroes = qemu_opt_get(opts, "detect-zeroes");
1144     if (detect_zeroes) {
1145         BlockdevDetectZeroesOptions value =
1146             qapi_enum_parse(BlockdevDetectZeroesOptions_lookup,
1147                             detect_zeroes,
1148                             BLOCKDEV_DETECT_ZEROES_OPTIONS__MAX,
1149                             BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
1150                             &local_err);
1151         if (local_err) {
1152             error_propagate(errp, local_err);
1153             ret = -EINVAL;
1154             goto fail_opts;
1155         }
1156
1157         if (value == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP &&
1158             !(bs->open_flags & BDRV_O_UNMAP))
1159         {
1160             error_setg(errp, "setting detect-zeroes to unmap is not allowed "
1161                              "without setting discard operation to unmap");
1162             ret = -EINVAL;
1163             goto fail_opts;
1164         }
1165
1166         bs->detect_zeroes = value;
1167     }
1168
1169     if (filename != NULL) {
1170         pstrcpy(bs->filename, sizeof(bs->filename), filename);
1171     } else {
1172         bs->filename[0] = '\0';
1173     }
1174     pstrcpy(bs->exact_filename, sizeof(bs->exact_filename), bs->filename);
1175
1176     /* Open the image, either directly or using a protocol */
1177     open_flags = bdrv_open_flags(bs, bs->open_flags);
1178     node_name = qemu_opt_get(opts, "node-name");
1179
1180     assert(!drv->bdrv_file_open || file == NULL);
1181     ret = bdrv_open_driver(bs, drv, node_name, options, open_flags, errp);
1182     if (ret < 0) {
1183         goto fail_opts;
1184     }
1185
1186     qemu_opts_del(opts);
1187     return 0;
1188
1189 fail_opts:
1190     qemu_opts_del(opts);
1191     return ret;
1192 }
1193
1194 static QDict *parse_json_filename(const char *filename, Error **errp)
1195 {
1196     QObject *options_obj;
1197     QDict *options;
1198     int ret;
1199
1200     ret = strstart(filename, "json:", &filename);
1201     assert(ret);
1202
1203     options_obj = qobject_from_json(filename);
1204     if (!options_obj) {
1205         error_setg(errp, "Could not parse the JSON options");
1206         return NULL;
1207     }
1208
1209     options = qobject_to_qdict(options_obj);
1210     if (!options) {
1211         qobject_decref(options_obj);
1212         error_setg(errp, "Invalid JSON object given");
1213         return NULL;
1214     }
1215
1216     qdict_flatten(options);
1217
1218     return options;
1219 }
1220
1221 static void parse_json_protocol(QDict *options, const char **pfilename,
1222                                 Error **errp)
1223 {
1224     QDict *json_options;
1225     Error *local_err = NULL;
1226
1227     /* Parse json: pseudo-protocol */
1228     if (!*pfilename || !g_str_has_prefix(*pfilename, "json:")) {
1229         return;
1230     }
1231
1232     json_options = parse_json_filename(*pfilename, &local_err);
1233     if (local_err) {
1234         error_propagate(errp, local_err);
1235         return;
1236     }
1237
1238     /* Options given in the filename have lower priority than options
1239      * specified directly */
1240     qdict_join(options, json_options, false);
1241     QDECREF(json_options);
1242     *pfilename = NULL;
1243 }
1244
1245 /*
1246  * Fills in default options for opening images and converts the legacy
1247  * filename/flags pair to option QDict entries.
1248  * The BDRV_O_PROTOCOL flag in *flags will be set or cleared accordingly if a
1249  * block driver has been specified explicitly.
1250  */
1251 static int bdrv_fill_options(QDict **options, const char *filename,
1252                              int *flags, Error **errp)
1253 {
1254     const char *drvname;
1255     bool protocol = *flags & BDRV_O_PROTOCOL;
1256     bool parse_filename = false;
1257     BlockDriver *drv = NULL;
1258     Error *local_err = NULL;
1259
1260     drvname = qdict_get_try_str(*options, "driver");
1261     if (drvname) {
1262         drv = bdrv_find_format(drvname);
1263         if (!drv) {
1264             error_setg(errp, "Unknown driver '%s'", drvname);
1265             return -ENOENT;
1266         }
1267         /* If the user has explicitly specified the driver, this choice should
1268          * override the BDRV_O_PROTOCOL flag */
1269         protocol = drv->bdrv_file_open;
1270     }
1271
1272     if (protocol) {
1273         *flags |= BDRV_O_PROTOCOL;
1274     } else {
1275         *flags &= ~BDRV_O_PROTOCOL;
1276     }
1277
1278     /* Translate cache options from flags into options */
1279     update_options_from_flags(*options, *flags);
1280
1281     /* Fetch the file name from the options QDict if necessary */
1282     if (protocol && filename) {
1283         if (!qdict_haskey(*options, "filename")) {
1284             qdict_put(*options, "filename", qstring_from_str(filename));
1285             parse_filename = true;
1286         } else {
1287             error_setg(errp, "Can't specify 'file' and 'filename' options at "
1288                              "the same time");
1289             return -EINVAL;
1290         }
1291     }
1292
1293     /* Find the right block driver */
1294     filename = qdict_get_try_str(*options, "filename");
1295
1296     if (!drvname && protocol) {
1297         if (filename) {
1298             drv = bdrv_find_protocol(filename, parse_filename, errp);
1299             if (!drv) {
1300                 return -EINVAL;
1301             }
1302
1303             drvname = drv->format_name;
1304             qdict_put(*options, "driver", qstring_from_str(drvname));
1305         } else {
1306             error_setg(errp, "Must specify either driver or file");
1307             return -EINVAL;
1308         }
1309     }
1310
1311     assert(drv || !protocol);
1312
1313     /* Driver-specific filename parsing */
1314     if (drv && drv->bdrv_parse_filename && parse_filename) {
1315         drv->bdrv_parse_filename(filename, *options, &local_err);
1316         if (local_err) {
1317             error_propagate(errp, local_err);
1318             return -EINVAL;
1319         }
1320
1321         if (!drv->bdrv_needs_filename) {
1322             qdict_del(*options, "filename");
1323         }
1324     }
1325
1326     return 0;
1327 }
1328
1329 static void bdrv_replace_child(BdrvChild *child, BlockDriverState *new_bs)
1330 {
1331     BlockDriverState *old_bs = child->bs;
1332
1333     if (old_bs) {
1334         if (old_bs->quiesce_counter && child->role->drained_end) {
1335             child->role->drained_end(child);
1336         }
1337         QLIST_REMOVE(child, next_parent);
1338     }
1339
1340     child->bs = new_bs;
1341
1342     if (new_bs) {
1343         QLIST_INSERT_HEAD(&new_bs->parents, child, next_parent);
1344         if (new_bs->quiesce_counter && child->role->drained_begin) {
1345             child->role->drained_begin(child);
1346         }
1347     }
1348 }
1349
1350 BdrvChild *bdrv_root_attach_child(BlockDriverState *child_bs,
1351                                   const char *child_name,
1352                                   const BdrvChildRole *child_role,
1353                                   void *opaque)
1354 {
1355     BdrvChild *child = g_new(BdrvChild, 1);
1356     *child = (BdrvChild) {
1357         .bs     = NULL,
1358         .name   = g_strdup(child_name),
1359         .role   = child_role,
1360         .opaque = opaque,
1361     };
1362
1363     bdrv_replace_child(child, child_bs);
1364
1365     return child;
1366 }
1367
1368 BdrvChild *bdrv_attach_child(BlockDriverState *parent_bs,
1369                              BlockDriverState *child_bs,
1370                              const char *child_name,
1371                              const BdrvChildRole *child_role,
1372                              Error **errp)
1373 {
1374     BdrvChild *child = bdrv_root_attach_child(child_bs, child_name, child_role,
1375                                               parent_bs);
1376     QLIST_INSERT_HEAD(&parent_bs->children, child, next);
1377     return child;
1378 }
1379
1380 static void bdrv_detach_child(BdrvChild *child)
1381 {
1382     if (child->next.le_prev) {
1383         QLIST_REMOVE(child, next);
1384         child->next.le_prev = NULL;
1385     }
1386
1387     bdrv_replace_child(child, NULL);
1388
1389     g_free(child->name);
1390     g_free(child);
1391 }
1392
1393 void bdrv_root_unref_child(BdrvChild *child)
1394 {
1395     BlockDriverState *child_bs;
1396
1397     child_bs = child->bs;
1398     bdrv_detach_child(child);
1399     bdrv_unref(child_bs);
1400 }
1401
1402 void bdrv_unref_child(BlockDriverState *parent, BdrvChild *child)
1403 {
1404     if (child == NULL) {
1405         return;
1406     }
1407
1408     if (child->bs->inherits_from == parent) {
1409         BdrvChild *c;
1410
1411         /* Remove inherits_from only when the last reference between parent and
1412          * child->bs goes away. */
1413         QLIST_FOREACH(c, &parent->children, next) {
1414             if (c != child && c->bs == child->bs) {
1415                 break;
1416             }
1417         }
1418         if (c == NULL) {
1419             child->bs->inherits_from = NULL;
1420         }
1421     }
1422
1423     bdrv_root_unref_child(child);
1424 }
1425
1426
1427 static void bdrv_parent_cb_change_media(BlockDriverState *bs, bool load)
1428 {
1429     BdrvChild *c;
1430     QLIST_FOREACH(c, &bs->parents, next_parent) {
1431         if (c->role->change_media) {
1432             c->role->change_media(c, load);
1433         }
1434     }
1435 }
1436
1437 static void bdrv_parent_cb_resize(BlockDriverState *bs)
1438 {
1439     BdrvChild *c;
1440     QLIST_FOREACH(c, &bs->parents, next_parent) {
1441         if (c->role->resize) {
1442             c->role->resize(c);
1443         }
1444     }
1445 }
1446
1447 /*
1448  * Sets the backing file link of a BDS. A new reference is created; callers
1449  * which don't need their own reference any more must call bdrv_unref().
1450  */
1451 void bdrv_set_backing_hd(BlockDriverState *bs, BlockDriverState *backing_hd)
1452 {
1453     if (backing_hd) {
1454         bdrv_ref(backing_hd);
1455     }
1456
1457     if (bs->backing) {
1458         assert(bs->backing_blocker);
1459         bdrv_op_unblock_all(bs->backing->bs, bs->backing_blocker);
1460         bdrv_unref_child(bs, bs->backing);
1461     } else if (backing_hd) {
1462         error_setg(&bs->backing_blocker,
1463                    "node is used as backing hd of '%s'",
1464                    bdrv_get_device_or_node_name(bs));
1465     }
1466
1467     if (!backing_hd) {
1468         error_free(bs->backing_blocker);
1469         bs->backing_blocker = NULL;
1470         bs->backing = NULL;
1471         goto out;
1472     }
1473     /* FIXME Error handling */
1474     bs->backing = bdrv_attach_child(bs, backing_hd, "backing", &child_backing,
1475                                     &error_abort);
1476     bs->open_flags &= ~BDRV_O_NO_BACKING;
1477     pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_hd->filename);
1478     pstrcpy(bs->backing_format, sizeof(bs->backing_format),
1479             backing_hd->drv ? backing_hd->drv->format_name : "");
1480
1481     bdrv_op_block_all(backing_hd, bs->backing_blocker);
1482     /* Otherwise we won't be able to commit or stream */
1483     bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_COMMIT_TARGET,
1484                     bs->backing_blocker);
1485     bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_STREAM,
1486                     bs->backing_blocker);
1487     /*
1488      * We do backup in 3 ways:
1489      * 1. drive backup
1490      *    The target bs is new opened, and the source is top BDS
1491      * 2. blockdev backup
1492      *    Both the source and the target are top BDSes.
1493      * 3. internal backup(used for block replication)
1494      *    Both the source and the target are backing file
1495      *
1496      * In case 1 and 2, neither the source nor the target is the backing file.
1497      * In case 3, we will block the top BDS, so there is only one block job
1498      * for the top BDS and its backing chain.
1499      */
1500     bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_BACKUP_SOURCE,
1501                     bs->backing_blocker);
1502     bdrv_op_unblock(backing_hd, BLOCK_OP_TYPE_BACKUP_TARGET,
1503                     bs->backing_blocker);
1504 out:
1505     bdrv_refresh_limits(bs, NULL);
1506 }
1507
1508 /*
1509  * Opens the backing file for a BlockDriverState if not yet open
1510  *
1511  * bdref_key specifies the key for the image's BlockdevRef in the options QDict.
1512  * That QDict has to be flattened; therefore, if the BlockdevRef is a QDict
1513  * itself, all options starting with "${bdref_key}." are considered part of the
1514  * BlockdevRef.
1515  *
1516  * TODO Can this be unified with bdrv_open_image()?
1517  */
1518 int bdrv_open_backing_file(BlockDriverState *bs, QDict *parent_options,
1519                            const char *bdref_key, Error **errp)
1520 {
1521     char *backing_filename = g_malloc0(PATH_MAX);
1522     char *bdref_key_dot;
1523     const char *reference = NULL;
1524     int ret = 0;
1525     BlockDriverState *backing_hd;
1526     QDict *options;
1527     QDict *tmp_parent_options = NULL;
1528     Error *local_err = NULL;
1529
1530     if (bs->backing != NULL) {
1531         goto free_exit;
1532     }
1533
1534     /* NULL means an empty set of options */
1535     if (parent_options == NULL) {
1536         tmp_parent_options = qdict_new();
1537         parent_options = tmp_parent_options;
1538     }
1539
1540     bs->open_flags &= ~BDRV_O_NO_BACKING;
1541
1542     bdref_key_dot = g_strdup_printf("%s.", bdref_key);
1543     qdict_extract_subqdict(parent_options, &options, bdref_key_dot);
1544     g_free(bdref_key_dot);
1545
1546     reference = qdict_get_try_str(parent_options, bdref_key);
1547     if (reference || qdict_haskey(options, "file.filename")) {
1548         backing_filename[0] = '\0';
1549     } else if (bs->backing_file[0] == '\0' && qdict_size(options) == 0) {
1550         QDECREF(options);
1551         goto free_exit;
1552     } else {
1553         bdrv_get_full_backing_filename(bs, backing_filename, PATH_MAX,
1554                                        &local_err);
1555         if (local_err) {
1556             ret = -EINVAL;
1557             error_propagate(errp, local_err);
1558             QDECREF(options);
1559             goto free_exit;
1560         }
1561     }
1562
1563     if (!bs->drv || !bs->drv->supports_backing) {
1564         ret = -EINVAL;
1565         error_setg(errp, "Driver doesn't support backing files");
1566         QDECREF(options);
1567         goto free_exit;
1568     }
1569
1570     if (bs->backing_format[0] != '\0' && !qdict_haskey(options, "driver")) {
1571         qdict_put(options, "driver", qstring_from_str(bs->backing_format));
1572     }
1573
1574     backing_hd = bdrv_open_inherit(*backing_filename ? backing_filename : NULL,
1575                                    reference, options, 0, bs, &child_backing,
1576                                    errp);
1577     if (!backing_hd) {
1578         bs->open_flags |= BDRV_O_NO_BACKING;
1579         error_prepend(errp, "Could not open backing file: ");
1580         ret = -EINVAL;
1581         goto free_exit;
1582     }
1583
1584     /* Hook up the backing file link; drop our reference, bs owns the
1585      * backing_hd reference now */
1586     bdrv_set_backing_hd(bs, backing_hd);
1587     bdrv_unref(backing_hd);
1588
1589     qdict_del(parent_options, bdref_key);
1590
1591 free_exit:
1592     g_free(backing_filename);
1593     QDECREF(tmp_parent_options);
1594     return ret;
1595 }
1596
1597 static BlockDriverState *
1598 bdrv_open_child_bs(const char *filename, QDict *options, const char *bdref_key,
1599                    BlockDriverState *parent, const BdrvChildRole *child_role,
1600                    bool allow_none, Error **errp)
1601 {
1602     BlockDriverState *bs = NULL;
1603     QDict *image_options;
1604     char *bdref_key_dot;
1605     const char *reference;
1606
1607     assert(child_role != NULL);
1608
1609     bdref_key_dot = g_strdup_printf("%s.", bdref_key);
1610     qdict_extract_subqdict(options, &image_options, bdref_key_dot);
1611     g_free(bdref_key_dot);
1612
1613     reference = qdict_get_try_str(options, bdref_key);
1614     if (!filename && !reference && !qdict_size(image_options)) {
1615         if (!allow_none) {
1616             error_setg(errp, "A block device must be specified for \"%s\"",
1617                        bdref_key);
1618         }
1619         QDECREF(image_options);
1620         goto done;
1621     }
1622
1623     bs = bdrv_open_inherit(filename, reference, image_options, 0,
1624                            parent, child_role, errp);
1625     if (!bs) {
1626         goto done;
1627     }
1628
1629 done:
1630     qdict_del(options, bdref_key);
1631     return bs;
1632 }
1633
1634 /*
1635  * Opens a disk image whose options are given as BlockdevRef in another block
1636  * device's options.
1637  *
1638  * If allow_none is true, no image will be opened if filename is false and no
1639  * BlockdevRef is given. NULL will be returned, but errp remains unset.
1640  *
1641  * bdrev_key specifies the key for the image's BlockdevRef in the options QDict.
1642  * That QDict has to be flattened; therefore, if the BlockdevRef is a QDict
1643  * itself, all options starting with "${bdref_key}." are considered part of the
1644  * BlockdevRef.
1645  *
1646  * The BlockdevRef will be removed from the options QDict.
1647  */
1648 BdrvChild *bdrv_open_child(const char *filename,
1649                            QDict *options, const char *bdref_key,
1650                            BlockDriverState *parent,
1651                            const BdrvChildRole *child_role,
1652                            bool allow_none, Error **errp)
1653 {
1654     BdrvChild *c;
1655     BlockDriverState *bs;
1656
1657     bs = bdrv_open_child_bs(filename, options, bdref_key, parent, child_role,
1658                             allow_none, errp);
1659     if (bs == NULL) {
1660         return NULL;
1661     }
1662
1663     c = bdrv_attach_child(parent, bs, bdref_key, child_role, errp);
1664     if (!c) {
1665         bdrv_unref(bs);
1666         return NULL;
1667     }
1668
1669     return c;
1670 }
1671
1672 static BlockDriverState *bdrv_append_temp_snapshot(BlockDriverState *bs,
1673                                                    int flags,
1674                                                    QDict *snapshot_options,
1675                                                    Error **errp)
1676 {
1677     /* TODO: extra byte is a hack to ensure MAX_PATH space on Windows. */
1678     char *tmp_filename = g_malloc0(PATH_MAX + 1);
1679     int64_t total_size;
1680     QemuOpts *opts = NULL;
1681     BlockDriverState *bs_snapshot;
1682     int ret;
1683
1684     /* if snapshot, we create a temporary backing file and open it
1685        instead of opening 'filename' directly */
1686
1687     /* Get the required size from the image */
1688     total_size = bdrv_getlength(bs);
1689     if (total_size < 0) {
1690         error_setg_errno(errp, -total_size, "Could not get image size");
1691         goto out;
1692     }
1693
1694     /* Create the temporary image */
1695     ret = get_tmp_filename(tmp_filename, PATH_MAX + 1);
1696     if (ret < 0) {
1697         error_setg_errno(errp, -ret, "Could not get temporary filename");
1698         goto out;
1699     }
1700
1701     opts = qemu_opts_create(bdrv_qcow2.create_opts, NULL, 0,
1702                             &error_abort);
1703     qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_size, &error_abort);
1704     ret = bdrv_create(&bdrv_qcow2, tmp_filename, opts, errp);
1705     qemu_opts_del(opts);
1706     if (ret < 0) {
1707         error_prepend(errp, "Could not create temporary overlay '%s': ",
1708                       tmp_filename);
1709         goto out;
1710     }
1711
1712     /* Prepare options QDict for the temporary file */
1713     qdict_put(snapshot_options, "file.driver",
1714               qstring_from_str("file"));
1715     qdict_put(snapshot_options, "file.filename",
1716               qstring_from_str(tmp_filename));
1717     qdict_put(snapshot_options, "driver",
1718               qstring_from_str("qcow2"));
1719
1720     bs_snapshot = bdrv_open(NULL, NULL, snapshot_options, flags, errp);
1721     snapshot_options = NULL;
1722     if (!bs_snapshot) {
1723         ret = -EINVAL;
1724         goto out;
1725     }
1726
1727     /* bdrv_append() consumes a strong reference to bs_snapshot (i.e. it will
1728      * call bdrv_unref() on it), so in order to be able to return one, we have
1729      * to increase bs_snapshot's refcount here */
1730     bdrv_ref(bs_snapshot);
1731     bdrv_append(bs_snapshot, bs);
1732
1733     g_free(tmp_filename);
1734     return bs_snapshot;
1735
1736 out:
1737     QDECREF(snapshot_options);
1738     g_free(tmp_filename);
1739     return NULL;
1740 }
1741
1742 /*
1743  * Opens a disk image (raw, qcow2, vmdk, ...)
1744  *
1745  * options is a QDict of options to pass to the block drivers, or NULL for an
1746  * empty set of options. The reference to the QDict belongs to the block layer
1747  * after the call (even on failure), so if the caller intends to reuse the
1748  * dictionary, it needs to use QINCREF() before calling bdrv_open.
1749  *
1750  * If *pbs is NULL, a new BDS will be created with a pointer to it stored there.
1751  * If it is not NULL, the referenced BDS will be reused.
1752  *
1753  * The reference parameter may be used to specify an existing block device which
1754  * should be opened. If specified, neither options nor a filename may be given,
1755  * nor can an existing BDS be reused (that is, *pbs has to be NULL).
1756  */
1757 static BlockDriverState *bdrv_open_inherit(const char *filename,
1758                                            const char *reference,
1759                                            QDict *options, int flags,
1760                                            BlockDriverState *parent,
1761                                            const BdrvChildRole *child_role,
1762                                            Error **errp)
1763 {
1764     int ret;
1765     BlockBackend *file = NULL;
1766     BlockDriverState *bs;
1767     BlockDriver *drv = NULL;
1768     const char *drvname;
1769     const char *backing;
1770     Error *local_err = NULL;
1771     QDict *snapshot_options = NULL;
1772     int snapshot_flags = 0;
1773
1774     assert(!child_role || !flags);
1775     assert(!child_role == !parent);
1776
1777     if (reference) {
1778         bool options_non_empty = options ? qdict_size(options) : false;
1779         QDECREF(options);
1780
1781         if (filename || options_non_empty) {
1782             error_setg(errp, "Cannot reference an existing block device with "
1783                        "additional options or a new filename");
1784             return NULL;
1785         }
1786
1787         bs = bdrv_lookup_bs(reference, reference, errp);
1788         if (!bs) {
1789             return NULL;
1790         }
1791
1792         bdrv_ref(bs);
1793         return bs;
1794     }
1795
1796     bs = bdrv_new();
1797
1798     /* NULL means an empty set of options */
1799     if (options == NULL) {
1800         options = qdict_new();
1801     }
1802
1803     /* json: syntax counts as explicit options, as if in the QDict */
1804     parse_json_protocol(options, &filename, &local_err);
1805     if (local_err) {
1806         goto fail;
1807     }
1808
1809     bs->explicit_options = qdict_clone_shallow(options);
1810
1811     if (child_role) {
1812         bs->inherits_from = parent;
1813         child_role->inherit_options(&flags, options,
1814                                     parent->open_flags, parent->options);
1815     }
1816
1817     ret = bdrv_fill_options(&options, filename, &flags, &local_err);
1818     if (local_err) {
1819         goto fail;
1820     }
1821
1822     /* Set the BDRV_O_RDWR and BDRV_O_ALLOW_RDWR flags.
1823      * FIXME: we're parsing the QDict to avoid having to create a
1824      * QemuOpts just for this, but neither option is optimal. */
1825     if (g_strcmp0(qdict_get_try_str(options, BDRV_OPT_READ_ONLY), "on") &&
1826         !qdict_get_try_bool(options, BDRV_OPT_READ_ONLY, false)) {
1827         flags |= (BDRV_O_RDWR | BDRV_O_ALLOW_RDWR);
1828     } else {
1829         flags &= ~BDRV_O_RDWR;
1830     }
1831
1832     if (flags & BDRV_O_SNAPSHOT) {
1833         snapshot_options = qdict_new();
1834         bdrv_temp_snapshot_options(&snapshot_flags, snapshot_options,
1835                                    flags, options);
1836         /* Let bdrv_backing_options() override "read-only" */
1837         qdict_del(options, BDRV_OPT_READ_ONLY);
1838         bdrv_backing_options(&flags, options, flags, options);
1839     }
1840
1841     bs->open_flags = flags;
1842     bs->options = options;
1843     options = qdict_clone_shallow(options);
1844
1845     /* Find the right image format driver */
1846     drvname = qdict_get_try_str(options, "driver");
1847     if (drvname) {
1848         drv = bdrv_find_format(drvname);
1849         if (!drv) {
1850             error_setg(errp, "Unknown driver: '%s'", drvname);
1851             goto fail;
1852         }
1853     }
1854
1855     assert(drvname || !(flags & BDRV_O_PROTOCOL));
1856
1857     backing = qdict_get_try_str(options, "backing");
1858     if (backing && *backing == '\0') {
1859         flags |= BDRV_O_NO_BACKING;
1860         qdict_del(options, "backing");
1861     }
1862
1863     /* Open image file without format layer. This BlockBackend is only used for
1864      * probing, the block drivers will do their own bdrv_open_child() for the
1865      * same BDS, which is why we put the node name back into options. */
1866     if ((flags & BDRV_O_PROTOCOL) == 0) {
1867         BlockDriverState *file_bs;
1868
1869         file_bs = bdrv_open_child_bs(filename, options, "file", bs,
1870                                      &child_file, true, &local_err);
1871         if (local_err) {
1872             goto fail;
1873         }
1874         if (file_bs != NULL) {
1875             file = blk_new();
1876             blk_insert_bs(file, file_bs);
1877             bdrv_unref(file_bs);
1878
1879             qdict_put(options, "file",
1880                       qstring_from_str(bdrv_get_node_name(file_bs)));
1881         }
1882     }
1883
1884     /* Image format probing */
1885     bs->probed = !drv;
1886     if (!drv && file) {
1887         ret = find_image_format(file, filename, &drv, &local_err);
1888         if (ret < 0) {
1889             goto fail;
1890         }
1891         /*
1892          * This option update would logically belong in bdrv_fill_options(),
1893          * but we first need to open bs->file for the probing to work, while
1894          * opening bs->file already requires the (mostly) final set of options
1895          * so that cache mode etc. can be inherited.
1896          *
1897          * Adding the driver later is somewhat ugly, but it's not an option
1898          * that would ever be inherited, so it's correct. We just need to make
1899          * sure to update both bs->options (which has the full effective
1900          * options for bs) and options (which has file.* already removed).
1901          */
1902         qdict_put(bs->options, "driver", qstring_from_str(drv->format_name));
1903         qdict_put(options, "driver", qstring_from_str(drv->format_name));
1904     } else if (!drv) {
1905         error_setg(errp, "Must specify either driver or file");
1906         goto fail;
1907     }
1908
1909     /* BDRV_O_PROTOCOL must be set iff a protocol BDS is about to be created */
1910     assert(!!(flags & BDRV_O_PROTOCOL) == !!drv->bdrv_file_open);
1911     /* file must be NULL if a protocol BDS is about to be created
1912      * (the inverse results in an error message from bdrv_open_common()) */
1913     assert(!(flags & BDRV_O_PROTOCOL) || !file);
1914
1915     /* Open the image */
1916     ret = bdrv_open_common(bs, file, options, &local_err);
1917     if (ret < 0) {
1918         goto fail;
1919     }
1920
1921     if (file) {
1922         blk_unref(file);
1923         file = NULL;
1924     }
1925
1926     /* If there is a backing file, use it */
1927     if ((flags & BDRV_O_NO_BACKING) == 0) {
1928         ret = bdrv_open_backing_file(bs, options, "backing", &local_err);
1929         if (ret < 0) {
1930             goto close_and_fail;
1931         }
1932     }
1933
1934     bdrv_refresh_filename(bs);
1935
1936     /* Check if any unknown options were used */
1937     if (qdict_size(options) != 0) {
1938         const QDictEntry *entry = qdict_first(options);
1939         if (flags & BDRV_O_PROTOCOL) {
1940             error_setg(errp, "Block protocol '%s' doesn't support the option "
1941                        "'%s'", drv->format_name, entry->key);
1942         } else {
1943             error_setg(errp,
1944                        "Block format '%s' does not support the option '%s'",
1945                        drv->format_name, entry->key);
1946         }
1947
1948         goto close_and_fail;
1949     }
1950
1951     if (!bdrv_key_required(bs)) {
1952         bdrv_parent_cb_change_media(bs, true);
1953     } else if (!runstate_check(RUN_STATE_PRELAUNCH)
1954                && !runstate_check(RUN_STATE_INMIGRATE)
1955                && !runstate_check(RUN_STATE_PAUSED)) { /* HACK */
1956         error_setg(errp,
1957                    "Guest must be stopped for opening of encrypted image");
1958         goto close_and_fail;
1959     }
1960
1961     QDECREF(options);
1962
1963     /* For snapshot=on, create a temporary qcow2 overlay. bs points to the
1964      * temporary snapshot afterwards. */
1965     if (snapshot_flags) {
1966         BlockDriverState *snapshot_bs;
1967         snapshot_bs = bdrv_append_temp_snapshot(bs, snapshot_flags,
1968                                                 snapshot_options, &local_err);
1969         snapshot_options = NULL;
1970         if (local_err) {
1971             goto close_and_fail;
1972         }
1973         /* We are not going to return bs but the overlay on top of it
1974          * (snapshot_bs); thus, we have to drop the strong reference to bs
1975          * (which we obtained by calling bdrv_new()). bs will not be deleted,
1976          * though, because the overlay still has a reference to it. */
1977         bdrv_unref(bs);
1978         bs = snapshot_bs;
1979     }
1980
1981     return bs;
1982
1983 fail:
1984     blk_unref(file);
1985     if (bs->file != NULL) {
1986         bdrv_unref_child(bs, bs->file);
1987     }
1988     QDECREF(snapshot_options);
1989     QDECREF(bs->explicit_options);
1990     QDECREF(bs->options);
1991     QDECREF(options);
1992     bs->options = NULL;
1993     bdrv_unref(bs);
1994     error_propagate(errp, local_err);
1995     return NULL;
1996
1997 close_and_fail:
1998     bdrv_unref(bs);
1999     QDECREF(snapshot_options);
2000     QDECREF(options);
2001     error_propagate(errp, local_err);
2002     return NULL;
2003 }
2004
2005 BlockDriverState *bdrv_open(const char *filename, const char *reference,
2006                             QDict *options, int flags, Error **errp)
2007 {
2008     return bdrv_open_inherit(filename, reference, options, flags, NULL,
2009                              NULL, errp);
2010 }
2011
2012 typedef struct BlockReopenQueueEntry {
2013      bool prepared;
2014      BDRVReopenState state;
2015      QSIMPLEQ_ENTRY(BlockReopenQueueEntry) entry;
2016 } BlockReopenQueueEntry;
2017
2018 /*
2019  * Adds a BlockDriverState to a simple queue for an atomic, transactional
2020  * reopen of multiple devices.
2021  *
2022  * bs_queue can either be an existing BlockReopenQueue that has had QSIMPLE_INIT
2023  * already performed, or alternatively may be NULL a new BlockReopenQueue will
2024  * be created and initialized. This newly created BlockReopenQueue should be
2025  * passed back in for subsequent calls that are intended to be of the same
2026  * atomic 'set'.
2027  *
2028  * bs is the BlockDriverState to add to the reopen queue.
2029  *
2030  * options contains the changed options for the associated bs
2031  * (the BlockReopenQueue takes ownership)
2032  *
2033  * flags contains the open flags for the associated bs
2034  *
2035  * returns a pointer to bs_queue, which is either the newly allocated
2036  * bs_queue, or the existing bs_queue being used.
2037  *
2038  */
2039 static BlockReopenQueue *bdrv_reopen_queue_child(BlockReopenQueue *bs_queue,
2040                                                  BlockDriverState *bs,
2041                                                  QDict *options,
2042                                                  int flags,
2043                                                  const BdrvChildRole *role,
2044                                                  QDict *parent_options,
2045                                                  int parent_flags)
2046 {
2047     assert(bs != NULL);
2048
2049     BlockReopenQueueEntry *bs_entry;
2050     BdrvChild *child;
2051     QDict *old_options, *explicit_options;
2052
2053     if (bs_queue == NULL) {
2054         bs_queue = g_new0(BlockReopenQueue, 1);
2055         QSIMPLEQ_INIT(bs_queue);
2056     }
2057
2058     if (!options) {
2059         options = qdict_new();
2060     }
2061
2062     /* Check if this BlockDriverState is already in the queue */
2063     QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) {
2064         if (bs == bs_entry->state.bs) {
2065             break;
2066         }
2067     }
2068
2069     /*
2070      * Precedence of options:
2071      * 1. Explicitly passed in options (highest)
2072      * 2. Set in flags (only for top level)
2073      * 3. Retained from explicitly set options of bs
2074      * 4. Inherited from parent node
2075      * 5. Retained from effective options of bs
2076      */
2077
2078     if (!parent_options) {
2079         /*
2080          * Any setting represented by flags is always updated. If the
2081          * corresponding QDict option is set, it takes precedence. Otherwise
2082          * the flag is translated into a QDict option. The old setting of bs is
2083          * not considered.
2084          */
2085         update_options_from_flags(options, flags);
2086     }
2087
2088     /* Old explicitly set values (don't overwrite by inherited value) */
2089     if (bs_entry) {
2090         old_options = qdict_clone_shallow(bs_entry->state.explicit_options);
2091     } else {
2092         old_options = qdict_clone_shallow(bs->explicit_options);
2093     }
2094     bdrv_join_options(bs, options, old_options);
2095     QDECREF(old_options);
2096
2097     explicit_options = qdict_clone_shallow(options);
2098
2099     /* Inherit from parent node */
2100     if (parent_options) {
2101         assert(!flags);
2102         role->inherit_options(&flags, options, parent_flags, parent_options);
2103     }
2104
2105     /* Old values are used for options that aren't set yet */
2106     old_options = qdict_clone_shallow(bs->options);
2107     bdrv_join_options(bs, options, old_options);
2108     QDECREF(old_options);
2109
2110     /* bdrv_open() masks this flag out */
2111     flags &= ~BDRV_O_PROTOCOL;
2112
2113     QLIST_FOREACH(child, &bs->children, next) {
2114         QDict *new_child_options;
2115         char *child_key_dot;
2116
2117         /* reopen can only change the options of block devices that were
2118          * implicitly created and inherited options. For other (referenced)
2119          * block devices, a syntax like "backing.foo" results in an error. */
2120         if (child->bs->inherits_from != bs) {
2121             continue;
2122         }
2123
2124         child_key_dot = g_strdup_printf("%s.", child->name);
2125         qdict_extract_subqdict(options, &new_child_options, child_key_dot);
2126         g_free(child_key_dot);
2127
2128         bdrv_reopen_queue_child(bs_queue, child->bs, new_child_options, 0,
2129                                 child->role, options, flags);
2130     }
2131
2132     if (!bs_entry) {
2133         bs_entry = g_new0(BlockReopenQueueEntry, 1);
2134         QSIMPLEQ_INSERT_TAIL(bs_queue, bs_entry, entry);
2135     } else {
2136         QDECREF(bs_entry->state.options);
2137         QDECREF(bs_entry->state.explicit_options);
2138     }
2139
2140     bs_entry->state.bs = bs;
2141     bs_entry->state.options = options;
2142     bs_entry->state.explicit_options = explicit_options;
2143     bs_entry->state.flags = flags;
2144
2145     return bs_queue;
2146 }
2147
2148 BlockReopenQueue *bdrv_reopen_queue(BlockReopenQueue *bs_queue,
2149                                     BlockDriverState *bs,
2150                                     QDict *options, int flags)
2151 {
2152     return bdrv_reopen_queue_child(bs_queue, bs, options, flags,
2153                                    NULL, NULL, 0);
2154 }
2155
2156 /*
2157  * Reopen multiple BlockDriverStates atomically & transactionally.
2158  *
2159  * The queue passed in (bs_queue) must have been built up previous
2160  * via bdrv_reopen_queue().
2161  *
2162  * Reopens all BDS specified in the queue, with the appropriate
2163  * flags.  All devices are prepared for reopen, and failure of any
2164  * device will cause all device changes to be abandonded, and intermediate
2165  * data cleaned up.
2166  *
2167  * If all devices prepare successfully, then the changes are committed
2168  * to all devices.
2169  *
2170  */
2171 int bdrv_reopen_multiple(AioContext *ctx, BlockReopenQueue *bs_queue, Error **errp)
2172 {
2173     int ret = -1;
2174     BlockReopenQueueEntry *bs_entry, *next;
2175     Error *local_err = NULL;
2176
2177     assert(bs_queue != NULL);
2178
2179     aio_context_release(ctx);
2180     bdrv_drain_all_begin();
2181     aio_context_acquire(ctx);
2182
2183     QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) {
2184         if (bdrv_reopen_prepare(&bs_entry->state, bs_queue, &local_err)) {
2185             error_propagate(errp, local_err);
2186             goto cleanup;
2187         }
2188         bs_entry->prepared = true;
2189     }
2190
2191     /* If we reach this point, we have success and just need to apply the
2192      * changes
2193      */
2194     QSIMPLEQ_FOREACH(bs_entry, bs_queue, entry) {
2195         bdrv_reopen_commit(&bs_entry->state);
2196     }
2197
2198     ret = 0;
2199
2200 cleanup:
2201     QSIMPLEQ_FOREACH_SAFE(bs_entry, bs_queue, entry, next) {
2202         if (ret && bs_entry->prepared) {
2203             bdrv_reopen_abort(&bs_entry->state);
2204         } else if (ret) {
2205             QDECREF(bs_entry->state.explicit_options);
2206         }
2207         QDECREF(bs_entry->state.options);
2208         g_free(bs_entry);
2209     }
2210     g_free(bs_queue);
2211
2212     bdrv_drain_all_end();
2213
2214     return ret;
2215 }
2216
2217
2218 /* Reopen a single BlockDriverState with the specified flags. */
2219 int bdrv_reopen(BlockDriverState *bs, int bdrv_flags, Error **errp)
2220 {
2221     int ret = -1;
2222     Error *local_err = NULL;
2223     BlockReopenQueue *queue = bdrv_reopen_queue(NULL, bs, NULL, bdrv_flags);
2224
2225     ret = bdrv_reopen_multiple(bdrv_get_aio_context(bs), queue, &local_err);
2226     if (local_err != NULL) {
2227         error_propagate(errp, local_err);
2228     }
2229     return ret;
2230 }
2231
2232
2233 /*
2234  * Prepares a BlockDriverState for reopen. All changes are staged in the
2235  * 'opaque' field of the BDRVReopenState, which is used and allocated by
2236  * the block driver layer .bdrv_reopen_prepare()
2237  *
2238  * bs is the BlockDriverState to reopen
2239  * flags are the new open flags
2240  * queue is the reopen queue
2241  *
2242  * Returns 0 on success, non-zero on error.  On error errp will be set
2243  * as well.
2244  *
2245  * On failure, bdrv_reopen_abort() will be called to clean up any data.
2246  * It is the responsibility of the caller to then call the abort() or
2247  * commit() for any other BDS that have been left in a prepare() state
2248  *
2249  */
2250 int bdrv_reopen_prepare(BDRVReopenState *reopen_state, BlockReopenQueue *queue,
2251                         Error **errp)
2252 {
2253     int ret = -1;
2254     Error *local_err = NULL;
2255     BlockDriver *drv;
2256     QemuOpts *opts;
2257     const char *value;
2258
2259     assert(reopen_state != NULL);
2260     assert(reopen_state->bs->drv != NULL);
2261     drv = reopen_state->bs->drv;
2262
2263     /* Process generic block layer options */
2264     opts = qemu_opts_create(&bdrv_runtime_opts, NULL, 0, &error_abort);
2265     qemu_opts_absorb_qdict(opts, reopen_state->options, &local_err);
2266     if (local_err) {
2267         error_propagate(errp, local_err);
2268         ret = -EINVAL;
2269         goto error;
2270     }
2271
2272     update_flags_from_options(&reopen_state->flags, opts);
2273
2274     /* node-name and driver must be unchanged. Put them back into the QDict, so
2275      * that they are checked at the end of this function. */
2276     value = qemu_opt_get(opts, "node-name");
2277     if (value) {
2278         qdict_put(reopen_state->options, "node-name", qstring_from_str(value));
2279     }
2280
2281     value = qemu_opt_get(opts, "driver");
2282     if (value) {
2283         qdict_put(reopen_state->options, "driver", qstring_from_str(value));
2284     }
2285
2286     /* if we are to stay read-only, do not allow permission change
2287      * to r/w */
2288     if (!(reopen_state->bs->open_flags & BDRV_O_ALLOW_RDWR) &&
2289         reopen_state->flags & BDRV_O_RDWR) {
2290         error_setg(errp, "Node '%s' is read only",
2291                    bdrv_get_device_or_node_name(reopen_state->bs));
2292         goto error;
2293     }
2294
2295
2296     ret = bdrv_flush(reopen_state->bs);
2297     if (ret) {
2298         error_setg_errno(errp, -ret, "Error flushing drive");
2299         goto error;
2300     }
2301
2302     if (drv->bdrv_reopen_prepare) {
2303         ret = drv->bdrv_reopen_prepare(reopen_state, queue, &local_err);
2304         if (ret) {
2305             if (local_err != NULL) {
2306                 error_propagate(errp, local_err);
2307             } else {
2308                 error_setg(errp, "failed while preparing to reopen image '%s'",
2309                            reopen_state->bs->filename);
2310             }
2311             goto error;
2312         }
2313     } else {
2314         /* It is currently mandatory to have a bdrv_reopen_prepare()
2315          * handler for each supported drv. */
2316         error_setg(errp, "Block format '%s' used by node '%s' "
2317                    "does not support reopening files", drv->format_name,
2318                    bdrv_get_device_or_node_name(reopen_state->bs));
2319         ret = -1;
2320         goto error;
2321     }
2322
2323     /* Options that are not handled are only okay if they are unchanged
2324      * compared to the old state. It is expected that some options are only
2325      * used for the initial open, but not reopen (e.g. filename) */
2326     if (qdict_size(reopen_state->options)) {
2327         const QDictEntry *entry = qdict_first(reopen_state->options);
2328
2329         do {
2330             QString *new_obj = qobject_to_qstring(entry->value);
2331             const char *new = qstring_get_str(new_obj);
2332             const char *old = qdict_get_try_str(reopen_state->bs->options,
2333                                                 entry->key);
2334
2335             if (!old || strcmp(new, old)) {
2336                 error_setg(errp, "Cannot change the option '%s'", entry->key);
2337                 ret = -EINVAL;
2338                 goto error;
2339             }
2340         } while ((entry = qdict_next(reopen_state->options, entry)));
2341     }
2342
2343     ret = 0;
2344
2345 error:
2346     qemu_opts_del(opts);
2347     return ret;
2348 }
2349
2350 /*
2351  * Takes the staged changes for the reopen from bdrv_reopen_prepare(), and
2352  * makes them final by swapping the staging BlockDriverState contents into
2353  * the active BlockDriverState contents.
2354  */
2355 void bdrv_reopen_commit(BDRVReopenState *reopen_state)
2356 {
2357     BlockDriver *drv;
2358
2359     assert(reopen_state != NULL);
2360     drv = reopen_state->bs->drv;
2361     assert(drv != NULL);
2362
2363     /* If there are any driver level actions to take */
2364     if (drv->bdrv_reopen_commit) {
2365         drv->bdrv_reopen_commit(reopen_state);
2366     }
2367
2368     /* set BDS specific flags now */
2369     QDECREF(reopen_state->bs->explicit_options);
2370
2371     reopen_state->bs->explicit_options   = reopen_state->explicit_options;
2372     reopen_state->bs->open_flags         = reopen_state->flags;
2373     reopen_state->bs->read_only = !(reopen_state->flags & BDRV_O_RDWR);
2374
2375     bdrv_refresh_limits(reopen_state->bs, NULL);
2376 }
2377
2378 /*
2379  * Abort the reopen, and delete and free the staged changes in
2380  * reopen_state
2381  */
2382 void bdrv_reopen_abort(BDRVReopenState *reopen_state)
2383 {
2384     BlockDriver *drv;
2385
2386     assert(reopen_state != NULL);
2387     drv = reopen_state->bs->drv;
2388     assert(drv != NULL);
2389
2390     if (drv->bdrv_reopen_abort) {
2391         drv->bdrv_reopen_abort(reopen_state);
2392     }
2393
2394     QDECREF(reopen_state->explicit_options);
2395 }
2396
2397
2398 static void bdrv_close(BlockDriverState *bs)
2399 {
2400     BdrvAioNotifier *ban, *ban_next;
2401
2402     assert(!bs->job);
2403     assert(!bs->refcnt);
2404
2405     bdrv_drained_begin(bs); /* complete I/O */
2406     bdrv_flush(bs);
2407     bdrv_drain(bs); /* in case flush left pending I/O */
2408
2409     bdrv_release_named_dirty_bitmaps(bs);
2410     assert(QLIST_EMPTY(&bs->dirty_bitmaps));
2411
2412     if (bs->drv) {
2413         BdrvChild *child, *next;
2414
2415         bs->drv->bdrv_close(bs);
2416         bs->drv = NULL;
2417
2418         bdrv_set_backing_hd(bs, NULL);
2419
2420         if (bs->file != NULL) {
2421             bdrv_unref_child(bs, bs->file);
2422             bs->file = NULL;
2423         }
2424
2425         QLIST_FOREACH_SAFE(child, &bs->children, next, next) {
2426             /* TODO Remove bdrv_unref() from drivers' close function and use
2427              * bdrv_unref_child() here */
2428             if (child->bs->inherits_from == bs) {
2429                 child->bs->inherits_from = NULL;
2430             }
2431             bdrv_detach_child(child);
2432         }
2433
2434         g_free(bs->opaque);
2435         bs->opaque = NULL;
2436         bs->copy_on_read = 0;
2437         bs->backing_file[0] = '\0';
2438         bs->backing_format[0] = '\0';
2439         bs->total_sectors = 0;
2440         bs->encrypted = false;
2441         bs->valid_key = false;
2442         bs->sg = false;
2443         QDECREF(bs->options);
2444         QDECREF(bs->explicit_options);
2445         bs->options = NULL;
2446         QDECREF(bs->full_open_options);
2447         bs->full_open_options = NULL;
2448     }
2449
2450     QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_next) {
2451         g_free(ban);
2452     }
2453     QLIST_INIT(&bs->aio_notifiers);
2454     bdrv_drained_end(bs);
2455 }
2456
2457 void bdrv_close_all(void)
2458 {
2459     block_job_cancel_sync_all();
2460     nbd_export_close_all();
2461
2462     /* Drop references from requests still in flight, such as canceled block
2463      * jobs whose AIO context has not been polled yet */
2464     bdrv_drain_all();
2465
2466     blk_remove_all_bs();
2467     blockdev_close_all_bdrv_states();
2468
2469     assert(QTAILQ_EMPTY(&all_bdrv_states));
2470 }
2471
2472 static void change_parent_backing_link(BlockDriverState *from,
2473                                        BlockDriverState *to)
2474 {
2475     BdrvChild *c, *next, *to_c;
2476
2477     QLIST_FOREACH_SAFE(c, &from->parents, next_parent, next) {
2478         if (c->role == &child_backing) {
2479             /* @from is generally not allowed to be a backing file, except for
2480              * when @to is the overlay. In that case, @from may not be replaced
2481              * by @to as @to's backing node. */
2482             QLIST_FOREACH(to_c, &to->children, next) {
2483                 if (to_c == c) {
2484                     break;
2485                 }
2486             }
2487             if (to_c) {
2488                 continue;
2489             }
2490         }
2491
2492         assert(c->role != &child_backing);
2493         bdrv_ref(to);
2494         bdrv_replace_child(c, to);
2495         bdrv_unref(from);
2496     }
2497 }
2498
2499 /*
2500  * Add new bs contents at the top of an image chain while the chain is
2501  * live, while keeping required fields on the top layer.
2502  *
2503  * This will modify the BlockDriverState fields, and swap contents
2504  * between bs_new and bs_top. Both bs_new and bs_top are modified.
2505  *
2506  * bs_new must not be attached to a BlockBackend.
2507  *
2508  * This function does not create any image files.
2509  *
2510  * bdrv_append() takes ownership of a bs_new reference and unrefs it because
2511  * that's what the callers commonly need. bs_new will be referenced by the old
2512  * parents of bs_top after bdrv_append() returns. If the caller needs to keep a
2513  * reference of its own, it must call bdrv_ref().
2514  */
2515 void bdrv_append(BlockDriverState *bs_new, BlockDriverState *bs_top)
2516 {
2517     assert(!bdrv_requests_pending(bs_top));
2518     assert(!bdrv_requests_pending(bs_new));
2519
2520     bdrv_ref(bs_top);
2521
2522     change_parent_backing_link(bs_top, bs_new);
2523     bdrv_set_backing_hd(bs_new, bs_top);
2524     bdrv_unref(bs_top);
2525
2526     /* bs_new is now referenced by its new parents, we don't need the
2527      * additional reference any more. */
2528     bdrv_unref(bs_new);
2529 }
2530
2531 void bdrv_replace_in_backing_chain(BlockDriverState *old, BlockDriverState *new)
2532 {
2533     assert(!bdrv_requests_pending(old));
2534     assert(!bdrv_requests_pending(new));
2535
2536     bdrv_ref(old);
2537
2538     change_parent_backing_link(old, new);
2539
2540     bdrv_unref(old);
2541 }
2542
2543 static void bdrv_delete(BlockDriverState *bs)
2544 {
2545     assert(!bs->job);
2546     assert(bdrv_op_blocker_is_empty(bs));
2547     assert(!bs->refcnt);
2548
2549     bdrv_close(bs);
2550
2551     /* remove from list, if necessary */
2552     if (bs->node_name[0] != '\0') {
2553         QTAILQ_REMOVE(&graph_bdrv_states, bs, node_list);
2554     }
2555     QTAILQ_REMOVE(&all_bdrv_states, bs, bs_list);
2556
2557     g_free(bs);
2558 }
2559
2560 /*
2561  * Run consistency checks on an image
2562  *
2563  * Returns 0 if the check could be completed (it doesn't mean that the image is
2564  * free of errors) or -errno when an internal error occurred. The results of the
2565  * check are stored in res.
2566  */
2567 int bdrv_check(BlockDriverState *bs, BdrvCheckResult *res, BdrvCheckMode fix)
2568 {
2569     if (bs->drv == NULL) {
2570         return -ENOMEDIUM;
2571     }
2572     if (bs->drv->bdrv_check == NULL) {
2573         return -ENOTSUP;
2574     }
2575
2576     memset(res, 0, sizeof(*res));
2577     return bs->drv->bdrv_check(bs, res, fix);
2578 }
2579
2580 /*
2581  * Return values:
2582  * 0        - success
2583  * -EINVAL  - backing format specified, but no file
2584  * -ENOSPC  - can't update the backing file because no space is left in the
2585  *            image file header
2586  * -ENOTSUP - format driver doesn't support changing the backing file
2587  */
2588 int bdrv_change_backing_file(BlockDriverState *bs,
2589     const char *backing_file, const char *backing_fmt)
2590 {
2591     BlockDriver *drv = bs->drv;
2592     int ret;
2593
2594     /* Backing file format doesn't make sense without a backing file */
2595     if (backing_fmt && !backing_file) {
2596         return -EINVAL;
2597     }
2598
2599     if (drv->bdrv_change_backing_file != NULL) {
2600         ret = drv->bdrv_change_backing_file(bs, backing_file, backing_fmt);
2601     } else {
2602         ret = -ENOTSUP;
2603     }
2604
2605     if (ret == 0) {
2606         pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: "");
2607         pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: "");
2608     }
2609     return ret;
2610 }
2611
2612 /*
2613  * Finds the image layer in the chain that has 'bs' as its backing file.
2614  *
2615  * active is the current topmost image.
2616  *
2617  * Returns NULL if bs is not found in active's image chain,
2618  * or if active == bs.
2619  *
2620  * Returns the bottommost base image if bs == NULL.
2621  */
2622 BlockDriverState *bdrv_find_overlay(BlockDriverState *active,
2623                                     BlockDriverState *bs)
2624 {
2625     while (active && bs != backing_bs(active)) {
2626         active = backing_bs(active);
2627     }
2628
2629     return active;
2630 }
2631
2632 /* Given a BDS, searches for the base layer. */
2633 BlockDriverState *bdrv_find_base(BlockDriverState *bs)
2634 {
2635     return bdrv_find_overlay(bs, NULL);
2636 }
2637
2638 /*
2639  * Drops images above 'base' up to and including 'top', and sets the image
2640  * above 'top' to have base as its backing file.
2641  *
2642  * Requires that the overlay to 'top' is opened r/w, so that the backing file
2643  * information in 'bs' can be properly updated.
2644  *
2645  * E.g., this will convert the following chain:
2646  * bottom <- base <- intermediate <- top <- active
2647  *
2648  * to
2649  *
2650  * bottom <- base <- active
2651  *
2652  * It is allowed for bottom==base, in which case it converts:
2653  *
2654  * base <- intermediate <- top <- active
2655  *
2656  * to
2657  *
2658  * base <- active
2659  *
2660  * If backing_file_str is non-NULL, it will be used when modifying top's
2661  * overlay image metadata.
2662  *
2663  * Error conditions:
2664  *  if active == top, that is considered an error
2665  *
2666  */
2667 int bdrv_drop_intermediate(BlockDriverState *active, BlockDriverState *top,
2668                            BlockDriverState *base, const char *backing_file_str)
2669 {
2670     BlockDriverState *new_top_bs = NULL;
2671     int ret = -EIO;
2672
2673     if (!top->drv || !base->drv) {
2674         goto exit;
2675     }
2676
2677     new_top_bs = bdrv_find_overlay(active, top);
2678
2679     if (new_top_bs == NULL) {
2680         /* we could not find the image above 'top', this is an error */
2681         goto exit;
2682     }
2683
2684     /* special case of new_top_bs->backing->bs already pointing to base - nothing
2685      * to do, no intermediate images */
2686     if (backing_bs(new_top_bs) == base) {
2687         ret = 0;
2688         goto exit;
2689     }
2690
2691     /* Make sure that base is in the backing chain of top */
2692     if (!bdrv_chain_contains(top, base)) {
2693         goto exit;
2694     }
2695
2696     /* success - we can delete the intermediate states, and link top->base */
2697     backing_file_str = backing_file_str ? backing_file_str : base->filename;
2698     ret = bdrv_change_backing_file(new_top_bs, backing_file_str,
2699                                    base->drv ? base->drv->format_name : "");
2700     if (ret) {
2701         goto exit;
2702     }
2703     bdrv_set_backing_hd(new_top_bs, base);
2704
2705     ret = 0;
2706 exit:
2707     return ret;
2708 }
2709
2710 /**
2711  * Truncate file to 'offset' bytes (needed only for file protocols)
2712  */
2713 int bdrv_truncate(BdrvChild *child, int64_t offset)
2714 {
2715     BlockDriverState *bs = child->bs;
2716     BlockDriver *drv = bs->drv;
2717     int ret;
2718     if (!drv)
2719         return -ENOMEDIUM;
2720     if (!drv->bdrv_truncate)
2721         return -ENOTSUP;
2722     if (bs->read_only)
2723         return -EACCES;
2724
2725     ret = drv->bdrv_truncate(bs, offset);
2726     if (ret == 0) {
2727         ret = refresh_total_sectors(bs, offset >> BDRV_SECTOR_BITS);
2728         bdrv_dirty_bitmap_truncate(bs);
2729         bdrv_parent_cb_resize(bs);
2730         ++bs->write_gen;
2731     }
2732     return ret;
2733 }
2734
2735 /**
2736  * Length of a allocated file in bytes. Sparse files are counted by actual
2737  * allocated space. Return < 0 if error or unknown.
2738  */
2739 int64_t bdrv_get_allocated_file_size(BlockDriverState *bs)
2740 {
2741     BlockDriver *drv = bs->drv;
2742     if (!drv) {
2743         return -ENOMEDIUM;
2744     }
2745     if (drv->bdrv_get_allocated_file_size) {
2746         return drv->bdrv_get_allocated_file_size(bs);
2747     }
2748     if (bs->file) {
2749         return bdrv_get_allocated_file_size(bs->file->bs);
2750     }
2751     return -ENOTSUP;
2752 }
2753
2754 /**
2755  * Return number of sectors on success, -errno on error.
2756  */
2757 int64_t bdrv_nb_sectors(BlockDriverState *bs)
2758 {
2759     BlockDriver *drv = bs->drv;
2760
2761     if (!drv)
2762         return -ENOMEDIUM;
2763
2764     if (drv->has_variable_length) {
2765         int ret = refresh_total_sectors(bs, bs->total_sectors);
2766         if (ret < 0) {
2767             return ret;
2768         }
2769     }
2770     return bs->total_sectors;
2771 }
2772
2773 /**
2774  * Return length in bytes on success, -errno on error.
2775  * The length is always a multiple of BDRV_SECTOR_SIZE.
2776  */
2777 int64_t bdrv_getlength(BlockDriverState *bs)
2778 {
2779     int64_t ret = bdrv_nb_sectors(bs);
2780
2781     ret = ret > INT64_MAX / BDRV_SECTOR_SIZE ? -EFBIG : ret;
2782     return ret < 0 ? ret : ret * BDRV_SECTOR_SIZE;
2783 }
2784
2785 /* return 0 as number of sectors if no device present or error */
2786 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr)
2787 {
2788     int64_t nb_sectors = bdrv_nb_sectors(bs);
2789
2790     *nb_sectors_ptr = nb_sectors < 0 ? 0 : nb_sectors;
2791 }
2792
2793 bool bdrv_is_read_only(BlockDriverState *bs)
2794 {
2795     return bs->read_only;
2796 }
2797
2798 bool bdrv_is_sg(BlockDriverState *bs)
2799 {
2800     return bs->sg;
2801 }
2802
2803 bool bdrv_is_encrypted(BlockDriverState *bs)
2804 {
2805     if (bs->backing && bs->backing->bs->encrypted) {
2806         return true;
2807     }
2808     return bs->encrypted;
2809 }
2810
2811 bool bdrv_key_required(BlockDriverState *bs)
2812 {
2813     BdrvChild *backing = bs->backing;
2814
2815     if (backing && backing->bs->encrypted && !backing->bs->valid_key) {
2816         return true;
2817     }
2818     return (bs->encrypted && !bs->valid_key);
2819 }
2820
2821 int bdrv_set_key(BlockDriverState *bs, const char *key)
2822 {
2823     int ret;
2824     if (bs->backing && bs->backing->bs->encrypted) {
2825         ret = bdrv_set_key(bs->backing->bs, key);
2826         if (ret < 0)
2827             return ret;
2828         if (!bs->encrypted)
2829             return 0;
2830     }
2831     if (!bs->encrypted) {
2832         return -EINVAL;
2833     } else if (!bs->drv || !bs->drv->bdrv_set_key) {
2834         return -ENOMEDIUM;
2835     }
2836     ret = bs->drv->bdrv_set_key(bs, key);
2837     if (ret < 0) {
2838         bs->valid_key = false;
2839     } else if (!bs->valid_key) {
2840         /* call the change callback now, we skipped it on open */
2841         bs->valid_key = true;
2842         bdrv_parent_cb_change_media(bs, true);
2843     }
2844     return ret;
2845 }
2846
2847 /*
2848  * Provide an encryption key for @bs.
2849  * If @key is non-null:
2850  *     If @bs is not encrypted, fail.
2851  *     Else if the key is invalid, fail.
2852  *     Else set @bs's key to @key, replacing the existing key, if any.
2853  * If @key is null:
2854  *     If @bs is encrypted and still lacks a key, fail.
2855  *     Else do nothing.
2856  * On failure, store an error object through @errp if non-null.
2857  */
2858 void bdrv_add_key(BlockDriverState *bs, const char *key, Error **errp)
2859 {
2860     if (key) {
2861         if (!bdrv_is_encrypted(bs)) {
2862             error_setg(errp, "Node '%s' is not encrypted",
2863                       bdrv_get_device_or_node_name(bs));
2864         } else if (bdrv_set_key(bs, key) < 0) {
2865             error_setg(errp, QERR_INVALID_PASSWORD);
2866         }
2867     } else {
2868         if (bdrv_key_required(bs)) {
2869             error_set(errp, ERROR_CLASS_DEVICE_ENCRYPTED,
2870                       "'%s' (%s) is encrypted",
2871                       bdrv_get_device_or_node_name(bs),
2872                       bdrv_get_encrypted_filename(bs));
2873         }
2874     }
2875 }
2876
2877 const char *bdrv_get_format_name(BlockDriverState *bs)
2878 {
2879     return bs->drv ? bs->drv->format_name : NULL;
2880 }
2881
2882 static int qsort_strcmp(const void *a, const void *b)
2883 {
2884     return strcmp(*(char *const *)a, *(char *const *)b);
2885 }
2886
2887 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
2888                          void *opaque)
2889 {
2890     BlockDriver *drv;
2891     int count = 0;
2892     int i;
2893     const char **formats = NULL;
2894
2895     QLIST_FOREACH(drv, &bdrv_drivers, list) {
2896         if (drv->format_name) {
2897             bool found = false;
2898             int i = count;
2899             while (formats && i && !found) {
2900                 found = !strcmp(formats[--i], drv->format_name);
2901             }
2902
2903             if (!found) {
2904                 formats = g_renew(const char *, formats, count + 1);
2905                 formats[count++] = drv->format_name;
2906             }
2907         }
2908     }
2909
2910     for (i = 0; i < (int)ARRAY_SIZE(block_driver_modules); i++) {
2911         const char *format_name = block_driver_modules[i].format_name;
2912
2913         if (format_name) {
2914             bool found = false;
2915             int j = count;
2916
2917             while (formats && j && !found) {
2918                 found = !strcmp(formats[--j], format_name);
2919             }
2920
2921             if (!found) {
2922                 formats = g_renew(const char *, formats, count + 1);
2923                 formats[count++] = format_name;
2924             }
2925         }
2926     }
2927
2928     qsort(formats, count, sizeof(formats[0]), qsort_strcmp);
2929
2930     for (i = 0; i < count; i++) {
2931         it(opaque, formats[i]);
2932     }
2933
2934     g_free(formats);
2935 }
2936
2937 /* This function is to find a node in the bs graph */
2938 BlockDriverState *bdrv_find_node(const char *node_name)
2939 {
2940     BlockDriverState *bs;
2941
2942     assert(node_name);
2943
2944     QTAILQ_FOREACH(bs, &graph_bdrv_states, node_list) {
2945         if (!strcmp(node_name, bs->node_name)) {
2946             return bs;
2947         }
2948     }
2949     return NULL;
2950 }
2951
2952 /* Put this QMP function here so it can access the static graph_bdrv_states. */
2953 BlockDeviceInfoList *bdrv_named_nodes_list(Error **errp)
2954 {
2955     BlockDeviceInfoList *list, *entry;
2956     BlockDriverState *bs;
2957
2958     list = NULL;
2959     QTAILQ_FOREACH(bs, &graph_bdrv_states, node_list) {
2960         BlockDeviceInfo *info = bdrv_block_device_info(NULL, bs, errp);
2961         if (!info) {
2962             qapi_free_BlockDeviceInfoList(list);
2963             return NULL;
2964         }
2965         entry = g_malloc0(sizeof(*entry));
2966         entry->value = info;
2967         entry->next = list;
2968         list = entry;
2969     }
2970
2971     return list;
2972 }
2973
2974 BlockDriverState *bdrv_lookup_bs(const char *device,
2975                                  const char *node_name,
2976                                  Error **errp)
2977 {
2978     BlockBackend *blk;
2979     BlockDriverState *bs;
2980
2981     if (device) {
2982         blk = blk_by_name(device);
2983
2984         if (blk) {
2985             bs = blk_bs(blk);
2986             if (!bs) {
2987                 error_setg(errp, "Device '%s' has no medium", device);
2988             }
2989
2990             return bs;
2991         }
2992     }
2993
2994     if (node_name) {
2995         bs = bdrv_find_node(node_name);
2996
2997         if (bs) {
2998             return bs;
2999         }
3000     }
3001
3002     error_setg(errp, "Cannot find device=%s nor node_name=%s",
3003                      device ? device : "",
3004                      node_name ? node_name : "");
3005     return NULL;
3006 }
3007
3008 /* If 'base' is in the same chain as 'top', return true. Otherwise,
3009  * return false.  If either argument is NULL, return false. */
3010 bool bdrv_chain_contains(BlockDriverState *top, BlockDriverState *base)
3011 {
3012     while (top && top != base) {
3013         top = backing_bs(top);
3014     }
3015
3016     return top != NULL;
3017 }
3018
3019 BlockDriverState *bdrv_next_node(BlockDriverState *bs)
3020 {
3021     if (!bs) {
3022         return QTAILQ_FIRST(&graph_bdrv_states);
3023     }
3024     return QTAILQ_NEXT(bs, node_list);
3025 }
3026
3027 const char *bdrv_get_node_name(const BlockDriverState *bs)
3028 {
3029     return bs->node_name;
3030 }
3031
3032 const char *bdrv_get_parent_name(const BlockDriverState *bs)
3033 {
3034     BdrvChild *c;
3035     const char *name;
3036
3037     /* If multiple parents have a name, just pick the first one. */
3038     QLIST_FOREACH(c, &bs->parents, next_parent) {
3039         if (c->role->get_name) {
3040             name = c->role->get_name(c);
3041             if (name && *name) {
3042                 return name;
3043             }
3044         }
3045     }
3046
3047     return NULL;
3048 }
3049
3050 /* TODO check what callers really want: bs->node_name or blk_name() */
3051 const char *bdrv_get_device_name(const BlockDriverState *bs)
3052 {
3053     return bdrv_get_parent_name(bs) ?: "";
3054 }
3055
3056 /* This can be used to identify nodes that might not have a device
3057  * name associated. Since node and device names live in the same
3058  * namespace, the result is unambiguous. The exception is if both are
3059  * absent, then this returns an empty (non-null) string. */
3060 const char *bdrv_get_device_or_node_name(const BlockDriverState *bs)
3061 {
3062     return bdrv_get_parent_name(bs) ?: bs->node_name;
3063 }
3064
3065 int bdrv_get_flags(BlockDriverState *bs)
3066 {
3067     return bs->open_flags;
3068 }
3069
3070 int bdrv_has_zero_init_1(BlockDriverState *bs)
3071 {
3072     return 1;
3073 }
3074
3075 int bdrv_has_zero_init(BlockDriverState *bs)
3076 {
3077     assert(bs->drv);
3078
3079     /* If BS is a copy on write image, it is initialized to
3080        the contents of the base image, which may not be zeroes.  */
3081     if (bs->backing) {
3082         return 0;
3083     }
3084     if (bs->drv->bdrv_has_zero_init) {
3085         return bs->drv->bdrv_has_zero_init(bs);
3086     }
3087
3088     /* safe default */
3089     return 0;
3090 }
3091
3092 bool bdrv_unallocated_blocks_are_zero(BlockDriverState *bs)
3093 {
3094     BlockDriverInfo bdi;
3095
3096     if (bs->backing) {
3097         return false;
3098     }
3099
3100     if (bdrv_get_info(bs, &bdi) == 0) {
3101         return bdi.unallocated_blocks_are_zero;
3102     }
3103
3104     return false;
3105 }
3106
3107 bool bdrv_can_write_zeroes_with_unmap(BlockDriverState *bs)
3108 {
3109     BlockDriverInfo bdi;
3110
3111     if (!(bs->open_flags & BDRV_O_UNMAP)) {
3112         return false;
3113     }
3114
3115     if (bdrv_get_info(bs, &bdi) == 0) {
3116         return bdi.can_write_zeroes_with_unmap;
3117     }
3118
3119     return false;
3120 }
3121
3122 const char *bdrv_get_encrypted_filename(BlockDriverState *bs)
3123 {
3124     if (bs->backing && bs->backing->bs->encrypted)
3125         return bs->backing_file;
3126     else if (bs->encrypted)
3127         return bs->filename;
3128     else
3129         return NULL;
3130 }
3131
3132 void bdrv_get_backing_filename(BlockDriverState *bs,
3133                                char *filename, int filename_size)
3134 {
3135     pstrcpy(filename, filename_size, bs->backing_file);
3136 }
3137
3138 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
3139 {
3140     BlockDriver *drv = bs->drv;
3141     if (!drv)
3142         return -ENOMEDIUM;
3143     if (!drv->bdrv_get_info)
3144         return -ENOTSUP;
3145     memset(bdi, 0, sizeof(*bdi));
3146     return drv->bdrv_get_info(bs, bdi);
3147 }
3148
3149 ImageInfoSpecific *bdrv_get_specific_info(BlockDriverState *bs)
3150 {
3151     BlockDriver *drv = bs->drv;
3152     if (drv && drv->bdrv_get_specific_info) {
3153         return drv->bdrv_get_specific_info(bs);
3154     }
3155     return NULL;
3156 }
3157
3158 void bdrv_debug_event(BlockDriverState *bs, BlkdebugEvent event)
3159 {
3160     if (!bs || !bs->drv || !bs->drv->bdrv_debug_event) {
3161         return;
3162     }
3163
3164     bs->drv->bdrv_debug_event(bs, event);
3165 }
3166
3167 int bdrv_debug_breakpoint(BlockDriverState *bs, const char *event,
3168                           const char *tag)
3169 {
3170     while (bs && bs->drv && !bs->drv->bdrv_debug_breakpoint) {
3171         bs = bs->file ? bs->file->bs : NULL;
3172     }
3173
3174     if (bs && bs->drv && bs->drv->bdrv_debug_breakpoint) {
3175         return bs->drv->bdrv_debug_breakpoint(bs, event, tag);
3176     }
3177
3178     return -ENOTSUP;
3179 }
3180
3181 int bdrv_debug_remove_breakpoint(BlockDriverState *bs, const char *tag)
3182 {
3183     while (bs && bs->drv && !bs->drv->bdrv_debug_remove_breakpoint) {
3184         bs = bs->file ? bs->file->bs : NULL;
3185     }
3186
3187     if (bs && bs->drv && bs->drv->bdrv_debug_remove_breakpoint) {
3188         return bs->drv->bdrv_debug_remove_breakpoint(bs, tag);
3189     }
3190
3191     return -ENOTSUP;
3192 }
3193
3194 int bdrv_debug_resume(BlockDriverState *bs, const char *tag)
3195 {
3196     while (bs && (!bs->drv || !bs->drv->bdrv_debug_resume)) {
3197         bs = bs->file ? bs->file->bs : NULL;
3198     }
3199
3200     if (bs && bs->drv && bs->drv->bdrv_debug_resume) {
3201         return bs->drv->bdrv_debug_resume(bs, tag);
3202     }
3203
3204     return -ENOTSUP;
3205 }
3206
3207 bool bdrv_debug_is_suspended(BlockDriverState *bs, const char *tag)
3208 {
3209     while (bs && bs->drv && !bs->drv->bdrv_debug_is_suspended) {
3210         bs = bs->file ? bs->file->bs : NULL;
3211     }
3212
3213     if (bs && bs->drv && bs->drv->bdrv_debug_is_suspended) {
3214         return bs->drv->bdrv_debug_is_suspended(bs, tag);
3215     }
3216
3217     return false;
3218 }
3219
3220 /* backing_file can either be relative, or absolute, or a protocol.  If it is
3221  * relative, it must be relative to the chain.  So, passing in bs->filename
3222  * from a BDS as backing_file should not be done, as that may be relative to
3223  * the CWD rather than the chain. */
3224 BlockDriverState *bdrv_find_backing_image(BlockDriverState *bs,
3225         const char *backing_file)
3226 {
3227     char *filename_full = NULL;
3228     char *backing_file_full = NULL;
3229     char *filename_tmp = NULL;
3230     int is_protocol = 0;
3231     BlockDriverState *curr_bs = NULL;
3232     BlockDriverState *retval = NULL;
3233     Error *local_error = NULL;
3234
3235     if (!bs || !bs->drv || !backing_file) {
3236         return NULL;
3237     }
3238
3239     filename_full     = g_malloc(PATH_MAX);
3240     backing_file_full = g_malloc(PATH_MAX);
3241     filename_tmp      = g_malloc(PATH_MAX);
3242
3243     is_protocol = path_has_protocol(backing_file);
3244
3245     for (curr_bs = bs; curr_bs->backing; curr_bs = curr_bs->backing->bs) {
3246
3247         /* If either of the filename paths is actually a protocol, then
3248          * compare unmodified paths; otherwise make paths relative */
3249         if (is_protocol || path_has_protocol(curr_bs->backing_file)) {
3250             if (strcmp(backing_file, curr_bs->backing_file) == 0) {
3251                 retval = curr_bs->backing->bs;
3252                 break;
3253             }
3254             /* Also check against the full backing filename for the image */
3255             bdrv_get_full_backing_filename(curr_bs, backing_file_full, PATH_MAX,
3256                                            &local_error);
3257             if (local_error == NULL) {
3258                 if (strcmp(backing_file, backing_file_full) == 0) {
3259                     retval = curr_bs->backing->bs;
3260                     break;
3261                 }
3262             } else {
3263                 error_free(local_error);
3264                 local_error = NULL;
3265             }
3266         } else {
3267             /* If not an absolute filename path, make it relative to the current
3268              * image's filename path */
3269             path_combine(filename_tmp, PATH_MAX, curr_bs->filename,
3270                          backing_file);
3271
3272             /* We are going to compare absolute pathnames */
3273             if (!realpath(filename_tmp, filename_full)) {
3274                 continue;
3275             }
3276
3277             /* We need to make sure the backing filename we are comparing against
3278              * is relative to the current image filename (or absolute) */
3279             path_combine(filename_tmp, PATH_MAX, curr_bs->filename,
3280                          curr_bs->backing_file);
3281
3282             if (!realpath(filename_tmp, backing_file_full)) {
3283                 continue;
3284             }
3285
3286             if (strcmp(backing_file_full, filename_full) == 0) {
3287                 retval = curr_bs->backing->bs;
3288                 break;
3289             }
3290         }
3291     }
3292
3293     g_free(filename_full);
3294     g_free(backing_file_full);
3295     g_free(filename_tmp);
3296     return retval;
3297 }
3298
3299 int bdrv_get_backing_file_depth(BlockDriverState *bs)
3300 {
3301     if (!bs->drv) {
3302         return 0;
3303     }
3304
3305     if (!bs->backing) {
3306         return 0;
3307     }
3308
3309     return 1 + bdrv_get_backing_file_depth(bs->backing->bs);
3310 }
3311
3312 void bdrv_init(void)
3313 {
3314     module_call_init(MODULE_INIT_BLOCK);
3315 }
3316
3317 void bdrv_init_with_whitelist(void)
3318 {
3319     use_bdrv_whitelist = 1;
3320     bdrv_init();
3321 }
3322
3323 void bdrv_invalidate_cache(BlockDriverState *bs, Error **errp)
3324 {
3325     BdrvChild *child;
3326     Error *local_err = NULL;
3327     int ret;
3328
3329     if (!bs->drv)  {
3330         return;
3331     }
3332
3333     if (!(bs->open_flags & BDRV_O_INACTIVE)) {
3334         return;
3335     }
3336
3337     QLIST_FOREACH(child, &bs->children, next) {
3338         bdrv_invalidate_cache(child->bs, &local_err);
3339         if (local_err) {
3340             error_propagate(errp, local_err);
3341             return;
3342         }
3343     }
3344
3345     bs->open_flags &= ~BDRV_O_INACTIVE;
3346     if (bs->drv->bdrv_invalidate_cache) {
3347         bs->drv->bdrv_invalidate_cache(bs, &local_err);
3348         if (local_err) {
3349             bs->open_flags |= BDRV_O_INACTIVE;
3350             error_propagate(errp, local_err);
3351             return;
3352         }
3353     }
3354
3355     ret = refresh_total_sectors(bs, bs->total_sectors);
3356     if (ret < 0) {
3357         bs->open_flags |= BDRV_O_INACTIVE;
3358         error_setg_errno(errp, -ret, "Could not refresh total sector count");
3359         return;
3360     }
3361 }
3362
3363 void bdrv_invalidate_cache_all(Error **errp)
3364 {
3365     BlockDriverState *bs;
3366     Error *local_err = NULL;
3367     BdrvNextIterator it;
3368
3369     for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
3370         AioContext *aio_context = bdrv_get_aio_context(bs);
3371
3372         aio_context_acquire(aio_context);
3373         bdrv_invalidate_cache(bs, &local_err);
3374         aio_context_release(aio_context);
3375         if (local_err) {
3376             error_propagate(errp, local_err);
3377             return;
3378         }
3379     }
3380 }
3381
3382 static int bdrv_inactivate_recurse(BlockDriverState *bs,
3383                                    bool setting_flag)
3384 {
3385     BdrvChild *child;
3386     int ret;
3387
3388     if (!setting_flag && bs->drv->bdrv_inactivate) {
3389         ret = bs->drv->bdrv_inactivate(bs);
3390         if (ret < 0) {
3391             return ret;
3392         }
3393     }
3394
3395     QLIST_FOREACH(child, &bs->children, next) {
3396         ret = bdrv_inactivate_recurse(child->bs, setting_flag);
3397         if (ret < 0) {
3398             return ret;
3399         }
3400     }
3401
3402     if (setting_flag) {
3403         bs->open_flags |= BDRV_O_INACTIVE;
3404     }
3405     return 0;
3406 }
3407
3408 int bdrv_inactivate_all(void)
3409 {
3410     BlockDriverState *bs = NULL;
3411     BdrvNextIterator it;
3412     int ret = 0;
3413     int pass;
3414
3415     for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
3416         aio_context_acquire(bdrv_get_aio_context(bs));
3417     }
3418
3419     /* We do two passes of inactivation. The first pass calls to drivers'
3420      * .bdrv_inactivate callbacks recursively so all cache is flushed to disk;
3421      * the second pass sets the BDRV_O_INACTIVE flag so that no further write
3422      * is allowed. */
3423     for (pass = 0; pass < 2; pass++) {
3424         for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
3425             ret = bdrv_inactivate_recurse(bs, pass);
3426             if (ret < 0) {
3427                 goto out;
3428             }
3429         }
3430     }
3431
3432 out:
3433     for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
3434         aio_context_release(bdrv_get_aio_context(bs));
3435     }
3436
3437     return ret;
3438 }
3439
3440 /**************************************************************/
3441 /* removable device support */
3442
3443 /**
3444  * Return TRUE if the media is present
3445  */
3446 bool bdrv_is_inserted(BlockDriverState *bs)
3447 {
3448     BlockDriver *drv = bs->drv;
3449     BdrvChild *child;
3450
3451     if (!drv) {
3452         return false;
3453     }
3454     if (drv->bdrv_is_inserted) {
3455         return drv->bdrv_is_inserted(bs);
3456     }
3457     QLIST_FOREACH(child, &bs->children, next) {
3458         if (!bdrv_is_inserted(child->bs)) {
3459             return false;
3460         }
3461     }
3462     return true;
3463 }
3464
3465 /**
3466  * Return whether the media changed since the last call to this
3467  * function, or -ENOTSUP if we don't know.  Most drivers don't know.
3468  */
3469 int bdrv_media_changed(BlockDriverState *bs)
3470 {
3471     BlockDriver *drv = bs->drv;
3472
3473     if (drv && drv->bdrv_media_changed) {
3474         return drv->bdrv_media_changed(bs);
3475     }
3476     return -ENOTSUP;
3477 }
3478
3479 /**
3480  * If eject_flag is TRUE, eject the media. Otherwise, close the tray
3481  */
3482 void bdrv_eject(BlockDriverState *bs, bool eject_flag)
3483 {
3484     BlockDriver *drv = bs->drv;
3485
3486     if (drv && drv->bdrv_eject) {
3487         drv->bdrv_eject(bs, eject_flag);
3488     }
3489 }
3490
3491 /**
3492  * Lock or unlock the media (if it is locked, the user won't be able
3493  * to eject it manually).
3494  */
3495 void bdrv_lock_medium(BlockDriverState *bs, bool locked)
3496 {
3497     BlockDriver *drv = bs->drv;
3498
3499     trace_bdrv_lock_medium(bs, locked);
3500
3501     if (drv && drv->bdrv_lock_medium) {
3502         drv->bdrv_lock_medium(bs, locked);
3503     }
3504 }
3505
3506 /* Get a reference to bs */
3507 void bdrv_ref(BlockDriverState *bs)
3508 {
3509     bs->refcnt++;
3510 }
3511
3512 /* Release a previously grabbed reference to bs.
3513  * If after releasing, reference count is zero, the BlockDriverState is
3514  * deleted. */
3515 void bdrv_unref(BlockDriverState *bs)
3516 {
3517     if (!bs) {
3518         return;
3519     }
3520     assert(bs->refcnt > 0);
3521     if (--bs->refcnt == 0) {
3522         bdrv_delete(bs);
3523     }
3524 }
3525
3526 struct BdrvOpBlocker {
3527     Error *reason;
3528     QLIST_ENTRY(BdrvOpBlocker) list;
3529 };
3530
3531 bool bdrv_op_is_blocked(BlockDriverState *bs, BlockOpType op, Error **errp)
3532 {
3533     BdrvOpBlocker *blocker;
3534     assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX);
3535     if (!QLIST_EMPTY(&bs->op_blockers[op])) {
3536         blocker = QLIST_FIRST(&bs->op_blockers[op]);
3537         if (errp) {
3538             *errp = error_copy(blocker->reason);
3539             error_prepend(errp, "Node '%s' is busy: ",
3540                           bdrv_get_device_or_node_name(bs));
3541         }
3542         return true;
3543     }
3544     return false;
3545 }
3546
3547 void bdrv_op_block(BlockDriverState *bs, BlockOpType op, Error *reason)
3548 {
3549     BdrvOpBlocker *blocker;
3550     assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX);
3551
3552     blocker = g_new0(BdrvOpBlocker, 1);
3553     blocker->reason = reason;
3554     QLIST_INSERT_HEAD(&bs->op_blockers[op], blocker, list);
3555 }
3556
3557 void bdrv_op_unblock(BlockDriverState *bs, BlockOpType op, Error *reason)
3558 {
3559     BdrvOpBlocker *blocker, *next;
3560     assert((int) op >= 0 && op < BLOCK_OP_TYPE_MAX);
3561     QLIST_FOREACH_SAFE(blocker, &bs->op_blockers[op], list, next) {
3562         if (blocker->reason == reason) {
3563             QLIST_REMOVE(blocker, list);
3564             g_free(blocker);
3565         }
3566     }
3567 }
3568
3569 void bdrv_op_block_all(BlockDriverState *bs, Error *reason)
3570 {
3571     int i;
3572     for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) {
3573         bdrv_op_block(bs, i, reason);
3574     }
3575 }
3576
3577 void bdrv_op_unblock_all(BlockDriverState *bs, Error *reason)
3578 {
3579     int i;
3580     for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) {
3581         bdrv_op_unblock(bs, i, reason);
3582     }
3583 }
3584
3585 bool bdrv_op_blocker_is_empty(BlockDriverState *bs)
3586 {
3587     int i;
3588
3589     for (i = 0; i < BLOCK_OP_TYPE_MAX; i++) {
3590         if (!QLIST_EMPTY(&bs->op_blockers[i])) {
3591             return false;
3592         }
3593     }
3594     return true;
3595 }
3596
3597 void bdrv_img_create(const char *filename, const char *fmt,
3598                      const char *base_filename, const char *base_fmt,
3599                      char *options, uint64_t img_size, int flags,
3600                      Error **errp, bool quiet)
3601 {
3602     QemuOptsList *create_opts = NULL;
3603     QemuOpts *opts = NULL;
3604     const char *backing_fmt, *backing_file;
3605     int64_t size;
3606     BlockDriver *drv, *proto_drv;
3607     Error *local_err = NULL;
3608     int ret = 0;
3609
3610     /* Find driver and parse its options */
3611     drv = bdrv_find_format(fmt);
3612     if (!drv) {
3613         error_setg(errp, "Unknown file format '%s'", fmt);
3614         return;
3615     }
3616
3617     proto_drv = bdrv_find_protocol(filename, true, errp);
3618     if (!proto_drv) {
3619         return;
3620     }
3621
3622     if (!drv->create_opts) {
3623         error_setg(errp, "Format driver '%s' does not support image creation",
3624                    drv->format_name);
3625         return;
3626     }
3627
3628     if (!proto_drv->create_opts) {
3629         error_setg(errp, "Protocol driver '%s' does not support image creation",
3630                    proto_drv->format_name);
3631         return;
3632     }
3633
3634     create_opts = qemu_opts_append(create_opts, drv->create_opts);
3635     create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
3636
3637     /* Create parameter list with default values */
3638     opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
3639     qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort);
3640
3641     /* Parse -o options */
3642     if (options) {
3643         qemu_opts_do_parse(opts, options, NULL, &local_err);
3644         if (local_err) {
3645             error_report_err(local_err);
3646             local_err = NULL;
3647             error_setg(errp, "Invalid options for file format '%s'", fmt);
3648             goto out;
3649         }
3650     }
3651
3652     if (base_filename) {
3653         qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &local_err);
3654         if (local_err) {
3655             error_setg(errp, "Backing file not supported for file format '%s'",
3656                        fmt);
3657             goto out;
3658         }
3659     }
3660
3661     if (base_fmt) {
3662         qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &local_err);
3663         if (local_err) {
3664             error_setg(errp, "Backing file format not supported for file "
3665                              "format '%s'", fmt);
3666             goto out;
3667         }
3668     }
3669
3670     backing_file = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
3671     if (backing_file) {
3672         if (!strcmp(filename, backing_file)) {
3673             error_setg(errp, "Error: Trying to create an image with the "
3674                              "same filename as the backing file");
3675             goto out;
3676         }
3677     }
3678
3679     backing_fmt = qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT);
3680
3681     // The size for the image must always be specified, with one exception:
3682     // If we are using a backing file, we can obtain the size from there
3683     size = qemu_opt_get_size(opts, BLOCK_OPT_SIZE, 0);
3684     if (size == -1) {
3685         if (backing_file) {
3686             BlockDriverState *bs;
3687             char *full_backing = g_new0(char, PATH_MAX);
3688             int64_t size;
3689             int back_flags;
3690             QDict *backing_options = NULL;
3691
3692             bdrv_get_full_backing_filename_from_filename(filename, backing_file,
3693                                                          full_backing, PATH_MAX,
3694                                                          &local_err);
3695             if (local_err) {
3696                 g_free(full_backing);
3697                 goto out;
3698             }
3699
3700             /* backing files always opened read-only */
3701             back_flags = flags;
3702             back_flags &= ~(BDRV_O_RDWR | BDRV_O_SNAPSHOT | BDRV_O_NO_BACKING);
3703
3704             if (backing_fmt) {
3705                 backing_options = qdict_new();
3706                 qdict_put(backing_options, "driver",
3707                           qstring_from_str(backing_fmt));
3708             }
3709
3710             bs = bdrv_open(full_backing, NULL, backing_options, back_flags,
3711                            &local_err);
3712             g_free(full_backing);
3713             if (!bs) {
3714                 goto out;
3715             }
3716             size = bdrv_getlength(bs);
3717             if (size < 0) {
3718                 error_setg_errno(errp, -size, "Could not get size of '%s'",
3719                                  backing_file);
3720                 bdrv_unref(bs);
3721                 goto out;
3722             }
3723
3724             qemu_opt_set_number(opts, BLOCK_OPT_SIZE, size, &error_abort);
3725
3726             bdrv_unref(bs);
3727         } else {
3728             error_setg(errp, "Image creation needs a size parameter");
3729             goto out;
3730         }
3731     }
3732
3733     if (!quiet) {
3734         printf("Formatting '%s', fmt=%s ", filename, fmt);
3735         qemu_opts_print(opts, " ");
3736         puts("");
3737     }
3738
3739     ret = bdrv_create(drv, filename, opts, &local_err);
3740
3741     if (ret == -EFBIG) {
3742         /* This is generally a better message than whatever the driver would
3743          * deliver (especially because of the cluster_size_hint), since that
3744          * is most probably not much different from "image too large". */
3745         const char *cluster_size_hint = "";
3746         if (qemu_opt_get_size(opts, BLOCK_OPT_CLUSTER_SIZE, 0)) {
3747             cluster_size_hint = " (try using a larger cluster size)";
3748         }
3749         error_setg(errp, "The image size is too large for file format '%s'"
3750                    "%s", fmt, cluster_size_hint);
3751         error_free(local_err);
3752         local_err = NULL;
3753     }
3754
3755 out:
3756     qemu_opts_del(opts);
3757     qemu_opts_free(create_opts);
3758     error_propagate(errp, local_err);
3759 }
3760
3761 AioContext *bdrv_get_aio_context(BlockDriverState *bs)
3762 {
3763     return bs->aio_context;
3764 }
3765
3766 static void bdrv_do_remove_aio_context_notifier(BdrvAioNotifier *ban)
3767 {
3768     QLIST_REMOVE(ban, list);
3769     g_free(ban);
3770 }
3771
3772 void bdrv_detach_aio_context(BlockDriverState *bs)
3773 {
3774     BdrvAioNotifier *baf, *baf_tmp;
3775     BdrvChild *child;
3776
3777     if (!bs->drv) {
3778         return;
3779     }
3780
3781     assert(!bs->walking_aio_notifiers);
3782     bs->walking_aio_notifiers = true;
3783     QLIST_FOREACH_SAFE(baf, &bs->aio_notifiers, list, baf_tmp) {
3784         if (baf->deleted) {
3785             bdrv_do_remove_aio_context_notifier(baf);
3786         } else {
3787             baf->detach_aio_context(baf->opaque);
3788         }
3789     }
3790     /* Never mind iterating again to check for ->deleted.  bdrv_close() will
3791      * remove remaining aio notifiers if we aren't called again.
3792      */
3793     bs->walking_aio_notifiers = false;
3794
3795     if (bs->drv->bdrv_detach_aio_context) {
3796         bs->drv->bdrv_detach_aio_context(bs);
3797     }
3798     QLIST_FOREACH(child, &bs->children, next) {
3799         bdrv_detach_aio_context(child->bs);
3800     }
3801
3802     bs->aio_context = NULL;
3803 }
3804
3805 void bdrv_attach_aio_context(BlockDriverState *bs,
3806                              AioContext *new_context)
3807 {
3808     BdrvAioNotifier *ban, *ban_tmp;
3809     BdrvChild *child;
3810
3811     if (!bs->drv) {
3812         return;
3813     }
3814
3815     bs->aio_context = new_context;
3816
3817     QLIST_FOREACH(child, &bs->children, next) {
3818         bdrv_attach_aio_context(child->bs, new_context);
3819     }
3820     if (bs->drv->bdrv_attach_aio_context) {
3821         bs->drv->bdrv_attach_aio_context(bs, new_context);
3822     }
3823
3824     assert(!bs->walking_aio_notifiers);
3825     bs->walking_aio_notifiers = true;
3826     QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_tmp) {
3827         if (ban->deleted) {
3828             bdrv_do_remove_aio_context_notifier(ban);
3829         } else {
3830             ban->attached_aio_context(new_context, ban->opaque);
3831         }
3832     }
3833     bs->walking_aio_notifiers = false;
3834 }
3835
3836 void bdrv_set_aio_context(BlockDriverState *bs, AioContext *new_context)
3837 {
3838     bdrv_drain(bs); /* ensure there are no in-flight requests */
3839
3840     bdrv_detach_aio_context(bs);
3841
3842     /* This function executes in the old AioContext so acquire the new one in
3843      * case it runs in a different thread.
3844      */
3845     aio_context_acquire(new_context);
3846     bdrv_attach_aio_context(bs, new_context);
3847     aio_context_release(new_context);
3848 }
3849
3850 void bdrv_add_aio_context_notifier(BlockDriverState *bs,
3851         void (*attached_aio_context)(AioContext *new_context, void *opaque),
3852         void (*detach_aio_context)(void *opaque), void *opaque)
3853 {
3854     BdrvAioNotifier *ban = g_new(BdrvAioNotifier, 1);
3855     *ban = (BdrvAioNotifier){
3856         .attached_aio_context = attached_aio_context,
3857         .detach_aio_context   = detach_aio_context,
3858         .opaque               = opaque
3859     };
3860
3861     QLIST_INSERT_HEAD(&bs->aio_notifiers, ban, list);
3862 }
3863
3864 void bdrv_remove_aio_context_notifier(BlockDriverState *bs,
3865                                       void (*attached_aio_context)(AioContext *,
3866                                                                    void *),
3867                                       void (*detach_aio_context)(void *),
3868                                       void *opaque)
3869 {
3870     BdrvAioNotifier *ban, *ban_next;
3871
3872     QLIST_FOREACH_SAFE(ban, &bs->aio_notifiers, list, ban_next) {
3873         if (ban->attached_aio_context == attached_aio_context &&
3874             ban->detach_aio_context   == detach_aio_context   &&
3875             ban->opaque               == opaque               &&
3876             ban->deleted              == false)
3877         {
3878             if (bs->walking_aio_notifiers) {
3879                 ban->deleted = true;
3880             } else {
3881                 bdrv_do_remove_aio_context_notifier(ban);
3882             }
3883             return;
3884         }
3885     }
3886
3887     abort();
3888 }
3889
3890 int bdrv_amend_options(BlockDriverState *bs, QemuOpts *opts,
3891                        BlockDriverAmendStatusCB *status_cb, void *cb_opaque)
3892 {
3893     if (!bs->drv->bdrv_amend_options) {
3894         return -ENOTSUP;
3895     }
3896     return bs->drv->bdrv_amend_options(bs, opts, status_cb, cb_opaque);
3897 }
3898
3899 /* This function will be called by the bdrv_recurse_is_first_non_filter method
3900  * of block filter and by bdrv_is_first_non_filter.
3901  * It is used to test if the given bs is the candidate or recurse more in the
3902  * node graph.
3903  */
3904 bool bdrv_recurse_is_first_non_filter(BlockDriverState *bs,
3905                                       BlockDriverState *candidate)
3906 {
3907     /* return false if basic checks fails */
3908     if (!bs || !bs->drv) {
3909         return false;
3910     }
3911
3912     /* the code reached a non block filter driver -> check if the bs is
3913      * the same as the candidate. It's the recursion termination condition.
3914      */
3915     if (!bs->drv->is_filter) {
3916         return bs == candidate;
3917     }
3918     /* Down this path the driver is a block filter driver */
3919
3920     /* If the block filter recursion method is defined use it to recurse down
3921      * the node graph.
3922      */
3923     if (bs->drv->bdrv_recurse_is_first_non_filter) {
3924         return bs->drv->bdrv_recurse_is_first_non_filter(bs, candidate);
3925     }
3926
3927     /* the driver is a block filter but don't allow to recurse -> return false
3928      */
3929     return false;
3930 }
3931
3932 /* This function checks if the candidate is the first non filter bs down it's
3933  * bs chain. Since we don't have pointers to parents it explore all bs chains
3934  * from the top. Some filters can choose not to pass down the recursion.
3935  */
3936 bool bdrv_is_first_non_filter(BlockDriverState *candidate)
3937 {
3938     BlockDriverState *bs;
3939     BdrvNextIterator it;
3940
3941     /* walk down the bs forest recursively */
3942     for (bs = bdrv_first(&it); bs; bs = bdrv_next(&it)) {
3943         bool perm;
3944
3945         /* try to recurse in this top level bs */
3946         perm = bdrv_recurse_is_first_non_filter(bs, candidate);
3947
3948         /* candidate is the first non filter */
3949         if (perm) {
3950             return true;
3951         }
3952     }
3953
3954     return false;
3955 }
3956
3957 BlockDriverState *check_to_replace_node(BlockDriverState *parent_bs,
3958                                         const char *node_name, Error **errp)
3959 {
3960     BlockDriverState *to_replace_bs = bdrv_find_node(node_name);
3961     AioContext *aio_context;
3962
3963     if (!to_replace_bs) {
3964         error_setg(errp, "Node name '%s' not found", node_name);
3965         return NULL;
3966     }
3967
3968     aio_context = bdrv_get_aio_context(to_replace_bs);
3969     aio_context_acquire(aio_context);
3970
3971     if (bdrv_op_is_blocked(to_replace_bs, BLOCK_OP_TYPE_REPLACE, errp)) {
3972         to_replace_bs = NULL;
3973         goto out;
3974     }
3975
3976     /* We don't want arbitrary node of the BDS chain to be replaced only the top
3977      * most non filter in order to prevent data corruption.
3978      * Another benefit is that this tests exclude backing files which are
3979      * blocked by the backing blockers.
3980      */
3981     if (!bdrv_recurse_is_first_non_filter(parent_bs, to_replace_bs)) {
3982         error_setg(errp, "Only top most non filter can be replaced");
3983         to_replace_bs = NULL;
3984         goto out;
3985     }
3986
3987 out:
3988     aio_context_release(aio_context);
3989     return to_replace_bs;
3990 }
3991
3992 static bool append_open_options(QDict *d, BlockDriverState *bs)
3993 {
3994     const QDictEntry *entry;
3995     QemuOptDesc *desc;
3996     BdrvChild *child;
3997     bool found_any = false;
3998     const char *p;
3999
4000     for (entry = qdict_first(bs->options); entry;
4001          entry = qdict_next(bs->options, entry))
4002     {
4003         /* Exclude options for children */
4004         QLIST_FOREACH(child, &bs->children, next) {
4005             if (strstart(qdict_entry_key(entry), child->name, &p)
4006                 && (!*p || *p == '.'))
4007             {
4008                 break;
4009             }
4010         }
4011         if (child) {
4012             continue;
4013         }
4014
4015         /* And exclude all non-driver-specific options */
4016         for (desc = bdrv_runtime_opts.desc; desc->name; desc++) {
4017             if (!strcmp(qdict_entry_key(entry), desc->name)) {
4018                 break;
4019             }
4020         }
4021         if (desc->name) {
4022             continue;
4023         }
4024
4025         qobject_incref(qdict_entry_value(entry));
4026         qdict_put_obj(d, qdict_entry_key(entry), qdict_entry_value(entry));
4027         found_any = true;
4028     }
4029
4030     return found_any;
4031 }
4032
4033 /* Updates the following BDS fields:
4034  *  - exact_filename: A filename which may be used for opening a block device
4035  *                    which (mostly) equals the given BDS (even without any
4036  *                    other options; so reading and writing must return the same
4037  *                    results, but caching etc. may be different)
4038  *  - full_open_options: Options which, when given when opening a block device
4039  *                       (without a filename), result in a BDS (mostly)
4040  *                       equalling the given one
4041  *  - filename: If exact_filename is set, it is copied here. Otherwise,
4042  *              full_open_options is converted to a JSON object, prefixed with
4043  *              "json:" (for use through the JSON pseudo protocol) and put here.
4044  */
4045 void bdrv_refresh_filename(BlockDriverState *bs)
4046 {
4047     BlockDriver *drv = bs->drv;
4048     QDict *opts;
4049
4050     if (!drv) {
4051         return;
4052     }
4053
4054     /* This BDS's file name will most probably depend on its file's name, so
4055      * refresh that first */
4056     if (bs->file) {
4057         bdrv_refresh_filename(bs->file->bs);
4058     }
4059
4060     if (drv->bdrv_refresh_filename) {
4061         /* Obsolete information is of no use here, so drop the old file name
4062          * information before refreshing it */
4063         bs->exact_filename[0] = '\0';
4064         if (bs->full_open_options) {
4065             QDECREF(bs->full_open_options);
4066             bs->full_open_options = NULL;
4067         }
4068
4069         opts = qdict_new();
4070         append_open_options(opts, bs);
4071         drv->bdrv_refresh_filename(bs, opts);
4072         QDECREF(opts);
4073     } else if (bs->file) {
4074         /* Try to reconstruct valid information from the underlying file */
4075         bool has_open_options;
4076
4077         bs->exact_filename[0] = '\0';
4078         if (bs->full_open_options) {
4079             QDECREF(bs->full_open_options);
4080             bs->full_open_options = NULL;
4081         }
4082
4083         opts = qdict_new();
4084         has_open_options = append_open_options(opts, bs);
4085
4086         /* If no specific options have been given for this BDS, the filename of
4087          * the underlying file should suffice for this one as well */
4088         if (bs->file->bs->exact_filename[0] && !has_open_options) {
4089             strcpy(bs->exact_filename, bs->file->bs->exact_filename);
4090         }
4091         /* Reconstructing the full options QDict is simple for most format block
4092          * drivers, as long as the full options are known for the underlying
4093          * file BDS. The full options QDict of that file BDS should somehow
4094          * contain a representation of the filename, therefore the following
4095          * suffices without querying the (exact_)filename of this BDS. */
4096         if (bs->file->bs->full_open_options) {
4097             qdict_put_obj(opts, "driver",
4098                           QOBJECT(qstring_from_str(drv->format_name)));
4099             QINCREF(bs->file->bs->full_open_options);
4100             qdict_put_obj(opts, "file",
4101                           QOBJECT(bs->file->bs->full_open_options));
4102
4103             bs->full_open_options = opts;
4104         } else {
4105             QDECREF(opts);
4106         }
4107     } else if (!bs->full_open_options && qdict_size(bs->options)) {
4108         /* There is no underlying file BDS (at least referenced by BDS.file),
4109          * so the full options QDict should be equal to the options given
4110          * specifically for this block device when it was opened (plus the
4111          * driver specification).
4112          * Because those options don't change, there is no need to update
4113          * full_open_options when it's already set. */
4114
4115         opts = qdict_new();
4116         append_open_options(opts, bs);
4117         qdict_put_obj(opts, "driver",
4118                       QOBJECT(qstring_from_str(drv->format_name)));
4119
4120         if (bs->exact_filename[0]) {
4121             /* This may not work for all block protocol drivers (some may
4122              * require this filename to be parsed), but we have to find some
4123              * default solution here, so just include it. If some block driver
4124              * does not support pure options without any filename at all or
4125              * needs some special format of the options QDict, it needs to
4126              * implement the driver-specific bdrv_refresh_filename() function.
4127              */
4128             qdict_put_obj(opts, "filename",
4129                           QOBJECT(qstring_from_str(bs->exact_filename)));
4130         }
4131
4132         bs->full_open_options = opts;
4133     }
4134
4135     if (bs->exact_filename[0]) {
4136         pstrcpy(bs->filename, sizeof(bs->filename), bs->exact_filename);
4137     } else if (bs->full_open_options) {
4138         QString *json = qobject_to_json(QOBJECT(bs->full_open_options));
4139         snprintf(bs->filename, sizeof(bs->filename), "json:%s",
4140                  qstring_get_str(json));
4141         QDECREF(json);
4142     }
4143 }
4144
4145 /*
4146  * Hot add/remove a BDS's child. So the user can take a child offline when
4147  * it is broken and take a new child online
4148  */
4149 void bdrv_add_child(BlockDriverState *parent_bs, BlockDriverState *child_bs,
4150                     Error **errp)
4151 {
4152
4153     if (!parent_bs->drv || !parent_bs->drv->bdrv_add_child) {
4154         error_setg(errp, "The node %s does not support adding a child",
4155                    bdrv_get_device_or_node_name(parent_bs));
4156         return;
4157     }
4158
4159     if (!QLIST_EMPTY(&child_bs->parents)) {
4160         error_setg(errp, "The node %s already has a parent",
4161                    child_bs->node_name);
4162         return;
4163     }
4164
4165     parent_bs->drv->bdrv_add_child(parent_bs, child_bs, errp);
4166 }
4167
4168 void bdrv_del_child(BlockDriverState *parent_bs, BdrvChild *child, Error **errp)
4169 {
4170     BdrvChild *tmp;
4171
4172     if (!parent_bs->drv || !parent_bs->drv->bdrv_del_child) {
4173         error_setg(errp, "The node %s does not support removing a child",
4174                    bdrv_get_device_or_node_name(parent_bs));
4175         return;
4176     }
4177
4178     QLIST_FOREACH(tmp, &parent_bs->children, next) {
4179         if (tmp == child) {
4180             break;
4181         }
4182     }
4183
4184     if (!tmp) {
4185         error_setg(errp, "The node %s does not have a child named %s",
4186                    bdrv_get_device_or_node_name(parent_bs),
4187                    bdrv_get_device_or_node_name(child->bs));
4188         return;
4189     }
4190
4191     parent_bs->drv->bdrv_del_child(parent_bs, child, errp);
4192 }