qcow2.c 142.0 KB
Newer Older
B
bellard 已提交
1 2
/*
 * Block driver for the QCOW version 2 format
3
 *
B
bellard 已提交
4
 * Copyright (c) 2004-2006 Fabrice Bellard
5
 *
B
bellard 已提交
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
P
Peter Maydell 已提交
24
#include "qemu/osdep.h"
25
#include "block/block_int.h"
26
#include "sysemu/block-backend.h"
27
#include "qemu/module.h"
B
bellard 已提交
28
#include <zlib.h>
K
Kevin Wolf 已提交
29
#include "block/qcow2.h"
30
#include "qemu/error-report.h"
31
#include "qapi/qmp/qerror.h"
32
#include "qapi/qmp/qbool.h"
33
#include "qapi/util.h"
M
Max Reitz 已提交
34 35
#include "qapi/qmp/types.h"
#include "qapi-event.h"
K
Kevin Wolf 已提交
36
#include "trace.h"
37
#include "qemu/option_int.h"
38
#include "qemu/cutils.h"
39
#include "qemu/bswap.h"
40 41 42
#include "qapi/opts-visitor.h"
#include "qapi-visit.h"
#include "block/crypto.h"
B
bellard 已提交
43 44 45 46 47 48 49 50

/*
  Differences with QCOW:

  - Support for multiple incremental snapshots.
  - Memory management by reference counts.
  - Clusters which have a reference count of one have the bit
    QCOW_OFLAG_COPIED to optimize write performance.
51
  - Size of compressed clusters is stored in sectors to reduce bit usage
B
bellard 已提交
52 53
    in the cluster offsets.
  - Support for storing additional data (such as the VM state) in the
54
    snapshots.
B
bellard 已提交
55 56 57 58 59
  - If a backing store is used, the cluster size is not constrained
    (could be backported to QCOW).
  - L2 tables have always a size of one cluster.
*/

60 61 62 63

typedef struct {
    uint32_t magic;
    uint32_t len;
64
} QEMU_PACKED QCowExtension;
J
Jeff Cody 已提交
65

66 67
#define  QCOW2_EXT_MAGIC_END 0
#define  QCOW2_EXT_MAGIC_BACKING_FORMAT 0xE2792ACA
68
#define  QCOW2_EXT_MAGIC_FEATURE_TABLE 0x6803f857
69
#define  QCOW2_EXT_MAGIC_CRYPTO_HEADER 0x0537be77
70
#define  QCOW2_EXT_MAGIC_BITMAPS 0x23852875
71

72
static int qcow2_probe(const uint8_t *buf, int buf_size, const char *filename)
B
bellard 已提交
73 74
{
    const QCowHeader *cow_header = (const void *)buf;
75

B
bellard 已提交
76 77
    if (buf_size >= sizeof(QCowHeader) &&
        be32_to_cpu(cow_header->magic) == QCOW_MAGIC &&
K
Kevin Wolf 已提交
78
        be32_to_cpu(cow_header->version) >= 2)
B
bellard 已提交
79 80 81 82 83
        return 100;
    else
        return 0;
}

84

85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
static ssize_t qcow2_crypto_hdr_read_func(QCryptoBlock *block, size_t offset,
                                          uint8_t *buf, size_t buflen,
                                          void *opaque, Error **errp)
{
    BlockDriverState *bs = opaque;
    BDRVQcow2State *s = bs->opaque;
    ssize_t ret;

    if ((offset + buflen) > s->crypto_header.length) {
        error_setg(errp, "Request for data outside of extension header");
        return -1;
    }

    ret = bdrv_pread(bs->file,
                     s->crypto_header.offset + offset, buf, buflen);
    if (ret < 0) {
        error_setg_errno(errp, -ret, "Could not read encryption header");
        return -1;
    }
    return ret;
}


static ssize_t qcow2_crypto_hdr_init_func(QCryptoBlock *block, size_t headerlen,
                                          void *opaque, Error **errp)
{
    BlockDriverState *bs = opaque;
    BDRVQcow2State *s = bs->opaque;
    int64_t ret;
    int64_t clusterlen;

    ret = qcow2_alloc_clusters(bs, headerlen);
    if (ret < 0) {
        error_setg_errno(errp, -ret,
                         "Cannot allocate cluster for LUKS header size %zu",
                         headerlen);
        return -1;
    }

    s->crypto_header.length = headerlen;
    s->crypto_header.offset = ret;

    /* Zero fill remaining space in cluster so it has predictable
     * content in case of future spec changes */
    clusterlen = size_to_clusters(s, headerlen) * s->cluster_size;
    ret = bdrv_pwrite_zeroes(bs->file,
                             ret + headerlen,
                             clusterlen - headerlen, 0);
    if (ret < 0) {
        error_setg_errno(errp, -ret, "Could not zero fill encryption header");
        return -1;
    }

    return ret;
}


static ssize_t qcow2_crypto_hdr_write_func(QCryptoBlock *block, size_t offset,
                                           const uint8_t *buf, size_t buflen,
                                           void *opaque, Error **errp)
{
    BlockDriverState *bs = opaque;
    BDRVQcow2State *s = bs->opaque;
    ssize_t ret;

    if ((offset + buflen) > s->crypto_header.length) {
        error_setg(errp, "Request for data outside of extension header");
        return -1;
    }

    ret = bdrv_pwrite(bs->file,
                      s->crypto_header.offset + offset, buf, buflen);
    if (ret < 0) {
        error_setg_errno(errp, -ret, "Could not read encryption header");
        return -1;
    }
    return ret;
}


165 166 167 168 169 170 171
/* 
 * read qcow2 extension and fill bs
 * start reading from start_offset
 * finish reading upon magic of value 0 or when end_offset reached
 * unknown magic is skipped (future extension this version knows nothing about)
 * return 0 upon success, non-0 otherwise
 */
172
static int qcow2_read_extensions(BlockDriverState *bs, uint64_t start_offset,
M
Max Reitz 已提交
173
                                 uint64_t end_offset, void **p_feature_table,
174 175
                                 int flags, bool *need_update_header,
                                 Error **errp)
176
{
177
    BDRVQcow2State *s = bs->opaque;
178 179
    QCowExtension ext;
    uint64_t offset;
180
    int ret;
181 182 183 184 185
    Qcow2BitmapHeaderExt bitmaps_ext;

    if (need_update_header != NULL) {
        *need_update_header = false;
    }
186 187

#ifdef DEBUG_EXT
188
    printf("qcow2_read_extensions: start=%ld end=%ld\n", start_offset, end_offset);
189 190 191 192 193 194 195
#endif
    offset = start_offset;
    while (offset < end_offset) {

#ifdef DEBUG_EXT
        /* Sanity check */
        if (offset > s->cluster_size)
196
            printf("qcow2_read_extension: suspicious offset %lu\n", offset);
197

D
Dong Xu Wang 已提交
198
        printf("attempting to read extended header in offset %lu\n", offset);
199 200
#endif

201
        ret = bdrv_pread(bs->file, offset, &ext, sizeof(ext));
M
Max Reitz 已提交
202 203 204
        if (ret < 0) {
            error_setg_errno(errp, -ret, "qcow2_read_extension: ERROR: "
                             "pread fail from offset %" PRIu64, offset);
205 206 207 208 209 210 211 212
            return 1;
        }
        be32_to_cpus(&ext.magic);
        be32_to_cpus(&ext.len);
        offset += sizeof(ext);
#ifdef DEBUG_EXT
        printf("ext.magic = 0x%x\n", ext.magic);
#endif
213
        if (offset > end_offset || ext.len > end_offset - offset) {
M
Max Reitz 已提交
214
            error_setg(errp, "Header extension too large");
215 216 217
            return -EINVAL;
        }

218
        switch (ext.magic) {
219
        case QCOW2_EXT_MAGIC_END:
220
            return 0;
221

222
        case QCOW2_EXT_MAGIC_BACKING_FORMAT:
223
            if (ext.len >= sizeof(bs->backing_format)) {
224 225 226
                error_setg(errp, "ERROR: ext_backing_format: len=%" PRIu32
                           " too large (>=%zu)", ext.len,
                           sizeof(bs->backing_format));
227 228
                return 2;
            }
229
            ret = bdrv_pread(bs->file, offset, bs->backing_format, ext.len);
M
Max Reitz 已提交
230 231 232
            if (ret < 0) {
                error_setg_errno(errp, -ret, "ERROR: ext_backing_format: "
                                 "Could not read format name");
233
                return 3;
M
Max Reitz 已提交
234
            }
235
            bs->backing_format[ext.len] = '\0';
236
            s->image_backing_format = g_strdup(bs->backing_format);
237 238 239 240 241
#ifdef DEBUG_EXT
            printf("Qcow2: Got format extension %s\n", bs->backing_format);
#endif
            break;

242 243 244
        case QCOW2_EXT_MAGIC_FEATURE_TABLE:
            if (p_feature_table != NULL) {
                void* feature_table = g_malloc0(ext.len + 2 * sizeof(Qcow2Feature));
245
                ret = bdrv_pread(bs->file, offset , feature_table, ext.len);
246
                if (ret < 0) {
M
Max Reitz 已提交
247 248
                    error_setg_errno(errp, -ret, "ERROR: ext_feature_table: "
                                     "Could not read table");
249 250 251 252 253 254 255
                    return ret;
                }

                *p_feature_table = feature_table;
            }
            break;

256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
        case QCOW2_EXT_MAGIC_CRYPTO_HEADER: {
            unsigned int cflags = 0;
            if (s->crypt_method_header != QCOW_CRYPT_LUKS) {
                error_setg(errp, "CRYPTO header extension only "
                           "expected with LUKS encryption method");
                return -EINVAL;
            }
            if (ext.len != sizeof(Qcow2CryptoHeaderExtension)) {
                error_setg(errp, "CRYPTO header extension size %u, "
                           "but expected size %zu", ext.len,
                           sizeof(Qcow2CryptoHeaderExtension));
                return -EINVAL;
            }

            ret = bdrv_pread(bs->file, offset, &s->crypto_header, ext.len);
            if (ret < 0) {
                error_setg_errno(errp, -ret,
                                 "Unable to read CRYPTO header extension");
                return ret;
            }
            be64_to_cpus(&s->crypto_header.offset);
            be64_to_cpus(&s->crypto_header.length);

            if ((s->crypto_header.offset % s->cluster_size) != 0) {
                error_setg(errp, "Encryption header offset '%" PRIu64 "' is "
                           "not a multiple of cluster size '%u'",
                           s->crypto_header.offset, s->cluster_size);
                return -EINVAL;
            }

            if (flags & BDRV_O_NO_IO) {
                cflags |= QCRYPTO_BLOCK_OPEN_NO_IO;
            }
289
            s->crypto = qcrypto_block_open(s->crypto_opts, "encrypt.",
290 291 292 293 294 295 296
                                           qcow2_crypto_hdr_read_func,
                                           bs, cflags, errp);
            if (!s->crypto) {
                return -EINVAL;
            }
        }   break;

297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
        case QCOW2_EXT_MAGIC_BITMAPS:
            if (ext.len != sizeof(bitmaps_ext)) {
                error_setg_errno(errp, -ret, "bitmaps_ext: "
                                 "Invalid extension length");
                return -EINVAL;
            }

            if (!(s->autoclear_features & QCOW2_AUTOCLEAR_BITMAPS)) {
                error_report("WARNING: a program lacking bitmap support "
                             "modified this file, so all bitmaps are now "
                             "considered inconsistent. Some clusters may be "
                             "leaked, run 'qemu-img check -r' on the image "
                             "file to fix.");
                if (need_update_header != NULL) {
                    /* Updating is needed to drop invalid bitmap extension. */
                    *need_update_header = true;
                }
                break;
            }

            ret = bdrv_pread(bs->file, offset, &bitmaps_ext, ext.len);
            if (ret < 0) {
                error_setg_errno(errp, -ret, "bitmaps_ext: "
                                 "Could not read ext header");
                return ret;
            }

            if (bitmaps_ext.reserved32 != 0) {
                error_setg_errno(errp, -ret, "bitmaps_ext: "
                                 "Reserved field is not zero");
                return -EINVAL;
            }

            be32_to_cpus(&bitmaps_ext.nb_bitmaps);
            be64_to_cpus(&bitmaps_ext.bitmap_directory_size);
            be64_to_cpus(&bitmaps_ext.bitmap_directory_offset);

            if (bitmaps_ext.nb_bitmaps > QCOW2_MAX_BITMAPS) {
                error_setg(errp,
                           "bitmaps_ext: Image has %" PRIu32 " bitmaps, "
                           "exceeding the QEMU supported maximum of %d",
                           bitmaps_ext.nb_bitmaps, QCOW2_MAX_BITMAPS);
                return -EINVAL;
            }

            if (bitmaps_ext.nb_bitmaps == 0) {
                error_setg(errp, "found bitmaps extension with zero bitmaps");
                return -EINVAL;
            }

            if (bitmaps_ext.bitmap_directory_offset & (s->cluster_size - 1)) {
                error_setg(errp, "bitmaps_ext: "
                                 "invalid bitmap directory offset");
                return -EINVAL;
            }

            if (bitmaps_ext.bitmap_directory_size >
                QCOW2_MAX_BITMAP_DIRECTORY_SIZE) {
                error_setg(errp, "bitmaps_ext: "
                                 "bitmap directory size (%" PRIu64 ") exceeds "
                                 "the maximum supported size (%d)",
                                 bitmaps_ext.bitmap_directory_size,
                                 QCOW2_MAX_BITMAP_DIRECTORY_SIZE);
                return -EINVAL;
            }

            s->nb_bitmaps = bitmaps_ext.nb_bitmaps;
            s->bitmap_directory_offset =
                    bitmaps_ext.bitmap_directory_offset;
            s->bitmap_directory_size =
                    bitmaps_ext.bitmap_directory_size;

#ifdef DEBUG_EXT
            printf("Qcow2: Got bitmaps extension: "
                   "offset=%" PRIu64 " nb_bitmaps=%" PRIu32 "\n",
                   s->bitmap_directory_offset, s->nb_bitmaps);
#endif
            break;

376
        default:
377 378 379 380 381 382 383 384 385
            /* unknown magic - save it in case we need to rewrite the header */
            {
                Qcow2UnknownHeaderExtension *uext;

                uext = g_malloc0(sizeof(*uext)  + ext.len);
                uext->magic = ext.magic;
                uext->len = ext.len;
                QLIST_INSERT_HEAD(&s->unknown_header_ext, uext, next);

386
                ret = bdrv_pread(bs->file, offset , uext->data, uext->len);
387
                if (ret < 0) {
M
Max Reitz 已提交
388 389
                    error_setg_errno(errp, -ret, "ERROR: unknown extension: "
                                     "Could not read data");
390 391 392
                    return ret;
                }
            }
393 394
            break;
        }
395 396

        offset += ((ext.len + 7) & ~7);
397 398 399 400 401
    }

    return 0;
}

402 403
static void cleanup_unknown_header_ext(BlockDriverState *bs)
{
404
    BDRVQcow2State *s = bs->opaque;
405 406 407 408 409 410 411
    Qcow2UnknownHeaderExtension *uext, *next;

    QLIST_FOREACH_SAFE(uext, &s->unknown_header_ext, next, next) {
        QLIST_REMOVE(uext, next);
        g_free(uext);
    }
}
412

413 414
static void report_unsupported_feature(Error **errp, Qcow2Feature *table,
                                       uint64_t mask)
415
{
416 417 418
    char *features = g_strdup("");
    char *old;

419 420
    while (table && table->name[0] != '\0') {
        if (table->type == QCOW2_FEAT_TYPE_INCOMPATIBLE) {
421 422 423 424 425 426
            if (mask & (1ULL << table->bit)) {
                old = features;
                features = g_strdup_printf("%s%s%.46s", old, *old ? ", " : "",
                                           table->name);
                g_free(old);
                mask &= ~(1ULL << table->bit);
427 428 429 430 431 432
            }
        }
        table++;
    }

    if (mask) {
433 434 435 436
        old = features;
        features = g_strdup_printf("%s%sUnknown incompatible feature: %" PRIx64,
                                   old, *old ? ", " : "", mask);
        g_free(old);
437
    }
438

439
    error_setg(errp, "Unsupported qcow2 feature(s): %s", features);
440
    g_free(features);
441 442
}

443 444 445 446 447 448 449
/*
 * Sets the dirty bit and flushes afterwards if necessary.
 *
 * The incompatible_features bit is only set if the image file header was
 * updated successfully.  Therefore it is not required to check the return
 * value of this function.
 */
450
int qcow2_mark_dirty(BlockDriverState *bs)
451
{
452
    BDRVQcow2State *s = bs->opaque;
453 454 455 456 457 458 459 460 461 462
    uint64_t val;
    int ret;

    assert(s->qcow_version >= 3);

    if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) {
        return 0; /* already dirty */
    }

    val = cpu_to_be64(s->incompatible_features | QCOW2_INCOMPAT_DIRTY);
463
    ret = bdrv_pwrite(bs->file, offsetof(QCowHeader, incompatible_features),
464 465 466 467
                      &val, sizeof(val));
    if (ret < 0) {
        return ret;
    }
K
Kevin Wolf 已提交
468
    ret = bdrv_flush(bs->file->bs);
469 470 471 472 473 474 475 476 477
    if (ret < 0) {
        return ret;
    }

    /* Only treat image as dirty if the header was updated successfully */
    s->incompatible_features |= QCOW2_INCOMPAT_DIRTY;
    return 0;
}

S
Stefan Hajnoczi 已提交
478 479 480 481 482 483 484
/*
 * Clears the dirty bit and flushes before if necessary.  Only call this
 * function when there are no pending requests, it does not guard against
 * concurrent requests dirtying the image.
 */
static int qcow2_mark_clean(BlockDriverState *bs)
{
485
    BDRVQcow2State *s = bs->opaque;
S
Stefan Hajnoczi 已提交
486 487

    if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) {
488 489 490 491 492
        int ret;

        s->incompatible_features &= ~QCOW2_INCOMPAT_DIRTY;

        ret = bdrv_flush(bs);
S
Stefan Hajnoczi 已提交
493 494 495 496 497 498 499 500 501
        if (ret < 0) {
            return ret;
        }

        return qcow2_update_header(bs);
    }
    return 0;
}

M
Max Reitz 已提交
502 503 504 505 506
/*
 * Marks the image as corrupt.
 */
int qcow2_mark_corrupt(BlockDriverState *bs)
{
507
    BDRVQcow2State *s = bs->opaque;
M
Max Reitz 已提交
508 509 510 511 512 513 514 515 516 517 518

    s->incompatible_features |= QCOW2_INCOMPAT_CORRUPT;
    return qcow2_update_header(bs);
}

/*
 * Marks the image as consistent, i.e., unsets the corrupt bit, and flushes
 * before if necessary.
 */
int qcow2_mark_consistent(BlockDriverState *bs)
{
519
    BDRVQcow2State *s = bs->opaque;
M
Max Reitz 已提交
520 521 522 523 524 525 526 527 528 529 530 531 532

    if (s->incompatible_features & QCOW2_INCOMPAT_CORRUPT) {
        int ret = bdrv_flush(bs);
        if (ret < 0) {
            return ret;
        }

        s->incompatible_features &= ~QCOW2_INCOMPAT_CORRUPT;
        return qcow2_update_header(bs);
    }
    return 0;
}

533 534 535 536 537 538 539 540 541
static int qcow2_check(BlockDriverState *bs, BdrvCheckResult *result,
                       BdrvCheckMode fix)
{
    int ret = qcow2_check_refcounts(bs, result, fix);
    if (ret < 0) {
        return ret;
    }

    if (fix && result->check_errors == 0 && result->corruptions == 0) {
M
Max Reitz 已提交
542 543 544 545 546
        ret = qcow2_mark_clean(bs);
        if (ret < 0) {
            return ret;
        }
        return qcow2_mark_consistent(bs);
547 548 549 550
    }
    return ret;
}

551 552 553
static int validate_table_offset(BlockDriverState *bs, uint64_t offset,
                                 uint64_t entries, size_t entry_len)
{
554
    BDRVQcow2State *s = bs->opaque;
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
    uint64_t size;

    /* Use signed INT64_MAX as the maximum even for uint64_t header fields,
     * because values will be passed to qemu functions taking int64_t. */
    if (entries > INT64_MAX / entry_len) {
        return -EINVAL;
    }

    size = entries * entry_len;

    if (INT64_MAX - size < offset) {
        return -EINVAL;
    }

    /* Tables must be cluster aligned */
570
    if (offset_into_cluster(s, offset) != 0) {
571 572 573 574 575 576
        return -EINVAL;
    }

    return 0;
}

577 578 579 580 581
static QemuOptsList qcow2_runtime_opts = {
    .name = "qcow2",
    .head = QTAILQ_HEAD_INITIALIZER(qcow2_runtime_opts.head),
    .desc = {
        {
582
            .name = QCOW2_OPT_LAZY_REFCOUNTS,
583 584 585
            .type = QEMU_OPT_BOOL,
            .help = "Postpone refcount updates",
        },
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
        {
            .name = QCOW2_OPT_DISCARD_REQUEST,
            .type = QEMU_OPT_BOOL,
            .help = "Pass guest discard requests to the layer below",
        },
        {
            .name = QCOW2_OPT_DISCARD_SNAPSHOT,
            .type = QEMU_OPT_BOOL,
            .help = "Generate discard requests when snapshot related space "
                    "is freed",
        },
        {
            .name = QCOW2_OPT_DISCARD_OTHER,
            .type = QEMU_OPT_BOOL,
            .help = "Generate discard requests when other clusters are freed",
        },
M
Max Reitz 已提交
602 603 604 605 606 607
        {
            .name = QCOW2_OPT_OVERLAP,
            .type = QEMU_OPT_STRING,
            .help = "Selects which overlap checks to perform from a range of "
                    "templates (none, constant, cached, all)",
        },
608 609 610 611 612 613
        {
            .name = QCOW2_OPT_OVERLAP_TEMPLATE,
            .type = QEMU_OPT_STRING,
            .help = "Selects which overlap checks to perform from a range of "
                    "templates (none, constant, cached, all)",
        },
M
Max Reitz 已提交
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
        {
            .name = QCOW2_OPT_OVERLAP_MAIN_HEADER,
            .type = QEMU_OPT_BOOL,
            .help = "Check for unintended writes into the main qcow2 header",
        },
        {
            .name = QCOW2_OPT_OVERLAP_ACTIVE_L1,
            .type = QEMU_OPT_BOOL,
            .help = "Check for unintended writes into the active L1 table",
        },
        {
            .name = QCOW2_OPT_OVERLAP_ACTIVE_L2,
            .type = QEMU_OPT_BOOL,
            .help = "Check for unintended writes into an active L2 table",
        },
        {
            .name = QCOW2_OPT_OVERLAP_REFCOUNT_TABLE,
            .type = QEMU_OPT_BOOL,
            .help = "Check for unintended writes into the refcount table",
        },
        {
            .name = QCOW2_OPT_OVERLAP_REFCOUNT_BLOCK,
            .type = QEMU_OPT_BOOL,
            .help = "Check for unintended writes into a refcount block",
        },
        {
            .name = QCOW2_OPT_OVERLAP_SNAPSHOT_TABLE,
            .type = QEMU_OPT_BOOL,
            .help = "Check for unintended writes into the snapshot table",
        },
        {
            .name = QCOW2_OPT_OVERLAP_INACTIVE_L1,
            .type = QEMU_OPT_BOOL,
            .help = "Check for unintended writes into an inactive L1 table",
        },
        {
            .name = QCOW2_OPT_OVERLAP_INACTIVE_L2,
            .type = QEMU_OPT_BOOL,
            .help = "Check for unintended writes into an inactive L2 table",
        },
654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
        {
            .name = QCOW2_OPT_CACHE_SIZE,
            .type = QEMU_OPT_SIZE,
            .help = "Maximum combined metadata (L2 tables and refcount blocks) "
                    "cache size",
        },
        {
            .name = QCOW2_OPT_L2_CACHE_SIZE,
            .type = QEMU_OPT_SIZE,
            .help = "Maximum L2 table cache size",
        },
        {
            .name = QCOW2_OPT_REFCOUNT_CACHE_SIZE,
            .type = QEMU_OPT_SIZE,
            .help = "Maximum refcount block cache size",
        },
670 671 672 673 674
        {
            .name = QCOW2_OPT_CACHE_CLEAN_INTERVAL,
            .type = QEMU_OPT_NUMBER,
            .help = "Clean unused cache entries after this time (in seconds)",
        },
675 676
        BLOCK_CRYPTO_OPT_DEF_KEY_SECRET("encrypt.",
            "ID of secret providing qcow2 AES key or LUKS passphrase"),
677 678 679 680
        { /* end of list */ }
    },
};

681 682 683 684 685 686 687 688 689 690 691
static const char *overlap_bool_option_names[QCOW2_OL_MAX_BITNR] = {
    [QCOW2_OL_MAIN_HEADER_BITNR]    = QCOW2_OPT_OVERLAP_MAIN_HEADER,
    [QCOW2_OL_ACTIVE_L1_BITNR]      = QCOW2_OPT_OVERLAP_ACTIVE_L1,
    [QCOW2_OL_ACTIVE_L2_BITNR]      = QCOW2_OPT_OVERLAP_ACTIVE_L2,
    [QCOW2_OL_REFCOUNT_TABLE_BITNR] = QCOW2_OPT_OVERLAP_REFCOUNT_TABLE,
    [QCOW2_OL_REFCOUNT_BLOCK_BITNR] = QCOW2_OPT_OVERLAP_REFCOUNT_BLOCK,
    [QCOW2_OL_SNAPSHOT_TABLE_BITNR] = QCOW2_OPT_OVERLAP_SNAPSHOT_TABLE,
    [QCOW2_OL_INACTIVE_L1_BITNR]    = QCOW2_OPT_OVERLAP_INACTIVE_L1,
    [QCOW2_OL_INACTIVE_L2_BITNR]    = QCOW2_OPT_OVERLAP_INACTIVE_L2,
};

692 693 694
static void cache_clean_timer_cb(void *opaque)
{
    BlockDriverState *bs = opaque;
695
    BDRVQcow2State *s = bs->opaque;
696 697 698 699 700 701 702 703
    qcow2_cache_clean_unused(bs, s->l2_table_cache);
    qcow2_cache_clean_unused(bs, s->refcount_block_cache);
    timer_mod(s->cache_clean_timer, qemu_clock_get_ms(QEMU_CLOCK_VIRTUAL) +
              (int64_t) s->cache_clean_interval * 1000);
}

static void cache_clean_timer_init(BlockDriverState *bs, AioContext *context)
{
704
    BDRVQcow2State *s = bs->opaque;
705 706 707 708 709 710 711 712 713 714 715
    if (s->cache_clean_interval > 0) {
        s->cache_clean_timer = aio_timer_new(context, QEMU_CLOCK_VIRTUAL,
                                             SCALE_MS, cache_clean_timer_cb,
                                             bs);
        timer_mod(s->cache_clean_timer, qemu_clock_get_ms(QEMU_CLOCK_VIRTUAL) +
                  (int64_t) s->cache_clean_interval * 1000);
    }
}

static void cache_clean_timer_del(BlockDriverState *bs)
{
716
    BDRVQcow2State *s = bs->opaque;
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
    if (s->cache_clean_timer) {
        timer_del(s->cache_clean_timer);
        timer_free(s->cache_clean_timer);
        s->cache_clean_timer = NULL;
    }
}

static void qcow2_detach_aio_context(BlockDriverState *bs)
{
    cache_clean_timer_del(bs);
}

static void qcow2_attach_aio_context(BlockDriverState *bs,
                                     AioContext *new_context)
{
    cache_clean_timer_init(bs, new_context);
}

M
Max Reitz 已提交
735 736
static void read_cache_sizes(BlockDriverState *bs, QemuOpts *opts,
                             uint64_t *l2_cache_size,
737 738
                             uint64_t *refcount_cache_size, Error **errp)
{
739
    BDRVQcow2State *s = bs->opaque;
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
    uint64_t combined_cache_size;
    bool l2_cache_size_set, refcount_cache_size_set, combined_cache_size_set;

    combined_cache_size_set = qemu_opt_get(opts, QCOW2_OPT_CACHE_SIZE);
    l2_cache_size_set = qemu_opt_get(opts, QCOW2_OPT_L2_CACHE_SIZE);
    refcount_cache_size_set = qemu_opt_get(opts, QCOW2_OPT_REFCOUNT_CACHE_SIZE);

    combined_cache_size = qemu_opt_get_size(opts, QCOW2_OPT_CACHE_SIZE, 0);
    *l2_cache_size = qemu_opt_get_size(opts, QCOW2_OPT_L2_CACHE_SIZE, 0);
    *refcount_cache_size = qemu_opt_get_size(opts,
                                             QCOW2_OPT_REFCOUNT_CACHE_SIZE, 0);

    if (combined_cache_size_set) {
        if (l2_cache_size_set && refcount_cache_size_set) {
            error_setg(errp, QCOW2_OPT_CACHE_SIZE ", " QCOW2_OPT_L2_CACHE_SIZE
                       " and " QCOW2_OPT_REFCOUNT_CACHE_SIZE " may not be set "
                       "the same time");
            return;
        } else if (*l2_cache_size > combined_cache_size) {
            error_setg(errp, QCOW2_OPT_L2_CACHE_SIZE " may not exceed "
                       QCOW2_OPT_CACHE_SIZE);
            return;
        } else if (*refcount_cache_size > combined_cache_size) {
            error_setg(errp, QCOW2_OPT_REFCOUNT_CACHE_SIZE " may not exceed "
                       QCOW2_OPT_CACHE_SIZE);
            return;
        }

        if (l2_cache_size_set) {
            *refcount_cache_size = combined_cache_size - *l2_cache_size;
        } else if (refcount_cache_size_set) {
            *l2_cache_size = combined_cache_size - *refcount_cache_size;
        } else {
            *refcount_cache_size = combined_cache_size
                                 / (DEFAULT_L2_REFCOUNT_SIZE_RATIO + 1);
            *l2_cache_size = combined_cache_size - *refcount_cache_size;
        }
    } else {
        if (!l2_cache_size_set && !refcount_cache_size_set) {
M
Max Reitz 已提交
779 780 781
            *l2_cache_size = MAX(DEFAULT_L2_CACHE_BYTE_SIZE,
                                 (uint64_t)DEFAULT_L2_CACHE_CLUSTERS
                                 * s->cluster_size);
782 783 784 785 786 787 788 789 790 791 792 793
            *refcount_cache_size = *l2_cache_size
                                 / DEFAULT_L2_REFCOUNT_SIZE_RATIO;
        } else if (!l2_cache_size_set) {
            *l2_cache_size = *refcount_cache_size
                           * DEFAULT_L2_REFCOUNT_SIZE_RATIO;
        } else if (!refcount_cache_size_set) {
            *refcount_cache_size = *l2_cache_size
                                 / DEFAULT_L2_REFCOUNT_SIZE_RATIO;
        }
    }
}

794 795 796 797 798 799 800
typedef struct Qcow2ReopenState {
    Qcow2Cache *l2_table_cache;
    Qcow2Cache *refcount_block_cache;
    bool use_lazy_refcounts;
    int overlap_check;
    bool discard_passthrough[QCOW2_DISCARD_MAX];
    uint64_t cache_clean_interval;
801
    QCryptoBlockOpenOptions *crypto_opts; /* Disk encryption runtime options */
802 803 804 805 806 807
} Qcow2ReopenState;

static int qcow2_update_options_prepare(BlockDriverState *bs,
                                        Qcow2ReopenState *r,
                                        QDict *options, int flags,
                                        Error **errp)
808 809
{
    BDRVQcow2State *s = bs->opaque;
810
    QemuOpts *opts = NULL;
811 812
    const char *opt_overlap_check, *opt_overlap_check_template;
    int overlap_check_template = 0;
813
    uint64_t l2_cache_size, refcount_cache_size;
814
    int i;
815 816
    const char *encryptfmt;
    QDict *encryptopts = NULL;
817
    Error *local_err = NULL;
818 819
    int ret;

820 821 822
    qdict_extract_subqdict(options, &encryptopts, "encrypt.");
    encryptfmt = qdict_get_try_str(encryptopts, "format");

823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
    opts = qemu_opts_create(&qcow2_runtime_opts, NULL, 0, &error_abort);
    qemu_opts_absorb_qdict(opts, options, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        ret = -EINVAL;
        goto fail;
    }

    /* get L2 table/refcount block cache size from command line options */
    read_cache_sizes(bs, opts, &l2_cache_size, &refcount_cache_size,
                     &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        ret = -EINVAL;
        goto fail;
    }

    l2_cache_size /= s->cluster_size;
    if (l2_cache_size < MIN_L2_CACHE_SIZE) {
        l2_cache_size = MIN_L2_CACHE_SIZE;
    }
    if (l2_cache_size > INT_MAX) {
        error_setg(errp, "L2 cache size too big");
        ret = -EINVAL;
        goto fail;
    }

    refcount_cache_size /= s->cluster_size;
    if (refcount_cache_size < MIN_REFCOUNT_CACHE_SIZE) {
        refcount_cache_size = MIN_REFCOUNT_CACHE_SIZE;
    }
    if (refcount_cache_size > INT_MAX) {
        error_setg(errp, "Refcount cache size too big");
        ret = -EINVAL;
        goto fail;
    }

860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877
    /* alloc new L2 table/refcount block cache, flush old one */
    if (s->l2_table_cache) {
        ret = qcow2_cache_flush(bs, s->l2_table_cache);
        if (ret) {
            error_setg_errno(errp, -ret, "Failed to flush the L2 table cache");
            goto fail;
        }
    }

    if (s->refcount_block_cache) {
        ret = qcow2_cache_flush(bs, s->refcount_block_cache);
        if (ret) {
            error_setg_errno(errp, -ret,
                             "Failed to flush the refcount block cache");
            goto fail;
        }
    }

878 879 880
    r->l2_table_cache = qcow2_cache_create(bs, l2_cache_size);
    r->refcount_block_cache = qcow2_cache_create(bs, refcount_cache_size);
    if (r->l2_table_cache == NULL || r->refcount_block_cache == NULL) {
881 882 883 884 885 886
        error_setg(errp, "Could not allocate metadata caches");
        ret = -ENOMEM;
        goto fail;
    }

    /* New interval for cache cleanup timer */
887
    r->cache_clean_interval =
888 889
        qemu_opt_get_number(opts, QCOW2_OPT_CACHE_CLEAN_INTERVAL,
                            s->cache_clean_interval);
890 891 892 893 894 895 896 897
#ifndef CONFIG_LINUX
    if (r->cache_clean_interval != 0) {
        error_setg(errp, QCOW2_OPT_CACHE_CLEAN_INTERVAL
                   " not supported on this host");
        ret = -EINVAL;
        goto fail;
    }
#endif
898
    if (r->cache_clean_interval > UINT_MAX) {
899 900 901 902 903
        error_setg(errp, "Cache clean interval too big");
        ret = -EINVAL;
        goto fail;
    }

904
    /* lazy-refcounts; flush if going from enabled to disabled */
905
    r->use_lazy_refcounts = qemu_opt_get_bool(opts, QCOW2_OPT_LAZY_REFCOUNTS,
906
        (s->compatible_features & QCOW2_COMPAT_LAZY_REFCOUNTS));
907
    if (r->use_lazy_refcounts && s->qcow_version < 3) {
908 909 910 911 912
        error_setg(errp, "Lazy refcounts require a qcow2 image with at least "
                   "qemu 1.1 compatibility level");
        ret = -EINVAL;
        goto fail;
    }
913

914 915 916 917 918 919 920 921
    if (s->use_lazy_refcounts && !r->use_lazy_refcounts) {
        ret = qcow2_mark_clean(bs);
        if (ret < 0) {
            error_setg_errno(errp, -ret, "Failed to disable lazy refcounts");
            goto fail;
        }
    }

922
    /* Overlap check options */
923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
    opt_overlap_check = qemu_opt_get(opts, QCOW2_OPT_OVERLAP);
    opt_overlap_check_template = qemu_opt_get(opts, QCOW2_OPT_OVERLAP_TEMPLATE);
    if (opt_overlap_check_template && opt_overlap_check &&
        strcmp(opt_overlap_check_template, opt_overlap_check))
    {
        error_setg(errp, "Conflicting values for qcow2 options '"
                   QCOW2_OPT_OVERLAP "' ('%s') and '" QCOW2_OPT_OVERLAP_TEMPLATE
                   "' ('%s')", opt_overlap_check, opt_overlap_check_template);
        ret = -EINVAL;
        goto fail;
    }
    if (!opt_overlap_check) {
        opt_overlap_check = opt_overlap_check_template ?: "cached";
    }

    if (!strcmp(opt_overlap_check, "none")) {
        overlap_check_template = 0;
    } else if (!strcmp(opt_overlap_check, "constant")) {
        overlap_check_template = QCOW2_OL_CONSTANT;
    } else if (!strcmp(opt_overlap_check, "cached")) {
        overlap_check_template = QCOW2_OL_CACHED;
    } else if (!strcmp(opt_overlap_check, "all")) {
        overlap_check_template = QCOW2_OL_ALL;
    } else {
        error_setg(errp, "Unsupported value '%s' for qcow2 option "
                   "'overlap-check'. Allowed are any of the following: "
                   "none, constant, cached, all", opt_overlap_check);
        ret = -EINVAL;
        goto fail;
    }

954
    r->overlap_check = 0;
955 956 957
    for (i = 0; i < QCOW2_OL_MAX_BITNR; i++) {
        /* overlap-check defines a template bitmask, but every flag may be
         * overwritten through the associated boolean option */
958
        r->overlap_check |=
959 960 961 962
            qemu_opt_get_bool(opts, overlap_bool_option_names[i],
                              overlap_check_template & (1 << i)) << i;
    }

963 964 965
    r->discard_passthrough[QCOW2_DISCARD_NEVER] = false;
    r->discard_passthrough[QCOW2_DISCARD_ALWAYS] = true;
    r->discard_passthrough[QCOW2_DISCARD_REQUEST] =
966 967
        qemu_opt_get_bool(opts, QCOW2_OPT_DISCARD_REQUEST,
                          flags & BDRV_O_UNMAP);
968
    r->discard_passthrough[QCOW2_DISCARD_SNAPSHOT] =
969
        qemu_opt_get_bool(opts, QCOW2_OPT_DISCARD_SNAPSHOT, true);
970
    r->discard_passthrough[QCOW2_DISCARD_OTHER] =
971 972
        qemu_opt_get_bool(opts, QCOW2_OPT_DISCARD_OTHER, false);

973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995
    switch (s->crypt_method_header) {
    case QCOW_CRYPT_NONE:
        if (encryptfmt) {
            error_setg(errp, "No encryption in image header, but options "
                       "specified format '%s'", encryptfmt);
            ret = -EINVAL;
            goto fail;
        }
        break;

    case QCOW_CRYPT_AES:
        if (encryptfmt && !g_str_equal(encryptfmt, "aes")) {
            error_setg(errp,
                       "Header reported 'aes' encryption format but "
                       "options specify '%s'", encryptfmt);
            ret = -EINVAL;
            goto fail;
        }
        qdict_del(encryptopts, "format");
        r->crypto_opts = block_crypto_open_opts_init(
            Q_CRYPTO_BLOCK_FORMAT_QCOW, encryptopts, errp);
        break;

996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
    case QCOW_CRYPT_LUKS:
        if (encryptfmt && !g_str_equal(encryptfmt, "luks")) {
            error_setg(errp,
                       "Header reported 'luks' encryption format but "
                       "options specify '%s'", encryptfmt);
            ret = -EINVAL;
            goto fail;
        }
        qdict_del(encryptopts, "format");
        r->crypto_opts = block_crypto_open_opts_init(
            Q_CRYPTO_BLOCK_FORMAT_LUKS, encryptopts, errp);
        break;

1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
    default:
        error_setg(errp, "Unsupported encryption method %d",
                   s->crypt_method_header);
        break;
    }
    if (s->crypt_method_header != QCOW_CRYPT_NONE && !r->crypto_opts) {
        ret = -EINVAL;
        goto fail;
    }

1019 1020
    ret = 0;
fail:
1021
    QDECREF(encryptopts);
1022 1023
    qemu_opts_del(opts);
    opts = NULL;
1024 1025 1026 1027 1028 1029 1030 1031 1032
    return ret;
}

static void qcow2_update_options_commit(BlockDriverState *bs,
                                        Qcow2ReopenState *r)
{
    BDRVQcow2State *s = bs->opaque;
    int i;

1033 1034 1035 1036 1037 1038
    if (s->l2_table_cache) {
        qcow2_cache_destroy(bs, s->l2_table_cache);
    }
    if (s->refcount_block_cache) {
        qcow2_cache_destroy(bs, s->refcount_block_cache);
    }
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
    s->l2_table_cache = r->l2_table_cache;
    s->refcount_block_cache = r->refcount_block_cache;

    s->overlap_check = r->overlap_check;
    s->use_lazy_refcounts = r->use_lazy_refcounts;

    for (i = 0; i < QCOW2_DISCARD_MAX; i++) {
        s->discard_passthrough[i] = r->discard_passthrough[i];
    }

1049 1050 1051 1052 1053
    if (s->cache_clean_interval != r->cache_clean_interval) {
        cache_clean_timer_del(bs);
        s->cache_clean_interval = r->cache_clean_interval;
        cache_clean_timer_init(bs, bdrv_get_aio_context(bs));
    }
1054 1055 1056

    qapi_free_QCryptoBlockOpenOptions(s->crypto_opts);
    s->crypto_opts = r->crypto_opts;
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
}

static void qcow2_update_options_abort(BlockDriverState *bs,
                                       Qcow2ReopenState *r)
{
    if (r->l2_table_cache) {
        qcow2_cache_destroy(bs, r->l2_table_cache);
    }
    if (r->refcount_block_cache) {
        qcow2_cache_destroy(bs, r->refcount_block_cache);
    }
1068
    qapi_free_QCryptoBlockOpenOptions(r->crypto_opts);
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
}

static int qcow2_update_options(BlockDriverState *bs, QDict *options,
                                int flags, Error **errp)
{
    Qcow2ReopenState r = {};
    int ret;

    ret = qcow2_update_options_prepare(bs, &r, options, flags, errp);
    if (ret >= 0) {
        qcow2_update_options_commit(bs, &r);
    } else {
        qcow2_update_options_abort(bs, &r);
    }
1083

1084 1085 1086
    return ret;
}

1087 1088
static int qcow2_do_open(BlockDriverState *bs, QDict *options, int flags,
                         Error **errp)
B
bellard 已提交
1089
{
1090
    BDRVQcow2State *s = bs->opaque;
1091 1092
    unsigned int len, i;
    int ret = 0;
B
bellard 已提交
1093
    QCowHeader header;
1094
    Error *local_err = NULL;
1095
    uint64_t ext_end;
1096
    uint64_t l1_vm_state_index;
1097
    bool update_header = false;
B
bellard 已提交
1098

1099
    ret = bdrv_pread(bs->file, 0, &header, sizeof(header));
1100
    if (ret < 0) {
M
Max Reitz 已提交
1101
        error_setg_errno(errp, -ret, "Could not read qcow2 header");
B
bellard 已提交
1102
        goto fail;
1103
    }
B
bellard 已提交
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
    be32_to_cpus(&header.magic);
    be32_to_cpus(&header.version);
    be64_to_cpus(&header.backing_file_offset);
    be32_to_cpus(&header.backing_file_size);
    be64_to_cpus(&header.size);
    be32_to_cpus(&header.cluster_bits);
    be32_to_cpus(&header.crypt_method);
    be64_to_cpus(&header.l1_table_offset);
    be32_to_cpus(&header.l1_size);
    be64_to_cpus(&header.refcount_table_offset);
    be32_to_cpus(&header.refcount_table_clusters);
    be64_to_cpus(&header.snapshots_offset);
    be32_to_cpus(&header.nb_snapshots);
1117

K
Kevin Wolf 已提交
1118
    if (header.magic != QCOW_MAGIC) {
M
Max Reitz 已提交
1119
        error_setg(errp, "Image is not in qcow2 format");
P
Paolo Bonzini 已提交
1120
        ret = -EINVAL;
B
bellard 已提交
1121
        goto fail;
1122
    }
K
Kevin Wolf 已提交
1123
    if (header.version < 2 || header.version > 3) {
1124
        error_setg(errp, "Unsupported qcow2 version %" PRIu32, header.version);
K
Kevin Wolf 已提交
1125 1126 1127 1128 1129 1130
        ret = -ENOTSUP;
        goto fail;
    }

    s->qcow_version = header.version;

1131 1132 1133
    /* Initialise cluster size */
    if (header.cluster_bits < MIN_CLUSTER_BITS ||
        header.cluster_bits > MAX_CLUSTER_BITS) {
1134 1135
        error_setg(errp, "Unsupported cluster size: 2^%" PRIu32,
                   header.cluster_bits);
1136 1137 1138 1139 1140 1141 1142 1143
        ret = -EINVAL;
        goto fail;
    }

    s->cluster_bits = header.cluster_bits;
    s->cluster_size = 1 << s->cluster_bits;
    s->cluster_sectors = 1 << (s->cluster_bits - 9);

K
Kevin Wolf 已提交
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
    /* Initialise version 3 header fields */
    if (header.version == 2) {
        header.incompatible_features    = 0;
        header.compatible_features      = 0;
        header.autoclear_features       = 0;
        header.refcount_order           = 4;
        header.header_length            = 72;
    } else {
        be64_to_cpus(&header.incompatible_features);
        be64_to_cpus(&header.compatible_features);
        be64_to_cpus(&header.autoclear_features);
        be32_to_cpus(&header.refcount_order);
        be32_to_cpus(&header.header_length);
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168

        if (header.header_length < 104) {
            error_setg(errp, "qcow2 header too short");
            ret = -EINVAL;
            goto fail;
        }
    }

    if (header.header_length > s->cluster_size) {
        error_setg(errp, "qcow2 header exceeds cluster size");
        ret = -EINVAL;
        goto fail;
K
Kevin Wolf 已提交
1169 1170 1171 1172 1173
    }

    if (header.header_length > sizeof(header)) {
        s->unknown_header_fields_size = header.header_length - sizeof(header);
        s->unknown_header_fields = g_malloc(s->unknown_header_fields_size);
1174
        ret = bdrv_pread(bs->file, sizeof(header), s->unknown_header_fields,
K
Kevin Wolf 已提交
1175 1176
                         s->unknown_header_fields_size);
        if (ret < 0) {
M
Max Reitz 已提交
1177 1178
            error_setg_errno(errp, -ret, "Could not read unknown qcow2 header "
                             "fields");
K
Kevin Wolf 已提交
1179 1180 1181 1182
            goto fail;
        }
    }

1183 1184 1185 1186 1187 1188
    if (header.backing_file_offset > s->cluster_size) {
        error_setg(errp, "Invalid backing file offset");
        ret = -EINVAL;
        goto fail;
    }

1189 1190 1191 1192 1193 1194
    if (header.backing_file_offset) {
        ext_end = header.backing_file_offset;
    } else {
        ext_end = 1 << header.cluster_bits;
    }

K
Kevin Wolf 已提交
1195 1196 1197 1198 1199
    /* Handle feature bits */
    s->incompatible_features    = header.incompatible_features;
    s->compatible_features      = header.compatible_features;
    s->autoclear_features       = header.autoclear_features;

S
Stefan Hajnoczi 已提交
1200
    if (s->incompatible_features & ~QCOW2_INCOMPAT_MASK) {
1201 1202
        void *feature_table = NULL;
        qcow2_read_extensions(bs, header.header_length, ext_end,
1203
                              &feature_table, flags, NULL, NULL);
1204
        report_unsupported_feature(errp, feature_table,
S
Stefan Hajnoczi 已提交
1205 1206
                                   s->incompatible_features &
                                   ~QCOW2_INCOMPAT_MASK);
K
Kevin Wolf 已提交
1207
        ret = -ENOTSUP;
1208
        g_free(feature_table);
K
Kevin Wolf 已提交
1209 1210 1211
        goto fail;
    }

M
Max Reitz 已提交
1212 1213 1214 1215
    if (s->incompatible_features & QCOW2_INCOMPAT_CORRUPT) {
        /* Corrupt images may not be written to unless they are being repaired
         */
        if ((flags & BDRV_O_RDWR) && !(flags & BDRV_O_CHECK)) {
M
Max Reitz 已提交
1216 1217
            error_setg(errp, "qcow2: Image is corrupt; cannot be opened "
                       "read/write");
M
Max Reitz 已提交
1218 1219 1220 1221 1222
            ret = -EACCES;
            goto fail;
        }
    }

K
Kevin Wolf 已提交
1223
    /* Check support for various header values */
1224 1225 1226 1227
    if (header.refcount_order > 6) {
        error_setg(errp, "Reference count entry width too large; may not "
                   "exceed 64 bits");
        ret = -EINVAL;
K
Kevin Wolf 已提交
1228 1229
        goto fail;
    }
1230
    s->refcount_order = header.refcount_order;
1231 1232 1233
    s->refcount_bits = 1 << s->refcount_order;
    s->refcount_max = UINT64_C(1) << (s->refcount_bits - 1);
    s->refcount_max += s->refcount_max - 1;
K
Kevin Wolf 已提交
1234

B
bellard 已提交
1235
    s->crypt_method_header = header.crypt_method;
1236
    if (s->crypt_method_header) {
1237 1238
        if (bdrv_uses_whitelist() &&
            s->crypt_method_header == QCOW_CRYPT_AES) {
1239 1240 1241 1242 1243 1244 1245 1246 1247 1248
            error_setg(errp,
                       "Use of AES-CBC encrypted qcow2 images is no longer "
                       "supported in system emulators");
            error_append_hint(errp,
                              "You can use 'qemu-img convert' to convert your "
                              "image to an alternative supported format, such "
                              "as unencrypted qcow2, or raw with the LUKS "
                              "format instead.\n");
            ret = -ENOSYS;
            goto fail;
1249 1250
        }

1251 1252 1253 1254 1255 1256 1257 1258 1259
        if (s->crypt_method_header == QCOW_CRYPT_AES) {
            s->crypt_physical_offset = false;
        } else {
            /* Assuming LUKS and any future crypt methods we
             * add will all use physical offsets, due to the
             * fact that the alternative is insecure...  */
            s->crypt_physical_offset = true;
        }

1260
        bs->encrypted = true;
1261
    }
1262

B
bellard 已提交
1263 1264
    s->l2_bits = s->cluster_bits - 3; /* L2 is always one cluster */
    s->l2_size = 1 << s->l2_bits;
1265 1266 1267
    /* 2^(s->refcount_order - 3) is the refcount width in bytes */
    s->refcount_block_bits = s->cluster_bits - (s->refcount_order - 3);
    s->refcount_block_size = 1 << s->refcount_block_bits;
B
bellard 已提交
1268 1269 1270 1271
    bs->total_sectors = header.size / 512;
    s->csize_shift = (62 - (s->cluster_bits - 8));
    s->csize_mask = (1 << (s->cluster_bits - 8)) - 1;
    s->cluster_offset_mask = (1LL << s->csize_shift) - 1;
1272

B
bellard 已提交
1273
    s->refcount_table_offset = header.refcount_table_offset;
1274
    s->refcount_table_size =
B
bellard 已提交
1275 1276
        header.refcount_table_clusters << (s->cluster_bits - 3);

1277
    if (header.refcount_table_clusters > qcow2_max_refcount_clusters(s)) {
1278 1279 1280 1281 1282
        error_setg(errp, "Reference count table too large");
        ret = -EINVAL;
        goto fail;
    }

1283 1284 1285 1286 1287 1288 1289
    ret = validate_table_offset(bs, s->refcount_table_offset,
                                s->refcount_table_size, sizeof(uint64_t));
    if (ret < 0) {
        error_setg(errp, "Invalid reference count table offset");
        goto fail;
    }

1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304
    /* Snapshot table offset/length */
    if (header.nb_snapshots > QCOW_MAX_SNAPSHOTS) {
        error_setg(errp, "Too many snapshots");
        ret = -EINVAL;
        goto fail;
    }

    ret = validate_table_offset(bs, header.snapshots_offset,
                                header.nb_snapshots,
                                sizeof(QCowSnapshotHeader));
    if (ret < 0) {
        error_setg(errp, "Invalid snapshot table offset");
        goto fail;
    }

B
bellard 已提交
1305
    /* read the level 1 table */
1306
    if (header.l1_size > QCOW_MAX_L1_SIZE / sizeof(uint64_t)) {
1307 1308 1309 1310
        error_setg(errp, "Active L1 table too large");
        ret = -EFBIG;
        goto fail;
    }
B
bellard 已提交
1311
    s->l1_size = header.l1_size;
1312 1313 1314

    l1_vm_state_index = size_to_l1(s, header.size);
    if (l1_vm_state_index > INT_MAX) {
M
Max Reitz 已提交
1315
        error_setg(errp, "Image is too big");
1316 1317 1318 1319 1320
        ret = -EFBIG;
        goto fail;
    }
    s->l1_vm_state_index = l1_vm_state_index;

B
bellard 已提交
1321 1322
    /* the L1 table must contain at least enough entries to put
       header.size bytes */
1323
    if (s->l1_size < s->l1_vm_state_index) {
M
Max Reitz 已提交
1324
        error_setg(errp, "L1 table is too small");
1325
        ret = -EINVAL;
B
bellard 已提交
1326
        goto fail;
1327
    }
1328 1329 1330 1331 1332 1333 1334

    ret = validate_table_offset(bs, header.l1_table_offset,
                                header.l1_size, sizeof(uint64_t));
    if (ret < 0) {
        error_setg(errp, "Invalid L1 table offset");
        goto fail;
    }
B
bellard 已提交
1335
    s->l1_table_offset = header.l1_table_offset;
1336 1337


1338
    if (s->l1_size > 0) {
K
Kevin Wolf 已提交
1339
        s->l1_table = qemu_try_blockalign(bs->file->bs,
1340
            align_offset(s->l1_size * sizeof(uint64_t), 512));
1341 1342 1343 1344 1345
        if (s->l1_table == NULL) {
            error_setg(errp, "Could not allocate L1 table");
            ret = -ENOMEM;
            goto fail;
        }
1346
        ret = bdrv_pread(bs->file, s->l1_table_offset, s->l1_table,
1347 1348
                         s->l1_size * sizeof(uint64_t));
        if (ret < 0) {
M
Max Reitz 已提交
1349
            error_setg_errno(errp, -ret, "Could not read L1 table");
1350
            goto fail;
1351
        }
1352 1353 1354
        for(i = 0;i < s->l1_size; i++) {
            be64_to_cpus(&s->l1_table[i]);
        }
B
bellard 已提交
1355
    }
K
Kevin Wolf 已提交
1356

1357 1358
    /* Parse driver-specific options */
    ret = qcow2_update_options(bs, options, flags, errp);
1359 1360 1361 1362
    if (ret < 0) {
        goto fail;
    }

1363
    s->cluster_cache = g_malloc(s->cluster_size);
B
bellard 已提交
1364
    /* one more sector for decompressed data alignment */
K
Kevin Wolf 已提交
1365
    s->cluster_data = qemu_try_blockalign(bs->file->bs, QCOW_MAX_CRYPT_CLUSTERS
1366 1367 1368 1369 1370 1371 1372
                                                    * s->cluster_size + 512);
    if (s->cluster_data == NULL) {
        error_setg(errp, "Could not allocate temporary cluster buffer");
        ret = -ENOMEM;
        goto fail;
    }

B
bellard 已提交
1373
    s->cluster_cache_offset = -1;
1374
    s->flags = flags;
1375

1376 1377
    ret = qcow2_refcount_init(bs);
    if (ret != 0) {
M
Max Reitz 已提交
1378
        error_setg_errno(errp, -ret, "Could not initialize refcount handling");
B
bellard 已提交
1379
        goto fail;
1380
    }
B
bellard 已提交
1381

B
Blue Swirl 已提交
1382
    QLIST_INIT(&s->cluster_allocs);
K
Kevin Wolf 已提交
1383
    QTAILQ_INIT(&s->discards);
1384

1385
    /* read qcow2 extensions */
M
Max Reitz 已提交
1386
    if (qcow2_read_extensions(bs, header.header_length, ext_end, NULL,
1387
                              flags, &update_header, &local_err)) {
M
Max Reitz 已提交
1388
        error_propagate(errp, local_err);
1389
        ret = -EINVAL;
1390
        goto fail;
1391
    }
1392

1393 1394 1395 1396 1397 1398 1399 1400 1401 1402
    /* qcow2_read_extension may have set up the crypto context
     * if the crypt method needs a header region, some methods
     * don't need header extensions, so must check here
     */
    if (s->crypt_method_header && !s->crypto) {
        if (s->crypt_method_header == QCOW_CRYPT_AES) {
            unsigned int cflags = 0;
            if (flags & BDRV_O_NO_IO) {
                cflags |= QCRYPTO_BLOCK_OPEN_NO_IO;
            }
1403 1404
            s->crypto = qcrypto_block_open(s->crypto_opts, "encrypt.",
                                           NULL, NULL, cflags, errp);
1405 1406 1407 1408 1409 1410 1411
            if (!s->crypto) {
                ret = -EINVAL;
                goto fail;
            }
        } else if (!(flags & BDRV_O_NO_IO)) {
            error_setg(errp, "Missing CRYPTO header for crypt method %d",
                       s->crypt_method_header);
1412 1413 1414 1415 1416
            ret = -EINVAL;
            goto fail;
        }
    }

B
bellard 已提交
1417 1418 1419
    /* read the backing file name */
    if (header.backing_file_offset != 0) {
        len = header.backing_file_size;
1420
        if (len > MIN(1023, s->cluster_size - header.backing_file_offset) ||
1421
            len >= sizeof(bs->backing_file)) {
1422 1423 1424
            error_setg(errp, "Backing file name too long");
            ret = -EINVAL;
            goto fail;
1425
        }
1426
        ret = bdrv_pread(bs->file, header.backing_file_offset,
1427 1428
                         bs->backing_file, len);
        if (ret < 0) {
M
Max Reitz 已提交
1429
            error_setg_errno(errp, -ret, "Could not read backing file name");
B
bellard 已提交
1430
            goto fail;
1431
        }
B
bellard 已提交
1432
        bs->backing_file[len] = '\0';
1433
        s->image_backing_file = g_strdup(bs->backing_file);
B
bellard 已提交
1434
    }
1435

1436 1437 1438 1439
    /* Internal snapshots */
    s->snapshots_offset = header.snapshots_offset;
    s->nb_snapshots = header.nb_snapshots;

1440 1441
    ret = qcow2_read_snapshots(bs);
    if (ret < 0) {
M
Max Reitz 已提交
1442
        error_setg_errno(errp, -ret, "Could not read snapshots");
B
bellard 已提交
1443
        goto fail;
1444
    }
B
bellard 已提交
1445

1446
    /* Clear unknown autoclear feature bits */
1447
    update_header |= s->autoclear_features & ~QCOW2_AUTOCLEAR_MASK;
1448 1449 1450
    update_header =
        update_header && !bs->read_only && !(flags & BDRV_O_INACTIVE);
    if (update_header) {
1451
        s->autoclear_features &= QCOW2_AUTOCLEAR_MASK;
1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463
    }

    if (qcow2_load_autoloading_dirty_bitmaps(bs, &local_err)) {
        update_header = false;
    }
    if (local_err != NULL) {
        error_propagate(errp, local_err);
        ret = -EINVAL;
        goto fail;
    }

    if (update_header) {
1464 1465
        ret = qcow2_update_header(bs);
        if (ret < 0) {
M
Max Reitz 已提交
1466
            error_setg_errno(errp, -ret, "Could not update qcow2 header");
1467 1468 1469 1470
            goto fail;
        }
    }

K
Kevin Wolf 已提交
1471 1472
    /* Initialise locks */
    qemu_co_mutex_init(&s->lock);
F
Fam Zheng 已提交
1473
    bs->supported_zero_flags = BDRV_REQ_MAY_UNMAP;
K
Kevin Wolf 已提交
1474

S
Stefan Hajnoczi 已提交
1475
    /* Repair image if dirty */
1476
    if (!(flags & (BDRV_O_CHECK | BDRV_O_INACTIVE)) && !bs->read_only &&
1477
        (s->incompatible_features & QCOW2_INCOMPAT_DIRTY)) {
S
Stefan Hajnoczi 已提交
1478 1479
        BdrvCheckResult result = {0};

M
Max Reitz 已提交
1480
        ret = qcow2_check(bs, &result, BDRV_FIX_ERRORS | BDRV_FIX_LEAKS);
S
Stefan Hajnoczi 已提交
1481
        if (ret < 0) {
M
Max Reitz 已提交
1482
            error_setg_errno(errp, -ret, "Could not repair dirty image");
S
Stefan Hajnoczi 已提交
1483 1484 1485 1486
            goto fail;
        }
    }

B
bellard 已提交
1487
#ifdef DEBUG_ALLOC
P
Philipp Hahn 已提交
1488 1489
    {
        BdrvCheckResult result = {0};
1490
        qcow2_check_refcounts(bs, &result, 0);
P
Philipp Hahn 已提交
1491
    }
B
bellard 已提交
1492
#endif
1493
    return ret;
B
bellard 已提交
1494 1495

 fail:
K
Kevin Wolf 已提交
1496
    g_free(s->unknown_header_fields);
1497
    cleanup_unknown_header_ext(bs);
K
Kevin Wolf 已提交
1498 1499
    qcow2_free_snapshots(bs);
    qcow2_refcount_close(bs);
1500
    qemu_vfree(s->l1_table);
1501 1502
    /* else pre-write overlap checks in cache_destroy may crash */
    s->l1_table = NULL;
1503
    cache_clean_timer_del(bs);
K
Kevin Wolf 已提交
1504 1505 1506
    if (s->l2_table_cache) {
        qcow2_cache_destroy(bs, s->l2_table_cache);
    }
1507 1508 1509
    if (s->refcount_block_cache) {
        qcow2_cache_destroy(bs, s->refcount_block_cache);
    }
1510
    g_free(s->cluster_cache);
1511
    qemu_vfree(s->cluster_data);
1512 1513
    qcrypto_block_free(s->crypto);
    qapi_free_QCryptoBlockOpenOptions(s->crypto_opts);
1514
    return ret;
B
bellard 已提交
1515 1516
}

1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528
static int qcow2_open(BlockDriverState *bs, QDict *options, int flags,
                      Error **errp)
{
    bs->file = bdrv_open_child(NULL, options, "file", bs, &child_file,
                               false, errp);
    if (!bs->file) {
        return -EINVAL;
    }

    return qcow2_do_open(bs, options, flags, errp);
}

1529
static void qcow2_refresh_limits(BlockDriverState *bs, Error **errp)
1530
{
1531
    BDRVQcow2State *s = bs->opaque;
1532

1533 1534
    if (bs->encrypted) {
        /* Encryption works on a sector granularity */
1535
        bs->bl.request_alignment = BDRV_SECTOR_SIZE;
1536
    }
1537
    bs->bl.pwrite_zeroes_alignment = s->cluster_size;
1538
    bs->bl.pdiscard_alignment = s->cluster_size;
1539 1540
}

J
Jeff Cody 已提交
1541 1542 1543
static int qcow2_reopen_prepare(BDRVReopenState *state,
                                BlockReopenQueue *queue, Error **errp)
{
1544
    Qcow2ReopenState *r;
1545 1546
    int ret;

1547 1548 1549 1550 1551 1552 1553 1554 1555 1556
    r = g_new0(Qcow2ReopenState, 1);
    state->opaque = r;

    ret = qcow2_update_options_prepare(state->bs, r, state->options,
                                       state->flags, errp);
    if (ret < 0) {
        goto fail;
    }

    /* We need to write out any unwritten data if we reopen read-only. */
1557
    if ((state->flags & BDRV_O_RDWR) == 0) {
1558 1559 1560 1561 1562
        ret = qcow2_reopen_bitmaps_ro(state->bs, errp);
        if (ret < 0) {
            goto fail;
        }

1563 1564
        ret = bdrv_flush(state->bs);
        if (ret < 0) {
1565
            goto fail;
1566 1567 1568 1569
        }

        ret = qcow2_mark_clean(state->bs);
        if (ret < 0) {
1570
            goto fail;
1571 1572 1573
        }
    }

J
Jeff Cody 已提交
1574
    return 0;
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591

fail:
    qcow2_update_options_abort(state->bs, r);
    g_free(r);
    return ret;
}

static void qcow2_reopen_commit(BDRVReopenState *state)
{
    qcow2_update_options_commit(state->bs, state->opaque);
    g_free(state->opaque);
}

static void qcow2_reopen_abort(BDRVReopenState *state)
{
    qcow2_update_options_abort(state->bs, state->opaque);
    g_free(state->opaque);
J
Jeff Cody 已提交
1592 1593
}

1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639
static void qcow2_join_options(QDict *options, QDict *old_options)
{
    bool has_new_overlap_template =
        qdict_haskey(options, QCOW2_OPT_OVERLAP) ||
        qdict_haskey(options, QCOW2_OPT_OVERLAP_TEMPLATE);
    bool has_new_total_cache_size =
        qdict_haskey(options, QCOW2_OPT_CACHE_SIZE);
    bool has_all_cache_options;

    /* New overlap template overrides all old overlap options */
    if (has_new_overlap_template) {
        qdict_del(old_options, QCOW2_OPT_OVERLAP);
        qdict_del(old_options, QCOW2_OPT_OVERLAP_TEMPLATE);
        qdict_del(old_options, QCOW2_OPT_OVERLAP_MAIN_HEADER);
        qdict_del(old_options, QCOW2_OPT_OVERLAP_ACTIVE_L1);
        qdict_del(old_options, QCOW2_OPT_OVERLAP_ACTIVE_L2);
        qdict_del(old_options, QCOW2_OPT_OVERLAP_REFCOUNT_TABLE);
        qdict_del(old_options, QCOW2_OPT_OVERLAP_REFCOUNT_BLOCK);
        qdict_del(old_options, QCOW2_OPT_OVERLAP_SNAPSHOT_TABLE);
        qdict_del(old_options, QCOW2_OPT_OVERLAP_INACTIVE_L1);
        qdict_del(old_options, QCOW2_OPT_OVERLAP_INACTIVE_L2);
    }

    /* New total cache size overrides all old options */
    if (qdict_haskey(options, QCOW2_OPT_CACHE_SIZE)) {
        qdict_del(old_options, QCOW2_OPT_L2_CACHE_SIZE);
        qdict_del(old_options, QCOW2_OPT_REFCOUNT_CACHE_SIZE);
    }

    qdict_join(options, old_options, false);

    /*
     * If after merging all cache size options are set, an old total size is
     * overwritten. Do keep all options, however, if all three are new. The
     * resulting error message is what we want to happen.
     */
    has_all_cache_options =
        qdict_haskey(options, QCOW2_OPT_CACHE_SIZE) ||
        qdict_haskey(options, QCOW2_OPT_L2_CACHE_SIZE) ||
        qdict_haskey(options, QCOW2_OPT_REFCOUNT_CACHE_SIZE);

    if (has_all_cache_options && !has_new_total_cache_size) {
        qdict_del(options, QCOW2_OPT_CACHE_SIZE);
    }
}

1640
static int64_t coroutine_fn qcow2_co_get_block_status(BlockDriverState *bs,
1641
        int64_t sector_num, int nb_sectors, int *pnum, BlockDriverState **file)
B
bellard 已提交
1642
{
1643
    BDRVQcow2State *s = bs->opaque;
B
bellard 已提交
1644
    uint64_t cluster_offset;
1645
    int index_in_cluster, ret;
K
Kevin Wolf 已提交
1646
    unsigned int bytes;
1647
    int64_t status = 0;
B
bellard 已提交
1648

K
Kevin Wolf 已提交
1649
    bytes = MIN(INT_MAX, nb_sectors * BDRV_SECTOR_SIZE);
1650
    qemu_co_mutex_lock(&s->lock);
K
Kevin Wolf 已提交
1651 1652
    ret = qcow2_get_cluster_offset(bs, sector_num << 9, &bytes,
                                   &cluster_offset);
1653
    qemu_co_mutex_unlock(&s->lock);
1654
    if (ret < 0) {
1655
        return ret;
1656
    }
1657

K
Kevin Wolf 已提交
1658 1659
    *pnum = bytes >> BDRV_SECTOR_BITS;

1660
    if (cluster_offset != 0 && ret != QCOW2_CLUSTER_COMPRESSED &&
1661
        !s->crypto) {
1662 1663
        index_in_cluster = sector_num & (s->cluster_sectors - 1);
        cluster_offset |= (index_in_cluster << BDRV_SECTOR_BITS);
1664
        *file = bs->file->bs;
1665 1666
        status |= BDRV_BLOCK_OFFSET_VALID | cluster_offset;
    }
1667
    if (ret == QCOW2_CLUSTER_ZERO_PLAIN || ret == QCOW2_CLUSTER_ZERO_ALLOC) {
1668 1669 1670 1671 1672
        status |= BDRV_BLOCK_ZERO;
    } else if (ret != QCOW2_CLUSTER_UNALLOCATED) {
        status |= BDRV_BLOCK_DATA;
    }
    return status;
B
bellard 已提交
1673 1674
}

B
bellard 已提交
1675
/* handle reading after the end of the backing file */
1676
int qcow2_backing_read1(BlockDriverState *bs, QEMUIOVector *qiov,
K
Kevin Wolf 已提交
1677
                        int64_t offset, int bytes)
B
bellard 已提交
1678
{
K
Kevin Wolf 已提交
1679
    uint64_t bs_size = bs->total_sectors * BDRV_SECTOR_SIZE;
B
bellard 已提交
1680
    int n1;
K
Kevin Wolf 已提交
1681 1682 1683 1684 1685 1686

    if ((offset + bytes) <= bs_size) {
        return bytes;
    }

    if (offset >= bs_size) {
B
bellard 已提交
1687
        n1 = 0;
K
Kevin Wolf 已提交
1688 1689 1690
    } else {
        n1 = bs_size - offset;
    }
1691

K
Kevin Wolf 已提交
1692
    qemu_iovec_memset(qiov, n1, 0, bytes - n1);
1693

B
bellard 已提交
1694 1695 1696
    return n1;
}

K
Kevin Wolf 已提交
1697 1698 1699
static coroutine_fn int qcow2_co_preadv(BlockDriverState *bs, uint64_t offset,
                                        uint64_t bytes, QEMUIOVector *qiov,
                                        int flags)
B
bellard 已提交
1700
{
1701
    BDRVQcow2State *s = bs->opaque;
K
Kevin Wolf 已提交
1702
    int offset_in_cluster, n1;
K
Kevin Wolf 已提交
1703
    int ret;
K
Kevin Wolf 已提交
1704
    unsigned int cur_bytes; /* number of bytes in current iteration */
1705
    uint64_t cluster_offset = 0;
1706 1707 1708
    uint64_t bytes_done = 0;
    QEMUIOVector hd_qiov;
    uint8_t *cluster_data = NULL;
B
bellard 已提交
1709

1710 1711 1712 1713
    qemu_iovec_init(&hd_qiov, qiov->niov);

    qemu_co_mutex_lock(&s->lock);

K
Kevin Wolf 已提交
1714
    while (bytes != 0) {
1715

1716
        /* prepare next request */
K
Kevin Wolf 已提交
1717
        cur_bytes = MIN(bytes, INT_MAX);
1718
        if (s->crypto) {
K
Kevin Wolf 已提交
1719 1720
            cur_bytes = MIN(cur_bytes,
                            QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size);
B
bellard 已提交
1721
        }
1722

K
Kevin Wolf 已提交
1723
        ret = qcow2_get_cluster_offset(bs, offset, &cur_bytes, &cluster_offset);
1724
        if (ret < 0) {
1725
            goto fail;
1726
        }
1727

K
Kevin Wolf 已提交
1728
        offset_in_cluster = offset_into_cluster(s, offset);
1729

1730
        qemu_iovec_reset(&hd_qiov);
K
Kevin Wolf 已提交
1731
        qemu_iovec_concat(&hd_qiov, qiov, bytes_done, cur_bytes);
1732

1733 1734
        switch (ret) {
        case QCOW2_CLUSTER_UNALLOCATED:
1735

1736
            if (bs->backing) {
1737
                /* read from the base image */
1738
                n1 = qcow2_backing_read1(bs->backing->bs, &hd_qiov,
K
Kevin Wolf 已提交
1739
                                         offset, cur_bytes);
1740
                if (n1 > 0) {
1741 1742 1743
                    QEMUIOVector local_qiov;

                    qemu_iovec_init(&local_qiov, hd_qiov.niov);
K
Kevin Wolf 已提交
1744
                    qemu_iovec_concat(&local_qiov, &hd_qiov, 0, n1);
1745

1746 1747
                    BLKDBG_EVENT(bs->file, BLKDBG_READ_BACKING_AIO);
                    qemu_co_mutex_unlock(&s->lock);
1748
                    ret = bdrv_co_preadv(bs->backing, offset, n1,
K
Kevin Wolf 已提交
1749
                                         &local_qiov, 0);
1750
                    qemu_co_mutex_lock(&s->lock);
1751 1752 1753

                    qemu_iovec_destroy(&local_qiov);

1754
                    if (ret < 0) {
1755
                        goto fail;
1756 1757 1758 1759
                    }
                }
            } else {
                /* Note: in this case, no need to wait */
K
Kevin Wolf 已提交
1760
                qemu_iovec_memset(&hd_qiov, 0, 0, cur_bytes);
1761
            }
1762 1763
            break;

1764 1765
        case QCOW2_CLUSTER_ZERO_PLAIN:
        case QCOW2_CLUSTER_ZERO_ALLOC:
K
Kevin Wolf 已提交
1766
            qemu_iovec_memset(&hd_qiov, 0, 0, cur_bytes);
1767 1768
            break;

1769
        case QCOW2_CLUSTER_COMPRESSED:
1770 1771 1772
            /* add AIO support for compressed blocks ? */
            ret = qcow2_decompress_cluster(bs, cluster_offset);
            if (ret < 0) {
1773
                goto fail;
1774 1775
            }

1776
            qemu_iovec_from_buf(&hd_qiov, 0,
K
Kevin Wolf 已提交
1777 1778
                                s->cluster_cache + offset_in_cluster,
                                cur_bytes);
1779 1780 1781
            break;

        case QCOW2_CLUSTER_NORMAL:
1782
            if ((cluster_offset & 511) != 0) {
1783 1784
                ret = -EIO;
                goto fail;
1785
            }
1786

1787
            if (bs->encrypted) {
1788
                assert(s->crypto);
1789

1790 1791 1792 1793
                /*
                 * For encrypted images, read everything into a temporary
                 * contiguous buffer on which the AES functions can work.
                 */
1794 1795
                if (!cluster_data) {
                    cluster_data =
K
Kevin Wolf 已提交
1796 1797 1798
                        qemu_try_blockalign(bs->file->bs,
                                            QCOW_MAX_CRYPT_CLUSTERS
                                            * s->cluster_size);
1799 1800 1801 1802
                    if (cluster_data == NULL) {
                        ret = -ENOMEM;
                        goto fail;
                    }
1803 1804
                }

K
Kevin Wolf 已提交
1805
                assert(cur_bytes <= QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size);
1806
                qemu_iovec_reset(&hd_qiov);
K
Kevin Wolf 已提交
1807
                qemu_iovec_add(&hd_qiov, cluster_data, cur_bytes);
1808 1809 1810 1811
            }

            BLKDBG_EVENT(bs->file, BLKDBG_READ_AIO);
            qemu_co_mutex_unlock(&s->lock);
1812
            ret = bdrv_co_preadv(bs->file,
K
Kevin Wolf 已提交
1813 1814
                                 cluster_offset + offset_in_cluster,
                                 cur_bytes, &hd_qiov, 0);
1815 1816
            qemu_co_mutex_lock(&s->lock);
            if (ret < 0) {
1817
                goto fail;
1818
            }
1819
            if (bs->encrypted) {
1820
                assert(s->crypto);
K
Kevin Wolf 已提交
1821 1822
                assert((offset & (BDRV_SECTOR_SIZE - 1)) == 0);
                assert((cur_bytes & (BDRV_SECTOR_SIZE - 1)) == 0);
1823
                Error *err = NULL;
1824
                if (qcrypto_block_decrypt(s->crypto,
1825 1826 1827
                                          (s->crypt_physical_offset ?
                                           cluster_offset + offset_in_cluster :
                                           offset) >> BDRV_SECTOR_BITS,
1828
                                          cluster_data,
1829 1830
                                          cur_bytes,
                                          &err) < 0) {
1831 1832 1833 1834
                    error_free(err);
                    ret = -EIO;
                    goto fail;
                }
K
Kevin Wolf 已提交
1835
                qemu_iovec_from_buf(qiov, bytes_done, cluster_data, cur_bytes);
1836
            }
1837 1838 1839 1840 1841 1842
            break;

        default:
            g_assert_not_reached();
            ret = -EIO;
            goto fail;
1843
        }
1844

K
Kevin Wolf 已提交
1845 1846 1847
        bytes -= cur_bytes;
        offset += cur_bytes;
        bytes_done += cur_bytes;
1848
    }
1849
    ret = 0;
1850

1851
fail:
K
Kevin Wolf 已提交
1852
    qemu_co_mutex_unlock(&s->lock);
K
Kevin Wolf 已提交
1853

1854
    qemu_iovec_destroy(&hd_qiov);
1855
    qemu_vfree(cluster_data);
K
Kevin Wolf 已提交
1856 1857

    return ret;
B
bellard 已提交
1858 1859
}

1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897
/* Check if it's possible to merge a write request with the writing of
 * the data from the COW regions */
static bool merge_cow(uint64_t offset, unsigned bytes,
                      QEMUIOVector *hd_qiov, QCowL2Meta *l2meta)
{
    QCowL2Meta *m;

    for (m = l2meta; m != NULL; m = m->next) {
        /* If both COW regions are empty then there's nothing to merge */
        if (m->cow_start.nb_bytes == 0 && m->cow_end.nb_bytes == 0) {
            continue;
        }

        /* The data (middle) region must be immediately after the
         * start region */
        if (l2meta_cow_start(m) + m->cow_start.nb_bytes != offset) {
            continue;
        }

        /* The end region must be immediately after the data (middle)
         * region */
        if (m->offset + m->cow_end.offset != offset + bytes) {
            continue;
        }

        /* Make sure that adding both COW regions to the QEMUIOVector
         * does not exceed IOV_MAX */
        if (hd_qiov->niov > IOV_MAX - 2) {
            continue;
        }

        m->data_qiov = hd_qiov;
        return true;
    }

    return false;
}

K
Kevin Wolf 已提交
1898 1899 1900
static coroutine_fn int qcow2_co_pwritev(BlockDriverState *bs, uint64_t offset,
                                         uint64_t bytes, QEMUIOVector *qiov,
                                         int flags)
B
bellard 已提交
1901
{
1902
    BDRVQcow2State *s = bs->opaque;
K
Kevin Wolf 已提交
1903
    int offset_in_cluster;
K
Kevin Wolf 已提交
1904
    int ret;
K
Kevin Wolf 已提交
1905
    unsigned int cur_bytes; /* number of sectors in current iteration */
1906
    uint64_t cluster_offset;
1907 1908 1909
    QEMUIOVector hd_qiov;
    uint64_t bytes_done = 0;
    uint8_t *cluster_data = NULL;
1910
    QCowL2Meta *l2meta = NULL;
1911

K
Kevin Wolf 已提交
1912
    trace_qcow2_writev_start_req(qemu_coroutine_self(), offset, bytes);
K
Kevin Wolf 已提交
1913

1914 1915 1916
    qemu_iovec_init(&hd_qiov, qiov->niov);

    s->cluster_cache_offset = -1; /* disable compressed cache */
1917

1918 1919
    qemu_co_mutex_lock(&s->lock);

K
Kevin Wolf 已提交
1920
    while (bytes != 0) {
1921

1922
        l2meta = NULL;
K
Kevin Wolf 已提交
1923

K
Kevin Wolf 已提交
1924
        trace_qcow2_writev_start_part(qemu_coroutine_self());
K
Kevin Wolf 已提交
1925 1926 1927 1928 1929 1930
        offset_in_cluster = offset_into_cluster(s, offset);
        cur_bytes = MIN(bytes, INT_MAX);
        if (bs->encrypted) {
            cur_bytes = MIN(cur_bytes,
                            QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size
                            - offset_in_cluster);
1931
        }
1932

K
Kevin Wolf 已提交
1933 1934
        ret = qcow2_alloc_cluster_offset(bs, offset, &cur_bytes,
                                         &cluster_offset, &l2meta);
1935
        if (ret < 0) {
1936
            goto fail;
1937
        }
1938

1939
        assert((cluster_offset & 511) == 0);
1940

1941
        qemu_iovec_reset(&hd_qiov);
K
Kevin Wolf 已提交
1942
        qemu_iovec_concat(&hd_qiov, qiov, bytes_done, cur_bytes);
1943

1944
        if (bs->encrypted) {
1945
            Error *err = NULL;
1946
            assert(s->crypto);
1947
            if (!cluster_data) {
K
Kevin Wolf 已提交
1948
                cluster_data = qemu_try_blockalign(bs->file->bs,
1949 1950 1951 1952 1953 1954
                                                   QCOW_MAX_CRYPT_CLUSTERS
                                                   * s->cluster_size);
                if (cluster_data == NULL) {
                    ret = -ENOMEM;
                    goto fail;
                }
1955
            }
1956

1957
            assert(hd_qiov.size <=
1958
                   QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size);
1959
            qemu_iovec_to_buf(&hd_qiov, 0, cluster_data, hd_qiov.size);
1960

1961 1962 1963 1964
            if (qcrypto_block_encrypt(s->crypto,
                                      (s->crypt_physical_offset ?
                                       cluster_offset + offset_in_cluster :
                                       offset) >> BDRV_SECTOR_BITS,
1965
                                      cluster_data,
1966
                                      cur_bytes, &err) < 0) {
1967 1968 1969 1970
                error_free(err);
                ret = -EIO;
                goto fail;
            }
1971

1972
            qemu_iovec_reset(&hd_qiov);
K
Kevin Wolf 已提交
1973
            qemu_iovec_add(&hd_qiov, cluster_data, cur_bytes);
1974
        }
1975

M
Max Reitz 已提交
1976
        ret = qcow2_pre_write_overlap_check(bs, 0,
K
Kevin Wolf 已提交
1977
                cluster_offset + offset_in_cluster, cur_bytes);
1978 1979 1980 1981
        if (ret < 0) {
            goto fail;
        }

1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997
        /* If we need to do COW, check if it's possible to merge the
         * writing of the guest data together with that of the COW regions.
         * If it's not possible (or not necessary) then write the
         * guest data now. */
        if (!merge_cow(offset, cur_bytes, &hd_qiov, l2meta)) {
            qemu_co_mutex_unlock(&s->lock);
            BLKDBG_EVENT(bs->file, BLKDBG_WRITE_AIO);
            trace_qcow2_writev_data(qemu_coroutine_self(),
                                    cluster_offset + offset_in_cluster);
            ret = bdrv_co_pwritev(bs->file,
                                  cluster_offset + offset_in_cluster,
                                  cur_bytes, &hd_qiov, 0);
            qemu_co_mutex_lock(&s->lock);
            if (ret < 0) {
                goto fail;
            }
1998
        }
1999

2000 2001 2002
        while (l2meta != NULL) {
            QCowL2Meta *next;

2003 2004 2005 2006
            ret = qcow2_alloc_cluster_link_l2(bs, l2meta);
            if (ret < 0) {
                goto fail;
            }
2007

2008 2009 2010 2011 2012 2013 2014
            /* Take the request off the list of running requests */
            if (l2meta->nb_clusters != 0) {
                QLIST_REMOVE(l2meta, next_in_flight);
            }

            qemu_co_queue_restart_all(&l2meta->dependent_requests);

2015
            next = l2meta->next;
2016
            g_free(l2meta);
2017
            l2meta = next;
2018
        }
2019

K
Kevin Wolf 已提交
2020 2021 2022 2023
        bytes -= cur_bytes;
        offset += cur_bytes;
        bytes_done += cur_bytes;
        trace_qcow2_writev_done_part(qemu_coroutine_self(), cur_bytes);
2024
    }
2025
    ret = 0;
2026

2027
fail:
2028 2029 2030
    while (l2meta != NULL) {
        QCowL2Meta *next;

2031 2032 2033 2034
        if (l2meta->nb_clusters != 0) {
            QLIST_REMOVE(l2meta, next_in_flight);
        }
        qemu_co_queue_restart_all(&l2meta->dependent_requests);
2035 2036

        next = l2meta->next;
K
Kevin Wolf 已提交
2037
        g_free(l2meta);
2038
        l2meta = next;
K
Kevin Wolf 已提交
2039
    }
2040

2041 2042
    qemu_co_mutex_unlock(&s->lock);

2043
    qemu_iovec_destroy(&hd_qiov);
2044
    qemu_vfree(cluster_data);
K
Kevin Wolf 已提交
2045
    trace_qcow2_writev_done_req(qemu_coroutine_self(), ret);
K
Kevin Wolf 已提交
2046

K
Kevin Wolf 已提交
2047
    return ret;
B
bellard 已提交
2048 2049
}

K
Kevin Wolf 已提交
2050 2051 2052 2053
static int qcow2_inactivate(BlockDriverState *bs)
{
    BDRVQcow2State *s = bs->opaque;
    int ret, result = 0;
2054
    Error *local_err = NULL;
K
Kevin Wolf 已提交
2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069

    ret = qcow2_cache_flush(bs, s->l2_table_cache);
    if (ret) {
        result = ret;
        error_report("Failed to flush the L2 table cache: %s",
                     strerror(-ret));
    }

    ret = qcow2_cache_flush(bs, s->refcount_block_cache);
    if (ret) {
        result = ret;
        error_report("Failed to flush the refcount block cache: %s",
                     strerror(-ret));
    }

2070 2071 2072 2073 2074 2075 2076 2077
    qcow2_store_persistent_dirty_bitmaps(bs, &local_err);
    if (local_err != NULL) {
        result = -EINVAL;
        error_report_err(local_err);
        error_report("Persistent bitmaps are lost for node '%s'",
                     bdrv_get_device_or_node_name(bs));
    }

K
Kevin Wolf 已提交
2078 2079 2080 2081 2082 2083 2084
    if (result == 0) {
        qcow2_mark_clean(bs);
    }

    return result;
}

2085
static void qcow2_close(BlockDriverState *bs)
B
bellard 已提交
2086
{
2087
    BDRVQcow2State *s = bs->opaque;
2088
    qemu_vfree(s->l1_table);
2089 2090
    /* else pre-write overlap checks in cache_destroy may crash */
    s->l1_table = NULL;
K
Kevin Wolf 已提交
2091

2092
    if (!(s->flags & BDRV_O_INACTIVE)) {
K
Kevin Wolf 已提交
2093
        qcow2_inactivate(bs);
2094
    }
S
Stefan Hajnoczi 已提交
2095

2096
    cache_clean_timer_del(bs);
K
Kevin Wolf 已提交
2097 2098 2099
    qcow2_cache_destroy(bs, s->l2_table_cache);
    qcow2_cache_destroy(bs, s->refcount_block_cache);

2100 2101
    qcrypto_block_free(s->crypto);
    s->crypto = NULL;
2102

K
Kevin Wolf 已提交
2103
    g_free(s->unknown_header_fields);
2104
    cleanup_unknown_header_ext(bs);
K
Kevin Wolf 已提交
2105

2106 2107 2108
    g_free(s->image_backing_file);
    g_free(s->image_backing_format);

2109
    g_free(s->cluster_cache);
2110
    qemu_vfree(s->cluster_data);
K
Kevin Wolf 已提交
2111
    qcow2_refcount_close(bs);
2112
    qcow2_free_snapshots(bs);
B
bellard 已提交
2113 2114
}

2115
static void qcow2_invalidate_cache(BlockDriverState *bs, Error **errp)
2116
{
2117
    BDRVQcow2State *s = bs->opaque;
2118
    int flags = s->flags;
2119
    QCryptoBlock *crypto = NULL;
2120
    QDict *options;
2121 2122
    Error *local_err = NULL;
    int ret;
2123 2124 2125 2126 2127 2128

    /*
     * Backing files are read-only which makes all of their metadata immutable,
     * that means we don't have to worry about reopening them here.
     */

2129 2130
    crypto = s->crypto;
    s->crypto = NULL;
2131 2132 2133

    qcow2_close(bs);

2134
    memset(s, 0, sizeof(BDRVQcow2State));
2135
    options = qdict_clone_shallow(bs->options);
2136

2137
    flags &= ~BDRV_O_INACTIVE;
2138
    ret = qcow2_do_open(bs, options, flags, &local_err);
2139
    QDECREF(options);
2140
    if (local_err) {
2141 2142
        error_propagate(errp, local_err);
        error_prepend(errp, "Could not reopen qcow2 layer: ");
2143
        bs->drv = NULL;
2144 2145 2146
        return;
    } else if (ret < 0) {
        error_setg_errno(errp, -ret, "Could not reopen qcow2 layer");
2147
        bs->drv = NULL;
2148 2149
        return;
    }
2150

2151
    s->crypto = crypto;
2152 2153
}

K
Kevin Wolf 已提交
2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167
static size_t header_ext_add(char *buf, uint32_t magic, const void *s,
    size_t len, size_t buflen)
{
    QCowExtension *ext_backing_fmt = (QCowExtension*) buf;
    size_t ext_len = sizeof(QCowExtension) + ((len + 7) & ~7);

    if (buflen < ext_len) {
        return -ENOSPC;
    }

    *ext_backing_fmt = (QCowExtension) {
        .magic  = cpu_to_be32(magic),
        .len    = cpu_to_be32(len),
    };
2168 2169 2170 2171

    if (len) {
        memcpy(buf + sizeof(QCowExtension), s, len);
    }
K
Kevin Wolf 已提交
2172 2173 2174 2175

    return ext_len;
}

K
Kevin Wolf 已提交
2176
/*
K
Kevin Wolf 已提交
2177 2178 2179 2180
 * Updates the qcow2 header, including the variable length parts of it, i.e.
 * the backing file name and all extensions. qcow2 was not designed to allow
 * such changes, so if we run out of space (we can only use the first cluster)
 * this function may fail.
K
Kevin Wolf 已提交
2181 2182 2183
 *
 * Returns 0 on success, -errno in error cases.
 */
K
Kevin Wolf 已提交
2184
int qcow2_update_header(BlockDriverState *bs)
K
Kevin Wolf 已提交
2185
{
2186
    BDRVQcow2State *s = bs->opaque;
K
Kevin Wolf 已提交
2187 2188 2189
    QCowHeader *header;
    char *buf;
    size_t buflen = s->cluster_size;
K
Kevin Wolf 已提交
2190
    int ret;
K
Kevin Wolf 已提交
2191 2192
    uint64_t total_size;
    uint32_t refcount_table_clusters;
K
Kevin Wolf 已提交
2193
    size_t header_length;
2194
    Qcow2UnknownHeaderExtension *uext;
K
Kevin Wolf 已提交
2195

K
Kevin Wolf 已提交
2196
    buf = qemu_blockalign(bs, buflen);
K
Kevin Wolf 已提交
2197

K
Kevin Wolf 已提交
2198 2199
    /* Header structure */
    header = (QCowHeader*) buf;
K
Kevin Wolf 已提交
2200

K
Kevin Wolf 已提交
2201 2202 2203
    if (buflen < sizeof(*header)) {
        ret = -ENOSPC;
        goto fail;
K
Kevin Wolf 已提交
2204 2205
    }

K
Kevin Wolf 已提交
2206
    header_length = sizeof(*header) + s->unknown_header_fields_size;
K
Kevin Wolf 已提交
2207 2208 2209 2210
    total_size = bs->total_sectors * BDRV_SECTOR_SIZE;
    refcount_table_clusters = s->refcount_table_size >> (s->cluster_bits - 3);

    *header = (QCowHeader) {
K
Kevin Wolf 已提交
2211
        /* Version 2 fields */
K
Kevin Wolf 已提交
2212
        .magic                  = cpu_to_be32(QCOW_MAGIC),
K
Kevin Wolf 已提交
2213
        .version                = cpu_to_be32(s->qcow_version),
K
Kevin Wolf 已提交
2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224
        .backing_file_offset    = 0,
        .backing_file_size      = 0,
        .cluster_bits           = cpu_to_be32(s->cluster_bits),
        .size                   = cpu_to_be64(total_size),
        .crypt_method           = cpu_to_be32(s->crypt_method_header),
        .l1_size                = cpu_to_be32(s->l1_size),
        .l1_table_offset        = cpu_to_be64(s->l1_table_offset),
        .refcount_table_offset  = cpu_to_be64(s->refcount_table_offset),
        .refcount_table_clusters = cpu_to_be32(refcount_table_clusters),
        .nb_snapshots           = cpu_to_be32(s->nb_snapshots),
        .snapshots_offset       = cpu_to_be64(s->snapshots_offset),
K
Kevin Wolf 已提交
2225 2226 2227 2228 2229

        /* Version 3 fields */
        .incompatible_features  = cpu_to_be64(s->incompatible_features),
        .compatible_features    = cpu_to_be64(s->compatible_features),
        .autoclear_features     = cpu_to_be64(s->autoclear_features),
2230
        .refcount_order         = cpu_to_be32(s->refcount_order),
K
Kevin Wolf 已提交
2231
        .header_length          = cpu_to_be32(header_length),
K
Kevin Wolf 已提交
2232
    };
K
Kevin Wolf 已提交
2233

K
Kevin Wolf 已提交
2234 2235 2236 2237 2238 2239 2240 2241 2242
    /* For older versions, write a shorter header */
    switch (s->qcow_version) {
    case 2:
        ret = offsetof(QCowHeader, incompatible_features);
        break;
    case 3:
        ret = sizeof(*header);
        break;
    default:
2243 2244
        ret = -EINVAL;
        goto fail;
K
Kevin Wolf 已提交
2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261
    }

    buf += ret;
    buflen -= ret;
    memset(buf, 0, buflen);

    /* Preserve any unknown field in the header */
    if (s->unknown_header_fields_size) {
        if (buflen < s->unknown_header_fields_size) {
            ret = -ENOSPC;
            goto fail;
        }

        memcpy(buf, s->unknown_header_fields, s->unknown_header_fields_size);
        buf += s->unknown_header_fields_size;
        buflen -= s->unknown_header_fields_size;
    }
K
Kevin Wolf 已提交
2262

K
Kevin Wolf 已提交
2263
    /* Backing file format header extension */
2264
    if (s->image_backing_format) {
K
Kevin Wolf 已提交
2265
        ret = header_ext_add(buf, QCOW2_EXT_MAGIC_BACKING_FORMAT,
2266 2267
                             s->image_backing_format,
                             strlen(s->image_backing_format),
K
Kevin Wolf 已提交
2268 2269 2270
                             buflen);
        if (ret < 0) {
            goto fail;
K
Kevin Wolf 已提交
2271 2272
        }

K
Kevin Wolf 已提交
2273 2274
        buf += ret;
        buflen -= ret;
K
Kevin Wolf 已提交
2275 2276
    }

2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292
    /* Full disk encryption header pointer extension */
    if (s->crypto_header.offset != 0) {
        cpu_to_be64s(&s->crypto_header.offset);
        cpu_to_be64s(&s->crypto_header.length);
        ret = header_ext_add(buf, QCOW2_EXT_MAGIC_CRYPTO_HEADER,
                             &s->crypto_header, sizeof(s->crypto_header),
                             buflen);
        be64_to_cpus(&s->crypto_header.offset);
        be64_to_cpus(&s->crypto_header.length);
        if (ret < 0) {
            goto fail;
        }
        buf += ret;
        buflen -= ret;
    }

2293
    /* Feature table */
2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319
    if (s->qcow_version >= 3) {
        Qcow2Feature features[] = {
            {
                .type = QCOW2_FEAT_TYPE_INCOMPATIBLE,
                .bit  = QCOW2_INCOMPAT_DIRTY_BITNR,
                .name = "dirty bit",
            },
            {
                .type = QCOW2_FEAT_TYPE_INCOMPATIBLE,
                .bit  = QCOW2_INCOMPAT_CORRUPT_BITNR,
                .name = "corrupt bit",
            },
            {
                .type = QCOW2_FEAT_TYPE_COMPATIBLE,
                .bit  = QCOW2_COMPAT_LAZY_REFCOUNTS_BITNR,
                .name = "lazy refcounts",
            },
        };

        ret = header_ext_add(buf, QCOW2_EXT_MAGIC_FEATURE_TABLE,
                             features, sizeof(features), buflen);
        if (ret < 0) {
            goto fail;
        }
        buf += ret;
        buflen -= ret;
2320 2321
    }

2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340
    /* Bitmap extension */
    if (s->nb_bitmaps > 0) {
        Qcow2BitmapHeaderExt bitmaps_header = {
            .nb_bitmaps = cpu_to_be32(s->nb_bitmaps),
            .bitmap_directory_size =
                    cpu_to_be64(s->bitmap_directory_size),
            .bitmap_directory_offset =
                    cpu_to_be64(s->bitmap_directory_offset)
        };
        ret = header_ext_add(buf, QCOW2_EXT_MAGIC_BITMAPS,
                             &bitmaps_header, sizeof(bitmaps_header),
                             buflen);
        if (ret < 0) {
            goto fail;
        }
        buf += ret;
        buflen -= ret;
    }

2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351
    /* Keep unknown header extensions */
    QLIST_FOREACH(uext, &s->unknown_header_ext, next) {
        ret = header_ext_add(buf, uext->magic, uext->data, uext->len, buflen);
        if (ret < 0) {
            goto fail;
        }

        buf += ret;
        buflen -= ret;
    }

K
Kevin Wolf 已提交
2352 2353
    /* End of header extensions */
    ret = header_ext_add(buf, QCOW2_EXT_MAGIC_END, NULL, 0, buflen);
K
Kevin Wolf 已提交
2354 2355 2356 2357
    if (ret < 0) {
        goto fail;
    }

K
Kevin Wolf 已提交
2358 2359
    buf += ret;
    buflen -= ret;
K
Kevin Wolf 已提交
2360

K
Kevin Wolf 已提交
2361
    /* Backing file name */
2362 2363
    if (s->image_backing_file) {
        size_t backing_file_len = strlen(s->image_backing_file);
K
Kevin Wolf 已提交
2364 2365 2366 2367 2368 2369

        if (buflen < backing_file_len) {
            ret = -ENOSPC;
            goto fail;
        }

2370
        /* Using strncpy is ok here, since buf is not NUL-terminated. */
2371
        strncpy(buf, s->image_backing_file, buflen);
K
Kevin Wolf 已提交
2372 2373 2374

        header->backing_file_offset = cpu_to_be64(buf - ((char*) header));
        header->backing_file_size   = cpu_to_be32(backing_file_len);
K
Kevin Wolf 已提交
2375 2376
    }

K
Kevin Wolf 已提交
2377
    /* Write the new header */
2378
    ret = bdrv_pwrite(bs->file, 0, header, s->cluster_size);
K
Kevin Wolf 已提交
2379 2380 2381 2382 2383 2384
    if (ret < 0) {
        goto fail;
    }

    ret = 0;
fail:
K
Kevin Wolf 已提交
2385
    qemu_vfree(header);
K
Kevin Wolf 已提交
2386 2387 2388 2389 2390 2391
    return ret;
}

static int qcow2_change_backing_file(BlockDriverState *bs,
    const char *backing_file, const char *backing_fmt)
{
2392
    BDRVQcow2State *s = bs->opaque;
2393

2394 2395 2396 2397
    if (backing_file && strlen(backing_file) > 1023) {
        return -EINVAL;
    }

K
Kevin Wolf 已提交
2398 2399 2400
    pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: "");
    pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: "");

2401 2402 2403 2404 2405 2406
    g_free(s->image_backing_file);
    g_free(s->image_backing_format);

    s->image_backing_file = backing_file ? g_strdup(bs->backing_file) : NULL;
    s->image_backing_format = backing_fmt ? g_strdup(bs->backing_format) : NULL;

K
Kevin Wolf 已提交
2407
    return qcow2_update_header(bs);
K
Kevin Wolf 已提交
2408 2409
}

2410 2411 2412 2413 2414 2415 2416 2417 2418 2419
static int qcow2_crypt_method_from_format(const char *encryptfmt)
{
    if (g_str_equal(encryptfmt, "luks")) {
        return QCOW_CRYPT_LUKS;
    } else if (g_str_equal(encryptfmt, "aes")) {
        return QCOW_CRYPT_AES;
    } else {
        return -EINVAL;
    }
}
2420 2421 2422 2423 2424 2425 2426 2427 2428

static int qcow2_set_up_encryption(BlockDriverState *bs, const char *encryptfmt,
                                   QemuOpts *opts, Error **errp)
{
    BDRVQcow2State *s = bs->opaque;
    QCryptoBlockCreateOptions *cryptoopts = NULL;
    QCryptoBlock *crypto = NULL;
    int ret = -EINVAL;
    QDict *options, *encryptopts;
2429
    int fmt;
2430 2431 2432 2433 2434

    options = qemu_opts_to_qdict(opts, NULL);
    qdict_extract_subqdict(options, &encryptopts, "encrypt.");
    QDECREF(options);

2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448
    fmt = qcow2_crypt_method_from_format(encryptfmt);

    switch (fmt) {
    case QCOW_CRYPT_LUKS:
        cryptoopts = block_crypto_create_opts_init(
            Q_CRYPTO_BLOCK_FORMAT_LUKS, encryptopts, errp);
        break;
    case QCOW_CRYPT_AES:
        cryptoopts = block_crypto_create_opts_init(
            Q_CRYPTO_BLOCK_FORMAT_QCOW, encryptopts, errp);
        break;
    default:
        error_setg(errp, "Unknown encryption format '%s'", encryptfmt);
        break;
2449 2450 2451 2452 2453
    }
    if (!cryptoopts) {
        ret = -EINVAL;
        goto out;
    }
2454
    s->crypt_method_header = fmt;
2455

2456
    crypto = qcrypto_block_create(cryptoopts, "encrypt.",
2457 2458
                                  qcow2_crypto_hdr_init_func,
                                  qcow2_crypto_hdr_write_func,
2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478
                                  bs, errp);
    if (!crypto) {
        ret = -EINVAL;
        goto out;
    }

    ret = qcow2_update_header(bs);
    if (ret < 0) {
        error_setg_errno(errp, -ret, "Could not write encryption header");
        goto out;
    }

 out:
    QDECREF(encryptopts);
    qcrypto_block_free(crypto);
    qapi_free_QCryptoBlockCreateOptions(cryptoopts);
    return ret;
}


2479 2480 2481 2482 2483 2484 2485 2486 2487
/**
 * Preallocates metadata structures for data clusters between @offset (in the
 * guest disk) and @new_length (which is thus generally the new guest disk
 * size).
 *
 * Returns: 0 on success, -errno on failure.
 */
static int preallocate(BlockDriverState *bs,
                       uint64_t offset, uint64_t new_length)
K
Kevin Wolf 已提交
2488
{
2489
    BDRVQcow2State *s = bs->opaque;
K
Kevin Wolf 已提交
2490
    uint64_t bytes;
K
Kevin Wolf 已提交
2491
    uint64_t host_offset = 0;
K
Kevin Wolf 已提交
2492
    unsigned int cur_bytes;
2493
    int ret;
2494
    QCowL2Meta *meta;
K
Kevin Wolf 已提交
2495

2496 2497 2498 2499
    if (qemu_in_coroutine()) {
        qemu_co_mutex_lock(&s->lock);
    }

2500 2501
    assert(offset <= new_length);
    bytes = new_length - offset;
K
Kevin Wolf 已提交
2502

K
Kevin Wolf 已提交
2503 2504 2505
    while (bytes) {
        cur_bytes = MIN(bytes, INT_MAX);
        ret = qcow2_alloc_cluster_offset(bs, offset, &cur_bytes,
K
Kevin Wolf 已提交
2506
                                         &host_offset, &meta);
2507
        if (ret < 0) {
2508
            goto done;
K
Kevin Wolf 已提交
2509 2510
        }

2511 2512 2513
        while (meta) {
            QCowL2Meta *next = meta->next;

H
Hu Tao 已提交
2514 2515 2516 2517
            ret = qcow2_alloc_cluster_link_l2(bs, meta);
            if (ret < 0) {
                qcow2_free_any_clusters(bs, meta->alloc_offset,
                                        meta->nb_clusters, QCOW2_DISCARD_NEVER);
2518
                goto done;
H
Hu Tao 已提交
2519 2520 2521 2522
            }

            /* There are no dependent requests, but we need to remove our
             * request from the list of in-flight requests */
2523
            QLIST_REMOVE(meta, next_in_flight);
2524 2525 2526

            g_free(meta);
            meta = next;
2527
        }
2528

K
Kevin Wolf 已提交
2529 2530
        /* TODO Preallocate data if requested */

K
Kevin Wolf 已提交
2531 2532
        bytes -= cur_bytes;
        offset += cur_bytes;
K
Kevin Wolf 已提交
2533 2534 2535 2536 2537 2538 2539
    }

    /*
     * It is expected that the image file is large enough to actually contain
     * all of the allocated clusters (otherwise we get failing reads after
     * EOF). Extend the image to the last allocated sector.
     */
K
Kevin Wolf 已提交
2540
    if (host_offset != 0) {
K
Kevin Wolf 已提交
2541
        uint8_t data = 0;
2542
        ret = bdrv_pwrite(bs->file, (host_offset + cur_bytes) - 1,
K
Kevin Wolf 已提交
2543
                          &data, 1);
2544
        if (ret < 0) {
2545
            goto done;
2546
        }
K
Kevin Wolf 已提交
2547 2548
    }

2549 2550 2551 2552 2553 2554 2555
    ret = 0;

done:
    if (qemu_in_coroutine()) {
        qemu_co_mutex_unlock(&s->lock);
    }
    return ret;
K
Kevin Wolf 已提交
2556 2557
}

2558 2559 2560 2561
/* qcow2_refcount_metadata_size:
 * @clusters: number of clusters to refcount (including data and L1/L2 tables)
 * @cluster_size: size of a cluster, in bytes
 * @refcount_order: refcount bits power-of-2 exponent
2562 2563
 * @generous_increase: allow for the refcount table to be 1.5x as large as it
 *                     needs to be
2564 2565 2566
 *
 * Returns: Number of bytes required for refcount blocks and table metadata.
 */
2567 2568 2569
int64_t qcow2_refcount_metadata_size(int64_t clusters, size_t cluster_size,
                                     int refcount_order, bool generous_increase,
                                     uint64_t *refblock_count)
2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591
{
    /*
     * Every host cluster is reference-counted, including metadata (even
     * refcount metadata is recursively included).
     *
     * An accurate formula for the size of refcount metadata size is difficult
     * to derive.  An easier method of calculation is finding the fixed point
     * where no further refcount blocks or table clusters are required to
     * reference count every cluster.
     */
    int64_t blocks_per_table_cluster = cluster_size / sizeof(uint64_t);
    int64_t refcounts_per_block = cluster_size * 8 / (1 << refcount_order);
    int64_t table = 0;  /* number of refcount table clusters */
    int64_t blocks = 0; /* number of refcount block clusters */
    int64_t last;
    int64_t n = 0;

    do {
        last = n;
        blocks = DIV_ROUND_UP(clusters + table + blocks, refcounts_per_block);
        table = DIV_ROUND_UP(blocks, blocks_per_table_cluster);
        n = clusters + blocks + table;
2592 2593 2594 2595 2596 2597

        if (n == last && generous_increase) {
            clusters += DIV_ROUND_UP(table, 2);
            n = 0; /* force another loop */
            generous_increase = false;
        }
2598 2599
    } while (n != last);

2600 2601 2602 2603
    if (refblock_count) {
        *refblock_count = blocks;
    }

2604 2605 2606
    return (blocks + table) * cluster_size;
}

2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620
/**
 * qcow2_calc_prealloc_size:
 * @total_size: virtual disk size in bytes
 * @cluster_size: cluster size in bytes
 * @refcount_order: refcount bits power-of-2 exponent
 *
 * Returns: Total number of bytes required for the fully allocated image
 * (including metadata).
 */
static int64_t qcow2_calc_prealloc_size(int64_t total_size,
                                        size_t cluster_size,
                                        int refcount_order)
{
    int64_t meta_size = 0;
2621
    uint64_t nl1e, nl2e;
2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636
    int64_t aligned_total_size = align_offset(total_size, cluster_size);

    /* header: 1 cluster */
    meta_size += cluster_size;

    /* total size of L2 tables */
    nl2e = aligned_total_size / cluster_size;
    nl2e = align_offset(nl2e, cluster_size / sizeof(uint64_t));
    meta_size += nl2e * sizeof(uint64_t);

    /* total size of L1 tables */
    nl1e = nl2e * sizeof(uint64_t) / cluster_size;
    nl1e = align_offset(nl1e, cluster_size / sizeof(uint64_t));
    meta_size += nl1e * sizeof(uint64_t);

2637 2638 2639
    /* total size of refcount table and blocks */
    meta_size += qcow2_refcount_metadata_size(
            (meta_size + aligned_total_size) / cluster_size,
2640
            cluster_size, refcount_order, false, NULL);
2641 2642 2643 2644

    return meta_size + aligned_total_size;
}

2645
static size_t qcow2_opt_get_cluster_size_del(QemuOpts *opts, Error **errp)
K
Kevin Wolf 已提交
2646
{
2647
    size_t cluster_size;
K
Kevin Wolf 已提交
2648
    int cluster_bits;
2649

2650 2651
    cluster_size = qemu_opt_get_size_del(opts, BLOCK_OPT_CLUSTER_SIZE,
                                         DEFAULT_CLUSTER_SIZE);
2652
    cluster_bits = ctz32(cluster_size);
K
Kevin Wolf 已提交
2653 2654 2655
    if (cluster_bits < MIN_CLUSTER_BITS || cluster_bits > MAX_CLUSTER_BITS ||
        (1 << cluster_bits) != cluster_size)
    {
M
Max Reitz 已提交
2656 2657
        error_setg(errp, "Cluster size must be a power of two between %d and "
                   "%dk", 1 << MIN_CLUSTER_BITS, 1 << (MAX_CLUSTER_BITS - 10));
2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699
        return 0;
    }
    return cluster_size;
}

static int qcow2_opt_get_version_del(QemuOpts *opts, Error **errp)
{
    char *buf;
    int ret;

    buf = qemu_opt_get_del(opts, BLOCK_OPT_COMPAT_LEVEL);
    if (!buf) {
        ret = 3; /* default */
    } else if (!strcmp(buf, "0.10")) {
        ret = 2;
    } else if (!strcmp(buf, "1.1")) {
        ret = 3;
    } else {
        error_setg(errp, "Invalid compatibility level: '%s'", buf);
        ret = -EINVAL;
    }
    g_free(buf);
    return ret;
}

static uint64_t qcow2_opt_get_refcount_bits_del(QemuOpts *opts, int version,
                                                Error **errp)
{
    uint64_t refcount_bits;

    refcount_bits = qemu_opt_get_number_del(opts, BLOCK_OPT_REFCOUNT_BITS, 16);
    if (refcount_bits > 64 || !is_power_of_2(refcount_bits)) {
        error_setg(errp, "Refcount width must be a power of two and may not "
                   "exceed 64 bits");
        return 0;
    }

    if (version < 3 && refcount_bits != 16) {
        error_setg(errp, "Different refcount widths than 16 bits require "
                   "compatibility level 1.1 or above (use compat=1.1 or "
                   "greater)");
        return 0;
K
Kevin Wolf 已提交
2700 2701
    }

2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712
    return refcount_bits;
}

static int qcow2_create2(const char *filename, int64_t total_size,
                         const char *backing_file, const char *backing_format,
                         int flags, size_t cluster_size, PreallocMode prealloc,
                         QemuOpts *opts, int version, int refcount_order,
                         const char *encryptfmt, Error **errp)
{
    QDict *options;

K
Kevin Wolf 已提交
2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724
    /*
     * Open the image file and write a minimal qcow2 header.
     *
     * We keep things simple and start with a zero-sized image. We also
     * do without refcount blocks or a L1 table for now. We'll fix the
     * inconsistency later.
     *
     * We do need a refcount table because growing the refcount table means
     * allocating two new refcount blocks - the seconds of which would be at
     * 2 GB for 64k clusters, and we don't want to have a 2 GB initial file
     * size for any qcow2 image.
     */
2725
    BlockBackend *blk;
2726
    QCowHeader *header;
2727
    uint64_t* refcount_table;
M
Max Reitz 已提交
2728
    Error *local_err = NULL;
K
Kevin Wolf 已提交
2729 2730
    int ret;

2731
    if (prealloc == PREALLOC_MODE_FULL || prealloc == PREALLOC_MODE_FALLOC) {
2732 2733 2734
        int64_t prealloc_size =
            qcow2_calc_prealloc_size(total_size, cluster_size, refcount_order);
        qemu_opt_set_number(opts, BLOCK_OPT_SIZE, prealloc_size, &error_abort);
2735 2736
        qemu_opt_set(opts, BLOCK_OPT_PREALLOC, PreallocMode_lookup[prealloc],
                     &error_abort);
2737 2738
    }

C
Chunyan Liu 已提交
2739
    ret = bdrv_create_file(filename, opts, &local_err);
K
Kevin Wolf 已提交
2740
    if (ret < 0) {
M
Max Reitz 已提交
2741
        error_propagate(errp, local_err);
K
Kevin Wolf 已提交
2742 2743 2744
        return ret;
    }

2745
    blk = blk_new_open(filename, NULL, NULL,
2746 2747
                       BDRV_O_RDWR | BDRV_O_RESIZE | BDRV_O_PROTOCOL,
                       &local_err);
2748
    if (blk == NULL) {
M
Max Reitz 已提交
2749
        error_propagate(errp, local_err);
2750
        return -EIO;
K
Kevin Wolf 已提交
2751 2752
    }

2753 2754
    blk_set_allow_write_beyond_eof(blk, true);

K
Kevin Wolf 已提交
2755
    /* Write the header */
2756 2757 2758 2759 2760
    QEMU_BUILD_BUG_ON((1 << MIN_CLUSTER_BITS) < sizeof(*header));
    header = g_malloc0(cluster_size);
    *header = (QCowHeader) {
        .magic                      = cpu_to_be32(QCOW_MAGIC),
        .version                    = cpu_to_be32(version),
2761
        .cluster_bits               = cpu_to_be32(ctz32(cluster_size)),
2762 2763 2764 2765 2766
        .size                       = cpu_to_be64(0),
        .l1_table_offset            = cpu_to_be64(0),
        .l1_size                    = cpu_to_be32(0),
        .refcount_table_offset      = cpu_to_be64(cluster_size),
        .refcount_table_clusters    = cpu_to_be32(1),
2767
        .refcount_order             = cpu_to_be32(refcount_order),
2768 2769
        .header_length              = cpu_to_be32(sizeof(*header)),
    };
K
Kevin Wolf 已提交
2770

2771 2772
    /* We'll update this to correct value later */
    header->crypt_method = cpu_to_be32(QCOW_CRYPT_NONE);
K
Kevin Wolf 已提交
2773

2774
    if (flags & BLOCK_FLAG_LAZY_REFCOUNTS) {
2775
        header->compatible_features |=
2776 2777 2778
            cpu_to_be64(QCOW2_COMPAT_LAZY_REFCOUNTS);
    }

2779
    ret = blk_pwrite(blk, 0, header, cluster_size, 0);
2780
    g_free(header);
K
Kevin Wolf 已提交
2781
    if (ret < 0) {
M
Max Reitz 已提交
2782
        error_setg_errno(errp, -ret, "Could not write qcow2 header");
K
Kevin Wolf 已提交
2783 2784 2785
        goto out;
    }

2786 2787 2788
    /* Write a refcount table with one refcount block */
    refcount_table = g_malloc0(2 * cluster_size);
    refcount_table[0] = cpu_to_be64(2 * cluster_size);
2789
    ret = blk_pwrite(blk, cluster_size, refcount_table, 2 * cluster_size, 0);
2790
    g_free(refcount_table);
K
Kevin Wolf 已提交
2791 2792

    if (ret < 0) {
M
Max Reitz 已提交
2793
        error_setg_errno(errp, -ret, "Could not write refcount table");
K
Kevin Wolf 已提交
2794 2795 2796
        goto out;
    }

2797 2798
    blk_unref(blk);
    blk = NULL;
K
Kevin Wolf 已提交
2799 2800 2801 2802 2803 2804

    /*
     * And now open the image and make it consistent first (i.e. increase the
     * refcount of the cluster that is occupied by the header and the refcount
     * table)
     */
2805
    options = qdict_new();
2806
    qdict_put_str(options, "driver", "qcow2");
2807
    blk = blk_new_open(filename, NULL, options,
2808 2809
                       BDRV_O_RDWR | BDRV_O_RESIZE | BDRV_O_NO_FLUSH,
                       &local_err);
2810
    if (blk == NULL) {
M
Max Reitz 已提交
2811
        error_propagate(errp, local_err);
2812
        ret = -EIO;
K
Kevin Wolf 已提交
2813 2814 2815
        goto out;
    }

2816
    ret = qcow2_alloc_clusters(blk_bs(blk), 3 * cluster_size);
K
Kevin Wolf 已提交
2817
    if (ret < 0) {
M
Max Reitz 已提交
2818 2819
        error_setg_errno(errp, -ret, "Could not allocate clusters for qcow2 "
                         "header and refcount table");
K
Kevin Wolf 已提交
2820 2821 2822 2823 2824 2825 2826
        goto out;

    } else if (ret != 0) {
        error_report("Huh, first cluster in empty image is already in use?");
        abort();
    }

2827
    /* Create a full header (including things like feature table) */
2828
    ret = qcow2_update_header(blk_bs(blk));
2829 2830 2831 2832 2833
    if (ret < 0) {
        error_setg_errno(errp, -ret, "Could not update qcow2 header");
        goto out;
    }

K
Kevin Wolf 已提交
2834
    /* Okay, now that we have a valid image, let's give it the right size */
2835
    ret = blk_truncate(blk, total_size, PREALLOC_MODE_OFF, errp);
K
Kevin Wolf 已提交
2836
    if (ret < 0) {
2837
        error_prepend(errp, "Could not resize image: ");
K
Kevin Wolf 已提交
2838 2839 2840 2841 2842
        goto out;
    }

    /* Want a backing file? There you go.*/
    if (backing_file) {
2843
        ret = bdrv_change_backing_file(blk_bs(blk), backing_file, backing_format);
K
Kevin Wolf 已提交
2844
        if (ret < 0) {
M
Max Reitz 已提交
2845 2846
            error_setg_errno(errp, -ret, "Could not assign backing file '%s' "
                             "with format '%s'", backing_file, backing_format);
K
Kevin Wolf 已提交
2847 2848 2849 2850
            goto out;
        }
    }

2851 2852 2853 2854 2855 2856 2857 2858
    /* Want encryption? There you go. */
    if (encryptfmt) {
        ret = qcow2_set_up_encryption(blk_bs(blk), encryptfmt, opts, errp);
        if (ret < 0) {
            goto out;
        }
    }

K
Kevin Wolf 已提交
2859
    /* And if we're supposed to preallocate metadata, do that now */
2860
    if (prealloc != PREALLOC_MODE_OFF) {
2861
        ret = preallocate(blk_bs(blk), 0, total_size);
K
Kevin Wolf 已提交
2862
        if (ret < 0) {
M
Max Reitz 已提交
2863
            error_setg_errno(errp, -ret, "Could not preallocate metadata");
K
Kevin Wolf 已提交
2864 2865 2866 2867
            goto out;
        }
    }

2868 2869
    blk_unref(blk);
    blk = NULL;
M
Max Reitz 已提交
2870

2871 2872 2873 2874 2875 2876
    /* Reopen the image without BDRV_O_NO_FLUSH to flush it before returning.
     * Using BDRV_O_NO_IO, since encryption is now setup we don't want to
     * have to setup decryption context. We're not doing any I/O on the top
     * level BlockDriverState, only lower layers, where BDRV_O_NO_IO does
     * not have effect.
     */
2877
    options = qdict_new();
2878
    qdict_put_str(options, "driver", "qcow2");
2879
    blk = blk_new_open(filename, NULL, options,
2880 2881
                       BDRV_O_RDWR | BDRV_O_NO_BACKING | BDRV_O_NO_IO,
                       &local_err);
2882
    if (blk == NULL) {
M
Max Reitz 已提交
2883
        error_propagate(errp, local_err);
2884
        ret = -EIO;
M
Max Reitz 已提交
2885 2886 2887
        goto out;
    }

K
Kevin Wolf 已提交
2888 2889
    ret = 0;
out:
2890 2891
    if (blk) {
        blk_unref(blk);
2892
    }
K
Kevin Wolf 已提交
2893 2894
    return ret;
}
K
Kevin Wolf 已提交
2895

2896
static int qcow2_create(const char *filename, QemuOpts *opts, Error **errp)
K
Kevin Wolf 已提交
2897
{
2898 2899 2900
    char *backing_file = NULL;
    char *backing_fmt = NULL;
    char *buf = NULL;
2901
    uint64_t size = 0;
K
Kevin Wolf 已提交
2902
    int flags = 0;
2903
    size_t cluster_size = DEFAULT_CLUSTER_SIZE;
2904
    PreallocMode prealloc;
2905 2906
    int version;
    uint64_t refcount_bits;
2907
    int refcount_order;
2908
    const char *encryptfmt = NULL;
M
Max Reitz 已提交
2909 2910
    Error *local_err = NULL;
    int ret;
K
Kevin Wolf 已提交
2911 2912

    /* Read out options */
2913 2914
    size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
                    BDRV_SECTOR_SIZE);
2915 2916
    backing_file = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FILE);
    backing_fmt = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FMT);
2917 2918 2919 2920 2921 2922 2923 2924 2925 2926
    encryptfmt = qemu_opt_get_del(opts, BLOCK_OPT_ENCRYPT_FORMAT);
    if (encryptfmt) {
        if (qemu_opt_get_del(opts, BLOCK_OPT_ENCRYPT)) {
            error_setg(errp, "Options " BLOCK_OPT_ENCRYPT " and "
                       BLOCK_OPT_ENCRYPT_FORMAT " are mutually exclusive");
            ret = -EINVAL;
            goto finish;
        }
    } else if (qemu_opt_get_bool_del(opts, BLOCK_OPT_ENCRYPT, false)) {
        encryptfmt = "aes";
2927
    }
2928 2929 2930 2931 2932 2933
    cluster_size = qcow2_opt_get_cluster_size_del(opts, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        ret = -EINVAL;
        goto finish;
    }
2934
    buf = qemu_opt_get_del(opts, BLOCK_OPT_PREALLOC);
2935
    prealloc = qapi_enum_parse(PreallocMode_lookup, buf,
2936
                               PREALLOC_MODE__MAX, PREALLOC_MODE_OFF,
2937 2938 2939
                               &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
2940 2941 2942
        ret = -EINVAL;
        goto finish;
    }
2943 2944 2945 2946

    version = qcow2_opt_get_version_del(opts, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
2947 2948 2949 2950 2951 2952
        ret = -EINVAL;
        goto finish;
    }

    if (qemu_opt_get_bool_del(opts, BLOCK_OPT_LAZY_REFCOUNTS, false)) {
        flags |= BLOCK_FLAG_LAZY_REFCOUNTS;
K
Kevin Wolf 已提交
2953 2954
    }

2955
    if (backing_file && prealloc != PREALLOC_MODE_OFF) {
M
Max Reitz 已提交
2956 2957
        error_setg(errp, "Backing file and preallocation cannot be used at "
                   "the same time");
2958 2959
        ret = -EINVAL;
        goto finish;
K
Kevin Wolf 已提交
2960 2961
    }

2962
    if (version < 3 && (flags & BLOCK_FLAG_LAZY_REFCOUNTS)) {
M
Max Reitz 已提交
2963 2964
        error_setg(errp, "Lazy refcounts only supported with compatibility "
                   "level 1.1 and above (use compat=1.1 or greater)");
2965 2966
        ret = -EINVAL;
        goto finish;
2967 2968
    }

2969 2970 2971
    refcount_bits = qcow2_opt_get_refcount_bits_del(opts, version, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
2972 2973 2974 2975
        ret = -EINVAL;
        goto finish;
    }

2976
    refcount_order = ctz32(refcount_bits);
2977

2978
    ret = qcow2_create2(filename, size, backing_file, backing_fmt, flags,
2979
                        cluster_size, prealloc, opts, version, refcount_order,
2980
                        encryptfmt, &local_err);
2981
    error_propagate(errp, local_err);
2982 2983 2984 2985 2986

finish:
    g_free(backing_file);
    g_free(backing_fmt);
    g_free(buf);
M
Max Reitz 已提交
2987
    return ret;
K
Kevin Wolf 已提交
2988 2989
}

2990

2991 2992
static bool is_zero_sectors(BlockDriverState *bs, int64_t start,
                            uint32_t count)
2993 2994 2995
{
    int nr;
    BlockDriverState *file;
2996
    int64_t res;
2997

2998 2999 3000 3001
    if (start + count > bs->total_sectors) {
        count = bs->total_sectors - start;
    }

3002 3003 3004 3005 3006 3007
    if (!count) {
        return true;
    }
    res = bdrv_get_block_status_above(bs, NULL, start, count,
                                      &nr, &file);
    return res >= 0 && (res & BDRV_BLOCK_ZERO) && nr == count;
3008 3009
}

3010
static coroutine_fn int qcow2_co_pwrite_zeroes(BlockDriverState *bs,
3011
    int64_t offset, int bytes, BdrvRequestFlags flags)
K
Kevin Wolf 已提交
3012 3013
{
    int ret;
3014
    BDRVQcow2State *s = bs->opaque;
K
Kevin Wolf 已提交
3015

3016
    uint32_t head = offset % s->cluster_size;
3017
    uint32_t tail = (offset + bytes) % s->cluster_size;
3018

3019 3020
    trace_qcow2_pwrite_zeroes_start_req(qemu_coroutine_self(), offset, bytes);
    if (offset + bytes == bs->total_sectors * BDRV_SECTOR_SIZE) {
3021 3022
        tail = 0;
    }
3023

3024
    if (head || tail) {
3025
        int64_t cl_start = (offset - head) >> BDRV_SECTOR_BITS;
3026
        uint64_t off;
K
Kevin Wolf 已提交
3027
        unsigned int nr;
3028

3029
        assert(head + bytes <= s->cluster_size);
3030

3031
        /* check whether remainder of cluster already reads as zero */
3032 3033
        if (!(is_zero_sectors(bs, cl_start,
                              DIV_ROUND_UP(head, BDRV_SECTOR_SIZE)) &&
3034
              is_zero_sectors(bs, (offset + bytes) >> BDRV_SECTOR_BITS,
3035 3036
                              DIV_ROUND_UP(-tail & (s->cluster_size - 1),
                                           BDRV_SECTOR_SIZE)))) {
3037 3038 3039 3040 3041
            return -ENOTSUP;
        }

        qemu_co_mutex_lock(&s->lock);
        /* We can have new write after previous check */
3042
        offset = cl_start << BDRV_SECTOR_BITS;
3043
        bytes = s->cluster_size;
K
Kevin Wolf 已提交
3044
        nr = s->cluster_size;
3045
        ret = qcow2_get_cluster_offset(bs, offset, &nr, &off);
3046 3047 3048
        if (ret != QCOW2_CLUSTER_UNALLOCATED &&
            ret != QCOW2_CLUSTER_ZERO_PLAIN &&
            ret != QCOW2_CLUSTER_ZERO_ALLOC) {
3049 3050 3051 3052 3053
            qemu_co_mutex_unlock(&s->lock);
            return -ENOTSUP;
        }
    } else {
        qemu_co_mutex_lock(&s->lock);
K
Kevin Wolf 已提交
3054 3055
    }

3056
    trace_qcow2_pwrite_zeroes(qemu_coroutine_self(), offset, bytes);
3057

K
Kevin Wolf 已提交
3058
    /* Whatever is left can use real zero clusters */
3059
    ret = qcow2_cluster_zeroize(bs, offset, bytes, flags);
K
Kevin Wolf 已提交
3060 3061 3062 3063 3064
    qemu_co_mutex_unlock(&s->lock);

    return ret;
}

3065
static coroutine_fn int qcow2_co_pdiscard(BlockDriverState *bs,
3066
                                          int64_t offset, int bytes)
K
Kevin Wolf 已提交
3067
{
3068
    int ret;
3069
    BDRVQcow2State *s = bs->opaque;
3070

3071 3072
    if (!QEMU_IS_ALIGNED(offset | bytes, s->cluster_size)) {
        assert(bytes < s->cluster_size);
3073 3074 3075
        /* Ignore partial clusters, except for the special case of the
         * complete partial cluster at the end of an unaligned file */
        if (!QEMU_IS_ALIGNED(offset, s->cluster_size) ||
3076
            offset + bytes != bs->total_sectors * BDRV_SECTOR_SIZE) {
3077 3078
            return -ENOTSUP;
        }
3079 3080
    }

3081
    qemu_co_mutex_lock(&s->lock);
3082
    ret = qcow2_cluster_discard(bs, offset, bytes, QCOW2_DISCARD_REQUEST,
3083
                                false);
3084 3085
    qemu_co_mutex_unlock(&s->lock);
    return ret;
K
Kevin Wolf 已提交
3086 3087
}

3088 3089
static int qcow2_truncate(BlockDriverState *bs, int64_t offset,
                          PreallocMode prealloc, Error **errp)
3090
{
3091
    BDRVQcow2State *s = bs->opaque;
3092
    uint64_t old_length;
3093 3094
    int64_t new_l1_size;
    int ret;
3095

3096 3097 3098
    if (prealloc != PREALLOC_MODE_OFF && prealloc != PREALLOC_MODE_METADATA &&
        prealloc != PREALLOC_MODE_FALLOC && prealloc != PREALLOC_MODE_FULL)
    {
3099 3100 3101 3102 3103
        error_setg(errp, "Unsupported preallocation mode '%s'",
                   PreallocMode_lookup[prealloc]);
        return -ENOTSUP;
    }

3104
    if (offset & 511) {
3105
        error_setg(errp, "The new size must be a multiple of 512");
3106 3107 3108 3109 3110
        return -EINVAL;
    }

    /* cannot proceed if image has snapshots */
    if (s->nb_snapshots) {
3111
        error_setg(errp, "Can't resize an image which has snapshots");
3112 3113 3114
        return -ENOTSUP;
    }

3115 3116 3117 3118 3119 3120 3121
    /* cannot proceed if image has bitmaps */
    if (s->nb_bitmaps) {
        /* TODO: resize bitmaps in the image */
        error_setg(errp, "Can't resize an image which has bitmaps");
        return -ENOTSUP;
    }

3122 3123
    old_length = bs->total_sectors * 512;

3124
    /* shrinking is currently not supported */
3125
    if (offset < old_length) {
3126
        error_setg(errp, "qcow2 doesn't support shrinking images yet");
3127 3128 3129 3130
        return -ENOTSUP;
    }

    new_l1_size = size_to_l1(s, offset);
3131
    ret = qcow2_grow_l1_table(bs, new_l1_size, true);
3132
    if (ret < 0) {
3133
        error_setg_errno(errp, -ret, "Failed to grow the L1 table");
3134 3135 3136
        return ret;
    }

3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148
    switch (prealloc) {
    case PREALLOC_MODE_OFF:
        break;

    case PREALLOC_MODE_METADATA:
        ret = preallocate(bs, old_length, offset);
        if (ret < 0) {
            error_setg_errno(errp, -ret, "Preallocation failed");
            return ret;
        }
        break;

3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244
    case PREALLOC_MODE_FALLOC:
    case PREALLOC_MODE_FULL:
    {
        int64_t allocation_start, host_offset, guest_offset;
        int64_t clusters_allocated;
        int64_t old_file_size, new_file_size;
        uint64_t nb_new_data_clusters, nb_new_l2_tables;

        old_file_size = bdrv_getlength(bs->file->bs);
        if (old_file_size < 0) {
            error_setg_errno(errp, -old_file_size,
                             "Failed to inquire current file length");
            return ret;
        }

        nb_new_data_clusters = DIV_ROUND_UP(offset - old_length,
                                            s->cluster_size);

        /* This is an overestimation; we will not actually allocate space for
         * these in the file but just make sure the new refcount structures are
         * able to cover them so we will not have to allocate new refblocks
         * while entering the data blocks in the potentially new L2 tables.
         * (We do not actually care where the L2 tables are placed. Maybe they
         *  are already allocated or they can be placed somewhere before
         *  @old_file_size. It does not matter because they will be fully
         *  allocated automatically, so they do not need to be covered by the
         *  preallocation. All that matters is that we will not have to allocate
         *  new refcount structures for them.) */
        nb_new_l2_tables = DIV_ROUND_UP(nb_new_data_clusters,
                                        s->cluster_size / sizeof(uint64_t));
        /* The cluster range may not be aligned to L2 boundaries, so add one L2
         * table for a potential head/tail */
        nb_new_l2_tables++;

        allocation_start = qcow2_refcount_area(bs, old_file_size,
                                               nb_new_data_clusters +
                                               nb_new_l2_tables,
                                               true, 0, 0);
        if (allocation_start < 0) {
            error_setg_errno(errp, -allocation_start,
                             "Failed to resize refcount structures");
            return -allocation_start;
        }

        clusters_allocated = qcow2_alloc_clusters_at(bs, allocation_start,
                                                     nb_new_data_clusters);
        if (clusters_allocated < 0) {
            error_setg_errno(errp, -clusters_allocated,
                             "Failed to allocate data clusters");
            return -clusters_allocated;
        }

        assert(clusters_allocated == nb_new_data_clusters);

        /* Allocate the data area */
        new_file_size = allocation_start +
                        nb_new_data_clusters * s->cluster_size;
        ret = bdrv_truncate(bs->file, new_file_size, prealloc, errp);
        if (ret < 0) {
            error_prepend(errp, "Failed to resize underlying file: ");
            qcow2_free_clusters(bs, allocation_start,
                                nb_new_data_clusters * s->cluster_size,
                                QCOW2_DISCARD_OTHER);
            return ret;
        }

        /* Create the necessary L2 entries */
        host_offset = allocation_start;
        guest_offset = old_length;
        while (nb_new_data_clusters) {
            int64_t guest_cluster = guest_offset >> s->cluster_bits;
            int64_t nb_clusters = MIN(nb_new_data_clusters,
                                      s->l2_size - guest_cluster % s->l2_size);
            QCowL2Meta allocation = {
                .offset       = guest_offset,
                .alloc_offset = host_offset,
                .nb_clusters  = nb_clusters,
            };
            qemu_co_queue_init(&allocation.dependent_requests);

            ret = qcow2_alloc_cluster_link_l2(bs, &allocation);
            if (ret < 0) {
                error_setg_errno(errp, -ret, "Failed to update L2 tables");
                qcow2_free_clusters(bs, host_offset,
                                    nb_new_data_clusters * s->cluster_size,
                                    QCOW2_DISCARD_OTHER);
                return ret;
            }

            guest_offset += nb_clusters * s->cluster_size;
            host_offset += nb_clusters * s->cluster_size;
            nb_new_data_clusters -= nb_clusters;
        }
        break;
    }

3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258
    default:
        g_assert_not_reached();
    }

    if (prealloc != PREALLOC_MODE_OFF) {
        /* Flush metadata before actually changing the image size */
        ret = bdrv_flush(bs);
        if (ret < 0) {
            error_setg_errno(errp, -ret,
                             "Failed to flush the preallocated area to disk");
            return ret;
        }
    }

3259 3260
    /* write updated header.size */
    offset = cpu_to_be64(offset);
3261
    ret = bdrv_pwrite_sync(bs->file, offsetof(QCowHeader, size),
3262
                           &offset, sizeof(uint64_t));
3263
    if (ret < 0) {
3264
        error_setg_errno(errp, -ret, "Failed to update the image size");
3265 3266 3267 3268 3269 3270 3271
        return ret;
    }

    s->l1_vm_state_index = new_l1_size;
    return 0;
}

B
Blue Swirl 已提交
3272 3273
/* XXX: put compressed sectors first, then all the cluster aligned
   tables to avoid losing bytes in alignment */
3274 3275 3276
static coroutine_fn int
qcow2_co_pwritev_compressed(BlockDriverState *bs, uint64_t offset,
                            uint64_t bytes, QEMUIOVector *qiov)
B
Blue Swirl 已提交
3277
{
3278
    BDRVQcow2State *s = bs->opaque;
3279 3280
    QEMUIOVector hd_qiov;
    struct iovec iov;
B
Blue Swirl 已提交
3281 3282
    z_stream strm;
    int ret, out_len;
3283
    uint8_t *buf, *out_buf;
B
Blue Swirl 已提交
3284 3285
    uint64_t cluster_offset;

3286
    if (bytes == 0) {
B
Blue Swirl 已提交
3287 3288
        /* align end of file to a sector boundary to ease reading with
           sector based I/Os */
K
Kevin Wolf 已提交
3289
        cluster_offset = bdrv_getlength(bs->file->bs);
3290
        return bdrv_truncate(bs->file, cluster_offset, PREALLOC_MODE_OFF, NULL);
B
Blue Swirl 已提交
3291 3292
    }

3293
    buf = qemu_blockalign(bs, s->cluster_size);
3294
    if (bytes != s->cluster_size) {
3295 3296
        if (bytes > s->cluster_size ||
            offset + bytes != bs->total_sectors << BDRV_SECTOR_BITS)
3297
        {
3298 3299
            qemu_vfree(buf);
            return -EINVAL;
3300
        }
3301 3302
        /* Zero-pad last write if image size is not cluster aligned */
        memset(buf + bytes, 0, s->cluster_size - bytes);
3303
    }
3304
    qemu_iovec_to_buf(qiov, 0, buf, bytes);
B
Blue Swirl 已提交
3305

3306
    out_buf = g_malloc(s->cluster_size);
B
Blue Swirl 已提交
3307 3308 3309 3310 3311 3312 3313

    /* best compression, small window, no zlib header */
    memset(&strm, 0, sizeof(strm));
    ret = deflateInit2(&strm, Z_DEFAULT_COMPRESSION,
                       Z_DEFLATED, -12,
                       9, Z_DEFAULT_STRATEGY);
    if (ret != 0) {
3314 3315
        ret = -EINVAL;
        goto fail;
B
Blue Swirl 已提交
3316 3317 3318 3319 3320 3321 3322 3323 3324 3325
    }

    strm.avail_in = s->cluster_size;
    strm.next_in = (uint8_t *)buf;
    strm.avail_out = s->cluster_size;
    strm.next_out = out_buf;

    ret = deflate(&strm, Z_FINISH);
    if (ret != Z_STREAM_END && ret != Z_OK) {
        deflateEnd(&strm);
3326 3327
        ret = -EINVAL;
        goto fail;
B
Blue Swirl 已提交
3328 3329 3330 3331 3332 3333 3334
    }
    out_len = strm.next_out - out_buf;

    deflateEnd(&strm);

    if (ret != Z_STREAM_END || out_len >= s->cluster_size) {
        /* could not compress: write normal cluster */
3335
        ret = qcow2_co_pwritev(bs, offset, bytes, qiov, 0);
3336 3337 3338
        if (ret < 0) {
            goto fail;
        }
3339 3340
        goto success;
    }
3341

3342 3343 3344 3345 3346 3347 3348 3349 3350
    qemu_co_mutex_lock(&s->lock);
    cluster_offset =
        qcow2_alloc_compressed_cluster_offset(bs, offset, out_len);
    if (!cluster_offset) {
        qemu_co_mutex_unlock(&s->lock);
        ret = -EIO;
        goto fail;
    }
    cluster_offset &= s->cluster_offset_mask;
3351

3352 3353 3354 3355
    ret = qcow2_pre_write_overlap_check(bs, 0, cluster_offset, out_len);
    qemu_co_mutex_unlock(&s->lock);
    if (ret < 0) {
        goto fail;
B
Blue Swirl 已提交
3356 3357
    }

3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369
    iov = (struct iovec) {
        .iov_base   = out_buf,
        .iov_len    = out_len,
    };
    qemu_iovec_init_external(&hd_qiov, &iov, 1);

    BLKDBG_EVENT(bs->file, BLKDBG_WRITE_COMPRESSED);
    ret = bdrv_co_pwritev(bs->file, cluster_offset, out_len, &hd_qiov, 0);
    if (ret < 0) {
        goto fail;
    }
success:
3370 3371
    ret = 0;
fail:
3372
    qemu_vfree(buf);
3373
    g_free(out_buf);
3374
    return ret;
B
Blue Swirl 已提交
3375 3376
}

M
Max Reitz 已提交
3377 3378
static int make_completely_empty(BlockDriverState *bs)
{
3379
    BDRVQcow2State *s = bs->opaque;
3380
    Error *local_err = NULL;
M
Max Reitz 已提交
3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414
    int ret, l1_clusters;
    int64_t offset;
    uint64_t *new_reftable = NULL;
    uint64_t rt_entry, l1_size2;
    struct {
        uint64_t l1_offset;
        uint64_t reftable_offset;
        uint32_t reftable_clusters;
    } QEMU_PACKED l1_ofs_rt_ofs_cls;

    ret = qcow2_cache_empty(bs, s->l2_table_cache);
    if (ret < 0) {
        goto fail;
    }

    ret = qcow2_cache_empty(bs, s->refcount_block_cache);
    if (ret < 0) {
        goto fail;
    }

    /* Refcounts will be broken utterly */
    ret = qcow2_mark_dirty(bs);
    if (ret < 0) {
        goto fail;
    }

    BLKDBG_EVENT(bs->file, BLKDBG_L1_UPDATE);

    l1_clusters = DIV_ROUND_UP(s->l1_size, s->cluster_size / sizeof(uint64_t));
    l1_size2 = (uint64_t)s->l1_size * sizeof(uint64_t);

    /* After this call, neither the in-memory nor the on-disk refcount
     * information accurately describe the actual references */

3415
    ret = bdrv_pwrite_zeroes(bs->file, s->l1_table_offset,
3416
                             l1_clusters * s->cluster_size, 0);
M
Max Reitz 已提交
3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428
    if (ret < 0) {
        goto fail_broken_refcounts;
    }
    memset(s->l1_table, 0, l1_size2);

    BLKDBG_EVENT(bs->file, BLKDBG_EMPTY_IMAGE_PREPARE);

    /* Overwrite enough clusters at the beginning of the sectors to place
     * the refcount table, a refcount block and the L1 table in; this may
     * overwrite parts of the existing refcount and L1 table, which is not
     * an issue because the dirty flag is set, complete data loss is in fact
     * desired and partial data loss is consequently fine as well */
3429
    ret = bdrv_pwrite_zeroes(bs->file, s->cluster_size,
3430
                             (2 + l1_clusters) * s->cluster_size, 0);
M
Max Reitz 已提交
3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444
    /* This call (even if it failed overall) may have overwritten on-disk
     * refcount structures; in that case, the in-memory refcount information
     * will probably differ from the on-disk information which makes the BDS
     * unusable */
    if (ret < 0) {
        goto fail_broken_refcounts;
    }

    BLKDBG_EVENT(bs->file, BLKDBG_L1_UPDATE);
    BLKDBG_EVENT(bs->file, BLKDBG_REFTABLE_UPDATE);

    /* "Create" an empty reftable (one cluster) directly after the image
     * header and an empty L1 table three clusters after the image header;
     * the cluster between those two will be used as the first refblock */
3445 3446 3447
    l1_ofs_rt_ofs_cls.l1_offset = cpu_to_be64(3 * s->cluster_size);
    l1_ofs_rt_ofs_cls.reftable_offset = cpu_to_be64(s->cluster_size);
    l1_ofs_rt_ofs_cls.reftable_clusters = cpu_to_be32(1);
3448
    ret = bdrv_pwrite_sync(bs->file, offsetof(QCowHeader, l1_table_offset),
M
Max Reitz 已提交
3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463
                           &l1_ofs_rt_ofs_cls, sizeof(l1_ofs_rt_ofs_cls));
    if (ret < 0) {
        goto fail_broken_refcounts;
    }

    s->l1_table_offset = 3 * s->cluster_size;

    new_reftable = g_try_new0(uint64_t, s->cluster_size / sizeof(uint64_t));
    if (!new_reftable) {
        ret = -ENOMEM;
        goto fail_broken_refcounts;
    }

    s->refcount_table_offset = s->cluster_size;
    s->refcount_table_size   = s->cluster_size / sizeof(uint64_t);
3464
    s->max_refcount_table_index = 0;
M
Max Reitz 已提交
3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479

    g_free(s->refcount_table);
    s->refcount_table = new_reftable;
    new_reftable = NULL;

    /* Now the in-memory refcount information again corresponds to the on-disk
     * information (reftable is empty and no refblocks (the refblock cache is
     * empty)); however, this means some clusters (e.g. the image header) are
     * referenced, but not refcounted, but the normal qcow2 code assumes that
     * the in-memory information is always correct */

    BLKDBG_EVENT(bs->file, BLKDBG_REFBLOCK_ALLOC);

    /* Enter the first refblock into the reftable */
    rt_entry = cpu_to_be64(2 * s->cluster_size);
3480
    ret = bdrv_pwrite_sync(bs->file, s->cluster_size,
M
Max Reitz 已提交
3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504
                           &rt_entry, sizeof(rt_entry));
    if (ret < 0) {
        goto fail_broken_refcounts;
    }
    s->refcount_table[0] = 2 * s->cluster_size;

    s->free_cluster_index = 0;
    assert(3 + l1_clusters <= s->refcount_block_size);
    offset = qcow2_alloc_clusters(bs, 3 * s->cluster_size + l1_size2);
    if (offset < 0) {
        ret = offset;
        goto fail_broken_refcounts;
    } else if (offset > 0) {
        error_report("First cluster in emptied image is in use");
        abort();
    }

    /* Now finally the in-memory information corresponds to the on-disk
     * structures and is correct */
    ret = qcow2_mark_clean(bs);
    if (ret < 0) {
        goto fail;
    }

3505
    ret = bdrv_truncate(bs->file, (3 + l1_clusters) * s->cluster_size,
3506
                        PREALLOC_MODE_OFF, &local_err);
M
Max Reitz 已提交
3507
    if (ret < 0) {
3508
        error_report_err(local_err);
M
Max Reitz 已提交
3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527
        goto fail;
    }

    return 0;

fail_broken_refcounts:
    /* The BDS is unusable at this point. If we wanted to make it usable, we
     * would have to call qcow2_refcount_close(), qcow2_refcount_init(),
     * qcow2_check_refcounts(), qcow2_refcount_close() and qcow2_refcount_init()
     * again. However, because the functions which could have caused this error
     * path to be taken are used by those functions as well, it's very likely
     * that that sequence will fail as well. Therefore, just eject the BDS. */
    bs->drv = NULL;

fail:
    g_free(new_reftable);
    return ret;
}

M
Max Reitz 已提交
3528 3529
static int qcow2_make_empty(BlockDriverState *bs)
{
3530
    BDRVQcow2State *s = bs->opaque;
3531 3532
    uint64_t offset, end_offset;
    int step = QEMU_ALIGN_DOWN(INT_MAX, s->cluster_size);
M
Max Reitz 已提交
3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545
    int l1_clusters, ret = 0;

    l1_clusters = DIV_ROUND_UP(s->l1_size, s->cluster_size / sizeof(uint64_t));

    if (s->qcow_version >= 3 && !s->snapshots &&
        3 + l1_clusters <= s->refcount_block_size) {
        /* The following function only works for qcow2 v3 images (it requires
         * the dirty flag) and only as long as there are no snapshots (because
         * it completely empties the image). Furthermore, the L1 table and three
         * additional clusters (image header, refcount table, one refcount
         * block) have to fit inside one refcount block. */
        return make_completely_empty(bs);
    }
M
Max Reitz 已提交
3546

M
Max Reitz 已提交
3547 3548
    /* This fallback code simply discards every active cluster; this is slow,
     * but works in all cases */
3549 3550
    end_offset = bs->total_sectors * BDRV_SECTOR_SIZE;
    for (offset = 0; offset < end_offset; offset += step) {
M
Max Reitz 已提交
3551 3552 3553 3554 3555
        /* As this function is generally used after committing an external
         * snapshot, QCOW2_DISCARD_SNAPSHOT seems appropriate. Also, the
         * default action for this kind of discard is to pass the discard,
         * which will ideally result in an actually smaller image file, as
         * is probably desired. */
3556 3557
        ret = qcow2_cluster_discard(bs, offset, MIN(step, end_offset - offset),
                                    QCOW2_DISCARD_SNAPSHOT, true);
M
Max Reitz 已提交
3558 3559 3560 3561 3562 3563 3564 3565
        if (ret < 0) {
            break;
        }
    }

    return ret;
}

3566
static coroutine_fn int qcow2_co_flush_to_os(BlockDriverState *bs)
B
Blue Swirl 已提交
3567
{
3568
    BDRVQcow2State *s = bs->opaque;
K
Kevin Wolf 已提交
3569 3570
    int ret;

P
Paolo Bonzini 已提交
3571
    qemu_co_mutex_lock(&s->lock);
3572
    ret = qcow2_cache_write(bs, s->l2_table_cache);
K
Kevin Wolf 已提交
3573
    if (ret < 0) {
D
Dong Xu Wang 已提交
3574
        qemu_co_mutex_unlock(&s->lock);
P
Paolo Bonzini 已提交
3575
        return ret;
K
Kevin Wolf 已提交
3576 3577
    }

3578
    if (qcow2_need_accurate_refcounts(s)) {
3579
        ret = qcow2_cache_write(bs, s->refcount_block_cache);
3580 3581 3582 3583
        if (ret < 0) {
            qemu_co_mutex_unlock(&s->lock);
            return ret;
        }
K
Kevin Wolf 已提交
3584
    }
P
Paolo Bonzini 已提交
3585
    qemu_co_mutex_unlock(&s->lock);
K
Kevin Wolf 已提交
3586

K
Kevin Wolf 已提交
3587 3588 3589
    return 0;
}

3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725
static BlockMeasureInfo *qcow2_measure(QemuOpts *opts, BlockDriverState *in_bs,
                                       Error **errp)
{
    Error *local_err = NULL;
    BlockMeasureInfo *info;
    uint64_t required = 0; /* bytes that contribute to required size */
    uint64_t virtual_size; /* disk size as seen by guest */
    uint64_t refcount_bits;
    uint64_t l2_tables;
    size_t cluster_size;
    int version;
    char *optstr;
    PreallocMode prealloc;
    bool has_backing_file;

    /* Parse image creation options */
    cluster_size = qcow2_opt_get_cluster_size_del(opts, &local_err);
    if (local_err) {
        goto err;
    }

    version = qcow2_opt_get_version_del(opts, &local_err);
    if (local_err) {
        goto err;
    }

    refcount_bits = qcow2_opt_get_refcount_bits_del(opts, version, &local_err);
    if (local_err) {
        goto err;
    }

    optstr = qemu_opt_get_del(opts, BLOCK_OPT_PREALLOC);
    prealloc = qapi_enum_parse(PreallocMode_lookup, optstr,
                               PREALLOC_MODE__MAX, PREALLOC_MODE_OFF,
                               &local_err);
    g_free(optstr);
    if (local_err) {
        goto err;
    }

    optstr = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FILE);
    has_backing_file = !!optstr;
    g_free(optstr);

    virtual_size = align_offset(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
                                cluster_size);

    /* Check that virtual disk size is valid */
    l2_tables = DIV_ROUND_UP(virtual_size / cluster_size,
                             cluster_size / sizeof(uint64_t));
    if (l2_tables * sizeof(uint64_t) > QCOW_MAX_L1_SIZE) {
        error_setg(&local_err, "The image size is too large "
                               "(try using a larger cluster size)");
        goto err;
    }

    /* Account for input image */
    if (in_bs) {
        int64_t ssize = bdrv_getlength(in_bs);
        if (ssize < 0) {
            error_setg_errno(&local_err, -ssize,
                             "Unable to get image virtual_size");
            goto err;
        }

        virtual_size = align_offset(ssize, cluster_size);

        if (has_backing_file) {
            /* We don't how much of the backing chain is shared by the input
             * image and the new image file.  In the worst case the new image's
             * backing file has nothing in common with the input image.  Be
             * conservative and assume all clusters need to be written.
             */
            required = virtual_size;
        } else {
            int cluster_sectors = cluster_size / BDRV_SECTOR_SIZE;
            int64_t sector_num;
            int pnum = 0;

            for (sector_num = 0;
                 sector_num < ssize / BDRV_SECTOR_SIZE;
                 sector_num += pnum) {
                int nb_sectors = MAX(ssize / BDRV_SECTOR_SIZE - sector_num,
                                     INT_MAX);
                BlockDriverState *file;
                int64_t ret;

                ret = bdrv_get_block_status_above(in_bs, NULL,
                                                  sector_num, nb_sectors,
                                                  &pnum, &file);
                if (ret < 0) {
                    error_setg_errno(&local_err, -ret,
                                     "Unable to get block status");
                    goto err;
                }

                if (ret & BDRV_BLOCK_ZERO) {
                    /* Skip zero regions (safe with no backing file) */
                } else if ((ret & (BDRV_BLOCK_DATA | BDRV_BLOCK_ALLOCATED)) ==
                           (BDRV_BLOCK_DATA | BDRV_BLOCK_ALLOCATED)) {
                    /* Extend pnum to end of cluster for next iteration */
                    pnum = ROUND_UP(sector_num + pnum, cluster_sectors) -
                           sector_num;

                    /* Count clusters we've seen */
                    required += (sector_num % cluster_sectors + pnum) *
                                BDRV_SECTOR_SIZE;
                }
            }
        }
    }

    /* Take into account preallocation.  Nothing special is needed for
     * PREALLOC_MODE_METADATA since metadata is always counted.
     */
    if (prealloc == PREALLOC_MODE_FULL || prealloc == PREALLOC_MODE_FALLOC) {
        required = virtual_size;
    }

    info = g_new(BlockMeasureInfo, 1);
    info->fully_allocated =
        qcow2_calc_prealloc_size(virtual_size, cluster_size,
                                 ctz32(refcount_bits));

    /* Remove data clusters that are not required.  This overestimates the
     * required size because metadata needed for the fully allocated file is
     * still counted.
     */
    info->required = info->fully_allocated - virtual_size + required;
    return info;

err:
    error_propagate(errp, local_err);
    return NULL;
}

3726
static int qcow2_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
B
Blue Swirl 已提交
3727
{
3728
    BDRVQcow2State *s = bs->opaque;
3729 3730
    bdi->unallocated_blocks_are_zero = true;
    bdi->can_write_zeroes_with_unmap = (s->qcow_version >= 3);
B
Blue Swirl 已提交
3731
    bdi->cluster_size = s->cluster_size;
3732
    bdi->vm_state_offset = qcow2_vm_state_offset(s);
B
Blue Swirl 已提交
3733 3734 3735
    return 0;
}

3736 3737
static ImageInfoSpecific *qcow2_get_specific_info(BlockDriverState *bs)
{
3738
    BDRVQcow2State *s = bs->opaque;
3739 3740
    ImageInfoSpecific *spec_info;
    QCryptoBlockInfo *encrypt_info = NULL;
3741

3742 3743 3744 3745 3746
    if (s->crypto != NULL) {
        encrypt_info = qcrypto_block_get_info(s->crypto, &error_abort);
    }

    spec_info = g_new(ImageInfoSpecific, 1);
3747
    *spec_info = (ImageInfoSpecific){
3748
        .type  = IMAGE_INFO_SPECIFIC_KIND_QCOW2,
3749
        .u.qcow2.data = g_new(ImageInfoSpecificQCow2, 1),
3750 3751
    };
    if (s->qcow_version == 2) {
3752
        *spec_info->u.qcow2.data = (ImageInfoSpecificQCow2){
3753 3754
            .compat             = g_strdup("0.10"),
            .refcount_bits      = s->refcount_bits,
3755 3756
        };
    } else if (s->qcow_version == 3) {
3757
        *spec_info->u.qcow2.data = (ImageInfoSpecificQCow2){
3758 3759 3760 3761
            .compat             = g_strdup("1.1"),
            .lazy_refcounts     = s->compatible_features &
                                  QCOW2_COMPAT_LAZY_REFCOUNTS,
            .has_lazy_refcounts = true,
3762 3763 3764
            .corrupt            = s->incompatible_features &
                                  QCOW2_INCOMPAT_CORRUPT,
            .has_corrupt        = true,
3765
            .refcount_bits      = s->refcount_bits,
3766
        };
3767 3768 3769 3770
    } else {
        /* if this assertion fails, this probably means a new version was
         * added without having it covered here */
        assert(false);
3771 3772
    }

3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796
    if (encrypt_info) {
        ImageInfoSpecificQCow2Encryption *qencrypt =
            g_new(ImageInfoSpecificQCow2Encryption, 1);
        switch (encrypt_info->format) {
        case Q_CRYPTO_BLOCK_FORMAT_QCOW:
            qencrypt->format = BLOCKDEV_QCOW2_ENCRYPTION_FORMAT_AES;
            qencrypt->u.aes = encrypt_info->u.qcow;
            break;
        case Q_CRYPTO_BLOCK_FORMAT_LUKS:
            qencrypt->format = BLOCKDEV_QCOW2_ENCRYPTION_FORMAT_LUKS;
            qencrypt->u.luks = encrypt_info->u.luks;
            break;
        default:
            abort();
        }
        /* Since we did shallow copy above, erase any pointers
         * in the original info */
        memset(&encrypt_info->u, 0, sizeof(encrypt_info->u));
        qapi_free_QCryptoBlockInfo(encrypt_info);

        spec_info->u.qcow2.data->has_encrypt = true;
        spec_info->u.qcow2.data->encrypt = qencrypt;
    }

3797 3798 3799
    return spec_info;
}

B
Blue Swirl 已提交
3800 3801 3802
#if 0
static void dump_refcounts(BlockDriverState *bs)
{
3803
    BDRVQcow2State *s = bs->opaque;
B
Blue Swirl 已提交
3804 3805 3806
    int64_t nb_clusters, k, k1, size;
    int refcount;

K
Kevin Wolf 已提交
3807
    size = bdrv_getlength(bs->file->bs);
B
Blue Swirl 已提交
3808 3809 3810 3811 3812 3813 3814
    nb_clusters = size_to_clusters(s, size);
    for(k = 0; k < nb_clusters;) {
        k1 = k;
        refcount = get_refcount(bs, k);
        k++;
        while (k < nb_clusters && get_refcount(bs, k) == refcount)
            k++;
B
Blue Swirl 已提交
3815 3816
        printf("%" PRId64 ": refcount=%d nb=%" PRId64 "\n", k, refcount,
               k - k1);
B
Blue Swirl 已提交
3817 3818 3819 3820
    }
}
#endif

3821 3822
static int qcow2_save_vmstate(BlockDriverState *bs, QEMUIOVector *qiov,
                              int64_t pos)
B
Blue Swirl 已提交
3823
{
3824
    BDRVQcow2State *s = bs->opaque;
B
Blue Swirl 已提交
3825

3826
    BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_SAVE);
3827 3828
    return bs->drv->bdrv_co_pwritev(bs, qcow2_vm_state_offset(s) + pos,
                                    qiov->size, qiov, 0);
B
Blue Swirl 已提交
3829 3830
}

3831 3832
static int qcow2_load_vmstate(BlockDriverState *bs, QEMUIOVector *qiov,
                              int64_t pos)
B
Blue Swirl 已提交
3833
{
3834
    BDRVQcow2State *s = bs->opaque;
B
Blue Swirl 已提交
3835

3836
    BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_LOAD);
3837 3838
    return bs->drv->bdrv_co_preadv(bs, qcow2_vm_state_offset(s) + pos,
                                   qiov->size, qiov, 0);
B
Blue Swirl 已提交
3839 3840
}

M
Max Reitz 已提交
3841 3842 3843 3844
/*
 * Downgrades an image's version. To achieve this, any incompatible features
 * have to be removed.
 */
3845
static int qcow2_downgrade(BlockDriverState *bs, int target_version,
3846
                           BlockDriverAmendStatusCB *status_cb, void *cb_opaque)
M
Max Reitz 已提交
3847
{
3848
    BDRVQcow2State *s = bs->opaque;
M
Max Reitz 已提交
3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860
    int current_version = s->qcow_version;
    int ret;

    if (target_version == current_version) {
        return 0;
    } else if (target_version > current_version) {
        return -EINVAL;
    } else if (target_version != 2) {
        return -EINVAL;
    }

    if (s->refcount_order != 4) {
3861
        error_report("compat=0.10 requires refcount_bits=16");
M
Max Reitz 已提交
3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888
        return -ENOTSUP;
    }

    /* clear incompatible features */
    if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) {
        ret = qcow2_mark_clean(bs);
        if (ret < 0) {
            return ret;
        }
    }

    /* with QCOW2_INCOMPAT_CORRUPT, it is pretty much impossible to get here in
     * the first place; if that happens nonetheless, returning -ENOTSUP is the
     * best thing to do anyway */

    if (s->incompatible_features) {
        return -ENOTSUP;
    }

    /* since we can ignore compatible features, we can set them to 0 as well */
    s->compatible_features = 0;
    /* if lazy refcounts have been used, they have already been fixed through
     * clearing the dirty flag */

    /* clearing autoclear features is trivial */
    s->autoclear_features = 0;

3889
    ret = qcow2_expand_zero_clusters(bs, status_cb, cb_opaque);
M
Max Reitz 已提交
3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902
    if (ret < 0) {
        return ret;
    }

    s->qcow_version = target_version;
    ret = qcow2_update_header(bs);
    if (ret < 0) {
        s->qcow_version = current_version;
        return ret;
    }
    return 0;
}

3903 3904 3905 3906 3907 3908
typedef enum Qcow2AmendOperation {
    /* This is the value Qcow2AmendHelperCBInfo::last_operation will be
     * statically initialized to so that the helper CB can discern the first
     * invocation from an operation change */
    QCOW2_NO_OPERATION = 0,

3909
    QCOW2_CHANGING_REFCOUNT_ORDER,
3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972
    QCOW2_DOWNGRADING,
} Qcow2AmendOperation;

typedef struct Qcow2AmendHelperCBInfo {
    /* The code coordinating the amend operations should only modify
     * these four fields; the rest will be managed by the CB */
    BlockDriverAmendStatusCB *original_status_cb;
    void *original_cb_opaque;

    Qcow2AmendOperation current_operation;

    /* Total number of operations to perform (only set once) */
    int total_operations;

    /* The following fields are managed by the CB */

    /* Number of operations completed */
    int operations_completed;

    /* Cumulative offset of all completed operations */
    int64_t offset_completed;

    Qcow2AmendOperation last_operation;
    int64_t last_work_size;
} Qcow2AmendHelperCBInfo;

static void qcow2_amend_helper_cb(BlockDriverState *bs,
                                  int64_t operation_offset,
                                  int64_t operation_work_size, void *opaque)
{
    Qcow2AmendHelperCBInfo *info = opaque;
    int64_t current_work_size;
    int64_t projected_work_size;

    if (info->current_operation != info->last_operation) {
        if (info->last_operation != QCOW2_NO_OPERATION) {
            info->offset_completed += info->last_work_size;
            info->operations_completed++;
        }

        info->last_operation = info->current_operation;
    }

    assert(info->total_operations > 0);
    assert(info->operations_completed < info->total_operations);

    info->last_work_size = operation_work_size;

    current_work_size = info->offset_completed + operation_work_size;

    /* current_work_size is the total work size for (operations_completed + 1)
     * operations (which includes this one), so multiply it by the number of
     * operations not covered and divide it by the number of operations
     * covered to get a projection for the operations not covered */
    projected_work_size = current_work_size * (info->total_operations -
                                               info->operations_completed - 1)
                                            / (info->operations_completed + 1);

    info->original_status_cb(bs, info->offset_completed + operation_offset,
                             current_work_size + projected_work_size,
                             info->original_cb_opaque);
}

3973
static int qcow2_amend_options(BlockDriverState *bs, QemuOpts *opts,
3974 3975
                               BlockDriverAmendStatusCB *status_cb,
                               void *cb_opaque)
M
Max Reitz 已提交
3976
{
3977
    BDRVQcow2State *s = bs->opaque;
M
Max Reitz 已提交
3978 3979 3980 3981
    int old_version = s->qcow_version, new_version = old_version;
    uint64_t new_size = 0;
    const char *backing_file = NULL, *backing_format = NULL;
    bool lazy_refcounts = s->use_lazy_refcounts;
3982 3983 3984
    const char *compat = NULL;
    uint64_t cluster_size = s->cluster_size;
    bool encrypt;
3985
    int encformat;
3986
    int refcount_bits = s->refcount_bits;
3987
    Error *local_err = NULL;
M
Max Reitz 已提交
3988
    int ret;
3989
    QemuOptDesc *desc = opts->list->desc;
3990
    Qcow2AmendHelperCBInfo helper_cb_info;
M
Max Reitz 已提交
3991

3992 3993
    while (desc && desc->name) {
        if (!qemu_opt_find(opts, desc->name)) {
M
Max Reitz 已提交
3994
            /* only change explicitly defined options */
3995
            desc++;
M
Max Reitz 已提交
3996 3997 3998
            continue;
        }

3999 4000
        if (!strcmp(desc->name, BLOCK_OPT_COMPAT_LEVEL)) {
            compat = qemu_opt_get(opts, BLOCK_OPT_COMPAT_LEVEL);
4001
            if (!compat) {
M
Max Reitz 已提交
4002
                /* preserve default */
4003
            } else if (!strcmp(compat, "0.10")) {
M
Max Reitz 已提交
4004
                new_version = 2;
4005
            } else if (!strcmp(compat, "1.1")) {
M
Max Reitz 已提交
4006 4007
                new_version = 3;
            } else {
4008
                error_report("Unknown compatibility level %s", compat);
M
Max Reitz 已提交
4009 4010
                return -EINVAL;
            }
4011
        } else if (!strcmp(desc->name, BLOCK_OPT_PREALLOC)) {
4012
            error_report("Cannot change preallocation mode");
M
Max Reitz 已提交
4013
            return -ENOTSUP;
4014 4015 4016 4017 4018 4019 4020 4021
        } else if (!strcmp(desc->name, BLOCK_OPT_SIZE)) {
            new_size = qemu_opt_get_size(opts, BLOCK_OPT_SIZE, 0);
        } else if (!strcmp(desc->name, BLOCK_OPT_BACKING_FILE)) {
            backing_file = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
        } else if (!strcmp(desc->name, BLOCK_OPT_BACKING_FMT)) {
            backing_format = qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT);
        } else if (!strcmp(desc->name, BLOCK_OPT_ENCRYPT)) {
            encrypt = qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT,
4022
                                        !!s->crypto);
4023

4024
            if (encrypt != !!s->crypto) {
4025
                error_report("Changing the encryption flag is not supported");
M
Max Reitz 已提交
4026 4027
                return -ENOTSUP;
            }
4028 4029 4030 4031 4032 4033 4034 4035
        } else if (!strcmp(desc->name, BLOCK_OPT_ENCRYPT_FORMAT)) {
            encformat = qcow2_crypt_method_from_format(
                qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT));

            if (encformat != s->crypt_method_header) {
                error_report("Changing the encryption format is not supported");
                return -ENOTSUP;
            }
4036 4037
        } else if (!strcmp(desc->name, BLOCK_OPT_CLUSTER_SIZE)) {
            cluster_size = qemu_opt_get_size(opts, BLOCK_OPT_CLUSTER_SIZE,
4038 4039
                                             cluster_size);
            if (cluster_size != s->cluster_size) {
4040
                error_report("Changing the cluster size is not supported");
M
Max Reitz 已提交
4041 4042
                return -ENOTSUP;
            }
4043 4044
        } else if (!strcmp(desc->name, BLOCK_OPT_LAZY_REFCOUNTS)) {
            lazy_refcounts = qemu_opt_get_bool(opts, BLOCK_OPT_LAZY_REFCOUNTS,
4045
                                               lazy_refcounts);
4046
        } else if (!strcmp(desc->name, BLOCK_OPT_REFCOUNT_BITS)) {
4047 4048 4049 4050 4051 4052 4053 4054 4055 4056
            refcount_bits = qemu_opt_get_number(opts, BLOCK_OPT_REFCOUNT_BITS,
                                                refcount_bits);

            if (refcount_bits <= 0 || refcount_bits > 64 ||
                !is_power_of_2(refcount_bits))
            {
                error_report("Refcount width must be a power of two and may "
                             "not exceed 64 bits");
                return -EINVAL;
            }
M
Max Reitz 已提交
4057
        } else {
4058
            /* if this point is reached, this probably means a new option was
M
Max Reitz 已提交
4059
             * added without having it covered here */
4060
            abort();
M
Max Reitz 已提交
4061
        }
4062 4063

        desc++;
M
Max Reitz 已提交
4064 4065
    }

4066 4067 4068 4069
    helper_cb_info = (Qcow2AmendHelperCBInfo){
        .original_status_cb = status_cb,
        .original_cb_opaque = cb_opaque,
        .total_operations = (new_version < old_version)
4070
                          + (s->refcount_bits != refcount_bits)
4071 4072
    };

4073 4074 4075 4076 4077 4078 4079
    /* Upgrade first (some features may require compat=1.1) */
    if (new_version > old_version) {
        s->qcow_version = new_version;
        ret = qcow2_update_header(bs);
        if (ret < 0) {
            s->qcow_version = old_version;
            return ret;
M
Max Reitz 已提交
4080 4081 4082
        }
    }

4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095
    if (s->refcount_bits != refcount_bits) {
        int refcount_order = ctz32(refcount_bits);

        if (new_version < 3 && refcount_bits != 16) {
            error_report("Different refcount widths than 16 bits require "
                         "compatibility level 1.1 or above (use compat=1.1 or "
                         "greater)");
            return -EINVAL;
        }

        helper_cb_info.current_operation = QCOW2_CHANGING_REFCOUNT_ORDER;
        ret = qcow2_change_refcount_order(bs, refcount_order,
                                          &qcow2_amend_helper_cb,
4096
                                          &helper_cb_info, &local_err);
4097
        if (ret < 0) {
4098
            error_report_err(local_err);
4099 4100 4101 4102
            return ret;
        }
    }

M
Max Reitz 已提交
4103
    if (backing_file || backing_format) {
4104 4105 4106
        ret = qcow2_change_backing_file(bs,
                    backing_file ?: s->image_backing_file,
                    backing_format ?: s->image_backing_format);
M
Max Reitz 已提交
4107 4108 4109 4110 4111 4112 4113
        if (ret < 0) {
            return ret;
        }
    }

    if (s->use_lazy_refcounts != lazy_refcounts) {
        if (lazy_refcounts) {
4114
            if (new_version < 3) {
4115 4116
                error_report("Lazy refcounts only supported with compatibility "
                             "level 1.1 and above (use compat=1.1 or greater)");
M
Max Reitz 已提交
4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143
                return -EINVAL;
            }
            s->compatible_features |= QCOW2_COMPAT_LAZY_REFCOUNTS;
            ret = qcow2_update_header(bs);
            if (ret < 0) {
                s->compatible_features &= ~QCOW2_COMPAT_LAZY_REFCOUNTS;
                return ret;
            }
            s->use_lazy_refcounts = true;
        } else {
            /* make image clean first */
            ret = qcow2_mark_clean(bs);
            if (ret < 0) {
                return ret;
            }
            /* now disallow lazy refcounts */
            s->compatible_features &= ~QCOW2_COMPAT_LAZY_REFCOUNTS;
            ret = qcow2_update_header(bs);
            if (ret < 0) {
                s->compatible_features |= QCOW2_COMPAT_LAZY_REFCOUNTS;
                return ret;
            }
            s->use_lazy_refcounts = false;
        }
    }

    if (new_size) {
K
Kevin Wolf 已提交
4144
        BlockBackend *blk = blk_new(BLK_PERM_RESIZE, BLK_PERM_ALL);
4145 4146 4147 4148 4149 4150 4151
        ret = blk_insert_bs(blk, bs, &local_err);
        if (ret < 0) {
            error_report_err(local_err);
            blk_unref(blk);
            return ret;
        }

4152
        ret = blk_truncate(blk, new_size, PREALLOC_MODE_OFF, &local_err);
4153
        blk_unref(blk);
M
Max Reitz 已提交
4154
        if (ret < 0) {
4155
            error_report_err(local_err);
M
Max Reitz 已提交
4156 4157 4158 4159
            return ret;
        }
    }

4160 4161
    /* Downgrade last (so unsupported features can be removed before) */
    if (new_version < old_version) {
4162 4163 4164
        helper_cb_info.current_operation = QCOW2_DOWNGRADING;
        ret = qcow2_downgrade(bs, new_version, &qcow2_amend_helper_cb,
                              &helper_cb_info);
4165 4166 4167 4168 4169
        if (ret < 0) {
            return ret;
        }
    }

M
Max Reitz 已提交
4170 4171 4172
    return 0;
}

M
Max Reitz 已提交
4173 4174 4175 4176 4177 4178 4179 4180 4181
/*
 * If offset or size are negative, respectively, they will not be included in
 * the BLOCK_IMAGE_CORRUPTED event emitted.
 * fatal will be ignored for read-only BDS; corruptions found there will always
 * be considered non-fatal.
 */
void qcow2_signal_corruption(BlockDriverState *bs, bool fatal, int64_t offset,
                             int64_t size, const char *message_format, ...)
{
4182
    BDRVQcow2State *s = bs->opaque;
4183
    const char *node_name;
M
Max Reitz 已提交
4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206
    char *message;
    va_list ap;

    fatal = fatal && !bs->read_only;

    if (s->signaled_corruption &&
        (!fatal || (s->incompatible_features & QCOW2_INCOMPAT_CORRUPT)))
    {
        return;
    }

    va_start(ap, message_format);
    message = g_strdup_vprintf(message_format, ap);
    va_end(ap);

    if (fatal) {
        fprintf(stderr, "qcow2: Marking image as corrupt: %s; further "
                "corruption events will be suppressed\n", message);
    } else {
        fprintf(stderr, "qcow2: Image is corrupt: %s; further non-fatal "
                "corruption events will be suppressed\n", message);
    }

4207 4208 4209 4210 4211
    node_name = bdrv_get_node_name(bs);
    qapi_event_send_block_image_corrupted(bdrv_get_device_name(bs),
                                          *node_name != '\0', node_name,
                                          message, offset >= 0, offset,
                                          size >= 0, size,
M
Max Reitz 已提交
4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222
                                          fatal, &error_abort);
    g_free(message);

    if (fatal) {
        qcow2_mark_corrupt(bs);
        bs->drv = NULL; /* make BDS unusable */
    }

    s->signaled_corruption = true;
}

4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249
static QemuOptsList qcow2_create_opts = {
    .name = "qcow2-create-opts",
    .head = QTAILQ_HEAD_INITIALIZER(qcow2_create_opts.head),
    .desc = {
        {
            .name = BLOCK_OPT_SIZE,
            .type = QEMU_OPT_SIZE,
            .help = "Virtual disk size"
        },
        {
            .name = BLOCK_OPT_COMPAT_LEVEL,
            .type = QEMU_OPT_STRING,
            .help = "Compatibility level (0.10 or 1.1)"
        },
        {
            .name = BLOCK_OPT_BACKING_FILE,
            .type = QEMU_OPT_STRING,
            .help = "File name of a base image"
        },
        {
            .name = BLOCK_OPT_BACKING_FMT,
            .type = QEMU_OPT_STRING,
            .help = "Image format of the base image"
        },
        {
            .name = BLOCK_OPT_ENCRYPT,
            .type = QEMU_OPT_BOOL,
4250 4251 4252 4253 4254 4255
            .help = "Encrypt the image with format 'aes'. (Deprecated "
                    "in favor of " BLOCK_OPT_ENCRYPT_FORMAT "=aes)",
        },
        {
            .name = BLOCK_OPT_ENCRYPT_FORMAT,
            .type = QEMU_OPT_STRING,
4256
            .help = "Encrypt the image, format choices: 'aes', 'luks'",
4257
        },
4258 4259 4260 4261 4262 4263 4264 4265
        BLOCK_CRYPTO_OPT_DEF_KEY_SECRET("encrypt.",
            "ID of secret providing qcow AES key or LUKS passphrase"),
        BLOCK_CRYPTO_OPT_DEF_LUKS_CIPHER_ALG("encrypt."),
        BLOCK_CRYPTO_OPT_DEF_LUKS_CIPHER_MODE("encrypt."),
        BLOCK_CRYPTO_OPT_DEF_LUKS_IVGEN_ALG("encrypt."),
        BLOCK_CRYPTO_OPT_DEF_LUKS_IVGEN_HASH_ALG("encrypt."),
        BLOCK_CRYPTO_OPT_DEF_LUKS_HASH_ALG("encrypt."),
        BLOCK_CRYPTO_OPT_DEF_LUKS_ITER_TIME("encrypt."),
4266 4267 4268 4269 4270 4271 4272 4273 4274
        {
            .name = BLOCK_OPT_CLUSTER_SIZE,
            .type = QEMU_OPT_SIZE,
            .help = "qcow2 cluster size",
            .def_value_str = stringify(DEFAULT_CLUSTER_SIZE)
        },
        {
            .name = BLOCK_OPT_PREALLOC,
            .type = QEMU_OPT_STRING,
4275 4276
            .help = "Preallocation mode (allowed values: off, metadata, "
                    "falloc, full)"
4277 4278 4279 4280 4281 4282 4283
        },
        {
            .name = BLOCK_OPT_LAZY_REFCOUNTS,
            .type = QEMU_OPT_BOOL,
            .help = "Postpone refcount updates",
            .def_value_str = "off"
        },
4284 4285 4286 4287 4288 4289
        {
            .name = BLOCK_OPT_REFCOUNT_BITS,
            .type = QEMU_OPT_NUMBER,
            .help = "Width of a reference count entry in bits",
            .def_value_str = "16"
        },
4290 4291
        { /* end of list */ }
    }
B
Blue Swirl 已提交
4292 4293
};

4294
BlockDriver bdrv_qcow2 = {
4295
    .format_name        = "qcow2",
4296
    .instance_size      = sizeof(BDRVQcow2State),
4297 4298 4299
    .bdrv_probe         = qcow2_probe,
    .bdrv_open          = qcow2_open,
    .bdrv_close         = qcow2_close,
J
Jeff Cody 已提交
4300
    .bdrv_reopen_prepare  = qcow2_reopen_prepare,
4301 4302
    .bdrv_reopen_commit   = qcow2_reopen_commit,
    .bdrv_reopen_abort    = qcow2_reopen_abort,
4303
    .bdrv_join_options    = qcow2_join_options,
4304
    .bdrv_child_perm      = bdrv_format_default_perms,
C
Chunyan Liu 已提交
4305
    .bdrv_create        = qcow2_create,
4306
    .bdrv_has_zero_init = bdrv_has_zero_init_1,
4307
    .bdrv_co_get_block_status = qcow2_co_get_block_status,
4308

K
Kevin Wolf 已提交
4309
    .bdrv_co_preadv         = qcow2_co_preadv,
K
Kevin Wolf 已提交
4310
    .bdrv_co_pwritev        = qcow2_co_pwritev,
K
Kevin Wolf 已提交
4311
    .bdrv_co_flush_to_os    = qcow2_co_flush_to_os,
4312

4313
    .bdrv_co_pwrite_zeroes  = qcow2_co_pwrite_zeroes,
4314
    .bdrv_co_pdiscard       = qcow2_co_pdiscard,
4315
    .bdrv_truncate          = qcow2_truncate,
4316
    .bdrv_co_pwritev_compressed = qcow2_co_pwritev_compressed,
M
Max Reitz 已提交
4317
    .bdrv_make_empty        = qcow2_make_empty,
B
Blue Swirl 已提交
4318 4319 4320 4321 4322

    .bdrv_snapshot_create   = qcow2_snapshot_create,
    .bdrv_snapshot_goto     = qcow2_snapshot_goto,
    .bdrv_snapshot_delete   = qcow2_snapshot_delete,
    .bdrv_snapshot_list     = qcow2_snapshot_list,
4323
    .bdrv_snapshot_load_tmp = qcow2_snapshot_load_tmp,
4324
    .bdrv_measure           = qcow2_measure,
4325
    .bdrv_get_info          = qcow2_get_info,
4326
    .bdrv_get_specific_info = qcow2_get_specific_info,
B
Blue Swirl 已提交
4327

4328 4329
    .bdrv_save_vmstate    = qcow2_save_vmstate,
    .bdrv_load_vmstate    = qcow2_load_vmstate,
B
Blue Swirl 已提交
4330

4331
    .supports_backing           = true,
B
Blue Swirl 已提交
4332 4333
    .bdrv_change_backing_file   = qcow2_change_backing_file,

4334
    .bdrv_refresh_limits        = qcow2_refresh_limits,
4335
    .bdrv_invalidate_cache      = qcow2_invalidate_cache,
K
Kevin Wolf 已提交
4336
    .bdrv_inactivate            = qcow2_inactivate,
4337

4338 4339
    .create_opts         = &qcow2_create_opts,
    .bdrv_check          = qcow2_check,
C
Chunyan Liu 已提交
4340
    .bdrv_amend_options  = qcow2_amend_options,
4341 4342 4343

    .bdrv_detach_aio_context  = qcow2_detach_aio_context,
    .bdrv_attach_aio_context  = qcow2_attach_aio_context,
4344 4345

    .bdrv_reopen_bitmaps_rw = qcow2_reopen_bitmaps_rw,
4346
    .bdrv_can_store_new_dirty_bitmap = qcow2_can_store_new_dirty_bitmap,
4347
    .bdrv_remove_persistent_dirty_bitmap = qcow2_remove_persistent_dirty_bitmap,
B
Blue Swirl 已提交
4348 4349
};

4350 4351 4352 4353 4354 4355
static void bdrv_qcow2_init(void)
{
    bdrv_register(&bdrv_qcow2);
}

block_init(bdrv_qcow2_init);