block.c

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