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