block.c

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