softfloat: Expand out the STATUS_PARAM macro
[qemu.git] / block / qcow2.c
blobdbaf016bc706c9c3e67384331136e0ad94497a8a
1 /*
2 * Block driver for the QCOW version 2 format
4 * Copyright (c) 2004-2006 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
24 #include "qemu-common.h"
25 #include "block/block_int.h"
26 #include "qemu/module.h"
27 #include <zlib.h>
28 #include "qemu/aes.h"
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"
34 #include "qapi/qmp/types.h"
35 #include "qapi-event.h"
36 #include "trace.h"
37 #include "qemu/option_int.h"
40 Differences with QCOW:
42 - Support for multiple incremental snapshots.
43 - Memory management by reference counts.
44 - Clusters which have a reference count of one have the bit
45 QCOW_OFLAG_COPIED to optimize write performance.
46 - Size of compressed clusters is stored in sectors to reduce bit usage
47 in the cluster offsets.
48 - Support for storing additional data (such as the VM state) in the
49 snapshots.
50 - If a backing store is used, the cluster size is not constrained
51 (could be backported to QCOW).
52 - L2 tables have always a size of one cluster.
56 typedef struct {
57 uint32_t magic;
58 uint32_t len;
59 } QEMU_PACKED QCowExtension;
61 #define QCOW2_EXT_MAGIC_END 0
62 #define QCOW2_EXT_MAGIC_BACKING_FORMAT 0xE2792ACA
63 #define QCOW2_EXT_MAGIC_FEATURE_TABLE 0x6803f857
65 static int qcow2_probe(const uint8_t *buf, int buf_size, const char *filename)
67 const QCowHeader *cow_header = (const void *)buf;
69 if (buf_size >= sizeof(QCowHeader) &&
70 be32_to_cpu(cow_header->magic) == QCOW_MAGIC &&
71 be32_to_cpu(cow_header->version) >= 2)
72 return 100;
73 else
74 return 0;
78 /*
79 * read qcow2 extension and fill bs
80 * start reading from start_offset
81 * finish reading upon magic of value 0 or when end_offset reached
82 * unknown magic is skipped (future extension this version knows nothing about)
83 * return 0 upon success, non-0 otherwise
85 static int qcow2_read_extensions(BlockDriverState *bs, uint64_t start_offset,
86 uint64_t end_offset, void **p_feature_table,
87 Error **errp)
89 BDRVQcowState *s = bs->opaque;
90 QCowExtension ext;
91 uint64_t offset;
92 int ret;
94 #ifdef DEBUG_EXT
95 printf("qcow2_read_extensions: start=%ld end=%ld\n", start_offset, end_offset);
96 #endif
97 offset = start_offset;
98 while (offset < end_offset) {
100 #ifdef DEBUG_EXT
101 /* Sanity check */
102 if (offset > s->cluster_size)
103 printf("qcow2_read_extension: suspicious offset %lu\n", offset);
105 printf("attempting to read extended header in offset %lu\n", offset);
106 #endif
108 ret = bdrv_pread(bs->file, offset, &ext, sizeof(ext));
109 if (ret < 0) {
110 error_setg_errno(errp, -ret, "qcow2_read_extension: ERROR: "
111 "pread fail from offset %" PRIu64, offset);
112 return 1;
114 be32_to_cpus(&ext.magic);
115 be32_to_cpus(&ext.len);
116 offset += sizeof(ext);
117 #ifdef DEBUG_EXT
118 printf("ext.magic = 0x%x\n", ext.magic);
119 #endif
120 if (offset > end_offset || ext.len > end_offset - offset) {
121 error_setg(errp, "Header extension too large");
122 return -EINVAL;
125 switch (ext.magic) {
126 case QCOW2_EXT_MAGIC_END:
127 return 0;
129 case QCOW2_EXT_MAGIC_BACKING_FORMAT:
130 if (ext.len >= sizeof(bs->backing_format)) {
131 error_setg(errp, "ERROR: ext_backing_format: len=%" PRIu32
132 " too large (>=%zu)", ext.len,
133 sizeof(bs->backing_format));
134 return 2;
136 ret = bdrv_pread(bs->file, offset, bs->backing_format, ext.len);
137 if (ret < 0) {
138 error_setg_errno(errp, -ret, "ERROR: ext_backing_format: "
139 "Could not read format name");
140 return 3;
142 bs->backing_format[ext.len] = '\0';
143 #ifdef DEBUG_EXT
144 printf("Qcow2: Got format extension %s\n", bs->backing_format);
145 #endif
146 break;
148 case QCOW2_EXT_MAGIC_FEATURE_TABLE:
149 if (p_feature_table != NULL) {
150 void* feature_table = g_malloc0(ext.len + 2 * sizeof(Qcow2Feature));
151 ret = bdrv_pread(bs->file, offset , feature_table, ext.len);
152 if (ret < 0) {
153 error_setg_errno(errp, -ret, "ERROR: ext_feature_table: "
154 "Could not read table");
155 return ret;
158 *p_feature_table = feature_table;
160 break;
162 default:
163 /* unknown magic - save it in case we need to rewrite the header */
165 Qcow2UnknownHeaderExtension *uext;
167 uext = g_malloc0(sizeof(*uext) + ext.len);
168 uext->magic = ext.magic;
169 uext->len = ext.len;
170 QLIST_INSERT_HEAD(&s->unknown_header_ext, uext, next);
172 ret = bdrv_pread(bs->file, offset , uext->data, uext->len);
173 if (ret < 0) {
174 error_setg_errno(errp, -ret, "ERROR: unknown extension: "
175 "Could not read data");
176 return ret;
179 break;
182 offset += ((ext.len + 7) & ~7);
185 return 0;
188 static void cleanup_unknown_header_ext(BlockDriverState *bs)
190 BDRVQcowState *s = bs->opaque;
191 Qcow2UnknownHeaderExtension *uext, *next;
193 QLIST_FOREACH_SAFE(uext, &s->unknown_header_ext, next, next) {
194 QLIST_REMOVE(uext, next);
195 g_free(uext);
199 static void GCC_FMT_ATTR(3, 4) report_unsupported(BlockDriverState *bs,
200 Error **errp, const char *fmt, ...)
202 char msg[64];
203 va_list ap;
205 va_start(ap, fmt);
206 vsnprintf(msg, sizeof(msg), fmt, ap);
207 va_end(ap);
209 error_set(errp, QERR_UNKNOWN_BLOCK_FORMAT_FEATURE,
210 bdrv_get_device_name(bs), "qcow2", msg);
213 static void report_unsupported_feature(BlockDriverState *bs,
214 Error **errp, Qcow2Feature *table, uint64_t mask)
216 char *features = g_strdup("");
217 char *old;
219 while (table && table->name[0] != '\0') {
220 if (table->type == QCOW2_FEAT_TYPE_INCOMPATIBLE) {
221 if (mask & (1ULL << table->bit)) {
222 old = features;
223 features = g_strdup_printf("%s%s%.46s", old, *old ? ", " : "",
224 table->name);
225 g_free(old);
226 mask &= ~(1ULL << table->bit);
229 table++;
232 if (mask) {
233 old = features;
234 features = g_strdup_printf("%s%sUnknown incompatible feature: %" PRIx64,
235 old, *old ? ", " : "", mask);
236 g_free(old);
239 report_unsupported(bs, errp, "%s", features);
240 g_free(features);
244 * Sets the dirty bit and flushes afterwards if necessary.
246 * The incompatible_features bit is only set if the image file header was
247 * updated successfully. Therefore it is not required to check the return
248 * value of this function.
250 int qcow2_mark_dirty(BlockDriverState *bs)
252 BDRVQcowState *s = bs->opaque;
253 uint64_t val;
254 int ret;
256 assert(s->qcow_version >= 3);
258 if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) {
259 return 0; /* already dirty */
262 val = cpu_to_be64(s->incompatible_features | QCOW2_INCOMPAT_DIRTY);
263 ret = bdrv_pwrite(bs->file, offsetof(QCowHeader, incompatible_features),
264 &val, sizeof(val));
265 if (ret < 0) {
266 return ret;
268 ret = bdrv_flush(bs->file);
269 if (ret < 0) {
270 return ret;
273 /* Only treat image as dirty if the header was updated successfully */
274 s->incompatible_features |= QCOW2_INCOMPAT_DIRTY;
275 return 0;
279 * Clears the dirty bit and flushes before if necessary. Only call this
280 * function when there are no pending requests, it does not guard against
281 * concurrent requests dirtying the image.
283 static int qcow2_mark_clean(BlockDriverState *bs)
285 BDRVQcowState *s = bs->opaque;
287 if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) {
288 int ret;
290 s->incompatible_features &= ~QCOW2_INCOMPAT_DIRTY;
292 ret = bdrv_flush(bs);
293 if (ret < 0) {
294 return ret;
297 return qcow2_update_header(bs);
299 return 0;
303 * Marks the image as corrupt.
305 int qcow2_mark_corrupt(BlockDriverState *bs)
307 BDRVQcowState *s = bs->opaque;
309 s->incompatible_features |= QCOW2_INCOMPAT_CORRUPT;
310 return qcow2_update_header(bs);
314 * Marks the image as consistent, i.e., unsets the corrupt bit, and flushes
315 * before if necessary.
317 int qcow2_mark_consistent(BlockDriverState *bs)
319 BDRVQcowState *s = bs->opaque;
321 if (s->incompatible_features & QCOW2_INCOMPAT_CORRUPT) {
322 int ret = bdrv_flush(bs);
323 if (ret < 0) {
324 return ret;
327 s->incompatible_features &= ~QCOW2_INCOMPAT_CORRUPT;
328 return qcow2_update_header(bs);
330 return 0;
333 static int qcow2_check(BlockDriverState *bs, BdrvCheckResult *result,
334 BdrvCheckMode fix)
336 int ret = qcow2_check_refcounts(bs, result, fix);
337 if (ret < 0) {
338 return ret;
341 if (fix && result->check_errors == 0 && result->corruptions == 0) {
342 ret = qcow2_mark_clean(bs);
343 if (ret < 0) {
344 return ret;
346 return qcow2_mark_consistent(bs);
348 return ret;
351 static int validate_table_offset(BlockDriverState *bs, uint64_t offset,
352 uint64_t entries, size_t entry_len)
354 BDRVQcowState *s = bs->opaque;
355 uint64_t size;
357 /* Use signed INT64_MAX as the maximum even for uint64_t header fields,
358 * because values will be passed to qemu functions taking int64_t. */
359 if (entries > INT64_MAX / entry_len) {
360 return -EINVAL;
363 size = entries * entry_len;
365 if (INT64_MAX - size < offset) {
366 return -EINVAL;
369 /* Tables must be cluster aligned */
370 if (offset & (s->cluster_size - 1)) {
371 return -EINVAL;
374 return 0;
377 static QemuOptsList qcow2_runtime_opts = {
378 .name = "qcow2",
379 .head = QTAILQ_HEAD_INITIALIZER(qcow2_runtime_opts.head),
380 .desc = {
382 .name = QCOW2_OPT_LAZY_REFCOUNTS,
383 .type = QEMU_OPT_BOOL,
384 .help = "Postpone refcount updates",
387 .name = QCOW2_OPT_DISCARD_REQUEST,
388 .type = QEMU_OPT_BOOL,
389 .help = "Pass guest discard requests to the layer below",
392 .name = QCOW2_OPT_DISCARD_SNAPSHOT,
393 .type = QEMU_OPT_BOOL,
394 .help = "Generate discard requests when snapshot related space "
395 "is freed",
398 .name = QCOW2_OPT_DISCARD_OTHER,
399 .type = QEMU_OPT_BOOL,
400 .help = "Generate discard requests when other clusters are freed",
403 .name = QCOW2_OPT_OVERLAP,
404 .type = QEMU_OPT_STRING,
405 .help = "Selects which overlap checks to perform from a range of "
406 "templates (none, constant, cached, all)",
409 .name = QCOW2_OPT_OVERLAP_TEMPLATE,
410 .type = QEMU_OPT_STRING,
411 .help = "Selects which overlap checks to perform from a range of "
412 "templates (none, constant, cached, all)",
415 .name = QCOW2_OPT_OVERLAP_MAIN_HEADER,
416 .type = QEMU_OPT_BOOL,
417 .help = "Check for unintended writes into the main qcow2 header",
420 .name = QCOW2_OPT_OVERLAP_ACTIVE_L1,
421 .type = QEMU_OPT_BOOL,
422 .help = "Check for unintended writes into the active L1 table",
425 .name = QCOW2_OPT_OVERLAP_ACTIVE_L2,
426 .type = QEMU_OPT_BOOL,
427 .help = "Check for unintended writes into an active L2 table",
430 .name = QCOW2_OPT_OVERLAP_REFCOUNT_TABLE,
431 .type = QEMU_OPT_BOOL,
432 .help = "Check for unintended writes into the refcount table",
435 .name = QCOW2_OPT_OVERLAP_REFCOUNT_BLOCK,
436 .type = QEMU_OPT_BOOL,
437 .help = "Check for unintended writes into a refcount block",
440 .name = QCOW2_OPT_OVERLAP_SNAPSHOT_TABLE,
441 .type = QEMU_OPT_BOOL,
442 .help = "Check for unintended writes into the snapshot table",
445 .name = QCOW2_OPT_OVERLAP_INACTIVE_L1,
446 .type = QEMU_OPT_BOOL,
447 .help = "Check for unintended writes into an inactive L1 table",
450 .name = QCOW2_OPT_OVERLAP_INACTIVE_L2,
451 .type = QEMU_OPT_BOOL,
452 .help = "Check for unintended writes into an inactive L2 table",
455 .name = QCOW2_OPT_CACHE_SIZE,
456 .type = QEMU_OPT_SIZE,
457 .help = "Maximum combined metadata (L2 tables and refcount blocks) "
458 "cache size",
461 .name = QCOW2_OPT_L2_CACHE_SIZE,
462 .type = QEMU_OPT_SIZE,
463 .help = "Maximum L2 table cache size",
466 .name = QCOW2_OPT_REFCOUNT_CACHE_SIZE,
467 .type = QEMU_OPT_SIZE,
468 .help = "Maximum refcount block cache size",
470 { /* end of list */ }
474 static const char *overlap_bool_option_names[QCOW2_OL_MAX_BITNR] = {
475 [QCOW2_OL_MAIN_HEADER_BITNR] = QCOW2_OPT_OVERLAP_MAIN_HEADER,
476 [QCOW2_OL_ACTIVE_L1_BITNR] = QCOW2_OPT_OVERLAP_ACTIVE_L1,
477 [QCOW2_OL_ACTIVE_L2_BITNR] = QCOW2_OPT_OVERLAP_ACTIVE_L2,
478 [QCOW2_OL_REFCOUNT_TABLE_BITNR] = QCOW2_OPT_OVERLAP_REFCOUNT_TABLE,
479 [QCOW2_OL_REFCOUNT_BLOCK_BITNR] = QCOW2_OPT_OVERLAP_REFCOUNT_BLOCK,
480 [QCOW2_OL_SNAPSHOT_TABLE_BITNR] = QCOW2_OPT_OVERLAP_SNAPSHOT_TABLE,
481 [QCOW2_OL_INACTIVE_L1_BITNR] = QCOW2_OPT_OVERLAP_INACTIVE_L1,
482 [QCOW2_OL_INACTIVE_L2_BITNR] = QCOW2_OPT_OVERLAP_INACTIVE_L2,
485 static void read_cache_sizes(QemuOpts *opts, uint64_t *l2_cache_size,
486 uint64_t *refcount_cache_size, Error **errp)
488 uint64_t combined_cache_size;
489 bool l2_cache_size_set, refcount_cache_size_set, combined_cache_size_set;
491 combined_cache_size_set = qemu_opt_get(opts, QCOW2_OPT_CACHE_SIZE);
492 l2_cache_size_set = qemu_opt_get(opts, QCOW2_OPT_L2_CACHE_SIZE);
493 refcount_cache_size_set = qemu_opt_get(opts, QCOW2_OPT_REFCOUNT_CACHE_SIZE);
495 combined_cache_size = qemu_opt_get_size(opts, QCOW2_OPT_CACHE_SIZE, 0);
496 *l2_cache_size = qemu_opt_get_size(opts, QCOW2_OPT_L2_CACHE_SIZE, 0);
497 *refcount_cache_size = qemu_opt_get_size(opts,
498 QCOW2_OPT_REFCOUNT_CACHE_SIZE, 0);
500 if (combined_cache_size_set) {
501 if (l2_cache_size_set && refcount_cache_size_set) {
502 error_setg(errp, QCOW2_OPT_CACHE_SIZE ", " QCOW2_OPT_L2_CACHE_SIZE
503 " and " QCOW2_OPT_REFCOUNT_CACHE_SIZE " may not be set "
504 "the same time");
505 return;
506 } else if (*l2_cache_size > combined_cache_size) {
507 error_setg(errp, QCOW2_OPT_L2_CACHE_SIZE " may not exceed "
508 QCOW2_OPT_CACHE_SIZE);
509 return;
510 } else if (*refcount_cache_size > combined_cache_size) {
511 error_setg(errp, QCOW2_OPT_REFCOUNT_CACHE_SIZE " may not exceed "
512 QCOW2_OPT_CACHE_SIZE);
513 return;
516 if (l2_cache_size_set) {
517 *refcount_cache_size = combined_cache_size - *l2_cache_size;
518 } else if (refcount_cache_size_set) {
519 *l2_cache_size = combined_cache_size - *refcount_cache_size;
520 } else {
521 *refcount_cache_size = combined_cache_size
522 / (DEFAULT_L2_REFCOUNT_SIZE_RATIO + 1);
523 *l2_cache_size = combined_cache_size - *refcount_cache_size;
525 } else {
526 if (!l2_cache_size_set && !refcount_cache_size_set) {
527 *l2_cache_size = DEFAULT_L2_CACHE_BYTE_SIZE;
528 *refcount_cache_size = *l2_cache_size
529 / DEFAULT_L2_REFCOUNT_SIZE_RATIO;
530 } else if (!l2_cache_size_set) {
531 *l2_cache_size = *refcount_cache_size
532 * DEFAULT_L2_REFCOUNT_SIZE_RATIO;
533 } else if (!refcount_cache_size_set) {
534 *refcount_cache_size = *l2_cache_size
535 / DEFAULT_L2_REFCOUNT_SIZE_RATIO;
540 static int qcow2_open(BlockDriverState *bs, QDict *options, int flags,
541 Error **errp)
543 BDRVQcowState *s = bs->opaque;
544 unsigned int len, i;
545 int ret = 0;
546 QCowHeader header;
547 QemuOpts *opts = NULL;
548 Error *local_err = NULL;
549 uint64_t ext_end;
550 uint64_t l1_vm_state_index;
551 const char *opt_overlap_check, *opt_overlap_check_template;
552 int overlap_check_template = 0;
553 uint64_t l2_cache_size, refcount_cache_size;
555 ret = bdrv_pread(bs->file, 0, &header, sizeof(header));
556 if (ret < 0) {
557 error_setg_errno(errp, -ret, "Could not read qcow2 header");
558 goto fail;
560 be32_to_cpus(&header.magic);
561 be32_to_cpus(&header.version);
562 be64_to_cpus(&header.backing_file_offset);
563 be32_to_cpus(&header.backing_file_size);
564 be64_to_cpus(&header.size);
565 be32_to_cpus(&header.cluster_bits);
566 be32_to_cpus(&header.crypt_method);
567 be64_to_cpus(&header.l1_table_offset);
568 be32_to_cpus(&header.l1_size);
569 be64_to_cpus(&header.refcount_table_offset);
570 be32_to_cpus(&header.refcount_table_clusters);
571 be64_to_cpus(&header.snapshots_offset);
572 be32_to_cpus(&header.nb_snapshots);
574 if (header.magic != QCOW_MAGIC) {
575 error_setg(errp, "Image is not in qcow2 format");
576 ret = -EINVAL;
577 goto fail;
579 if (header.version < 2 || header.version > 3) {
580 report_unsupported(bs, errp, "QCOW version %" PRIu32, header.version);
581 ret = -ENOTSUP;
582 goto fail;
585 s->qcow_version = header.version;
587 /* Initialise cluster size */
588 if (header.cluster_bits < MIN_CLUSTER_BITS ||
589 header.cluster_bits > MAX_CLUSTER_BITS) {
590 error_setg(errp, "Unsupported cluster size: 2^%" PRIu32,
591 header.cluster_bits);
592 ret = -EINVAL;
593 goto fail;
596 s->cluster_bits = header.cluster_bits;
597 s->cluster_size = 1 << s->cluster_bits;
598 s->cluster_sectors = 1 << (s->cluster_bits - 9);
600 /* Initialise version 3 header fields */
601 if (header.version == 2) {
602 header.incompatible_features = 0;
603 header.compatible_features = 0;
604 header.autoclear_features = 0;
605 header.refcount_order = 4;
606 header.header_length = 72;
607 } else {
608 be64_to_cpus(&header.incompatible_features);
609 be64_to_cpus(&header.compatible_features);
610 be64_to_cpus(&header.autoclear_features);
611 be32_to_cpus(&header.refcount_order);
612 be32_to_cpus(&header.header_length);
614 if (header.header_length < 104) {
615 error_setg(errp, "qcow2 header too short");
616 ret = -EINVAL;
617 goto fail;
621 if (header.header_length > s->cluster_size) {
622 error_setg(errp, "qcow2 header exceeds cluster size");
623 ret = -EINVAL;
624 goto fail;
627 if (header.header_length > sizeof(header)) {
628 s->unknown_header_fields_size = header.header_length - sizeof(header);
629 s->unknown_header_fields = g_malloc(s->unknown_header_fields_size);
630 ret = bdrv_pread(bs->file, sizeof(header), s->unknown_header_fields,
631 s->unknown_header_fields_size);
632 if (ret < 0) {
633 error_setg_errno(errp, -ret, "Could not read unknown qcow2 header "
634 "fields");
635 goto fail;
639 if (header.backing_file_offset > s->cluster_size) {
640 error_setg(errp, "Invalid backing file offset");
641 ret = -EINVAL;
642 goto fail;
645 if (header.backing_file_offset) {
646 ext_end = header.backing_file_offset;
647 } else {
648 ext_end = 1 << header.cluster_bits;
651 /* Handle feature bits */
652 s->incompatible_features = header.incompatible_features;
653 s->compatible_features = header.compatible_features;
654 s->autoclear_features = header.autoclear_features;
656 if (s->incompatible_features & ~QCOW2_INCOMPAT_MASK) {
657 void *feature_table = NULL;
658 qcow2_read_extensions(bs, header.header_length, ext_end,
659 &feature_table, NULL);
660 report_unsupported_feature(bs, errp, feature_table,
661 s->incompatible_features &
662 ~QCOW2_INCOMPAT_MASK);
663 ret = -ENOTSUP;
664 g_free(feature_table);
665 goto fail;
668 if (s->incompatible_features & QCOW2_INCOMPAT_CORRUPT) {
669 /* Corrupt images may not be written to unless they are being repaired
671 if ((flags & BDRV_O_RDWR) && !(flags & BDRV_O_CHECK)) {
672 error_setg(errp, "qcow2: Image is corrupt; cannot be opened "
673 "read/write");
674 ret = -EACCES;
675 goto fail;
679 /* Check support for various header values */
680 if (header.refcount_order != 4) {
681 report_unsupported(bs, errp, "%d bit reference counts",
682 1 << header.refcount_order);
683 ret = -ENOTSUP;
684 goto fail;
686 s->refcount_order = header.refcount_order;
688 if (header.crypt_method > QCOW_CRYPT_AES) {
689 error_setg(errp, "Unsupported encryption method: %" PRIu32,
690 header.crypt_method);
691 ret = -EINVAL;
692 goto fail;
694 s->crypt_method_header = header.crypt_method;
695 if (s->crypt_method_header) {
696 bs->encrypted = 1;
699 s->l2_bits = s->cluster_bits - 3; /* L2 is always one cluster */
700 s->l2_size = 1 << s->l2_bits;
701 /* 2^(s->refcount_order - 3) is the refcount width in bytes */
702 s->refcount_block_bits = s->cluster_bits - (s->refcount_order - 3);
703 s->refcount_block_size = 1 << s->refcount_block_bits;
704 bs->total_sectors = header.size / 512;
705 s->csize_shift = (62 - (s->cluster_bits - 8));
706 s->csize_mask = (1 << (s->cluster_bits - 8)) - 1;
707 s->cluster_offset_mask = (1LL << s->csize_shift) - 1;
709 s->refcount_table_offset = header.refcount_table_offset;
710 s->refcount_table_size =
711 header.refcount_table_clusters << (s->cluster_bits - 3);
713 if (header.refcount_table_clusters > qcow2_max_refcount_clusters(s)) {
714 error_setg(errp, "Reference count table too large");
715 ret = -EINVAL;
716 goto fail;
719 ret = validate_table_offset(bs, s->refcount_table_offset,
720 s->refcount_table_size, sizeof(uint64_t));
721 if (ret < 0) {
722 error_setg(errp, "Invalid reference count table offset");
723 goto fail;
726 /* Snapshot table offset/length */
727 if (header.nb_snapshots > QCOW_MAX_SNAPSHOTS) {
728 error_setg(errp, "Too many snapshots");
729 ret = -EINVAL;
730 goto fail;
733 ret = validate_table_offset(bs, header.snapshots_offset,
734 header.nb_snapshots,
735 sizeof(QCowSnapshotHeader));
736 if (ret < 0) {
737 error_setg(errp, "Invalid snapshot table offset");
738 goto fail;
741 /* read the level 1 table */
742 if (header.l1_size > QCOW_MAX_L1_SIZE) {
743 error_setg(errp, "Active L1 table too large");
744 ret = -EFBIG;
745 goto fail;
747 s->l1_size = header.l1_size;
749 l1_vm_state_index = size_to_l1(s, header.size);
750 if (l1_vm_state_index > INT_MAX) {
751 error_setg(errp, "Image is too big");
752 ret = -EFBIG;
753 goto fail;
755 s->l1_vm_state_index = l1_vm_state_index;
757 /* the L1 table must contain at least enough entries to put
758 header.size bytes */
759 if (s->l1_size < s->l1_vm_state_index) {
760 error_setg(errp, "L1 table is too small");
761 ret = -EINVAL;
762 goto fail;
765 ret = validate_table_offset(bs, header.l1_table_offset,
766 header.l1_size, sizeof(uint64_t));
767 if (ret < 0) {
768 error_setg(errp, "Invalid L1 table offset");
769 goto fail;
771 s->l1_table_offset = header.l1_table_offset;
774 if (s->l1_size > 0) {
775 s->l1_table = qemu_try_blockalign(bs->file,
776 align_offset(s->l1_size * sizeof(uint64_t), 512));
777 if (s->l1_table == NULL) {
778 error_setg(errp, "Could not allocate L1 table");
779 ret = -ENOMEM;
780 goto fail;
782 ret = bdrv_pread(bs->file, s->l1_table_offset, s->l1_table,
783 s->l1_size * sizeof(uint64_t));
784 if (ret < 0) {
785 error_setg_errno(errp, -ret, "Could not read L1 table");
786 goto fail;
788 for(i = 0;i < s->l1_size; i++) {
789 be64_to_cpus(&s->l1_table[i]);
793 /* get L2 table/refcount block cache size from command line options */
794 opts = qemu_opts_create(&qcow2_runtime_opts, NULL, 0, &error_abort);
795 qemu_opts_absorb_qdict(opts, options, &local_err);
796 if (local_err) {
797 error_propagate(errp, local_err);
798 ret = -EINVAL;
799 goto fail;
802 read_cache_sizes(opts, &l2_cache_size, &refcount_cache_size, &local_err);
803 if (local_err) {
804 error_propagate(errp, local_err);
805 ret = -EINVAL;
806 goto fail;
809 l2_cache_size /= s->cluster_size;
810 if (l2_cache_size < MIN_L2_CACHE_SIZE) {
811 l2_cache_size = MIN_L2_CACHE_SIZE;
813 if (l2_cache_size > INT_MAX) {
814 error_setg(errp, "L2 cache size too big");
815 ret = -EINVAL;
816 goto fail;
819 refcount_cache_size /= s->cluster_size;
820 if (refcount_cache_size < MIN_REFCOUNT_CACHE_SIZE) {
821 refcount_cache_size = MIN_REFCOUNT_CACHE_SIZE;
823 if (refcount_cache_size > INT_MAX) {
824 error_setg(errp, "Refcount cache size too big");
825 ret = -EINVAL;
826 goto fail;
829 /* alloc L2 table/refcount block cache */
830 s->l2_table_cache = qcow2_cache_create(bs, l2_cache_size);
831 s->refcount_block_cache = qcow2_cache_create(bs, refcount_cache_size);
832 if (s->l2_table_cache == NULL || s->refcount_block_cache == NULL) {
833 error_setg(errp, "Could not allocate metadata caches");
834 ret = -ENOMEM;
835 goto fail;
838 s->cluster_cache = g_malloc(s->cluster_size);
839 /* one more sector for decompressed data alignment */
840 s->cluster_data = qemu_try_blockalign(bs->file, QCOW_MAX_CRYPT_CLUSTERS
841 * s->cluster_size + 512);
842 if (s->cluster_data == NULL) {
843 error_setg(errp, "Could not allocate temporary cluster buffer");
844 ret = -ENOMEM;
845 goto fail;
848 s->cluster_cache_offset = -1;
849 s->flags = flags;
851 ret = qcow2_refcount_init(bs);
852 if (ret != 0) {
853 error_setg_errno(errp, -ret, "Could not initialize refcount handling");
854 goto fail;
857 QLIST_INIT(&s->cluster_allocs);
858 QTAILQ_INIT(&s->discards);
860 /* read qcow2 extensions */
861 if (qcow2_read_extensions(bs, header.header_length, ext_end, NULL,
862 &local_err)) {
863 error_propagate(errp, local_err);
864 ret = -EINVAL;
865 goto fail;
868 /* read the backing file name */
869 if (header.backing_file_offset != 0) {
870 len = header.backing_file_size;
871 if (len > MIN(1023, s->cluster_size - header.backing_file_offset) ||
872 len > sizeof(bs->backing_file)) {
873 error_setg(errp, "Backing file name too long");
874 ret = -EINVAL;
875 goto fail;
877 ret = bdrv_pread(bs->file, header.backing_file_offset,
878 bs->backing_file, len);
879 if (ret < 0) {
880 error_setg_errno(errp, -ret, "Could not read backing file name");
881 goto fail;
883 bs->backing_file[len] = '\0';
886 /* Internal snapshots */
887 s->snapshots_offset = header.snapshots_offset;
888 s->nb_snapshots = header.nb_snapshots;
890 ret = qcow2_read_snapshots(bs);
891 if (ret < 0) {
892 error_setg_errno(errp, -ret, "Could not read snapshots");
893 goto fail;
896 /* Clear unknown autoclear feature bits */
897 if (!bs->read_only && !(flags & BDRV_O_INCOMING) && s->autoclear_features) {
898 s->autoclear_features = 0;
899 ret = qcow2_update_header(bs);
900 if (ret < 0) {
901 error_setg_errno(errp, -ret, "Could not update qcow2 header");
902 goto fail;
906 /* Initialise locks */
907 qemu_co_mutex_init(&s->lock);
909 /* Repair image if dirty */
910 if (!(flags & (BDRV_O_CHECK | BDRV_O_INCOMING)) && !bs->read_only &&
911 (s->incompatible_features & QCOW2_INCOMPAT_DIRTY)) {
912 BdrvCheckResult result = {0};
914 ret = qcow2_check(bs, &result, BDRV_FIX_ERRORS | BDRV_FIX_LEAKS);
915 if (ret < 0) {
916 error_setg_errno(errp, -ret, "Could not repair dirty image");
917 goto fail;
921 /* Enable lazy_refcounts according to image and command line options */
922 s->use_lazy_refcounts = qemu_opt_get_bool(opts, QCOW2_OPT_LAZY_REFCOUNTS,
923 (s->compatible_features & QCOW2_COMPAT_LAZY_REFCOUNTS));
925 s->discard_passthrough[QCOW2_DISCARD_NEVER] = false;
926 s->discard_passthrough[QCOW2_DISCARD_ALWAYS] = true;
927 s->discard_passthrough[QCOW2_DISCARD_REQUEST] =
928 qemu_opt_get_bool(opts, QCOW2_OPT_DISCARD_REQUEST,
929 flags & BDRV_O_UNMAP);
930 s->discard_passthrough[QCOW2_DISCARD_SNAPSHOT] =
931 qemu_opt_get_bool(opts, QCOW2_OPT_DISCARD_SNAPSHOT, true);
932 s->discard_passthrough[QCOW2_DISCARD_OTHER] =
933 qemu_opt_get_bool(opts, QCOW2_OPT_DISCARD_OTHER, false);
935 opt_overlap_check = qemu_opt_get(opts, QCOW2_OPT_OVERLAP);
936 opt_overlap_check_template = qemu_opt_get(opts, QCOW2_OPT_OVERLAP_TEMPLATE);
937 if (opt_overlap_check_template && opt_overlap_check &&
938 strcmp(opt_overlap_check_template, opt_overlap_check))
940 error_setg(errp, "Conflicting values for qcow2 options '"
941 QCOW2_OPT_OVERLAP "' ('%s') and '" QCOW2_OPT_OVERLAP_TEMPLATE
942 "' ('%s')", opt_overlap_check, opt_overlap_check_template);
943 ret = -EINVAL;
944 goto fail;
946 if (!opt_overlap_check) {
947 opt_overlap_check = opt_overlap_check_template ?: "cached";
950 if (!strcmp(opt_overlap_check, "none")) {
951 overlap_check_template = 0;
952 } else if (!strcmp(opt_overlap_check, "constant")) {
953 overlap_check_template = QCOW2_OL_CONSTANT;
954 } else if (!strcmp(opt_overlap_check, "cached")) {
955 overlap_check_template = QCOW2_OL_CACHED;
956 } else if (!strcmp(opt_overlap_check, "all")) {
957 overlap_check_template = QCOW2_OL_ALL;
958 } else {
959 error_setg(errp, "Unsupported value '%s' for qcow2 option "
960 "'overlap-check'. Allowed are either of the following: "
961 "none, constant, cached, all", opt_overlap_check);
962 ret = -EINVAL;
963 goto fail;
966 s->overlap_check = 0;
967 for (i = 0; i < QCOW2_OL_MAX_BITNR; i++) {
968 /* overlap-check defines a template bitmask, but every flag may be
969 * overwritten through the associated boolean option */
970 s->overlap_check |=
971 qemu_opt_get_bool(opts, overlap_bool_option_names[i],
972 overlap_check_template & (1 << i)) << i;
975 qemu_opts_del(opts);
976 opts = NULL;
978 if (s->use_lazy_refcounts && s->qcow_version < 3) {
979 error_setg(errp, "Lazy refcounts require a qcow2 image with at least "
980 "qemu 1.1 compatibility level");
981 ret = -EINVAL;
982 goto fail;
985 #ifdef DEBUG_ALLOC
987 BdrvCheckResult result = {0};
988 qcow2_check_refcounts(bs, &result, 0);
990 #endif
991 return ret;
993 fail:
994 qemu_opts_del(opts);
995 g_free(s->unknown_header_fields);
996 cleanup_unknown_header_ext(bs);
997 qcow2_free_snapshots(bs);
998 qcow2_refcount_close(bs);
999 qemu_vfree(s->l1_table);
1000 /* else pre-write overlap checks in cache_destroy may crash */
1001 s->l1_table = NULL;
1002 if (s->l2_table_cache) {
1003 qcow2_cache_destroy(bs, s->l2_table_cache);
1005 if (s->refcount_block_cache) {
1006 qcow2_cache_destroy(bs, s->refcount_block_cache);
1008 g_free(s->cluster_cache);
1009 qemu_vfree(s->cluster_data);
1010 return ret;
1013 static void qcow2_refresh_limits(BlockDriverState *bs, Error **errp)
1015 BDRVQcowState *s = bs->opaque;
1017 bs->bl.write_zeroes_alignment = s->cluster_sectors;
1020 static int qcow2_set_key(BlockDriverState *bs, const char *key)
1022 BDRVQcowState *s = bs->opaque;
1023 uint8_t keybuf[16];
1024 int len, i;
1026 memset(keybuf, 0, 16);
1027 len = strlen(key);
1028 if (len > 16)
1029 len = 16;
1030 /* XXX: we could compress the chars to 7 bits to increase
1031 entropy */
1032 for(i = 0;i < len;i++) {
1033 keybuf[i] = key[i];
1035 s->crypt_method = s->crypt_method_header;
1037 if (AES_set_encrypt_key(keybuf, 128, &s->aes_encrypt_key) != 0)
1038 return -1;
1039 if (AES_set_decrypt_key(keybuf, 128, &s->aes_decrypt_key) != 0)
1040 return -1;
1041 #if 0
1042 /* test */
1044 uint8_t in[16];
1045 uint8_t out[16];
1046 uint8_t tmp[16];
1047 for(i=0;i<16;i++)
1048 in[i] = i;
1049 AES_encrypt(in, tmp, &s->aes_encrypt_key);
1050 AES_decrypt(tmp, out, &s->aes_decrypt_key);
1051 for(i = 0; i < 16; i++)
1052 printf(" %02x", tmp[i]);
1053 printf("\n");
1054 for(i = 0; i < 16; i++)
1055 printf(" %02x", out[i]);
1056 printf("\n");
1058 #endif
1059 return 0;
1062 /* We have no actual commit/abort logic for qcow2, but we need to write out any
1063 * unwritten data if we reopen read-only. */
1064 static int qcow2_reopen_prepare(BDRVReopenState *state,
1065 BlockReopenQueue *queue, Error **errp)
1067 int ret;
1069 if ((state->flags & BDRV_O_RDWR) == 0) {
1070 ret = bdrv_flush(state->bs);
1071 if (ret < 0) {
1072 return ret;
1075 ret = qcow2_mark_clean(state->bs);
1076 if (ret < 0) {
1077 return ret;
1081 return 0;
1084 static int64_t coroutine_fn qcow2_co_get_block_status(BlockDriverState *bs,
1085 int64_t sector_num, int nb_sectors, int *pnum)
1087 BDRVQcowState *s = bs->opaque;
1088 uint64_t cluster_offset;
1089 int index_in_cluster, ret;
1090 int64_t status = 0;
1092 *pnum = nb_sectors;
1093 qemu_co_mutex_lock(&s->lock);
1094 ret = qcow2_get_cluster_offset(bs, sector_num << 9, pnum, &cluster_offset);
1095 qemu_co_mutex_unlock(&s->lock);
1096 if (ret < 0) {
1097 return ret;
1100 if (cluster_offset != 0 && ret != QCOW2_CLUSTER_COMPRESSED &&
1101 !s->crypt_method) {
1102 index_in_cluster = sector_num & (s->cluster_sectors - 1);
1103 cluster_offset |= (index_in_cluster << BDRV_SECTOR_BITS);
1104 status |= BDRV_BLOCK_OFFSET_VALID | cluster_offset;
1106 if (ret == QCOW2_CLUSTER_ZERO) {
1107 status |= BDRV_BLOCK_ZERO;
1108 } else if (ret != QCOW2_CLUSTER_UNALLOCATED) {
1109 status |= BDRV_BLOCK_DATA;
1111 return status;
1114 /* handle reading after the end of the backing file */
1115 int qcow2_backing_read1(BlockDriverState *bs, QEMUIOVector *qiov,
1116 int64_t sector_num, int nb_sectors)
1118 int n1;
1119 if ((sector_num + nb_sectors) <= bs->total_sectors)
1120 return nb_sectors;
1121 if (sector_num >= bs->total_sectors)
1122 n1 = 0;
1123 else
1124 n1 = bs->total_sectors - sector_num;
1126 qemu_iovec_memset(qiov, 512 * n1, 0, 512 * (nb_sectors - n1));
1128 return n1;
1131 static coroutine_fn int qcow2_co_readv(BlockDriverState *bs, int64_t sector_num,
1132 int remaining_sectors, QEMUIOVector *qiov)
1134 BDRVQcowState *s = bs->opaque;
1135 int index_in_cluster, n1;
1136 int ret;
1137 int cur_nr_sectors; /* number of sectors in current iteration */
1138 uint64_t cluster_offset = 0;
1139 uint64_t bytes_done = 0;
1140 QEMUIOVector hd_qiov;
1141 uint8_t *cluster_data = NULL;
1143 qemu_iovec_init(&hd_qiov, qiov->niov);
1145 qemu_co_mutex_lock(&s->lock);
1147 while (remaining_sectors != 0) {
1149 /* prepare next request */
1150 cur_nr_sectors = remaining_sectors;
1151 if (s->crypt_method) {
1152 cur_nr_sectors = MIN(cur_nr_sectors,
1153 QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors);
1156 ret = qcow2_get_cluster_offset(bs, sector_num << 9,
1157 &cur_nr_sectors, &cluster_offset);
1158 if (ret < 0) {
1159 goto fail;
1162 index_in_cluster = sector_num & (s->cluster_sectors - 1);
1164 qemu_iovec_reset(&hd_qiov);
1165 qemu_iovec_concat(&hd_qiov, qiov, bytes_done,
1166 cur_nr_sectors * 512);
1168 switch (ret) {
1169 case QCOW2_CLUSTER_UNALLOCATED:
1171 if (bs->backing_hd) {
1172 /* read from the base image */
1173 n1 = qcow2_backing_read1(bs->backing_hd, &hd_qiov,
1174 sector_num, cur_nr_sectors);
1175 if (n1 > 0) {
1176 QEMUIOVector local_qiov;
1178 qemu_iovec_init(&local_qiov, hd_qiov.niov);
1179 qemu_iovec_concat(&local_qiov, &hd_qiov, 0,
1180 n1 * BDRV_SECTOR_SIZE);
1182 BLKDBG_EVENT(bs->file, BLKDBG_READ_BACKING_AIO);
1183 qemu_co_mutex_unlock(&s->lock);
1184 ret = bdrv_co_readv(bs->backing_hd, sector_num,
1185 n1, &local_qiov);
1186 qemu_co_mutex_lock(&s->lock);
1188 qemu_iovec_destroy(&local_qiov);
1190 if (ret < 0) {
1191 goto fail;
1194 } else {
1195 /* Note: in this case, no need to wait */
1196 qemu_iovec_memset(&hd_qiov, 0, 0, 512 * cur_nr_sectors);
1198 break;
1200 case QCOW2_CLUSTER_ZERO:
1201 qemu_iovec_memset(&hd_qiov, 0, 0, 512 * cur_nr_sectors);
1202 break;
1204 case QCOW2_CLUSTER_COMPRESSED:
1205 /* add AIO support for compressed blocks ? */
1206 ret = qcow2_decompress_cluster(bs, cluster_offset);
1207 if (ret < 0) {
1208 goto fail;
1211 qemu_iovec_from_buf(&hd_qiov, 0,
1212 s->cluster_cache + index_in_cluster * 512,
1213 512 * cur_nr_sectors);
1214 break;
1216 case QCOW2_CLUSTER_NORMAL:
1217 if ((cluster_offset & 511) != 0) {
1218 ret = -EIO;
1219 goto fail;
1222 if (s->crypt_method) {
1224 * For encrypted images, read everything into a temporary
1225 * contiguous buffer on which the AES functions can work.
1227 if (!cluster_data) {
1228 cluster_data =
1229 qemu_try_blockalign(bs->file, QCOW_MAX_CRYPT_CLUSTERS
1230 * s->cluster_size);
1231 if (cluster_data == NULL) {
1232 ret = -ENOMEM;
1233 goto fail;
1237 assert(cur_nr_sectors <=
1238 QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors);
1239 qemu_iovec_reset(&hd_qiov);
1240 qemu_iovec_add(&hd_qiov, cluster_data,
1241 512 * cur_nr_sectors);
1244 BLKDBG_EVENT(bs->file, BLKDBG_READ_AIO);
1245 qemu_co_mutex_unlock(&s->lock);
1246 ret = bdrv_co_readv(bs->file,
1247 (cluster_offset >> 9) + index_in_cluster,
1248 cur_nr_sectors, &hd_qiov);
1249 qemu_co_mutex_lock(&s->lock);
1250 if (ret < 0) {
1251 goto fail;
1253 if (s->crypt_method) {
1254 qcow2_encrypt_sectors(s, sector_num, cluster_data,
1255 cluster_data, cur_nr_sectors, 0, &s->aes_decrypt_key);
1256 qemu_iovec_from_buf(qiov, bytes_done,
1257 cluster_data, 512 * cur_nr_sectors);
1259 break;
1261 default:
1262 g_assert_not_reached();
1263 ret = -EIO;
1264 goto fail;
1267 remaining_sectors -= cur_nr_sectors;
1268 sector_num += cur_nr_sectors;
1269 bytes_done += cur_nr_sectors * 512;
1271 ret = 0;
1273 fail:
1274 qemu_co_mutex_unlock(&s->lock);
1276 qemu_iovec_destroy(&hd_qiov);
1277 qemu_vfree(cluster_data);
1279 return ret;
1282 static coroutine_fn int qcow2_co_writev(BlockDriverState *bs,
1283 int64_t sector_num,
1284 int remaining_sectors,
1285 QEMUIOVector *qiov)
1287 BDRVQcowState *s = bs->opaque;
1288 int index_in_cluster;
1289 int ret;
1290 int cur_nr_sectors; /* number of sectors in current iteration */
1291 uint64_t cluster_offset;
1292 QEMUIOVector hd_qiov;
1293 uint64_t bytes_done = 0;
1294 uint8_t *cluster_data = NULL;
1295 QCowL2Meta *l2meta = NULL;
1297 trace_qcow2_writev_start_req(qemu_coroutine_self(), sector_num,
1298 remaining_sectors);
1300 qemu_iovec_init(&hd_qiov, qiov->niov);
1302 s->cluster_cache_offset = -1; /* disable compressed cache */
1304 qemu_co_mutex_lock(&s->lock);
1306 while (remaining_sectors != 0) {
1308 l2meta = NULL;
1310 trace_qcow2_writev_start_part(qemu_coroutine_self());
1311 index_in_cluster = sector_num & (s->cluster_sectors - 1);
1312 cur_nr_sectors = remaining_sectors;
1313 if (s->crypt_method &&
1314 cur_nr_sectors >
1315 QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors - index_in_cluster) {
1316 cur_nr_sectors =
1317 QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors - index_in_cluster;
1320 ret = qcow2_alloc_cluster_offset(bs, sector_num << 9,
1321 &cur_nr_sectors, &cluster_offset, &l2meta);
1322 if (ret < 0) {
1323 goto fail;
1326 assert((cluster_offset & 511) == 0);
1328 qemu_iovec_reset(&hd_qiov);
1329 qemu_iovec_concat(&hd_qiov, qiov, bytes_done,
1330 cur_nr_sectors * 512);
1332 if (s->crypt_method) {
1333 if (!cluster_data) {
1334 cluster_data = qemu_try_blockalign(bs->file,
1335 QCOW_MAX_CRYPT_CLUSTERS
1336 * s->cluster_size);
1337 if (cluster_data == NULL) {
1338 ret = -ENOMEM;
1339 goto fail;
1343 assert(hd_qiov.size <=
1344 QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size);
1345 qemu_iovec_to_buf(&hd_qiov, 0, cluster_data, hd_qiov.size);
1347 qcow2_encrypt_sectors(s, sector_num, cluster_data,
1348 cluster_data, cur_nr_sectors, 1, &s->aes_encrypt_key);
1350 qemu_iovec_reset(&hd_qiov);
1351 qemu_iovec_add(&hd_qiov, cluster_data,
1352 cur_nr_sectors * 512);
1355 ret = qcow2_pre_write_overlap_check(bs, 0,
1356 cluster_offset + index_in_cluster * BDRV_SECTOR_SIZE,
1357 cur_nr_sectors * BDRV_SECTOR_SIZE);
1358 if (ret < 0) {
1359 goto fail;
1362 qemu_co_mutex_unlock(&s->lock);
1363 BLKDBG_EVENT(bs->file, BLKDBG_WRITE_AIO);
1364 trace_qcow2_writev_data(qemu_coroutine_self(),
1365 (cluster_offset >> 9) + index_in_cluster);
1366 ret = bdrv_co_writev(bs->file,
1367 (cluster_offset >> 9) + index_in_cluster,
1368 cur_nr_sectors, &hd_qiov);
1369 qemu_co_mutex_lock(&s->lock);
1370 if (ret < 0) {
1371 goto fail;
1374 while (l2meta != NULL) {
1375 QCowL2Meta *next;
1377 ret = qcow2_alloc_cluster_link_l2(bs, l2meta);
1378 if (ret < 0) {
1379 goto fail;
1382 /* Take the request off the list of running requests */
1383 if (l2meta->nb_clusters != 0) {
1384 QLIST_REMOVE(l2meta, next_in_flight);
1387 qemu_co_queue_restart_all(&l2meta->dependent_requests);
1389 next = l2meta->next;
1390 g_free(l2meta);
1391 l2meta = next;
1394 remaining_sectors -= cur_nr_sectors;
1395 sector_num += cur_nr_sectors;
1396 bytes_done += cur_nr_sectors * 512;
1397 trace_qcow2_writev_done_part(qemu_coroutine_self(), cur_nr_sectors);
1399 ret = 0;
1401 fail:
1402 qemu_co_mutex_unlock(&s->lock);
1404 while (l2meta != NULL) {
1405 QCowL2Meta *next;
1407 if (l2meta->nb_clusters != 0) {
1408 QLIST_REMOVE(l2meta, next_in_flight);
1410 qemu_co_queue_restart_all(&l2meta->dependent_requests);
1412 next = l2meta->next;
1413 g_free(l2meta);
1414 l2meta = next;
1417 qemu_iovec_destroy(&hd_qiov);
1418 qemu_vfree(cluster_data);
1419 trace_qcow2_writev_done_req(qemu_coroutine_self(), ret);
1421 return ret;
1424 static void qcow2_close(BlockDriverState *bs)
1426 BDRVQcowState *s = bs->opaque;
1427 qemu_vfree(s->l1_table);
1428 /* else pre-write overlap checks in cache_destroy may crash */
1429 s->l1_table = NULL;
1431 if (!(bs->open_flags & BDRV_O_INCOMING)) {
1432 int ret1, ret2;
1434 ret1 = qcow2_cache_flush(bs, s->l2_table_cache);
1435 ret2 = qcow2_cache_flush(bs, s->refcount_block_cache);
1437 if (ret1) {
1438 error_report("Failed to flush the L2 table cache: %s",
1439 strerror(-ret1));
1441 if (ret2) {
1442 error_report("Failed to flush the refcount block cache: %s",
1443 strerror(-ret2));
1446 if (!ret1 && !ret2) {
1447 qcow2_mark_clean(bs);
1451 qcow2_cache_destroy(bs, s->l2_table_cache);
1452 qcow2_cache_destroy(bs, s->refcount_block_cache);
1454 g_free(s->unknown_header_fields);
1455 cleanup_unknown_header_ext(bs);
1457 g_free(s->cluster_cache);
1458 qemu_vfree(s->cluster_data);
1459 qcow2_refcount_close(bs);
1460 qcow2_free_snapshots(bs);
1463 static void qcow2_invalidate_cache(BlockDriverState *bs, Error **errp)
1465 BDRVQcowState *s = bs->opaque;
1466 int flags = s->flags;
1467 AES_KEY aes_encrypt_key;
1468 AES_KEY aes_decrypt_key;
1469 uint32_t crypt_method = 0;
1470 QDict *options;
1471 Error *local_err = NULL;
1472 int ret;
1475 * Backing files are read-only which makes all of their metadata immutable,
1476 * that means we don't have to worry about reopening them here.
1479 if (s->crypt_method) {
1480 crypt_method = s->crypt_method;
1481 memcpy(&aes_encrypt_key, &s->aes_encrypt_key, sizeof(aes_encrypt_key));
1482 memcpy(&aes_decrypt_key, &s->aes_decrypt_key, sizeof(aes_decrypt_key));
1485 qcow2_close(bs);
1487 bdrv_invalidate_cache(bs->file, &local_err);
1488 if (local_err) {
1489 error_propagate(errp, local_err);
1490 return;
1493 memset(s, 0, sizeof(BDRVQcowState));
1494 options = qdict_clone_shallow(bs->options);
1496 ret = qcow2_open(bs, options, flags, &local_err);
1497 QDECREF(options);
1498 if (local_err) {
1499 error_setg(errp, "Could not reopen qcow2 layer: %s",
1500 error_get_pretty(local_err));
1501 error_free(local_err);
1502 return;
1503 } else if (ret < 0) {
1504 error_setg_errno(errp, -ret, "Could not reopen qcow2 layer");
1505 return;
1508 if (crypt_method) {
1509 s->crypt_method = crypt_method;
1510 memcpy(&s->aes_encrypt_key, &aes_encrypt_key, sizeof(aes_encrypt_key));
1511 memcpy(&s->aes_decrypt_key, &aes_decrypt_key, sizeof(aes_decrypt_key));
1515 static size_t header_ext_add(char *buf, uint32_t magic, const void *s,
1516 size_t len, size_t buflen)
1518 QCowExtension *ext_backing_fmt = (QCowExtension*) buf;
1519 size_t ext_len = sizeof(QCowExtension) + ((len + 7) & ~7);
1521 if (buflen < ext_len) {
1522 return -ENOSPC;
1525 *ext_backing_fmt = (QCowExtension) {
1526 .magic = cpu_to_be32(magic),
1527 .len = cpu_to_be32(len),
1529 memcpy(buf + sizeof(QCowExtension), s, len);
1531 return ext_len;
1535 * Updates the qcow2 header, including the variable length parts of it, i.e.
1536 * the backing file name and all extensions. qcow2 was not designed to allow
1537 * such changes, so if we run out of space (we can only use the first cluster)
1538 * this function may fail.
1540 * Returns 0 on success, -errno in error cases.
1542 int qcow2_update_header(BlockDriverState *bs)
1544 BDRVQcowState *s = bs->opaque;
1545 QCowHeader *header;
1546 char *buf;
1547 size_t buflen = s->cluster_size;
1548 int ret;
1549 uint64_t total_size;
1550 uint32_t refcount_table_clusters;
1551 size_t header_length;
1552 Qcow2UnknownHeaderExtension *uext;
1554 buf = qemu_blockalign(bs, buflen);
1556 /* Header structure */
1557 header = (QCowHeader*) buf;
1559 if (buflen < sizeof(*header)) {
1560 ret = -ENOSPC;
1561 goto fail;
1564 header_length = sizeof(*header) + s->unknown_header_fields_size;
1565 total_size = bs->total_sectors * BDRV_SECTOR_SIZE;
1566 refcount_table_clusters = s->refcount_table_size >> (s->cluster_bits - 3);
1568 *header = (QCowHeader) {
1569 /* Version 2 fields */
1570 .magic = cpu_to_be32(QCOW_MAGIC),
1571 .version = cpu_to_be32(s->qcow_version),
1572 .backing_file_offset = 0,
1573 .backing_file_size = 0,
1574 .cluster_bits = cpu_to_be32(s->cluster_bits),
1575 .size = cpu_to_be64(total_size),
1576 .crypt_method = cpu_to_be32(s->crypt_method_header),
1577 .l1_size = cpu_to_be32(s->l1_size),
1578 .l1_table_offset = cpu_to_be64(s->l1_table_offset),
1579 .refcount_table_offset = cpu_to_be64(s->refcount_table_offset),
1580 .refcount_table_clusters = cpu_to_be32(refcount_table_clusters),
1581 .nb_snapshots = cpu_to_be32(s->nb_snapshots),
1582 .snapshots_offset = cpu_to_be64(s->snapshots_offset),
1584 /* Version 3 fields */
1585 .incompatible_features = cpu_to_be64(s->incompatible_features),
1586 .compatible_features = cpu_to_be64(s->compatible_features),
1587 .autoclear_features = cpu_to_be64(s->autoclear_features),
1588 .refcount_order = cpu_to_be32(s->refcount_order),
1589 .header_length = cpu_to_be32(header_length),
1592 /* For older versions, write a shorter header */
1593 switch (s->qcow_version) {
1594 case 2:
1595 ret = offsetof(QCowHeader, incompatible_features);
1596 break;
1597 case 3:
1598 ret = sizeof(*header);
1599 break;
1600 default:
1601 ret = -EINVAL;
1602 goto fail;
1605 buf += ret;
1606 buflen -= ret;
1607 memset(buf, 0, buflen);
1609 /* Preserve any unknown field in the header */
1610 if (s->unknown_header_fields_size) {
1611 if (buflen < s->unknown_header_fields_size) {
1612 ret = -ENOSPC;
1613 goto fail;
1616 memcpy(buf, s->unknown_header_fields, s->unknown_header_fields_size);
1617 buf += s->unknown_header_fields_size;
1618 buflen -= s->unknown_header_fields_size;
1621 /* Backing file format header extension */
1622 if (*bs->backing_format) {
1623 ret = header_ext_add(buf, QCOW2_EXT_MAGIC_BACKING_FORMAT,
1624 bs->backing_format, strlen(bs->backing_format),
1625 buflen);
1626 if (ret < 0) {
1627 goto fail;
1630 buf += ret;
1631 buflen -= ret;
1634 /* Feature table */
1635 Qcow2Feature features[] = {
1637 .type = QCOW2_FEAT_TYPE_INCOMPATIBLE,
1638 .bit = QCOW2_INCOMPAT_DIRTY_BITNR,
1639 .name = "dirty bit",
1642 .type = QCOW2_FEAT_TYPE_INCOMPATIBLE,
1643 .bit = QCOW2_INCOMPAT_CORRUPT_BITNR,
1644 .name = "corrupt bit",
1647 .type = QCOW2_FEAT_TYPE_COMPATIBLE,
1648 .bit = QCOW2_COMPAT_LAZY_REFCOUNTS_BITNR,
1649 .name = "lazy refcounts",
1653 ret = header_ext_add(buf, QCOW2_EXT_MAGIC_FEATURE_TABLE,
1654 features, sizeof(features), buflen);
1655 if (ret < 0) {
1656 goto fail;
1658 buf += ret;
1659 buflen -= ret;
1661 /* Keep unknown header extensions */
1662 QLIST_FOREACH(uext, &s->unknown_header_ext, next) {
1663 ret = header_ext_add(buf, uext->magic, uext->data, uext->len, buflen);
1664 if (ret < 0) {
1665 goto fail;
1668 buf += ret;
1669 buflen -= ret;
1672 /* End of header extensions */
1673 ret = header_ext_add(buf, QCOW2_EXT_MAGIC_END, NULL, 0, buflen);
1674 if (ret < 0) {
1675 goto fail;
1678 buf += ret;
1679 buflen -= ret;
1681 /* Backing file name */
1682 if (*bs->backing_file) {
1683 size_t backing_file_len = strlen(bs->backing_file);
1685 if (buflen < backing_file_len) {
1686 ret = -ENOSPC;
1687 goto fail;
1690 /* Using strncpy is ok here, since buf is not NUL-terminated. */
1691 strncpy(buf, bs->backing_file, buflen);
1693 header->backing_file_offset = cpu_to_be64(buf - ((char*) header));
1694 header->backing_file_size = cpu_to_be32(backing_file_len);
1697 /* Write the new header */
1698 ret = bdrv_pwrite(bs->file, 0, header, s->cluster_size);
1699 if (ret < 0) {
1700 goto fail;
1703 ret = 0;
1704 fail:
1705 qemu_vfree(header);
1706 return ret;
1709 static int qcow2_change_backing_file(BlockDriverState *bs,
1710 const char *backing_file, const char *backing_fmt)
1712 pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: "");
1713 pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: "");
1715 return qcow2_update_header(bs);
1718 static int preallocate(BlockDriverState *bs)
1720 uint64_t nb_sectors;
1721 uint64_t offset;
1722 uint64_t host_offset = 0;
1723 int num;
1724 int ret;
1725 QCowL2Meta *meta;
1727 nb_sectors = bdrv_nb_sectors(bs);
1728 offset = 0;
1730 while (nb_sectors) {
1731 num = MIN(nb_sectors, INT_MAX >> BDRV_SECTOR_BITS);
1732 ret = qcow2_alloc_cluster_offset(bs, offset, &num,
1733 &host_offset, &meta);
1734 if (ret < 0) {
1735 return ret;
1738 while (meta) {
1739 QCowL2Meta *next = meta->next;
1741 ret = qcow2_alloc_cluster_link_l2(bs, meta);
1742 if (ret < 0) {
1743 qcow2_free_any_clusters(bs, meta->alloc_offset,
1744 meta->nb_clusters, QCOW2_DISCARD_NEVER);
1745 return ret;
1748 /* There are no dependent requests, but we need to remove our
1749 * request from the list of in-flight requests */
1750 QLIST_REMOVE(meta, next_in_flight);
1752 g_free(meta);
1753 meta = next;
1756 /* TODO Preallocate data if requested */
1758 nb_sectors -= num;
1759 offset += num << BDRV_SECTOR_BITS;
1763 * It is expected that the image file is large enough to actually contain
1764 * all of the allocated clusters (otherwise we get failing reads after
1765 * EOF). Extend the image to the last allocated sector.
1767 if (host_offset != 0) {
1768 uint8_t buf[BDRV_SECTOR_SIZE];
1769 memset(buf, 0, BDRV_SECTOR_SIZE);
1770 ret = bdrv_write(bs->file, (host_offset >> BDRV_SECTOR_BITS) + num - 1,
1771 buf, 1);
1772 if (ret < 0) {
1773 return ret;
1777 return 0;
1780 static int qcow2_create2(const char *filename, int64_t total_size,
1781 const char *backing_file, const char *backing_format,
1782 int flags, size_t cluster_size, PreallocMode prealloc,
1783 QemuOpts *opts, int version,
1784 Error **errp)
1786 /* Calculate cluster_bits */
1787 int cluster_bits;
1788 cluster_bits = ffs(cluster_size) - 1;
1789 if (cluster_bits < MIN_CLUSTER_BITS || cluster_bits > MAX_CLUSTER_BITS ||
1790 (1 << cluster_bits) != cluster_size)
1792 error_setg(errp, "Cluster size must be a power of two between %d and "
1793 "%dk", 1 << MIN_CLUSTER_BITS, 1 << (MAX_CLUSTER_BITS - 10));
1794 return -EINVAL;
1798 * Open the image file and write a minimal qcow2 header.
1800 * We keep things simple and start with a zero-sized image. We also
1801 * do without refcount blocks or a L1 table for now. We'll fix the
1802 * inconsistency later.
1804 * We do need a refcount table because growing the refcount table means
1805 * allocating two new refcount blocks - the seconds of which would be at
1806 * 2 GB for 64k clusters, and we don't want to have a 2 GB initial file
1807 * size for any qcow2 image.
1809 BlockDriverState* bs;
1810 QCowHeader *header;
1811 uint64_t* refcount_table;
1812 Error *local_err = NULL;
1813 int ret;
1815 if (prealloc == PREALLOC_MODE_FULL || prealloc == PREALLOC_MODE_FALLOC) {
1816 int64_t meta_size = 0;
1817 uint64_t nreftablee, nrefblocke, nl1e, nl2e;
1818 int64_t aligned_total_size = align_offset(total_size, cluster_size);
1820 /* header: 1 cluster */
1821 meta_size += cluster_size;
1823 /* total size of L2 tables */
1824 nl2e = aligned_total_size / cluster_size;
1825 nl2e = align_offset(nl2e, cluster_size / sizeof(uint64_t));
1826 meta_size += nl2e * sizeof(uint64_t);
1828 /* total size of L1 tables */
1829 nl1e = nl2e * sizeof(uint64_t) / cluster_size;
1830 nl1e = align_offset(nl1e, cluster_size / sizeof(uint64_t));
1831 meta_size += nl1e * sizeof(uint64_t);
1833 /* total size of refcount blocks
1835 * note: every host cluster is reference-counted, including metadata
1836 * (even refcount blocks are recursively included).
1837 * Let:
1838 * a = total_size (this is the guest disk size)
1839 * m = meta size not including refcount blocks and refcount tables
1840 * c = cluster size
1841 * y1 = number of refcount blocks entries
1842 * y2 = meta size including everything
1843 * then,
1844 * y1 = (y2 + a)/c
1845 * y2 = y1 * sizeof(u16) + y1 * sizeof(u16) * sizeof(u64) / c + m
1846 * we can get y1:
1847 * y1 = (a + m) / (c - sizeof(u16) - sizeof(u16) * sizeof(u64) / c)
1849 nrefblocke = (aligned_total_size + meta_size + cluster_size) /
1850 (cluster_size - sizeof(uint16_t) -
1851 1.0 * sizeof(uint16_t) * sizeof(uint64_t) / cluster_size);
1852 nrefblocke = align_offset(nrefblocke, cluster_size / sizeof(uint16_t));
1853 meta_size += nrefblocke * sizeof(uint16_t);
1855 /* total size of refcount tables */
1856 nreftablee = nrefblocke * sizeof(uint16_t) / cluster_size;
1857 nreftablee = align_offset(nreftablee, cluster_size / sizeof(uint64_t));
1858 meta_size += nreftablee * sizeof(uint64_t);
1860 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
1861 aligned_total_size + meta_size);
1862 qemu_opt_set(opts, BLOCK_OPT_PREALLOC, PreallocMode_lookup[prealloc]);
1865 ret = bdrv_create_file(filename, opts, &local_err);
1866 if (ret < 0) {
1867 error_propagate(errp, local_err);
1868 return ret;
1871 bs = NULL;
1872 ret = bdrv_open(&bs, filename, NULL, NULL, BDRV_O_RDWR | BDRV_O_PROTOCOL,
1873 NULL, &local_err);
1874 if (ret < 0) {
1875 error_propagate(errp, local_err);
1876 return ret;
1879 /* Write the header */
1880 QEMU_BUILD_BUG_ON((1 << MIN_CLUSTER_BITS) < sizeof(*header));
1881 header = g_malloc0(cluster_size);
1882 *header = (QCowHeader) {
1883 .magic = cpu_to_be32(QCOW_MAGIC),
1884 .version = cpu_to_be32(version),
1885 .cluster_bits = cpu_to_be32(cluster_bits),
1886 .size = cpu_to_be64(0),
1887 .l1_table_offset = cpu_to_be64(0),
1888 .l1_size = cpu_to_be32(0),
1889 .refcount_table_offset = cpu_to_be64(cluster_size),
1890 .refcount_table_clusters = cpu_to_be32(1),
1891 .refcount_order = cpu_to_be32(4),
1892 .header_length = cpu_to_be32(sizeof(*header)),
1895 if (flags & BLOCK_FLAG_ENCRYPT) {
1896 header->crypt_method = cpu_to_be32(QCOW_CRYPT_AES);
1897 } else {
1898 header->crypt_method = cpu_to_be32(QCOW_CRYPT_NONE);
1901 if (flags & BLOCK_FLAG_LAZY_REFCOUNTS) {
1902 header->compatible_features |=
1903 cpu_to_be64(QCOW2_COMPAT_LAZY_REFCOUNTS);
1906 ret = bdrv_pwrite(bs, 0, header, cluster_size);
1907 g_free(header);
1908 if (ret < 0) {
1909 error_setg_errno(errp, -ret, "Could not write qcow2 header");
1910 goto out;
1913 /* Write a refcount table with one refcount block */
1914 refcount_table = g_malloc0(2 * cluster_size);
1915 refcount_table[0] = cpu_to_be64(2 * cluster_size);
1916 ret = bdrv_pwrite(bs, cluster_size, refcount_table, 2 * cluster_size);
1917 g_free(refcount_table);
1919 if (ret < 0) {
1920 error_setg_errno(errp, -ret, "Could not write refcount table");
1921 goto out;
1924 bdrv_unref(bs);
1925 bs = NULL;
1928 * And now open the image and make it consistent first (i.e. increase the
1929 * refcount of the cluster that is occupied by the header and the refcount
1930 * table)
1932 ret = bdrv_open(&bs, filename, NULL, NULL,
1933 BDRV_O_RDWR | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH,
1934 &bdrv_qcow2, &local_err);
1935 if (ret < 0) {
1936 error_propagate(errp, local_err);
1937 goto out;
1940 ret = qcow2_alloc_clusters(bs, 3 * cluster_size);
1941 if (ret < 0) {
1942 error_setg_errno(errp, -ret, "Could not allocate clusters for qcow2 "
1943 "header and refcount table");
1944 goto out;
1946 } else if (ret != 0) {
1947 error_report("Huh, first cluster in empty image is already in use?");
1948 abort();
1951 /* Okay, now that we have a valid image, let's give it the right size */
1952 ret = bdrv_truncate(bs, total_size);
1953 if (ret < 0) {
1954 error_setg_errno(errp, -ret, "Could not resize image");
1955 goto out;
1958 /* Want a backing file? There you go.*/
1959 if (backing_file) {
1960 ret = bdrv_change_backing_file(bs, backing_file, backing_format);
1961 if (ret < 0) {
1962 error_setg_errno(errp, -ret, "Could not assign backing file '%s' "
1963 "with format '%s'", backing_file, backing_format);
1964 goto out;
1968 /* And if we're supposed to preallocate metadata, do that now */
1969 if (prealloc != PREALLOC_MODE_OFF) {
1970 BDRVQcowState *s = bs->opaque;
1971 qemu_co_mutex_lock(&s->lock);
1972 ret = preallocate(bs);
1973 qemu_co_mutex_unlock(&s->lock);
1974 if (ret < 0) {
1975 error_setg_errno(errp, -ret, "Could not preallocate metadata");
1976 goto out;
1980 bdrv_unref(bs);
1981 bs = NULL;
1983 /* Reopen the image without BDRV_O_NO_FLUSH to flush it before returning */
1984 ret = bdrv_open(&bs, filename, NULL, NULL,
1985 BDRV_O_RDWR | BDRV_O_CACHE_WB | BDRV_O_NO_BACKING,
1986 &bdrv_qcow2, &local_err);
1987 if (local_err) {
1988 error_propagate(errp, local_err);
1989 goto out;
1992 ret = 0;
1993 out:
1994 if (bs) {
1995 bdrv_unref(bs);
1997 return ret;
2000 static int qcow2_create(const char *filename, QemuOpts *opts, Error **errp)
2002 char *backing_file = NULL;
2003 char *backing_fmt = NULL;
2004 char *buf = NULL;
2005 uint64_t size = 0;
2006 int flags = 0;
2007 size_t cluster_size = DEFAULT_CLUSTER_SIZE;
2008 PreallocMode prealloc;
2009 int version = 3;
2010 Error *local_err = NULL;
2011 int ret;
2013 /* Read out options */
2014 size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
2015 BDRV_SECTOR_SIZE);
2016 backing_file = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FILE);
2017 backing_fmt = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FMT);
2018 if (qemu_opt_get_bool_del(opts, BLOCK_OPT_ENCRYPT, false)) {
2019 flags |= BLOCK_FLAG_ENCRYPT;
2021 cluster_size = qemu_opt_get_size_del(opts, BLOCK_OPT_CLUSTER_SIZE,
2022 DEFAULT_CLUSTER_SIZE);
2023 buf = qemu_opt_get_del(opts, BLOCK_OPT_PREALLOC);
2024 prealloc = qapi_enum_parse(PreallocMode_lookup, buf,
2025 PREALLOC_MODE_MAX, PREALLOC_MODE_OFF,
2026 &local_err);
2027 if (local_err) {
2028 error_propagate(errp, local_err);
2029 ret = -EINVAL;
2030 goto finish;
2032 g_free(buf);
2033 buf = qemu_opt_get_del(opts, BLOCK_OPT_COMPAT_LEVEL);
2034 if (!buf) {
2035 /* keep the default */
2036 } else if (!strcmp(buf, "0.10")) {
2037 version = 2;
2038 } else if (!strcmp(buf, "1.1")) {
2039 version = 3;
2040 } else {
2041 error_setg(errp, "Invalid compatibility level: '%s'", buf);
2042 ret = -EINVAL;
2043 goto finish;
2046 if (qemu_opt_get_bool_del(opts, BLOCK_OPT_LAZY_REFCOUNTS, false)) {
2047 flags |= BLOCK_FLAG_LAZY_REFCOUNTS;
2050 if (backing_file && prealloc != PREALLOC_MODE_OFF) {
2051 error_setg(errp, "Backing file and preallocation cannot be used at "
2052 "the same time");
2053 ret = -EINVAL;
2054 goto finish;
2057 if (version < 3 && (flags & BLOCK_FLAG_LAZY_REFCOUNTS)) {
2058 error_setg(errp, "Lazy refcounts only supported with compatibility "
2059 "level 1.1 and above (use compat=1.1 or greater)");
2060 ret = -EINVAL;
2061 goto finish;
2064 ret = qcow2_create2(filename, size, backing_file, backing_fmt, flags,
2065 cluster_size, prealloc, opts, version, &local_err);
2066 if (local_err) {
2067 error_propagate(errp, local_err);
2070 finish:
2071 g_free(backing_file);
2072 g_free(backing_fmt);
2073 g_free(buf);
2074 return ret;
2077 static coroutine_fn int qcow2_co_write_zeroes(BlockDriverState *bs,
2078 int64_t sector_num, int nb_sectors, BdrvRequestFlags flags)
2080 int ret;
2081 BDRVQcowState *s = bs->opaque;
2083 /* Emulate misaligned zero writes */
2084 if (sector_num % s->cluster_sectors || nb_sectors % s->cluster_sectors) {
2085 return -ENOTSUP;
2088 /* Whatever is left can use real zero clusters */
2089 qemu_co_mutex_lock(&s->lock);
2090 ret = qcow2_zero_clusters(bs, sector_num << BDRV_SECTOR_BITS,
2091 nb_sectors);
2092 qemu_co_mutex_unlock(&s->lock);
2094 return ret;
2097 static coroutine_fn int qcow2_co_discard(BlockDriverState *bs,
2098 int64_t sector_num, int nb_sectors)
2100 int ret;
2101 BDRVQcowState *s = bs->opaque;
2103 qemu_co_mutex_lock(&s->lock);
2104 ret = qcow2_discard_clusters(bs, sector_num << BDRV_SECTOR_BITS,
2105 nb_sectors, QCOW2_DISCARD_REQUEST, false);
2106 qemu_co_mutex_unlock(&s->lock);
2107 return ret;
2110 static int qcow2_truncate(BlockDriverState *bs, int64_t offset)
2112 BDRVQcowState *s = bs->opaque;
2113 int64_t new_l1_size;
2114 int ret;
2116 if (offset & 511) {
2117 error_report("The new size must be a multiple of 512");
2118 return -EINVAL;
2121 /* cannot proceed if image has snapshots */
2122 if (s->nb_snapshots) {
2123 error_report("Can't resize an image which has snapshots");
2124 return -ENOTSUP;
2127 /* shrinking is currently not supported */
2128 if (offset < bs->total_sectors * 512) {
2129 error_report("qcow2 doesn't support shrinking images yet");
2130 return -ENOTSUP;
2133 new_l1_size = size_to_l1(s, offset);
2134 ret = qcow2_grow_l1_table(bs, new_l1_size, true);
2135 if (ret < 0) {
2136 return ret;
2139 /* write updated header.size */
2140 offset = cpu_to_be64(offset);
2141 ret = bdrv_pwrite_sync(bs->file, offsetof(QCowHeader, size),
2142 &offset, sizeof(uint64_t));
2143 if (ret < 0) {
2144 return ret;
2147 s->l1_vm_state_index = new_l1_size;
2148 return 0;
2151 /* XXX: put compressed sectors first, then all the cluster aligned
2152 tables to avoid losing bytes in alignment */
2153 static int qcow2_write_compressed(BlockDriverState *bs, int64_t sector_num,
2154 const uint8_t *buf, int nb_sectors)
2156 BDRVQcowState *s = bs->opaque;
2157 z_stream strm;
2158 int ret, out_len;
2159 uint8_t *out_buf;
2160 uint64_t cluster_offset;
2162 if (nb_sectors == 0) {
2163 /* align end of file to a sector boundary to ease reading with
2164 sector based I/Os */
2165 cluster_offset = bdrv_getlength(bs->file);
2166 return bdrv_truncate(bs->file, cluster_offset);
2169 if (nb_sectors != s->cluster_sectors) {
2170 ret = -EINVAL;
2172 /* Zero-pad last write if image size is not cluster aligned */
2173 if (sector_num + nb_sectors == bs->total_sectors &&
2174 nb_sectors < s->cluster_sectors) {
2175 uint8_t *pad_buf = qemu_blockalign(bs, s->cluster_size);
2176 memset(pad_buf, 0, s->cluster_size);
2177 memcpy(pad_buf, buf, nb_sectors * BDRV_SECTOR_SIZE);
2178 ret = qcow2_write_compressed(bs, sector_num,
2179 pad_buf, s->cluster_sectors);
2180 qemu_vfree(pad_buf);
2182 return ret;
2185 out_buf = g_malloc(s->cluster_size + (s->cluster_size / 1000) + 128);
2187 /* best compression, small window, no zlib header */
2188 memset(&strm, 0, sizeof(strm));
2189 ret = deflateInit2(&strm, Z_DEFAULT_COMPRESSION,
2190 Z_DEFLATED, -12,
2191 9, Z_DEFAULT_STRATEGY);
2192 if (ret != 0) {
2193 ret = -EINVAL;
2194 goto fail;
2197 strm.avail_in = s->cluster_size;
2198 strm.next_in = (uint8_t *)buf;
2199 strm.avail_out = s->cluster_size;
2200 strm.next_out = out_buf;
2202 ret = deflate(&strm, Z_FINISH);
2203 if (ret != Z_STREAM_END && ret != Z_OK) {
2204 deflateEnd(&strm);
2205 ret = -EINVAL;
2206 goto fail;
2208 out_len = strm.next_out - out_buf;
2210 deflateEnd(&strm);
2212 if (ret != Z_STREAM_END || out_len >= s->cluster_size) {
2213 /* could not compress: write normal cluster */
2214 ret = bdrv_write(bs, sector_num, buf, s->cluster_sectors);
2215 if (ret < 0) {
2216 goto fail;
2218 } else {
2219 cluster_offset = qcow2_alloc_compressed_cluster_offset(bs,
2220 sector_num << 9, out_len);
2221 if (!cluster_offset) {
2222 ret = -EIO;
2223 goto fail;
2225 cluster_offset &= s->cluster_offset_mask;
2227 ret = qcow2_pre_write_overlap_check(bs, 0, cluster_offset, out_len);
2228 if (ret < 0) {
2229 goto fail;
2232 BLKDBG_EVENT(bs->file, BLKDBG_WRITE_COMPRESSED);
2233 ret = bdrv_pwrite(bs->file, cluster_offset, out_buf, out_len);
2234 if (ret < 0) {
2235 goto fail;
2239 ret = 0;
2240 fail:
2241 g_free(out_buf);
2242 return ret;
2245 static int make_completely_empty(BlockDriverState *bs)
2247 BDRVQcowState *s = bs->opaque;
2248 int ret, l1_clusters;
2249 int64_t offset;
2250 uint64_t *new_reftable = NULL;
2251 uint64_t rt_entry, l1_size2;
2252 struct {
2253 uint64_t l1_offset;
2254 uint64_t reftable_offset;
2255 uint32_t reftable_clusters;
2256 } QEMU_PACKED l1_ofs_rt_ofs_cls;
2258 ret = qcow2_cache_empty(bs, s->l2_table_cache);
2259 if (ret < 0) {
2260 goto fail;
2263 ret = qcow2_cache_empty(bs, s->refcount_block_cache);
2264 if (ret < 0) {
2265 goto fail;
2268 /* Refcounts will be broken utterly */
2269 ret = qcow2_mark_dirty(bs);
2270 if (ret < 0) {
2271 goto fail;
2274 BLKDBG_EVENT(bs->file, BLKDBG_L1_UPDATE);
2276 l1_clusters = DIV_ROUND_UP(s->l1_size, s->cluster_size / sizeof(uint64_t));
2277 l1_size2 = (uint64_t)s->l1_size * sizeof(uint64_t);
2279 /* After this call, neither the in-memory nor the on-disk refcount
2280 * information accurately describe the actual references */
2282 ret = bdrv_write_zeroes(bs->file, s->l1_table_offset / BDRV_SECTOR_SIZE,
2283 l1_clusters * s->cluster_sectors, 0);
2284 if (ret < 0) {
2285 goto fail_broken_refcounts;
2287 memset(s->l1_table, 0, l1_size2);
2289 BLKDBG_EVENT(bs->file, BLKDBG_EMPTY_IMAGE_PREPARE);
2291 /* Overwrite enough clusters at the beginning of the sectors to place
2292 * the refcount table, a refcount block and the L1 table in; this may
2293 * overwrite parts of the existing refcount and L1 table, which is not
2294 * an issue because the dirty flag is set, complete data loss is in fact
2295 * desired and partial data loss is consequently fine as well */
2296 ret = bdrv_write_zeroes(bs->file, s->cluster_size / BDRV_SECTOR_SIZE,
2297 (2 + l1_clusters) * s->cluster_size /
2298 BDRV_SECTOR_SIZE, 0);
2299 /* This call (even if it failed overall) may have overwritten on-disk
2300 * refcount structures; in that case, the in-memory refcount information
2301 * will probably differ from the on-disk information which makes the BDS
2302 * unusable */
2303 if (ret < 0) {
2304 goto fail_broken_refcounts;
2307 BLKDBG_EVENT(bs->file, BLKDBG_L1_UPDATE);
2308 BLKDBG_EVENT(bs->file, BLKDBG_REFTABLE_UPDATE);
2310 /* "Create" an empty reftable (one cluster) directly after the image
2311 * header and an empty L1 table three clusters after the image header;
2312 * the cluster between those two will be used as the first refblock */
2313 cpu_to_be64w(&l1_ofs_rt_ofs_cls.l1_offset, 3 * s->cluster_size);
2314 cpu_to_be64w(&l1_ofs_rt_ofs_cls.reftable_offset, s->cluster_size);
2315 cpu_to_be32w(&l1_ofs_rt_ofs_cls.reftable_clusters, 1);
2316 ret = bdrv_pwrite_sync(bs->file, offsetof(QCowHeader, l1_table_offset),
2317 &l1_ofs_rt_ofs_cls, sizeof(l1_ofs_rt_ofs_cls));
2318 if (ret < 0) {
2319 goto fail_broken_refcounts;
2322 s->l1_table_offset = 3 * s->cluster_size;
2324 new_reftable = g_try_new0(uint64_t, s->cluster_size / sizeof(uint64_t));
2325 if (!new_reftable) {
2326 ret = -ENOMEM;
2327 goto fail_broken_refcounts;
2330 s->refcount_table_offset = s->cluster_size;
2331 s->refcount_table_size = s->cluster_size / sizeof(uint64_t);
2333 g_free(s->refcount_table);
2334 s->refcount_table = new_reftable;
2335 new_reftable = NULL;
2337 /* Now the in-memory refcount information again corresponds to the on-disk
2338 * information (reftable is empty and no refblocks (the refblock cache is
2339 * empty)); however, this means some clusters (e.g. the image header) are
2340 * referenced, but not refcounted, but the normal qcow2 code assumes that
2341 * the in-memory information is always correct */
2343 BLKDBG_EVENT(bs->file, BLKDBG_REFBLOCK_ALLOC);
2345 /* Enter the first refblock into the reftable */
2346 rt_entry = cpu_to_be64(2 * s->cluster_size);
2347 ret = bdrv_pwrite_sync(bs->file, s->cluster_size,
2348 &rt_entry, sizeof(rt_entry));
2349 if (ret < 0) {
2350 goto fail_broken_refcounts;
2352 s->refcount_table[0] = 2 * s->cluster_size;
2354 s->free_cluster_index = 0;
2355 assert(3 + l1_clusters <= s->refcount_block_size);
2356 offset = qcow2_alloc_clusters(bs, 3 * s->cluster_size + l1_size2);
2357 if (offset < 0) {
2358 ret = offset;
2359 goto fail_broken_refcounts;
2360 } else if (offset > 0) {
2361 error_report("First cluster in emptied image is in use");
2362 abort();
2365 /* Now finally the in-memory information corresponds to the on-disk
2366 * structures and is correct */
2367 ret = qcow2_mark_clean(bs);
2368 if (ret < 0) {
2369 goto fail;
2372 ret = bdrv_truncate(bs->file, (3 + l1_clusters) * s->cluster_size);
2373 if (ret < 0) {
2374 goto fail;
2377 return 0;
2379 fail_broken_refcounts:
2380 /* The BDS is unusable at this point. If we wanted to make it usable, we
2381 * would have to call qcow2_refcount_close(), qcow2_refcount_init(),
2382 * qcow2_check_refcounts(), qcow2_refcount_close() and qcow2_refcount_init()
2383 * again. However, because the functions which could have caused this error
2384 * path to be taken are used by those functions as well, it's very likely
2385 * that that sequence will fail as well. Therefore, just eject the BDS. */
2386 bs->drv = NULL;
2388 fail:
2389 g_free(new_reftable);
2390 return ret;
2393 static int qcow2_make_empty(BlockDriverState *bs)
2395 BDRVQcowState *s = bs->opaque;
2396 uint64_t start_sector;
2397 int sector_step = INT_MAX / BDRV_SECTOR_SIZE;
2398 int l1_clusters, ret = 0;
2400 l1_clusters = DIV_ROUND_UP(s->l1_size, s->cluster_size / sizeof(uint64_t));
2402 if (s->qcow_version >= 3 && !s->snapshots &&
2403 3 + l1_clusters <= s->refcount_block_size) {
2404 /* The following function only works for qcow2 v3 images (it requires
2405 * the dirty flag) and only as long as there are no snapshots (because
2406 * it completely empties the image). Furthermore, the L1 table and three
2407 * additional clusters (image header, refcount table, one refcount
2408 * block) have to fit inside one refcount block. */
2409 return make_completely_empty(bs);
2412 /* This fallback code simply discards every active cluster; this is slow,
2413 * but works in all cases */
2414 for (start_sector = 0; start_sector < bs->total_sectors;
2415 start_sector += sector_step)
2417 /* As this function is generally used after committing an external
2418 * snapshot, QCOW2_DISCARD_SNAPSHOT seems appropriate. Also, the
2419 * default action for this kind of discard is to pass the discard,
2420 * which will ideally result in an actually smaller image file, as
2421 * is probably desired. */
2422 ret = qcow2_discard_clusters(bs, start_sector * BDRV_SECTOR_SIZE,
2423 MIN(sector_step,
2424 bs->total_sectors - start_sector),
2425 QCOW2_DISCARD_SNAPSHOT, true);
2426 if (ret < 0) {
2427 break;
2431 return ret;
2434 static coroutine_fn int qcow2_co_flush_to_os(BlockDriverState *bs)
2436 BDRVQcowState *s = bs->opaque;
2437 int ret;
2439 qemu_co_mutex_lock(&s->lock);
2440 ret = qcow2_cache_flush(bs, s->l2_table_cache);
2441 if (ret < 0) {
2442 qemu_co_mutex_unlock(&s->lock);
2443 return ret;
2446 if (qcow2_need_accurate_refcounts(s)) {
2447 ret = qcow2_cache_flush(bs, s->refcount_block_cache);
2448 if (ret < 0) {
2449 qemu_co_mutex_unlock(&s->lock);
2450 return ret;
2453 qemu_co_mutex_unlock(&s->lock);
2455 return 0;
2458 static int qcow2_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
2460 BDRVQcowState *s = bs->opaque;
2461 bdi->unallocated_blocks_are_zero = true;
2462 bdi->can_write_zeroes_with_unmap = (s->qcow_version >= 3);
2463 bdi->cluster_size = s->cluster_size;
2464 bdi->vm_state_offset = qcow2_vm_state_offset(s);
2465 return 0;
2468 static ImageInfoSpecific *qcow2_get_specific_info(BlockDriverState *bs)
2470 BDRVQcowState *s = bs->opaque;
2471 ImageInfoSpecific *spec_info = g_new(ImageInfoSpecific, 1);
2473 *spec_info = (ImageInfoSpecific){
2474 .kind = IMAGE_INFO_SPECIFIC_KIND_QCOW2,
2476 .qcow2 = g_new(ImageInfoSpecificQCow2, 1),
2479 if (s->qcow_version == 2) {
2480 *spec_info->qcow2 = (ImageInfoSpecificQCow2){
2481 .compat = g_strdup("0.10"),
2483 } else if (s->qcow_version == 3) {
2484 *spec_info->qcow2 = (ImageInfoSpecificQCow2){
2485 .compat = g_strdup("1.1"),
2486 .lazy_refcounts = s->compatible_features &
2487 QCOW2_COMPAT_LAZY_REFCOUNTS,
2488 .has_lazy_refcounts = true,
2489 .corrupt = s->incompatible_features &
2490 QCOW2_INCOMPAT_CORRUPT,
2491 .has_corrupt = true,
2495 return spec_info;
2498 #if 0
2499 static void dump_refcounts(BlockDriverState *bs)
2501 BDRVQcowState *s = bs->opaque;
2502 int64_t nb_clusters, k, k1, size;
2503 int refcount;
2505 size = bdrv_getlength(bs->file);
2506 nb_clusters = size_to_clusters(s, size);
2507 for(k = 0; k < nb_clusters;) {
2508 k1 = k;
2509 refcount = get_refcount(bs, k);
2510 k++;
2511 while (k < nb_clusters && get_refcount(bs, k) == refcount)
2512 k++;
2513 printf("%" PRId64 ": refcount=%d nb=%" PRId64 "\n", k, refcount,
2514 k - k1);
2517 #endif
2519 static int qcow2_save_vmstate(BlockDriverState *bs, QEMUIOVector *qiov,
2520 int64_t pos)
2522 BDRVQcowState *s = bs->opaque;
2523 int64_t total_sectors = bs->total_sectors;
2524 int growable = bs->growable;
2525 bool zero_beyond_eof = bs->zero_beyond_eof;
2526 int ret;
2528 BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_SAVE);
2529 bs->growable = 1;
2530 bs->zero_beyond_eof = false;
2531 ret = bdrv_pwritev(bs, qcow2_vm_state_offset(s) + pos, qiov);
2532 bs->growable = growable;
2533 bs->zero_beyond_eof = zero_beyond_eof;
2535 /* bdrv_co_do_writev will have increased the total_sectors value to include
2536 * the VM state - the VM state is however not an actual part of the block
2537 * device, therefore, we need to restore the old value. */
2538 bs->total_sectors = total_sectors;
2540 return ret;
2543 static int qcow2_load_vmstate(BlockDriverState *bs, uint8_t *buf,
2544 int64_t pos, int size)
2546 BDRVQcowState *s = bs->opaque;
2547 int growable = bs->growable;
2548 bool zero_beyond_eof = bs->zero_beyond_eof;
2549 int ret;
2551 BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_LOAD);
2552 bs->growable = 1;
2553 bs->zero_beyond_eof = false;
2554 ret = bdrv_pread(bs, qcow2_vm_state_offset(s) + pos, buf, size);
2555 bs->growable = growable;
2556 bs->zero_beyond_eof = zero_beyond_eof;
2558 return ret;
2562 * Downgrades an image's version. To achieve this, any incompatible features
2563 * have to be removed.
2565 static int qcow2_downgrade(BlockDriverState *bs, int target_version,
2566 BlockDriverAmendStatusCB *status_cb)
2568 BDRVQcowState *s = bs->opaque;
2569 int current_version = s->qcow_version;
2570 int ret;
2572 if (target_version == current_version) {
2573 return 0;
2574 } else if (target_version > current_version) {
2575 return -EINVAL;
2576 } else if (target_version != 2) {
2577 return -EINVAL;
2580 if (s->refcount_order != 4) {
2581 /* we would have to convert the image to a refcount_order == 4 image
2582 * here; however, since qemu (at the time of writing this) does not
2583 * support anything different than 4 anyway, there is no point in doing
2584 * so right now; however, we should error out (if qemu supports this in
2585 * the future and this code has not been adapted) */
2586 error_report("qcow2_downgrade: Image refcount orders other than 4 are "
2587 "currently not supported.");
2588 return -ENOTSUP;
2591 /* clear incompatible features */
2592 if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) {
2593 ret = qcow2_mark_clean(bs);
2594 if (ret < 0) {
2595 return ret;
2599 /* with QCOW2_INCOMPAT_CORRUPT, it is pretty much impossible to get here in
2600 * the first place; if that happens nonetheless, returning -ENOTSUP is the
2601 * best thing to do anyway */
2603 if (s->incompatible_features) {
2604 return -ENOTSUP;
2607 /* since we can ignore compatible features, we can set them to 0 as well */
2608 s->compatible_features = 0;
2609 /* if lazy refcounts have been used, they have already been fixed through
2610 * clearing the dirty flag */
2612 /* clearing autoclear features is trivial */
2613 s->autoclear_features = 0;
2615 ret = qcow2_expand_zero_clusters(bs, status_cb);
2616 if (ret < 0) {
2617 return ret;
2620 s->qcow_version = target_version;
2621 ret = qcow2_update_header(bs);
2622 if (ret < 0) {
2623 s->qcow_version = current_version;
2624 return ret;
2626 return 0;
2629 static int qcow2_amend_options(BlockDriverState *bs, QemuOpts *opts,
2630 BlockDriverAmendStatusCB *status_cb)
2632 BDRVQcowState *s = bs->opaque;
2633 int old_version = s->qcow_version, new_version = old_version;
2634 uint64_t new_size = 0;
2635 const char *backing_file = NULL, *backing_format = NULL;
2636 bool lazy_refcounts = s->use_lazy_refcounts;
2637 const char *compat = NULL;
2638 uint64_t cluster_size = s->cluster_size;
2639 bool encrypt;
2640 int ret;
2641 QemuOptDesc *desc = opts->list->desc;
2643 while (desc && desc->name) {
2644 if (!qemu_opt_find(opts, desc->name)) {
2645 /* only change explicitly defined options */
2646 desc++;
2647 continue;
2650 if (!strcmp(desc->name, "compat")) {
2651 compat = qemu_opt_get(opts, "compat");
2652 if (!compat) {
2653 /* preserve default */
2654 } else if (!strcmp(compat, "0.10")) {
2655 new_version = 2;
2656 } else if (!strcmp(compat, "1.1")) {
2657 new_version = 3;
2658 } else {
2659 fprintf(stderr, "Unknown compatibility level %s.\n", compat);
2660 return -EINVAL;
2662 } else if (!strcmp(desc->name, "preallocation")) {
2663 fprintf(stderr, "Cannot change preallocation mode.\n");
2664 return -ENOTSUP;
2665 } else if (!strcmp(desc->name, "size")) {
2666 new_size = qemu_opt_get_size(opts, "size", 0);
2667 } else if (!strcmp(desc->name, "backing_file")) {
2668 backing_file = qemu_opt_get(opts, "backing_file");
2669 } else if (!strcmp(desc->name, "backing_fmt")) {
2670 backing_format = qemu_opt_get(opts, "backing_fmt");
2671 } else if (!strcmp(desc->name, "encryption")) {
2672 encrypt = qemu_opt_get_bool(opts, "encryption", s->crypt_method);
2673 if (encrypt != !!s->crypt_method) {
2674 fprintf(stderr, "Changing the encryption flag is not "
2675 "supported.\n");
2676 return -ENOTSUP;
2678 } else if (!strcmp(desc->name, "cluster_size")) {
2679 cluster_size = qemu_opt_get_size(opts, "cluster_size",
2680 cluster_size);
2681 if (cluster_size != s->cluster_size) {
2682 fprintf(stderr, "Changing the cluster size is not "
2683 "supported.\n");
2684 return -ENOTSUP;
2686 } else if (!strcmp(desc->name, "lazy_refcounts")) {
2687 lazy_refcounts = qemu_opt_get_bool(opts, "lazy_refcounts",
2688 lazy_refcounts);
2689 } else {
2690 /* if this assertion fails, this probably means a new option was
2691 * added without having it covered here */
2692 assert(false);
2695 desc++;
2698 if (new_version != old_version) {
2699 if (new_version > old_version) {
2700 /* Upgrade */
2701 s->qcow_version = new_version;
2702 ret = qcow2_update_header(bs);
2703 if (ret < 0) {
2704 s->qcow_version = old_version;
2705 return ret;
2707 } else {
2708 ret = qcow2_downgrade(bs, new_version, status_cb);
2709 if (ret < 0) {
2710 return ret;
2715 if (backing_file || backing_format) {
2716 ret = qcow2_change_backing_file(bs, backing_file ?: bs->backing_file,
2717 backing_format ?: bs->backing_format);
2718 if (ret < 0) {
2719 return ret;
2723 if (s->use_lazy_refcounts != lazy_refcounts) {
2724 if (lazy_refcounts) {
2725 if (s->qcow_version < 3) {
2726 fprintf(stderr, "Lazy refcounts only supported with compatibility "
2727 "level 1.1 and above (use compat=1.1 or greater)\n");
2728 return -EINVAL;
2730 s->compatible_features |= QCOW2_COMPAT_LAZY_REFCOUNTS;
2731 ret = qcow2_update_header(bs);
2732 if (ret < 0) {
2733 s->compatible_features &= ~QCOW2_COMPAT_LAZY_REFCOUNTS;
2734 return ret;
2736 s->use_lazy_refcounts = true;
2737 } else {
2738 /* make image clean first */
2739 ret = qcow2_mark_clean(bs);
2740 if (ret < 0) {
2741 return ret;
2743 /* now disallow lazy refcounts */
2744 s->compatible_features &= ~QCOW2_COMPAT_LAZY_REFCOUNTS;
2745 ret = qcow2_update_header(bs);
2746 if (ret < 0) {
2747 s->compatible_features |= QCOW2_COMPAT_LAZY_REFCOUNTS;
2748 return ret;
2750 s->use_lazy_refcounts = false;
2754 if (new_size) {
2755 ret = bdrv_truncate(bs, new_size);
2756 if (ret < 0) {
2757 return ret;
2761 return 0;
2765 * If offset or size are negative, respectively, they will not be included in
2766 * the BLOCK_IMAGE_CORRUPTED event emitted.
2767 * fatal will be ignored for read-only BDS; corruptions found there will always
2768 * be considered non-fatal.
2770 void qcow2_signal_corruption(BlockDriverState *bs, bool fatal, int64_t offset,
2771 int64_t size, const char *message_format, ...)
2773 BDRVQcowState *s = bs->opaque;
2774 char *message;
2775 va_list ap;
2777 fatal = fatal && !bs->read_only;
2779 if (s->signaled_corruption &&
2780 (!fatal || (s->incompatible_features & QCOW2_INCOMPAT_CORRUPT)))
2782 return;
2785 va_start(ap, message_format);
2786 message = g_strdup_vprintf(message_format, ap);
2787 va_end(ap);
2789 if (fatal) {
2790 fprintf(stderr, "qcow2: Marking image as corrupt: %s; further "
2791 "corruption events will be suppressed\n", message);
2792 } else {
2793 fprintf(stderr, "qcow2: Image is corrupt: %s; further non-fatal "
2794 "corruption events will be suppressed\n", message);
2797 qapi_event_send_block_image_corrupted(bdrv_get_device_name(bs), message,
2798 offset >= 0, offset, size >= 0, size,
2799 fatal, &error_abort);
2800 g_free(message);
2802 if (fatal) {
2803 qcow2_mark_corrupt(bs);
2804 bs->drv = NULL; /* make BDS unusable */
2807 s->signaled_corruption = true;
2810 static QemuOptsList qcow2_create_opts = {
2811 .name = "qcow2-create-opts",
2812 .head = QTAILQ_HEAD_INITIALIZER(qcow2_create_opts.head),
2813 .desc = {
2815 .name = BLOCK_OPT_SIZE,
2816 .type = QEMU_OPT_SIZE,
2817 .help = "Virtual disk size"
2820 .name = BLOCK_OPT_COMPAT_LEVEL,
2821 .type = QEMU_OPT_STRING,
2822 .help = "Compatibility level (0.10 or 1.1)"
2825 .name = BLOCK_OPT_BACKING_FILE,
2826 .type = QEMU_OPT_STRING,
2827 .help = "File name of a base image"
2830 .name = BLOCK_OPT_BACKING_FMT,
2831 .type = QEMU_OPT_STRING,
2832 .help = "Image format of the base image"
2835 .name = BLOCK_OPT_ENCRYPT,
2836 .type = QEMU_OPT_BOOL,
2837 .help = "Encrypt the image",
2838 .def_value_str = "off"
2841 .name = BLOCK_OPT_CLUSTER_SIZE,
2842 .type = QEMU_OPT_SIZE,
2843 .help = "qcow2 cluster size",
2844 .def_value_str = stringify(DEFAULT_CLUSTER_SIZE)
2847 .name = BLOCK_OPT_PREALLOC,
2848 .type = QEMU_OPT_STRING,
2849 .help = "Preallocation mode (allowed values: off, metadata, "
2850 "falloc, full)"
2853 .name = BLOCK_OPT_LAZY_REFCOUNTS,
2854 .type = QEMU_OPT_BOOL,
2855 .help = "Postpone refcount updates",
2856 .def_value_str = "off"
2858 { /* end of list */ }
2862 BlockDriver bdrv_qcow2 = {
2863 .format_name = "qcow2",
2864 .instance_size = sizeof(BDRVQcowState),
2865 .bdrv_probe = qcow2_probe,
2866 .bdrv_open = qcow2_open,
2867 .bdrv_close = qcow2_close,
2868 .bdrv_reopen_prepare = qcow2_reopen_prepare,
2869 .bdrv_create = qcow2_create,
2870 .bdrv_has_zero_init = bdrv_has_zero_init_1,
2871 .bdrv_co_get_block_status = qcow2_co_get_block_status,
2872 .bdrv_set_key = qcow2_set_key,
2874 .bdrv_co_readv = qcow2_co_readv,
2875 .bdrv_co_writev = qcow2_co_writev,
2876 .bdrv_co_flush_to_os = qcow2_co_flush_to_os,
2878 .bdrv_co_write_zeroes = qcow2_co_write_zeroes,
2879 .bdrv_co_discard = qcow2_co_discard,
2880 .bdrv_truncate = qcow2_truncate,
2881 .bdrv_write_compressed = qcow2_write_compressed,
2882 .bdrv_make_empty = qcow2_make_empty,
2884 .bdrv_snapshot_create = qcow2_snapshot_create,
2885 .bdrv_snapshot_goto = qcow2_snapshot_goto,
2886 .bdrv_snapshot_delete = qcow2_snapshot_delete,
2887 .bdrv_snapshot_list = qcow2_snapshot_list,
2888 .bdrv_snapshot_load_tmp = qcow2_snapshot_load_tmp,
2889 .bdrv_get_info = qcow2_get_info,
2890 .bdrv_get_specific_info = qcow2_get_specific_info,
2892 .bdrv_save_vmstate = qcow2_save_vmstate,
2893 .bdrv_load_vmstate = qcow2_load_vmstate,
2895 .supports_backing = true,
2896 .bdrv_change_backing_file = qcow2_change_backing_file,
2898 .bdrv_refresh_limits = qcow2_refresh_limits,
2899 .bdrv_invalidate_cache = qcow2_invalidate_cache,
2901 .create_opts = &qcow2_create_opts,
2902 .bdrv_check = qcow2_check,
2903 .bdrv_amend_options = qcow2_amend_options,
2906 static void bdrv_qcow2_init(void)
2908 bdrv_register(&bdrv_qcow2);
2911 block_init(bdrv_qcow2_init);