block.c

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