block.c

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