xref: /qemu/block/qcow2.c (revision 9a29e18f7dfd5a0e80d1c60fc856ebba18ddb738)
1585f8587Sbellard /*
2585f8587Sbellard  * Block driver for the QCOW version 2 format
3585f8587Sbellard  *
4585f8587Sbellard  * Copyright (c) 2004-2006 Fabrice Bellard
5585f8587Sbellard  *
6585f8587Sbellard  * Permission is hereby granted, free of charge, to any person obtaining a copy
7585f8587Sbellard  * of this software and associated documentation files (the "Software"), to deal
8585f8587Sbellard  * in the Software without restriction, including without limitation the rights
9585f8587Sbellard  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10585f8587Sbellard  * copies of the Software, and to permit persons to whom the Software is
11585f8587Sbellard  * furnished to do so, subject to the following conditions:
12585f8587Sbellard  *
13585f8587Sbellard  * The above copyright notice and this permission notice shall be included in
14585f8587Sbellard  * all copies or substantial portions of the Software.
15585f8587Sbellard  *
16585f8587Sbellard  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17585f8587Sbellard  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18585f8587Sbellard  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19585f8587Sbellard  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20585f8587Sbellard  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21585f8587Sbellard  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22585f8587Sbellard  * THE SOFTWARE.
23585f8587Sbellard  */
24faf07963Spbrook #include "qemu-common.h"
25737e150eSPaolo Bonzini #include "block/block_int.h"
261de7afc9SPaolo Bonzini #include "qemu/module.h"
27585f8587Sbellard #include <zlib.h>
28753d9b82SAurelien Jarno #include "qemu/aes.h"
29f7d0fe02SKevin Wolf #include "block/qcow2.h"
301de7afc9SPaolo Bonzini #include "qemu/error-report.h"
317b1b5d19SPaolo Bonzini #include "qapi/qmp/qerror.h"
32acdfb480SKevin Wolf #include "qapi/qmp/qbool.h"
33ffeaac9bSHu Tao #include "qapi/util.h"
3485186ebdSMax Reitz #include "qapi/qmp/types.h"
3585186ebdSMax Reitz #include "qapi-event.h"
363cce16f4SKevin Wolf #include "trace.h"
371bd0e2d1SChunyan Liu #include "qemu/option_int.h"
38585f8587Sbellard 
39585f8587Sbellard /*
40585f8587Sbellard   Differences with QCOW:
41585f8587Sbellard 
42585f8587Sbellard   - Support for multiple incremental snapshots.
43585f8587Sbellard   - Memory management by reference counts.
44585f8587Sbellard   - Clusters which have a reference count of one have the bit
45585f8587Sbellard     QCOW_OFLAG_COPIED to optimize write performance.
46585f8587Sbellard   - Size of compressed clusters is stored in sectors to reduce bit usage
47585f8587Sbellard     in the cluster offsets.
48585f8587Sbellard   - Support for storing additional data (such as the VM state) in the
49585f8587Sbellard     snapshots.
50585f8587Sbellard   - If a backing store is used, the cluster size is not constrained
51585f8587Sbellard     (could be backported to QCOW).
52585f8587Sbellard   - L2 tables have always a size of one cluster.
53585f8587Sbellard */
54585f8587Sbellard 
559b80ddf3Saliguori 
569b80ddf3Saliguori typedef struct {
579b80ddf3Saliguori     uint32_t magic;
589b80ddf3Saliguori     uint32_t len;
59c4217f64SJeff Cody } QEMU_PACKED QCowExtension;
6021d82ac9SJeff Cody 
617c80ab3fSJes Sorensen #define  QCOW2_EXT_MAGIC_END 0
627c80ab3fSJes Sorensen #define  QCOW2_EXT_MAGIC_BACKING_FORMAT 0xE2792ACA
63cfcc4c62SKevin Wolf #define  QCOW2_EXT_MAGIC_FEATURE_TABLE 0x6803f857
649b80ddf3Saliguori 
657c80ab3fSJes Sorensen static int qcow2_probe(const uint8_t *buf, int buf_size, const char *filename)
66585f8587Sbellard {
67585f8587Sbellard     const QCowHeader *cow_header = (const void *)buf;
68585f8587Sbellard 
69585f8587Sbellard     if (buf_size >= sizeof(QCowHeader) &&
70585f8587Sbellard         be32_to_cpu(cow_header->magic) == QCOW_MAGIC &&
716744cbabSKevin Wolf         be32_to_cpu(cow_header->version) >= 2)
72585f8587Sbellard         return 100;
73585f8587Sbellard     else
74585f8587Sbellard         return 0;
75585f8587Sbellard }
76585f8587Sbellard 
779b80ddf3Saliguori 
789b80ddf3Saliguori /*
799b80ddf3Saliguori  * read qcow2 extension and fill bs
809b80ddf3Saliguori  * start reading from start_offset
819b80ddf3Saliguori  * finish reading upon magic of value 0 or when end_offset reached
829b80ddf3Saliguori  * unknown magic is skipped (future extension this version knows nothing about)
839b80ddf3Saliguori  * return 0 upon success, non-0 otherwise
849b80ddf3Saliguori  */
857c80ab3fSJes Sorensen static int qcow2_read_extensions(BlockDriverState *bs, uint64_t start_offset,
863ef6c40aSMax Reitz                                  uint64_t end_offset, void **p_feature_table,
873ef6c40aSMax Reitz                                  Error **errp)
889b80ddf3Saliguori {
8975bab85cSKevin Wolf     BDRVQcowState *s = bs->opaque;
909b80ddf3Saliguori     QCowExtension ext;
919b80ddf3Saliguori     uint64_t offset;
9275bab85cSKevin Wolf     int ret;
939b80ddf3Saliguori 
949b80ddf3Saliguori #ifdef DEBUG_EXT
957c80ab3fSJes Sorensen     printf("qcow2_read_extensions: start=%ld end=%ld\n", start_offset, end_offset);
969b80ddf3Saliguori #endif
979b80ddf3Saliguori     offset = start_offset;
989b80ddf3Saliguori     while (offset < end_offset) {
999b80ddf3Saliguori 
1009b80ddf3Saliguori #ifdef DEBUG_EXT
1019b80ddf3Saliguori         /* Sanity check */
1029b80ddf3Saliguori         if (offset > s->cluster_size)
1037c80ab3fSJes Sorensen             printf("qcow2_read_extension: suspicious offset %lu\n", offset);
1049b80ddf3Saliguori 
1059b2260cbSDong Xu Wang         printf("attempting to read extended header in offset %lu\n", offset);
1069b80ddf3Saliguori #endif
1079b80ddf3Saliguori 
1083ef6c40aSMax Reitz         ret = bdrv_pread(bs->file, offset, &ext, sizeof(ext));
1093ef6c40aSMax Reitz         if (ret < 0) {
1103ef6c40aSMax Reitz             error_setg_errno(errp, -ret, "qcow2_read_extension: ERROR: "
1113ef6c40aSMax Reitz                              "pread fail from offset %" PRIu64, offset);
1129b80ddf3Saliguori             return 1;
1139b80ddf3Saliguori         }
1149b80ddf3Saliguori         be32_to_cpus(&ext.magic);
1159b80ddf3Saliguori         be32_to_cpus(&ext.len);
1169b80ddf3Saliguori         offset += sizeof(ext);
1179b80ddf3Saliguori #ifdef DEBUG_EXT
1189b80ddf3Saliguori         printf("ext.magic = 0x%x\n", ext.magic);
1199b80ddf3Saliguori #endif
1202ebafc85SKevin Wolf         if (offset > end_offset || ext.len > end_offset - offset) {
1213ef6c40aSMax Reitz             error_setg(errp, "Header extension too large");
12264ca6aeeSKevin Wolf             return -EINVAL;
12364ca6aeeSKevin Wolf         }
12464ca6aeeSKevin Wolf 
1259b80ddf3Saliguori         switch (ext.magic) {
1267c80ab3fSJes Sorensen         case QCOW2_EXT_MAGIC_END:
1279b80ddf3Saliguori             return 0;
128f965509cSaliguori 
1297c80ab3fSJes Sorensen         case QCOW2_EXT_MAGIC_BACKING_FORMAT:
130f965509cSaliguori             if (ext.len >= sizeof(bs->backing_format)) {
131521b2b5dSMax Reitz                 error_setg(errp, "ERROR: ext_backing_format: len=%" PRIu32
132521b2b5dSMax Reitz                            " too large (>=%zu)", ext.len,
133521b2b5dSMax Reitz                            sizeof(bs->backing_format));
134f965509cSaliguori                 return 2;
135f965509cSaliguori             }
1363ef6c40aSMax Reitz             ret = bdrv_pread(bs->file, offset, bs->backing_format, ext.len);
1373ef6c40aSMax Reitz             if (ret < 0) {
1383ef6c40aSMax Reitz                 error_setg_errno(errp, -ret, "ERROR: ext_backing_format: "
1393ef6c40aSMax Reitz                                  "Could not read format name");
140f965509cSaliguori                 return 3;
1413ef6c40aSMax Reitz             }
142f965509cSaliguori             bs->backing_format[ext.len] = '\0';
143f965509cSaliguori #ifdef DEBUG_EXT
144f965509cSaliguori             printf("Qcow2: Got format extension %s\n", bs->backing_format);
145f965509cSaliguori #endif
146f965509cSaliguori             break;
147f965509cSaliguori 
148cfcc4c62SKevin Wolf         case QCOW2_EXT_MAGIC_FEATURE_TABLE:
149cfcc4c62SKevin Wolf             if (p_feature_table != NULL) {
150cfcc4c62SKevin Wolf                 void* feature_table = g_malloc0(ext.len + 2 * sizeof(Qcow2Feature));
151cfcc4c62SKevin Wolf                 ret = bdrv_pread(bs->file, offset , feature_table, ext.len);
152cfcc4c62SKevin Wolf                 if (ret < 0) {
1533ef6c40aSMax Reitz                     error_setg_errno(errp, -ret, "ERROR: ext_feature_table: "
1543ef6c40aSMax Reitz                                      "Could not read table");
155cfcc4c62SKevin Wolf                     return ret;
156cfcc4c62SKevin Wolf                 }
157cfcc4c62SKevin Wolf 
158cfcc4c62SKevin Wolf                 *p_feature_table = feature_table;
159cfcc4c62SKevin Wolf             }
160cfcc4c62SKevin Wolf             break;
161cfcc4c62SKevin Wolf 
1629b80ddf3Saliguori         default:
16375bab85cSKevin Wolf             /* unknown magic - save it in case we need to rewrite the header */
16475bab85cSKevin Wolf             {
16575bab85cSKevin Wolf                 Qcow2UnknownHeaderExtension *uext;
16675bab85cSKevin Wolf 
16775bab85cSKevin Wolf                 uext = g_malloc0(sizeof(*uext)  + ext.len);
16875bab85cSKevin Wolf                 uext->magic = ext.magic;
16975bab85cSKevin Wolf                 uext->len = ext.len;
17075bab85cSKevin Wolf                 QLIST_INSERT_HEAD(&s->unknown_header_ext, uext, next);
17175bab85cSKevin Wolf 
17275bab85cSKevin Wolf                 ret = bdrv_pread(bs->file, offset , uext->data, uext->len);
17375bab85cSKevin Wolf                 if (ret < 0) {
1743ef6c40aSMax Reitz                     error_setg_errno(errp, -ret, "ERROR: unknown extension: "
1753ef6c40aSMax Reitz                                      "Could not read data");
17675bab85cSKevin Wolf                     return ret;
17775bab85cSKevin Wolf                 }
17875bab85cSKevin Wolf             }
1799b80ddf3Saliguori             break;
1809b80ddf3Saliguori         }
181fd29b4bbSKevin Wolf 
182fd29b4bbSKevin Wolf         offset += ((ext.len + 7) & ~7);
1839b80ddf3Saliguori     }
1849b80ddf3Saliguori 
1859b80ddf3Saliguori     return 0;
1869b80ddf3Saliguori }
1879b80ddf3Saliguori 
18875bab85cSKevin Wolf static void cleanup_unknown_header_ext(BlockDriverState *bs)
18975bab85cSKevin Wolf {
19075bab85cSKevin Wolf     BDRVQcowState *s = bs->opaque;
19175bab85cSKevin Wolf     Qcow2UnknownHeaderExtension *uext, *next;
19275bab85cSKevin Wolf 
19375bab85cSKevin Wolf     QLIST_FOREACH_SAFE(uext, &s->unknown_header_ext, next, next) {
19475bab85cSKevin Wolf         QLIST_REMOVE(uext, next);
19575bab85cSKevin Wolf         g_free(uext);
19675bab85cSKevin Wolf     }
19775bab85cSKevin Wolf }
1989b80ddf3Saliguori 
1993ef6c40aSMax Reitz static void GCC_FMT_ATTR(3, 4) report_unsupported(BlockDriverState *bs,
2003ef6c40aSMax Reitz     Error **errp, const char *fmt, ...)
2016744cbabSKevin Wolf {
2026744cbabSKevin Wolf     char msg[64];
2036744cbabSKevin Wolf     va_list ap;
2046744cbabSKevin Wolf 
2056744cbabSKevin Wolf     va_start(ap, fmt);
2066744cbabSKevin Wolf     vsnprintf(msg, sizeof(msg), fmt, ap);
2076744cbabSKevin Wolf     va_end(ap);
2086744cbabSKevin Wolf 
209bfb197e0SMarkus Armbruster     error_set(errp, QERR_UNKNOWN_BLOCK_FORMAT_FEATURE,
210bfb197e0SMarkus Armbruster               bdrv_get_device_name(bs), "qcow2", msg);
2116744cbabSKevin Wolf }
2126744cbabSKevin Wolf 
213cfcc4c62SKevin Wolf static void report_unsupported_feature(BlockDriverState *bs,
2143ef6c40aSMax Reitz     Error **errp, Qcow2Feature *table, uint64_t mask)
215cfcc4c62SKevin Wolf {
21612ac6d3dSKevin Wolf     char *features = g_strdup("");
21712ac6d3dSKevin Wolf     char *old;
21812ac6d3dSKevin Wolf 
219cfcc4c62SKevin Wolf     while (table && table->name[0] != '\0') {
220cfcc4c62SKevin Wolf         if (table->type == QCOW2_FEAT_TYPE_INCOMPATIBLE) {
22112ac6d3dSKevin Wolf             if (mask & (1ULL << table->bit)) {
22212ac6d3dSKevin Wolf                 old = features;
22312ac6d3dSKevin Wolf                 features = g_strdup_printf("%s%s%.46s", old, *old ? ", " : "",
22412ac6d3dSKevin Wolf                                            table->name);
22512ac6d3dSKevin Wolf                 g_free(old);
22612ac6d3dSKevin Wolf                 mask &= ~(1ULL << table->bit);
227cfcc4c62SKevin Wolf             }
228cfcc4c62SKevin Wolf         }
229cfcc4c62SKevin Wolf         table++;
230cfcc4c62SKevin Wolf     }
231cfcc4c62SKevin Wolf 
232cfcc4c62SKevin Wolf     if (mask) {
23312ac6d3dSKevin Wolf         old = features;
23412ac6d3dSKevin Wolf         features = g_strdup_printf("%s%sUnknown incompatible feature: %" PRIx64,
23512ac6d3dSKevin Wolf                                    old, *old ? ", " : "", mask);
23612ac6d3dSKevin Wolf         g_free(old);
237cfcc4c62SKevin Wolf     }
23812ac6d3dSKevin Wolf 
23912ac6d3dSKevin Wolf     report_unsupported(bs, errp, "%s", features);
24012ac6d3dSKevin Wolf     g_free(features);
241cfcc4c62SKevin Wolf }
242cfcc4c62SKevin Wolf 
243c61d0004SStefan Hajnoczi /*
244bfe8043eSStefan Hajnoczi  * Sets the dirty bit and flushes afterwards if necessary.
245bfe8043eSStefan Hajnoczi  *
246bfe8043eSStefan Hajnoczi  * The incompatible_features bit is only set if the image file header was
247bfe8043eSStefan Hajnoczi  * updated successfully.  Therefore it is not required to check the return
248bfe8043eSStefan Hajnoczi  * value of this function.
249bfe8043eSStefan Hajnoczi  */
250280d3735SKevin Wolf int qcow2_mark_dirty(BlockDriverState *bs)
251bfe8043eSStefan Hajnoczi {
252bfe8043eSStefan Hajnoczi     BDRVQcowState *s = bs->opaque;
253bfe8043eSStefan Hajnoczi     uint64_t val;
254bfe8043eSStefan Hajnoczi     int ret;
255bfe8043eSStefan Hajnoczi 
256bfe8043eSStefan Hajnoczi     assert(s->qcow_version >= 3);
257bfe8043eSStefan Hajnoczi 
258bfe8043eSStefan Hajnoczi     if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) {
259bfe8043eSStefan Hajnoczi         return 0; /* already dirty */
260bfe8043eSStefan Hajnoczi     }
261bfe8043eSStefan Hajnoczi 
262bfe8043eSStefan Hajnoczi     val = cpu_to_be64(s->incompatible_features | QCOW2_INCOMPAT_DIRTY);
263bfe8043eSStefan Hajnoczi     ret = bdrv_pwrite(bs->file, offsetof(QCowHeader, incompatible_features),
264bfe8043eSStefan Hajnoczi                       &val, sizeof(val));
265bfe8043eSStefan Hajnoczi     if (ret < 0) {
266bfe8043eSStefan Hajnoczi         return ret;
267bfe8043eSStefan Hajnoczi     }
268bfe8043eSStefan Hajnoczi     ret = bdrv_flush(bs->file);
269bfe8043eSStefan Hajnoczi     if (ret < 0) {
270bfe8043eSStefan Hajnoczi         return ret;
271bfe8043eSStefan Hajnoczi     }
272bfe8043eSStefan Hajnoczi 
273bfe8043eSStefan Hajnoczi     /* Only treat image as dirty if the header was updated successfully */
274bfe8043eSStefan Hajnoczi     s->incompatible_features |= QCOW2_INCOMPAT_DIRTY;
275bfe8043eSStefan Hajnoczi     return 0;
276bfe8043eSStefan Hajnoczi }
277bfe8043eSStefan Hajnoczi 
278bfe8043eSStefan Hajnoczi /*
279c61d0004SStefan Hajnoczi  * Clears the dirty bit and flushes before if necessary.  Only call this
280c61d0004SStefan Hajnoczi  * function when there are no pending requests, it does not guard against
281c61d0004SStefan Hajnoczi  * concurrent requests dirtying the image.
282c61d0004SStefan Hajnoczi  */
283c61d0004SStefan Hajnoczi static int qcow2_mark_clean(BlockDriverState *bs)
284c61d0004SStefan Hajnoczi {
285c61d0004SStefan Hajnoczi     BDRVQcowState *s = bs->opaque;
286c61d0004SStefan Hajnoczi 
287c61d0004SStefan Hajnoczi     if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) {
2884c2e5f8fSKevin Wolf         int ret;
2894c2e5f8fSKevin Wolf 
2904c2e5f8fSKevin Wolf         s->incompatible_features &= ~QCOW2_INCOMPAT_DIRTY;
2914c2e5f8fSKevin Wolf 
2924c2e5f8fSKevin Wolf         ret = bdrv_flush(bs);
293c61d0004SStefan Hajnoczi         if (ret < 0) {
294c61d0004SStefan Hajnoczi             return ret;
295c61d0004SStefan Hajnoczi         }
296c61d0004SStefan Hajnoczi 
297c61d0004SStefan Hajnoczi         return qcow2_update_header(bs);
298c61d0004SStefan Hajnoczi     }
299c61d0004SStefan Hajnoczi     return 0;
300c61d0004SStefan Hajnoczi }
301c61d0004SStefan Hajnoczi 
30269c98726SMax Reitz /*
30369c98726SMax Reitz  * Marks the image as corrupt.
30469c98726SMax Reitz  */
30569c98726SMax Reitz int qcow2_mark_corrupt(BlockDriverState *bs)
30669c98726SMax Reitz {
30769c98726SMax Reitz     BDRVQcowState *s = bs->opaque;
30869c98726SMax Reitz 
30969c98726SMax Reitz     s->incompatible_features |= QCOW2_INCOMPAT_CORRUPT;
31069c98726SMax Reitz     return qcow2_update_header(bs);
31169c98726SMax Reitz }
31269c98726SMax Reitz 
31369c98726SMax Reitz /*
31469c98726SMax Reitz  * Marks the image as consistent, i.e., unsets the corrupt bit, and flushes
31569c98726SMax Reitz  * before if necessary.
31669c98726SMax Reitz  */
31769c98726SMax Reitz int qcow2_mark_consistent(BlockDriverState *bs)
31869c98726SMax Reitz {
31969c98726SMax Reitz     BDRVQcowState *s = bs->opaque;
32069c98726SMax Reitz 
32169c98726SMax Reitz     if (s->incompatible_features & QCOW2_INCOMPAT_CORRUPT) {
32269c98726SMax Reitz         int ret = bdrv_flush(bs);
32369c98726SMax Reitz         if (ret < 0) {
32469c98726SMax Reitz             return ret;
32569c98726SMax Reitz         }
32669c98726SMax Reitz 
32769c98726SMax Reitz         s->incompatible_features &= ~QCOW2_INCOMPAT_CORRUPT;
32869c98726SMax Reitz         return qcow2_update_header(bs);
32969c98726SMax Reitz     }
33069c98726SMax Reitz     return 0;
33169c98726SMax Reitz }
33269c98726SMax Reitz 
333acbe5982SStefan Hajnoczi static int qcow2_check(BlockDriverState *bs, BdrvCheckResult *result,
334acbe5982SStefan Hajnoczi                        BdrvCheckMode fix)
335acbe5982SStefan Hajnoczi {
336acbe5982SStefan Hajnoczi     int ret = qcow2_check_refcounts(bs, result, fix);
337acbe5982SStefan Hajnoczi     if (ret < 0) {
338acbe5982SStefan Hajnoczi         return ret;
339acbe5982SStefan Hajnoczi     }
340acbe5982SStefan Hajnoczi 
341acbe5982SStefan Hajnoczi     if (fix && result->check_errors == 0 && result->corruptions == 0) {
34224530f3eSMax Reitz         ret = qcow2_mark_clean(bs);
34324530f3eSMax Reitz         if (ret < 0) {
34424530f3eSMax Reitz             return ret;
34524530f3eSMax Reitz         }
34624530f3eSMax Reitz         return qcow2_mark_consistent(bs);
347acbe5982SStefan Hajnoczi     }
348acbe5982SStefan Hajnoczi     return ret;
349acbe5982SStefan Hajnoczi }
350acbe5982SStefan Hajnoczi 
3518c7de283SKevin Wolf static int validate_table_offset(BlockDriverState *bs, uint64_t offset,
3528c7de283SKevin Wolf                                  uint64_t entries, size_t entry_len)
3538c7de283SKevin Wolf {
3548c7de283SKevin Wolf     BDRVQcowState *s = bs->opaque;
3558c7de283SKevin Wolf     uint64_t size;
3568c7de283SKevin Wolf 
3578c7de283SKevin Wolf     /* Use signed INT64_MAX as the maximum even for uint64_t header fields,
3588c7de283SKevin Wolf      * because values will be passed to qemu functions taking int64_t. */
3598c7de283SKevin Wolf     if (entries > INT64_MAX / entry_len) {
3608c7de283SKevin Wolf         return -EINVAL;
3618c7de283SKevin Wolf     }
3628c7de283SKevin Wolf 
3638c7de283SKevin Wolf     size = entries * entry_len;
3648c7de283SKevin Wolf 
3658c7de283SKevin Wolf     if (INT64_MAX - size < offset) {
3668c7de283SKevin Wolf         return -EINVAL;
3678c7de283SKevin Wolf     }
3688c7de283SKevin Wolf 
3698c7de283SKevin Wolf     /* Tables must be cluster aligned */
3708c7de283SKevin Wolf     if (offset & (s->cluster_size - 1)) {
3718c7de283SKevin Wolf         return -EINVAL;
3728c7de283SKevin Wolf     }
3738c7de283SKevin Wolf 
3748c7de283SKevin Wolf     return 0;
3758c7de283SKevin Wolf }
3768c7de283SKevin Wolf 
37774c4510aSKevin Wolf static QemuOptsList qcow2_runtime_opts = {
37874c4510aSKevin Wolf     .name = "qcow2",
37974c4510aSKevin Wolf     .head = QTAILQ_HEAD_INITIALIZER(qcow2_runtime_opts.head),
38074c4510aSKevin Wolf     .desc = {
38174c4510aSKevin Wolf         {
38264aa99d3SKevin Wolf             .name = QCOW2_OPT_LAZY_REFCOUNTS,
38374c4510aSKevin Wolf             .type = QEMU_OPT_BOOL,
38474c4510aSKevin Wolf             .help = "Postpone refcount updates",
38574c4510aSKevin Wolf         },
38667af674eSKevin Wolf         {
38767af674eSKevin Wolf             .name = QCOW2_OPT_DISCARD_REQUEST,
38867af674eSKevin Wolf             .type = QEMU_OPT_BOOL,
38967af674eSKevin Wolf             .help = "Pass guest discard requests to the layer below",
39067af674eSKevin Wolf         },
39167af674eSKevin Wolf         {
39267af674eSKevin Wolf             .name = QCOW2_OPT_DISCARD_SNAPSHOT,
39367af674eSKevin Wolf             .type = QEMU_OPT_BOOL,
39467af674eSKevin Wolf             .help = "Generate discard requests when snapshot related space "
39567af674eSKevin Wolf                     "is freed",
39667af674eSKevin Wolf         },
39767af674eSKevin Wolf         {
39867af674eSKevin Wolf             .name = QCOW2_OPT_DISCARD_OTHER,
39967af674eSKevin Wolf             .type = QEMU_OPT_BOOL,
40067af674eSKevin Wolf             .help = "Generate discard requests when other clusters are freed",
40167af674eSKevin Wolf         },
40205de7e86SMax Reitz         {
40305de7e86SMax Reitz             .name = QCOW2_OPT_OVERLAP,
40405de7e86SMax Reitz             .type = QEMU_OPT_STRING,
40505de7e86SMax Reitz             .help = "Selects which overlap checks to perform from a range of "
40605de7e86SMax Reitz                     "templates (none, constant, cached, all)",
40705de7e86SMax Reitz         },
40805de7e86SMax Reitz         {
409ee42b5ceSMax Reitz             .name = QCOW2_OPT_OVERLAP_TEMPLATE,
410ee42b5ceSMax Reitz             .type = QEMU_OPT_STRING,
411ee42b5ceSMax Reitz             .help = "Selects which overlap checks to perform from a range of "
412ee42b5ceSMax Reitz                     "templates (none, constant, cached, all)",
413ee42b5ceSMax Reitz         },
414ee42b5ceSMax Reitz         {
41505de7e86SMax Reitz             .name = QCOW2_OPT_OVERLAP_MAIN_HEADER,
41605de7e86SMax Reitz             .type = QEMU_OPT_BOOL,
41705de7e86SMax Reitz             .help = "Check for unintended writes into the main qcow2 header",
41805de7e86SMax Reitz         },
41905de7e86SMax Reitz         {
42005de7e86SMax Reitz             .name = QCOW2_OPT_OVERLAP_ACTIVE_L1,
42105de7e86SMax Reitz             .type = QEMU_OPT_BOOL,
42205de7e86SMax Reitz             .help = "Check for unintended writes into the active L1 table",
42305de7e86SMax Reitz         },
42405de7e86SMax Reitz         {
42505de7e86SMax Reitz             .name = QCOW2_OPT_OVERLAP_ACTIVE_L2,
42605de7e86SMax Reitz             .type = QEMU_OPT_BOOL,
42705de7e86SMax Reitz             .help = "Check for unintended writes into an active L2 table",
42805de7e86SMax Reitz         },
42905de7e86SMax Reitz         {
43005de7e86SMax Reitz             .name = QCOW2_OPT_OVERLAP_REFCOUNT_TABLE,
43105de7e86SMax Reitz             .type = QEMU_OPT_BOOL,
43205de7e86SMax Reitz             .help = "Check for unintended writes into the refcount table",
43305de7e86SMax Reitz         },
43405de7e86SMax Reitz         {
43505de7e86SMax Reitz             .name = QCOW2_OPT_OVERLAP_REFCOUNT_BLOCK,
43605de7e86SMax Reitz             .type = QEMU_OPT_BOOL,
43705de7e86SMax Reitz             .help = "Check for unintended writes into a refcount block",
43805de7e86SMax Reitz         },
43905de7e86SMax Reitz         {
44005de7e86SMax Reitz             .name = QCOW2_OPT_OVERLAP_SNAPSHOT_TABLE,
44105de7e86SMax Reitz             .type = QEMU_OPT_BOOL,
44205de7e86SMax Reitz             .help = "Check for unintended writes into the snapshot table",
44305de7e86SMax Reitz         },
44405de7e86SMax Reitz         {
44505de7e86SMax Reitz             .name = QCOW2_OPT_OVERLAP_INACTIVE_L1,
44605de7e86SMax Reitz             .type = QEMU_OPT_BOOL,
44705de7e86SMax Reitz             .help = "Check for unintended writes into an inactive L1 table",
44805de7e86SMax Reitz         },
44905de7e86SMax Reitz         {
45005de7e86SMax Reitz             .name = QCOW2_OPT_OVERLAP_INACTIVE_L2,
45105de7e86SMax Reitz             .type = QEMU_OPT_BOOL,
45205de7e86SMax Reitz             .help = "Check for unintended writes into an inactive L2 table",
45305de7e86SMax Reitz         },
4546c1c8d5dSMax Reitz         {
4556c1c8d5dSMax Reitz             .name = QCOW2_OPT_CACHE_SIZE,
4566c1c8d5dSMax Reitz             .type = QEMU_OPT_SIZE,
4576c1c8d5dSMax Reitz             .help = "Maximum combined metadata (L2 tables and refcount blocks) "
4586c1c8d5dSMax Reitz                     "cache size",
4596c1c8d5dSMax Reitz         },
4606c1c8d5dSMax Reitz         {
4616c1c8d5dSMax Reitz             .name = QCOW2_OPT_L2_CACHE_SIZE,
4626c1c8d5dSMax Reitz             .type = QEMU_OPT_SIZE,
4636c1c8d5dSMax Reitz             .help = "Maximum L2 table cache size",
4646c1c8d5dSMax Reitz         },
4656c1c8d5dSMax Reitz         {
4666c1c8d5dSMax Reitz             .name = QCOW2_OPT_REFCOUNT_CACHE_SIZE,
4676c1c8d5dSMax Reitz             .type = QEMU_OPT_SIZE,
4686c1c8d5dSMax Reitz             .help = "Maximum refcount block cache size",
4696c1c8d5dSMax Reitz         },
47074c4510aSKevin Wolf         { /* end of list */ }
47174c4510aSKevin Wolf     },
47274c4510aSKevin Wolf };
47374c4510aSKevin Wolf 
4744092e99dSMax Reitz static const char *overlap_bool_option_names[QCOW2_OL_MAX_BITNR] = {
4754092e99dSMax Reitz     [QCOW2_OL_MAIN_HEADER_BITNR]    = QCOW2_OPT_OVERLAP_MAIN_HEADER,
4764092e99dSMax Reitz     [QCOW2_OL_ACTIVE_L1_BITNR]      = QCOW2_OPT_OVERLAP_ACTIVE_L1,
4774092e99dSMax Reitz     [QCOW2_OL_ACTIVE_L2_BITNR]      = QCOW2_OPT_OVERLAP_ACTIVE_L2,
4784092e99dSMax Reitz     [QCOW2_OL_REFCOUNT_TABLE_BITNR] = QCOW2_OPT_OVERLAP_REFCOUNT_TABLE,
4794092e99dSMax Reitz     [QCOW2_OL_REFCOUNT_BLOCK_BITNR] = QCOW2_OPT_OVERLAP_REFCOUNT_BLOCK,
4804092e99dSMax Reitz     [QCOW2_OL_SNAPSHOT_TABLE_BITNR] = QCOW2_OPT_OVERLAP_SNAPSHOT_TABLE,
4814092e99dSMax Reitz     [QCOW2_OL_INACTIVE_L1_BITNR]    = QCOW2_OPT_OVERLAP_INACTIVE_L1,
4824092e99dSMax Reitz     [QCOW2_OL_INACTIVE_L2_BITNR]    = QCOW2_OPT_OVERLAP_INACTIVE_L2,
4834092e99dSMax Reitz };
4844092e99dSMax Reitz 
4856c1c8d5dSMax Reitz static void read_cache_sizes(QemuOpts *opts, uint64_t *l2_cache_size,
4866c1c8d5dSMax Reitz                              uint64_t *refcount_cache_size, Error **errp)
4876c1c8d5dSMax Reitz {
4886c1c8d5dSMax Reitz     uint64_t combined_cache_size;
4896c1c8d5dSMax Reitz     bool l2_cache_size_set, refcount_cache_size_set, combined_cache_size_set;
4906c1c8d5dSMax Reitz 
4916c1c8d5dSMax Reitz     combined_cache_size_set = qemu_opt_get(opts, QCOW2_OPT_CACHE_SIZE);
4926c1c8d5dSMax Reitz     l2_cache_size_set = qemu_opt_get(opts, QCOW2_OPT_L2_CACHE_SIZE);
4936c1c8d5dSMax Reitz     refcount_cache_size_set = qemu_opt_get(opts, QCOW2_OPT_REFCOUNT_CACHE_SIZE);
4946c1c8d5dSMax Reitz 
4956c1c8d5dSMax Reitz     combined_cache_size = qemu_opt_get_size(opts, QCOW2_OPT_CACHE_SIZE, 0);
4966c1c8d5dSMax Reitz     *l2_cache_size = qemu_opt_get_size(opts, QCOW2_OPT_L2_CACHE_SIZE, 0);
4976c1c8d5dSMax Reitz     *refcount_cache_size = qemu_opt_get_size(opts,
4986c1c8d5dSMax Reitz                                              QCOW2_OPT_REFCOUNT_CACHE_SIZE, 0);
4996c1c8d5dSMax Reitz 
5006c1c8d5dSMax Reitz     if (combined_cache_size_set) {
5016c1c8d5dSMax Reitz         if (l2_cache_size_set && refcount_cache_size_set) {
5026c1c8d5dSMax Reitz             error_setg(errp, QCOW2_OPT_CACHE_SIZE ", " QCOW2_OPT_L2_CACHE_SIZE
5036c1c8d5dSMax Reitz                        " and " QCOW2_OPT_REFCOUNT_CACHE_SIZE " may not be set "
5046c1c8d5dSMax Reitz                        "the same time");
5056c1c8d5dSMax Reitz             return;
5066c1c8d5dSMax Reitz         } else if (*l2_cache_size > combined_cache_size) {
5076c1c8d5dSMax Reitz             error_setg(errp, QCOW2_OPT_L2_CACHE_SIZE " may not exceed "
5086c1c8d5dSMax Reitz                        QCOW2_OPT_CACHE_SIZE);
5096c1c8d5dSMax Reitz             return;
5106c1c8d5dSMax Reitz         } else if (*refcount_cache_size > combined_cache_size) {
5116c1c8d5dSMax Reitz             error_setg(errp, QCOW2_OPT_REFCOUNT_CACHE_SIZE " may not exceed "
5126c1c8d5dSMax Reitz                        QCOW2_OPT_CACHE_SIZE);
5136c1c8d5dSMax Reitz             return;
5146c1c8d5dSMax Reitz         }
5156c1c8d5dSMax Reitz 
5166c1c8d5dSMax Reitz         if (l2_cache_size_set) {
5176c1c8d5dSMax Reitz             *refcount_cache_size = combined_cache_size - *l2_cache_size;
5186c1c8d5dSMax Reitz         } else if (refcount_cache_size_set) {
5196c1c8d5dSMax Reitz             *l2_cache_size = combined_cache_size - *refcount_cache_size;
5206c1c8d5dSMax Reitz         } else {
5216c1c8d5dSMax Reitz             *refcount_cache_size = combined_cache_size
5226c1c8d5dSMax Reitz                                  / (DEFAULT_L2_REFCOUNT_SIZE_RATIO + 1);
5236c1c8d5dSMax Reitz             *l2_cache_size = combined_cache_size - *refcount_cache_size;
5246c1c8d5dSMax Reitz         }
5256c1c8d5dSMax Reitz     } else {
5266c1c8d5dSMax Reitz         if (!l2_cache_size_set && !refcount_cache_size_set) {
5276c1c8d5dSMax Reitz             *l2_cache_size = DEFAULT_L2_CACHE_BYTE_SIZE;
5286c1c8d5dSMax Reitz             *refcount_cache_size = *l2_cache_size
5296c1c8d5dSMax Reitz                                  / DEFAULT_L2_REFCOUNT_SIZE_RATIO;
5306c1c8d5dSMax Reitz         } else if (!l2_cache_size_set) {
5316c1c8d5dSMax Reitz             *l2_cache_size = *refcount_cache_size
5326c1c8d5dSMax Reitz                            * DEFAULT_L2_REFCOUNT_SIZE_RATIO;
5336c1c8d5dSMax Reitz         } else if (!refcount_cache_size_set) {
5346c1c8d5dSMax Reitz             *refcount_cache_size = *l2_cache_size
5356c1c8d5dSMax Reitz                                  / DEFAULT_L2_REFCOUNT_SIZE_RATIO;
5366c1c8d5dSMax Reitz         }
5376c1c8d5dSMax Reitz     }
5386c1c8d5dSMax Reitz }
5396c1c8d5dSMax Reitz 
540015a1036SMax Reitz static int qcow2_open(BlockDriverState *bs, QDict *options, int flags,
541015a1036SMax Reitz                       Error **errp)
542585f8587Sbellard {
543585f8587Sbellard     BDRVQcowState *s = bs->opaque;
5446d33e8e7SKevin Wolf     unsigned int len, i;
5456d33e8e7SKevin Wolf     int ret = 0;
546585f8587Sbellard     QCowHeader header;
5477b17ce60SMax Reitz     QemuOpts *opts = NULL;
54874c4510aSKevin Wolf     Error *local_err = NULL;
5499b80ddf3Saliguori     uint64_t ext_end;
5502cf7cfa1SKevin Wolf     uint64_t l1_vm_state_index;
551ee42b5ceSMax Reitz     const char *opt_overlap_check, *opt_overlap_check_template;
5521fa5cc83SMax Reitz     int overlap_check_template = 0;
553440ba08aSMax Reitz     uint64_t l2_cache_size, refcount_cache_size;
554585f8587Sbellard 
5556d85a57eSJes Sorensen     ret = bdrv_pread(bs->file, 0, &header, sizeof(header));
5566d85a57eSJes Sorensen     if (ret < 0) {
5573ef6c40aSMax Reitz         error_setg_errno(errp, -ret, "Could not read qcow2 header");
558585f8587Sbellard         goto fail;
5596d85a57eSJes Sorensen     }
560585f8587Sbellard     be32_to_cpus(&header.magic);
561585f8587Sbellard     be32_to_cpus(&header.version);
562585f8587Sbellard     be64_to_cpus(&header.backing_file_offset);
563585f8587Sbellard     be32_to_cpus(&header.backing_file_size);
564585f8587Sbellard     be64_to_cpus(&header.size);
565585f8587Sbellard     be32_to_cpus(&header.cluster_bits);
566585f8587Sbellard     be32_to_cpus(&header.crypt_method);
567585f8587Sbellard     be64_to_cpus(&header.l1_table_offset);
568585f8587Sbellard     be32_to_cpus(&header.l1_size);
569585f8587Sbellard     be64_to_cpus(&header.refcount_table_offset);
570585f8587Sbellard     be32_to_cpus(&header.refcount_table_clusters);
571585f8587Sbellard     be64_to_cpus(&header.snapshots_offset);
572585f8587Sbellard     be32_to_cpus(&header.nb_snapshots);
573585f8587Sbellard 
574e8cdcec1SKevin Wolf     if (header.magic != QCOW_MAGIC) {
5753ef6c40aSMax Reitz         error_setg(errp, "Image is not in qcow2 format");
57676abe407SPaolo Bonzini         ret = -EINVAL;
577585f8587Sbellard         goto fail;
5786d85a57eSJes Sorensen     }
5796744cbabSKevin Wolf     if (header.version < 2 || header.version > 3) {
580521b2b5dSMax Reitz         report_unsupported(bs, errp, "QCOW version %" PRIu32, header.version);
581e8cdcec1SKevin Wolf         ret = -ENOTSUP;
582e8cdcec1SKevin Wolf         goto fail;
583e8cdcec1SKevin Wolf     }
5846744cbabSKevin Wolf 
5856744cbabSKevin Wolf     s->qcow_version = header.version;
5866744cbabSKevin Wolf 
58724342f2cSKevin Wolf     /* Initialise cluster size */
58824342f2cSKevin Wolf     if (header.cluster_bits < MIN_CLUSTER_BITS ||
58924342f2cSKevin Wolf         header.cluster_bits > MAX_CLUSTER_BITS) {
590521b2b5dSMax Reitz         error_setg(errp, "Unsupported cluster size: 2^%" PRIu32,
591521b2b5dSMax Reitz                    header.cluster_bits);
59224342f2cSKevin Wolf         ret = -EINVAL;
59324342f2cSKevin Wolf         goto fail;
59424342f2cSKevin Wolf     }
59524342f2cSKevin Wolf 
59624342f2cSKevin Wolf     s->cluster_bits = header.cluster_bits;
59724342f2cSKevin Wolf     s->cluster_size = 1 << s->cluster_bits;
59824342f2cSKevin Wolf     s->cluster_sectors = 1 << (s->cluster_bits - 9);
59924342f2cSKevin Wolf 
6006744cbabSKevin Wolf     /* Initialise version 3 header fields */
6016744cbabSKevin Wolf     if (header.version == 2) {
6026744cbabSKevin Wolf         header.incompatible_features    = 0;
6036744cbabSKevin Wolf         header.compatible_features      = 0;
6046744cbabSKevin Wolf         header.autoclear_features       = 0;
6056744cbabSKevin Wolf         header.refcount_order           = 4;
6066744cbabSKevin Wolf         header.header_length            = 72;
6076744cbabSKevin Wolf     } else {
6086744cbabSKevin Wolf         be64_to_cpus(&header.incompatible_features);
6096744cbabSKevin Wolf         be64_to_cpus(&header.compatible_features);
6106744cbabSKevin Wolf         be64_to_cpus(&header.autoclear_features);
6116744cbabSKevin Wolf         be32_to_cpus(&header.refcount_order);
6126744cbabSKevin Wolf         be32_to_cpus(&header.header_length);
61324342f2cSKevin Wolf 
61424342f2cSKevin Wolf         if (header.header_length < 104) {
61524342f2cSKevin Wolf             error_setg(errp, "qcow2 header too short");
61624342f2cSKevin Wolf             ret = -EINVAL;
61724342f2cSKevin Wolf             goto fail;
61824342f2cSKevin Wolf         }
61924342f2cSKevin Wolf     }
62024342f2cSKevin Wolf 
62124342f2cSKevin Wolf     if (header.header_length > s->cluster_size) {
62224342f2cSKevin Wolf         error_setg(errp, "qcow2 header exceeds cluster size");
62324342f2cSKevin Wolf         ret = -EINVAL;
62424342f2cSKevin Wolf         goto fail;
6256744cbabSKevin Wolf     }
6266744cbabSKevin Wolf 
6276744cbabSKevin Wolf     if (header.header_length > sizeof(header)) {
6286744cbabSKevin Wolf         s->unknown_header_fields_size = header.header_length - sizeof(header);
6296744cbabSKevin Wolf         s->unknown_header_fields = g_malloc(s->unknown_header_fields_size);
6306744cbabSKevin Wolf         ret = bdrv_pread(bs->file, sizeof(header), s->unknown_header_fields,
6316744cbabSKevin Wolf                          s->unknown_header_fields_size);
6326744cbabSKevin Wolf         if (ret < 0) {
6333ef6c40aSMax Reitz             error_setg_errno(errp, -ret, "Could not read unknown qcow2 header "
6343ef6c40aSMax Reitz                              "fields");
6356744cbabSKevin Wolf             goto fail;
6366744cbabSKevin Wolf         }
6376744cbabSKevin Wolf     }
6386744cbabSKevin Wolf 
639a1b3955cSKevin Wolf     if (header.backing_file_offset > s->cluster_size) {
640a1b3955cSKevin Wolf         error_setg(errp, "Invalid backing file offset");
641a1b3955cSKevin Wolf         ret = -EINVAL;
642a1b3955cSKevin Wolf         goto fail;
643a1b3955cSKevin Wolf     }
644a1b3955cSKevin Wolf 
645cfcc4c62SKevin Wolf     if (header.backing_file_offset) {
646cfcc4c62SKevin Wolf         ext_end = header.backing_file_offset;
647cfcc4c62SKevin Wolf     } else {
648cfcc4c62SKevin Wolf         ext_end = 1 << header.cluster_bits;
649cfcc4c62SKevin Wolf     }
650cfcc4c62SKevin Wolf 
6516744cbabSKevin Wolf     /* Handle feature bits */
6526744cbabSKevin Wolf     s->incompatible_features    = header.incompatible_features;
6536744cbabSKevin Wolf     s->compatible_features      = header.compatible_features;
6546744cbabSKevin Wolf     s->autoclear_features       = header.autoclear_features;
6556744cbabSKevin Wolf 
656c61d0004SStefan Hajnoczi     if (s->incompatible_features & ~QCOW2_INCOMPAT_MASK) {
657cfcc4c62SKevin Wolf         void *feature_table = NULL;
658cfcc4c62SKevin Wolf         qcow2_read_extensions(bs, header.header_length, ext_end,
6593ef6c40aSMax Reitz                               &feature_table, NULL);
6603ef6c40aSMax Reitz         report_unsupported_feature(bs, errp, feature_table,
661c61d0004SStefan Hajnoczi                                    s->incompatible_features &
662c61d0004SStefan Hajnoczi                                    ~QCOW2_INCOMPAT_MASK);
6636744cbabSKevin Wolf         ret = -ENOTSUP;
664c5a33ee9SPrasad Joshi         g_free(feature_table);
6656744cbabSKevin Wolf         goto fail;
6666744cbabSKevin Wolf     }
6676744cbabSKevin Wolf 
66869c98726SMax Reitz     if (s->incompatible_features & QCOW2_INCOMPAT_CORRUPT) {
66969c98726SMax Reitz         /* Corrupt images may not be written to unless they are being repaired
67069c98726SMax Reitz          */
67169c98726SMax Reitz         if ((flags & BDRV_O_RDWR) && !(flags & BDRV_O_CHECK)) {
6723ef6c40aSMax Reitz             error_setg(errp, "qcow2: Image is corrupt; cannot be opened "
6733ef6c40aSMax Reitz                        "read/write");
67469c98726SMax Reitz             ret = -EACCES;
67569c98726SMax Reitz             goto fail;
67669c98726SMax Reitz         }
67769c98726SMax Reitz     }
67869c98726SMax Reitz 
6796744cbabSKevin Wolf     /* Check support for various header values */
6806744cbabSKevin Wolf     if (header.refcount_order != 4) {
6813ef6c40aSMax Reitz         report_unsupported(bs, errp, "%d bit reference counts",
6826744cbabSKevin Wolf                            1 << header.refcount_order);
6836744cbabSKevin Wolf         ret = -ENOTSUP;
6846744cbabSKevin Wolf         goto fail;
6856744cbabSKevin Wolf     }
686b6481f37SMax Reitz     s->refcount_order = header.refcount_order;
6876744cbabSKevin Wolf 
6886d85a57eSJes Sorensen     if (header.crypt_method > QCOW_CRYPT_AES) {
689521b2b5dSMax Reitz         error_setg(errp, "Unsupported encryption method: %" PRIu32,
6903ef6c40aSMax Reitz                    header.crypt_method);
6916d85a57eSJes Sorensen         ret = -EINVAL;
692585f8587Sbellard         goto fail;
6936d85a57eSJes Sorensen     }
694585f8587Sbellard     s->crypt_method_header = header.crypt_method;
6956d85a57eSJes Sorensen     if (s->crypt_method_header) {
696585f8587Sbellard         bs->encrypted = 1;
6976d85a57eSJes Sorensen     }
69824342f2cSKevin Wolf 
699585f8587Sbellard     s->l2_bits = s->cluster_bits - 3; /* L2 is always one cluster */
700585f8587Sbellard     s->l2_size = 1 << s->l2_bits;
7011d13d654SMax Reitz     /* 2^(s->refcount_order - 3) is the refcount width in bytes */
7021d13d654SMax Reitz     s->refcount_block_bits = s->cluster_bits - (s->refcount_order - 3);
7031d13d654SMax Reitz     s->refcount_block_size = 1 << s->refcount_block_bits;
704585f8587Sbellard     bs->total_sectors = header.size / 512;
705585f8587Sbellard     s->csize_shift = (62 - (s->cluster_bits - 8));
706585f8587Sbellard     s->csize_mask = (1 << (s->cluster_bits - 8)) - 1;
707585f8587Sbellard     s->cluster_offset_mask = (1LL << s->csize_shift) - 1;
7085dab2fadSKevin Wolf 
709585f8587Sbellard     s->refcount_table_offset = header.refcount_table_offset;
710585f8587Sbellard     s->refcount_table_size =
711585f8587Sbellard         header.refcount_table_clusters << (s->cluster_bits - 3);
712585f8587Sbellard 
7132b5d5953SKevin Wolf     if (header.refcount_table_clusters > qcow2_max_refcount_clusters(s)) {
7145dab2fadSKevin Wolf         error_setg(errp, "Reference count table too large");
7155dab2fadSKevin Wolf         ret = -EINVAL;
7165dab2fadSKevin Wolf         goto fail;
7175dab2fadSKevin Wolf     }
7185dab2fadSKevin Wolf 
7198c7de283SKevin Wolf     ret = validate_table_offset(bs, s->refcount_table_offset,
7208c7de283SKevin Wolf                                 s->refcount_table_size, sizeof(uint64_t));
7218c7de283SKevin Wolf     if (ret < 0) {
7228c7de283SKevin Wolf         error_setg(errp, "Invalid reference count table offset");
7238c7de283SKevin Wolf         goto fail;
7248c7de283SKevin Wolf     }
7258c7de283SKevin Wolf 
726ce48f2f4SKevin Wolf     /* Snapshot table offset/length */
727ce48f2f4SKevin Wolf     if (header.nb_snapshots > QCOW_MAX_SNAPSHOTS) {
728ce48f2f4SKevin Wolf         error_setg(errp, "Too many snapshots");
729ce48f2f4SKevin Wolf         ret = -EINVAL;
730ce48f2f4SKevin Wolf         goto fail;
731ce48f2f4SKevin Wolf     }
732ce48f2f4SKevin Wolf 
733ce48f2f4SKevin Wolf     ret = validate_table_offset(bs, header.snapshots_offset,
734ce48f2f4SKevin Wolf                                 header.nb_snapshots,
735ce48f2f4SKevin Wolf                                 sizeof(QCowSnapshotHeader));
736ce48f2f4SKevin Wolf     if (ret < 0) {
737ce48f2f4SKevin Wolf         error_setg(errp, "Invalid snapshot table offset");
738ce48f2f4SKevin Wolf         goto fail;
739ce48f2f4SKevin Wolf     }
740ce48f2f4SKevin Wolf 
741585f8587Sbellard     /* read the level 1 table */
7426a83f8b5SKevin Wolf     if (header.l1_size > QCOW_MAX_L1_SIZE) {
7432d51c32cSKevin Wolf         error_setg(errp, "Active L1 table too large");
7442d51c32cSKevin Wolf         ret = -EFBIG;
7452d51c32cSKevin Wolf         goto fail;
7462d51c32cSKevin Wolf     }
747585f8587Sbellard     s->l1_size = header.l1_size;
7482cf7cfa1SKevin Wolf 
7492cf7cfa1SKevin Wolf     l1_vm_state_index = size_to_l1(s, header.size);
7502cf7cfa1SKevin Wolf     if (l1_vm_state_index > INT_MAX) {
7513ef6c40aSMax Reitz         error_setg(errp, "Image is too big");
7522cf7cfa1SKevin Wolf         ret = -EFBIG;
7532cf7cfa1SKevin Wolf         goto fail;
7542cf7cfa1SKevin Wolf     }
7552cf7cfa1SKevin Wolf     s->l1_vm_state_index = l1_vm_state_index;
7562cf7cfa1SKevin Wolf 
757585f8587Sbellard     /* the L1 table must contain at least enough entries to put
758585f8587Sbellard        header.size bytes */
7596d85a57eSJes Sorensen     if (s->l1_size < s->l1_vm_state_index) {
7603ef6c40aSMax Reitz         error_setg(errp, "L1 table is too small");
7616d85a57eSJes Sorensen         ret = -EINVAL;
762585f8587Sbellard         goto fail;
7636d85a57eSJes Sorensen     }
7642d51c32cSKevin Wolf 
7652d51c32cSKevin Wolf     ret = validate_table_offset(bs, header.l1_table_offset,
7662d51c32cSKevin Wolf                                 header.l1_size, sizeof(uint64_t));
7672d51c32cSKevin Wolf     if (ret < 0) {
7682d51c32cSKevin Wolf         error_setg(errp, "Invalid L1 table offset");
7692d51c32cSKevin Wolf         goto fail;
7702d51c32cSKevin Wolf     }
771585f8587Sbellard     s->l1_table_offset = header.l1_table_offset;
7722d51c32cSKevin Wolf 
7732d51c32cSKevin Wolf 
774d191d12dSStefan Weil     if (s->l1_size > 0) {
775de82815dSKevin Wolf         s->l1_table = qemu_try_blockalign(bs->file,
7763f6a3ee5SKevin Wolf             align_offset(s->l1_size * sizeof(uint64_t), 512));
777de82815dSKevin Wolf         if (s->l1_table == NULL) {
778de82815dSKevin Wolf             error_setg(errp, "Could not allocate L1 table");
779de82815dSKevin Wolf             ret = -ENOMEM;
780de82815dSKevin Wolf             goto fail;
781de82815dSKevin Wolf         }
7826d85a57eSJes Sorensen         ret = bdrv_pread(bs->file, s->l1_table_offset, s->l1_table,
7836d85a57eSJes Sorensen                          s->l1_size * sizeof(uint64_t));
7846d85a57eSJes Sorensen         if (ret < 0) {
7853ef6c40aSMax Reitz             error_setg_errno(errp, -ret, "Could not read L1 table");
786585f8587Sbellard             goto fail;
7876d85a57eSJes Sorensen         }
788585f8587Sbellard         for(i = 0;i < s->l1_size; i++) {
789585f8587Sbellard             be64_to_cpus(&s->l1_table[i]);
790585f8587Sbellard         }
791d191d12dSStefan Weil     }
79229c1a730SKevin Wolf 
7936c1c8d5dSMax Reitz     /* get L2 table/refcount block cache size from command line options */
7946c1c8d5dSMax Reitz     opts = qemu_opts_create(&qcow2_runtime_opts, NULL, 0, &error_abort);
7956c1c8d5dSMax Reitz     qemu_opts_absorb_qdict(opts, options, &local_err);
7966c1c8d5dSMax Reitz     if (local_err) {
7976c1c8d5dSMax Reitz         error_propagate(errp, local_err);
7986c1c8d5dSMax Reitz         ret = -EINVAL;
7996c1c8d5dSMax Reitz         goto fail;
8006c1c8d5dSMax Reitz     }
8016c1c8d5dSMax Reitz 
8026c1c8d5dSMax Reitz     read_cache_sizes(opts, &l2_cache_size, &refcount_cache_size, &local_err);
8036c1c8d5dSMax Reitz     if (local_err) {
8046c1c8d5dSMax Reitz         error_propagate(errp, local_err);
8056c1c8d5dSMax Reitz         ret = -EINVAL;
8066c1c8d5dSMax Reitz         goto fail;
8076c1c8d5dSMax Reitz     }
8086c1c8d5dSMax Reitz 
8096c1c8d5dSMax Reitz     l2_cache_size /= s->cluster_size;
810440ba08aSMax Reitz     if (l2_cache_size < MIN_L2_CACHE_SIZE) {
811440ba08aSMax Reitz         l2_cache_size = MIN_L2_CACHE_SIZE;
812440ba08aSMax Reitz     }
8136c1c8d5dSMax Reitz     if (l2_cache_size > INT_MAX) {
8146c1c8d5dSMax Reitz         error_setg(errp, "L2 cache size too big");
8156c1c8d5dSMax Reitz         ret = -EINVAL;
8166c1c8d5dSMax Reitz         goto fail;
8176c1c8d5dSMax Reitz     }
818440ba08aSMax Reitz 
8196c1c8d5dSMax Reitz     refcount_cache_size /= s->cluster_size;
820440ba08aSMax Reitz     if (refcount_cache_size < MIN_REFCOUNT_CACHE_SIZE) {
821440ba08aSMax Reitz         refcount_cache_size = MIN_REFCOUNT_CACHE_SIZE;
822440ba08aSMax Reitz     }
8236c1c8d5dSMax Reitz     if (refcount_cache_size > INT_MAX) {
8246c1c8d5dSMax Reitz         error_setg(errp, "Refcount cache size too big");
8256c1c8d5dSMax Reitz         ret = -EINVAL;
8266c1c8d5dSMax Reitz         goto fail;
8276c1c8d5dSMax Reitz     }
828440ba08aSMax Reitz 
8296c1c8d5dSMax Reitz     /* alloc L2 table/refcount block cache */
830440ba08aSMax Reitz     s->l2_table_cache = qcow2_cache_create(bs, l2_cache_size);
831440ba08aSMax Reitz     s->refcount_block_cache = qcow2_cache_create(bs, refcount_cache_size);
832de82815dSKevin Wolf     if (s->l2_table_cache == NULL || s->refcount_block_cache == NULL) {
833de82815dSKevin Wolf         error_setg(errp, "Could not allocate metadata caches");
834de82815dSKevin Wolf         ret = -ENOMEM;
835de82815dSKevin Wolf         goto fail;
836de82815dSKevin Wolf     }
83729c1a730SKevin Wolf 
8387267c094SAnthony Liguori     s->cluster_cache = g_malloc(s->cluster_size);
839585f8587Sbellard     /* one more sector for decompressed data alignment */
840de82815dSKevin Wolf     s->cluster_data = qemu_try_blockalign(bs->file, QCOW_MAX_CRYPT_CLUSTERS
841de82815dSKevin Wolf                                                     * s->cluster_size + 512);
842de82815dSKevin Wolf     if (s->cluster_data == NULL) {
843de82815dSKevin Wolf         error_setg(errp, "Could not allocate temporary cluster buffer");
844de82815dSKevin Wolf         ret = -ENOMEM;
845de82815dSKevin Wolf         goto fail;
846de82815dSKevin Wolf     }
847de82815dSKevin Wolf 
848585f8587Sbellard     s->cluster_cache_offset = -1;
84906d9260fSAnthony Liguori     s->flags = flags;
850585f8587Sbellard 
8516d85a57eSJes Sorensen     ret = qcow2_refcount_init(bs);
8526d85a57eSJes Sorensen     if (ret != 0) {
8533ef6c40aSMax Reitz         error_setg_errno(errp, -ret, "Could not initialize refcount handling");
854585f8587Sbellard         goto fail;
8556d85a57eSJes Sorensen     }
856585f8587Sbellard 
85772cf2d4fSBlue Swirl     QLIST_INIT(&s->cluster_allocs);
8580b919faeSKevin Wolf     QTAILQ_INIT(&s->discards);
859f214978aSKevin Wolf 
8609b80ddf3Saliguori     /* read qcow2 extensions */
8613ef6c40aSMax Reitz     if (qcow2_read_extensions(bs, header.header_length, ext_end, NULL,
8623ef6c40aSMax Reitz         &local_err)) {
8633ef6c40aSMax Reitz         error_propagate(errp, local_err);
8646d85a57eSJes Sorensen         ret = -EINVAL;
8659b80ddf3Saliguori         goto fail;
8666d85a57eSJes Sorensen     }
8679b80ddf3Saliguori 
868585f8587Sbellard     /* read the backing file name */
869585f8587Sbellard     if (header.backing_file_offset != 0) {
870585f8587Sbellard         len = header.backing_file_size;
871*9a29e18fSJeff Cody         if (len > MIN(1023, s->cluster_size - header.backing_file_offset) ||
872*9a29e18fSJeff Cody             len > sizeof(bs->backing_file)) {
8736d33e8e7SKevin Wolf             error_setg(errp, "Backing file name too long");
8746d33e8e7SKevin Wolf             ret = -EINVAL;
8756d33e8e7SKevin Wolf             goto fail;
8766d85a57eSJes Sorensen         }
8776d85a57eSJes Sorensen         ret = bdrv_pread(bs->file, header.backing_file_offset,
8786d85a57eSJes Sorensen                          bs->backing_file, len);
8796d85a57eSJes Sorensen         if (ret < 0) {
8803ef6c40aSMax Reitz             error_setg_errno(errp, -ret, "Could not read backing file name");
881585f8587Sbellard             goto fail;
8826d85a57eSJes Sorensen         }
883585f8587Sbellard         bs->backing_file[len] = '\0';
884585f8587Sbellard     }
88542deb29fSKevin Wolf 
88611b128f4SKevin Wolf     /* Internal snapshots */
88711b128f4SKevin Wolf     s->snapshots_offset = header.snapshots_offset;
88811b128f4SKevin Wolf     s->nb_snapshots = header.nb_snapshots;
88911b128f4SKevin Wolf 
89042deb29fSKevin Wolf     ret = qcow2_read_snapshots(bs);
89142deb29fSKevin Wolf     if (ret < 0) {
8923ef6c40aSMax Reitz         error_setg_errno(errp, -ret, "Could not read snapshots");
893585f8587Sbellard         goto fail;
8946d85a57eSJes Sorensen     }
895585f8587Sbellard 
896af7b708dSStefan Hajnoczi     /* Clear unknown autoclear feature bits */
89727eb6c09SKevin Wolf     if (!bs->read_only && !(flags & BDRV_O_INCOMING) && s->autoclear_features) {
898af7b708dSStefan Hajnoczi         s->autoclear_features = 0;
899af7b708dSStefan Hajnoczi         ret = qcow2_update_header(bs);
900af7b708dSStefan Hajnoczi         if (ret < 0) {
9013ef6c40aSMax Reitz             error_setg_errno(errp, -ret, "Could not update qcow2 header");
902af7b708dSStefan Hajnoczi             goto fail;
903af7b708dSStefan Hajnoczi         }
904af7b708dSStefan Hajnoczi     }
905af7b708dSStefan Hajnoczi 
90668d100e9SKevin Wolf     /* Initialise locks */
90768d100e9SKevin Wolf     qemu_co_mutex_init(&s->lock);
90868d100e9SKevin Wolf 
909c61d0004SStefan Hajnoczi     /* Repair image if dirty */
91027eb6c09SKevin Wolf     if (!(flags & (BDRV_O_CHECK | BDRV_O_INCOMING)) && !bs->read_only &&
911058f8f16SStefan Hajnoczi         (s->incompatible_features & QCOW2_INCOMPAT_DIRTY)) {
912c61d0004SStefan Hajnoczi         BdrvCheckResult result = {0};
913c61d0004SStefan Hajnoczi 
9145b84106bSMax Reitz         ret = qcow2_check(bs, &result, BDRV_FIX_ERRORS | BDRV_FIX_LEAKS);
915c61d0004SStefan Hajnoczi         if (ret < 0) {
9163ef6c40aSMax Reitz             error_setg_errno(errp, -ret, "Could not repair dirty image");
917c61d0004SStefan Hajnoczi             goto fail;
918c61d0004SStefan Hajnoczi         }
919c61d0004SStefan Hajnoczi     }
920c61d0004SStefan Hajnoczi 
92174c4510aSKevin Wolf     /* Enable lazy_refcounts according to image and command line options */
922acdfb480SKevin Wolf     s->use_lazy_refcounts = qemu_opt_get_bool(opts, QCOW2_OPT_LAZY_REFCOUNTS,
92374c4510aSKevin Wolf         (s->compatible_features & QCOW2_COMPAT_LAZY_REFCOUNTS));
92474c4510aSKevin Wolf 
92567af674eSKevin Wolf     s->discard_passthrough[QCOW2_DISCARD_NEVER] = false;
92667af674eSKevin Wolf     s->discard_passthrough[QCOW2_DISCARD_ALWAYS] = true;
92767af674eSKevin Wolf     s->discard_passthrough[QCOW2_DISCARD_REQUEST] =
92867af674eSKevin Wolf         qemu_opt_get_bool(opts, QCOW2_OPT_DISCARD_REQUEST,
92967af674eSKevin Wolf                           flags & BDRV_O_UNMAP);
93067af674eSKevin Wolf     s->discard_passthrough[QCOW2_DISCARD_SNAPSHOT] =
93167af674eSKevin Wolf         qemu_opt_get_bool(opts, QCOW2_OPT_DISCARD_SNAPSHOT, true);
93267af674eSKevin Wolf     s->discard_passthrough[QCOW2_DISCARD_OTHER] =
93367af674eSKevin Wolf         qemu_opt_get_bool(opts, QCOW2_OPT_DISCARD_OTHER, false);
93467af674eSKevin Wolf 
935ee42b5ceSMax Reitz     opt_overlap_check = qemu_opt_get(opts, QCOW2_OPT_OVERLAP);
936ee42b5ceSMax Reitz     opt_overlap_check_template = qemu_opt_get(opts, QCOW2_OPT_OVERLAP_TEMPLATE);
937ee42b5ceSMax Reitz     if (opt_overlap_check_template && opt_overlap_check &&
938ee42b5ceSMax Reitz         strcmp(opt_overlap_check_template, opt_overlap_check))
939ee42b5ceSMax Reitz     {
940ee42b5ceSMax Reitz         error_setg(errp, "Conflicting values for qcow2 options '"
941ee42b5ceSMax Reitz                    QCOW2_OPT_OVERLAP "' ('%s') and '" QCOW2_OPT_OVERLAP_TEMPLATE
942ee42b5ceSMax Reitz                    "' ('%s')", opt_overlap_check, opt_overlap_check_template);
943ee42b5ceSMax Reitz         ret = -EINVAL;
944ee42b5ceSMax Reitz         goto fail;
945ee42b5ceSMax Reitz     }
946ee42b5ceSMax Reitz     if (!opt_overlap_check) {
947ee42b5ceSMax Reitz         opt_overlap_check = opt_overlap_check_template ?: "cached";
948ee42b5ceSMax Reitz     }
949ee42b5ceSMax Reitz 
9501fa5cc83SMax Reitz     if (!strcmp(opt_overlap_check, "none")) {
9511fa5cc83SMax Reitz         overlap_check_template = 0;
9521fa5cc83SMax Reitz     } else if (!strcmp(opt_overlap_check, "constant")) {
9531fa5cc83SMax Reitz         overlap_check_template = QCOW2_OL_CONSTANT;
9541fa5cc83SMax Reitz     } else if (!strcmp(opt_overlap_check, "cached")) {
9551fa5cc83SMax Reitz         overlap_check_template = QCOW2_OL_CACHED;
9561fa5cc83SMax Reitz     } else if (!strcmp(opt_overlap_check, "all")) {
9571fa5cc83SMax Reitz         overlap_check_template = QCOW2_OL_ALL;
9581fa5cc83SMax Reitz     } else {
9591fa5cc83SMax Reitz         error_setg(errp, "Unsupported value '%s' for qcow2 option "
9601fa5cc83SMax Reitz                    "'overlap-check'. Allowed are either of the following: "
9611fa5cc83SMax Reitz                    "none, constant, cached, all", opt_overlap_check);
9621fa5cc83SMax Reitz         ret = -EINVAL;
9631fa5cc83SMax Reitz         goto fail;
9641fa5cc83SMax Reitz     }
9651fa5cc83SMax Reitz 
9661fa5cc83SMax Reitz     s->overlap_check = 0;
9671fa5cc83SMax Reitz     for (i = 0; i < QCOW2_OL_MAX_BITNR; i++) {
9681fa5cc83SMax Reitz         /* overlap-check defines a template bitmask, but every flag may be
9691fa5cc83SMax Reitz          * overwritten through the associated boolean option */
9701fa5cc83SMax Reitz         s->overlap_check |=
9711fa5cc83SMax Reitz             qemu_opt_get_bool(opts, overlap_bool_option_names[i],
9721fa5cc83SMax Reitz                               overlap_check_template & (1 << i)) << i;
9731fa5cc83SMax Reitz     }
9743e355390SMax Reitz 
97574c4510aSKevin Wolf     qemu_opts_del(opts);
9767b17ce60SMax Reitz     opts = NULL;
97774c4510aSKevin Wolf 
97874c4510aSKevin Wolf     if (s->use_lazy_refcounts && s->qcow_version < 3) {
9793ef6c40aSMax Reitz         error_setg(errp, "Lazy refcounts require a qcow2 image with at least "
9803ef6c40aSMax Reitz                    "qemu 1.1 compatibility level");
98174c4510aSKevin Wolf         ret = -EINVAL;
98274c4510aSKevin Wolf         goto fail;
98374c4510aSKevin Wolf     }
98474c4510aSKevin Wolf 
985585f8587Sbellard #ifdef DEBUG_ALLOC
9866cbc3031SPhilipp Hahn     {
9876cbc3031SPhilipp Hahn         BdrvCheckResult result = {0};
988b35278f7SStefan Hajnoczi         qcow2_check_refcounts(bs, &result, 0);
9896cbc3031SPhilipp Hahn     }
990585f8587Sbellard #endif
9916d85a57eSJes Sorensen     return ret;
992585f8587Sbellard 
993585f8587Sbellard  fail:
9947b17ce60SMax Reitz     qemu_opts_del(opts);
9956744cbabSKevin Wolf     g_free(s->unknown_header_fields);
99675bab85cSKevin Wolf     cleanup_unknown_header_ext(bs);
997ed6ccf0fSKevin Wolf     qcow2_free_snapshots(bs);
998ed6ccf0fSKevin Wolf     qcow2_refcount_close(bs);
999de82815dSKevin Wolf     qemu_vfree(s->l1_table);
1000cf93980eSMax Reitz     /* else pre-write overlap checks in cache_destroy may crash */
1001cf93980eSMax Reitz     s->l1_table = NULL;
100229c1a730SKevin Wolf     if (s->l2_table_cache) {
100329c1a730SKevin Wolf         qcow2_cache_destroy(bs, s->l2_table_cache);
100429c1a730SKevin Wolf     }
1005c5a33ee9SPrasad Joshi     if (s->refcount_block_cache) {
1006c5a33ee9SPrasad Joshi         qcow2_cache_destroy(bs, s->refcount_block_cache);
1007c5a33ee9SPrasad Joshi     }
10087267c094SAnthony Liguori     g_free(s->cluster_cache);
1009dea43a65SFrediano Ziglio     qemu_vfree(s->cluster_data);
10106d85a57eSJes Sorensen     return ret;
1011585f8587Sbellard }
1012585f8587Sbellard 
10133baca891SKevin Wolf static void qcow2_refresh_limits(BlockDriverState *bs, Error **errp)
1014d34682cdSKevin Wolf {
1015d34682cdSKevin Wolf     BDRVQcowState *s = bs->opaque;
1016d34682cdSKevin Wolf 
1017d34682cdSKevin Wolf     bs->bl.write_zeroes_alignment = s->cluster_sectors;
1018d34682cdSKevin Wolf }
1019d34682cdSKevin Wolf 
10207c80ab3fSJes Sorensen static int qcow2_set_key(BlockDriverState *bs, const char *key)
1021585f8587Sbellard {
1022585f8587Sbellard     BDRVQcowState *s = bs->opaque;
1023585f8587Sbellard     uint8_t keybuf[16];
1024585f8587Sbellard     int len, i;
1025585f8587Sbellard 
1026585f8587Sbellard     memset(keybuf, 0, 16);
1027585f8587Sbellard     len = strlen(key);
1028585f8587Sbellard     if (len > 16)
1029585f8587Sbellard         len = 16;
1030585f8587Sbellard     /* XXX: we could compress the chars to 7 bits to increase
1031585f8587Sbellard        entropy */
1032585f8587Sbellard     for(i = 0;i < len;i++) {
1033585f8587Sbellard         keybuf[i] = key[i];
1034585f8587Sbellard     }
1035585f8587Sbellard     s->crypt_method = s->crypt_method_header;
1036585f8587Sbellard 
1037585f8587Sbellard     if (AES_set_encrypt_key(keybuf, 128, &s->aes_encrypt_key) != 0)
1038585f8587Sbellard         return -1;
1039585f8587Sbellard     if (AES_set_decrypt_key(keybuf, 128, &s->aes_decrypt_key) != 0)
1040585f8587Sbellard         return -1;
1041585f8587Sbellard #if 0
1042585f8587Sbellard     /* test */
1043585f8587Sbellard     {
1044585f8587Sbellard         uint8_t in[16];
1045585f8587Sbellard         uint8_t out[16];
1046585f8587Sbellard         uint8_t tmp[16];
1047585f8587Sbellard         for(i=0;i<16;i++)
1048585f8587Sbellard             in[i] = i;
1049585f8587Sbellard         AES_encrypt(in, tmp, &s->aes_encrypt_key);
1050585f8587Sbellard         AES_decrypt(tmp, out, &s->aes_decrypt_key);
1051585f8587Sbellard         for(i = 0; i < 16; i++)
1052585f8587Sbellard             printf(" %02x", tmp[i]);
1053585f8587Sbellard         printf("\n");
1054585f8587Sbellard         for(i = 0; i < 16; i++)
1055585f8587Sbellard             printf(" %02x", out[i]);
1056585f8587Sbellard         printf("\n");
1057585f8587Sbellard     }
1058585f8587Sbellard #endif
1059585f8587Sbellard     return 0;
1060585f8587Sbellard }
1061585f8587Sbellard 
10624c2e5f8fSKevin Wolf /* We have no actual commit/abort logic for qcow2, but we need to write out any
10634c2e5f8fSKevin Wolf  * unwritten data if we reopen read-only. */
106421d82ac9SJeff Cody static int qcow2_reopen_prepare(BDRVReopenState *state,
106521d82ac9SJeff Cody                                 BlockReopenQueue *queue, Error **errp)
106621d82ac9SJeff Cody {
10674c2e5f8fSKevin Wolf     int ret;
10684c2e5f8fSKevin Wolf 
10694c2e5f8fSKevin Wolf     if ((state->flags & BDRV_O_RDWR) == 0) {
10704c2e5f8fSKevin Wolf         ret = bdrv_flush(state->bs);
10714c2e5f8fSKevin Wolf         if (ret < 0) {
10724c2e5f8fSKevin Wolf             return ret;
10734c2e5f8fSKevin Wolf         }
10744c2e5f8fSKevin Wolf 
10754c2e5f8fSKevin Wolf         ret = qcow2_mark_clean(state->bs);
10764c2e5f8fSKevin Wolf         if (ret < 0) {
10774c2e5f8fSKevin Wolf             return ret;
10784c2e5f8fSKevin Wolf         }
10794c2e5f8fSKevin Wolf     }
10804c2e5f8fSKevin Wolf 
108121d82ac9SJeff Cody     return 0;
108221d82ac9SJeff Cody }
108321d82ac9SJeff Cody 
1084b6b8a333SPaolo Bonzini static int64_t coroutine_fn qcow2_co_get_block_status(BlockDriverState *bs,
1085f8a2e5e3SStefan Hajnoczi         int64_t sector_num, int nb_sectors, int *pnum)
1086585f8587Sbellard {
1087f8a2e5e3SStefan Hajnoczi     BDRVQcowState *s = bs->opaque;
1088585f8587Sbellard     uint64_t cluster_offset;
10894bc74be9SPaolo Bonzini     int index_in_cluster, ret;
10904bc74be9SPaolo Bonzini     int64_t status = 0;
1091585f8587Sbellard 
1092095a9c58Saliguori     *pnum = nb_sectors;
1093f8a2e5e3SStefan Hajnoczi     qemu_co_mutex_lock(&s->lock);
10941c46efaaSKevin Wolf     ret = qcow2_get_cluster_offset(bs, sector_num << 9, pnum, &cluster_offset);
1095f8a2e5e3SStefan Hajnoczi     qemu_co_mutex_unlock(&s->lock);
10961c46efaaSKevin Wolf     if (ret < 0) {
1097d663640cSPaolo Bonzini         return ret;
10981c46efaaSKevin Wolf     }
1099095a9c58Saliguori 
11004bc74be9SPaolo Bonzini     if (cluster_offset != 0 && ret != QCOW2_CLUSTER_COMPRESSED &&
11014bc74be9SPaolo Bonzini         !s->crypt_method) {
11024bc74be9SPaolo Bonzini         index_in_cluster = sector_num & (s->cluster_sectors - 1);
11034bc74be9SPaolo Bonzini         cluster_offset |= (index_in_cluster << BDRV_SECTOR_BITS);
11044bc74be9SPaolo Bonzini         status |= BDRV_BLOCK_OFFSET_VALID | cluster_offset;
11054bc74be9SPaolo Bonzini     }
11064bc74be9SPaolo Bonzini     if (ret == QCOW2_CLUSTER_ZERO) {
11074bc74be9SPaolo Bonzini         status |= BDRV_BLOCK_ZERO;
11084bc74be9SPaolo Bonzini     } else if (ret != QCOW2_CLUSTER_UNALLOCATED) {
11094bc74be9SPaolo Bonzini         status |= BDRV_BLOCK_DATA;
11104bc74be9SPaolo Bonzini     }
11114bc74be9SPaolo Bonzini     return status;
1112585f8587Sbellard }
1113585f8587Sbellard 
1114a9465922Sbellard /* handle reading after the end of the backing file */
1115bd28f835SKevin Wolf int qcow2_backing_read1(BlockDriverState *bs, QEMUIOVector *qiov,
1116bd28f835SKevin Wolf                   int64_t sector_num, int nb_sectors)
1117a9465922Sbellard {
1118a9465922Sbellard     int n1;
1119a9465922Sbellard     if ((sector_num + nb_sectors) <= bs->total_sectors)
1120a9465922Sbellard         return nb_sectors;
1121a9465922Sbellard     if (sector_num >= bs->total_sectors)
1122a9465922Sbellard         n1 = 0;
1123a9465922Sbellard     else
1124a9465922Sbellard         n1 = bs->total_sectors - sector_num;
1125bd28f835SKevin Wolf 
11263d9b4925SMichael Tokarev     qemu_iovec_memset(qiov, 512 * n1, 0, 512 * (nb_sectors - n1));
1127bd28f835SKevin Wolf 
1128a9465922Sbellard     return n1;
1129a9465922Sbellard }
1130a9465922Sbellard 
1131a968168cSDong Xu Wang static coroutine_fn int qcow2_co_readv(BlockDriverState *bs, int64_t sector_num,
11323fc48d09SFrediano Ziglio                           int remaining_sectors, QEMUIOVector *qiov)
11331490791fSaliguori {
1134585f8587Sbellard     BDRVQcowState *s = bs->opaque;
1135a9465922Sbellard     int index_in_cluster, n1;
113668d100e9SKevin Wolf     int ret;
1137faf575c1SFrediano Ziglio     int cur_nr_sectors; /* number of sectors in current iteration */
1138c2bdd990SFrediano Ziglio     uint64_t cluster_offset = 0;
11393fc48d09SFrediano Ziglio     uint64_t bytes_done = 0;
11403fc48d09SFrediano Ziglio     QEMUIOVector hd_qiov;
11413fc48d09SFrediano Ziglio     uint8_t *cluster_data = NULL;
1142585f8587Sbellard 
11433fc48d09SFrediano Ziglio     qemu_iovec_init(&hd_qiov, qiov->niov);
11443fc48d09SFrediano Ziglio 
11453fc48d09SFrediano Ziglio     qemu_co_mutex_lock(&s->lock);
11463fc48d09SFrediano Ziglio 
11473fc48d09SFrediano Ziglio     while (remaining_sectors != 0) {
1148585f8587Sbellard 
1149faf575c1SFrediano Ziglio         /* prepare next request */
11503fc48d09SFrediano Ziglio         cur_nr_sectors = remaining_sectors;
1151bd28f835SKevin Wolf         if (s->crypt_method) {
1152faf575c1SFrediano Ziglio             cur_nr_sectors = MIN(cur_nr_sectors,
1153bd28f835SKevin Wolf                 QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors);
1154bd28f835SKevin Wolf         }
1155bd28f835SKevin Wolf 
11563fc48d09SFrediano Ziglio         ret = qcow2_get_cluster_offset(bs, sector_num << 9,
1157c2bdd990SFrediano Ziglio             &cur_nr_sectors, &cluster_offset);
11581c46efaaSKevin Wolf         if (ret < 0) {
11593fc48d09SFrediano Ziglio             goto fail;
11601c46efaaSKevin Wolf         }
11611c46efaaSKevin Wolf 
11623fc48d09SFrediano Ziglio         index_in_cluster = sector_num & (s->cluster_sectors - 1);
1163585f8587Sbellard 
11643fc48d09SFrediano Ziglio         qemu_iovec_reset(&hd_qiov);
11651b093c48SMichael Tokarev         qemu_iovec_concat(&hd_qiov, qiov, bytes_done,
1166faf575c1SFrediano Ziglio             cur_nr_sectors * 512);
1167bd28f835SKevin Wolf 
116868d000a3SKevin Wolf         switch (ret) {
116968d000a3SKevin Wolf         case QCOW2_CLUSTER_UNALLOCATED:
1170bd28f835SKevin Wolf 
1171585f8587Sbellard             if (bs->backing_hd) {
1172585f8587Sbellard                 /* read from the base image */
11733fc48d09SFrediano Ziglio                 n1 = qcow2_backing_read1(bs->backing_hd, &hd_qiov,
11743fc48d09SFrediano Ziglio                     sector_num, cur_nr_sectors);
1175a9465922Sbellard                 if (n1 > 0) {
117644deba5aSKevin Wolf                     QEMUIOVector local_qiov;
117744deba5aSKevin Wolf 
117844deba5aSKevin Wolf                     qemu_iovec_init(&local_qiov, hd_qiov.niov);
117944deba5aSKevin Wolf                     qemu_iovec_concat(&local_qiov, &hd_qiov, 0,
118044deba5aSKevin Wolf                                       n1 * BDRV_SECTOR_SIZE);
118144deba5aSKevin Wolf 
118266f82ceeSKevin Wolf                     BLKDBG_EVENT(bs->file, BLKDBG_READ_BACKING_AIO);
118368d100e9SKevin Wolf                     qemu_co_mutex_unlock(&s->lock);
11843fc48d09SFrediano Ziglio                     ret = bdrv_co_readv(bs->backing_hd, sector_num,
118544deba5aSKevin Wolf                                         n1, &local_qiov);
118668d100e9SKevin Wolf                     qemu_co_mutex_lock(&s->lock);
118744deba5aSKevin Wolf 
118844deba5aSKevin Wolf                     qemu_iovec_destroy(&local_qiov);
118944deba5aSKevin Wolf 
119068d100e9SKevin Wolf                     if (ret < 0) {
11913fc48d09SFrediano Ziglio                         goto fail;
11923ab4c7e9SKevin Wolf                     }
11931490791fSaliguori                 }
1194a9465922Sbellard             } else {
1195585f8587Sbellard                 /* Note: in this case, no need to wait */
11963d9b4925SMichael Tokarev                 qemu_iovec_memset(&hd_qiov, 0, 0, 512 * cur_nr_sectors);
11971490791fSaliguori             }
119868d000a3SKevin Wolf             break;
119968d000a3SKevin Wolf 
12006377af48SKevin Wolf         case QCOW2_CLUSTER_ZERO:
12013d9b4925SMichael Tokarev             qemu_iovec_memset(&hd_qiov, 0, 0, 512 * cur_nr_sectors);
12026377af48SKevin Wolf             break;
12036377af48SKevin Wolf 
120468d000a3SKevin Wolf         case QCOW2_CLUSTER_COMPRESSED:
1205585f8587Sbellard             /* add AIO support for compressed blocks ? */
1206c2bdd990SFrediano Ziglio             ret = qcow2_decompress_cluster(bs, cluster_offset);
12078af36488SKevin Wolf             if (ret < 0) {
12083fc48d09SFrediano Ziglio                 goto fail;
12098af36488SKevin Wolf             }
1210bd28f835SKevin Wolf 
121103396148SMichael Tokarev             qemu_iovec_from_buf(&hd_qiov, 0,
1212bd28f835SKevin Wolf                 s->cluster_cache + index_in_cluster * 512,
1213faf575c1SFrediano Ziglio                 512 * cur_nr_sectors);
121468d000a3SKevin Wolf             break;
121568d000a3SKevin Wolf 
121668d000a3SKevin Wolf         case QCOW2_CLUSTER_NORMAL:
1217c2bdd990SFrediano Ziglio             if ((cluster_offset & 511) != 0) {
12183fc48d09SFrediano Ziglio                 ret = -EIO;
12193fc48d09SFrediano Ziglio                 goto fail;
1220585f8587Sbellard             }
1221c87c0672Saliguori 
1222bd28f835SKevin Wolf             if (s->crypt_method) {
1223bd28f835SKevin Wolf                 /*
1224bd28f835SKevin Wolf                  * For encrypted images, read everything into a temporary
1225bd28f835SKevin Wolf                  * contiguous buffer on which the AES functions can work.
1226bd28f835SKevin Wolf                  */
12273fc48d09SFrediano Ziglio                 if (!cluster_data) {
12283fc48d09SFrediano Ziglio                     cluster_data =
1229de82815dSKevin Wolf                         qemu_try_blockalign(bs->file, QCOW_MAX_CRYPT_CLUSTERS
1230de82815dSKevin Wolf                                                       * s->cluster_size);
1231de82815dSKevin Wolf                     if (cluster_data == NULL) {
1232de82815dSKevin Wolf                         ret = -ENOMEM;
1233de82815dSKevin Wolf                         goto fail;
1234de82815dSKevin Wolf                     }
1235bd28f835SKevin Wolf                 }
1236bd28f835SKevin Wolf 
1237faf575c1SFrediano Ziglio                 assert(cur_nr_sectors <=
1238bd28f835SKevin Wolf                     QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors);
12393fc48d09SFrediano Ziglio                 qemu_iovec_reset(&hd_qiov);
12403fc48d09SFrediano Ziglio                 qemu_iovec_add(&hd_qiov, cluster_data,
1241faf575c1SFrediano Ziglio                     512 * cur_nr_sectors);
1242bd28f835SKevin Wolf             }
1243bd28f835SKevin Wolf 
124466f82ceeSKevin Wolf             BLKDBG_EVENT(bs->file, BLKDBG_READ_AIO);
124568d100e9SKevin Wolf             qemu_co_mutex_unlock(&s->lock);
124668d100e9SKevin Wolf             ret = bdrv_co_readv(bs->file,
1247c2bdd990SFrediano Ziglio                                 (cluster_offset >> 9) + index_in_cluster,
12483fc48d09SFrediano Ziglio                                 cur_nr_sectors, &hd_qiov);
124968d100e9SKevin Wolf             qemu_co_mutex_lock(&s->lock);
125068d100e9SKevin Wolf             if (ret < 0) {
12513fc48d09SFrediano Ziglio                 goto fail;
1252585f8587Sbellard             }
1253faf575c1SFrediano Ziglio             if (s->crypt_method) {
12543fc48d09SFrediano Ziglio                 qcow2_encrypt_sectors(s, sector_num,  cluster_data,
12553fc48d09SFrediano Ziglio                     cluster_data, cur_nr_sectors, 0, &s->aes_decrypt_key);
125603396148SMichael Tokarev                 qemu_iovec_from_buf(qiov, bytes_done,
125703396148SMichael Tokarev                     cluster_data, 512 * cur_nr_sectors);
1258171e3d6bSKevin Wolf             }
125968d000a3SKevin Wolf             break;
126068d000a3SKevin Wolf 
126168d000a3SKevin Wolf         default:
126268d000a3SKevin Wolf             g_assert_not_reached();
126368d000a3SKevin Wolf             ret = -EIO;
126468d000a3SKevin Wolf             goto fail;
1265faf575c1SFrediano Ziglio         }
1266faf575c1SFrediano Ziglio 
12673fc48d09SFrediano Ziglio         remaining_sectors -= cur_nr_sectors;
12683fc48d09SFrediano Ziglio         sector_num += cur_nr_sectors;
12693fc48d09SFrediano Ziglio         bytes_done += cur_nr_sectors * 512;
12705ebaa27eSFrediano Ziglio     }
12713fc48d09SFrediano Ziglio     ret = 0;
1272f141eafeSaliguori 
12733fc48d09SFrediano Ziglio fail:
127468d100e9SKevin Wolf     qemu_co_mutex_unlock(&s->lock);
127568d100e9SKevin Wolf 
12763fc48d09SFrediano Ziglio     qemu_iovec_destroy(&hd_qiov);
1277dea43a65SFrediano Ziglio     qemu_vfree(cluster_data);
127868d100e9SKevin Wolf 
127968d100e9SKevin Wolf     return ret;
1280585f8587Sbellard }
1281585f8587Sbellard 
1282a968168cSDong Xu Wang static coroutine_fn int qcow2_co_writev(BlockDriverState *bs,
12833fc48d09SFrediano Ziglio                            int64_t sector_num,
12843fc48d09SFrediano Ziglio                            int remaining_sectors,
12853fc48d09SFrediano Ziglio                            QEMUIOVector *qiov)
1286585f8587Sbellard {
1287585f8587Sbellard     BDRVQcowState *s = bs->opaque;
1288585f8587Sbellard     int index_in_cluster;
128968d100e9SKevin Wolf     int ret;
1290faf575c1SFrediano Ziglio     int cur_nr_sectors; /* number of sectors in current iteration */
1291c2bdd990SFrediano Ziglio     uint64_t cluster_offset;
12923fc48d09SFrediano Ziglio     QEMUIOVector hd_qiov;
12933fc48d09SFrediano Ziglio     uint64_t bytes_done = 0;
12943fc48d09SFrediano Ziglio     uint8_t *cluster_data = NULL;
12958d2497c3SKevin Wolf     QCowL2Meta *l2meta = NULL;
1296c2271403SFrediano Ziglio 
12973cce16f4SKevin Wolf     trace_qcow2_writev_start_req(qemu_coroutine_self(), sector_num,
12983cce16f4SKevin Wolf                                  remaining_sectors);
12993cce16f4SKevin Wolf 
13003fc48d09SFrediano Ziglio     qemu_iovec_init(&hd_qiov, qiov->niov);
1301585f8587Sbellard 
13023fc48d09SFrediano Ziglio     s->cluster_cache_offset = -1; /* disable compressed cache */
13033fc48d09SFrediano Ziglio 
13043fc48d09SFrediano Ziglio     qemu_co_mutex_lock(&s->lock);
13053fc48d09SFrediano Ziglio 
13063fc48d09SFrediano Ziglio     while (remaining_sectors != 0) {
13073fc48d09SFrediano Ziglio 
1308f50f88b9SKevin Wolf         l2meta = NULL;
1309cf5c1a23SKevin Wolf 
13103cce16f4SKevin Wolf         trace_qcow2_writev_start_part(qemu_coroutine_self());
13113fc48d09SFrediano Ziglio         index_in_cluster = sector_num & (s->cluster_sectors - 1);
131216f0587eSHu Tao         cur_nr_sectors = remaining_sectors;
1313095a9c58Saliguori         if (s->crypt_method &&
131416f0587eSHu Tao             cur_nr_sectors >
131516f0587eSHu Tao             QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors - index_in_cluster) {
131616f0587eSHu Tao             cur_nr_sectors =
131716f0587eSHu Tao                 QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors - index_in_cluster;
13185ebaa27eSFrediano Ziglio         }
1319095a9c58Saliguori 
13203fc48d09SFrediano Ziglio         ret = qcow2_alloc_cluster_offset(bs, sector_num << 9,
132116f0587eSHu Tao             &cur_nr_sectors, &cluster_offset, &l2meta);
1322148da7eaSKevin Wolf         if (ret < 0) {
13233fc48d09SFrediano Ziglio             goto fail;
1324148da7eaSKevin Wolf         }
1325148da7eaSKevin Wolf 
1326c2bdd990SFrediano Ziglio         assert((cluster_offset & 511) == 0);
1327148da7eaSKevin Wolf 
13283fc48d09SFrediano Ziglio         qemu_iovec_reset(&hd_qiov);
13291b093c48SMichael Tokarev         qemu_iovec_concat(&hd_qiov, qiov, bytes_done,
1330faf575c1SFrediano Ziglio             cur_nr_sectors * 512);
13316f5f060bSKevin Wolf 
1332585f8587Sbellard         if (s->crypt_method) {
13333fc48d09SFrediano Ziglio             if (!cluster_data) {
1334de82815dSKevin Wolf                 cluster_data = qemu_try_blockalign(bs->file,
1335de82815dSKevin Wolf                                                    QCOW_MAX_CRYPT_CLUSTERS
1336de82815dSKevin Wolf                                                    * s->cluster_size);
1337de82815dSKevin Wolf                 if (cluster_data == NULL) {
1338de82815dSKevin Wolf                     ret = -ENOMEM;
1339de82815dSKevin Wolf                     goto fail;
1340de82815dSKevin Wolf                 }
1341585f8587Sbellard             }
13426f5f060bSKevin Wolf 
13433fc48d09SFrediano Ziglio             assert(hd_qiov.size <=
13445ebaa27eSFrediano Ziglio                    QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size);
1345d5e6b161SMichael Tokarev             qemu_iovec_to_buf(&hd_qiov, 0, cluster_data, hd_qiov.size);
13466f5f060bSKevin Wolf 
13473fc48d09SFrediano Ziglio             qcow2_encrypt_sectors(s, sector_num, cluster_data,
13483fc48d09SFrediano Ziglio                 cluster_data, cur_nr_sectors, 1, &s->aes_encrypt_key);
13496f5f060bSKevin Wolf 
13503fc48d09SFrediano Ziglio             qemu_iovec_reset(&hd_qiov);
13513fc48d09SFrediano Ziglio             qemu_iovec_add(&hd_qiov, cluster_data,
1352faf575c1SFrediano Ziglio                 cur_nr_sectors * 512);
1353585f8587Sbellard         }
13546f5f060bSKevin Wolf 
1355231bb267SMax Reitz         ret = qcow2_pre_write_overlap_check(bs, 0,
1356cf93980eSMax Reitz                 cluster_offset + index_in_cluster * BDRV_SECTOR_SIZE,
1357cf93980eSMax Reitz                 cur_nr_sectors * BDRV_SECTOR_SIZE);
1358cf93980eSMax Reitz         if (ret < 0) {
1359cf93980eSMax Reitz             goto fail;
1360cf93980eSMax Reitz         }
1361cf93980eSMax Reitz 
136268d100e9SKevin Wolf         qemu_co_mutex_unlock(&s->lock);
136367a7a0ebSKevin Wolf         BLKDBG_EVENT(bs->file, BLKDBG_WRITE_AIO);
13643cce16f4SKevin Wolf         trace_qcow2_writev_data(qemu_coroutine_self(),
13653cce16f4SKevin Wolf                                 (cluster_offset >> 9) + index_in_cluster);
136668d100e9SKevin Wolf         ret = bdrv_co_writev(bs->file,
1367c2bdd990SFrediano Ziglio                              (cluster_offset >> 9) + index_in_cluster,
13683fc48d09SFrediano Ziglio                              cur_nr_sectors, &hd_qiov);
136968d100e9SKevin Wolf         qemu_co_mutex_lock(&s->lock);
137068d100e9SKevin Wolf         if (ret < 0) {
13713fc48d09SFrediano Ziglio             goto fail;
1372171e3d6bSKevin Wolf         }
1373f141eafeSaliguori 
137488c6588cSKevin Wolf         while (l2meta != NULL) {
137588c6588cSKevin Wolf             QCowL2Meta *next;
137688c6588cSKevin Wolf 
1377cf5c1a23SKevin Wolf             ret = qcow2_alloc_cluster_link_l2(bs, l2meta);
1378faf575c1SFrediano Ziglio             if (ret < 0) {
13793fc48d09SFrediano Ziglio                 goto fail;
1380faf575c1SFrediano Ziglio             }
1381faf575c1SFrediano Ziglio 
13824e95314eSKevin Wolf             /* Take the request off the list of running requests */
13834e95314eSKevin Wolf             if (l2meta->nb_clusters != 0) {
13844e95314eSKevin Wolf                 QLIST_REMOVE(l2meta, next_in_flight);
13854e95314eSKevin Wolf             }
13864e95314eSKevin Wolf 
13874e95314eSKevin Wolf             qemu_co_queue_restart_all(&l2meta->dependent_requests);
13884e95314eSKevin Wolf 
138988c6588cSKevin Wolf             next = l2meta->next;
1390cf5c1a23SKevin Wolf             g_free(l2meta);
139188c6588cSKevin Wolf             l2meta = next;
1392f50f88b9SKevin Wolf         }
13930fa9131aSKevin Wolf 
13943fc48d09SFrediano Ziglio         remaining_sectors -= cur_nr_sectors;
13953fc48d09SFrediano Ziglio         sector_num += cur_nr_sectors;
13963fc48d09SFrediano Ziglio         bytes_done += cur_nr_sectors * 512;
13973cce16f4SKevin Wolf         trace_qcow2_writev_done_part(qemu_coroutine_self(), cur_nr_sectors);
13985ebaa27eSFrediano Ziglio     }
13993fc48d09SFrediano Ziglio     ret = 0;
1400faf575c1SFrediano Ziglio 
14013fc48d09SFrediano Ziglio fail:
14024e95314eSKevin Wolf     qemu_co_mutex_unlock(&s->lock);
14034e95314eSKevin Wolf 
140488c6588cSKevin Wolf     while (l2meta != NULL) {
140588c6588cSKevin Wolf         QCowL2Meta *next;
140688c6588cSKevin Wolf 
14074e95314eSKevin Wolf         if (l2meta->nb_clusters != 0) {
14084e95314eSKevin Wolf             QLIST_REMOVE(l2meta, next_in_flight);
14094e95314eSKevin Wolf         }
14104e95314eSKevin Wolf         qemu_co_queue_restart_all(&l2meta->dependent_requests);
141188c6588cSKevin Wolf 
141288c6588cSKevin Wolf         next = l2meta->next;
1413cf5c1a23SKevin Wolf         g_free(l2meta);
141488c6588cSKevin Wolf         l2meta = next;
1415cf5c1a23SKevin Wolf     }
14160fa9131aSKevin Wolf 
14173fc48d09SFrediano Ziglio     qemu_iovec_destroy(&hd_qiov);
1418dea43a65SFrediano Ziglio     qemu_vfree(cluster_data);
14193cce16f4SKevin Wolf     trace_qcow2_writev_done_req(qemu_coroutine_self(), ret);
142042496d62SKevin Wolf 
142168d100e9SKevin Wolf     return ret;
1422585f8587Sbellard }
1423585f8587Sbellard 
14247c80ab3fSJes Sorensen static void qcow2_close(BlockDriverState *bs)
1425585f8587Sbellard {
1426585f8587Sbellard     BDRVQcowState *s = bs->opaque;
1427de82815dSKevin Wolf     qemu_vfree(s->l1_table);
1428cf93980eSMax Reitz     /* else pre-write overlap checks in cache_destroy may crash */
1429cf93980eSMax Reitz     s->l1_table = NULL;
143029c1a730SKevin Wolf 
143127eb6c09SKevin Wolf     if (!(bs->open_flags & BDRV_O_INCOMING)) {
14323b5e14c7SMax Reitz         int ret1, ret2;
143329c1a730SKevin Wolf 
14343b5e14c7SMax Reitz         ret1 = qcow2_cache_flush(bs, s->l2_table_cache);
14353b5e14c7SMax Reitz         ret2 = qcow2_cache_flush(bs, s->refcount_block_cache);
14363b5e14c7SMax Reitz 
14373b5e14c7SMax Reitz         if (ret1) {
14383b5e14c7SMax Reitz             error_report("Failed to flush the L2 table cache: %s",
14393b5e14c7SMax Reitz                          strerror(-ret1));
14403b5e14c7SMax Reitz         }
14413b5e14c7SMax Reitz         if (ret2) {
14423b5e14c7SMax Reitz             error_report("Failed to flush the refcount block cache: %s",
14433b5e14c7SMax Reitz                          strerror(-ret2));
14443b5e14c7SMax Reitz         }
14453b5e14c7SMax Reitz 
14463b5e14c7SMax Reitz         if (!ret1 && !ret2) {
1447c61d0004SStefan Hajnoczi             qcow2_mark_clean(bs);
144827eb6c09SKevin Wolf         }
14493b5e14c7SMax Reitz     }
1450c61d0004SStefan Hajnoczi 
145129c1a730SKevin Wolf     qcow2_cache_destroy(bs, s->l2_table_cache);
145229c1a730SKevin Wolf     qcow2_cache_destroy(bs, s->refcount_block_cache);
145329c1a730SKevin Wolf 
14546744cbabSKevin Wolf     g_free(s->unknown_header_fields);
145575bab85cSKevin Wolf     cleanup_unknown_header_ext(bs);
14566744cbabSKevin Wolf 
14577267c094SAnthony Liguori     g_free(s->cluster_cache);
1458dea43a65SFrediano Ziglio     qemu_vfree(s->cluster_data);
1459ed6ccf0fSKevin Wolf     qcow2_refcount_close(bs);
146028c1202bSLi Zhi Hui     qcow2_free_snapshots(bs);
1461585f8587Sbellard }
1462585f8587Sbellard 
14635a8a30dbSKevin Wolf static void qcow2_invalidate_cache(BlockDriverState *bs, Error **errp)
146406d9260fSAnthony Liguori {
146506d9260fSAnthony Liguori     BDRVQcowState *s = bs->opaque;
146606d9260fSAnthony Liguori     int flags = s->flags;
146706d9260fSAnthony Liguori     AES_KEY aes_encrypt_key;
146806d9260fSAnthony Liguori     AES_KEY aes_decrypt_key;
146906d9260fSAnthony Liguori     uint32_t crypt_method = 0;
1470acdfb480SKevin Wolf     QDict *options;
14715a8a30dbSKevin Wolf     Error *local_err = NULL;
14725a8a30dbSKevin Wolf     int ret;
147306d9260fSAnthony Liguori 
147406d9260fSAnthony Liguori     /*
147506d9260fSAnthony Liguori      * Backing files are read-only which makes all of their metadata immutable,
147606d9260fSAnthony Liguori      * that means we don't have to worry about reopening them here.
147706d9260fSAnthony Liguori      */
147806d9260fSAnthony Liguori 
147906d9260fSAnthony Liguori     if (s->crypt_method) {
148006d9260fSAnthony Liguori         crypt_method = s->crypt_method;
148106d9260fSAnthony Liguori         memcpy(&aes_encrypt_key, &s->aes_encrypt_key, sizeof(aes_encrypt_key));
148206d9260fSAnthony Liguori         memcpy(&aes_decrypt_key, &s->aes_decrypt_key, sizeof(aes_decrypt_key));
148306d9260fSAnthony Liguori     }
148406d9260fSAnthony Liguori 
148506d9260fSAnthony Liguori     qcow2_close(bs);
148606d9260fSAnthony Liguori 
14875a8a30dbSKevin Wolf     bdrv_invalidate_cache(bs->file, &local_err);
14885a8a30dbSKevin Wolf     if (local_err) {
14895a8a30dbSKevin Wolf         error_propagate(errp, local_err);
14905a8a30dbSKevin Wolf         return;
14915a8a30dbSKevin Wolf     }
14923456a8d1SKevin Wolf 
149306d9260fSAnthony Liguori     memset(s, 0, sizeof(BDRVQcowState));
1494d475e5acSKevin Wolf     options = qdict_clone_shallow(bs->options);
14955a8a30dbSKevin Wolf 
14965a8a30dbSKevin Wolf     ret = qcow2_open(bs, options, flags, &local_err);
1497a1904e48SMarkus Armbruster     QDECREF(options);
14985a8a30dbSKevin Wolf     if (local_err) {
14995a8a30dbSKevin Wolf         error_setg(errp, "Could not reopen qcow2 layer: %s",
15005a8a30dbSKevin Wolf                    error_get_pretty(local_err));
15015a8a30dbSKevin Wolf         error_free(local_err);
15025a8a30dbSKevin Wolf         return;
15035a8a30dbSKevin Wolf     } else if (ret < 0) {
15045a8a30dbSKevin Wolf         error_setg_errno(errp, -ret, "Could not reopen qcow2 layer");
15055a8a30dbSKevin Wolf         return;
15065a8a30dbSKevin Wolf     }
1507acdfb480SKevin Wolf 
150806d9260fSAnthony Liguori     if (crypt_method) {
150906d9260fSAnthony Liguori         s->crypt_method = crypt_method;
151006d9260fSAnthony Liguori         memcpy(&s->aes_encrypt_key, &aes_encrypt_key, sizeof(aes_encrypt_key));
151106d9260fSAnthony Liguori         memcpy(&s->aes_decrypt_key, &aes_decrypt_key, sizeof(aes_decrypt_key));
151206d9260fSAnthony Liguori     }
151306d9260fSAnthony Liguori }
151406d9260fSAnthony Liguori 
1515e24e49e6SKevin Wolf static size_t header_ext_add(char *buf, uint32_t magic, const void *s,
1516e24e49e6SKevin Wolf     size_t len, size_t buflen)
1517756e6736SKevin Wolf {
1518e24e49e6SKevin Wolf     QCowExtension *ext_backing_fmt = (QCowExtension*) buf;
1519e24e49e6SKevin Wolf     size_t ext_len = sizeof(QCowExtension) + ((len + 7) & ~7);
1520756e6736SKevin Wolf 
1521e24e49e6SKevin Wolf     if (buflen < ext_len) {
1522756e6736SKevin Wolf         return -ENOSPC;
1523756e6736SKevin Wolf     }
1524756e6736SKevin Wolf 
1525e24e49e6SKevin Wolf     *ext_backing_fmt = (QCowExtension) {
1526e24e49e6SKevin Wolf         .magic  = cpu_to_be32(magic),
1527e24e49e6SKevin Wolf         .len    = cpu_to_be32(len),
1528e24e49e6SKevin Wolf     };
1529e24e49e6SKevin Wolf     memcpy(buf + sizeof(QCowExtension), s, len);
1530756e6736SKevin Wolf 
1531e24e49e6SKevin Wolf     return ext_len;
1532756e6736SKevin Wolf }
1533756e6736SKevin Wolf 
1534e24e49e6SKevin Wolf /*
1535e24e49e6SKevin Wolf  * Updates the qcow2 header, including the variable length parts of it, i.e.
1536e24e49e6SKevin Wolf  * the backing file name and all extensions. qcow2 was not designed to allow
1537e24e49e6SKevin Wolf  * such changes, so if we run out of space (we can only use the first cluster)
1538e24e49e6SKevin Wolf  * this function may fail.
1539e24e49e6SKevin Wolf  *
1540e24e49e6SKevin Wolf  * Returns 0 on success, -errno in error cases.
1541e24e49e6SKevin Wolf  */
1542e24e49e6SKevin Wolf int qcow2_update_header(BlockDriverState *bs)
1543e24e49e6SKevin Wolf {
1544e24e49e6SKevin Wolf     BDRVQcowState *s = bs->opaque;
1545e24e49e6SKevin Wolf     QCowHeader *header;
1546e24e49e6SKevin Wolf     char *buf;
1547e24e49e6SKevin Wolf     size_t buflen = s->cluster_size;
1548e24e49e6SKevin Wolf     int ret;
1549e24e49e6SKevin Wolf     uint64_t total_size;
1550e24e49e6SKevin Wolf     uint32_t refcount_table_clusters;
15516744cbabSKevin Wolf     size_t header_length;
155275bab85cSKevin Wolf     Qcow2UnknownHeaderExtension *uext;
1553e24e49e6SKevin Wolf 
1554e24e49e6SKevin Wolf     buf = qemu_blockalign(bs, buflen);
1555e24e49e6SKevin Wolf 
1556e24e49e6SKevin Wolf     /* Header structure */
1557e24e49e6SKevin Wolf     header = (QCowHeader*) buf;
1558e24e49e6SKevin Wolf 
1559e24e49e6SKevin Wolf     if (buflen < sizeof(*header)) {
1560e24e49e6SKevin Wolf         ret = -ENOSPC;
1561e24e49e6SKevin Wolf         goto fail;
1562756e6736SKevin Wolf     }
1563756e6736SKevin Wolf 
15646744cbabSKevin Wolf     header_length = sizeof(*header) + s->unknown_header_fields_size;
1565e24e49e6SKevin Wolf     total_size = bs->total_sectors * BDRV_SECTOR_SIZE;
1566e24e49e6SKevin Wolf     refcount_table_clusters = s->refcount_table_size >> (s->cluster_bits - 3);
1567e24e49e6SKevin Wolf 
1568e24e49e6SKevin Wolf     *header = (QCowHeader) {
15696744cbabSKevin Wolf         /* Version 2 fields */
1570e24e49e6SKevin Wolf         .magic                  = cpu_to_be32(QCOW_MAGIC),
15716744cbabSKevin Wolf         .version                = cpu_to_be32(s->qcow_version),
1572e24e49e6SKevin Wolf         .backing_file_offset    = 0,
1573e24e49e6SKevin Wolf         .backing_file_size      = 0,
1574e24e49e6SKevin Wolf         .cluster_bits           = cpu_to_be32(s->cluster_bits),
1575e24e49e6SKevin Wolf         .size                   = cpu_to_be64(total_size),
1576e24e49e6SKevin Wolf         .crypt_method           = cpu_to_be32(s->crypt_method_header),
1577e24e49e6SKevin Wolf         .l1_size                = cpu_to_be32(s->l1_size),
1578e24e49e6SKevin Wolf         .l1_table_offset        = cpu_to_be64(s->l1_table_offset),
1579e24e49e6SKevin Wolf         .refcount_table_offset  = cpu_to_be64(s->refcount_table_offset),
1580e24e49e6SKevin Wolf         .refcount_table_clusters = cpu_to_be32(refcount_table_clusters),
1581e24e49e6SKevin Wolf         .nb_snapshots           = cpu_to_be32(s->nb_snapshots),
1582e24e49e6SKevin Wolf         .snapshots_offset       = cpu_to_be64(s->snapshots_offset),
15836744cbabSKevin Wolf 
15846744cbabSKevin Wolf         /* Version 3 fields */
15856744cbabSKevin Wolf         .incompatible_features  = cpu_to_be64(s->incompatible_features),
15866744cbabSKevin Wolf         .compatible_features    = cpu_to_be64(s->compatible_features),
15876744cbabSKevin Wolf         .autoclear_features     = cpu_to_be64(s->autoclear_features),
1588b6481f37SMax Reitz         .refcount_order         = cpu_to_be32(s->refcount_order),
15896744cbabSKevin Wolf         .header_length          = cpu_to_be32(header_length),
1590e24e49e6SKevin Wolf     };
1591e24e49e6SKevin Wolf 
15926744cbabSKevin Wolf     /* For older versions, write a shorter header */
15936744cbabSKevin Wolf     switch (s->qcow_version) {
15946744cbabSKevin Wolf     case 2:
15956744cbabSKevin Wolf         ret = offsetof(QCowHeader, incompatible_features);
15966744cbabSKevin Wolf         break;
15976744cbabSKevin Wolf     case 3:
15986744cbabSKevin Wolf         ret = sizeof(*header);
15996744cbabSKevin Wolf         break;
16006744cbabSKevin Wolf     default:
1601b6c14762SJim Meyering         ret = -EINVAL;
1602b6c14762SJim Meyering         goto fail;
16036744cbabSKevin Wolf     }
16046744cbabSKevin Wolf 
16056744cbabSKevin Wolf     buf += ret;
16066744cbabSKevin Wolf     buflen -= ret;
16076744cbabSKevin Wolf     memset(buf, 0, buflen);
16086744cbabSKevin Wolf 
16096744cbabSKevin Wolf     /* Preserve any unknown field in the header */
16106744cbabSKevin Wolf     if (s->unknown_header_fields_size) {
16116744cbabSKevin Wolf         if (buflen < s->unknown_header_fields_size) {
16126744cbabSKevin Wolf             ret = -ENOSPC;
16136744cbabSKevin Wolf             goto fail;
16146744cbabSKevin Wolf         }
16156744cbabSKevin Wolf 
16166744cbabSKevin Wolf         memcpy(buf, s->unknown_header_fields, s->unknown_header_fields_size);
16176744cbabSKevin Wolf         buf += s->unknown_header_fields_size;
16186744cbabSKevin Wolf         buflen -= s->unknown_header_fields_size;
16196744cbabSKevin Wolf     }
1620e24e49e6SKevin Wolf 
1621e24e49e6SKevin Wolf     /* Backing file format header extension */
1622e24e49e6SKevin Wolf     if (*bs->backing_format) {
1623e24e49e6SKevin Wolf         ret = header_ext_add(buf, QCOW2_EXT_MAGIC_BACKING_FORMAT,
1624e24e49e6SKevin Wolf                              bs->backing_format, strlen(bs->backing_format),
1625e24e49e6SKevin Wolf                              buflen);
1626756e6736SKevin Wolf         if (ret < 0) {
1627756e6736SKevin Wolf             goto fail;
1628756e6736SKevin Wolf         }
1629756e6736SKevin Wolf 
1630e24e49e6SKevin Wolf         buf += ret;
1631e24e49e6SKevin Wolf         buflen -= ret;
1632e24e49e6SKevin Wolf     }
1633756e6736SKevin Wolf 
1634cfcc4c62SKevin Wolf     /* Feature table */
1635cfcc4c62SKevin Wolf     Qcow2Feature features[] = {
1636c61d0004SStefan Hajnoczi         {
1637c61d0004SStefan Hajnoczi             .type = QCOW2_FEAT_TYPE_INCOMPATIBLE,
1638c61d0004SStefan Hajnoczi             .bit  = QCOW2_INCOMPAT_DIRTY_BITNR,
1639c61d0004SStefan Hajnoczi             .name = "dirty bit",
1640c61d0004SStefan Hajnoczi         },
1641bfe8043eSStefan Hajnoczi         {
164269c98726SMax Reitz             .type = QCOW2_FEAT_TYPE_INCOMPATIBLE,
164369c98726SMax Reitz             .bit  = QCOW2_INCOMPAT_CORRUPT_BITNR,
164469c98726SMax Reitz             .name = "corrupt bit",
164569c98726SMax Reitz         },
164669c98726SMax Reitz         {
1647bfe8043eSStefan Hajnoczi             .type = QCOW2_FEAT_TYPE_COMPATIBLE,
1648bfe8043eSStefan Hajnoczi             .bit  = QCOW2_COMPAT_LAZY_REFCOUNTS_BITNR,
1649bfe8043eSStefan Hajnoczi             .name = "lazy refcounts",
1650bfe8043eSStefan Hajnoczi         },
1651cfcc4c62SKevin Wolf     };
1652cfcc4c62SKevin Wolf 
1653cfcc4c62SKevin Wolf     ret = header_ext_add(buf, QCOW2_EXT_MAGIC_FEATURE_TABLE,
1654cfcc4c62SKevin Wolf                          features, sizeof(features), buflen);
1655cfcc4c62SKevin Wolf     if (ret < 0) {
1656cfcc4c62SKevin Wolf         goto fail;
1657cfcc4c62SKevin Wolf     }
1658cfcc4c62SKevin Wolf     buf += ret;
1659cfcc4c62SKevin Wolf     buflen -= ret;
1660cfcc4c62SKevin Wolf 
166175bab85cSKevin Wolf     /* Keep unknown header extensions */
166275bab85cSKevin Wolf     QLIST_FOREACH(uext, &s->unknown_header_ext, next) {
166375bab85cSKevin Wolf         ret = header_ext_add(buf, uext->magic, uext->data, uext->len, buflen);
166475bab85cSKevin Wolf         if (ret < 0) {
166575bab85cSKevin Wolf             goto fail;
166675bab85cSKevin Wolf         }
166775bab85cSKevin Wolf 
166875bab85cSKevin Wolf         buf += ret;
166975bab85cSKevin Wolf         buflen -= ret;
167075bab85cSKevin Wolf     }
167175bab85cSKevin Wolf 
1672e24e49e6SKevin Wolf     /* End of header extensions */
1673e24e49e6SKevin Wolf     ret = header_ext_add(buf, QCOW2_EXT_MAGIC_END, NULL, 0, buflen);
1674756e6736SKevin Wolf     if (ret < 0) {
1675756e6736SKevin Wolf         goto fail;
1676756e6736SKevin Wolf     }
1677756e6736SKevin Wolf 
1678e24e49e6SKevin Wolf     buf += ret;
1679e24e49e6SKevin Wolf     buflen -= ret;
1680e24e49e6SKevin Wolf 
1681e24e49e6SKevin Wolf     /* Backing file name */
1682e24e49e6SKevin Wolf     if (*bs->backing_file) {
1683e24e49e6SKevin Wolf         size_t backing_file_len = strlen(bs->backing_file);
1684e24e49e6SKevin Wolf 
1685e24e49e6SKevin Wolf         if (buflen < backing_file_len) {
1686e24e49e6SKevin Wolf             ret = -ENOSPC;
1687e24e49e6SKevin Wolf             goto fail;
1688e24e49e6SKevin Wolf         }
1689e24e49e6SKevin Wolf 
169000ea1881SJim Meyering         /* Using strncpy is ok here, since buf is not NUL-terminated. */
1691e24e49e6SKevin Wolf         strncpy(buf, bs->backing_file, buflen);
1692e24e49e6SKevin Wolf 
1693e24e49e6SKevin Wolf         header->backing_file_offset = cpu_to_be64(buf - ((char*) header));
1694e24e49e6SKevin Wolf         header->backing_file_size   = cpu_to_be32(backing_file_len);
1695e24e49e6SKevin Wolf     }
1696e24e49e6SKevin Wolf 
1697e24e49e6SKevin Wolf     /* Write the new header */
1698e24e49e6SKevin Wolf     ret = bdrv_pwrite(bs->file, 0, header, s->cluster_size);
1699756e6736SKevin Wolf     if (ret < 0) {
1700756e6736SKevin Wolf         goto fail;
1701756e6736SKevin Wolf     }
1702756e6736SKevin Wolf 
1703756e6736SKevin Wolf     ret = 0;
1704756e6736SKevin Wolf fail:
1705e24e49e6SKevin Wolf     qemu_vfree(header);
1706756e6736SKevin Wolf     return ret;
1707756e6736SKevin Wolf }
1708756e6736SKevin Wolf 
1709756e6736SKevin Wolf static int qcow2_change_backing_file(BlockDriverState *bs,
1710756e6736SKevin Wolf     const char *backing_file, const char *backing_fmt)
1711756e6736SKevin Wolf {
1712e24e49e6SKevin Wolf     pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: "");
1713e24e49e6SKevin Wolf     pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: "");
1714e24e49e6SKevin Wolf 
1715e24e49e6SKevin Wolf     return qcow2_update_header(bs);
1716756e6736SKevin Wolf }
1717756e6736SKevin Wolf 
1718a35e1c17SKevin Wolf static int preallocate(BlockDriverState *bs)
1719a35e1c17SKevin Wolf {
1720a35e1c17SKevin Wolf     uint64_t nb_sectors;
1721a35e1c17SKevin Wolf     uint64_t offset;
1722060bee89SKevin Wolf     uint64_t host_offset = 0;
1723a35e1c17SKevin Wolf     int num;
1724148da7eaSKevin Wolf     int ret;
1725f50f88b9SKevin Wolf     QCowL2Meta *meta;
1726a35e1c17SKevin Wolf 
172757322b78SMarkus Armbruster     nb_sectors = bdrv_nb_sectors(bs);
1728a35e1c17SKevin Wolf     offset = 0;
1729a35e1c17SKevin Wolf 
1730a35e1c17SKevin Wolf     while (nb_sectors) {
17317c2bbf4aSHu Tao         num = MIN(nb_sectors, INT_MAX >> BDRV_SECTOR_BITS);
173216f0587eSHu Tao         ret = qcow2_alloc_cluster_offset(bs, offset, &num,
1733060bee89SKevin Wolf                                          &host_offset, &meta);
1734148da7eaSKevin Wolf         if (ret < 0) {
173519dbcbf7SKevin Wolf             return ret;
1736a35e1c17SKevin Wolf         }
1737a35e1c17SKevin Wolf 
1738c792707fSStefan Hajnoczi         while (meta) {
1739c792707fSStefan Hajnoczi             QCowL2Meta *next = meta->next;
1740c792707fSStefan Hajnoczi 
1741f50f88b9SKevin Wolf             ret = qcow2_alloc_cluster_link_l2(bs, meta);
174219dbcbf7SKevin Wolf             if (ret < 0) {
17437c2bbf4aSHu Tao                 qcow2_free_any_clusters(bs, meta->alloc_offset,
17447c2bbf4aSHu Tao                                         meta->nb_clusters, QCOW2_DISCARD_NEVER);
174519dbcbf7SKevin Wolf                 return ret;
1746a35e1c17SKevin Wolf             }
1747a35e1c17SKevin Wolf 
17487c2bbf4aSHu Tao             /* There are no dependent requests, but we need to remove our
17497c2bbf4aSHu Tao              * request from the list of in-flight requests */
17504e95314eSKevin Wolf             QLIST_REMOVE(meta, next_in_flight);
1751c792707fSStefan Hajnoczi 
1752c792707fSStefan Hajnoczi             g_free(meta);
1753c792707fSStefan Hajnoczi             meta = next;
1754f50f88b9SKevin Wolf         }
1755f214978aSKevin Wolf 
1756a35e1c17SKevin Wolf         /* TODO Preallocate data if requested */
1757a35e1c17SKevin Wolf 
1758a35e1c17SKevin Wolf         nb_sectors -= num;
17597c2bbf4aSHu Tao         offset += num << BDRV_SECTOR_BITS;
1760a35e1c17SKevin Wolf     }
1761a35e1c17SKevin Wolf 
1762a35e1c17SKevin Wolf     /*
1763a35e1c17SKevin Wolf      * It is expected that the image file is large enough to actually contain
1764a35e1c17SKevin Wolf      * all of the allocated clusters (otherwise we get failing reads after
1765a35e1c17SKevin Wolf      * EOF). Extend the image to the last allocated sector.
1766a35e1c17SKevin Wolf      */
1767060bee89SKevin Wolf     if (host_offset != 0) {
17687c2bbf4aSHu Tao         uint8_t buf[BDRV_SECTOR_SIZE];
17697c2bbf4aSHu Tao         memset(buf, 0, BDRV_SECTOR_SIZE);
17707c2bbf4aSHu Tao         ret = bdrv_write(bs->file, (host_offset >> BDRV_SECTOR_BITS) + num - 1,
17717c2bbf4aSHu Tao                          buf, 1);
177219dbcbf7SKevin Wolf         if (ret < 0) {
177319dbcbf7SKevin Wolf             return ret;
177419dbcbf7SKevin Wolf         }
1775a35e1c17SKevin Wolf     }
1776a35e1c17SKevin Wolf 
1777a35e1c17SKevin Wolf     return 0;
1778a35e1c17SKevin Wolf }
1779a35e1c17SKevin Wolf 
17807c80ab3fSJes Sorensen static int qcow2_create2(const char *filename, int64_t total_size,
1781a9420734SKevin Wolf                          const char *backing_file, const char *backing_format,
1782ffeaac9bSHu Tao                          int flags, size_t cluster_size, PreallocMode prealloc,
17831bd0e2d1SChunyan Liu                          QemuOpts *opts, int version,
17843ef6c40aSMax Reitz                          Error **errp)
1785a9420734SKevin Wolf {
17869b2260cbSDong Xu Wang     /* Calculate cluster_bits */
1787a9420734SKevin Wolf     int cluster_bits;
1788a9420734SKevin Wolf     cluster_bits = ffs(cluster_size) - 1;
1789a9420734SKevin Wolf     if (cluster_bits < MIN_CLUSTER_BITS || cluster_bits > MAX_CLUSTER_BITS ||
1790a9420734SKevin Wolf         (1 << cluster_bits) != cluster_size)
1791a9420734SKevin Wolf     {
17923ef6c40aSMax Reitz         error_setg(errp, "Cluster size must be a power of two between %d and "
17933ef6c40aSMax Reitz                    "%dk", 1 << MIN_CLUSTER_BITS, 1 << (MAX_CLUSTER_BITS - 10));
1794a9420734SKevin Wolf         return -EINVAL;
1795a9420734SKevin Wolf     }
1796a9420734SKevin Wolf 
1797a9420734SKevin Wolf     /*
1798a9420734SKevin Wolf      * Open the image file and write a minimal qcow2 header.
1799a9420734SKevin Wolf      *
1800a9420734SKevin Wolf      * We keep things simple and start with a zero-sized image. We also
1801a9420734SKevin Wolf      * do without refcount blocks or a L1 table for now. We'll fix the
1802a9420734SKevin Wolf      * inconsistency later.
1803a9420734SKevin Wolf      *
1804a9420734SKevin Wolf      * We do need a refcount table because growing the refcount table means
1805a9420734SKevin Wolf      * allocating two new refcount blocks - the seconds of which would be at
1806a9420734SKevin Wolf      * 2 GB for 64k clusters, and we don't want to have a 2 GB initial file
1807a9420734SKevin Wolf      * size for any qcow2 image.
1808a9420734SKevin Wolf      */
1809a9420734SKevin Wolf     BlockDriverState* bs;
1810f8413b3cSKevin Wolf     QCowHeader *header;
1811b106ad91SKevin Wolf     uint64_t* refcount_table;
18123ef6c40aSMax Reitz     Error *local_err = NULL;
1813a9420734SKevin Wolf     int ret;
1814a9420734SKevin Wolf 
18150e4271b7SHu Tao     if (prealloc == PREALLOC_MODE_FULL || prealloc == PREALLOC_MODE_FALLOC) {
18160e4271b7SHu Tao         int64_t meta_size = 0;
18170e4271b7SHu Tao         uint64_t nreftablee, nrefblocke, nl1e, nl2e;
18180e4271b7SHu Tao         int64_t aligned_total_size = align_offset(total_size, cluster_size);
18190e4271b7SHu Tao 
18200e4271b7SHu Tao         /* header: 1 cluster */
18210e4271b7SHu Tao         meta_size += cluster_size;
18220e4271b7SHu Tao 
18230e4271b7SHu Tao         /* total size of L2 tables */
18240e4271b7SHu Tao         nl2e = aligned_total_size / cluster_size;
18250e4271b7SHu Tao         nl2e = align_offset(nl2e, cluster_size / sizeof(uint64_t));
18260e4271b7SHu Tao         meta_size += nl2e * sizeof(uint64_t);
18270e4271b7SHu Tao 
18280e4271b7SHu Tao         /* total size of L1 tables */
18290e4271b7SHu Tao         nl1e = nl2e * sizeof(uint64_t) / cluster_size;
18300e4271b7SHu Tao         nl1e = align_offset(nl1e, cluster_size / sizeof(uint64_t));
18310e4271b7SHu Tao         meta_size += nl1e * sizeof(uint64_t);
18320e4271b7SHu Tao 
18330e4271b7SHu Tao         /* total size of refcount blocks
18340e4271b7SHu Tao          *
18350e4271b7SHu Tao          * note: every host cluster is reference-counted, including metadata
18360e4271b7SHu Tao          * (even refcount blocks are recursively included).
18370e4271b7SHu Tao          * Let:
18380e4271b7SHu Tao          *   a = total_size (this is the guest disk size)
18390e4271b7SHu Tao          *   m = meta size not including refcount blocks and refcount tables
18400e4271b7SHu Tao          *   c = cluster size
18410e4271b7SHu Tao          *   y1 = number of refcount blocks entries
18420e4271b7SHu Tao          *   y2 = meta size including everything
18430e4271b7SHu Tao          * then,
18440e4271b7SHu Tao          *   y1 = (y2 + a)/c
18450e4271b7SHu Tao          *   y2 = y1 * sizeof(u16) + y1 * sizeof(u16) * sizeof(u64) / c + m
18460e4271b7SHu Tao          * we can get y1:
18470e4271b7SHu Tao          *   y1 = (a + m) / (c - sizeof(u16) - sizeof(u16) * sizeof(u64) / c)
18480e4271b7SHu Tao          */
18490e4271b7SHu Tao         nrefblocke = (aligned_total_size + meta_size + cluster_size) /
18500e4271b7SHu Tao             (cluster_size - sizeof(uint16_t) -
18510e4271b7SHu Tao              1.0 * sizeof(uint16_t) * sizeof(uint64_t) / cluster_size);
18520e4271b7SHu Tao         nrefblocke = align_offset(nrefblocke, cluster_size / sizeof(uint16_t));
18530e4271b7SHu Tao         meta_size += nrefblocke * sizeof(uint16_t);
18540e4271b7SHu Tao 
18550e4271b7SHu Tao         /* total size of refcount tables */
18560e4271b7SHu Tao         nreftablee = nrefblocke * sizeof(uint16_t) / cluster_size;
18570e4271b7SHu Tao         nreftablee = align_offset(nreftablee, cluster_size / sizeof(uint64_t));
18580e4271b7SHu Tao         meta_size += nreftablee * sizeof(uint64_t);
18590e4271b7SHu Tao 
18600e4271b7SHu Tao         qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
18610e4271b7SHu Tao                             aligned_total_size + meta_size);
18620e4271b7SHu Tao         qemu_opt_set(opts, BLOCK_OPT_PREALLOC, PreallocMode_lookup[prealloc]);
18630e4271b7SHu Tao     }
18640e4271b7SHu Tao 
1865c282e1fdSChunyan Liu     ret = bdrv_create_file(filename, opts, &local_err);
1866a9420734SKevin Wolf     if (ret < 0) {
18673ef6c40aSMax Reitz         error_propagate(errp, local_err);
1868a9420734SKevin Wolf         return ret;
1869a9420734SKevin Wolf     }
1870a9420734SKevin Wolf 
18712e40134bSMax Reitz     bs = NULL;
18722e40134bSMax Reitz     ret = bdrv_open(&bs, filename, NULL, NULL, BDRV_O_RDWR | BDRV_O_PROTOCOL,
18732e40134bSMax Reitz                     NULL, &local_err);
1874a9420734SKevin Wolf     if (ret < 0) {
18753ef6c40aSMax Reitz         error_propagate(errp, local_err);
1876a9420734SKevin Wolf         return ret;
1877a9420734SKevin Wolf     }
1878a9420734SKevin Wolf 
1879a9420734SKevin Wolf     /* Write the header */
1880f8413b3cSKevin Wolf     QEMU_BUILD_BUG_ON((1 << MIN_CLUSTER_BITS) < sizeof(*header));
1881f8413b3cSKevin Wolf     header = g_malloc0(cluster_size);
1882f8413b3cSKevin Wolf     *header = (QCowHeader) {
1883f8413b3cSKevin Wolf         .magic                      = cpu_to_be32(QCOW_MAGIC),
1884f8413b3cSKevin Wolf         .version                    = cpu_to_be32(version),
1885f8413b3cSKevin Wolf         .cluster_bits               = cpu_to_be32(cluster_bits),
1886f8413b3cSKevin Wolf         .size                       = cpu_to_be64(0),
1887f8413b3cSKevin Wolf         .l1_table_offset            = cpu_to_be64(0),
1888f8413b3cSKevin Wolf         .l1_size                    = cpu_to_be32(0),
1889f8413b3cSKevin Wolf         .refcount_table_offset      = cpu_to_be64(cluster_size),
1890f8413b3cSKevin Wolf         .refcount_table_clusters    = cpu_to_be32(1),
189117bd5f47SMax Reitz         .refcount_order             = cpu_to_be32(4),
1892f8413b3cSKevin Wolf         .header_length              = cpu_to_be32(sizeof(*header)),
1893f8413b3cSKevin Wolf     };
1894a9420734SKevin Wolf 
1895a9420734SKevin Wolf     if (flags & BLOCK_FLAG_ENCRYPT) {
1896f8413b3cSKevin Wolf         header->crypt_method = cpu_to_be32(QCOW_CRYPT_AES);
1897a9420734SKevin Wolf     } else {
1898f8413b3cSKevin Wolf         header->crypt_method = cpu_to_be32(QCOW_CRYPT_NONE);
1899a9420734SKevin Wolf     }
1900a9420734SKevin Wolf 
1901bfe8043eSStefan Hajnoczi     if (flags & BLOCK_FLAG_LAZY_REFCOUNTS) {
1902f8413b3cSKevin Wolf         header->compatible_features |=
1903bfe8043eSStefan Hajnoczi             cpu_to_be64(QCOW2_COMPAT_LAZY_REFCOUNTS);
1904bfe8043eSStefan Hajnoczi     }
1905bfe8043eSStefan Hajnoczi 
1906f8413b3cSKevin Wolf     ret = bdrv_pwrite(bs, 0, header, cluster_size);
1907f8413b3cSKevin Wolf     g_free(header);
1908a9420734SKevin Wolf     if (ret < 0) {
19093ef6c40aSMax Reitz         error_setg_errno(errp, -ret, "Could not write qcow2 header");
1910a9420734SKevin Wolf         goto out;
1911a9420734SKevin Wolf     }
1912a9420734SKevin Wolf 
1913b106ad91SKevin Wolf     /* Write a refcount table with one refcount block */
1914b106ad91SKevin Wolf     refcount_table = g_malloc0(2 * cluster_size);
1915b106ad91SKevin Wolf     refcount_table[0] = cpu_to_be64(2 * cluster_size);
1916b106ad91SKevin Wolf     ret = bdrv_pwrite(bs, cluster_size, refcount_table, 2 * cluster_size);
19177267c094SAnthony Liguori     g_free(refcount_table);
1918a9420734SKevin Wolf 
1919a9420734SKevin Wolf     if (ret < 0) {
19203ef6c40aSMax Reitz         error_setg_errno(errp, -ret, "Could not write refcount table");
1921a9420734SKevin Wolf         goto out;
1922a9420734SKevin Wolf     }
1923a9420734SKevin Wolf 
1924f67503e5SMax Reitz     bdrv_unref(bs);
1925f67503e5SMax Reitz     bs = NULL;
1926a9420734SKevin Wolf 
1927a9420734SKevin Wolf     /*
1928a9420734SKevin Wolf      * And now open the image and make it consistent first (i.e. increase the
1929a9420734SKevin Wolf      * refcount of the cluster that is occupied by the header and the refcount
1930a9420734SKevin Wolf      * table)
1931a9420734SKevin Wolf      */
1932ddf5636dSMax Reitz     ret = bdrv_open(&bs, filename, NULL, NULL,
1933ef810437SMax Reitz                     BDRV_O_RDWR | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH,
1934ef810437SMax Reitz                     &bdrv_qcow2, &local_err);
1935a9420734SKevin Wolf     if (ret < 0) {
19363ef6c40aSMax Reitz         error_propagate(errp, local_err);
1937a9420734SKevin Wolf         goto out;
1938a9420734SKevin Wolf     }
1939a9420734SKevin Wolf 
1940b106ad91SKevin Wolf     ret = qcow2_alloc_clusters(bs, 3 * cluster_size);
1941a9420734SKevin Wolf     if (ret < 0) {
19423ef6c40aSMax Reitz         error_setg_errno(errp, -ret, "Could not allocate clusters for qcow2 "
19433ef6c40aSMax Reitz                          "header and refcount table");
1944a9420734SKevin Wolf         goto out;
1945a9420734SKevin Wolf 
1946a9420734SKevin Wolf     } else if (ret != 0) {
1947a9420734SKevin Wolf         error_report("Huh, first cluster in empty image is already in use?");
1948a9420734SKevin Wolf         abort();
1949a9420734SKevin Wolf     }
1950a9420734SKevin Wolf 
1951a9420734SKevin Wolf     /* Okay, now that we have a valid image, let's give it the right size */
1952180e9526SHu Tao     ret = bdrv_truncate(bs, total_size);
1953a9420734SKevin Wolf     if (ret < 0) {
19543ef6c40aSMax Reitz         error_setg_errno(errp, -ret, "Could not resize image");
1955a9420734SKevin Wolf         goto out;
1956a9420734SKevin Wolf     }
1957a9420734SKevin Wolf 
1958a9420734SKevin Wolf     /* Want a backing file? There you go.*/
1959a9420734SKevin Wolf     if (backing_file) {
1960a9420734SKevin Wolf         ret = bdrv_change_backing_file(bs, backing_file, backing_format);
1961a9420734SKevin Wolf         if (ret < 0) {
19623ef6c40aSMax Reitz             error_setg_errno(errp, -ret, "Could not assign backing file '%s' "
19633ef6c40aSMax Reitz                              "with format '%s'", backing_file, backing_format);
1964a9420734SKevin Wolf             goto out;
1965a9420734SKevin Wolf         }
1966a9420734SKevin Wolf     }
1967a9420734SKevin Wolf 
1968a9420734SKevin Wolf     /* And if we're supposed to preallocate metadata, do that now */
19690e4271b7SHu Tao     if (prealloc != PREALLOC_MODE_OFF) {
197015552c4aSZhi Yong Wu         BDRVQcowState *s = bs->opaque;
197115552c4aSZhi Yong Wu         qemu_co_mutex_lock(&s->lock);
1972a9420734SKevin Wolf         ret = preallocate(bs);
197315552c4aSZhi Yong Wu         qemu_co_mutex_unlock(&s->lock);
1974a9420734SKevin Wolf         if (ret < 0) {
19753ef6c40aSMax Reitz             error_setg_errno(errp, -ret, "Could not preallocate metadata");
1976a9420734SKevin Wolf             goto out;
1977a9420734SKevin Wolf         }
1978a9420734SKevin Wolf     }
1979a9420734SKevin Wolf 
1980f67503e5SMax Reitz     bdrv_unref(bs);
1981f67503e5SMax Reitz     bs = NULL;
1982ba2ab2f2SMax Reitz 
1983ba2ab2f2SMax Reitz     /* Reopen the image without BDRV_O_NO_FLUSH to flush it before returning */
1984ddf5636dSMax Reitz     ret = bdrv_open(&bs, filename, NULL, NULL,
1985c9fbb99dSKevin Wolf                     BDRV_O_RDWR | BDRV_O_CACHE_WB | BDRV_O_NO_BACKING,
1986ef810437SMax Reitz                     &bdrv_qcow2, &local_err);
198784d18f06SMarkus Armbruster     if (local_err) {
1988ba2ab2f2SMax Reitz         error_propagate(errp, local_err);
1989ba2ab2f2SMax Reitz         goto out;
1990ba2ab2f2SMax Reitz     }
1991ba2ab2f2SMax Reitz 
1992a9420734SKevin Wolf     ret = 0;
1993a9420734SKevin Wolf out:
1994f67503e5SMax Reitz     if (bs) {
19954f6fd349SFam Zheng         bdrv_unref(bs);
1996f67503e5SMax Reitz     }
1997a9420734SKevin Wolf     return ret;
1998a9420734SKevin Wolf }
1999de5f3f40SKevin Wolf 
20001bd0e2d1SChunyan Liu static int qcow2_create(const char *filename, QemuOpts *opts, Error **errp)
2001de5f3f40SKevin Wolf {
20021bd0e2d1SChunyan Liu     char *backing_file = NULL;
20031bd0e2d1SChunyan Liu     char *backing_fmt = NULL;
20041bd0e2d1SChunyan Liu     char *buf = NULL;
2005180e9526SHu Tao     uint64_t size = 0;
2006de5f3f40SKevin Wolf     int flags = 0;
200799cce9faSKevin Wolf     size_t cluster_size = DEFAULT_CLUSTER_SIZE;
2008ffeaac9bSHu Tao     PreallocMode prealloc;
20098ad1898cSKevin Wolf     int version = 3;
20103ef6c40aSMax Reitz     Error *local_err = NULL;
20113ef6c40aSMax Reitz     int ret;
2012de5f3f40SKevin Wolf 
2013de5f3f40SKevin Wolf     /* Read out options */
2014180e9526SHu Tao     size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
2015c2eb918eSHu Tao                     BDRV_SECTOR_SIZE);
20161bd0e2d1SChunyan Liu     backing_file = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FILE);
20171bd0e2d1SChunyan Liu     backing_fmt = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FMT);
20181bd0e2d1SChunyan Liu     if (qemu_opt_get_bool_del(opts, BLOCK_OPT_ENCRYPT, false)) {
20191bd0e2d1SChunyan Liu         flags |= BLOCK_FLAG_ENCRYPT;
2020de5f3f40SKevin Wolf     }
20211bd0e2d1SChunyan Liu     cluster_size = qemu_opt_get_size_del(opts, BLOCK_OPT_CLUSTER_SIZE,
20221bd0e2d1SChunyan Liu                                          DEFAULT_CLUSTER_SIZE);
20231bd0e2d1SChunyan Liu     buf = qemu_opt_get_del(opts, BLOCK_OPT_PREALLOC);
2024ffeaac9bSHu Tao     prealloc = qapi_enum_parse(PreallocMode_lookup, buf,
2025ffeaac9bSHu Tao                                PREALLOC_MODE_MAX, PREALLOC_MODE_OFF,
2026ffeaac9bSHu Tao                                &local_err);
2027ffeaac9bSHu Tao     if (local_err) {
2028ffeaac9bSHu Tao         error_propagate(errp, local_err);
20291bd0e2d1SChunyan Liu         ret = -EINVAL;
20301bd0e2d1SChunyan Liu         goto finish;
2031de5f3f40SKevin Wolf     }
20321bd0e2d1SChunyan Liu     g_free(buf);
20331bd0e2d1SChunyan Liu     buf = qemu_opt_get_del(opts, BLOCK_OPT_COMPAT_LEVEL);
20341bd0e2d1SChunyan Liu     if (!buf) {
20359117b477SKevin Wolf         /* keep the default */
20361bd0e2d1SChunyan Liu     } else if (!strcmp(buf, "0.10")) {
20376744cbabSKevin Wolf         version = 2;
20381bd0e2d1SChunyan Liu     } else if (!strcmp(buf, "1.1")) {
20396744cbabSKevin Wolf         version = 3;
20406744cbabSKevin Wolf     } else {
20411bd0e2d1SChunyan Liu         error_setg(errp, "Invalid compatibility level: '%s'", buf);
20421bd0e2d1SChunyan Liu         ret = -EINVAL;
20431bd0e2d1SChunyan Liu         goto finish;
20446744cbabSKevin Wolf     }
20451bd0e2d1SChunyan Liu 
20461bd0e2d1SChunyan Liu     if (qemu_opt_get_bool_del(opts, BLOCK_OPT_LAZY_REFCOUNTS, false)) {
20471bd0e2d1SChunyan Liu         flags |= BLOCK_FLAG_LAZY_REFCOUNTS;
2048de5f3f40SKevin Wolf     }
2049de5f3f40SKevin Wolf 
2050ffeaac9bSHu Tao     if (backing_file && prealloc != PREALLOC_MODE_OFF) {
20513ef6c40aSMax Reitz         error_setg(errp, "Backing file and preallocation cannot be used at "
20523ef6c40aSMax Reitz                    "the same time");
20531bd0e2d1SChunyan Liu         ret = -EINVAL;
20541bd0e2d1SChunyan Liu         goto finish;
2055de5f3f40SKevin Wolf     }
2056de5f3f40SKevin Wolf 
2057bfe8043eSStefan Hajnoczi     if (version < 3 && (flags & BLOCK_FLAG_LAZY_REFCOUNTS)) {
20583ef6c40aSMax Reitz         error_setg(errp, "Lazy refcounts only supported with compatibility "
20593ef6c40aSMax Reitz                    "level 1.1 and above (use compat=1.1 or greater)");
20601bd0e2d1SChunyan Liu         ret = -EINVAL;
20611bd0e2d1SChunyan Liu         goto finish;
2062bfe8043eSStefan Hajnoczi     }
2063bfe8043eSStefan Hajnoczi 
2064180e9526SHu Tao     ret = qcow2_create2(filename, size, backing_file, backing_fmt, flags,
20651bd0e2d1SChunyan Liu                         cluster_size, prealloc, opts, version, &local_err);
206684d18f06SMarkus Armbruster     if (local_err) {
20673ef6c40aSMax Reitz         error_propagate(errp, local_err);
20683ef6c40aSMax Reitz     }
20691bd0e2d1SChunyan Liu 
20701bd0e2d1SChunyan Liu finish:
20711bd0e2d1SChunyan Liu     g_free(backing_file);
20721bd0e2d1SChunyan Liu     g_free(backing_fmt);
20731bd0e2d1SChunyan Liu     g_free(buf);
20743ef6c40aSMax Reitz     return ret;
2075de5f3f40SKevin Wolf }
2076de5f3f40SKevin Wolf 
2077621f0589SKevin Wolf static coroutine_fn int qcow2_co_write_zeroes(BlockDriverState *bs,
2078aa7bfbffSPeter Lieven     int64_t sector_num, int nb_sectors, BdrvRequestFlags flags)
2079621f0589SKevin Wolf {
2080621f0589SKevin Wolf     int ret;
2081621f0589SKevin Wolf     BDRVQcowState *s = bs->opaque;
2082621f0589SKevin Wolf 
2083621f0589SKevin Wolf     /* Emulate misaligned zero writes */
2084621f0589SKevin Wolf     if (sector_num % s->cluster_sectors || nb_sectors % s->cluster_sectors) {
2085621f0589SKevin Wolf         return -ENOTSUP;
2086621f0589SKevin Wolf     }
2087621f0589SKevin Wolf 
2088621f0589SKevin Wolf     /* Whatever is left can use real zero clusters */
2089621f0589SKevin Wolf     qemu_co_mutex_lock(&s->lock);
2090621f0589SKevin Wolf     ret = qcow2_zero_clusters(bs, sector_num << BDRV_SECTOR_BITS,
2091621f0589SKevin Wolf         nb_sectors);
2092621f0589SKevin Wolf     qemu_co_mutex_unlock(&s->lock);
2093621f0589SKevin Wolf 
2094621f0589SKevin Wolf     return ret;
2095621f0589SKevin Wolf }
2096621f0589SKevin Wolf 
20976db39ae2SPaolo Bonzini static coroutine_fn int qcow2_co_discard(BlockDriverState *bs,
20986db39ae2SPaolo Bonzini     int64_t sector_num, int nb_sectors)
20995ea929e3SKevin Wolf {
21006db39ae2SPaolo Bonzini     int ret;
21016db39ae2SPaolo Bonzini     BDRVQcowState *s = bs->opaque;
21026db39ae2SPaolo Bonzini 
21036db39ae2SPaolo Bonzini     qemu_co_mutex_lock(&s->lock);
21046db39ae2SPaolo Bonzini     ret = qcow2_discard_clusters(bs, sector_num << BDRV_SECTOR_BITS,
2105808c4b6fSMax Reitz         nb_sectors, QCOW2_DISCARD_REQUEST, false);
21066db39ae2SPaolo Bonzini     qemu_co_mutex_unlock(&s->lock);
21076db39ae2SPaolo Bonzini     return ret;
21085ea929e3SKevin Wolf }
21095ea929e3SKevin Wolf 
2110419b19d9SStefan Hajnoczi static int qcow2_truncate(BlockDriverState *bs, int64_t offset)
2111419b19d9SStefan Hajnoczi {
2112419b19d9SStefan Hajnoczi     BDRVQcowState *s = bs->opaque;
21132cf7cfa1SKevin Wolf     int64_t new_l1_size;
21142cf7cfa1SKevin Wolf     int ret;
2115419b19d9SStefan Hajnoczi 
2116419b19d9SStefan Hajnoczi     if (offset & 511) {
2117259b2173SKevin Wolf         error_report("The new size must be a multiple of 512");
2118419b19d9SStefan Hajnoczi         return -EINVAL;
2119419b19d9SStefan Hajnoczi     }
2120419b19d9SStefan Hajnoczi 
2121419b19d9SStefan Hajnoczi     /* cannot proceed if image has snapshots */
2122419b19d9SStefan Hajnoczi     if (s->nb_snapshots) {
2123259b2173SKevin Wolf         error_report("Can't resize an image which has snapshots");
2124419b19d9SStefan Hajnoczi         return -ENOTSUP;
2125419b19d9SStefan Hajnoczi     }
2126419b19d9SStefan Hajnoczi 
2127419b19d9SStefan Hajnoczi     /* shrinking is currently not supported */
2128419b19d9SStefan Hajnoczi     if (offset < bs->total_sectors * 512) {
2129259b2173SKevin Wolf         error_report("qcow2 doesn't support shrinking images yet");
2130419b19d9SStefan Hajnoczi         return -ENOTSUP;
2131419b19d9SStefan Hajnoczi     }
2132419b19d9SStefan Hajnoczi 
2133419b19d9SStefan Hajnoczi     new_l1_size = size_to_l1(s, offset);
213472893756SStefan Hajnoczi     ret = qcow2_grow_l1_table(bs, new_l1_size, true);
2135419b19d9SStefan Hajnoczi     if (ret < 0) {
2136419b19d9SStefan Hajnoczi         return ret;
2137419b19d9SStefan Hajnoczi     }
2138419b19d9SStefan Hajnoczi 
2139419b19d9SStefan Hajnoczi     /* write updated header.size */
2140419b19d9SStefan Hajnoczi     offset = cpu_to_be64(offset);
21418b3b7206SKevin Wolf     ret = bdrv_pwrite_sync(bs->file, offsetof(QCowHeader, size),
2142419b19d9SStefan Hajnoczi                            &offset, sizeof(uint64_t));
2143419b19d9SStefan Hajnoczi     if (ret < 0) {
2144419b19d9SStefan Hajnoczi         return ret;
2145419b19d9SStefan Hajnoczi     }
2146419b19d9SStefan Hajnoczi 
2147419b19d9SStefan Hajnoczi     s->l1_vm_state_index = new_l1_size;
2148419b19d9SStefan Hajnoczi     return 0;
2149419b19d9SStefan Hajnoczi }
2150419b19d9SStefan Hajnoczi 
215120d97356SBlue Swirl /* XXX: put compressed sectors first, then all the cluster aligned
215220d97356SBlue Swirl    tables to avoid losing bytes in alignment */
21537c80ab3fSJes Sorensen static int qcow2_write_compressed(BlockDriverState *bs, int64_t sector_num,
215420d97356SBlue Swirl                                   const uint8_t *buf, int nb_sectors)
215520d97356SBlue Swirl {
215620d97356SBlue Swirl     BDRVQcowState *s = bs->opaque;
215720d97356SBlue Swirl     z_stream strm;
215820d97356SBlue Swirl     int ret, out_len;
215920d97356SBlue Swirl     uint8_t *out_buf;
216020d97356SBlue Swirl     uint64_t cluster_offset;
216120d97356SBlue Swirl 
216220d97356SBlue Swirl     if (nb_sectors == 0) {
216320d97356SBlue Swirl         /* align end of file to a sector boundary to ease reading with
216420d97356SBlue Swirl            sector based I/Os */
216566f82ceeSKevin Wolf         cluster_offset = bdrv_getlength(bs->file);
21666a69b962SMax Reitz         return bdrv_truncate(bs->file, cluster_offset);
216720d97356SBlue Swirl     }
216820d97356SBlue Swirl 
2169f4d38befSStefan Hajnoczi     if (nb_sectors != s->cluster_sectors) {
2170f4d38befSStefan Hajnoczi         ret = -EINVAL;
2171f4d38befSStefan Hajnoczi 
2172f4d38befSStefan Hajnoczi         /* Zero-pad last write if image size is not cluster aligned */
2173f4d38befSStefan Hajnoczi         if (sector_num + nb_sectors == bs->total_sectors &&
2174f4d38befSStefan Hajnoczi             nb_sectors < s->cluster_sectors) {
2175f4d38befSStefan Hajnoczi             uint8_t *pad_buf = qemu_blockalign(bs, s->cluster_size);
2176f4d38befSStefan Hajnoczi             memset(pad_buf, 0, s->cluster_size);
2177f4d38befSStefan Hajnoczi             memcpy(pad_buf, buf, nb_sectors * BDRV_SECTOR_SIZE);
2178f4d38befSStefan Hajnoczi             ret = qcow2_write_compressed(bs, sector_num,
2179f4d38befSStefan Hajnoczi                                          pad_buf, s->cluster_sectors);
2180f4d38befSStefan Hajnoczi             qemu_vfree(pad_buf);
2181f4d38befSStefan Hajnoczi         }
2182f4d38befSStefan Hajnoczi         return ret;
2183f4d38befSStefan Hajnoczi     }
218420d97356SBlue Swirl 
21857267c094SAnthony Liguori     out_buf = g_malloc(s->cluster_size + (s->cluster_size / 1000) + 128);
218620d97356SBlue Swirl 
218720d97356SBlue Swirl     /* best compression, small window, no zlib header */
218820d97356SBlue Swirl     memset(&strm, 0, sizeof(strm));
218920d97356SBlue Swirl     ret = deflateInit2(&strm, Z_DEFAULT_COMPRESSION,
219020d97356SBlue Swirl                        Z_DEFLATED, -12,
219120d97356SBlue Swirl                        9, Z_DEFAULT_STRATEGY);
219220d97356SBlue Swirl     if (ret != 0) {
21938f1efd00SKevin Wolf         ret = -EINVAL;
21948f1efd00SKevin Wolf         goto fail;
219520d97356SBlue Swirl     }
219620d97356SBlue Swirl 
219720d97356SBlue Swirl     strm.avail_in = s->cluster_size;
219820d97356SBlue Swirl     strm.next_in = (uint8_t *)buf;
219920d97356SBlue Swirl     strm.avail_out = s->cluster_size;
220020d97356SBlue Swirl     strm.next_out = out_buf;
220120d97356SBlue Swirl 
220220d97356SBlue Swirl     ret = deflate(&strm, Z_FINISH);
220320d97356SBlue Swirl     if (ret != Z_STREAM_END && ret != Z_OK) {
220420d97356SBlue Swirl         deflateEnd(&strm);
22058f1efd00SKevin Wolf         ret = -EINVAL;
22068f1efd00SKevin Wolf         goto fail;
220720d97356SBlue Swirl     }
220820d97356SBlue Swirl     out_len = strm.next_out - out_buf;
220920d97356SBlue Swirl 
221020d97356SBlue Swirl     deflateEnd(&strm);
221120d97356SBlue Swirl 
221220d97356SBlue Swirl     if (ret != Z_STREAM_END || out_len >= s->cluster_size) {
221320d97356SBlue Swirl         /* could not compress: write normal cluster */
22148f1efd00SKevin Wolf         ret = bdrv_write(bs, sector_num, buf, s->cluster_sectors);
22158f1efd00SKevin Wolf         if (ret < 0) {
22168f1efd00SKevin Wolf             goto fail;
22178f1efd00SKevin Wolf         }
221820d97356SBlue Swirl     } else {
221920d97356SBlue Swirl         cluster_offset = qcow2_alloc_compressed_cluster_offset(bs,
222020d97356SBlue Swirl             sector_num << 9, out_len);
22218f1efd00SKevin Wolf         if (!cluster_offset) {
22228f1efd00SKevin Wolf             ret = -EIO;
22238f1efd00SKevin Wolf             goto fail;
22248f1efd00SKevin Wolf         }
222520d97356SBlue Swirl         cluster_offset &= s->cluster_offset_mask;
2226cf93980eSMax Reitz 
2227231bb267SMax Reitz         ret = qcow2_pre_write_overlap_check(bs, 0, cluster_offset, out_len);
2228cf93980eSMax Reitz         if (ret < 0) {
2229cf93980eSMax Reitz             goto fail;
2230cf93980eSMax Reitz         }
2231cf93980eSMax Reitz 
223266f82ceeSKevin Wolf         BLKDBG_EVENT(bs->file, BLKDBG_WRITE_COMPRESSED);
22338f1efd00SKevin Wolf         ret = bdrv_pwrite(bs->file, cluster_offset, out_buf, out_len);
22348f1efd00SKevin Wolf         if (ret < 0) {
22358f1efd00SKevin Wolf             goto fail;
223620d97356SBlue Swirl         }
223720d97356SBlue Swirl     }
223820d97356SBlue Swirl 
22398f1efd00SKevin Wolf     ret = 0;
22408f1efd00SKevin Wolf fail:
22417267c094SAnthony Liguori     g_free(out_buf);
22428f1efd00SKevin Wolf     return ret;
224320d97356SBlue Swirl }
224420d97356SBlue Swirl 
224594054183SMax Reitz static int make_completely_empty(BlockDriverState *bs)
224694054183SMax Reitz {
224794054183SMax Reitz     BDRVQcowState *s = bs->opaque;
224894054183SMax Reitz     int ret, l1_clusters;
224994054183SMax Reitz     int64_t offset;
225094054183SMax Reitz     uint64_t *new_reftable = NULL;
225194054183SMax Reitz     uint64_t rt_entry, l1_size2;
225294054183SMax Reitz     struct {
225394054183SMax Reitz         uint64_t l1_offset;
225494054183SMax Reitz         uint64_t reftable_offset;
225594054183SMax Reitz         uint32_t reftable_clusters;
225694054183SMax Reitz     } QEMU_PACKED l1_ofs_rt_ofs_cls;
225794054183SMax Reitz 
225894054183SMax Reitz     ret = qcow2_cache_empty(bs, s->l2_table_cache);
225994054183SMax Reitz     if (ret < 0) {
226094054183SMax Reitz         goto fail;
226194054183SMax Reitz     }
226294054183SMax Reitz 
226394054183SMax Reitz     ret = qcow2_cache_empty(bs, s->refcount_block_cache);
226494054183SMax Reitz     if (ret < 0) {
226594054183SMax Reitz         goto fail;
226694054183SMax Reitz     }
226794054183SMax Reitz 
226894054183SMax Reitz     /* Refcounts will be broken utterly */
226994054183SMax Reitz     ret = qcow2_mark_dirty(bs);
227094054183SMax Reitz     if (ret < 0) {
227194054183SMax Reitz         goto fail;
227294054183SMax Reitz     }
227394054183SMax Reitz 
227494054183SMax Reitz     BLKDBG_EVENT(bs->file, BLKDBG_L1_UPDATE);
227594054183SMax Reitz 
227694054183SMax Reitz     l1_clusters = DIV_ROUND_UP(s->l1_size, s->cluster_size / sizeof(uint64_t));
227794054183SMax Reitz     l1_size2 = (uint64_t)s->l1_size * sizeof(uint64_t);
227894054183SMax Reitz 
227994054183SMax Reitz     /* After this call, neither the in-memory nor the on-disk refcount
228094054183SMax Reitz      * information accurately describe the actual references */
228194054183SMax Reitz 
228294054183SMax Reitz     ret = bdrv_write_zeroes(bs->file, s->l1_table_offset / BDRV_SECTOR_SIZE,
228394054183SMax Reitz                             l1_clusters * s->cluster_sectors, 0);
228494054183SMax Reitz     if (ret < 0) {
228594054183SMax Reitz         goto fail_broken_refcounts;
228694054183SMax Reitz     }
228794054183SMax Reitz     memset(s->l1_table, 0, l1_size2);
228894054183SMax Reitz 
228994054183SMax Reitz     BLKDBG_EVENT(bs->file, BLKDBG_EMPTY_IMAGE_PREPARE);
229094054183SMax Reitz 
229194054183SMax Reitz     /* Overwrite enough clusters at the beginning of the sectors to place
229294054183SMax Reitz      * the refcount table, a refcount block and the L1 table in; this may
229394054183SMax Reitz      * overwrite parts of the existing refcount and L1 table, which is not
229494054183SMax Reitz      * an issue because the dirty flag is set, complete data loss is in fact
229594054183SMax Reitz      * desired and partial data loss is consequently fine as well */
229694054183SMax Reitz     ret = bdrv_write_zeroes(bs->file, s->cluster_size / BDRV_SECTOR_SIZE,
229794054183SMax Reitz                             (2 + l1_clusters) * s->cluster_size /
229894054183SMax Reitz                             BDRV_SECTOR_SIZE, 0);
229994054183SMax Reitz     /* This call (even if it failed overall) may have overwritten on-disk
230094054183SMax Reitz      * refcount structures; in that case, the in-memory refcount information
230194054183SMax Reitz      * will probably differ from the on-disk information which makes the BDS
230294054183SMax Reitz      * unusable */
230394054183SMax Reitz     if (ret < 0) {
230494054183SMax Reitz         goto fail_broken_refcounts;
230594054183SMax Reitz     }
230694054183SMax Reitz 
230794054183SMax Reitz     BLKDBG_EVENT(bs->file, BLKDBG_L1_UPDATE);
230894054183SMax Reitz     BLKDBG_EVENT(bs->file, BLKDBG_REFTABLE_UPDATE);
230994054183SMax Reitz 
231094054183SMax Reitz     /* "Create" an empty reftable (one cluster) directly after the image
231194054183SMax Reitz      * header and an empty L1 table three clusters after the image header;
231294054183SMax Reitz      * the cluster between those two will be used as the first refblock */
231394054183SMax Reitz     cpu_to_be64w(&l1_ofs_rt_ofs_cls.l1_offset, 3 * s->cluster_size);
231494054183SMax Reitz     cpu_to_be64w(&l1_ofs_rt_ofs_cls.reftable_offset, s->cluster_size);
231594054183SMax Reitz     cpu_to_be32w(&l1_ofs_rt_ofs_cls.reftable_clusters, 1);
231694054183SMax Reitz     ret = bdrv_pwrite_sync(bs->file, offsetof(QCowHeader, l1_table_offset),
231794054183SMax Reitz                            &l1_ofs_rt_ofs_cls, sizeof(l1_ofs_rt_ofs_cls));
231894054183SMax Reitz     if (ret < 0) {
231994054183SMax Reitz         goto fail_broken_refcounts;
232094054183SMax Reitz     }
232194054183SMax Reitz 
232294054183SMax Reitz     s->l1_table_offset = 3 * s->cluster_size;
232394054183SMax Reitz 
232494054183SMax Reitz     new_reftable = g_try_new0(uint64_t, s->cluster_size / sizeof(uint64_t));
232594054183SMax Reitz     if (!new_reftable) {
232694054183SMax Reitz         ret = -ENOMEM;
232794054183SMax Reitz         goto fail_broken_refcounts;
232894054183SMax Reitz     }
232994054183SMax Reitz 
233094054183SMax Reitz     s->refcount_table_offset = s->cluster_size;
233194054183SMax Reitz     s->refcount_table_size   = s->cluster_size / sizeof(uint64_t);
233294054183SMax Reitz 
233394054183SMax Reitz     g_free(s->refcount_table);
233494054183SMax Reitz     s->refcount_table = new_reftable;
233594054183SMax Reitz     new_reftable = NULL;
233694054183SMax Reitz 
233794054183SMax Reitz     /* Now the in-memory refcount information again corresponds to the on-disk
233894054183SMax Reitz      * information (reftable is empty and no refblocks (the refblock cache is
233994054183SMax Reitz      * empty)); however, this means some clusters (e.g. the image header) are
234094054183SMax Reitz      * referenced, but not refcounted, but the normal qcow2 code assumes that
234194054183SMax Reitz      * the in-memory information is always correct */
234294054183SMax Reitz 
234394054183SMax Reitz     BLKDBG_EVENT(bs->file, BLKDBG_REFBLOCK_ALLOC);
234494054183SMax Reitz 
234594054183SMax Reitz     /* Enter the first refblock into the reftable */
234694054183SMax Reitz     rt_entry = cpu_to_be64(2 * s->cluster_size);
234794054183SMax Reitz     ret = bdrv_pwrite_sync(bs->file, s->cluster_size,
234894054183SMax Reitz                            &rt_entry, sizeof(rt_entry));
234994054183SMax Reitz     if (ret < 0) {
235094054183SMax Reitz         goto fail_broken_refcounts;
235194054183SMax Reitz     }
235294054183SMax Reitz     s->refcount_table[0] = 2 * s->cluster_size;
235394054183SMax Reitz 
235494054183SMax Reitz     s->free_cluster_index = 0;
235594054183SMax Reitz     assert(3 + l1_clusters <= s->refcount_block_size);
235694054183SMax Reitz     offset = qcow2_alloc_clusters(bs, 3 * s->cluster_size + l1_size2);
235794054183SMax Reitz     if (offset < 0) {
235894054183SMax Reitz         ret = offset;
235994054183SMax Reitz         goto fail_broken_refcounts;
236094054183SMax Reitz     } else if (offset > 0) {
236194054183SMax Reitz         error_report("First cluster in emptied image is in use");
236294054183SMax Reitz         abort();
236394054183SMax Reitz     }
236494054183SMax Reitz 
236594054183SMax Reitz     /* Now finally the in-memory information corresponds to the on-disk
236694054183SMax Reitz      * structures and is correct */
236794054183SMax Reitz     ret = qcow2_mark_clean(bs);
236894054183SMax Reitz     if (ret < 0) {
236994054183SMax Reitz         goto fail;
237094054183SMax Reitz     }
237194054183SMax Reitz 
237294054183SMax Reitz     ret = bdrv_truncate(bs->file, (3 + l1_clusters) * s->cluster_size);
237394054183SMax Reitz     if (ret < 0) {
237494054183SMax Reitz         goto fail;
237594054183SMax Reitz     }
237694054183SMax Reitz 
237794054183SMax Reitz     return 0;
237894054183SMax Reitz 
237994054183SMax Reitz fail_broken_refcounts:
238094054183SMax Reitz     /* The BDS is unusable at this point. If we wanted to make it usable, we
238194054183SMax Reitz      * would have to call qcow2_refcount_close(), qcow2_refcount_init(),
238294054183SMax Reitz      * qcow2_check_refcounts(), qcow2_refcount_close() and qcow2_refcount_init()
238394054183SMax Reitz      * again. However, because the functions which could have caused this error
238494054183SMax Reitz      * path to be taken are used by those functions as well, it's very likely
238594054183SMax Reitz      * that that sequence will fail as well. Therefore, just eject the BDS. */
238694054183SMax Reitz     bs->drv = NULL;
238794054183SMax Reitz 
238894054183SMax Reitz fail:
238994054183SMax Reitz     g_free(new_reftable);
239094054183SMax Reitz     return ret;
239194054183SMax Reitz }
239294054183SMax Reitz 
2393491d27e2SMax Reitz static int qcow2_make_empty(BlockDriverState *bs)
2394491d27e2SMax Reitz {
239594054183SMax Reitz     BDRVQcowState *s = bs->opaque;
2396491d27e2SMax Reitz     uint64_t start_sector;
2397491d27e2SMax Reitz     int sector_step = INT_MAX / BDRV_SECTOR_SIZE;
239894054183SMax Reitz     int l1_clusters, ret = 0;
2399491d27e2SMax Reitz 
240094054183SMax Reitz     l1_clusters = DIV_ROUND_UP(s->l1_size, s->cluster_size / sizeof(uint64_t));
240194054183SMax Reitz 
240294054183SMax Reitz     if (s->qcow_version >= 3 && !s->snapshots &&
240394054183SMax Reitz         3 + l1_clusters <= s->refcount_block_size) {
240494054183SMax Reitz         /* The following function only works for qcow2 v3 images (it requires
240594054183SMax Reitz          * the dirty flag) and only as long as there are no snapshots (because
240694054183SMax Reitz          * it completely empties the image). Furthermore, the L1 table and three
240794054183SMax Reitz          * additional clusters (image header, refcount table, one refcount
240894054183SMax Reitz          * block) have to fit inside one refcount block. */
240994054183SMax Reitz         return make_completely_empty(bs);
241094054183SMax Reitz     }
241194054183SMax Reitz 
241294054183SMax Reitz     /* This fallback code simply discards every active cluster; this is slow,
241394054183SMax Reitz      * but works in all cases */
2414491d27e2SMax Reitz     for (start_sector = 0; start_sector < bs->total_sectors;
2415491d27e2SMax Reitz          start_sector += sector_step)
2416491d27e2SMax Reitz     {
2417491d27e2SMax Reitz         /* As this function is generally used after committing an external
2418491d27e2SMax Reitz          * snapshot, QCOW2_DISCARD_SNAPSHOT seems appropriate. Also, the
2419491d27e2SMax Reitz          * default action for this kind of discard is to pass the discard,
2420491d27e2SMax Reitz          * which will ideally result in an actually smaller image file, as
2421491d27e2SMax Reitz          * is probably desired. */
2422491d27e2SMax Reitz         ret = qcow2_discard_clusters(bs, start_sector * BDRV_SECTOR_SIZE,
2423491d27e2SMax Reitz                                      MIN(sector_step,
2424491d27e2SMax Reitz                                          bs->total_sectors - start_sector),
2425491d27e2SMax Reitz                                      QCOW2_DISCARD_SNAPSHOT, true);
2426491d27e2SMax Reitz         if (ret < 0) {
2427491d27e2SMax Reitz             break;
2428491d27e2SMax Reitz         }
2429491d27e2SMax Reitz     }
2430491d27e2SMax Reitz 
2431491d27e2SMax Reitz     return ret;
2432491d27e2SMax Reitz }
2433491d27e2SMax Reitz 
2434a968168cSDong Xu Wang static coroutine_fn int qcow2_co_flush_to_os(BlockDriverState *bs)
243520d97356SBlue Swirl {
243629c1a730SKevin Wolf     BDRVQcowState *s = bs->opaque;
243729c1a730SKevin Wolf     int ret;
243829c1a730SKevin Wolf 
24398b94ff85SPaolo Bonzini     qemu_co_mutex_lock(&s->lock);
244029c1a730SKevin Wolf     ret = qcow2_cache_flush(bs, s->l2_table_cache);
244129c1a730SKevin Wolf     if (ret < 0) {
2442c95de7e2SDong Xu Wang         qemu_co_mutex_unlock(&s->lock);
24438b94ff85SPaolo Bonzini         return ret;
244429c1a730SKevin Wolf     }
244529c1a730SKevin Wolf 
2446bfe8043eSStefan Hajnoczi     if (qcow2_need_accurate_refcounts(s)) {
244729c1a730SKevin Wolf         ret = qcow2_cache_flush(bs, s->refcount_block_cache);
244829c1a730SKevin Wolf         if (ret < 0) {
2449c95de7e2SDong Xu Wang             qemu_co_mutex_unlock(&s->lock);
24508b94ff85SPaolo Bonzini             return ret;
245129c1a730SKevin Wolf         }
2452bfe8043eSStefan Hajnoczi     }
24538b94ff85SPaolo Bonzini     qemu_co_mutex_unlock(&s->lock);
245429c1a730SKevin Wolf 
2455eb489bb1SKevin Wolf     return 0;
2456eb489bb1SKevin Wolf }
2457eb489bb1SKevin Wolf 
24587c80ab3fSJes Sorensen static int qcow2_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
245920d97356SBlue Swirl {
246020d97356SBlue Swirl     BDRVQcowState *s = bs->opaque;
246195de6d70SPaolo Bonzini     bdi->unallocated_blocks_are_zero = true;
246295de6d70SPaolo Bonzini     bdi->can_write_zeroes_with_unmap = (s->qcow_version >= 3);
246320d97356SBlue Swirl     bdi->cluster_size = s->cluster_size;
24647c80ab3fSJes Sorensen     bdi->vm_state_offset = qcow2_vm_state_offset(s);
246520d97356SBlue Swirl     return 0;
246620d97356SBlue Swirl }
246720d97356SBlue Swirl 
246837764dfbSMax Reitz static ImageInfoSpecific *qcow2_get_specific_info(BlockDriverState *bs)
246937764dfbSMax Reitz {
247037764dfbSMax Reitz     BDRVQcowState *s = bs->opaque;
247137764dfbSMax Reitz     ImageInfoSpecific *spec_info = g_new(ImageInfoSpecific, 1);
247237764dfbSMax Reitz 
247337764dfbSMax Reitz     *spec_info = (ImageInfoSpecific){
247437764dfbSMax Reitz         .kind  = IMAGE_INFO_SPECIFIC_KIND_QCOW2,
247537764dfbSMax Reitz         {
247637764dfbSMax Reitz             .qcow2 = g_new(ImageInfoSpecificQCow2, 1),
247737764dfbSMax Reitz         },
247837764dfbSMax Reitz     };
247937764dfbSMax Reitz     if (s->qcow_version == 2) {
248037764dfbSMax Reitz         *spec_info->qcow2 = (ImageInfoSpecificQCow2){
248137764dfbSMax Reitz             .compat = g_strdup("0.10"),
248237764dfbSMax Reitz         };
248337764dfbSMax Reitz     } else if (s->qcow_version == 3) {
248437764dfbSMax Reitz         *spec_info->qcow2 = (ImageInfoSpecificQCow2){
248537764dfbSMax Reitz             .compat             = g_strdup("1.1"),
248637764dfbSMax Reitz             .lazy_refcounts     = s->compatible_features &
248737764dfbSMax Reitz                                   QCOW2_COMPAT_LAZY_REFCOUNTS,
248837764dfbSMax Reitz             .has_lazy_refcounts = true,
24899009b196SMax Reitz             .corrupt            = s->incompatible_features &
24909009b196SMax Reitz                                   QCOW2_INCOMPAT_CORRUPT,
24919009b196SMax Reitz             .has_corrupt        = true,
249237764dfbSMax Reitz         };
249337764dfbSMax Reitz     }
249437764dfbSMax Reitz 
249537764dfbSMax Reitz     return spec_info;
249637764dfbSMax Reitz }
249737764dfbSMax Reitz 
249820d97356SBlue Swirl #if 0
249920d97356SBlue Swirl static void dump_refcounts(BlockDriverState *bs)
250020d97356SBlue Swirl {
250120d97356SBlue Swirl     BDRVQcowState *s = bs->opaque;
250220d97356SBlue Swirl     int64_t nb_clusters, k, k1, size;
250320d97356SBlue Swirl     int refcount;
250420d97356SBlue Swirl 
250566f82ceeSKevin Wolf     size = bdrv_getlength(bs->file);
250620d97356SBlue Swirl     nb_clusters = size_to_clusters(s, size);
250720d97356SBlue Swirl     for(k = 0; k < nb_clusters;) {
250820d97356SBlue Swirl         k1 = k;
250920d97356SBlue Swirl         refcount = get_refcount(bs, k);
251020d97356SBlue Swirl         k++;
251120d97356SBlue Swirl         while (k < nb_clusters && get_refcount(bs, k) == refcount)
251220d97356SBlue Swirl             k++;
25130bfcd599SBlue Swirl         printf("%" PRId64 ": refcount=%d nb=%" PRId64 "\n", k, refcount,
25140bfcd599SBlue Swirl                k - k1);
251520d97356SBlue Swirl     }
251620d97356SBlue Swirl }
251720d97356SBlue Swirl #endif
251820d97356SBlue Swirl 
2519cf8074b3SKevin Wolf static int qcow2_save_vmstate(BlockDriverState *bs, QEMUIOVector *qiov,
2520cf8074b3SKevin Wolf                               int64_t pos)
252120d97356SBlue Swirl {
252220d97356SBlue Swirl     BDRVQcowState *s = bs->opaque;
2523eedff66fSMax Reitz     int64_t total_sectors = bs->total_sectors;
252420d97356SBlue Swirl     int growable = bs->growable;
25256e13610aSMax Reitz     bool zero_beyond_eof = bs->zero_beyond_eof;
252620d97356SBlue Swirl     int ret;
252720d97356SBlue Swirl 
252866f82ceeSKevin Wolf     BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_SAVE);
252920d97356SBlue Swirl     bs->growable = 1;
25306e13610aSMax Reitz     bs->zero_beyond_eof = false;
25318d3b1a2dSKevin Wolf     ret = bdrv_pwritev(bs, qcow2_vm_state_offset(s) + pos, qiov);
253220d97356SBlue Swirl     bs->growable = growable;
25336e13610aSMax Reitz     bs->zero_beyond_eof = zero_beyond_eof;
253420d97356SBlue Swirl 
2535eedff66fSMax Reitz     /* bdrv_co_do_writev will have increased the total_sectors value to include
2536eedff66fSMax Reitz      * the VM state - the VM state is however not an actual part of the block
2537eedff66fSMax Reitz      * device, therefore, we need to restore the old value. */
2538eedff66fSMax Reitz     bs->total_sectors = total_sectors;
2539eedff66fSMax Reitz 
254020d97356SBlue Swirl     return ret;
254120d97356SBlue Swirl }
254220d97356SBlue Swirl 
25437c80ab3fSJes Sorensen static int qcow2_load_vmstate(BlockDriverState *bs, uint8_t *buf,
254420d97356SBlue Swirl                               int64_t pos, int size)
254520d97356SBlue Swirl {
254620d97356SBlue Swirl     BDRVQcowState *s = bs->opaque;
254720d97356SBlue Swirl     int growable = bs->growable;
25480d51b4deSAsias He     bool zero_beyond_eof = bs->zero_beyond_eof;
254920d97356SBlue Swirl     int ret;
255020d97356SBlue Swirl 
255166f82ceeSKevin Wolf     BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_LOAD);
255220d97356SBlue Swirl     bs->growable = 1;
25530d51b4deSAsias He     bs->zero_beyond_eof = false;
25547c80ab3fSJes Sorensen     ret = bdrv_pread(bs, qcow2_vm_state_offset(s) + pos, buf, size);
255520d97356SBlue Swirl     bs->growable = growable;
25560d51b4deSAsias He     bs->zero_beyond_eof = zero_beyond_eof;
255720d97356SBlue Swirl 
255820d97356SBlue Swirl     return ret;
255920d97356SBlue Swirl }
256020d97356SBlue Swirl 
25619296b3edSMax Reitz /*
25629296b3edSMax Reitz  * Downgrades an image's version. To achieve this, any incompatible features
25639296b3edSMax Reitz  * have to be removed.
25649296b3edSMax Reitz  */
25654057a2b2SMax Reitz static int qcow2_downgrade(BlockDriverState *bs, int target_version,
25664057a2b2SMax Reitz                            BlockDriverAmendStatusCB *status_cb)
25679296b3edSMax Reitz {
25689296b3edSMax Reitz     BDRVQcowState *s = bs->opaque;
25699296b3edSMax Reitz     int current_version = s->qcow_version;
25709296b3edSMax Reitz     int ret;
25719296b3edSMax Reitz 
25729296b3edSMax Reitz     if (target_version == current_version) {
25739296b3edSMax Reitz         return 0;
25749296b3edSMax Reitz     } else if (target_version > current_version) {
25759296b3edSMax Reitz         return -EINVAL;
25769296b3edSMax Reitz     } else if (target_version != 2) {
25779296b3edSMax Reitz         return -EINVAL;
25789296b3edSMax Reitz     }
25799296b3edSMax Reitz 
25809296b3edSMax Reitz     if (s->refcount_order != 4) {
25819296b3edSMax Reitz         /* we would have to convert the image to a refcount_order == 4 image
25829296b3edSMax Reitz          * here; however, since qemu (at the time of writing this) does not
25839296b3edSMax Reitz          * support anything different than 4 anyway, there is no point in doing
25849296b3edSMax Reitz          * so right now; however, we should error out (if qemu supports this in
25859296b3edSMax Reitz          * the future and this code has not been adapted) */
25869296b3edSMax Reitz         error_report("qcow2_downgrade: Image refcount orders other than 4 are "
25879296b3edSMax Reitz                      "currently not supported.");
25889296b3edSMax Reitz         return -ENOTSUP;
25899296b3edSMax Reitz     }
25909296b3edSMax Reitz 
25919296b3edSMax Reitz     /* clear incompatible features */
25929296b3edSMax Reitz     if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) {
25939296b3edSMax Reitz         ret = qcow2_mark_clean(bs);
25949296b3edSMax Reitz         if (ret < 0) {
25959296b3edSMax Reitz             return ret;
25969296b3edSMax Reitz         }
25979296b3edSMax Reitz     }
25989296b3edSMax Reitz 
25999296b3edSMax Reitz     /* with QCOW2_INCOMPAT_CORRUPT, it is pretty much impossible to get here in
26009296b3edSMax Reitz      * the first place; if that happens nonetheless, returning -ENOTSUP is the
26019296b3edSMax Reitz      * best thing to do anyway */
26029296b3edSMax Reitz 
26039296b3edSMax Reitz     if (s->incompatible_features) {
26049296b3edSMax Reitz         return -ENOTSUP;
26059296b3edSMax Reitz     }
26069296b3edSMax Reitz 
26079296b3edSMax Reitz     /* since we can ignore compatible features, we can set them to 0 as well */
26089296b3edSMax Reitz     s->compatible_features = 0;
26099296b3edSMax Reitz     /* if lazy refcounts have been used, they have already been fixed through
26109296b3edSMax Reitz      * clearing the dirty flag */
26119296b3edSMax Reitz 
26129296b3edSMax Reitz     /* clearing autoclear features is trivial */
26139296b3edSMax Reitz     s->autoclear_features = 0;
26149296b3edSMax Reitz 
26154057a2b2SMax Reitz     ret = qcow2_expand_zero_clusters(bs, status_cb);
26169296b3edSMax Reitz     if (ret < 0) {
26179296b3edSMax Reitz         return ret;
26189296b3edSMax Reitz     }
26199296b3edSMax Reitz 
26209296b3edSMax Reitz     s->qcow_version = target_version;
26219296b3edSMax Reitz     ret = qcow2_update_header(bs);
26229296b3edSMax Reitz     if (ret < 0) {
26239296b3edSMax Reitz         s->qcow_version = current_version;
26249296b3edSMax Reitz         return ret;
26259296b3edSMax Reitz     }
26269296b3edSMax Reitz     return 0;
26279296b3edSMax Reitz }
26289296b3edSMax Reitz 
262977485434SMax Reitz static int qcow2_amend_options(BlockDriverState *bs, QemuOpts *opts,
263077485434SMax Reitz                                BlockDriverAmendStatusCB *status_cb)
26319296b3edSMax Reitz {
26329296b3edSMax Reitz     BDRVQcowState *s = bs->opaque;
26339296b3edSMax Reitz     int old_version = s->qcow_version, new_version = old_version;
26349296b3edSMax Reitz     uint64_t new_size = 0;
26359296b3edSMax Reitz     const char *backing_file = NULL, *backing_format = NULL;
26369296b3edSMax Reitz     bool lazy_refcounts = s->use_lazy_refcounts;
26371bd0e2d1SChunyan Liu     const char *compat = NULL;
26381bd0e2d1SChunyan Liu     uint64_t cluster_size = s->cluster_size;
26391bd0e2d1SChunyan Liu     bool encrypt;
26409296b3edSMax Reitz     int ret;
26411bd0e2d1SChunyan Liu     QemuOptDesc *desc = opts->list->desc;
26429296b3edSMax Reitz 
26431bd0e2d1SChunyan Liu     while (desc && desc->name) {
26441bd0e2d1SChunyan Liu         if (!qemu_opt_find(opts, desc->name)) {
26459296b3edSMax Reitz             /* only change explicitly defined options */
26461bd0e2d1SChunyan Liu             desc++;
26479296b3edSMax Reitz             continue;
26489296b3edSMax Reitz         }
26499296b3edSMax Reitz 
26501bd0e2d1SChunyan Liu         if (!strcmp(desc->name, "compat")) {
26511bd0e2d1SChunyan Liu             compat = qemu_opt_get(opts, "compat");
26521bd0e2d1SChunyan Liu             if (!compat) {
26539296b3edSMax Reitz                 /* preserve default */
26541bd0e2d1SChunyan Liu             } else if (!strcmp(compat, "0.10")) {
26559296b3edSMax Reitz                 new_version = 2;
26561bd0e2d1SChunyan Liu             } else if (!strcmp(compat, "1.1")) {
26579296b3edSMax Reitz                 new_version = 3;
26589296b3edSMax Reitz             } else {
26591bd0e2d1SChunyan Liu                 fprintf(stderr, "Unknown compatibility level %s.\n", compat);
26609296b3edSMax Reitz                 return -EINVAL;
26619296b3edSMax Reitz             }
26621bd0e2d1SChunyan Liu         } else if (!strcmp(desc->name, "preallocation")) {
26639296b3edSMax Reitz             fprintf(stderr, "Cannot change preallocation mode.\n");
26649296b3edSMax Reitz             return -ENOTSUP;
26651bd0e2d1SChunyan Liu         } else if (!strcmp(desc->name, "size")) {
26661bd0e2d1SChunyan Liu             new_size = qemu_opt_get_size(opts, "size", 0);
26671bd0e2d1SChunyan Liu         } else if (!strcmp(desc->name, "backing_file")) {
26681bd0e2d1SChunyan Liu             backing_file = qemu_opt_get(opts, "backing_file");
26691bd0e2d1SChunyan Liu         } else if (!strcmp(desc->name, "backing_fmt")) {
26701bd0e2d1SChunyan Liu             backing_format = qemu_opt_get(opts, "backing_fmt");
26711bd0e2d1SChunyan Liu         } else if (!strcmp(desc->name, "encryption")) {
26721bd0e2d1SChunyan Liu             encrypt = qemu_opt_get_bool(opts, "encryption", s->crypt_method);
26731bd0e2d1SChunyan Liu             if (encrypt != !!s->crypt_method) {
26749296b3edSMax Reitz                 fprintf(stderr, "Changing the encryption flag is not "
26759296b3edSMax Reitz                         "supported.\n");
26769296b3edSMax Reitz                 return -ENOTSUP;
26779296b3edSMax Reitz             }
26781bd0e2d1SChunyan Liu         } else if (!strcmp(desc->name, "cluster_size")) {
26791bd0e2d1SChunyan Liu             cluster_size = qemu_opt_get_size(opts, "cluster_size",
26801bd0e2d1SChunyan Liu                                              cluster_size);
26811bd0e2d1SChunyan Liu             if (cluster_size != s->cluster_size) {
26829296b3edSMax Reitz                 fprintf(stderr, "Changing the cluster size is not "
26839296b3edSMax Reitz                         "supported.\n");
26849296b3edSMax Reitz                 return -ENOTSUP;
26859296b3edSMax Reitz             }
26861bd0e2d1SChunyan Liu         } else if (!strcmp(desc->name, "lazy_refcounts")) {
26871bd0e2d1SChunyan Liu             lazy_refcounts = qemu_opt_get_bool(opts, "lazy_refcounts",
26881bd0e2d1SChunyan Liu                                                lazy_refcounts);
26899296b3edSMax Reitz         } else {
26909296b3edSMax Reitz             /* if this assertion fails, this probably means a new option was
26919296b3edSMax Reitz              * added without having it covered here */
26929296b3edSMax Reitz             assert(false);
26939296b3edSMax Reitz         }
26941bd0e2d1SChunyan Liu 
26951bd0e2d1SChunyan Liu         desc++;
26969296b3edSMax Reitz     }
26979296b3edSMax Reitz 
26989296b3edSMax Reitz     if (new_version != old_version) {
26999296b3edSMax Reitz         if (new_version > old_version) {
27009296b3edSMax Reitz             /* Upgrade */
27019296b3edSMax Reitz             s->qcow_version = new_version;
27029296b3edSMax Reitz             ret = qcow2_update_header(bs);
27039296b3edSMax Reitz             if (ret < 0) {
27049296b3edSMax Reitz                 s->qcow_version = old_version;
27059296b3edSMax Reitz                 return ret;
27069296b3edSMax Reitz             }
27079296b3edSMax Reitz         } else {
27084057a2b2SMax Reitz             ret = qcow2_downgrade(bs, new_version, status_cb);
27099296b3edSMax Reitz             if (ret < 0) {
27109296b3edSMax Reitz                 return ret;
27119296b3edSMax Reitz             }
27129296b3edSMax Reitz         }
27139296b3edSMax Reitz     }
27149296b3edSMax Reitz 
27159296b3edSMax Reitz     if (backing_file || backing_format) {
27169296b3edSMax Reitz         ret = qcow2_change_backing_file(bs, backing_file ?: bs->backing_file,
27179296b3edSMax Reitz                                         backing_format ?: bs->backing_format);
27189296b3edSMax Reitz         if (ret < 0) {
27199296b3edSMax Reitz             return ret;
27209296b3edSMax Reitz         }
27219296b3edSMax Reitz     }
27229296b3edSMax Reitz 
27239296b3edSMax Reitz     if (s->use_lazy_refcounts != lazy_refcounts) {
27249296b3edSMax Reitz         if (lazy_refcounts) {
27259296b3edSMax Reitz             if (s->qcow_version < 3) {
27269296b3edSMax Reitz                 fprintf(stderr, "Lazy refcounts only supported with compatibility "
27279296b3edSMax Reitz                         "level 1.1 and above (use compat=1.1 or greater)\n");
27289296b3edSMax Reitz                 return -EINVAL;
27299296b3edSMax Reitz             }
27309296b3edSMax Reitz             s->compatible_features |= QCOW2_COMPAT_LAZY_REFCOUNTS;
27319296b3edSMax Reitz             ret = qcow2_update_header(bs);
27329296b3edSMax Reitz             if (ret < 0) {
27339296b3edSMax Reitz                 s->compatible_features &= ~QCOW2_COMPAT_LAZY_REFCOUNTS;
27349296b3edSMax Reitz                 return ret;
27359296b3edSMax Reitz             }
27369296b3edSMax Reitz             s->use_lazy_refcounts = true;
27379296b3edSMax Reitz         } else {
27389296b3edSMax Reitz             /* make image clean first */
27399296b3edSMax Reitz             ret = qcow2_mark_clean(bs);
27409296b3edSMax Reitz             if (ret < 0) {
27419296b3edSMax Reitz                 return ret;
27429296b3edSMax Reitz             }
27439296b3edSMax Reitz             /* now disallow lazy refcounts */
27449296b3edSMax Reitz             s->compatible_features &= ~QCOW2_COMPAT_LAZY_REFCOUNTS;
27459296b3edSMax Reitz             ret = qcow2_update_header(bs);
27469296b3edSMax Reitz             if (ret < 0) {
27479296b3edSMax Reitz                 s->compatible_features |= QCOW2_COMPAT_LAZY_REFCOUNTS;
27489296b3edSMax Reitz                 return ret;
27499296b3edSMax Reitz             }
27509296b3edSMax Reitz             s->use_lazy_refcounts = false;
27519296b3edSMax Reitz         }
27529296b3edSMax Reitz     }
27539296b3edSMax Reitz 
27549296b3edSMax Reitz     if (new_size) {
27559296b3edSMax Reitz         ret = bdrv_truncate(bs, new_size);
27569296b3edSMax Reitz         if (ret < 0) {
27579296b3edSMax Reitz             return ret;
27589296b3edSMax Reitz         }
27599296b3edSMax Reitz     }
27609296b3edSMax Reitz 
27619296b3edSMax Reitz     return 0;
27629296b3edSMax Reitz }
27639296b3edSMax Reitz 
276485186ebdSMax Reitz /*
276585186ebdSMax Reitz  * If offset or size are negative, respectively, they will not be included in
276685186ebdSMax Reitz  * the BLOCK_IMAGE_CORRUPTED event emitted.
276785186ebdSMax Reitz  * fatal will be ignored for read-only BDS; corruptions found there will always
276885186ebdSMax Reitz  * be considered non-fatal.
276985186ebdSMax Reitz  */
277085186ebdSMax Reitz void qcow2_signal_corruption(BlockDriverState *bs, bool fatal, int64_t offset,
277185186ebdSMax Reitz                              int64_t size, const char *message_format, ...)
277285186ebdSMax Reitz {
277385186ebdSMax Reitz     BDRVQcowState *s = bs->opaque;
277485186ebdSMax Reitz     char *message;
277585186ebdSMax Reitz     va_list ap;
277685186ebdSMax Reitz 
277785186ebdSMax Reitz     fatal = fatal && !bs->read_only;
277885186ebdSMax Reitz 
277985186ebdSMax Reitz     if (s->signaled_corruption &&
278085186ebdSMax Reitz         (!fatal || (s->incompatible_features & QCOW2_INCOMPAT_CORRUPT)))
278185186ebdSMax Reitz     {
278285186ebdSMax Reitz         return;
278385186ebdSMax Reitz     }
278485186ebdSMax Reitz 
278585186ebdSMax Reitz     va_start(ap, message_format);
278685186ebdSMax Reitz     message = g_strdup_vprintf(message_format, ap);
278785186ebdSMax Reitz     va_end(ap);
278885186ebdSMax Reitz 
278985186ebdSMax Reitz     if (fatal) {
279085186ebdSMax Reitz         fprintf(stderr, "qcow2: Marking image as corrupt: %s; further "
279185186ebdSMax Reitz                 "corruption events will be suppressed\n", message);
279285186ebdSMax Reitz     } else {
279385186ebdSMax Reitz         fprintf(stderr, "qcow2: Image is corrupt: %s; further non-fatal "
279485186ebdSMax Reitz                 "corruption events will be suppressed\n", message);
279585186ebdSMax Reitz     }
279685186ebdSMax Reitz 
279785186ebdSMax Reitz     qapi_event_send_block_image_corrupted(bdrv_get_device_name(bs), message,
279885186ebdSMax Reitz                                           offset >= 0, offset, size >= 0, size,
279985186ebdSMax Reitz                                           fatal, &error_abort);
280085186ebdSMax Reitz     g_free(message);
280185186ebdSMax Reitz 
280285186ebdSMax Reitz     if (fatal) {
280385186ebdSMax Reitz         qcow2_mark_corrupt(bs);
280485186ebdSMax Reitz         bs->drv = NULL; /* make BDS unusable */
280585186ebdSMax Reitz     }
280685186ebdSMax Reitz 
280785186ebdSMax Reitz     s->signaled_corruption = true;
280885186ebdSMax Reitz }
280985186ebdSMax Reitz 
28101bd0e2d1SChunyan Liu static QemuOptsList qcow2_create_opts = {
28111bd0e2d1SChunyan Liu     .name = "qcow2-create-opts",
28121bd0e2d1SChunyan Liu     .head = QTAILQ_HEAD_INITIALIZER(qcow2_create_opts.head),
28131bd0e2d1SChunyan Liu     .desc = {
281420d97356SBlue Swirl         {
281520d97356SBlue Swirl             .name = BLOCK_OPT_SIZE,
28161bd0e2d1SChunyan Liu             .type = QEMU_OPT_SIZE,
281720d97356SBlue Swirl             .help = "Virtual disk size"
281820d97356SBlue Swirl         },
281920d97356SBlue Swirl         {
28206744cbabSKevin Wolf             .name = BLOCK_OPT_COMPAT_LEVEL,
28211bd0e2d1SChunyan Liu             .type = QEMU_OPT_STRING,
28226744cbabSKevin Wolf             .help = "Compatibility level (0.10 or 1.1)"
28236744cbabSKevin Wolf         },
28246744cbabSKevin Wolf         {
282520d97356SBlue Swirl             .name = BLOCK_OPT_BACKING_FILE,
28261bd0e2d1SChunyan Liu             .type = QEMU_OPT_STRING,
282720d97356SBlue Swirl             .help = "File name of a base image"
282820d97356SBlue Swirl         },
282920d97356SBlue Swirl         {
283020d97356SBlue Swirl             .name = BLOCK_OPT_BACKING_FMT,
28311bd0e2d1SChunyan Liu             .type = QEMU_OPT_STRING,
283220d97356SBlue Swirl             .help = "Image format of the base image"
283320d97356SBlue Swirl         },
283420d97356SBlue Swirl         {
283520d97356SBlue Swirl             .name = BLOCK_OPT_ENCRYPT,
28361bd0e2d1SChunyan Liu             .type = QEMU_OPT_BOOL,
28371bd0e2d1SChunyan Liu             .help = "Encrypt the image",
28381bd0e2d1SChunyan Liu             .def_value_str = "off"
283920d97356SBlue Swirl         },
284020d97356SBlue Swirl         {
284120d97356SBlue Swirl             .name = BLOCK_OPT_CLUSTER_SIZE,
28421bd0e2d1SChunyan Liu             .type = QEMU_OPT_SIZE,
284399cce9faSKevin Wolf             .help = "qcow2 cluster size",
28441bd0e2d1SChunyan Liu             .def_value_str = stringify(DEFAULT_CLUSTER_SIZE)
284520d97356SBlue Swirl         },
284620d97356SBlue Swirl         {
284720d97356SBlue Swirl             .name = BLOCK_OPT_PREALLOC,
28481bd0e2d1SChunyan Liu             .type = QEMU_OPT_STRING,
28490e4271b7SHu Tao             .help = "Preallocation mode (allowed values: off, metadata, "
28500e4271b7SHu Tao                     "falloc, full)"
285120d97356SBlue Swirl         },
2852bfe8043eSStefan Hajnoczi         {
2853bfe8043eSStefan Hajnoczi             .name = BLOCK_OPT_LAZY_REFCOUNTS,
28541bd0e2d1SChunyan Liu             .type = QEMU_OPT_BOOL,
2855bfe8043eSStefan Hajnoczi             .help = "Postpone refcount updates",
28561bd0e2d1SChunyan Liu             .def_value_str = "off"
2857bfe8043eSStefan Hajnoczi         },
28581bd0e2d1SChunyan Liu         { /* end of list */ }
28591bd0e2d1SChunyan Liu     }
286020d97356SBlue Swirl };
286120d97356SBlue Swirl 
28625f535a94SMax Reitz BlockDriver bdrv_qcow2 = {
286320d97356SBlue Swirl     .format_name        = "qcow2",
286420d97356SBlue Swirl     .instance_size      = sizeof(BDRVQcowState),
28657c80ab3fSJes Sorensen     .bdrv_probe         = qcow2_probe,
28667c80ab3fSJes Sorensen     .bdrv_open          = qcow2_open,
28677c80ab3fSJes Sorensen     .bdrv_close         = qcow2_close,
286821d82ac9SJeff Cody     .bdrv_reopen_prepare  = qcow2_reopen_prepare,
2869c282e1fdSChunyan Liu     .bdrv_create        = qcow2_create,
28703ac21627SPeter Lieven     .bdrv_has_zero_init = bdrv_has_zero_init_1,
2871b6b8a333SPaolo Bonzini     .bdrv_co_get_block_status = qcow2_co_get_block_status,
28727c80ab3fSJes Sorensen     .bdrv_set_key       = qcow2_set_key,
287320d97356SBlue Swirl 
287468d100e9SKevin Wolf     .bdrv_co_readv          = qcow2_co_readv,
287568d100e9SKevin Wolf     .bdrv_co_writev         = qcow2_co_writev,
2876eb489bb1SKevin Wolf     .bdrv_co_flush_to_os    = qcow2_co_flush_to_os,
2877419b19d9SStefan Hajnoczi 
2878621f0589SKevin Wolf     .bdrv_co_write_zeroes   = qcow2_co_write_zeroes,
28796db39ae2SPaolo Bonzini     .bdrv_co_discard        = qcow2_co_discard,
2880419b19d9SStefan Hajnoczi     .bdrv_truncate          = qcow2_truncate,
28817c80ab3fSJes Sorensen     .bdrv_write_compressed  = qcow2_write_compressed,
2882491d27e2SMax Reitz     .bdrv_make_empty        = qcow2_make_empty,
288320d97356SBlue Swirl 
288420d97356SBlue Swirl     .bdrv_snapshot_create   = qcow2_snapshot_create,
288520d97356SBlue Swirl     .bdrv_snapshot_goto     = qcow2_snapshot_goto,
288620d97356SBlue Swirl     .bdrv_snapshot_delete   = qcow2_snapshot_delete,
288720d97356SBlue Swirl     .bdrv_snapshot_list     = qcow2_snapshot_list,
288851ef6727Sedison     .bdrv_snapshot_load_tmp = qcow2_snapshot_load_tmp,
28897c80ab3fSJes Sorensen     .bdrv_get_info          = qcow2_get_info,
289037764dfbSMax Reitz     .bdrv_get_specific_info = qcow2_get_specific_info,
289120d97356SBlue Swirl 
28927c80ab3fSJes Sorensen     .bdrv_save_vmstate    = qcow2_save_vmstate,
28937c80ab3fSJes Sorensen     .bdrv_load_vmstate    = qcow2_load_vmstate,
289420d97356SBlue Swirl 
28958ee79e70SKevin Wolf     .supports_backing           = true,
289620d97356SBlue Swirl     .bdrv_change_backing_file   = qcow2_change_backing_file,
289720d97356SBlue Swirl 
2898d34682cdSKevin Wolf     .bdrv_refresh_limits        = qcow2_refresh_limits,
289906d9260fSAnthony Liguori     .bdrv_invalidate_cache      = qcow2_invalidate_cache,
290006d9260fSAnthony Liguori 
29011bd0e2d1SChunyan Liu     .create_opts         = &qcow2_create_opts,
29027c80ab3fSJes Sorensen     .bdrv_check          = qcow2_check,
2903c282e1fdSChunyan Liu     .bdrv_amend_options  = qcow2_amend_options,
290420d97356SBlue Swirl };
290520d97356SBlue Swirl 
29065efa9d5aSAnthony Liguori static void bdrv_qcow2_init(void)
29075efa9d5aSAnthony Liguori {
29085efa9d5aSAnthony Liguori     bdrv_register(&bdrv_qcow2);
29095efa9d5aSAnthony Liguori }
29105efa9d5aSAnthony Liguori 
29115efa9d5aSAnthony Liguori block_init(bdrv_qcow2_init);
2912