]> git.proxmox.com Git - mirror_qemu.git/blame - block/qcow2.c
qcow2: Allow resize of images with internal snapshots
[mirror_qemu.git] / block / qcow2.c
CommitLineData
585f8587
FB
1/*
2 * Block driver for the QCOW version 2 format
5fafdf24 3 *
585f8587 4 * Copyright (c) 2004-2006 Fabrice Bellard
5fafdf24 5 *
585f8587
FB
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
e688df6b 24
80c71a24 25#include "qemu/osdep.h"
2714f13d 26
609f45ea 27#include "block/qdict.h"
23588797 28#include "sysemu/block-backend.h"
db725815 29#include "qemu/main-loop.h"
1de7afc9 30#include "qemu/module.h"
0d8c41da 31#include "qcow2.h"
1de7afc9 32#include "qemu/error-report.h"
e688df6b 33#include "qapi/error.h"
9af23989 34#include "qapi/qapi-events-block-core.h"
6b673957
MA
35#include "qapi/qmp/qdict.h"
36#include "qapi/qmp/qstring.h"
3cce16f4 37#include "trace.h"
1bd0e2d1 38#include "qemu/option_int.h"
f348b6d1 39#include "qemu/cutils.h"
58369e22 40#include "qemu/bswap.h"
b76b4f60
KW
41#include "qapi/qobject-input-visitor.h"
42#include "qapi/qapi-visit-block-core.h"
0d8c41da 43#include "crypto.h"
d710cf57 44#include "block/aio_task.h"
585f8587
FB
45
46/*
47 Differences with QCOW:
48
49 - Support for multiple incremental snapshots.
50 - Memory management by reference counts.
51 - Clusters which have a reference count of one have the bit
52 QCOW_OFLAG_COPIED to optimize write performance.
5fafdf24 53 - Size of compressed clusters is stored in sectors to reduce bit usage
585f8587
FB
54 in the cluster offsets.
55 - Support for storing additional data (such as the VM state) in the
3b46e624 56 snapshots.
585f8587
FB
57 - If a backing store is used, the cluster size is not constrained
58 (could be backported to QCOW).
59 - L2 tables have always a size of one cluster.
60*/
61
9b80ddf3
AL
62
63typedef struct {
64 uint32_t magic;
65 uint32_t len;
c4217f64 66} QEMU_PACKED QCowExtension;
21d82ac9 67
7c80ab3f
JS
68#define QCOW2_EXT_MAGIC_END 0
69#define QCOW2_EXT_MAGIC_BACKING_FORMAT 0xE2792ACA
cfcc4c62 70#define QCOW2_EXT_MAGIC_FEATURE_TABLE 0x6803f857
4652b8f3 71#define QCOW2_EXT_MAGIC_CRYPTO_HEADER 0x0537be77
88ddffae 72#define QCOW2_EXT_MAGIC_BITMAPS 0x23852875
93c24936 73#define QCOW2_EXT_MAGIC_DATA_FILE 0x44415441
9b80ddf3 74
c3c10f72
VSO
75static int coroutine_fn
76qcow2_co_preadv_compressed(BlockDriverState *bs,
77 uint64_t file_cluster_offset,
78 uint64_t offset,
79 uint64_t bytes,
df893d25
VSO
80 QEMUIOVector *qiov,
81 size_t qiov_offset);
c3c10f72 82
7c80ab3f 83static int qcow2_probe(const uint8_t *buf, int buf_size, const char *filename)
585f8587
FB
84{
85 const QCowHeader *cow_header = (const void *)buf;
3b46e624 86
585f8587
FB
87 if (buf_size >= sizeof(QCowHeader) &&
88 be32_to_cpu(cow_header->magic) == QCOW_MAGIC &&
6744cbab 89 be32_to_cpu(cow_header->version) >= 2)
585f8587
FB
90 return 100;
91 else
92 return 0;
93}
94
9b80ddf3 95
4652b8f3
DB
96static ssize_t qcow2_crypto_hdr_read_func(QCryptoBlock *block, size_t offset,
97 uint8_t *buf, size_t buflen,
98 void *opaque, Error **errp)
99{
100 BlockDriverState *bs = opaque;
101 BDRVQcow2State *s = bs->opaque;
102 ssize_t ret;
103
104 if ((offset + buflen) > s->crypto_header.length) {
105 error_setg(errp, "Request for data outside of extension header");
106 return -1;
107 }
108
109 ret = bdrv_pread(bs->file,
110 s->crypto_header.offset + offset, buf, buflen);
111 if (ret < 0) {
112 error_setg_errno(errp, -ret, "Could not read encryption header");
113 return -1;
114 }
115 return ret;
116}
117
118
119static ssize_t qcow2_crypto_hdr_init_func(QCryptoBlock *block, size_t headerlen,
120 void *opaque, Error **errp)
121{
122 BlockDriverState *bs = opaque;
123 BDRVQcow2State *s = bs->opaque;
124 int64_t ret;
125 int64_t clusterlen;
126
127 ret = qcow2_alloc_clusters(bs, headerlen);
128 if (ret < 0) {
129 error_setg_errno(errp, -ret,
130 "Cannot allocate cluster for LUKS header size %zu",
131 headerlen);
132 return -1;
133 }
134
135 s->crypto_header.length = headerlen;
136 s->crypto_header.offset = ret;
137
087ab8e7
DB
138 /*
139 * Zero fill all space in cluster so it has predictable
140 * content, as we may not initialize some regions of the
141 * header (eg only 1 out of 8 key slots will be initialized)
142 */
4652b8f3 143 clusterlen = size_to_clusters(s, headerlen) * s->cluster_size;
966b000f 144 assert(qcow2_pre_write_overlap_check(bs, 0, ret, clusterlen, false) == 0);
4652b8f3 145 ret = bdrv_pwrite_zeroes(bs->file,
087ab8e7
DB
146 ret,
147 clusterlen, 0);
4652b8f3
DB
148 if (ret < 0) {
149 error_setg_errno(errp, -ret, "Could not zero fill encryption header");
150 return -1;
151 }
152
153 return ret;
154}
155
156
157static ssize_t qcow2_crypto_hdr_write_func(QCryptoBlock *block, size_t offset,
158 const uint8_t *buf, size_t buflen,
159 void *opaque, Error **errp)
160{
161 BlockDriverState *bs = opaque;
162 BDRVQcow2State *s = bs->opaque;
163 ssize_t ret;
164
165 if ((offset + buflen) > s->crypto_header.length) {
166 error_setg(errp, "Request for data outside of extension header");
167 return -1;
168 }
169
170 ret = bdrv_pwrite(bs->file,
171 s->crypto_header.offset + offset, buf, buflen);
172 if (ret < 0) {
173 error_setg_errno(errp, -ret, "Could not read encryption header");
174 return -1;
175 }
176 return ret;
177}
178
179
a951a631 180/*
9b80ddf3
AL
181 * read qcow2 extension and fill bs
182 * start reading from start_offset
183 * finish reading upon magic of value 0 or when end_offset reached
184 * unknown magic is skipped (future extension this version knows nothing about)
185 * return 0 upon success, non-0 otherwise
186 */
7c80ab3f 187static int qcow2_read_extensions(BlockDriverState *bs, uint64_t start_offset,
3ef6c40a 188 uint64_t end_offset, void **p_feature_table,
88ddffae
VSO
189 int flags, bool *need_update_header,
190 Error **errp)
9b80ddf3 191{
ff99129a 192 BDRVQcow2State *s = bs->opaque;
9b80ddf3
AL
193 QCowExtension ext;
194 uint64_t offset;
75bab85c 195 int ret;
88ddffae
VSO
196 Qcow2BitmapHeaderExt bitmaps_ext;
197
198 if (need_update_header != NULL) {
199 *need_update_header = false;
200 }
9b80ddf3
AL
201
202#ifdef DEBUG_EXT
7c80ab3f 203 printf("qcow2_read_extensions: start=%ld end=%ld\n", start_offset, end_offset);
9b80ddf3
AL
204#endif
205 offset = start_offset;
206 while (offset < end_offset) {
207
208#ifdef DEBUG_EXT
209 /* Sanity check */
210 if (offset > s->cluster_size)
7c80ab3f 211 printf("qcow2_read_extension: suspicious offset %lu\n", offset);
9b80ddf3 212
9b2260cb 213 printf("attempting to read extended header in offset %lu\n", offset);
9b80ddf3
AL
214#endif
215
cf2ab8fc 216 ret = bdrv_pread(bs->file, offset, &ext, sizeof(ext));
3ef6c40a
HR
217 if (ret < 0) {
218 error_setg_errno(errp, -ret, "qcow2_read_extension: ERROR: "
219 "pread fail from offset %" PRIu64, offset);
9b80ddf3
AL
220 return 1;
221 }
3b698f52
PM
222 ext.magic = be32_to_cpu(ext.magic);
223 ext.len = be32_to_cpu(ext.len);
9b80ddf3
AL
224 offset += sizeof(ext);
225#ifdef DEBUG_EXT
226 printf("ext.magic = 0x%x\n", ext.magic);
227#endif
2ebafc85 228 if (offset > end_offset || ext.len > end_offset - offset) {
3ef6c40a 229 error_setg(errp, "Header extension too large");
64ca6aee
KW
230 return -EINVAL;
231 }
232
9b80ddf3 233 switch (ext.magic) {
7c80ab3f 234 case QCOW2_EXT_MAGIC_END:
9b80ddf3 235 return 0;
f965509c 236
7c80ab3f 237 case QCOW2_EXT_MAGIC_BACKING_FORMAT:
f965509c 238 if (ext.len >= sizeof(bs->backing_format)) {
521b2b5d
HR
239 error_setg(errp, "ERROR: ext_backing_format: len=%" PRIu32
240 " too large (>=%zu)", ext.len,
241 sizeof(bs->backing_format));
f965509c
AL
242 return 2;
243 }
cf2ab8fc 244 ret = bdrv_pread(bs->file, offset, bs->backing_format, ext.len);
3ef6c40a
HR
245 if (ret < 0) {
246 error_setg_errno(errp, -ret, "ERROR: ext_backing_format: "
247 "Could not read format name");
f965509c 248 return 3;
3ef6c40a 249 }
f965509c 250 bs->backing_format[ext.len] = '\0';
e4603fe1 251 s->image_backing_format = g_strdup(bs->backing_format);
f965509c
AL
252#ifdef DEBUG_EXT
253 printf("Qcow2: Got format extension %s\n", bs->backing_format);
254#endif
f965509c
AL
255 break;
256
cfcc4c62
KW
257 case QCOW2_EXT_MAGIC_FEATURE_TABLE:
258 if (p_feature_table != NULL) {
259 void* feature_table = g_malloc0(ext.len + 2 * sizeof(Qcow2Feature));
cf2ab8fc 260 ret = bdrv_pread(bs->file, offset , feature_table, ext.len);
cfcc4c62 261 if (ret < 0) {
3ef6c40a
HR
262 error_setg_errno(errp, -ret, "ERROR: ext_feature_table: "
263 "Could not read table");
cfcc4c62
KW
264 return ret;
265 }
266
267 *p_feature_table = feature_table;
268 }
269 break;
270
4652b8f3
DB
271 case QCOW2_EXT_MAGIC_CRYPTO_HEADER: {
272 unsigned int cflags = 0;
273 if (s->crypt_method_header != QCOW_CRYPT_LUKS) {
274 error_setg(errp, "CRYPTO header extension only "
275 "expected with LUKS encryption method");
276 return -EINVAL;
277 }
278 if (ext.len != sizeof(Qcow2CryptoHeaderExtension)) {
279 error_setg(errp, "CRYPTO header extension size %u, "
280 "but expected size %zu", ext.len,
281 sizeof(Qcow2CryptoHeaderExtension));
282 return -EINVAL;
283 }
284
285 ret = bdrv_pread(bs->file, offset, &s->crypto_header, ext.len);
286 if (ret < 0) {
287 error_setg_errno(errp, -ret,
288 "Unable to read CRYPTO header extension");
289 return ret;
290 }
3b698f52
PM
291 s->crypto_header.offset = be64_to_cpu(s->crypto_header.offset);
292 s->crypto_header.length = be64_to_cpu(s->crypto_header.length);
4652b8f3
DB
293
294 if ((s->crypto_header.offset % s->cluster_size) != 0) {
295 error_setg(errp, "Encryption header offset '%" PRIu64 "' is "
296 "not a multiple of cluster size '%u'",
297 s->crypto_header.offset, s->cluster_size);
298 return -EINVAL;
299 }
300
301 if (flags & BDRV_O_NO_IO) {
302 cflags |= QCRYPTO_BLOCK_OPEN_NO_IO;
303 }
1cd9a787 304 s->crypto = qcrypto_block_open(s->crypto_opts, "encrypt.",
4652b8f3 305 qcow2_crypto_hdr_read_func,
8ac0f15f 306 bs, cflags, QCOW2_MAX_THREADS, errp);
4652b8f3
DB
307 if (!s->crypto) {
308 return -EINVAL;
309 }
310 } break;
311
88ddffae
VSO
312 case QCOW2_EXT_MAGIC_BITMAPS:
313 if (ext.len != sizeof(bitmaps_ext)) {
314 error_setg_errno(errp, -ret, "bitmaps_ext: "
315 "Invalid extension length");
316 return -EINVAL;
317 }
318
319 if (!(s->autoclear_features & QCOW2_AUTOCLEAR_BITMAPS)) {
c9ceb3ec
HR
320 if (s->qcow_version < 3) {
321 /* Let's be a bit more specific */
322 warn_report("This qcow2 v2 image contains bitmaps, but "
323 "they may have been modified by a program "
324 "without persistent bitmap support; so now "
325 "they must all be considered inconsistent");
326 } else {
327 warn_report("a program lacking bitmap support "
328 "modified this file, so all bitmaps are now "
329 "considered inconsistent");
330 }
55d527a9
AF
331 error_printf("Some clusters may be leaked, "
332 "run 'qemu-img check -r' on the image "
88ddffae
VSO
333 "file to fix.");
334 if (need_update_header != NULL) {
335 /* Updating is needed to drop invalid bitmap extension. */
336 *need_update_header = true;
337 }
338 break;
339 }
340
341 ret = bdrv_pread(bs->file, offset, &bitmaps_ext, ext.len);
342 if (ret < 0) {
343 error_setg_errno(errp, -ret, "bitmaps_ext: "
344 "Could not read ext header");
345 return ret;
346 }
347
348 if (bitmaps_ext.reserved32 != 0) {
349 error_setg_errno(errp, -ret, "bitmaps_ext: "
350 "Reserved field is not zero");
351 return -EINVAL;
352 }
353
3b698f52
PM
354 bitmaps_ext.nb_bitmaps = be32_to_cpu(bitmaps_ext.nb_bitmaps);
355 bitmaps_ext.bitmap_directory_size =
356 be64_to_cpu(bitmaps_ext.bitmap_directory_size);
357 bitmaps_ext.bitmap_directory_offset =
358 be64_to_cpu(bitmaps_ext.bitmap_directory_offset);
88ddffae
VSO
359
360 if (bitmaps_ext.nb_bitmaps > QCOW2_MAX_BITMAPS) {
361 error_setg(errp,
362 "bitmaps_ext: Image has %" PRIu32 " bitmaps, "
363 "exceeding the QEMU supported maximum of %d",
364 bitmaps_ext.nb_bitmaps, QCOW2_MAX_BITMAPS);
365 return -EINVAL;
366 }
367
368 if (bitmaps_ext.nb_bitmaps == 0) {
369 error_setg(errp, "found bitmaps extension with zero bitmaps");
370 return -EINVAL;
371 }
372
74e60fb5 373 if (offset_into_cluster(s, bitmaps_ext.bitmap_directory_offset)) {
88ddffae
VSO
374 error_setg(errp, "bitmaps_ext: "
375 "invalid bitmap directory offset");
376 return -EINVAL;
377 }
378
379 if (bitmaps_ext.bitmap_directory_size >
380 QCOW2_MAX_BITMAP_DIRECTORY_SIZE) {
381 error_setg(errp, "bitmaps_ext: "
382 "bitmap directory size (%" PRIu64 ") exceeds "
383 "the maximum supported size (%d)",
384 bitmaps_ext.bitmap_directory_size,
385 QCOW2_MAX_BITMAP_DIRECTORY_SIZE);
386 return -EINVAL;
387 }
388
389 s->nb_bitmaps = bitmaps_ext.nb_bitmaps;
390 s->bitmap_directory_offset =
391 bitmaps_ext.bitmap_directory_offset;
392 s->bitmap_directory_size =
393 bitmaps_ext.bitmap_directory_size;
394
395#ifdef DEBUG_EXT
396 printf("Qcow2: Got bitmaps extension: "
397 "offset=%" PRIu64 " nb_bitmaps=%" PRIu32 "\n",
398 s->bitmap_directory_offset, s->nb_bitmaps);
399#endif
400 break;
401
9b890bdc
KW
402 case QCOW2_EXT_MAGIC_DATA_FILE:
403 {
404 s->image_data_file = g_malloc0(ext.len + 1);
405 ret = bdrv_pread(bs->file, offset, s->image_data_file, ext.len);
406 if (ret < 0) {
407 error_setg_errno(errp, -ret,
408 "ERROR: Could not read data file name");
409 return ret;
410 }
411#ifdef DEBUG_EXT
412 printf("Qcow2: Got external data file %s\n", s->image_data_file);
413#endif
414 break;
415 }
416
9b80ddf3 417 default:
75bab85c 418 /* unknown magic - save it in case we need to rewrite the header */
4096974e
EB
419 /* If you add a new feature, make sure to also update the fast
420 * path of qcow2_make_empty() to deal with it. */
75bab85c
KW
421 {
422 Qcow2UnknownHeaderExtension *uext;
423
424 uext = g_malloc0(sizeof(*uext) + ext.len);
425 uext->magic = ext.magic;
426 uext->len = ext.len;
427 QLIST_INSERT_HEAD(&s->unknown_header_ext, uext, next);
428
cf2ab8fc 429 ret = bdrv_pread(bs->file, offset , uext->data, uext->len);
75bab85c 430 if (ret < 0) {
3ef6c40a
HR
431 error_setg_errno(errp, -ret, "ERROR: unknown extension: "
432 "Could not read data");
75bab85c
KW
433 return ret;
434 }
75bab85c 435 }
9b80ddf3
AL
436 break;
437 }
fd29b4bb
KW
438
439 offset += ((ext.len + 7) & ~7);
9b80ddf3
AL
440 }
441
442 return 0;
443}
444
75bab85c
KW
445static void cleanup_unknown_header_ext(BlockDriverState *bs)
446{
ff99129a 447 BDRVQcow2State *s = bs->opaque;
75bab85c
KW
448 Qcow2UnknownHeaderExtension *uext, *next;
449
450 QLIST_FOREACH_SAFE(uext, &s->unknown_header_ext, next, next) {
451 QLIST_REMOVE(uext, next);
452 g_free(uext);
453 }
454}
9b80ddf3 455
a55448b3
HR
456static void report_unsupported_feature(Error **errp, Qcow2Feature *table,
457 uint64_t mask)
cfcc4c62 458{
7cdca2e2 459 g_autoptr(GString) features = g_string_sized_new(60);
12ac6d3d 460
cfcc4c62
KW
461 while (table && table->name[0] != '\0') {
462 if (table->type == QCOW2_FEAT_TYPE_INCOMPATIBLE) {
12ac6d3d 463 if (mask & (1ULL << table->bit)) {
7cdca2e2
AG
464 if (features->len > 0) {
465 g_string_append(features, ", ");
466 }
467 g_string_append_printf(features, "%.46s", table->name);
12ac6d3d 468 mask &= ~(1ULL << table->bit);
cfcc4c62
KW
469 }
470 }
471 table++;
472 }
473
474 if (mask) {
7cdca2e2
AG
475 if (features->len > 0) {
476 g_string_append(features, ", ");
477 }
478 g_string_append_printf(features,
479 "Unknown incompatible feature: %" PRIx64, mask);
cfcc4c62 480 }
12ac6d3d 481
7cdca2e2 482 error_setg(errp, "Unsupported qcow2 feature(s): %s", features->str);
cfcc4c62
KW
483}
484
bfe8043e
SH
485/*
486 * Sets the dirty bit and flushes afterwards if necessary.
487 *
488 * The incompatible_features bit is only set if the image file header was
489 * updated successfully. Therefore it is not required to check the return
490 * value of this function.
491 */
280d3735 492int qcow2_mark_dirty(BlockDriverState *bs)
bfe8043e 493{
ff99129a 494 BDRVQcow2State *s = bs->opaque;
bfe8043e
SH
495 uint64_t val;
496 int ret;
497
498 assert(s->qcow_version >= 3);
499
500 if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) {
501 return 0; /* already dirty */
502 }
503
504 val = cpu_to_be64(s->incompatible_features | QCOW2_INCOMPAT_DIRTY);
d9ca2ea2 505 ret = bdrv_pwrite(bs->file, offsetof(QCowHeader, incompatible_features),
bfe8043e
SH
506 &val, sizeof(val));
507 if (ret < 0) {
508 return ret;
509 }
9a4f4c31 510 ret = bdrv_flush(bs->file->bs);
bfe8043e
SH
511 if (ret < 0) {
512 return ret;
513 }
514
515 /* Only treat image as dirty if the header was updated successfully */
516 s->incompatible_features |= QCOW2_INCOMPAT_DIRTY;
517 return 0;
518}
519
c61d0004
SH
520/*
521 * Clears the dirty bit and flushes before if necessary. Only call this
522 * function when there are no pending requests, it does not guard against
523 * concurrent requests dirtying the image.
524 */
525static int qcow2_mark_clean(BlockDriverState *bs)
526{
ff99129a 527 BDRVQcow2State *s = bs->opaque;
c61d0004
SH
528
529 if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) {
4c2e5f8f
KW
530 int ret;
531
532 s->incompatible_features &= ~QCOW2_INCOMPAT_DIRTY;
533
8b220eb7 534 ret = qcow2_flush_caches(bs);
c61d0004
SH
535 if (ret < 0) {
536 return ret;
537 }
538
c61d0004
SH
539 return qcow2_update_header(bs);
540 }
541 return 0;
542}
543
69c98726
HR
544/*
545 * Marks the image as corrupt.
546 */
547int qcow2_mark_corrupt(BlockDriverState *bs)
548{
ff99129a 549 BDRVQcow2State *s = bs->opaque;
69c98726
HR
550
551 s->incompatible_features |= QCOW2_INCOMPAT_CORRUPT;
552 return qcow2_update_header(bs);
553}
554
555/*
556 * Marks the image as consistent, i.e., unsets the corrupt bit, and flushes
557 * before if necessary.
558 */
559int qcow2_mark_consistent(BlockDriverState *bs)
560{
ff99129a 561 BDRVQcow2State *s = bs->opaque;
69c98726
HR
562
563 if (s->incompatible_features & QCOW2_INCOMPAT_CORRUPT) {
8b220eb7 564 int ret = qcow2_flush_caches(bs);
69c98726
HR
565 if (ret < 0) {
566 return ret;
567 }
568
569 s->incompatible_features &= ~QCOW2_INCOMPAT_CORRUPT;
570 return qcow2_update_header(bs);
571 }
572 return 0;
573}
574
8bc584fe
HR
575static void qcow2_add_check_result(BdrvCheckResult *out,
576 const BdrvCheckResult *src,
577 bool set_allocation_info)
578{
579 out->corruptions += src->corruptions;
580 out->leaks += src->leaks;
581 out->check_errors += src->check_errors;
582 out->corruptions_fixed += src->corruptions_fixed;
583 out->leaks_fixed += src->leaks_fixed;
584
585 if (set_allocation_info) {
586 out->image_end_offset = src->image_end_offset;
587 out->bfi = src->bfi;
588 }
589}
590
2fd61638
PB
591static int coroutine_fn qcow2_co_check_locked(BlockDriverState *bs,
592 BdrvCheckResult *result,
593 BdrvCheckMode fix)
acbe5982 594{
8bc584fe
HR
595 BdrvCheckResult snapshot_res = {};
596 BdrvCheckResult refcount_res = {};
597 int ret;
598
599 memset(result, 0, sizeof(*result));
600
601 ret = qcow2_check_read_snapshot_table(bs, &snapshot_res, fix);
8bc584fe 602 if (ret < 0) {
fe446b5d 603 qcow2_add_check_result(result, &snapshot_res, false);
8bc584fe
HR
604 return ret;
605 }
606
607 ret = qcow2_check_refcounts(bs, &refcount_res, fix);
608 qcow2_add_check_result(result, &refcount_res, true);
fe446b5d
HR
609 if (ret < 0) {
610 qcow2_add_check_result(result, &snapshot_res, false);
611 return ret;
612 }
613
614 ret = qcow2_check_fix_snapshot_table(bs, &snapshot_res, fix);
615 qcow2_add_check_result(result, &snapshot_res, false);
acbe5982
SH
616 if (ret < 0) {
617 return ret;
618 }
619
620 if (fix && result->check_errors == 0 && result->corruptions == 0) {
24530f3e
HR
621 ret = qcow2_mark_clean(bs);
622 if (ret < 0) {
623 return ret;
624 }
625 return qcow2_mark_consistent(bs);
acbe5982
SH
626 }
627 return ret;
628}
629
2fd61638
PB
630static int coroutine_fn qcow2_co_check(BlockDriverState *bs,
631 BdrvCheckResult *result,
632 BdrvCheckMode fix)
633{
634 BDRVQcow2State *s = bs->opaque;
635 int ret;
636
637 qemu_co_mutex_lock(&s->lock);
638 ret = qcow2_co_check_locked(bs, result, fix);
639 qemu_co_mutex_unlock(&s->lock);
640 return ret;
641}
642
0cf0e598
AG
643int qcow2_validate_table(BlockDriverState *bs, uint64_t offset,
644 uint64_t entries, size_t entry_len,
645 int64_t max_size_bytes, const char *table_name,
646 Error **errp)
8c7de283 647{
ff99129a 648 BDRVQcow2State *s = bs->opaque;
8c7de283 649
0cf0e598
AG
650 if (entries > max_size_bytes / entry_len) {
651 error_setg(errp, "%s too large", table_name);
652 return -EFBIG;
8c7de283
KW
653 }
654
0cf0e598
AG
655 /* Use signed INT64_MAX as the maximum even for uint64_t header fields,
656 * because values will be passed to qemu functions taking int64_t. */
657 if ((INT64_MAX - entries * entry_len < offset) ||
658 (offset_into_cluster(s, offset) != 0)) {
659 error_setg(errp, "%s offset invalid", table_name);
8c7de283
KW
660 return -EINVAL;
661 }
662
663 return 0;
664}
665
8a2ce0bc
AG
666static const char *const mutable_opts[] = {
667 QCOW2_OPT_LAZY_REFCOUNTS,
668 QCOW2_OPT_DISCARD_REQUEST,
669 QCOW2_OPT_DISCARD_SNAPSHOT,
670 QCOW2_OPT_DISCARD_OTHER,
671 QCOW2_OPT_OVERLAP,
672 QCOW2_OPT_OVERLAP_TEMPLATE,
673 QCOW2_OPT_OVERLAP_MAIN_HEADER,
674 QCOW2_OPT_OVERLAP_ACTIVE_L1,
675 QCOW2_OPT_OVERLAP_ACTIVE_L2,
676 QCOW2_OPT_OVERLAP_REFCOUNT_TABLE,
677 QCOW2_OPT_OVERLAP_REFCOUNT_BLOCK,
678 QCOW2_OPT_OVERLAP_SNAPSHOT_TABLE,
679 QCOW2_OPT_OVERLAP_INACTIVE_L1,
680 QCOW2_OPT_OVERLAP_INACTIVE_L2,
681 QCOW2_OPT_OVERLAP_BITMAP_DIRECTORY,
682 QCOW2_OPT_CACHE_SIZE,
683 QCOW2_OPT_L2_CACHE_SIZE,
684 QCOW2_OPT_L2_CACHE_ENTRY_SIZE,
685 QCOW2_OPT_REFCOUNT_CACHE_SIZE,
686 QCOW2_OPT_CACHE_CLEAN_INTERVAL,
687 NULL
688};
689
74c4510a
KW
690static QemuOptsList qcow2_runtime_opts = {
691 .name = "qcow2",
692 .head = QTAILQ_HEAD_INITIALIZER(qcow2_runtime_opts.head),
693 .desc = {
694 {
64aa99d3 695 .name = QCOW2_OPT_LAZY_REFCOUNTS,
74c4510a
KW
696 .type = QEMU_OPT_BOOL,
697 .help = "Postpone refcount updates",
698 },
67af674e
KW
699 {
700 .name = QCOW2_OPT_DISCARD_REQUEST,
701 .type = QEMU_OPT_BOOL,
702 .help = "Pass guest discard requests to the layer below",
703 },
704 {
705 .name = QCOW2_OPT_DISCARD_SNAPSHOT,
706 .type = QEMU_OPT_BOOL,
707 .help = "Generate discard requests when snapshot related space "
708 "is freed",
709 },
710 {
711 .name = QCOW2_OPT_DISCARD_OTHER,
712 .type = QEMU_OPT_BOOL,
713 .help = "Generate discard requests when other clusters are freed",
714 },
05de7e86
HR
715 {
716 .name = QCOW2_OPT_OVERLAP,
717 .type = QEMU_OPT_STRING,
718 .help = "Selects which overlap checks to perform from a range of "
719 "templates (none, constant, cached, all)",
720 },
ee42b5ce
HR
721 {
722 .name = QCOW2_OPT_OVERLAP_TEMPLATE,
723 .type = QEMU_OPT_STRING,
724 .help = "Selects which overlap checks to perform from a range of "
725 "templates (none, constant, cached, all)",
726 },
05de7e86
HR
727 {
728 .name = QCOW2_OPT_OVERLAP_MAIN_HEADER,
729 .type = QEMU_OPT_BOOL,
730 .help = "Check for unintended writes into the main qcow2 header",
731 },
732 {
733 .name = QCOW2_OPT_OVERLAP_ACTIVE_L1,
734 .type = QEMU_OPT_BOOL,
735 .help = "Check for unintended writes into the active L1 table",
736 },
737 {
738 .name = QCOW2_OPT_OVERLAP_ACTIVE_L2,
739 .type = QEMU_OPT_BOOL,
740 .help = "Check for unintended writes into an active L2 table",
741 },
742 {
743 .name = QCOW2_OPT_OVERLAP_REFCOUNT_TABLE,
744 .type = QEMU_OPT_BOOL,
745 .help = "Check for unintended writes into the refcount table",
746 },
747 {
748 .name = QCOW2_OPT_OVERLAP_REFCOUNT_BLOCK,
749 .type = QEMU_OPT_BOOL,
750 .help = "Check for unintended writes into a refcount block",
751 },
752 {
753 .name = QCOW2_OPT_OVERLAP_SNAPSHOT_TABLE,
754 .type = QEMU_OPT_BOOL,
755 .help = "Check for unintended writes into the snapshot table",
756 },
757 {
758 .name = QCOW2_OPT_OVERLAP_INACTIVE_L1,
759 .type = QEMU_OPT_BOOL,
760 .help = "Check for unintended writes into an inactive L1 table",
761 },
762 {
763 .name = QCOW2_OPT_OVERLAP_INACTIVE_L2,
764 .type = QEMU_OPT_BOOL,
765 .help = "Check for unintended writes into an inactive L2 table",
766 },
0e4e4318
VSO
767 {
768 .name = QCOW2_OPT_OVERLAP_BITMAP_DIRECTORY,
769 .type = QEMU_OPT_BOOL,
770 .help = "Check for unintended writes into the bitmap directory",
771 },
6c1c8d5d
HR
772 {
773 .name = QCOW2_OPT_CACHE_SIZE,
774 .type = QEMU_OPT_SIZE,
775 .help = "Maximum combined metadata (L2 tables and refcount blocks) "
776 "cache size",
777 },
778 {
779 .name = QCOW2_OPT_L2_CACHE_SIZE,
780 .type = QEMU_OPT_SIZE,
781 .help = "Maximum L2 table cache size",
782 },
1221fe6f
AG
783 {
784 .name = QCOW2_OPT_L2_CACHE_ENTRY_SIZE,
785 .type = QEMU_OPT_SIZE,
786 .help = "Size of each entry in the L2 cache",
787 },
6c1c8d5d
HR
788 {
789 .name = QCOW2_OPT_REFCOUNT_CACHE_SIZE,
790 .type = QEMU_OPT_SIZE,
791 .help = "Maximum refcount block cache size",
792 },
279621c0
AG
793 {
794 .name = QCOW2_OPT_CACHE_CLEAN_INTERVAL,
795 .type = QEMU_OPT_NUMBER,
796 .help = "Clean unused cache entries after this time (in seconds)",
797 },
4652b8f3
DB
798 BLOCK_CRYPTO_OPT_DEF_KEY_SECRET("encrypt.",
799 "ID of secret providing qcow2 AES key or LUKS passphrase"),
74c4510a
KW
800 { /* end of list */ }
801 },
802};
803
4092e99d 804static const char *overlap_bool_option_names[QCOW2_OL_MAX_BITNR] = {
0e4e4318
VSO
805 [QCOW2_OL_MAIN_HEADER_BITNR] = QCOW2_OPT_OVERLAP_MAIN_HEADER,
806 [QCOW2_OL_ACTIVE_L1_BITNR] = QCOW2_OPT_OVERLAP_ACTIVE_L1,
807 [QCOW2_OL_ACTIVE_L2_BITNR] = QCOW2_OPT_OVERLAP_ACTIVE_L2,
808 [QCOW2_OL_REFCOUNT_TABLE_BITNR] = QCOW2_OPT_OVERLAP_REFCOUNT_TABLE,
809 [QCOW2_OL_REFCOUNT_BLOCK_BITNR] = QCOW2_OPT_OVERLAP_REFCOUNT_BLOCK,
810 [QCOW2_OL_SNAPSHOT_TABLE_BITNR] = QCOW2_OPT_OVERLAP_SNAPSHOT_TABLE,
811 [QCOW2_OL_INACTIVE_L1_BITNR] = QCOW2_OPT_OVERLAP_INACTIVE_L1,
812 [QCOW2_OL_INACTIVE_L2_BITNR] = QCOW2_OPT_OVERLAP_INACTIVE_L2,
813 [QCOW2_OL_BITMAP_DIRECTORY_BITNR] = QCOW2_OPT_OVERLAP_BITMAP_DIRECTORY,
4092e99d
HR
814};
815
279621c0
AG
816static void cache_clean_timer_cb(void *opaque)
817{
818 BlockDriverState *bs = opaque;
ff99129a 819 BDRVQcow2State *s = bs->opaque;
b2f68bff
AG
820 qcow2_cache_clean_unused(s->l2_table_cache);
821 qcow2_cache_clean_unused(s->refcount_block_cache);
279621c0
AG
822 timer_mod(s->cache_clean_timer, qemu_clock_get_ms(QEMU_CLOCK_VIRTUAL) +
823 (int64_t) s->cache_clean_interval * 1000);
824}
825
826static void cache_clean_timer_init(BlockDriverState *bs, AioContext *context)
827{
ff99129a 828 BDRVQcow2State *s = bs->opaque;
279621c0
AG
829 if (s->cache_clean_interval > 0) {
830 s->cache_clean_timer = aio_timer_new(context, QEMU_CLOCK_VIRTUAL,
831 SCALE_MS, cache_clean_timer_cb,
832 bs);
833 timer_mod(s->cache_clean_timer, qemu_clock_get_ms(QEMU_CLOCK_VIRTUAL) +
834 (int64_t) s->cache_clean_interval * 1000);
835 }
836}
837
838static void cache_clean_timer_del(BlockDriverState *bs)
839{
ff99129a 840 BDRVQcow2State *s = bs->opaque;
279621c0
AG
841 if (s->cache_clean_timer) {
842 timer_del(s->cache_clean_timer);
843 timer_free(s->cache_clean_timer);
844 s->cache_clean_timer = NULL;
845 }
846}
847
848static void qcow2_detach_aio_context(BlockDriverState *bs)
849{
850 cache_clean_timer_del(bs);
851}
852
853static void qcow2_attach_aio_context(BlockDriverState *bs,
854 AioContext *new_context)
855{
856 cache_clean_timer_init(bs, new_context);
857}
858
bc85ef26
HR
859static void read_cache_sizes(BlockDriverState *bs, QemuOpts *opts,
860 uint64_t *l2_cache_size,
1221fe6f 861 uint64_t *l2_cache_entry_size,
6c1c8d5d
HR
862 uint64_t *refcount_cache_size, Error **errp)
863{
ff99129a 864 BDRVQcow2State *s = bs->opaque;
b749562d 865 uint64_t combined_cache_size, l2_cache_max_setting;
6c1c8d5d 866 bool l2_cache_size_set, refcount_cache_size_set, combined_cache_size_set;
af39bd0d 867 bool l2_cache_entry_size_set;
7af5eea9 868 int min_refcount_cache = MIN_REFCOUNT_CACHE_SIZE * s->cluster_size;
b749562d 869 uint64_t virtual_disk_size = bs->total_sectors * BDRV_SECTOR_SIZE;
b70d0820
AG
870 uint64_t max_l2_entries = DIV_ROUND_UP(virtual_disk_size, s->cluster_size);
871 /* An L2 table is always one cluster in size so the max cache size
872 * should be a multiple of the cluster size. */
873 uint64_t max_l2_cache = ROUND_UP(max_l2_entries * sizeof(uint64_t),
874 s->cluster_size);
6c1c8d5d
HR
875
876 combined_cache_size_set = qemu_opt_get(opts, QCOW2_OPT_CACHE_SIZE);
877 l2_cache_size_set = qemu_opt_get(opts, QCOW2_OPT_L2_CACHE_SIZE);
878 refcount_cache_size_set = qemu_opt_get(opts, QCOW2_OPT_REFCOUNT_CACHE_SIZE);
af39bd0d 879 l2_cache_entry_size_set = qemu_opt_get(opts, QCOW2_OPT_L2_CACHE_ENTRY_SIZE);
6c1c8d5d
HR
880
881 combined_cache_size = qemu_opt_get_size(opts, QCOW2_OPT_CACHE_SIZE, 0);
b749562d
LB
882 l2_cache_max_setting = qemu_opt_get_size(opts, QCOW2_OPT_L2_CACHE_SIZE,
883 DEFAULT_L2_CACHE_MAX_SIZE);
6c1c8d5d
HR
884 *refcount_cache_size = qemu_opt_get_size(opts,
885 QCOW2_OPT_REFCOUNT_CACHE_SIZE, 0);
886
1221fe6f
AG
887 *l2_cache_entry_size = qemu_opt_get_size(
888 opts, QCOW2_OPT_L2_CACHE_ENTRY_SIZE, s->cluster_size);
889
b749562d
LB
890 *l2_cache_size = MIN(max_l2_cache, l2_cache_max_setting);
891
6c1c8d5d
HR
892 if (combined_cache_size_set) {
893 if (l2_cache_size_set && refcount_cache_size_set) {
894 error_setg(errp, QCOW2_OPT_CACHE_SIZE ", " QCOW2_OPT_L2_CACHE_SIZE
895 " and " QCOW2_OPT_REFCOUNT_CACHE_SIZE " may not be set "
308999e9 896 "at the same time");
6c1c8d5d 897 return;
b749562d
LB
898 } else if (l2_cache_size_set &&
899 (l2_cache_max_setting > combined_cache_size)) {
6c1c8d5d
HR
900 error_setg(errp, QCOW2_OPT_L2_CACHE_SIZE " may not exceed "
901 QCOW2_OPT_CACHE_SIZE);
902 return;
903 } else if (*refcount_cache_size > combined_cache_size) {
904 error_setg(errp, QCOW2_OPT_REFCOUNT_CACHE_SIZE " may not exceed "
905 QCOW2_OPT_CACHE_SIZE);
906 return;
907 }
908
909 if (l2_cache_size_set) {
910 *refcount_cache_size = combined_cache_size - *l2_cache_size;
911 } else if (refcount_cache_size_set) {
912 *l2_cache_size = combined_cache_size - *refcount_cache_size;
913 } else {
52253998
AG
914 /* Assign as much memory as possible to the L2 cache, and
915 * use the remainder for the refcount cache */
916 if (combined_cache_size >= max_l2_cache + min_refcount_cache) {
917 *l2_cache_size = max_l2_cache;
918 *refcount_cache_size = combined_cache_size - *l2_cache_size;
919 } else {
920 *refcount_cache_size =
921 MIN(combined_cache_size, min_refcount_cache);
922 *l2_cache_size = combined_cache_size - *refcount_cache_size;
923 }
6c1c8d5d 924 }
6c1c8d5d 925 }
af39bd0d
AG
926
927 /*
928 * If the L2 cache is not enough to cover the whole disk then
929 * default to 4KB entries. Smaller entries reduce the cost of
930 * loads and evictions and increase I/O performance.
931 */
932 if (*l2_cache_size < max_l2_cache && !l2_cache_entry_size_set) {
933 *l2_cache_entry_size = MIN(s->cluster_size, 4096);
934 }
935
657ada52
LB
936 /* l2_cache_size and refcount_cache_size are ensured to have at least
937 * their minimum values in qcow2_update_options_prepare() */
1221fe6f
AG
938
939 if (*l2_cache_entry_size < (1 << MIN_CLUSTER_BITS) ||
940 *l2_cache_entry_size > s->cluster_size ||
941 !is_power_of_2(*l2_cache_entry_size)) {
942 error_setg(errp, "L2 cache entry size must be a power of two "
943 "between %d and the cluster size (%d)",
944 1 << MIN_CLUSTER_BITS, s->cluster_size);
945 return;
946 }
6c1c8d5d
HR
947}
948
ee55b173
KW
949typedef struct Qcow2ReopenState {
950 Qcow2Cache *l2_table_cache;
951 Qcow2Cache *refcount_block_cache;
3c2e511a 952 int l2_slice_size; /* Number of entries in a slice of the L2 table */
ee55b173
KW
953 bool use_lazy_refcounts;
954 int overlap_check;
955 bool discard_passthrough[QCOW2_DISCARD_MAX];
956 uint64_t cache_clean_interval;
b25b387f 957 QCryptoBlockOpenOptions *crypto_opts; /* Disk encryption runtime options */
ee55b173
KW
958} Qcow2ReopenState;
959
960static int qcow2_update_options_prepare(BlockDriverState *bs,
961 Qcow2ReopenState *r,
962 QDict *options, int flags,
963 Error **errp)
4c75d1a1
KW
964{
965 BDRVQcow2State *s = bs->opaque;
94edf3fb 966 QemuOpts *opts = NULL;
4c75d1a1
KW
967 const char *opt_overlap_check, *opt_overlap_check_template;
968 int overlap_check_template = 0;
1221fe6f 969 uint64_t l2_cache_size, l2_cache_entry_size, refcount_cache_size;
4c75d1a1 970 int i;
b25b387f
DB
971 const char *encryptfmt;
972 QDict *encryptopts = NULL;
94edf3fb 973 Error *local_err = NULL;
4c75d1a1
KW
974 int ret;
975
b25b387f
DB
976 qdict_extract_subqdict(options, &encryptopts, "encrypt.");
977 encryptfmt = qdict_get_try_str(encryptopts, "format");
978
94edf3fb
KW
979 opts = qemu_opts_create(&qcow2_runtime_opts, NULL, 0, &error_abort);
980 qemu_opts_absorb_qdict(opts, options, &local_err);
981 if (local_err) {
982 error_propagate(errp, local_err);
983 ret = -EINVAL;
984 goto fail;
985 }
986
987 /* get L2 table/refcount block cache size from command line options */
1221fe6f
AG
988 read_cache_sizes(bs, opts, &l2_cache_size, &l2_cache_entry_size,
989 &refcount_cache_size, &local_err);
94edf3fb
KW
990 if (local_err) {
991 error_propagate(errp, local_err);
992 ret = -EINVAL;
993 goto fail;
994 }
995
1221fe6f 996 l2_cache_size /= l2_cache_entry_size;
94edf3fb
KW
997 if (l2_cache_size < MIN_L2_CACHE_SIZE) {
998 l2_cache_size = MIN_L2_CACHE_SIZE;
999 }
1000 if (l2_cache_size > INT_MAX) {
1001 error_setg(errp, "L2 cache size too big");
1002 ret = -EINVAL;
1003 goto fail;
1004 }
1005
1006 refcount_cache_size /= s->cluster_size;
1007 if (refcount_cache_size < MIN_REFCOUNT_CACHE_SIZE) {
1008 refcount_cache_size = MIN_REFCOUNT_CACHE_SIZE;
1009 }
1010 if (refcount_cache_size > INT_MAX) {
1011 error_setg(errp, "Refcount cache size too big");
1012 ret = -EINVAL;
1013 goto fail;
1014 }
1015
5b0959a7
KW
1016 /* alloc new L2 table/refcount block cache, flush old one */
1017 if (s->l2_table_cache) {
1018 ret = qcow2_cache_flush(bs, s->l2_table_cache);
1019 if (ret) {
1020 error_setg_errno(errp, -ret, "Failed to flush the L2 table cache");
1021 goto fail;
1022 }
1023 }
1024
1025 if (s->refcount_block_cache) {
1026 ret = qcow2_cache_flush(bs, s->refcount_block_cache);
1027 if (ret) {
1028 error_setg_errno(errp, -ret,
1029 "Failed to flush the refcount block cache");
1030 goto fail;
1031 }
1032 }
1033
1221fe6f
AG
1034 r->l2_slice_size = l2_cache_entry_size / sizeof(uint64_t);
1035 r->l2_table_cache = qcow2_cache_create(bs, l2_cache_size,
1036 l2_cache_entry_size);
1037 r->refcount_block_cache = qcow2_cache_create(bs, refcount_cache_size,
1038 s->cluster_size);
ee55b173 1039 if (r->l2_table_cache == NULL || r->refcount_block_cache == NULL) {
94edf3fb
KW
1040 error_setg(errp, "Could not allocate metadata caches");
1041 ret = -ENOMEM;
1042 goto fail;
1043 }
1044
1045 /* New interval for cache cleanup timer */
ee55b173 1046 r->cache_clean_interval =
5b0959a7 1047 qemu_opt_get_number(opts, QCOW2_OPT_CACHE_CLEAN_INTERVAL,
e957b50b 1048 DEFAULT_CACHE_CLEAN_INTERVAL);
91203f08
AG
1049#ifndef CONFIG_LINUX
1050 if (r->cache_clean_interval != 0) {
1051 error_setg(errp, QCOW2_OPT_CACHE_CLEAN_INTERVAL
1052 " not supported on this host");
1053 ret = -EINVAL;
1054 goto fail;
1055 }
1056#endif
ee55b173 1057 if (r->cache_clean_interval > UINT_MAX) {
94edf3fb
KW
1058 error_setg(errp, "Cache clean interval too big");
1059 ret = -EINVAL;
1060 goto fail;
1061 }
94edf3fb 1062
5b0959a7 1063 /* lazy-refcounts; flush if going from enabled to disabled */
ee55b173 1064 r->use_lazy_refcounts = qemu_opt_get_bool(opts, QCOW2_OPT_LAZY_REFCOUNTS,
4c75d1a1 1065 (s->compatible_features & QCOW2_COMPAT_LAZY_REFCOUNTS));
ee55b173 1066 if (r->use_lazy_refcounts && s->qcow_version < 3) {
007dbc39
KW
1067 error_setg(errp, "Lazy refcounts require a qcow2 image with at least "
1068 "qemu 1.1 compatibility level");
1069 ret = -EINVAL;
1070 goto fail;
1071 }
4c75d1a1 1072
5b0959a7
KW
1073 if (s->use_lazy_refcounts && !r->use_lazy_refcounts) {
1074 ret = qcow2_mark_clean(bs);
1075 if (ret < 0) {
1076 error_setg_errno(errp, -ret, "Failed to disable lazy refcounts");
1077 goto fail;
1078 }
1079 }
1080
007dbc39 1081 /* Overlap check options */
4c75d1a1
KW
1082 opt_overlap_check = qemu_opt_get(opts, QCOW2_OPT_OVERLAP);
1083 opt_overlap_check_template = qemu_opt_get(opts, QCOW2_OPT_OVERLAP_TEMPLATE);
1084 if (opt_overlap_check_template && opt_overlap_check &&
1085 strcmp(opt_overlap_check_template, opt_overlap_check))
1086 {
1087 error_setg(errp, "Conflicting values for qcow2 options '"
1088 QCOW2_OPT_OVERLAP "' ('%s') and '" QCOW2_OPT_OVERLAP_TEMPLATE
1089 "' ('%s')", opt_overlap_check, opt_overlap_check_template);
1090 ret = -EINVAL;
1091 goto fail;
1092 }
1093 if (!opt_overlap_check) {
1094 opt_overlap_check = opt_overlap_check_template ?: "cached";
1095 }
1096
1097 if (!strcmp(opt_overlap_check, "none")) {
1098 overlap_check_template = 0;
1099 } else if (!strcmp(opt_overlap_check, "constant")) {
1100 overlap_check_template = QCOW2_OL_CONSTANT;
1101 } else if (!strcmp(opt_overlap_check, "cached")) {
1102 overlap_check_template = QCOW2_OL_CACHED;
1103 } else if (!strcmp(opt_overlap_check, "all")) {
1104 overlap_check_template = QCOW2_OL_ALL;
1105 } else {
1106 error_setg(errp, "Unsupported value '%s' for qcow2 option "
1107 "'overlap-check'. Allowed are any of the following: "
1108 "none, constant, cached, all", opt_overlap_check);
1109 ret = -EINVAL;
1110 goto fail;
1111 }
1112
ee55b173 1113 r->overlap_check = 0;
4c75d1a1
KW
1114 for (i = 0; i < QCOW2_OL_MAX_BITNR; i++) {
1115 /* overlap-check defines a template bitmask, but every flag may be
1116 * overwritten through the associated boolean option */
ee55b173 1117 r->overlap_check |=
4c75d1a1
KW
1118 qemu_opt_get_bool(opts, overlap_bool_option_names[i],
1119 overlap_check_template & (1 << i)) << i;
1120 }
1121
ee55b173
KW
1122 r->discard_passthrough[QCOW2_DISCARD_NEVER] = false;
1123 r->discard_passthrough[QCOW2_DISCARD_ALWAYS] = true;
1124 r->discard_passthrough[QCOW2_DISCARD_REQUEST] =
007dbc39
KW
1125 qemu_opt_get_bool(opts, QCOW2_OPT_DISCARD_REQUEST,
1126 flags & BDRV_O_UNMAP);
ee55b173 1127 r->discard_passthrough[QCOW2_DISCARD_SNAPSHOT] =
007dbc39 1128 qemu_opt_get_bool(opts, QCOW2_OPT_DISCARD_SNAPSHOT, true);
ee55b173 1129 r->discard_passthrough[QCOW2_DISCARD_OTHER] =
007dbc39
KW
1130 qemu_opt_get_bool(opts, QCOW2_OPT_DISCARD_OTHER, false);
1131
b25b387f
DB
1132 switch (s->crypt_method_header) {
1133 case QCOW_CRYPT_NONE:
1134 if (encryptfmt) {
1135 error_setg(errp, "No encryption in image header, but options "
1136 "specified format '%s'", encryptfmt);
1137 ret = -EINVAL;
1138 goto fail;
1139 }
1140 break;
1141
1142 case QCOW_CRYPT_AES:
1143 if (encryptfmt && !g_str_equal(encryptfmt, "aes")) {
1144 error_setg(errp,
1145 "Header reported 'aes' encryption format but "
1146 "options specify '%s'", encryptfmt);
1147 ret = -EINVAL;
1148 goto fail;
1149 }
796d3239
MA
1150 qdict_put_str(encryptopts, "format", "qcow");
1151 r->crypto_opts = block_crypto_open_opts_init(encryptopts, errp);
b25b387f
DB
1152 break;
1153
4652b8f3
DB
1154 case QCOW_CRYPT_LUKS:
1155 if (encryptfmt && !g_str_equal(encryptfmt, "luks")) {
1156 error_setg(errp,
1157 "Header reported 'luks' encryption format but "
1158 "options specify '%s'", encryptfmt);
1159 ret = -EINVAL;
1160 goto fail;
1161 }
796d3239
MA
1162 qdict_put_str(encryptopts, "format", "luks");
1163 r->crypto_opts = block_crypto_open_opts_init(encryptopts, errp);
4652b8f3
DB
1164 break;
1165
b25b387f
DB
1166 default:
1167 error_setg(errp, "Unsupported encryption method %d",
1168 s->crypt_method_header);
1169 break;
1170 }
1171 if (s->crypt_method_header != QCOW_CRYPT_NONE && !r->crypto_opts) {
1172 ret = -EINVAL;
1173 goto fail;
1174 }
1175
4c75d1a1
KW
1176 ret = 0;
1177fail:
cb3e7f08 1178 qobject_unref(encryptopts);
94edf3fb
KW
1179 qemu_opts_del(opts);
1180 opts = NULL;
ee55b173
KW
1181 return ret;
1182}
1183
1184static void qcow2_update_options_commit(BlockDriverState *bs,
1185 Qcow2ReopenState *r)
1186{
1187 BDRVQcow2State *s = bs->opaque;
1188 int i;
1189
5b0959a7 1190 if (s->l2_table_cache) {
e64d4072 1191 qcow2_cache_destroy(s->l2_table_cache);
5b0959a7
KW
1192 }
1193 if (s->refcount_block_cache) {
e64d4072 1194 qcow2_cache_destroy(s->refcount_block_cache);
5b0959a7 1195 }
ee55b173
KW
1196 s->l2_table_cache = r->l2_table_cache;
1197 s->refcount_block_cache = r->refcount_block_cache;
3c2e511a 1198 s->l2_slice_size = r->l2_slice_size;
ee55b173
KW
1199
1200 s->overlap_check = r->overlap_check;
1201 s->use_lazy_refcounts = r->use_lazy_refcounts;
1202
1203 for (i = 0; i < QCOW2_DISCARD_MAX; i++) {
1204 s->discard_passthrough[i] = r->discard_passthrough[i];
1205 }
1206
5b0959a7
KW
1207 if (s->cache_clean_interval != r->cache_clean_interval) {
1208 cache_clean_timer_del(bs);
1209 s->cache_clean_interval = r->cache_clean_interval;
1210 cache_clean_timer_init(bs, bdrv_get_aio_context(bs));
1211 }
b25b387f
DB
1212
1213 qapi_free_QCryptoBlockOpenOptions(s->crypto_opts);
1214 s->crypto_opts = r->crypto_opts;
ee55b173
KW
1215}
1216
1217static void qcow2_update_options_abort(BlockDriverState *bs,
1218 Qcow2ReopenState *r)
1219{
1220 if (r->l2_table_cache) {
e64d4072 1221 qcow2_cache_destroy(r->l2_table_cache);
ee55b173
KW
1222 }
1223 if (r->refcount_block_cache) {
e64d4072 1224 qcow2_cache_destroy(r->refcount_block_cache);
ee55b173 1225 }
b25b387f 1226 qapi_free_QCryptoBlockOpenOptions(r->crypto_opts);
ee55b173
KW
1227}
1228
1229static int qcow2_update_options(BlockDriverState *bs, QDict *options,
1230 int flags, Error **errp)
1231{
1232 Qcow2ReopenState r = {};
1233 int ret;
1234
1235 ret = qcow2_update_options_prepare(bs, &r, options, flags, errp);
1236 if (ret >= 0) {
1237 qcow2_update_options_commit(bs, &r);
1238 } else {
1239 qcow2_update_options_abort(bs, &r);
1240 }
94edf3fb 1241
4c75d1a1
KW
1242 return ret;
1243}
1244
1fafcd93
PB
1245/* Called with s->lock held. */
1246static int coroutine_fn qcow2_do_open(BlockDriverState *bs, QDict *options,
1247 int flags, Error **errp)
585f8587 1248{
ff99129a 1249 BDRVQcow2State *s = bs->opaque;
6d33e8e7
KW
1250 unsigned int len, i;
1251 int ret = 0;
585f8587 1252 QCowHeader header;
74c4510a 1253 Error *local_err = NULL;
9b80ddf3 1254 uint64_t ext_end;
2cf7cfa1 1255 uint64_t l1_vm_state_index;
88ddffae 1256 bool update_header = false;
585f8587 1257
cf2ab8fc 1258 ret = bdrv_pread(bs->file, 0, &header, sizeof(header));
6d85a57e 1259 if (ret < 0) {
3ef6c40a 1260 error_setg_errno(errp, -ret, "Could not read qcow2 header");
585f8587 1261 goto fail;
6d85a57e 1262 }
3b698f52
PM
1263 header.magic = be32_to_cpu(header.magic);
1264 header.version = be32_to_cpu(header.version);
1265 header.backing_file_offset = be64_to_cpu(header.backing_file_offset);
1266 header.backing_file_size = be32_to_cpu(header.backing_file_size);
1267 header.size = be64_to_cpu(header.size);
1268 header.cluster_bits = be32_to_cpu(header.cluster_bits);
1269 header.crypt_method = be32_to_cpu(header.crypt_method);
1270 header.l1_table_offset = be64_to_cpu(header.l1_table_offset);
1271 header.l1_size = be32_to_cpu(header.l1_size);
1272 header.refcount_table_offset = be64_to_cpu(header.refcount_table_offset);
1273 header.refcount_table_clusters =
1274 be32_to_cpu(header.refcount_table_clusters);
1275 header.snapshots_offset = be64_to_cpu(header.snapshots_offset);
1276 header.nb_snapshots = be32_to_cpu(header.nb_snapshots);
3b46e624 1277
e8cdcec1 1278 if (header.magic != QCOW_MAGIC) {
3ef6c40a 1279 error_setg(errp, "Image is not in qcow2 format");
76abe407 1280 ret = -EINVAL;
585f8587 1281 goto fail;
6d85a57e 1282 }
6744cbab 1283 if (header.version < 2 || header.version > 3) {
a55448b3 1284 error_setg(errp, "Unsupported qcow2 version %" PRIu32, header.version);
6744cbab
KW
1285 ret = -ENOTSUP;
1286 goto fail;
1287 }
1288
1289 s->qcow_version = header.version;
1290
24342f2c
KW
1291 /* Initialise cluster size */
1292 if (header.cluster_bits < MIN_CLUSTER_BITS ||
1293 header.cluster_bits > MAX_CLUSTER_BITS) {
521b2b5d
HR
1294 error_setg(errp, "Unsupported cluster size: 2^%" PRIu32,
1295 header.cluster_bits);
24342f2c
KW
1296 ret = -EINVAL;
1297 goto fail;
1298 }
1299
1300 s->cluster_bits = header.cluster_bits;
1301 s->cluster_size = 1 << s->cluster_bits;
24342f2c 1302
6744cbab
KW
1303 /* Initialise version 3 header fields */
1304 if (header.version == 2) {
1305 header.incompatible_features = 0;
1306 header.compatible_features = 0;
1307 header.autoclear_features = 0;
1308 header.refcount_order = 4;
1309 header.header_length = 72;
1310 } else {
3b698f52
PM
1311 header.incompatible_features =
1312 be64_to_cpu(header.incompatible_features);
1313 header.compatible_features = be64_to_cpu(header.compatible_features);
1314 header.autoclear_features = be64_to_cpu(header.autoclear_features);
1315 header.refcount_order = be32_to_cpu(header.refcount_order);
1316 header.header_length = be32_to_cpu(header.header_length);
24342f2c
KW
1317
1318 if (header.header_length < 104) {
1319 error_setg(errp, "qcow2 header too short");
1320 ret = -EINVAL;
1321 goto fail;
1322 }
1323 }
1324
1325 if (header.header_length > s->cluster_size) {
1326 error_setg(errp, "qcow2 header exceeds cluster size");
1327 ret = -EINVAL;
1328 goto fail;
6744cbab
KW
1329 }
1330
1331 if (header.header_length > sizeof(header)) {
1332 s->unknown_header_fields_size = header.header_length - sizeof(header);
1333 s->unknown_header_fields = g_malloc(s->unknown_header_fields_size);
cf2ab8fc 1334 ret = bdrv_pread(bs->file, sizeof(header), s->unknown_header_fields,
6744cbab
KW
1335 s->unknown_header_fields_size);
1336 if (ret < 0) {
3ef6c40a
HR
1337 error_setg_errno(errp, -ret, "Could not read unknown qcow2 header "
1338 "fields");
6744cbab
KW
1339 goto fail;
1340 }
1341 }
1342
a1b3955c
KW
1343 if (header.backing_file_offset > s->cluster_size) {
1344 error_setg(errp, "Invalid backing file offset");
1345 ret = -EINVAL;
1346 goto fail;
1347 }
1348
cfcc4c62
KW
1349 if (header.backing_file_offset) {
1350 ext_end = header.backing_file_offset;
1351 } else {
1352 ext_end = 1 << header.cluster_bits;
1353 }
1354
6744cbab
KW
1355 /* Handle feature bits */
1356 s->incompatible_features = header.incompatible_features;
1357 s->compatible_features = header.compatible_features;
1358 s->autoclear_features = header.autoclear_features;
1359
c61d0004 1360 if (s->incompatible_features & ~QCOW2_INCOMPAT_MASK) {
cfcc4c62
KW
1361 void *feature_table = NULL;
1362 qcow2_read_extensions(bs, header.header_length, ext_end,
88ddffae 1363 &feature_table, flags, NULL, NULL);
a55448b3 1364 report_unsupported_feature(errp, feature_table,
c61d0004
SH
1365 s->incompatible_features &
1366 ~QCOW2_INCOMPAT_MASK);
6744cbab 1367 ret = -ENOTSUP;
c5a33ee9 1368 g_free(feature_table);
6744cbab
KW
1369 goto fail;
1370 }
1371
69c98726
HR
1372 if (s->incompatible_features & QCOW2_INCOMPAT_CORRUPT) {
1373 /* Corrupt images may not be written to unless they are being repaired
1374 */
1375 if ((flags & BDRV_O_RDWR) && !(flags & BDRV_O_CHECK)) {
3ef6c40a
HR
1376 error_setg(errp, "qcow2: Image is corrupt; cannot be opened "
1377 "read/write");
69c98726
HR
1378 ret = -EACCES;
1379 goto fail;
1380 }
1381 }
1382
6744cbab 1383 /* Check support for various header values */
b72faf9f
HR
1384 if (header.refcount_order > 6) {
1385 error_setg(errp, "Reference count entry width too large; may not "
1386 "exceed 64 bits");
1387 ret = -EINVAL;
e8cdcec1
KW
1388 goto fail;
1389 }
b6481f37 1390 s->refcount_order = header.refcount_order;
346a53df
HR
1391 s->refcount_bits = 1 << s->refcount_order;
1392 s->refcount_max = UINT64_C(1) << (s->refcount_bits - 1);
1393 s->refcount_max += s->refcount_max - 1;
6744cbab 1394
585f8587 1395 s->crypt_method_header = header.crypt_method;
6d85a57e 1396 if (s->crypt_method_header) {
e6ff69bf
DB
1397 if (bdrv_uses_whitelist() &&
1398 s->crypt_method_header == QCOW_CRYPT_AES) {
8c0dcbc4
DB
1399 error_setg(errp,
1400 "Use of AES-CBC encrypted qcow2 images is no longer "
1401 "supported in system emulators");
1402 error_append_hint(errp,
1403 "You can use 'qemu-img convert' to convert your "
1404 "image to an alternative supported format, such "
1405 "as unencrypted qcow2, or raw with the LUKS "
1406 "format instead.\n");
1407 ret = -ENOSYS;
1408 goto fail;
e6ff69bf
DB
1409 }
1410
4652b8f3
DB
1411 if (s->crypt_method_header == QCOW_CRYPT_AES) {
1412 s->crypt_physical_offset = false;
1413 } else {
1414 /* Assuming LUKS and any future crypt methods we
1415 * add will all use physical offsets, due to the
1416 * fact that the alternative is insecure... */
1417 s->crypt_physical_offset = true;
1418 }
1419
54115412 1420 bs->encrypted = true;
6d85a57e 1421 }
24342f2c 1422
585f8587
FB
1423 s->l2_bits = s->cluster_bits - 3; /* L2 is always one cluster */
1424 s->l2_size = 1 << s->l2_bits;
1d13d654
HR
1425 /* 2^(s->refcount_order - 3) is the refcount width in bytes */
1426 s->refcount_block_bits = s->cluster_bits - (s->refcount_order - 3);
1427 s->refcount_block_size = 1 << s->refcount_block_bits;
bd016b91 1428 bs->total_sectors = header.size / BDRV_SECTOR_SIZE;
585f8587
FB
1429 s->csize_shift = (62 - (s->cluster_bits - 8));
1430 s->csize_mask = (1 << (s->cluster_bits - 8)) - 1;
1431 s->cluster_offset_mask = (1LL << s->csize_shift) - 1;
5dab2fad 1432
585f8587 1433 s->refcount_table_offset = header.refcount_table_offset;
5fafdf24 1434 s->refcount_table_size =
585f8587
FB
1435 header.refcount_table_clusters << (s->cluster_bits - 3);
1436
951053a9
AG
1437 if (header.refcount_table_clusters == 0 && !(flags & BDRV_O_CHECK)) {
1438 error_setg(errp, "Image does not contain a reference count table");
1439 ret = -EINVAL;
1440 goto fail;
1441 }
1442
0cf0e598
AG
1443 ret = qcow2_validate_table(bs, s->refcount_table_offset,
1444 header.refcount_table_clusters,
1445 s->cluster_size, QCOW_MAX_REFTABLE_SIZE,
1446 "Reference count table", errp);
8c7de283 1447 if (ret < 0) {
8c7de283
KW
1448 goto fail;
1449 }
1450
8bc584fe
HR
1451 if (!(flags & BDRV_O_CHECK)) {
1452 /*
1453 * The total size in bytes of the snapshot table is checked in
1454 * qcow2_read_snapshots() because the size of each snapshot is
1455 * variable and we don't know it yet.
1456 * Here we only check the offset and number of snapshots.
1457 */
1458 ret = qcow2_validate_table(bs, header.snapshots_offset,
1459 header.nb_snapshots,
1460 sizeof(QCowSnapshotHeader),
1461 sizeof(QCowSnapshotHeader) *
1462 QCOW_MAX_SNAPSHOTS,
1463 "Snapshot table", errp);
1464 if (ret < 0) {
1465 goto fail;
1466 }
ce48f2f4
KW
1467 }
1468
585f8587 1469 /* read the level 1 table */
0cf0e598
AG
1470 ret = qcow2_validate_table(bs, header.l1_table_offset,
1471 header.l1_size, sizeof(uint64_t),
1472 QCOW_MAX_L1_SIZE, "Active L1 table", errp);
1473 if (ret < 0) {
2d51c32c
KW
1474 goto fail;
1475 }
585f8587 1476 s->l1_size = header.l1_size;
0cf0e598 1477 s->l1_table_offset = header.l1_table_offset;
2cf7cfa1
KW
1478
1479 l1_vm_state_index = size_to_l1(s, header.size);
1480 if (l1_vm_state_index > INT_MAX) {
3ef6c40a 1481 error_setg(errp, "Image is too big");
2cf7cfa1
KW
1482 ret = -EFBIG;
1483 goto fail;
1484 }
1485 s->l1_vm_state_index = l1_vm_state_index;
1486
585f8587
FB
1487 /* the L1 table must contain at least enough entries to put
1488 header.size bytes */
6d85a57e 1489 if (s->l1_size < s->l1_vm_state_index) {
3ef6c40a 1490 error_setg(errp, "L1 table is too small");
6d85a57e 1491 ret = -EINVAL;
585f8587 1492 goto fail;
6d85a57e 1493 }
2d51c32c 1494
d191d12d 1495 if (s->l1_size > 0) {
9a4f4c31 1496 s->l1_table = qemu_try_blockalign(bs->file->bs,
ef97d608 1497 s->l1_size * sizeof(uint64_t));
de82815d
KW
1498 if (s->l1_table == NULL) {
1499 error_setg(errp, "Could not allocate L1 table");
1500 ret = -ENOMEM;
1501 goto fail;
1502 }
cf2ab8fc 1503 ret = bdrv_pread(bs->file, s->l1_table_offset, s->l1_table,
6d85a57e
JS
1504 s->l1_size * sizeof(uint64_t));
1505 if (ret < 0) {
3ef6c40a 1506 error_setg_errno(errp, -ret, "Could not read L1 table");
d191d12d 1507 goto fail;
6d85a57e 1508 }
d191d12d 1509 for(i = 0;i < s->l1_size; i++) {
3b698f52 1510 s->l1_table[i] = be64_to_cpu(s->l1_table[i]);
d191d12d 1511 }
585f8587 1512 }
29c1a730 1513
94edf3fb
KW
1514 /* Parse driver-specific options */
1515 ret = qcow2_update_options(bs, options, flags, errp);
90efa0ea
KW
1516 if (ret < 0) {
1517 goto fail;
1518 }
1519
06d9260f 1520 s->flags = flags;
3b46e624 1521
6d85a57e
JS
1522 ret = qcow2_refcount_init(bs);
1523 if (ret != 0) {
3ef6c40a 1524 error_setg_errno(errp, -ret, "Could not initialize refcount handling");
585f8587 1525 goto fail;
6d85a57e 1526 }
585f8587 1527
72cf2d4f 1528 QLIST_INIT(&s->cluster_allocs);
0b919fae 1529 QTAILQ_INIT(&s->discards);
f214978a 1530
9b80ddf3 1531 /* read qcow2 extensions */
3ef6c40a 1532 if (qcow2_read_extensions(bs, header.header_length, ext_end, NULL,
88ddffae 1533 flags, &update_header, &local_err)) {
3ef6c40a 1534 error_propagate(errp, local_err);
6d85a57e 1535 ret = -EINVAL;
9b80ddf3 1536 goto fail;
6d85a57e 1537 }
9b80ddf3 1538
0e8c08be
KW
1539 /* Open external data file */
1540 s->data_file = bdrv_open_child(NULL, options, "data-file", bs, &child_file,
1541 true, &local_err);
1542 if (local_err) {
1543 error_propagate(errp, local_err);
1544 ret = -EINVAL;
1545 goto fail;
1546 }
1547
1548 if (s->incompatible_features & QCOW2_INCOMPAT_DATA_FILE) {
9b890bdc
KW
1549 if (!s->data_file && s->image_data_file) {
1550 s->data_file = bdrv_open_child(s->image_data_file, options,
1551 "data-file", bs, &child_file,
1552 false, errp);
1553 if (!s->data_file) {
1554 ret = -EINVAL;
1555 goto fail;
1556 }
1557 }
0e8c08be
KW
1558 if (!s->data_file) {
1559 error_setg(errp, "'data-file' is required for this image");
1560 ret = -EINVAL;
1561 goto fail;
1562 }
1563 } else {
1564 if (s->data_file) {
1565 error_setg(errp, "'data-file' can only be set for images with an "
1566 "external data file");
1567 ret = -EINVAL;
1568 goto fail;
6c3944dc
KW
1569 }
1570
1571 s->data_file = bs->file;
1572
1573 if (data_file_is_raw(bs)) {
1574 error_setg(errp, "data-file-raw requires a data file");
1575 ret = -EINVAL;
1576 goto fail;
0e8c08be
KW
1577 }
1578 }
93c24936 1579
4652b8f3
DB
1580 /* qcow2_read_extension may have set up the crypto context
1581 * if the crypt method needs a header region, some methods
1582 * don't need header extensions, so must check here
1583 */
1584 if (s->crypt_method_header && !s->crypto) {
1585 if (s->crypt_method_header == QCOW_CRYPT_AES) {
1586 unsigned int cflags = 0;
1587 if (flags & BDRV_O_NO_IO) {
1588 cflags |= QCRYPTO_BLOCK_OPEN_NO_IO;
1589 }
1cd9a787 1590 s->crypto = qcrypto_block_open(s->crypto_opts, "encrypt.",
8ac0f15f
VSO
1591 NULL, NULL, cflags,
1592 QCOW2_MAX_THREADS, errp);
4652b8f3
DB
1593 if (!s->crypto) {
1594 ret = -EINVAL;
1595 goto fail;
1596 }
1597 } else if (!(flags & BDRV_O_NO_IO)) {
1598 error_setg(errp, "Missing CRYPTO header for crypt method %d",
1599 s->crypt_method_header);
b25b387f
DB
1600 ret = -EINVAL;
1601 goto fail;
1602 }
1603 }
1604
585f8587
FB
1605 /* read the backing file name */
1606 if (header.backing_file_offset != 0) {
1607 len = header.backing_file_size;
9a29e18f 1608 if (len > MIN(1023, s->cluster_size - header.backing_file_offset) ||
e729fa6a 1609 len >= sizeof(bs->backing_file)) {
6d33e8e7
KW
1610 error_setg(errp, "Backing file name too long");
1611 ret = -EINVAL;
1612 goto fail;
6d85a57e 1613 }
cf2ab8fc 1614 ret = bdrv_pread(bs->file, header.backing_file_offset,
998c2019 1615 bs->auto_backing_file, len);
6d85a57e 1616 if (ret < 0) {
3ef6c40a 1617 error_setg_errno(errp, -ret, "Could not read backing file name");
585f8587 1618 goto fail;
6d85a57e 1619 }
998c2019
HR
1620 bs->auto_backing_file[len] = '\0';
1621 pstrcpy(bs->backing_file, sizeof(bs->backing_file),
1622 bs->auto_backing_file);
1623 s->image_backing_file = g_strdup(bs->auto_backing_file);
585f8587 1624 }
42deb29f 1625
8bc584fe
HR
1626 /*
1627 * Internal snapshots; skip reading them in check mode, because
1628 * we do not need them then, and we do not want to abort because
1629 * of a broken table.
1630 */
1631 if (!(flags & BDRV_O_CHECK)) {
1632 s->snapshots_offset = header.snapshots_offset;
1633 s->nb_snapshots = header.nb_snapshots;
11b128f4 1634
8bc584fe
HR
1635 ret = qcow2_read_snapshots(bs, errp);
1636 if (ret < 0) {
1637 goto fail;
1638 }
6d85a57e 1639 }
585f8587 1640
af7b708d 1641 /* Clear unknown autoclear feature bits */
88ddffae 1642 update_header |= s->autoclear_features & ~QCOW2_AUTOCLEAR_MASK;
d1258dd0
VSO
1643 update_header =
1644 update_header && !bs->read_only && !(flags & BDRV_O_INACTIVE);
1645 if (update_header) {
88ddffae 1646 s->autoclear_features &= QCOW2_AUTOCLEAR_MASK;
d1258dd0
VSO
1647 }
1648
9c98f145
VSO
1649 /* == Handle persistent dirty bitmaps ==
1650 *
1651 * We want load dirty bitmaps in three cases:
1652 *
1653 * 1. Normal open of the disk in active mode, not related to invalidation
1654 * after migration.
1655 *
1656 * 2. Invalidation of the target vm after pre-copy phase of migration, if
1657 * bitmaps are _not_ migrating through migration channel, i.e.
1658 * 'dirty-bitmaps' capability is disabled.
1659 *
1660 * 3. Invalidation of source vm after failed or canceled migration.
1661 * This is a very interesting case. There are two possible types of
1662 * bitmaps:
1663 *
1664 * A. Stored on inactivation and removed. They should be loaded from the
1665 * image.
1666 *
1667 * B. Not stored: not-persistent bitmaps and bitmaps, migrated through
1668 * the migration channel (with dirty-bitmaps capability).
1669 *
1670 * On the other hand, there are two possible sub-cases:
1671 *
1672 * 3.1 disk was changed by somebody else while were inactive. In this
1673 * case all in-RAM dirty bitmaps (both persistent and not) are
1674 * definitely invalid. And we don't have any method to determine
1675 * this.
1676 *
1677 * Simple and safe thing is to just drop all the bitmaps of type B on
1678 * inactivation. But in this case we lose bitmaps in valid 4.2 case.
1679 *
1680 * On the other hand, resuming source vm, if disk was already changed
1681 * is a bad thing anyway: not only bitmaps, the whole vm state is
1682 * out of sync with disk.
1683 *
1684 * This means, that user or management tool, who for some reason
1685 * decided to resume source vm, after disk was already changed by
1686 * target vm, should at least drop all dirty bitmaps by hand.
1687 *
1688 * So, we can ignore this case for now, but TODO: "generation"
1689 * extension for qcow2, to determine, that image was changed after
1690 * last inactivation. And if it is changed, we will drop (or at least
1691 * mark as 'invalid' all the bitmaps of type B, both persistent
1692 * and not).
1693 *
1694 * 3.2 disk was _not_ changed while were inactive. Bitmaps may be saved
1695 * to disk ('dirty-bitmaps' capability disabled), or not saved
1696 * ('dirty-bitmaps' capability enabled), but we don't need to care
1697 * of: let's load bitmaps as always: stored bitmaps will be loaded,
1698 * and not stored has flag IN_USE=1 in the image and will be skipped
1699 * on loading.
1700 *
1701 * One remaining possible case when we don't want load bitmaps:
1702 *
1703 * 4. Open disk in inactive mode in target vm (bitmaps are migrating or
1704 * will be loaded on invalidation, no needs try loading them before)
1705 */
1706
1707 if (!(bdrv_get_flags(bs) & BDRV_O_INACTIVE)) {
1708 /* It's case 1, 2 or 3.2. Or 3.1 which is BUG in management layer. */
1709 bool header_updated = qcow2_load_dirty_bitmaps(bs, &local_err);
66be5c3e
T
1710 if (local_err != NULL) {
1711 error_propagate(errp, local_err);
1712 ret = -EINVAL;
1713 goto fail;
1714 }
9c98f145
VSO
1715
1716 update_header = update_header && !header_updated;
d1258dd0 1717 }
d1258dd0
VSO
1718
1719 if (update_header) {
af7b708d
SH
1720 ret = qcow2_update_header(bs);
1721 if (ret < 0) {
3ef6c40a 1722 error_setg_errno(errp, -ret, "Could not update qcow2 header");
af7b708d
SH
1723 goto fail;
1724 }
1725 }
1726
3b650816
KW
1727 bs->supported_zero_flags = header.version >= 3 ?
1728 BDRV_REQ_MAY_UNMAP | BDRV_REQ_NO_FALLBACK : 0;
f01643fb 1729 bs->supported_truncate_flags = BDRV_REQ_ZERO_WRITE;
68d100e9 1730
c61d0004 1731 /* Repair image if dirty */
04c01a5c 1732 if (!(flags & (BDRV_O_CHECK | BDRV_O_INACTIVE)) && !bs->read_only &&
058f8f16 1733 (s->incompatible_features & QCOW2_INCOMPAT_DIRTY)) {
c61d0004
SH
1734 BdrvCheckResult result = {0};
1735
2fd61638
PB
1736 ret = qcow2_co_check_locked(bs, &result,
1737 BDRV_FIX_ERRORS | BDRV_FIX_LEAKS);
791fff50
HR
1738 if (ret < 0 || result.check_errors) {
1739 if (ret >= 0) {
1740 ret = -EIO;
1741 }
3ef6c40a 1742 error_setg_errno(errp, -ret, "Could not repair dirty image");
c61d0004
SH
1743 goto fail;
1744 }
1745 }
1746
585f8587 1747#ifdef DEBUG_ALLOC
6cbc3031
PH
1748 {
1749 BdrvCheckResult result = {0};
b35278f7 1750 qcow2_check_refcounts(bs, &result, 0);
6cbc3031 1751 }
585f8587 1752#endif
ceb029cd 1753
6f13a316 1754 qemu_co_queue_init(&s->thread_task_queue);
ceb029cd 1755
6d85a57e 1756 return ret;
585f8587
FB
1757
1758 fail:
9b890bdc 1759 g_free(s->image_data_file);
0e8c08be
KW
1760 if (has_data_file(bs)) {
1761 bdrv_unref_child(bs, s->data_file);
808cf3cb 1762 s->data_file = NULL;
0e8c08be 1763 }
6744cbab 1764 g_free(s->unknown_header_fields);
75bab85c 1765 cleanup_unknown_header_ext(bs);
ed6ccf0f
KW
1766 qcow2_free_snapshots(bs);
1767 qcow2_refcount_close(bs);
de82815d 1768 qemu_vfree(s->l1_table);
cf93980e
HR
1769 /* else pre-write overlap checks in cache_destroy may crash */
1770 s->l1_table = NULL;
279621c0 1771 cache_clean_timer_del(bs);
29c1a730 1772 if (s->l2_table_cache) {
e64d4072 1773 qcow2_cache_destroy(s->l2_table_cache);
29c1a730 1774 }
c5a33ee9 1775 if (s->refcount_block_cache) {
e64d4072 1776 qcow2_cache_destroy(s->refcount_block_cache);
c5a33ee9 1777 }
b25b387f
DB
1778 qcrypto_block_free(s->crypto);
1779 qapi_free_QCryptoBlockOpenOptions(s->crypto_opts);
6d85a57e 1780 return ret;
585f8587
FB
1781}
1782
1fafcd93
PB
1783typedef struct QCow2OpenCo {
1784 BlockDriverState *bs;
1785 QDict *options;
1786 int flags;
1787 Error **errp;
1788 int ret;
1789} QCow2OpenCo;
1790
1791static void coroutine_fn qcow2_open_entry(void *opaque)
1792{
1793 QCow2OpenCo *qoc = opaque;
1794 BDRVQcow2State *s = qoc->bs->opaque;
1795
1796 qemu_co_mutex_lock(&s->lock);
1797 qoc->ret = qcow2_do_open(qoc->bs, qoc->options, qoc->flags, qoc->errp);
1798 qemu_co_mutex_unlock(&s->lock);
1799}
1800
4e4bf5c4
KW
1801static int qcow2_open(BlockDriverState *bs, QDict *options, int flags,
1802 Error **errp)
1803{
1fafcd93
PB
1804 BDRVQcow2State *s = bs->opaque;
1805 QCow2OpenCo qoc = {
1806 .bs = bs,
1807 .options = options,
1808 .flags = flags,
1809 .errp = errp,
1810 .ret = -EINPROGRESS
1811 };
1812
4e4bf5c4
KW
1813 bs->file = bdrv_open_child(NULL, options, "file", bs, &child_file,
1814 false, errp);
1815 if (!bs->file) {
1816 return -EINVAL;
1817 }
1818
1fafcd93
PB
1819 /* Initialise locks */
1820 qemu_co_mutex_init(&s->lock);
1821
1822 if (qemu_in_coroutine()) {
1823 /* From bdrv_co_create. */
1824 qcow2_open_entry(&qoc);
1825 } else {
4720cbee 1826 assert(qemu_get_current_aio_context() == qemu_get_aio_context());
1fafcd93
PB
1827 qemu_coroutine_enter(qemu_coroutine_create(qcow2_open_entry, &qoc));
1828 BDRV_POLL_WHILE(bs, qoc.ret == -EINPROGRESS);
1829 }
1830 return qoc.ret;
4e4bf5c4
KW
1831}
1832
3baca891 1833static void qcow2_refresh_limits(BlockDriverState *bs, Error **errp)
d34682cd 1834{
ff99129a 1835 BDRVQcow2State *s = bs->opaque;
d34682cd 1836
a84178cc
EB
1837 if (bs->encrypted) {
1838 /* Encryption works on a sector granularity */
6f8f015c 1839 bs->bl.request_alignment = qcrypto_block_get_sector_size(s->crypto);
a84178cc 1840 }
cf081fca 1841 bs->bl.pwrite_zeroes_alignment = s->cluster_size;
ecdbead6 1842 bs->bl.pdiscard_alignment = s->cluster_size;
d34682cd
KW
1843}
1844
21d82ac9
JC
1845static int qcow2_reopen_prepare(BDRVReopenState *state,
1846 BlockReopenQueue *queue, Error **errp)
1847{
5b0959a7 1848 Qcow2ReopenState *r;
4c2e5f8f
KW
1849 int ret;
1850
5b0959a7
KW
1851 r = g_new0(Qcow2ReopenState, 1);
1852 state->opaque = r;
1853
1854 ret = qcow2_update_options_prepare(state->bs, r, state->options,
1855 state->flags, errp);
1856 if (ret < 0) {
1857 goto fail;
1858 }
1859
1860 /* We need to write out any unwritten data if we reopen read-only. */
4c2e5f8f 1861 if ((state->flags & BDRV_O_RDWR) == 0) {
169b8793
VSO
1862 ret = qcow2_reopen_bitmaps_ro(state->bs, errp);
1863 if (ret < 0) {
1864 goto fail;
1865 }
1866
4c2e5f8f
KW
1867 ret = bdrv_flush(state->bs);
1868 if (ret < 0) {
5b0959a7 1869 goto fail;
4c2e5f8f
KW
1870 }
1871
1872 ret = qcow2_mark_clean(state->bs);
1873 if (ret < 0) {
5b0959a7 1874 goto fail;
4c2e5f8f
KW
1875 }
1876 }
1877
21d82ac9 1878 return 0;
5b0959a7
KW
1879
1880fail:
1881 qcow2_update_options_abort(state->bs, r);
1882 g_free(r);
1883 return ret;
1884}
1885
1886static void qcow2_reopen_commit(BDRVReopenState *state)
1887{
1888 qcow2_update_options_commit(state->bs, state->opaque);
65eb7c85
PK
1889 g_free(state->opaque);
1890}
1891
1892static void qcow2_reopen_commit_post(BDRVReopenState *state)
1893{
4dd09f62
VSO
1894 if (state->flags & BDRV_O_RDWR) {
1895 Error *local_err = NULL;
1896
1897 if (qcow2_reopen_bitmaps_rw(state->bs, &local_err) < 0) {
1898 /*
1899 * This is not fatal, bitmaps just left read-only, so all following
1900 * writes will fail. User can remove read-only bitmaps to unblock
1901 * writes or retry reopen.
1902 */
1903 error_reportf_err(local_err,
1904 "%s: Failed to make dirty bitmaps writable: ",
1905 bdrv_get_node_name(state->bs));
1906 }
1907 }
5b0959a7
KW
1908}
1909
1910static void qcow2_reopen_abort(BDRVReopenState *state)
1911{
1912 qcow2_update_options_abort(state->bs, state->opaque);
1913 g_free(state->opaque);
21d82ac9
JC
1914}
1915
5365f44d
KW
1916static void qcow2_join_options(QDict *options, QDict *old_options)
1917{
1918 bool has_new_overlap_template =
1919 qdict_haskey(options, QCOW2_OPT_OVERLAP) ||
1920 qdict_haskey(options, QCOW2_OPT_OVERLAP_TEMPLATE);
1921 bool has_new_total_cache_size =
1922 qdict_haskey(options, QCOW2_OPT_CACHE_SIZE);
1923 bool has_all_cache_options;
1924
1925 /* New overlap template overrides all old overlap options */
1926 if (has_new_overlap_template) {
1927 qdict_del(old_options, QCOW2_OPT_OVERLAP);
1928 qdict_del(old_options, QCOW2_OPT_OVERLAP_TEMPLATE);
1929 qdict_del(old_options, QCOW2_OPT_OVERLAP_MAIN_HEADER);
1930 qdict_del(old_options, QCOW2_OPT_OVERLAP_ACTIVE_L1);
1931 qdict_del(old_options, QCOW2_OPT_OVERLAP_ACTIVE_L2);
1932 qdict_del(old_options, QCOW2_OPT_OVERLAP_REFCOUNT_TABLE);
1933 qdict_del(old_options, QCOW2_OPT_OVERLAP_REFCOUNT_BLOCK);
1934 qdict_del(old_options, QCOW2_OPT_OVERLAP_SNAPSHOT_TABLE);
1935 qdict_del(old_options, QCOW2_OPT_OVERLAP_INACTIVE_L1);
1936 qdict_del(old_options, QCOW2_OPT_OVERLAP_INACTIVE_L2);
1937 }
1938
1939 /* New total cache size overrides all old options */
1940 if (qdict_haskey(options, QCOW2_OPT_CACHE_SIZE)) {
1941 qdict_del(old_options, QCOW2_OPT_L2_CACHE_SIZE);
1942 qdict_del(old_options, QCOW2_OPT_REFCOUNT_CACHE_SIZE);
1943 }
1944
1945 qdict_join(options, old_options, false);
1946
1947 /*
1948 * If after merging all cache size options are set, an old total size is
1949 * overwritten. Do keep all options, however, if all three are new. The
1950 * resulting error message is what we want to happen.
1951 */
1952 has_all_cache_options =
1953 qdict_haskey(options, QCOW2_OPT_CACHE_SIZE) ||
1954 qdict_haskey(options, QCOW2_OPT_L2_CACHE_SIZE) ||
1955 qdict_haskey(options, QCOW2_OPT_REFCOUNT_CACHE_SIZE);
1956
1957 if (has_all_cache_options && !has_new_total_cache_size) {
1958 qdict_del(options, QCOW2_OPT_CACHE_SIZE);
1959 }
1960}
1961
a320fb04
EB
1962static int coroutine_fn qcow2_co_block_status(BlockDriverState *bs,
1963 bool want_zero,
1964 int64_t offset, int64_t count,
1965 int64_t *pnum, int64_t *map,
1966 BlockDriverState **file)
585f8587 1967{
ff99129a 1968 BDRVQcow2State *s = bs->opaque;
585f8587 1969 uint64_t cluster_offset;
ecfe1863 1970 unsigned int bytes;
74e60fb5 1971 int ret, status = 0;
585f8587 1972
5e978550
KW
1973 qemu_co_mutex_lock(&s->lock);
1974
69f47505
VSO
1975 if (!s->metadata_preallocation_checked) {
1976 ret = qcow2_detect_metadata_preallocation(bs);
1977 s->metadata_preallocation = (ret == 1);
1978 s->metadata_preallocation_checked = true;
1979 }
1980
a320fb04 1981 bytes = MIN(INT_MAX, count);
a320fb04 1982 ret = qcow2_get_cluster_offset(bs, offset, &bytes, &cluster_offset);
f8a2e5e3 1983 qemu_co_mutex_unlock(&s->lock);
1c46efaa 1984 if (ret < 0) {
d663640c 1985 return ret;
1c46efaa 1986 }
095a9c58 1987
a320fb04 1988 *pnum = bytes;
ecfe1863 1989
37be1403 1990 if ((ret == QCOW2_CLUSTER_NORMAL || ret == QCOW2_CLUSTER_ZERO_ALLOC) &&
b25b387f 1991 !s->crypto) {
74e60fb5 1992 *map = cluster_offset | offset_into_cluster(s, offset);
37be1403 1993 *file = s->data_file->bs;
a320fb04 1994 status |= BDRV_BLOCK_OFFSET_VALID;
4bc74be9 1995 }
fdfab37d 1996 if (ret == QCOW2_CLUSTER_ZERO_PLAIN || ret == QCOW2_CLUSTER_ZERO_ALLOC) {
4bc74be9
PB
1997 status |= BDRV_BLOCK_ZERO;
1998 } else if (ret != QCOW2_CLUSTER_UNALLOCATED) {
1999 status |= BDRV_BLOCK_DATA;
2000 }
69f47505
VSO
2001 if (s->metadata_preallocation && (status & BDRV_BLOCK_DATA) &&
2002 (status & BDRV_BLOCK_OFFSET_VALID))
2003 {
2004 status |= BDRV_BLOCK_RECURSE;
2005 }
4bc74be9 2006 return status;
585f8587
FB
2007}
2008
fd9fcd37
FZ
2009static coroutine_fn int qcow2_handle_l2meta(BlockDriverState *bs,
2010 QCowL2Meta **pl2meta,
2011 bool link_l2)
2012{
2013 int ret = 0;
2014 QCowL2Meta *l2meta = *pl2meta;
2015
2016 while (l2meta != NULL) {
2017 QCowL2Meta *next;
2018
354d930d 2019 if (link_l2) {
fd9fcd37
FZ
2020 ret = qcow2_alloc_cluster_link_l2(bs, l2meta);
2021 if (ret) {
2022 goto out;
2023 }
8b24cd14
KW
2024 } else {
2025 qcow2_alloc_cluster_abort(bs, l2meta);
fd9fcd37
FZ
2026 }
2027
2028 /* Take the request off the list of running requests */
2029 if (l2meta->nb_clusters != 0) {
2030 QLIST_REMOVE(l2meta, next_in_flight);
2031 }
2032
2033 qemu_co_queue_restart_all(&l2meta->dependent_requests);
2034
2035 next = l2meta->next;
2036 g_free(l2meta);
2037 l2meta = next;
2038 }
2039out:
2040 *pl2meta = l2meta;
2041 return ret;
2042}
2043
88f468e5
VSO
2044static coroutine_fn int
2045qcow2_co_preadv_encrypted(BlockDriverState *bs,
2046 uint64_t file_cluster_offset,
2047 uint64_t offset,
2048 uint64_t bytes,
2049 QEMUIOVector *qiov,
2050 uint64_t qiov_offset)
2051{
2052 int ret;
2053 BDRVQcow2State *s = bs->opaque;
2054 uint8_t *buf;
2055
2056 assert(bs->encrypted && s->crypto);
2057 assert(bytes <= QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size);
2058
2059 /*
2060 * For encrypted images, read everything into a temporary
2061 * contiguous buffer on which the AES functions can work.
2062 * Also, decryption in a separate buffer is better as it
2063 * prevents the guest from learning information about the
2064 * encrypted nature of the virtual disk.
2065 */
2066
2067 buf = qemu_try_blockalign(s->data_file->bs, bytes);
2068 if (buf == NULL) {
2069 return -ENOMEM;
2070 }
2071
2072 BLKDBG_EVENT(bs->file, BLKDBG_READ_AIO);
2073 ret = bdrv_co_pread(s->data_file,
2074 file_cluster_offset + offset_into_cluster(s, offset),
2075 bytes, buf, 0);
2076 if (ret < 0) {
2077 goto fail;
2078 }
2079
88f468e5
VSO
2080 if (qcow2_co_decrypt(bs,
2081 file_cluster_offset + offset_into_cluster(s, offset),
2082 offset, buf, bytes) < 0)
2083 {
2084 ret = -EIO;
2085 goto fail;
2086 }
2087 qemu_iovec_from_buf(qiov, qiov_offset, buf, bytes);
2088
2089fail:
2090 qemu_vfree(buf);
2091
2092 return ret;
2093}
2094
d710cf57
VSO
2095typedef struct Qcow2AioTask {
2096 AioTask task;
2097
2098 BlockDriverState *bs;
2099 QCow2ClusterType cluster_type; /* only for read */
2100 uint64_t file_cluster_offset;
2101 uint64_t offset;
2102 uint64_t bytes;
2103 QEMUIOVector *qiov;
2104 uint64_t qiov_offset;
2105 QCowL2Meta *l2meta; /* only for write */
2106} Qcow2AioTask;
2107
2108static coroutine_fn int qcow2_co_preadv_task_entry(AioTask *task);
2109static coroutine_fn int qcow2_add_task(BlockDriverState *bs,
2110 AioTaskPool *pool,
2111 AioTaskFunc func,
2112 QCow2ClusterType cluster_type,
2113 uint64_t file_cluster_offset,
2114 uint64_t offset,
2115 uint64_t bytes,
2116 QEMUIOVector *qiov,
2117 size_t qiov_offset,
2118 QCowL2Meta *l2meta)
2119{
2120 Qcow2AioTask local_task;
2121 Qcow2AioTask *task = pool ? g_new(Qcow2AioTask, 1) : &local_task;
2122
2123 *task = (Qcow2AioTask) {
2124 .task.func = func,
2125 .bs = bs,
2126 .cluster_type = cluster_type,
2127 .qiov = qiov,
2128 .file_cluster_offset = file_cluster_offset,
2129 .offset = offset,
2130 .bytes = bytes,
2131 .qiov_offset = qiov_offset,
2132 .l2meta = l2meta,
2133 };
2134
2135 trace_qcow2_add_task(qemu_coroutine_self(), bs, pool,
2136 func == qcow2_co_preadv_task_entry ? "read" : "write",
2137 cluster_type, file_cluster_offset, offset, bytes,
2138 qiov, qiov_offset);
2139
2140 if (!pool) {
2141 return func(&task->task);
2142 }
2143
2144 aio_task_pool_start_task(pool, &task->task);
2145
2146 return 0;
2147}
2148
88f468e5
VSO
2149static coroutine_fn int qcow2_co_preadv_task(BlockDriverState *bs,
2150 QCow2ClusterType cluster_type,
2151 uint64_t file_cluster_offset,
2152 uint64_t offset, uint64_t bytes,
2153 QEMUIOVector *qiov,
2154 size_t qiov_offset)
2155{
2156 BDRVQcow2State *s = bs->opaque;
2157 int offset_in_cluster = offset_into_cluster(s, offset);
2158
2159 switch (cluster_type) {
2160 case QCOW2_CLUSTER_ZERO_PLAIN:
2161 case QCOW2_CLUSTER_ZERO_ALLOC:
2162 /* Both zero types are handled in qcow2_co_preadv_part */
2163 g_assert_not_reached();
2164
2165 case QCOW2_CLUSTER_UNALLOCATED:
2166 assert(bs->backing); /* otherwise handled in qcow2_co_preadv_part */
2167
2168 BLKDBG_EVENT(bs->file, BLKDBG_READ_BACKING_AIO);
2169 return bdrv_co_preadv_part(bs->backing, offset, bytes,
2170 qiov, qiov_offset, 0);
2171
2172 case QCOW2_CLUSTER_COMPRESSED:
2173 return qcow2_co_preadv_compressed(bs, file_cluster_offset,
2174 offset, bytes, qiov, qiov_offset);
2175
2176 case QCOW2_CLUSTER_NORMAL:
344ffea9 2177 assert(offset_into_cluster(s, file_cluster_offset) == 0);
88f468e5
VSO
2178 if (bs->encrypted) {
2179 return qcow2_co_preadv_encrypted(bs, file_cluster_offset,
2180 offset, bytes, qiov, qiov_offset);
2181 }
2182
2183 BLKDBG_EVENT(bs->file, BLKDBG_READ_AIO);
2184 return bdrv_co_preadv_part(s->data_file,
2185 file_cluster_offset + offset_in_cluster,
2186 bytes, qiov, qiov_offset, 0);
2187
2188 default:
2189 g_assert_not_reached();
2190 }
2191
2192 g_assert_not_reached();
2193}
2194
d710cf57
VSO
2195static coroutine_fn int qcow2_co_preadv_task_entry(AioTask *task)
2196{
2197 Qcow2AioTask *t = container_of(task, Qcow2AioTask, task);
2198
2199 assert(!t->l2meta);
2200
2201 return qcow2_co_preadv_task(t->bs, t->cluster_type, t->file_cluster_offset,
2202 t->offset, t->bytes, t->qiov, t->qiov_offset);
2203}
2204
df893d25
VSO
2205static coroutine_fn int qcow2_co_preadv_part(BlockDriverState *bs,
2206 uint64_t offset, uint64_t bytes,
2207 QEMUIOVector *qiov,
2208 size_t qiov_offset, int flags)
585f8587 2209{
ff99129a 2210 BDRVQcow2State *s = bs->opaque;
d710cf57 2211 int ret = 0;
ecfe1863 2212 unsigned int cur_bytes; /* number of bytes in current iteration */
c2bdd990 2213 uint64_t cluster_offset = 0;
d710cf57 2214 AioTaskPool *aio = NULL;
585f8587 2215
d710cf57 2216 while (bytes != 0 && aio_task_pool_status(aio) == 0) {
5ebaa27e 2217 /* prepare next request */
ecfe1863 2218 cur_bytes = MIN(bytes, INT_MAX);
b25b387f 2219 if (s->crypto) {
ecfe1863
KW
2220 cur_bytes = MIN(cur_bytes,
2221 QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size);
585f8587 2222 }
5ebaa27e 2223
f24196d3 2224 qemu_co_mutex_lock(&s->lock);
ecfe1863 2225 ret = qcow2_get_cluster_offset(bs, offset, &cur_bytes, &cluster_offset);
f24196d3 2226 qemu_co_mutex_unlock(&s->lock);
8af36488 2227 if (ret < 0) {
d710cf57 2228 goto out;
8af36488 2229 }
bd28f835 2230
88f468e5
VSO
2231 if (ret == QCOW2_CLUSTER_ZERO_PLAIN ||
2232 ret == QCOW2_CLUSTER_ZERO_ALLOC ||
2233 (ret == QCOW2_CLUSTER_UNALLOCATED && !bs->backing))
2234 {
df893d25 2235 qemu_iovec_memset(qiov, qiov_offset, 0, cur_bytes);
88f468e5 2236 } else {
d710cf57
VSO
2237 if (!aio && cur_bytes != bytes) {
2238 aio = aio_task_pool_new(QCOW2_MAX_WORKERS);
2239 }
2240 ret = qcow2_add_task(bs, aio, qcow2_co_preadv_task_entry, ret,
2241 cluster_offset, offset, cur_bytes,
2242 qiov, qiov_offset, NULL);
5ebaa27e 2243 if (ret < 0) {
d710cf57 2244 goto out;
5ebaa27e 2245 }
faf575c1 2246 }
f141eafe 2247
ecfe1863
KW
2248 bytes -= cur_bytes;
2249 offset += cur_bytes;
df893d25 2250 qiov_offset += cur_bytes;
5ebaa27e 2251 }
68d100e9 2252
d710cf57
VSO
2253out:
2254 if (aio) {
2255 aio_task_pool_wait_all(aio);
2256 if (ret == 0) {
2257 ret = aio_task_pool_status(aio);
2258 }
2259 g_free(aio);
2260 }
2261
2262 return ret;
585f8587
FB
2263}
2264
ee22a9d8
AG
2265/* Check if it's possible to merge a write request with the writing of
2266 * the data from the COW regions */
2267static bool merge_cow(uint64_t offset, unsigned bytes,
5396234b
VSO
2268 QEMUIOVector *qiov, size_t qiov_offset,
2269 QCowL2Meta *l2meta)
ee22a9d8
AG
2270{
2271 QCowL2Meta *m;
2272
2273 for (m = l2meta; m != NULL; m = m->next) {
2274 /* If both COW regions are empty then there's nothing to merge */
2275 if (m->cow_start.nb_bytes == 0 && m->cow_end.nb_bytes == 0) {
2276 continue;
2277 }
2278
c8bb23cb
AN
2279 /* If COW regions are handled already, skip this too */
2280 if (m->skip_cow) {
2281 continue;
2282 }
2283
ee22a9d8
AG
2284 /* The data (middle) region must be immediately after the
2285 * start region */
2286 if (l2meta_cow_start(m) + m->cow_start.nb_bytes != offset) {
2287 continue;
2288 }
2289
2290 /* The end region must be immediately after the data (middle)
2291 * region */
2292 if (m->offset + m->cow_end.offset != offset + bytes) {
2293 continue;
2294 }
2295
2296 /* Make sure that adding both COW regions to the QEMUIOVector
2297 * does not exceed IOV_MAX */
5396234b 2298 if (qemu_iovec_subvec_niov(qiov, qiov_offset, bytes) > IOV_MAX - 2) {
ee22a9d8
AG
2299 continue;
2300 }
2301
5396234b
VSO
2302 m->data_qiov = qiov;
2303 m->data_qiov_offset = qiov_offset;
ee22a9d8
AG
2304 return true;
2305 }
2306
2307 return false;
2308}
2309
c8bb23cb
AN
2310static bool is_unallocated(BlockDriverState *bs, int64_t offset, int64_t bytes)
2311{
2312 int64_t nr;
2313 return !bytes ||
170d3bd3
AS
2314 (!bdrv_is_allocated_above(bs, NULL, false, offset, bytes, &nr) &&
2315 nr == bytes);
c8bb23cb
AN
2316}
2317
2318static bool is_zero_cow(BlockDriverState *bs, QCowL2Meta *m)
2319{
2320 /*
2321 * This check is designed for optimization shortcut so it must be
2322 * efficient.
2323 * Instead of is_zero(), use is_unallocated() as it is faster (but not
2324 * as accurate and can result in false negatives).
2325 */
2326 return is_unallocated(bs, m->offset + m->cow_start.offset,
2327 m->cow_start.nb_bytes) &&
2328 is_unallocated(bs, m->offset + m->cow_end.offset,
2329 m->cow_end.nb_bytes);
2330}
2331
2332static int handle_alloc_space(BlockDriverState *bs, QCowL2Meta *l2meta)
2333{
2334 BDRVQcow2State *s = bs->opaque;
2335 QCowL2Meta *m;
2336
2337 if (!(s->data_file->bs->supported_zero_flags & BDRV_REQ_NO_FALLBACK)) {
2338 return 0;
2339 }
2340
2341 if (bs->encrypted) {
2342 return 0;
2343 }
2344
2345 for (m = l2meta; m != NULL; m = m->next) {
2346 int ret;
2347
2348 if (!m->cow_start.nb_bytes && !m->cow_end.nb_bytes) {
2349 continue;
2350 }
2351
2352 if (!is_zero_cow(bs, m)) {
2353 continue;
2354 }
2355
2356 /*
2357 * instead of writing zero COW buffers,
2358 * efficiently zero out the whole clusters
2359 */
2360
2361 ret = qcow2_pre_write_overlap_check(bs, 0, m->alloc_offset,
2362 m->nb_clusters * s->cluster_size,
2363 true);
2364 if (ret < 0) {
2365 return ret;
2366 }
2367
2368 BLKDBG_EVENT(bs->file, BLKDBG_CLUSTER_ALLOC_SPACE);
2369 ret = bdrv_co_pwrite_zeroes(s->data_file, m->alloc_offset,
2370 m->nb_clusters * s->cluster_size,
2371 BDRV_REQ_NO_FALLBACK);
2372 if (ret < 0) {
2373 if (ret != -ENOTSUP && ret != -EAGAIN) {
2374 return ret;
2375 }
2376 continue;
2377 }
2378
2379 trace_qcow2_skip_cow(qemu_coroutine_self(), m->offset, m->nb_clusters);
2380 m->skip_cow = true;
2381 }
2382 return 0;
2383}
2384
6aa7a263
VSO
2385/*
2386 * qcow2_co_pwritev_task
2387 * Called with s->lock unlocked
2388 * l2meta - if not NULL, qcow2_co_pwritev_task() will consume it. Caller must
2389 * not use it somehow after qcow2_co_pwritev_task() call
2390 */
2391static coroutine_fn int qcow2_co_pwritev_task(BlockDriverState *bs,
2392 uint64_t file_cluster_offset,
2393 uint64_t offset, uint64_t bytes,
2394 QEMUIOVector *qiov,
2395 uint64_t qiov_offset,
2396 QCowL2Meta *l2meta)
2397{
2398 int ret;
2399 BDRVQcow2State *s = bs->opaque;
2400 void *crypt_buf = NULL;
2401 int offset_in_cluster = offset_into_cluster(s, offset);
2402 QEMUIOVector encrypted_qiov;
2403
2404 if (bs->encrypted) {
2405 assert(s->crypto);
2406 assert(bytes <= QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size);
2407 crypt_buf = qemu_try_blockalign(bs->file->bs, bytes);
2408 if (crypt_buf == NULL) {
2409 ret = -ENOMEM;
2410 goto out_unlocked;
2411 }
2412 qemu_iovec_to_buf(qiov, qiov_offset, crypt_buf, bytes);
2413
2414 if (qcow2_co_encrypt(bs, file_cluster_offset + offset_in_cluster,
2415 offset, crypt_buf, bytes) < 0)
2416 {
2417 ret = -EIO;
2418 goto out_unlocked;
2419 }
2420
2421 qemu_iovec_init_buf(&encrypted_qiov, crypt_buf, bytes);
2422 qiov = &encrypted_qiov;
2423 qiov_offset = 0;
2424 }
2425
2426 /* Try to efficiently initialize the physical space with zeroes */
2427 ret = handle_alloc_space(bs, l2meta);
2428 if (ret < 0) {
2429 goto out_unlocked;
2430 }
2431
2432 /*
2433 * If we need to do COW, check if it's possible to merge the
2434 * writing of the guest data together with that of the COW regions.
2435 * If it's not possible (or not necessary) then write the
2436 * guest data now.
2437 */
2438 if (!merge_cow(offset, bytes, qiov, qiov_offset, l2meta)) {
2439 BLKDBG_EVENT(bs->file, BLKDBG_WRITE_AIO);
2440 trace_qcow2_writev_data(qemu_coroutine_self(),
2441 file_cluster_offset + offset_in_cluster);
2442 ret = bdrv_co_pwritev_part(s->data_file,
2443 file_cluster_offset + offset_in_cluster,
2444 bytes, qiov, qiov_offset, 0);
2445 if (ret < 0) {
2446 goto out_unlocked;
2447 }
2448 }
2449
2450 qemu_co_mutex_lock(&s->lock);
2451
2452 ret = qcow2_handle_l2meta(bs, &l2meta, true);
2453 goto out_locked;
2454
2455out_unlocked:
2456 qemu_co_mutex_lock(&s->lock);
2457
2458out_locked:
2459 qcow2_handle_l2meta(bs, &l2meta, false);
2460 qemu_co_mutex_unlock(&s->lock);
2461
2462 qemu_vfree(crypt_buf);
2463
2464 return ret;
2465}
2466
d710cf57
VSO
2467static coroutine_fn int qcow2_co_pwritev_task_entry(AioTask *task)
2468{
2469 Qcow2AioTask *t = container_of(task, Qcow2AioTask, task);
2470
2471 assert(!t->cluster_type);
2472
2473 return qcow2_co_pwritev_task(t->bs, t->file_cluster_offset,
2474 t->offset, t->bytes, t->qiov, t->qiov_offset,
2475 t->l2meta);
2476}
2477
5396234b
VSO
2478static coroutine_fn int qcow2_co_pwritev_part(
2479 BlockDriverState *bs, uint64_t offset, uint64_t bytes,
2480 QEMUIOVector *qiov, size_t qiov_offset, int flags)
585f8587 2481{
ff99129a 2482 BDRVQcow2State *s = bs->opaque;
d46a0bb2 2483 int offset_in_cluster;
68d100e9 2484 int ret;
d46a0bb2 2485 unsigned int cur_bytes; /* number of sectors in current iteration */
c2bdd990 2486 uint64_t cluster_offset;
8d2497c3 2487 QCowL2Meta *l2meta = NULL;
d710cf57 2488 AioTaskPool *aio = NULL;
c2271403 2489
d46a0bb2 2490 trace_qcow2_writev_start_req(qemu_coroutine_self(), offset, bytes);
3cce16f4 2491
d710cf57 2492 while (bytes != 0 && aio_task_pool_status(aio) == 0) {
3fc48d09 2493
f50f88b9 2494 l2meta = NULL;
cf5c1a23 2495
3cce16f4 2496 trace_qcow2_writev_start_part(qemu_coroutine_self());
d46a0bb2
KW
2497 offset_in_cluster = offset_into_cluster(s, offset);
2498 cur_bytes = MIN(bytes, INT_MAX);
2499 if (bs->encrypted) {
2500 cur_bytes = MIN(cur_bytes,
2501 QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size
2502 - offset_in_cluster);
5ebaa27e 2503 }
095a9c58 2504
6aa7a263
VSO
2505 qemu_co_mutex_lock(&s->lock);
2506
d46a0bb2
KW
2507 ret = qcow2_alloc_cluster_offset(bs, offset, &cur_bytes,
2508 &cluster_offset, &l2meta);
5ebaa27e 2509 if (ret < 0) {
5447c3a0 2510 goto out_locked;
5ebaa27e 2511 }
148da7ea 2512
344ffea9 2513 assert(offset_into_cluster(s, cluster_offset) == 0);
148da7ea 2514
5447c3a0
VSO
2515 ret = qcow2_pre_write_overlap_check(bs, 0,
2516 cluster_offset + offset_in_cluster,
2517 cur_bytes, true);
2518 if (ret < 0) {
2519 goto out_locked;
2520 }
2521
2522 qemu_co_mutex_unlock(&s->lock);
2523
d710cf57
VSO
2524 if (!aio && cur_bytes != bytes) {
2525 aio = aio_task_pool_new(QCOW2_MAX_WORKERS);
2526 }
2527 ret = qcow2_add_task(bs, aio, qcow2_co_pwritev_task_entry, 0,
2528 cluster_offset, offset, cur_bytes,
2529 qiov, qiov_offset, l2meta);
6aa7a263 2530 l2meta = NULL; /* l2meta is consumed by qcow2_co_pwritev_task() */
c8bb23cb 2531 if (ret < 0) {
6aa7a263 2532 goto fail_nometa;
f50f88b9 2533 }
0fa9131a 2534
d46a0bb2
KW
2535 bytes -= cur_bytes;
2536 offset += cur_bytes;
6aa7a263 2537 qiov_offset += cur_bytes;
d46a0bb2 2538 trace_qcow2_writev_done_part(qemu_coroutine_self(), cur_bytes);
5ebaa27e 2539 }
3fc48d09 2540 ret = 0;
faf575c1 2541
5447c3a0
VSO
2542 qemu_co_mutex_lock(&s->lock);
2543
2544out_locked:
fd9fcd37 2545 qcow2_handle_l2meta(bs, &l2meta, false);
0fa9131a 2546
a8c57408
PB
2547 qemu_co_mutex_unlock(&s->lock);
2548
6aa7a263 2549fail_nometa:
d710cf57
VSO
2550 if (aio) {
2551 aio_task_pool_wait_all(aio);
2552 if (ret == 0) {
2553 ret = aio_task_pool_status(aio);
2554 }
2555 g_free(aio);
2556 }
2557
3cce16f4 2558 trace_qcow2_writev_done_req(qemu_coroutine_self(), ret);
42496d62 2559
68d100e9 2560 return ret;
585f8587
FB
2561}
2562
ec6d8912
KW
2563static int qcow2_inactivate(BlockDriverState *bs)
2564{
2565 BDRVQcow2State *s = bs->opaque;
2566 int ret, result = 0;
5f72826e 2567 Error *local_err = NULL;
ec6d8912 2568
644ddbb7 2569 qcow2_store_persistent_dirty_bitmaps(bs, true, &local_err);
83a8c775
PB
2570 if (local_err != NULL) {
2571 result = -EINVAL;
132adb68
VSO
2572 error_reportf_err(local_err, "Lost persistent bitmaps during "
2573 "inactivation of node '%s': ",
2574 bdrv_get_device_or_node_name(bs));
83a8c775
PB
2575 }
2576
ec6d8912
KW
2577 ret = qcow2_cache_flush(bs, s->l2_table_cache);
2578 if (ret) {
2579 result = ret;
2580 error_report("Failed to flush the L2 table cache: %s",
2581 strerror(-ret));
2582 }
2583
2584 ret = qcow2_cache_flush(bs, s->refcount_block_cache);
2585 if (ret) {
2586 result = ret;
2587 error_report("Failed to flush the refcount block cache: %s",
2588 strerror(-ret));
2589 }
2590
2591 if (result == 0) {
2592 qcow2_mark_clean(bs);
2593 }
2594
2595 return result;
2596}
2597
7c80ab3f 2598static void qcow2_close(BlockDriverState *bs)
585f8587 2599{
ff99129a 2600 BDRVQcow2State *s = bs->opaque;
de82815d 2601 qemu_vfree(s->l1_table);
cf93980e
HR
2602 /* else pre-write overlap checks in cache_destroy may crash */
2603 s->l1_table = NULL;
29c1a730 2604
140fd5a6 2605 if (!(s->flags & BDRV_O_INACTIVE)) {
ec6d8912 2606 qcow2_inactivate(bs);
27eb6c09 2607 }
c61d0004 2608
279621c0 2609 cache_clean_timer_del(bs);
e64d4072
AG
2610 qcow2_cache_destroy(s->l2_table_cache);
2611 qcow2_cache_destroy(s->refcount_block_cache);
29c1a730 2612
b25b387f
DB
2613 qcrypto_block_free(s->crypto);
2614 s->crypto = NULL;
4aebf0f0 2615 qapi_free_QCryptoBlockOpenOptions(s->crypto_opts);
f6fa64f6 2616
6744cbab 2617 g_free(s->unknown_header_fields);
75bab85c 2618 cleanup_unknown_header_ext(bs);
6744cbab 2619
9b890bdc 2620 g_free(s->image_data_file);
e4603fe1
KW
2621 g_free(s->image_backing_file);
2622 g_free(s->image_backing_format);
2623
0e8c08be
KW
2624 if (has_data_file(bs)) {
2625 bdrv_unref_child(bs, s->data_file);
808cf3cb 2626 s->data_file = NULL;
0e8c08be
KW
2627 }
2628
ed6ccf0f 2629 qcow2_refcount_close(bs);
28c1202b 2630 qcow2_free_snapshots(bs);
585f8587
FB
2631}
2632
2b148f39
PB
2633static void coroutine_fn qcow2_co_invalidate_cache(BlockDriverState *bs,
2634 Error **errp)
06d9260f 2635{
ff99129a 2636 BDRVQcow2State *s = bs->opaque;
06d9260f 2637 int flags = s->flags;
b25b387f 2638 QCryptoBlock *crypto = NULL;
acdfb480 2639 QDict *options;
5a8a30db
KW
2640 Error *local_err = NULL;
2641 int ret;
06d9260f
AL
2642
2643 /*
2644 * Backing files are read-only which makes all of their metadata immutable,
2645 * that means we don't have to worry about reopening them here.
2646 */
2647
b25b387f
DB
2648 crypto = s->crypto;
2649 s->crypto = NULL;
06d9260f
AL
2650
2651 qcow2_close(bs);
2652
ff99129a 2653 memset(s, 0, sizeof(BDRVQcow2State));
d475e5ac 2654 options = qdict_clone_shallow(bs->options);
5a8a30db 2655
140fd5a6 2656 flags &= ~BDRV_O_INACTIVE;
2b148f39 2657 qemu_co_mutex_lock(&s->lock);
4e4bf5c4 2658 ret = qcow2_do_open(bs, options, flags, &local_err);
2b148f39 2659 qemu_co_mutex_unlock(&s->lock);
cb3e7f08 2660 qobject_unref(options);
5a8a30db 2661 if (local_err) {
4b576648
MA
2662 error_propagate_prepend(errp, local_err,
2663 "Could not reopen qcow2 layer: ");
191fb11b 2664 bs->drv = NULL;
5a8a30db
KW
2665 return;
2666 } else if (ret < 0) {
2667 error_setg_errno(errp, -ret, "Could not reopen qcow2 layer");
191fb11b 2668 bs->drv = NULL;
5a8a30db
KW
2669 return;
2670 }
acdfb480 2671
b25b387f 2672 s->crypto = crypto;
06d9260f
AL
2673}
2674
e24e49e6
KW
2675static size_t header_ext_add(char *buf, uint32_t magic, const void *s,
2676 size_t len, size_t buflen)
2677{
2678 QCowExtension *ext_backing_fmt = (QCowExtension*) buf;
2679 size_t ext_len = sizeof(QCowExtension) + ((len + 7) & ~7);
2680
2681 if (buflen < ext_len) {
2682 return -ENOSPC;
2683 }
2684
2685 *ext_backing_fmt = (QCowExtension) {
2686 .magic = cpu_to_be32(magic),
2687 .len = cpu_to_be32(len),
2688 };
0647d47c
SH
2689
2690 if (len) {
2691 memcpy(buf + sizeof(QCowExtension), s, len);
2692 }
e24e49e6
KW
2693
2694 return ext_len;
2695}
2696
756e6736 2697/*
e24e49e6
KW
2698 * Updates the qcow2 header, including the variable length parts of it, i.e.
2699 * the backing file name and all extensions. qcow2 was not designed to allow
2700 * such changes, so if we run out of space (we can only use the first cluster)
2701 * this function may fail.
756e6736
KW
2702 *
2703 * Returns 0 on success, -errno in error cases.
2704 */
e24e49e6 2705int qcow2_update_header(BlockDriverState *bs)
756e6736 2706{
ff99129a 2707 BDRVQcow2State *s = bs->opaque;
e24e49e6
KW
2708 QCowHeader *header;
2709 char *buf;
2710 size_t buflen = s->cluster_size;
756e6736 2711 int ret;
e24e49e6
KW
2712 uint64_t total_size;
2713 uint32_t refcount_table_clusters;
6744cbab 2714 size_t header_length;
75bab85c 2715 Qcow2UnknownHeaderExtension *uext;
756e6736 2716
e24e49e6 2717 buf = qemu_blockalign(bs, buflen);
756e6736 2718
e24e49e6
KW
2719 /* Header structure */
2720 header = (QCowHeader*) buf;
756e6736 2721
e24e49e6
KW
2722 if (buflen < sizeof(*header)) {
2723 ret = -ENOSPC;
2724 goto fail;
756e6736
KW
2725 }
2726
6744cbab 2727 header_length = sizeof(*header) + s->unknown_header_fields_size;
e24e49e6
KW
2728 total_size = bs->total_sectors * BDRV_SECTOR_SIZE;
2729 refcount_table_clusters = s->refcount_table_size >> (s->cluster_bits - 3);
2730
2731 *header = (QCowHeader) {
6744cbab 2732 /* Version 2 fields */
e24e49e6 2733 .magic = cpu_to_be32(QCOW_MAGIC),
6744cbab 2734 .version = cpu_to_be32(s->qcow_version),
e24e49e6
KW
2735 .backing_file_offset = 0,
2736 .backing_file_size = 0,
2737 .cluster_bits = cpu_to_be32(s->cluster_bits),
2738 .size = cpu_to_be64(total_size),
2739 .crypt_method = cpu_to_be32(s->crypt_method_header),
2740 .l1_size = cpu_to_be32(s->l1_size),
2741 .l1_table_offset = cpu_to_be64(s->l1_table_offset),
2742 .refcount_table_offset = cpu_to_be64(s->refcount_table_offset),
2743 .refcount_table_clusters = cpu_to_be32(refcount_table_clusters),
2744 .nb_snapshots = cpu_to_be32(s->nb_snapshots),
2745 .snapshots_offset = cpu_to_be64(s->snapshots_offset),
6744cbab
KW
2746
2747 /* Version 3 fields */
2748 .incompatible_features = cpu_to_be64(s->incompatible_features),
2749 .compatible_features = cpu_to_be64(s->compatible_features),
2750 .autoclear_features = cpu_to_be64(s->autoclear_features),
b6481f37 2751 .refcount_order = cpu_to_be32(s->refcount_order),
6744cbab 2752 .header_length = cpu_to_be32(header_length),
e24e49e6 2753 };
756e6736 2754
6744cbab
KW
2755 /* For older versions, write a shorter header */
2756 switch (s->qcow_version) {
2757 case 2:
2758 ret = offsetof(QCowHeader, incompatible_features);
2759 break;
2760 case 3:
2761 ret = sizeof(*header);
2762 break;
2763 default:
b6c14762
JM
2764 ret = -EINVAL;
2765 goto fail;
6744cbab
KW
2766 }
2767
2768 buf += ret;
2769 buflen -= ret;
2770 memset(buf, 0, buflen);
2771
2772 /* Preserve any unknown field in the header */
2773 if (s->unknown_header_fields_size) {
2774 if (buflen < s->unknown_header_fields_size) {
2775 ret = -ENOSPC;
2776 goto fail;
2777 }
2778
2779 memcpy(buf, s->unknown_header_fields, s->unknown_header_fields_size);
2780 buf += s->unknown_header_fields_size;
2781 buflen -= s->unknown_header_fields_size;
2782 }
756e6736 2783
e24e49e6 2784 /* Backing file format header extension */
e4603fe1 2785 if (s->image_backing_format) {
e24e49e6 2786 ret = header_ext_add(buf, QCOW2_EXT_MAGIC_BACKING_FORMAT,
e4603fe1
KW
2787 s->image_backing_format,
2788 strlen(s->image_backing_format),
e24e49e6
KW
2789 buflen);
2790 if (ret < 0) {
2791 goto fail;
756e6736
KW
2792 }
2793
e24e49e6
KW
2794 buf += ret;
2795 buflen -= ret;
756e6736
KW
2796 }
2797
9b890bdc
KW
2798 /* External data file header extension */
2799 if (has_data_file(bs) && s->image_data_file) {
2800 ret = header_ext_add(buf, QCOW2_EXT_MAGIC_DATA_FILE,
2801 s->image_data_file, strlen(s->image_data_file),
2802 buflen);
2803 if (ret < 0) {
2804 goto fail;
2805 }
2806
2807 buf += ret;
2808 buflen -= ret;
2809 }
2810
4652b8f3
DB
2811 /* Full disk encryption header pointer extension */
2812 if (s->crypto_header.offset != 0) {
3b698f52
PM
2813 s->crypto_header.offset = cpu_to_be64(s->crypto_header.offset);
2814 s->crypto_header.length = cpu_to_be64(s->crypto_header.length);
4652b8f3
DB
2815 ret = header_ext_add(buf, QCOW2_EXT_MAGIC_CRYPTO_HEADER,
2816 &s->crypto_header, sizeof(s->crypto_header),
2817 buflen);
3b698f52
PM
2818 s->crypto_header.offset = be64_to_cpu(s->crypto_header.offset);
2819 s->crypto_header.length = be64_to_cpu(s->crypto_header.length);
4652b8f3
DB
2820 if (ret < 0) {
2821 goto fail;
2822 }
2823 buf += ret;
2824 buflen -= ret;
2825 }
2826
e7be13ad
EB
2827 /*
2828 * Feature table. A mere 8 feature names occupies 392 bytes, and
2829 * when coupled with the v3 minimum header of 104 bytes plus the
2830 * 8-byte end-of-extension marker, that would leave only 8 bytes
2831 * for a backing file name in an image with 512-byte clusters.
2832 * Thus, we choose to omit this header for cluster sizes 4k and
2833 * smaller.
2834 */
2835 if (s->qcow_version >= 3 && s->cluster_size > 4096) {
bb40ebce 2836 static const Qcow2Feature features[] = {
1a4828c7
KW
2837 {
2838 .type = QCOW2_FEAT_TYPE_INCOMPATIBLE,
2839 .bit = QCOW2_INCOMPAT_DIRTY_BITNR,
2840 .name = "dirty bit",
2841 },
2842 {
2843 .type = QCOW2_FEAT_TYPE_INCOMPATIBLE,
2844 .bit = QCOW2_INCOMPAT_CORRUPT_BITNR,
2845 .name = "corrupt bit",
2846 },
93c24936
KW
2847 {
2848 .type = QCOW2_FEAT_TYPE_INCOMPATIBLE,
2849 .bit = QCOW2_INCOMPAT_DATA_FILE_BITNR,
2850 .name = "external data file",
2851 },
1a4828c7
KW
2852 {
2853 .type = QCOW2_FEAT_TYPE_COMPATIBLE,
2854 .bit = QCOW2_COMPAT_LAZY_REFCOUNTS_BITNR,
2855 .name = "lazy refcounts",
2856 },
bb40ebce
EB
2857 {
2858 .type = QCOW2_FEAT_TYPE_AUTOCLEAR,
2859 .bit = QCOW2_AUTOCLEAR_BITMAPS_BITNR,
2860 .name = "bitmaps",
2861 },
2862 {
2863 .type = QCOW2_FEAT_TYPE_AUTOCLEAR,
2864 .bit = QCOW2_AUTOCLEAR_DATA_FILE_RAW_BITNR,
2865 .name = "raw external data",
2866 },
1a4828c7
KW
2867 };
2868
2869 ret = header_ext_add(buf, QCOW2_EXT_MAGIC_FEATURE_TABLE,
2870 features, sizeof(features), buflen);
2871 if (ret < 0) {
2872 goto fail;
2873 }
2874 buf += ret;
2875 buflen -= ret;
cfcc4c62 2876 }
cfcc4c62 2877
88ddffae
VSO
2878 /* Bitmap extension */
2879 if (s->nb_bitmaps > 0) {
2880 Qcow2BitmapHeaderExt bitmaps_header = {
2881 .nb_bitmaps = cpu_to_be32(s->nb_bitmaps),
2882 .bitmap_directory_size =
2883 cpu_to_be64(s->bitmap_directory_size),
2884 .bitmap_directory_offset =
2885 cpu_to_be64(s->bitmap_directory_offset)
2886 };
2887 ret = header_ext_add(buf, QCOW2_EXT_MAGIC_BITMAPS,
2888 &bitmaps_header, sizeof(bitmaps_header),
2889 buflen);
2890 if (ret < 0) {
2891 goto fail;
2892 }
2893 buf += ret;
2894 buflen -= ret;
2895 }
2896
75bab85c
KW
2897 /* Keep unknown header extensions */
2898 QLIST_FOREACH(uext, &s->unknown_header_ext, next) {
2899 ret = header_ext_add(buf, uext->magic, uext->data, uext->len, buflen);
2900 if (ret < 0) {
2901 goto fail;
2902 }
2903
2904 buf += ret;
2905 buflen -= ret;
2906 }
2907
e24e49e6
KW
2908 /* End of header extensions */
2909 ret = header_ext_add(buf, QCOW2_EXT_MAGIC_END, NULL, 0, buflen);
756e6736
KW
2910 if (ret < 0) {
2911 goto fail;
2912 }
2913
e24e49e6
KW
2914 buf += ret;
2915 buflen -= ret;
756e6736 2916
e24e49e6 2917 /* Backing file name */
e4603fe1
KW
2918 if (s->image_backing_file) {
2919 size_t backing_file_len = strlen(s->image_backing_file);
e24e49e6
KW
2920
2921 if (buflen < backing_file_len) {
2922 ret = -ENOSPC;
2923 goto fail;
2924 }
2925
00ea1881 2926 /* Using strncpy is ok here, since buf is not NUL-terminated. */
e4603fe1 2927 strncpy(buf, s->image_backing_file, buflen);
e24e49e6
KW
2928
2929 header->backing_file_offset = cpu_to_be64(buf - ((char*) header));
2930 header->backing_file_size = cpu_to_be32(backing_file_len);
756e6736
KW
2931 }
2932
e24e49e6 2933 /* Write the new header */
d9ca2ea2 2934 ret = bdrv_pwrite(bs->file, 0, header, s->cluster_size);
756e6736
KW
2935 if (ret < 0) {
2936 goto fail;
2937 }
2938
2939 ret = 0;
2940fail:
e24e49e6 2941 qemu_vfree(header);
756e6736
KW
2942 return ret;
2943}
2944
2945static int qcow2_change_backing_file(BlockDriverState *bs,
2946 const char *backing_file, const char *backing_fmt)
2947{
ff99129a 2948 BDRVQcow2State *s = bs->opaque;
e4603fe1 2949
6c3944dc
KW
2950 /* Adding a backing file means that the external data file alone won't be
2951 * enough to make sense of the content */
2952 if (backing_file && data_file_is_raw(bs)) {
2953 return -EINVAL;
2954 }
2955
4e876bcf
HR
2956 if (backing_file && strlen(backing_file) > 1023) {
2957 return -EINVAL;
2958 }
2959
998c2019
HR
2960 pstrcpy(bs->auto_backing_file, sizeof(bs->auto_backing_file),
2961 backing_file ?: "");
e24e49e6
KW
2962 pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: "");
2963 pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: "");
2964
e4603fe1
KW
2965 g_free(s->image_backing_file);
2966 g_free(s->image_backing_format);
2967
2968 s->image_backing_file = backing_file ? g_strdup(bs->backing_file) : NULL;
2969 s->image_backing_format = backing_fmt ? g_strdup(bs->backing_format) : NULL;
2970
e24e49e6 2971 return qcow2_update_header(bs);
756e6736
KW
2972}
2973
4652b8f3
DB
2974static int qcow2_crypt_method_from_format(const char *encryptfmt)
2975{
2976 if (g_str_equal(encryptfmt, "luks")) {
2977 return QCOW_CRYPT_LUKS;
2978 } else if (g_str_equal(encryptfmt, "aes")) {
2979 return QCOW_CRYPT_AES;
2980 } else {
2981 return -EINVAL;
2982 }
2983}
b25b387f 2984
60900b7b
KW
2985static int qcow2_set_up_encryption(BlockDriverState *bs,
2986 QCryptoBlockCreateOptions *cryptoopts,
2987 Error **errp)
2988{
2989 BDRVQcow2State *s = bs->opaque;
2990 QCryptoBlock *crypto = NULL;
2991 int fmt, ret;
2992
2993 switch (cryptoopts->format) {
2994 case Q_CRYPTO_BLOCK_FORMAT_LUKS:
2995 fmt = QCOW_CRYPT_LUKS;
2996 break;
2997 case Q_CRYPTO_BLOCK_FORMAT_QCOW:
2998 fmt = QCOW_CRYPT_AES;
2999 break;
3000 default:
3001 error_setg(errp, "Crypto format not supported in qcow2");
3002 return -EINVAL;
b25b387f 3003 }
60900b7b 3004
4652b8f3 3005 s->crypt_method_header = fmt;
b25b387f 3006
1cd9a787 3007 crypto = qcrypto_block_create(cryptoopts, "encrypt.",
4652b8f3
DB
3008 qcow2_crypto_hdr_init_func,
3009 qcow2_crypto_hdr_write_func,
b25b387f
DB
3010 bs, errp);
3011 if (!crypto) {
60900b7b 3012 return -EINVAL;
b25b387f
DB
3013 }
3014
3015 ret = qcow2_update_header(bs);
3016 if (ret < 0) {
3017 error_setg_errno(errp, -ret, "Could not write encryption header");
3018 goto out;
3019 }
3020
60900b7b 3021 ret = 0;
b25b387f 3022 out:
b25b387f 3023 qcrypto_block_free(crypto);
b25b387f
DB
3024 return ret;
3025}
3026
7bc45dc1
HR
3027/**
3028 * Preallocates metadata structures for data clusters between @offset (in the
3029 * guest disk) and @new_length (which is thus generally the new guest disk
3030 * size).
3031 *
3032 * Returns: 0 on success, -errno on failure.
3033 */
47e86b86 3034static int coroutine_fn preallocate_co(BlockDriverState *bs, uint64_t offset,
718c0fce
KW
3035 uint64_t new_length, PreallocMode mode,
3036 Error **errp)
a35e1c17 3037{
93e32b3e 3038 BDRVQcow2State *s = bs->opaque;
d46a0bb2 3039 uint64_t bytes;
060bee89 3040 uint64_t host_offset = 0;
718c0fce 3041 int64_t file_length;
d46a0bb2 3042 unsigned int cur_bytes;
148da7ea 3043 int ret;
f50f88b9 3044 QCowL2Meta *meta;
a35e1c17 3045
7bc45dc1
HR
3046 assert(offset <= new_length);
3047 bytes = new_length - offset;
a35e1c17 3048
d46a0bb2 3049 while (bytes) {
f29fbf7c 3050 cur_bytes = MIN(bytes, QEMU_ALIGN_DOWN(INT_MAX, s->cluster_size));
d46a0bb2 3051 ret = qcow2_alloc_cluster_offset(bs, offset, &cur_bytes,
060bee89 3052 &host_offset, &meta);
148da7ea 3053 if (ret < 0) {
360bd074 3054 error_setg_errno(errp, -ret, "Allocating clusters failed");
47e86b86 3055 return ret;
a35e1c17
KW
3056 }
3057
c792707f
SH
3058 while (meta) {
3059 QCowL2Meta *next = meta->next;
3060
7c2bbf4a
HT
3061 ret = qcow2_alloc_cluster_link_l2(bs, meta);
3062 if (ret < 0) {
360bd074 3063 error_setg_errno(errp, -ret, "Mapping clusters failed");
7c2bbf4a
HT
3064 qcow2_free_any_clusters(bs, meta->alloc_offset,
3065 meta->nb_clusters, QCOW2_DISCARD_NEVER);
47e86b86 3066 return ret;
7c2bbf4a
HT
3067 }
3068
3069 /* There are no dependent requests, but we need to remove our
3070 * request from the list of in-flight requests */
4e95314e 3071 QLIST_REMOVE(meta, next_in_flight);
c792707f
SH
3072
3073 g_free(meta);
3074 meta = next;
f50f88b9 3075 }
f214978a 3076
a35e1c17
KW
3077 /* TODO Preallocate data if requested */
3078
d46a0bb2
KW
3079 bytes -= cur_bytes;
3080 offset += cur_bytes;
a35e1c17
KW
3081 }
3082
3083 /*
3084 * It is expected that the image file is large enough to actually contain
3085 * all of the allocated clusters (otherwise we get failing reads after
3086 * EOF). Extend the image to the last allocated sector.
3087 */
718c0fce
KW
3088 file_length = bdrv_getlength(s->data_file->bs);
3089 if (file_length < 0) {
3090 error_setg_errno(errp, -file_length, "Could not get file size");
3091 return file_length;
3092 }
3093
3094 if (host_offset + cur_bytes > file_length) {
3095 if (mode == PREALLOC_MODE_METADATA) {
3096 mode = PREALLOC_MODE_OFF;
3097 }
c80d8b06 3098 ret = bdrv_co_truncate(s->data_file, host_offset + cur_bytes, false,
7b8e4857 3099 mode, 0, errp);
19dbcbf7 3100 if (ret < 0) {
47e86b86 3101 return ret;
19dbcbf7 3102 }
a35e1c17
KW
3103 }
3104
47e86b86 3105 return 0;
a35e1c17
KW
3106}
3107
7c5bcc42
SH
3108/* qcow2_refcount_metadata_size:
3109 * @clusters: number of clusters to refcount (including data and L1/L2 tables)
3110 * @cluster_size: size of a cluster, in bytes
3111 * @refcount_order: refcount bits power-of-2 exponent
12cc30a8
HR
3112 * @generous_increase: allow for the refcount table to be 1.5x as large as it
3113 * needs to be
7c5bcc42
SH
3114 *
3115 * Returns: Number of bytes required for refcount blocks and table metadata.
3116 */
12cc30a8
HR
3117int64_t qcow2_refcount_metadata_size(int64_t clusters, size_t cluster_size,
3118 int refcount_order, bool generous_increase,
3119 uint64_t *refblock_count)
7c5bcc42
SH
3120{
3121 /*
3122 * Every host cluster is reference-counted, including metadata (even
3123 * refcount metadata is recursively included).
3124 *
3125 * An accurate formula for the size of refcount metadata size is difficult
3126 * to derive. An easier method of calculation is finding the fixed point
3127 * where no further refcount blocks or table clusters are required to
3128 * reference count every cluster.
3129 */
3130 int64_t blocks_per_table_cluster = cluster_size / sizeof(uint64_t);
3131 int64_t refcounts_per_block = cluster_size * 8 / (1 << refcount_order);
3132 int64_t table = 0; /* number of refcount table clusters */
3133 int64_t blocks = 0; /* number of refcount block clusters */
3134 int64_t last;
3135 int64_t n = 0;
3136
3137 do {
3138 last = n;
3139 blocks = DIV_ROUND_UP(clusters + table + blocks, refcounts_per_block);
3140 table = DIV_ROUND_UP(blocks, blocks_per_table_cluster);
3141 n = clusters + blocks + table;
12cc30a8
HR
3142
3143 if (n == last && generous_increase) {
3144 clusters += DIV_ROUND_UP(table, 2);
3145 n = 0; /* force another loop */
3146 generous_increase = false;
3147 }
7c5bcc42
SH
3148 } while (n != last);
3149
12cc30a8
HR
3150 if (refblock_count) {
3151 *refblock_count = blocks;
3152 }
3153
7c5bcc42
SH
3154 return (blocks + table) * cluster_size;
3155}
3156
95c67e3b
SH
3157/**
3158 * qcow2_calc_prealloc_size:
3159 * @total_size: virtual disk size in bytes
3160 * @cluster_size: cluster size in bytes
3161 * @refcount_order: refcount bits power-of-2 exponent
3162 *
3163 * Returns: Total number of bytes required for the fully allocated image
3164 * (including metadata).
3165 */
3166static int64_t qcow2_calc_prealloc_size(int64_t total_size,
3167 size_t cluster_size,
3168 int refcount_order)
3169{
95c67e3b 3170 int64_t meta_size = 0;
7c5bcc42 3171 uint64_t nl1e, nl2e;
9e029689 3172 int64_t aligned_total_size = ROUND_UP(total_size, cluster_size);
95c67e3b
SH
3173
3174 /* header: 1 cluster */
3175 meta_size += cluster_size;
3176
3177 /* total size of L2 tables */
3178 nl2e = aligned_total_size / cluster_size;
9e029689 3179 nl2e = ROUND_UP(nl2e, cluster_size / sizeof(uint64_t));
95c67e3b
SH
3180 meta_size += nl2e * sizeof(uint64_t);
3181
3182 /* total size of L1 tables */
3183 nl1e = nl2e * sizeof(uint64_t) / cluster_size;
9e029689 3184 nl1e = ROUND_UP(nl1e, cluster_size / sizeof(uint64_t));
95c67e3b
SH
3185 meta_size += nl1e * sizeof(uint64_t);
3186
7c5bcc42
SH
3187 /* total size of refcount table and blocks */
3188 meta_size += qcow2_refcount_metadata_size(
3189 (meta_size + aligned_total_size) / cluster_size,
12cc30a8 3190 cluster_size, refcount_order, false, NULL);
95c67e3b
SH
3191
3192 return meta_size + aligned_total_size;
3193}
3194
29ca9e45 3195static bool validate_cluster_size(size_t cluster_size, Error **errp)
a9420734 3196{
29ca9e45 3197 int cluster_bits = ctz32(cluster_size);
a9420734
KW
3198 if (cluster_bits < MIN_CLUSTER_BITS || cluster_bits > MAX_CLUSTER_BITS ||
3199 (1 << cluster_bits) != cluster_size)
3200 {
3ef6c40a
HR
3201 error_setg(errp, "Cluster size must be a power of two between %d and "
3202 "%dk", 1 << MIN_CLUSTER_BITS, 1 << (MAX_CLUSTER_BITS - 10));
29ca9e45
KW
3203 return false;
3204 }
3205 return true;
3206}
3207
3208static size_t qcow2_opt_get_cluster_size_del(QemuOpts *opts, Error **errp)
3209{
3210 size_t cluster_size;
3211
3212 cluster_size = qemu_opt_get_size_del(opts, BLOCK_OPT_CLUSTER_SIZE,
3213 DEFAULT_CLUSTER_SIZE);
3214 if (!validate_cluster_size(cluster_size, errp)) {
0eb4a8c1
SH
3215 return 0;
3216 }
3217 return cluster_size;
3218}
3219
3220static int qcow2_opt_get_version_del(QemuOpts *opts, Error **errp)
3221{
3222 char *buf;
3223 int ret;
3224
3225 buf = qemu_opt_get_del(opts, BLOCK_OPT_COMPAT_LEVEL);
3226 if (!buf) {
3227 ret = 3; /* default */
3228 } else if (!strcmp(buf, "0.10")) {
3229 ret = 2;
3230 } else if (!strcmp(buf, "1.1")) {
3231 ret = 3;
3232 } else {
3233 error_setg(errp, "Invalid compatibility level: '%s'", buf);
3234 ret = -EINVAL;
3235 }
3236 g_free(buf);
3237 return ret;
3238}
3239
3240static uint64_t qcow2_opt_get_refcount_bits_del(QemuOpts *opts, int version,
3241 Error **errp)
3242{
3243 uint64_t refcount_bits;
3244
3245 refcount_bits = qemu_opt_get_number_del(opts, BLOCK_OPT_REFCOUNT_BITS, 16);
3246 if (refcount_bits > 64 || !is_power_of_2(refcount_bits)) {
3247 error_setg(errp, "Refcount width must be a power of two and may not "
3248 "exceed 64 bits");
3249 return 0;
3250 }
3251
3252 if (version < 3 && refcount_bits != 16) {
3253 error_setg(errp, "Different refcount widths than 16 bits require "
3254 "compatibility level 1.1 or above (use compat=1.1 or "
3255 "greater)");
3256 return 0;
a9420734
KW
3257 }
3258
0eb4a8c1
SH
3259 return refcount_bits;
3260}
3261
c274393a 3262static int coroutine_fn
60900b7b 3263qcow2_co_create(BlockdevCreateOptions *create_options, Error **errp)
0eb4a8c1 3264{
29ca9e45 3265 BlockdevCreateOptionsQcow2 *qcow2_opts;
0eb4a8c1
SH
3266 QDict *options;
3267
a9420734
KW
3268 /*
3269 * Open the image file and write a minimal qcow2 header.
3270 *
3271 * We keep things simple and start with a zero-sized image. We also
3272 * do without refcount blocks or a L1 table for now. We'll fix the
3273 * inconsistency later.
3274 *
3275 * We do need a refcount table because growing the refcount table means
a951a631 3276 * allocating two new refcount blocks - the second of which would be at
a9420734
KW
3277 * 2 GB for 64k clusters, and we don't want to have a 2 GB initial file
3278 * size for any qcow2 image.
3279 */
e1d74bc6
KW
3280 BlockBackend *blk = NULL;
3281 BlockDriverState *bs = NULL;
dcc98687 3282 BlockDriverState *data_bs = NULL;
f8413b3c 3283 QCowHeader *header;
29ca9e45
KW
3284 size_t cluster_size;
3285 int version;
3286 int refcount_order;
b106ad91 3287 uint64_t* refcount_table;
3ef6c40a 3288 Error *local_err = NULL;
a9420734
KW
3289 int ret;
3290
29ca9e45
KW
3291 assert(create_options->driver == BLOCKDEV_DRIVER_QCOW2);
3292 qcow2_opts = &create_options->u.qcow2;
3293
e1d74bc6
KW
3294 bs = bdrv_open_blockdev_ref(qcow2_opts->file, errp);
3295 if (bs == NULL) {
3296 return -EIO;
3297 }
3298
3299 /* Validate options and set default values */
29ca9e45 3300 if (!QEMU_IS_ALIGNED(qcow2_opts->size, BDRV_SECTOR_SIZE)) {
3afea402
AG
3301 error_setg(errp, "Image size must be a multiple of %u bytes",
3302 (unsigned) BDRV_SECTOR_SIZE);
29ca9e45
KW
3303 ret = -EINVAL;
3304 goto out;
3305 }
3306
3307 if (qcow2_opts->has_version) {
3308 switch (qcow2_opts->version) {
3309 case BLOCKDEV_QCOW2_VERSION_V2:
3310 version = 2;
3311 break;
3312 case BLOCKDEV_QCOW2_VERSION_V3:
3313 version = 3;
3314 break;
3315 default:
3316 g_assert_not_reached();
3317 }
3318 } else {
3319 version = 3;
3320 }
3321
3322 if (qcow2_opts->has_cluster_size) {
3323 cluster_size = qcow2_opts->cluster_size;
3324 } else {
3325 cluster_size = DEFAULT_CLUSTER_SIZE;
3326 }
3327
3328 if (!validate_cluster_size(cluster_size, errp)) {
e1d74bc6
KW
3329 ret = -EINVAL;
3330 goto out;
29ca9e45
KW
3331 }
3332
3333 if (!qcow2_opts->has_preallocation) {
3334 qcow2_opts->preallocation = PREALLOC_MODE_OFF;
3335 }
3336 if (qcow2_opts->has_backing_file &&
3337 qcow2_opts->preallocation != PREALLOC_MODE_OFF)
3338 {
3339 error_setg(errp, "Backing file and preallocation cannot be used at "
3340 "the same time");
e1d74bc6
KW
3341 ret = -EINVAL;
3342 goto out;
29ca9e45
KW
3343 }
3344 if (qcow2_opts->has_backing_fmt && !qcow2_opts->has_backing_file) {
3345 error_setg(errp, "Backing format cannot be used without backing file");
e1d74bc6
KW
3346 ret = -EINVAL;
3347 goto out;
29ca9e45
KW
3348 }
3349
3350 if (!qcow2_opts->has_lazy_refcounts) {
3351 qcow2_opts->lazy_refcounts = false;
3352 }
3353 if (version < 3 && qcow2_opts->lazy_refcounts) {
3354 error_setg(errp, "Lazy refcounts only supported with compatibility "
b76b4f60 3355 "level 1.1 and above (use version=v3 or greater)");
e1d74bc6
KW
3356 ret = -EINVAL;
3357 goto out;
29ca9e45
KW
3358 }
3359
3360 if (!qcow2_opts->has_refcount_bits) {
3361 qcow2_opts->refcount_bits = 16;
3362 }
3363 if (qcow2_opts->refcount_bits > 64 ||
3364 !is_power_of_2(qcow2_opts->refcount_bits))
3365 {
3366 error_setg(errp, "Refcount width must be a power of two and may not "
3367 "exceed 64 bits");
e1d74bc6
KW
3368 ret = -EINVAL;
3369 goto out;
29ca9e45
KW
3370 }
3371 if (version < 3 && qcow2_opts->refcount_bits != 16) {
3372 error_setg(errp, "Different refcount widths than 16 bits require "
b76b4f60 3373 "compatibility level 1.1 or above (use version=v3 or "
29ca9e45 3374 "greater)");
e1d74bc6
KW
3375 ret = -EINVAL;
3376 goto out;
29ca9e45
KW
3377 }
3378 refcount_order = ctz32(qcow2_opts->refcount_bits);
3379
6c3944dc
KW
3380 if (qcow2_opts->data_file_raw && !qcow2_opts->data_file) {
3381 error_setg(errp, "data-file-raw requires data-file");
3382 ret = -EINVAL;
3383 goto out;
3384 }
3385 if (qcow2_opts->data_file_raw && qcow2_opts->has_backing_file) {
3386 error_setg(errp, "Backing file and data-file-raw cannot be used at "
3387 "the same time");
3388 ret = -EINVAL;
3389 goto out;
3390 }
3391
dcc98687
KW
3392 if (qcow2_opts->data_file) {
3393 if (version < 3) {
3394 error_setg(errp, "External data files are only supported with "
3395 "compatibility level 1.1 and above (use version=v3 or "
3396 "greater)");
3397 ret = -EINVAL;
3398 goto out;
3399 }
3400 data_bs = bdrv_open_blockdev_ref(qcow2_opts->data_file, errp);
a0cf8363 3401 if (data_bs == NULL) {
dcc98687
KW
3402 ret = -EIO;
3403 goto out;
3404 }
3405 }
29ca9e45
KW
3406
3407 /* Create BlockBackend to write to the image */
a3aeeab5
EB
3408 blk = blk_new_with_bs(bs, BLK_PERM_WRITE | BLK_PERM_RESIZE, BLK_PERM_ALL,
3409 errp);
3410 if (!blk) {
3411 ret = -EPERM;
cbf2b7c4 3412 goto out;
a9420734 3413 }
23588797
KW
3414 blk_set_allow_write_beyond_eof(blk, true);
3415
a9420734 3416 /* Write the header */
f8413b3c
KW
3417 QEMU_BUILD_BUG_ON((1 << MIN_CLUSTER_BITS) < sizeof(*header));
3418 header = g_malloc0(cluster_size);
3419 *header = (QCowHeader) {
3420 .magic = cpu_to_be32(QCOW_MAGIC),
3421 .version = cpu_to_be32(version),
0eb4a8c1 3422 .cluster_bits = cpu_to_be32(ctz32(cluster_size)),
f8413b3c
KW
3423 .size = cpu_to_be64(0),
3424 .l1_table_offset = cpu_to_be64(0),
3425 .l1_size = cpu_to_be32(0),
3426 .refcount_table_offset = cpu_to_be64(cluster_size),
3427 .refcount_table_clusters = cpu_to_be32(1),
bd4b167f 3428 .refcount_order = cpu_to_be32(refcount_order),
f8413b3c
KW
3429 .header_length = cpu_to_be32(sizeof(*header)),
3430 };
a9420734 3431
b25b387f
DB
3432 /* We'll update this to correct value later */
3433 header->crypt_method = cpu_to_be32(QCOW_CRYPT_NONE);
a9420734 3434
29ca9e45 3435 if (qcow2_opts->lazy_refcounts) {
f8413b3c 3436 header->compatible_features |=
bfe8043e
SH
3437 cpu_to_be64(QCOW2_COMPAT_LAZY_REFCOUNTS);
3438 }
dcc98687
KW
3439 if (data_bs) {
3440 header->incompatible_features |=
3441 cpu_to_be64(QCOW2_INCOMPAT_DATA_FILE);
3442 }
6c3944dc
KW
3443 if (qcow2_opts->data_file_raw) {
3444 header->autoclear_features |=
3445 cpu_to_be64(QCOW2_AUTOCLEAR_DATA_FILE_RAW);
3446 }
bfe8043e 3447
8341f00d 3448 ret = blk_pwrite(blk, 0, header, cluster_size, 0);
f8413b3c 3449 g_free(header);
a9420734 3450 if (ret < 0) {
3ef6c40a 3451 error_setg_errno(errp, -ret, "Could not write qcow2 header");
a9420734
KW
3452 goto out;
3453 }
3454
b106ad91
KW
3455 /* Write a refcount table with one refcount block */
3456 refcount_table = g_malloc0(2 * cluster_size);
3457 refcount_table[0] = cpu_to_be64(2 * cluster_size);
8341f00d 3458 ret = blk_pwrite(blk, cluster_size, refcount_table, 2 * cluster_size, 0);
7267c094 3459 g_free(refcount_table);
a9420734
KW
3460
3461 if (ret < 0) {
3ef6c40a 3462 error_setg_errno(errp, -ret, "Could not write refcount table");
a9420734
KW
3463 goto out;
3464 }
3465
23588797
KW
3466 blk_unref(blk);
3467 blk = NULL;
a9420734
KW
3468
3469 /*
3470 * And now open the image and make it consistent first (i.e. increase the
3471 * refcount of the cluster that is occupied by the header and the refcount
3472 * table)
3473 */
e6641719 3474 options = qdict_new();
46f5ac20 3475 qdict_put_str(options, "driver", "qcow2");
cbf2b7c4 3476 qdict_put_str(options, "file", bs->node_name);
dcc98687
KW
3477 if (data_bs) {
3478 qdict_put_str(options, "data-file", data_bs->node_name);
3479 }
cbf2b7c4 3480 blk = blk_new_open(NULL, NULL, options,
55880601
KW
3481 BDRV_O_RDWR | BDRV_O_RESIZE | BDRV_O_NO_FLUSH,
3482 &local_err);
23588797 3483 if (blk == NULL) {
3ef6c40a 3484 error_propagate(errp, local_err);
23588797 3485 ret = -EIO;
a9420734
KW
3486 goto out;
3487 }
3488
23588797 3489 ret = qcow2_alloc_clusters(blk_bs(blk), 3 * cluster_size);
a9420734 3490 if (ret < 0) {
3ef6c40a
HR
3491 error_setg_errno(errp, -ret, "Could not allocate clusters for qcow2 "
3492 "header and refcount table");
a9420734
KW
3493 goto out;
3494
3495 } else if (ret != 0) {
3496 error_report("Huh, first cluster in empty image is already in use?");
3497 abort();
3498 }
3499
9b890bdc
KW
3500 /* Set the external data file if necessary */
3501 if (data_bs) {
3502 BDRVQcow2State *s = blk_bs(blk)->opaque;
3503 s->image_data_file = g_strdup(data_bs->filename);
3504 }
3505
b527c9b3 3506 /* Create a full header (including things like feature table) */
23588797 3507 ret = qcow2_update_header(blk_bs(blk));
b527c9b3
KW
3508 if (ret < 0) {
3509 error_setg_errno(errp, -ret, "Could not update qcow2 header");
3510 goto out;
3511 }
3512
a9420734 3513 /* Okay, now that we have a valid image, let's give it the right size */
c80d8b06 3514 ret = blk_truncate(blk, qcow2_opts->size, false, qcow2_opts->preallocation,
8c6242b6 3515 0, errp);
a9420734 3516 if (ret < 0) {
ed3d2ec9 3517 error_prepend(errp, "Could not resize image: ");
a9420734
KW
3518 goto out;
3519 }
3520
a951a631 3521 /* Want a backing file? There you go. */
29ca9e45
KW
3522 if (qcow2_opts->has_backing_file) {
3523 const char *backing_format = NULL;
3524
3525 if (qcow2_opts->has_backing_fmt) {
3526 backing_format = BlockdevDriver_str(qcow2_opts->backing_fmt);
3527 }
3528
3529 ret = bdrv_change_backing_file(blk_bs(blk), qcow2_opts->backing_file,
3530 backing_format);
a9420734 3531 if (ret < 0) {
3ef6c40a 3532 error_setg_errno(errp, -ret, "Could not assign backing file '%s' "
29ca9e45
KW
3533 "with format '%s'", qcow2_opts->backing_file,
3534 backing_format);
a9420734
KW
3535 goto out;
3536 }
3537 }
3538
b25b387f 3539 /* Want encryption? There you go. */
60900b7b
KW
3540 if (qcow2_opts->has_encrypt) {
3541 ret = qcow2_set_up_encryption(blk_bs(blk), qcow2_opts->encrypt, errp);
b25b387f
DB
3542 if (ret < 0) {
3543 goto out;
3544 }
3545 }
3546
23588797
KW
3547 blk_unref(blk);
3548 blk = NULL;
ba2ab2f2 3549
b25b387f
DB
3550 /* Reopen the image without BDRV_O_NO_FLUSH to flush it before returning.
3551 * Using BDRV_O_NO_IO, since encryption is now setup we don't want to
3552 * have to setup decryption context. We're not doing any I/O on the top
3553 * level BlockDriverState, only lower layers, where BDRV_O_NO_IO does
3554 * not have effect.
3555 */
e6641719 3556 options = qdict_new();
46f5ac20 3557 qdict_put_str(options, "driver", "qcow2");
cbf2b7c4 3558 qdict_put_str(options, "file", bs->node_name);
dcc98687
KW
3559 if (data_bs) {
3560 qdict_put_str(options, "data-file", data_bs->node_name);
3561 }
cbf2b7c4 3562 blk = blk_new_open(NULL, NULL, options,
b25b387f
DB
3563 BDRV_O_RDWR | BDRV_O_NO_BACKING | BDRV_O_NO_IO,
3564 &local_err);
23588797 3565 if (blk == NULL) {
ba2ab2f2 3566 error_propagate(errp, local_err);
23588797 3567 ret = -EIO;
ba2ab2f2
HR
3568 goto out;
3569 }
3570
a9420734
KW
3571 ret = 0;
3572out:
e1d74bc6
KW
3573 blk_unref(blk);
3574 bdrv_unref(bs);
dcc98687 3575 bdrv_unref(data_bs);
a9420734
KW
3576 return ret;
3577}
de5f3f40 3578
b92902df
ML
3579static int coroutine_fn qcow2_co_create_opts(BlockDriver *drv,
3580 const char *filename,
3581 QemuOpts *opts,
efc75e2a 3582 Error **errp)
de5f3f40 3583{
b76b4f60 3584 BlockdevCreateOptions *create_options = NULL;
92adf9db 3585 QDict *qdict;
b76b4f60 3586 Visitor *v;
cbf2b7c4 3587 BlockDriverState *bs = NULL;
9b890bdc 3588 BlockDriverState *data_bs = NULL;
3ef6c40a 3589 Error *local_err = NULL;
b76b4f60 3590 const char *val;
3ef6c40a 3591 int ret;
de5f3f40 3592
b76b4f60
KW
3593 /* Only the keyval visitor supports the dotted syntax needed for
3594 * encryption, so go through a QDict before getting a QAPI type. Ignore
3595 * options meant for the protocol layer so that the visitor doesn't
3596 * complain. */
3597 qdict = qemu_opts_to_qdict_filtered(opts, NULL, bdrv_qcow2.create_opts,
3598 true);
3599
3600 /* Handle encryption options */
3601 val = qdict_get_try_str(qdict, BLOCK_OPT_ENCRYPT);
3602 if (val && !strcmp(val, "on")) {
3603 qdict_put_str(qdict, BLOCK_OPT_ENCRYPT, "qcow");
3604 } else if (val && !strcmp(val, "off")) {
3605 qdict_del(qdict, BLOCK_OPT_ENCRYPT);
3606 }
3607
3608 val = qdict_get_try_str(qdict, BLOCK_OPT_ENCRYPT_FORMAT);
3609 if (val && !strcmp(val, "aes")) {
3610 qdict_put_str(qdict, BLOCK_OPT_ENCRYPT_FORMAT, "qcow");
3611 }
3612
3613 /* Convert compat=0.10/1.1 into compat=v2/v3, to be renamed into
3614 * version=v2/v3 below. */
3615 val = qdict_get_try_str(qdict, BLOCK_OPT_COMPAT_LEVEL);
3616 if (val && !strcmp(val, "0.10")) {
3617 qdict_put_str(qdict, BLOCK_OPT_COMPAT_LEVEL, "v2");
3618 } else if (val && !strcmp(val, "1.1")) {
3619 qdict_put_str(qdict, BLOCK_OPT_COMPAT_LEVEL, "v3");
3620 }
3621
3622 /* Change legacy command line options into QMP ones */
3623 static const QDictRenames opt_renames[] = {
3624 { BLOCK_OPT_BACKING_FILE, "backing-file" },
3625 { BLOCK_OPT_BACKING_FMT, "backing-fmt" },
3626 { BLOCK_OPT_CLUSTER_SIZE, "cluster-size" },
3627 { BLOCK_OPT_LAZY_REFCOUNTS, "lazy-refcounts" },
3628 { BLOCK_OPT_REFCOUNT_BITS, "refcount-bits" },
3629 { BLOCK_OPT_ENCRYPT, BLOCK_OPT_ENCRYPT_FORMAT },
3630 { BLOCK_OPT_COMPAT_LEVEL, "version" },
6c3944dc 3631 { BLOCK_OPT_DATA_FILE_RAW, "data-file-raw" },
b76b4f60
KW
3632 { NULL, NULL },
3633 };
3634
3635 if (!qdict_rename_keys(qdict, opt_renames, errp)) {
29ca9e45
KW
3636 ret = -EINVAL;
3637 goto finish;
3638 }
60900b7b 3639
b76b4f60
KW
3640 /* Create and open the file (protocol layer) */
3641 ret = bdrv_create_file(filename, opts, errp);
3642 if (ret < 0) {
0eb4a8c1
SH
3643 goto finish;
3644 }
b76b4f60
KW
3645
3646 bs = bdrv_open(filename, NULL, NULL,
3647 BDRV_O_RDWR | BDRV_O_RESIZE | BDRV_O_PROTOCOL, errp);
3648 if (bs == NULL) {
3649 ret = -EIO;
1bd0e2d1
CL
3650 goto finish;
3651 }
0eb4a8c1 3652
9b890bdc
KW
3653 /* Create and open an external data file (protocol layer) */
3654 val = qdict_get_try_str(qdict, BLOCK_OPT_DATA_FILE);
3655 if (val) {
3656 ret = bdrv_create_file(val, opts, errp);
3657 if (ret < 0) {
3658 goto finish;
3659 }
3660
3661 data_bs = bdrv_open(val, NULL, NULL,
3662 BDRV_O_RDWR | BDRV_O_RESIZE | BDRV_O_PROTOCOL,
3663 errp);
3664 if (data_bs == NULL) {
3665 ret = -EIO;
3666 goto finish;
3667 }
3668
3669 qdict_del(qdict, BLOCK_OPT_DATA_FILE);
3670 qdict_put_str(qdict, "data-file", data_bs->node_name);
3671 }
3672
b76b4f60
KW
3673 /* Set 'driver' and 'node' options */
3674 qdict_put_str(qdict, "driver", "qcow2");
3675 qdict_put_str(qdict, "file", bs->node_name);
3676
3677 /* Now get the QAPI type BlockdevCreateOptions */
af91062e
MA
3678 v = qobject_input_visitor_new_flat_confused(qdict, errp);
3679 if (!v) {
1bd0e2d1
CL
3680 ret = -EINVAL;
3681 goto finish;
3682 }
3683
b76b4f60
KW
3684 visit_type_BlockdevCreateOptions(v, NULL, &create_options, &local_err);
3685 visit_free(v);
de5f3f40 3686
0eb4a8c1
SH
3687 if (local_err) {
3688 error_propagate(errp, local_err);
bd4b167f
HR
3689 ret = -EINVAL;
3690 goto finish;
3691 }
3692
b76b4f60
KW
3693 /* Silently round up size */
3694 create_options->u.qcow2.size = ROUND_UP(create_options->u.qcow2.size,
3695 BDRV_SECTOR_SIZE);
cbf2b7c4
KW
3696
3697 /* Create the qcow2 image (format layer) */
b76b4f60 3698 ret = qcow2_co_create(create_options, errp);
cbf2b7c4
KW
3699 if (ret < 0) {
3700 goto finish;
3701 }
1bd0e2d1 3702
b76b4f60 3703 ret = 0;
1bd0e2d1 3704finish:
cb3e7f08 3705 qobject_unref(qdict);
cbf2b7c4 3706 bdrv_unref(bs);
9b890bdc 3707 bdrv_unref(data_bs);
b76b4f60 3708 qapi_free_BlockdevCreateOptions(create_options);
3ef6c40a 3709 return ret;
de5f3f40
KW
3710}
3711
2928abce 3712
f06f6b66 3713static bool is_zero(BlockDriverState *bs, int64_t offset, int64_t bytes)
2928abce 3714{
31826642
EB
3715 int64_t nr;
3716 int res;
f06f6b66
EB
3717
3718 /* Clamp to image length, before checking status of underlying sectors */
8cbf74b2
EB
3719 if (offset + bytes > bs->total_sectors * BDRV_SECTOR_SIZE) {
3720 bytes = bs->total_sectors * BDRV_SECTOR_SIZE - offset;
fbaa6bb3
EB
3721 }
3722
f06f6b66 3723 if (!bytes) {
ebb718a5
EB
3724 return true;
3725 }
8cbf74b2 3726 res = bdrv_block_status_above(bs, NULL, offset, bytes, &nr, NULL, NULL);
31826642 3727 return res >= 0 && (res & BDRV_BLOCK_ZERO) && nr == bytes;
2928abce
DL
3728}
3729
5544b59f 3730static coroutine_fn int qcow2_co_pwrite_zeroes(BlockDriverState *bs,
f5a5ca79 3731 int64_t offset, int bytes, BdrvRequestFlags flags)
621f0589
KW
3732{
3733 int ret;
ff99129a 3734 BDRVQcow2State *s = bs->opaque;
621f0589 3735
5544b59f 3736 uint32_t head = offset % s->cluster_size;
f5a5ca79 3737 uint32_t tail = (offset + bytes) % s->cluster_size;
2928abce 3738
f5a5ca79
MP
3739 trace_qcow2_pwrite_zeroes_start_req(qemu_coroutine_self(), offset, bytes);
3740 if (offset + bytes == bs->total_sectors * BDRV_SECTOR_SIZE) {
fbaa6bb3
EB
3741 tail = 0;
3742 }
5a64e942 3743
ebb718a5 3744 if (head || tail) {
ebb718a5 3745 uint64_t off;
ecfe1863 3746 unsigned int nr;
2928abce 3747
f5a5ca79 3748 assert(head + bytes <= s->cluster_size);
2928abce 3749
ebb718a5 3750 /* check whether remainder of cluster already reads as zero */
f06f6b66
EB
3751 if (!(is_zero(bs, offset - head, head) &&
3752 is_zero(bs, offset + bytes,
3753 tail ? s->cluster_size - tail : 0))) {
2928abce
DL
3754 return -ENOTSUP;
3755 }
3756
2928abce
DL
3757 qemu_co_mutex_lock(&s->lock);
3758 /* We can have new write after previous check */
f06f6b66 3759 offset = QEMU_ALIGN_DOWN(offset, s->cluster_size);
f5a5ca79 3760 bytes = s->cluster_size;
ecfe1863 3761 nr = s->cluster_size;
5544b59f 3762 ret = qcow2_get_cluster_offset(bs, offset, &nr, &off);
fdfab37d
EB
3763 if (ret != QCOW2_CLUSTER_UNALLOCATED &&
3764 ret != QCOW2_CLUSTER_ZERO_PLAIN &&
3765 ret != QCOW2_CLUSTER_ZERO_ALLOC) {
2928abce
DL
3766 qemu_co_mutex_unlock(&s->lock);
3767 return -ENOTSUP;
3768 }
3769 } else {
3770 qemu_co_mutex_lock(&s->lock);
621f0589
KW
3771 }
3772
f5a5ca79 3773 trace_qcow2_pwrite_zeroes(qemu_coroutine_self(), offset, bytes);
5a64e942 3774
621f0589 3775 /* Whatever is left can use real zero clusters */
f5a5ca79 3776 ret = qcow2_cluster_zeroize(bs, offset, bytes, flags);
621f0589
KW
3777 qemu_co_mutex_unlock(&s->lock);
3778
3779 return ret;
3780}
3781
82e8a788 3782static coroutine_fn int qcow2_co_pdiscard(BlockDriverState *bs,
f5a5ca79 3783 int64_t offset, int bytes)
5ea929e3 3784{
6db39ae2 3785 int ret;
ff99129a 3786 BDRVQcow2State *s = bs->opaque;
6db39ae2 3787
80f5c011
AG
3788 /* If the image does not support QCOW_OFLAG_ZERO then discarding
3789 * clusters could expose stale data from the backing file. */
3790 if (s->qcow_version < 3 && bs->backing) {
3791 return -ENOTSUP;
3792 }
3793
f5a5ca79
MP
3794 if (!QEMU_IS_ALIGNED(offset | bytes, s->cluster_size)) {
3795 assert(bytes < s->cluster_size);
048c5fd1
EB
3796 /* Ignore partial clusters, except for the special case of the
3797 * complete partial cluster at the end of an unaligned file */
3798 if (!QEMU_IS_ALIGNED(offset, s->cluster_size) ||
f5a5ca79 3799 offset + bytes != bs->total_sectors * BDRV_SECTOR_SIZE) {
048c5fd1
EB
3800 return -ENOTSUP;
3801 }
49228d1e
EB
3802 }
3803
6db39ae2 3804 qemu_co_mutex_lock(&s->lock);
f5a5ca79 3805 ret = qcow2_cluster_discard(bs, offset, bytes, QCOW2_DISCARD_REQUEST,
d2cb36af 3806 false);
6db39ae2
PB
3807 qemu_co_mutex_unlock(&s->lock);
3808 return ret;
5ea929e3
KW
3809}
3810
fd9fcd37
FZ
3811static int coroutine_fn
3812qcow2_co_copy_range_from(BlockDriverState *bs,
3813 BdrvChild *src, uint64_t src_offset,
3814 BdrvChild *dst, uint64_t dst_offset,
67b51fb9
VSO
3815 uint64_t bytes, BdrvRequestFlags read_flags,
3816 BdrvRequestFlags write_flags)
fd9fcd37
FZ
3817{
3818 BDRVQcow2State *s = bs->opaque;
3819 int ret;
3820 unsigned int cur_bytes; /* number of bytes in current iteration */
3821 BdrvChild *child = NULL;
67b51fb9 3822 BdrvRequestFlags cur_write_flags;
fd9fcd37
FZ
3823
3824 assert(!bs->encrypted);
3825 qemu_co_mutex_lock(&s->lock);
3826
3827 while (bytes != 0) {
3828 uint64_t copy_offset = 0;
3829 /* prepare next request */
3830 cur_bytes = MIN(bytes, INT_MAX);
67b51fb9 3831 cur_write_flags = write_flags;
fd9fcd37
FZ
3832
3833 ret = qcow2_get_cluster_offset(bs, src_offset, &cur_bytes, &copy_offset);
3834 if (ret < 0) {
3835 goto out;
3836 }
3837
3838 switch (ret) {
3839 case QCOW2_CLUSTER_UNALLOCATED:
3840 if (bs->backing && bs->backing->bs) {
3841 int64_t backing_length = bdrv_getlength(bs->backing->bs);
3842 if (src_offset >= backing_length) {
67b51fb9 3843 cur_write_flags |= BDRV_REQ_ZERO_WRITE;
fd9fcd37
FZ
3844 } else {
3845 child = bs->backing;
3846 cur_bytes = MIN(cur_bytes, backing_length - src_offset);
3847 copy_offset = src_offset;
3848 }
3849 } else {
67b51fb9 3850 cur_write_flags |= BDRV_REQ_ZERO_WRITE;
fd9fcd37
FZ
3851 }
3852 break;
3853
3854 case QCOW2_CLUSTER_ZERO_PLAIN:
3855 case QCOW2_CLUSTER_ZERO_ALLOC:
67b51fb9 3856 cur_write_flags |= BDRV_REQ_ZERO_WRITE;
fd9fcd37
FZ
3857 break;
3858
3859 case QCOW2_CLUSTER_COMPRESSED:
3860 ret = -ENOTSUP;
3861 goto out;
fd9fcd37
FZ
3862
3863 case QCOW2_CLUSTER_NORMAL:
966b000f 3864 child = s->data_file;
fd9fcd37 3865 copy_offset += offset_into_cluster(s, src_offset);
fd9fcd37
FZ
3866 break;
3867
3868 default:
3869 abort();
3870 }
3871 qemu_co_mutex_unlock(&s->lock);
3872 ret = bdrv_co_copy_range_from(child,
3873 copy_offset,
3874 dst, dst_offset,
67b51fb9 3875 cur_bytes, read_flags, cur_write_flags);
fd9fcd37
FZ
3876 qemu_co_mutex_lock(&s->lock);
3877 if (ret < 0) {
3878 goto out;
3879 }
3880
3881 bytes -= cur_bytes;
3882 src_offset += cur_bytes;
3883 dst_offset += cur_bytes;
3884 }
3885 ret = 0;
3886
3887out:
3888 qemu_co_mutex_unlock(&s->lock);
3889 return ret;
3890}
3891
3892static int coroutine_fn
3893qcow2_co_copy_range_to(BlockDriverState *bs,
3894 BdrvChild *src, uint64_t src_offset,
3895 BdrvChild *dst, uint64_t dst_offset,
67b51fb9
VSO
3896 uint64_t bytes, BdrvRequestFlags read_flags,
3897 BdrvRequestFlags write_flags)
fd9fcd37
FZ
3898{
3899 BDRVQcow2State *s = bs->opaque;
3900 int offset_in_cluster;
3901 int ret;
3902 unsigned int cur_bytes; /* number of sectors in current iteration */
3903 uint64_t cluster_offset;
fd9fcd37
FZ
3904 QCowL2Meta *l2meta = NULL;
3905
3906 assert(!bs->encrypted);
fd9fcd37
FZ
3907
3908 qemu_co_mutex_lock(&s->lock);
3909
3910 while (bytes != 0) {
3911
3912 l2meta = NULL;
3913
3914 offset_in_cluster = offset_into_cluster(s, dst_offset);
3915 cur_bytes = MIN(bytes, INT_MAX);
3916
3917 /* TODO:
3918 * If src->bs == dst->bs, we could simply copy by incrementing
3919 * the refcnt, without copying user data.
3920 * Or if src->bs == dst->bs->backing->bs, we could copy by discarding. */
3921 ret = qcow2_alloc_cluster_offset(bs, dst_offset, &cur_bytes,
3922 &cluster_offset, &l2meta);
3923 if (ret < 0) {
3924 goto fail;
3925 }
3926
344ffea9 3927 assert(offset_into_cluster(s, cluster_offset) == 0);
fd9fcd37
FZ
3928
3929 ret = qcow2_pre_write_overlap_check(bs, 0,
966b000f 3930 cluster_offset + offset_in_cluster, cur_bytes, true);
fd9fcd37
FZ
3931 if (ret < 0) {
3932 goto fail;
3933 }
3934
3935 qemu_co_mutex_unlock(&s->lock);
3936 ret = bdrv_co_copy_range_to(src, src_offset,
966b000f 3937 s->data_file,
fd9fcd37 3938 cluster_offset + offset_in_cluster,
67b51fb9 3939 cur_bytes, read_flags, write_flags);
fd9fcd37
FZ
3940 qemu_co_mutex_lock(&s->lock);
3941 if (ret < 0) {
3942 goto fail;
3943 }
3944
3945 ret = qcow2_handle_l2meta(bs, &l2meta, true);
3946 if (ret) {
3947 goto fail;
3948 }
3949
3950 bytes -= cur_bytes;
e06f4639 3951 src_offset += cur_bytes;
fd9fcd37
FZ
3952 dst_offset += cur_bytes;
3953 }
3954 ret = 0;
3955
3956fail:
3957 qcow2_handle_l2meta(bs, &l2meta, false);
3958
3959 qemu_co_mutex_unlock(&s->lock);
3960
fd9fcd37
FZ
3961 trace_qcow2_writev_done_req(qemu_coroutine_self(), ret);
3962
3963 return ret;
3964}
3965
061ca8a3 3966static int coroutine_fn qcow2_co_truncate(BlockDriverState *bs, int64_t offset,
c80d8b06 3967 bool exact, PreallocMode prealloc,
92b92799 3968 BdrvRequestFlags flags, Error **errp)
419b19d9 3969{
ff99129a 3970 BDRVQcow2State *s = bs->opaque;
95b98f34 3971 uint64_t old_length;
2cf7cfa1
KW
3972 int64_t new_l1_size;
3973 int ret;
45b4949c 3974 QDict *options;
419b19d9 3975
772d1f97
HR
3976 if (prealloc != PREALLOC_MODE_OFF && prealloc != PREALLOC_MODE_METADATA &&
3977 prealloc != PREALLOC_MODE_FALLOC && prealloc != PREALLOC_MODE_FULL)
3978 {
8243ccb7 3979 error_setg(errp, "Unsupported preallocation mode '%s'",
977c736f 3980 PreallocMode_str(prealloc));
8243ccb7
HR
3981 return -ENOTSUP;
3982 }
3983
3afea402
AG
3984 if (!QEMU_IS_ALIGNED(offset, BDRV_SECTOR_SIZE)) {
3985 error_setg(errp, "The new size must be a multiple of %u",
3986 (unsigned) BDRV_SECTOR_SIZE);
419b19d9
SH
3987 return -EINVAL;
3988 }
3989
061ca8a3
KW
3990 qemu_co_mutex_lock(&s->lock);
3991
7fa140ab
EB
3992 /*
3993 * Even though we store snapshot size for all images, it was not
3994 * required until v3, so it is not safe to proceed for v2.
3995 */
3996 if (s->nb_snapshots && s->qcow_version < 3) {
3997 error_setg(errp, "Can't resize a v2 image which has snapshots");
061ca8a3
KW
3998 ret = -ENOTSUP;
3999 goto fail;
419b19d9
SH
4000 }
4001
88ddffae 4002 /* cannot proceed if image has bitmaps */
d19c6b36 4003 if (qcow2_truncate_bitmaps_check(bs, errp)) {
061ca8a3
KW
4004 ret = -ENOTSUP;
4005 goto fail;
88ddffae
VSO
4006 }
4007
bd016b91 4008 old_length = bs->total_sectors * BDRV_SECTOR_SIZE;
46b732cd 4009 new_l1_size = size_to_l1(s, offset);
95b98f34 4010
95b98f34 4011 if (offset < old_length) {
163bc39d 4012 int64_t last_cluster, old_file_size;
46b732cd
PB
4013 if (prealloc != PREALLOC_MODE_OFF) {
4014 error_setg(errp,
4015 "Preallocation can't be used for shrinking an image");
061ca8a3
KW
4016 ret = -EINVAL;
4017 goto fail;
46b732cd 4018 }
419b19d9 4019
46b732cd
PB
4020 ret = qcow2_cluster_discard(bs, ROUND_UP(offset, s->cluster_size),
4021 old_length - ROUND_UP(offset,
4022 s->cluster_size),
4023 QCOW2_DISCARD_ALWAYS, true);
4024 if (ret < 0) {
4025 error_setg_errno(errp, -ret, "Failed to discard cropped clusters");
061ca8a3 4026 goto fail;
46b732cd
PB
4027 }
4028
4029 ret = qcow2_shrink_l1_table(bs, new_l1_size);
4030 if (ret < 0) {
4031 error_setg_errno(errp, -ret,
4032 "Failed to reduce the number of L2 tables");
061ca8a3 4033 goto fail;
46b732cd
PB
4034 }
4035
4036 ret = qcow2_shrink_reftable(bs);
4037 if (ret < 0) {
4038 error_setg_errno(errp, -ret,
4039 "Failed to discard unused refblocks");
061ca8a3 4040 goto fail;
46b732cd 4041 }
163bc39d
PB
4042
4043 old_file_size = bdrv_getlength(bs->file->bs);
4044 if (old_file_size < 0) {
4045 error_setg_errno(errp, -old_file_size,
4046 "Failed to inquire current file length");
061ca8a3
KW
4047 ret = old_file_size;
4048 goto fail;
163bc39d
PB
4049 }
4050 last_cluster = qcow2_get_last_cluster(bs, old_file_size);
4051 if (last_cluster < 0) {
4052 error_setg_errno(errp, -last_cluster,
4053 "Failed to find the last cluster");
061ca8a3
KW
4054 ret = last_cluster;
4055 goto fail;
163bc39d
PB
4056 }
4057 if ((last_cluster + 1) * s->cluster_size < old_file_size) {
233521b1
HR
4058 Error *local_err = NULL;
4059
e61a28a9
HR
4060 /*
4061 * Do not pass @exact here: It will not help the user if
4062 * we get an error here just because they wanted to shrink
4063 * their qcow2 image (on a block device) with qemu-img.
4064 * (And on the qcow2 layer, the @exact requirement is
4065 * always fulfilled, so there is no need to pass it on.)
4066 */
061ca8a3 4067 bdrv_co_truncate(bs->file, (last_cluster + 1) * s->cluster_size,
7b8e4857 4068 false, PREALLOC_MODE_OFF, 0, &local_err);
233521b1
HR
4069 if (local_err) {
4070 warn_reportf_err(local_err,
4071 "Failed to truncate the tail of the image: ");
163bc39d
PB
4072 }
4073 }
46b732cd
PB
4074 } else {
4075 ret = qcow2_grow_l1_table(bs, new_l1_size, true);
4076 if (ret < 0) {
4077 error_setg_errno(errp, -ret, "Failed to grow the L1 table");
061ca8a3 4078 goto fail;
46b732cd 4079 }
419b19d9
SH
4080 }
4081
95b98f34
HR
4082 switch (prealloc) {
4083 case PREALLOC_MODE_OFF:
718c0fce 4084 if (has_data_file(bs)) {
e61a28a9
HR
4085 /*
4086 * If the caller wants an exact resize, the external data
4087 * file should be resized to the exact target size, too,
4088 * so we pass @exact here.
4089 */
7b8e4857
KW
4090 ret = bdrv_co_truncate(s->data_file, offset, exact, prealloc, 0,
4091 errp);
718c0fce
KW
4092 if (ret < 0) {
4093 goto fail;
4094 }
4095 }
95b98f34
HR
4096 break;
4097
4098 case PREALLOC_MODE_METADATA:
718c0fce 4099 ret = preallocate_co(bs, old_length, offset, prealloc, errp);
95b98f34 4100 if (ret < 0) {
061ca8a3 4101 goto fail;
95b98f34
HR
4102 }
4103 break;
4104
772d1f97
HR
4105 case PREALLOC_MODE_FALLOC:
4106 case PREALLOC_MODE_FULL:
4107 {
4108 int64_t allocation_start, host_offset, guest_offset;
4109 int64_t clusters_allocated;
4110 int64_t old_file_size, new_file_size;
4111 uint64_t nb_new_data_clusters, nb_new_l2_tables;
4112
966b000f
KW
4113 /* With a data file, preallocation means just allocating the metadata
4114 * and forwarding the truncate request to the data file */
4115 if (has_data_file(bs)) {
718c0fce 4116 ret = preallocate_co(bs, old_length, offset, prealloc, errp);
966b000f 4117 if (ret < 0) {
966b000f
KW
4118 goto fail;
4119 }
4120 break;
4121 }
4122
772d1f97
HR
4123 old_file_size = bdrv_getlength(bs->file->bs);
4124 if (old_file_size < 0) {
4125 error_setg_errno(errp, -old_file_size,
4126 "Failed to inquire current file length");
061ca8a3
KW
4127 ret = old_file_size;
4128 goto fail;
772d1f97 4129 }
e400ad1e 4130 old_file_size = ROUND_UP(old_file_size, s->cluster_size);
772d1f97
HR
4131
4132 nb_new_data_clusters = DIV_ROUND_UP(offset - old_length,
4133 s->cluster_size);
4134
4135 /* This is an overestimation; we will not actually allocate space for
4136 * these in the file but just make sure the new refcount structures are
4137 * able to cover them so we will not have to allocate new refblocks
4138 * while entering the data blocks in the potentially new L2 tables.
4139 * (We do not actually care where the L2 tables are placed. Maybe they
4140 * are already allocated or they can be placed somewhere before
4141 * @old_file_size. It does not matter because they will be fully
4142 * allocated automatically, so they do not need to be covered by the
4143 * preallocation. All that matters is that we will not have to allocate
4144 * new refcount structures for them.) */
4145 nb_new_l2_tables = DIV_ROUND_UP(nb_new_data_clusters,
4146 s->cluster_size / sizeof(uint64_t));
4147 /* The cluster range may not be aligned to L2 boundaries, so add one L2
4148 * table for a potential head/tail */
4149 nb_new_l2_tables++;
4150
4151 allocation_start = qcow2_refcount_area(bs, old_file_size,
4152 nb_new_data_clusters +
4153 nb_new_l2_tables,
4154 true, 0, 0);
4155 if (allocation_start < 0) {
4156 error_setg_errno(errp, -allocation_start,
4157 "Failed to resize refcount structures");
061ca8a3
KW
4158 ret = allocation_start;
4159 goto fail;
772d1f97
HR
4160 }
4161
4162 clusters_allocated = qcow2_alloc_clusters_at(bs, allocation_start,
4163 nb_new_data_clusters);
4164 if (clusters_allocated < 0) {
4165 error_setg_errno(errp, -clusters_allocated,
4166 "Failed to allocate data clusters");
061ca8a3
KW
4167 ret = clusters_allocated;
4168 goto fail;
772d1f97
HR
4169 }
4170
4171 assert(clusters_allocated == nb_new_data_clusters);
4172
4173 /* Allocate the data area */
4174 new_file_size = allocation_start +
4175 nb_new_data_clusters * s->cluster_size;
eb8a0cf3
KW
4176 /*
4177 * Image file grows, so @exact does not matter.
4178 *
4179 * If we need to zero out the new area, try first whether the protocol
4180 * driver can already take care of this.
4181 */
4182 if (flags & BDRV_REQ_ZERO_WRITE) {
4183 ret = bdrv_co_truncate(bs->file, new_file_size, false, prealloc,
4184 BDRV_REQ_ZERO_WRITE, NULL);
4185 if (ret >= 0) {
4186 flags &= ~BDRV_REQ_ZERO_WRITE;
4187 }
4188 } else {
4189 ret = -1;
4190 }
4191 if (ret < 0) {
4192 ret = bdrv_co_truncate(bs->file, new_file_size, false, prealloc, 0,
4193 errp);
4194 }
772d1f97
HR
4195 if (ret < 0) {
4196 error_prepend(errp, "Failed to resize underlying file: ");
4197 qcow2_free_clusters(bs, allocation_start,
4198 nb_new_data_clusters * s->cluster_size,
4199 QCOW2_DISCARD_OTHER);
061ca8a3 4200 goto fail;
772d1f97
HR
4201 }
4202
4203 /* Create the necessary L2 entries */
4204 host_offset = allocation_start;
4205 guest_offset = old_length;
4206 while (nb_new_data_clusters) {
13bec229
AG
4207 int64_t nb_clusters = MIN(
4208 nb_new_data_clusters,
4209 s->l2_slice_size - offset_to_l2_slice_index(s, guest_offset));
772d1f97
HR
4210 QCowL2Meta allocation = {
4211 .offset = guest_offset,
4212 .alloc_offset = host_offset,
4213 .nb_clusters = nb_clusters,
4214 };
4215 qemu_co_queue_init(&allocation.dependent_requests);
4216
4217 ret = qcow2_alloc_cluster_link_l2(bs, &allocation);
4218 if (ret < 0) {
4219 error_setg_errno(errp, -ret, "Failed to update L2 tables");
4220 qcow2_free_clusters(bs, host_offset,
4221 nb_new_data_clusters * s->cluster_size,
4222 QCOW2_DISCARD_OTHER);
061ca8a3 4223 goto fail;
772d1f97
HR
4224 }
4225
4226 guest_offset += nb_clusters * s->cluster_size;
4227 host_offset += nb_clusters * s->cluster_size;
4228 nb_new_data_clusters -= nb_clusters;
4229 }
4230 break;
4231 }
4232
95b98f34
HR
4233 default:
4234 g_assert_not_reached();
4235 }
4236
f01643fb
KW
4237 if ((flags & BDRV_REQ_ZERO_WRITE) && offset > old_length) {
4238 uint64_t zero_start = QEMU_ALIGN_UP(old_length, s->cluster_size);
4239
4240 /*
4241 * Use zero clusters as much as we can. qcow2_cluster_zeroize()
4242 * requires a cluster-aligned start. The end may be unaligned if it is
4243 * at the end of the image (which it is here).
4244 */
4245 ret = qcow2_cluster_zeroize(bs, zero_start, offset - zero_start, 0);
4246 if (ret < 0) {
4247 error_setg_errno(errp, -ret, "Failed to zero out new clusters");
4248 goto fail;
4249 }
4250
4251 /* Write explicit zeros for the unaligned head */
4252 if (zero_start > old_length) {
4253 uint64_t len = zero_start - old_length;
4254 uint8_t *buf = qemu_blockalign0(bs, len);
4255 QEMUIOVector qiov;
4256 qemu_iovec_init_buf(&qiov, buf, len);
4257
4258 qemu_co_mutex_unlock(&s->lock);
4259 ret = qcow2_co_pwritev_part(bs, old_length, len, &qiov, 0, 0);
4260 qemu_co_mutex_lock(&s->lock);
4261
4262 qemu_vfree(buf);
4263 if (ret < 0) {
4264 error_setg_errno(errp, -ret, "Failed to zero out the new area");
4265 goto fail;
4266 }
4267 }
4268 }
4269
95b98f34
HR
4270 if (prealloc != PREALLOC_MODE_OFF) {
4271 /* Flush metadata before actually changing the image size */
061ca8a3 4272 ret = qcow2_write_caches(bs);
95b98f34
HR
4273 if (ret < 0) {
4274 error_setg_errno(errp, -ret,
4275 "Failed to flush the preallocated area to disk");
061ca8a3 4276 goto fail;
95b98f34
HR
4277 }
4278 }
4279
45b4949c
LB
4280 bs->total_sectors = offset / BDRV_SECTOR_SIZE;
4281
419b19d9
SH
4282 /* write updated header.size */
4283 offset = cpu_to_be64(offset);
d9ca2ea2 4284 ret = bdrv_pwrite_sync(bs->file, offsetof(QCowHeader, size),
8b3b7206 4285 &offset, sizeof(uint64_t));
419b19d9 4286 if (ret < 0) {
f59adb32 4287 error_setg_errno(errp, -ret, "Failed to update the image size");
061ca8a3 4288 goto fail;
419b19d9
SH
4289 }
4290
4291 s->l1_vm_state_index = new_l1_size;
45b4949c
LB
4292
4293 /* Update cache sizes */
4294 options = qdict_clone_shallow(bs->options);
4295 ret = qcow2_update_options(bs, options, s->flags, errp);
4296 qobject_unref(options);
4297 if (ret < 0) {
4298 goto fail;
4299 }
061ca8a3
KW
4300 ret = 0;
4301fail:
4302 qemu_co_mutex_unlock(&s->lock);
4303 return ret;
419b19d9
SH
4304}
4305
fcccefc5 4306static coroutine_fn int
0d483dce 4307qcow2_co_pwritev_compressed_task(BlockDriverState *bs,
5396234b
VSO
4308 uint64_t offset, uint64_t bytes,
4309 QEMUIOVector *qiov, size_t qiov_offset)
20d97356 4310{
ff99129a 4311 BDRVQcow2State *s = bs->opaque;
2714f13d 4312 int ret;
e1f4a37a 4313 ssize_t out_len;
fcccefc5 4314 uint8_t *buf, *out_buf;
77e023ff 4315 uint64_t cluster_offset;
20d97356 4316
0d483dce
AS
4317 assert(bytes == s->cluster_size || (bytes < s->cluster_size &&
4318 (offset + bytes == bs->total_sectors << BDRV_SECTOR_BITS)));
3e3b838f 4319
a2c0ca6f 4320 buf = qemu_blockalign(bs, s->cluster_size);
0d483dce 4321 if (bytes < s->cluster_size) {
a2c0ca6f
PB
4322 /* Zero-pad last write if image size is not cluster aligned */
4323 memset(buf + bytes, 0, s->cluster_size - bytes);
f4d38bef 4324 }
5396234b 4325 qemu_iovec_to_buf(qiov, qiov_offset, buf, bytes);
20d97356 4326
ebf7bba0 4327 out_buf = g_malloc(s->cluster_size);
20d97356 4328
6994fd78
VSO
4329 out_len = qcow2_co_compress(bs, out_buf, s->cluster_size - 1,
4330 buf, s->cluster_size);
e1f4a37a 4331 if (out_len == -ENOMEM) {
20d97356 4332 /* could not compress: write normal cluster */
5396234b 4333 ret = qcow2_co_pwritev_part(bs, offset, bytes, qiov, qiov_offset, 0);
8f1efd00
KW
4334 if (ret < 0) {
4335 goto fail;
4336 }
fcccefc5 4337 goto success;
e1f4a37a
AG
4338 } else if (out_len < 0) {
4339 ret = -EINVAL;
4340 goto fail;
fcccefc5 4341 }
cf93980e 4342
fcccefc5 4343 qemu_co_mutex_lock(&s->lock);
77e023ff
KW
4344 ret = qcow2_alloc_compressed_cluster_offset(bs, offset, out_len,
4345 &cluster_offset);
4346 if (ret < 0) {
fcccefc5 4347 qemu_co_mutex_unlock(&s->lock);
fcccefc5
PB
4348 goto fail;
4349 }
cf93980e 4350
966b000f 4351 ret = qcow2_pre_write_overlap_check(bs, 0, cluster_offset, out_len, true);
fcccefc5
PB
4352 qemu_co_mutex_unlock(&s->lock);
4353 if (ret < 0) {
4354 goto fail;
20d97356
BS
4355 }
4356
966b000f 4357 BLKDBG_EVENT(s->data_file, BLKDBG_WRITE_COMPRESSED);
b00cb15b 4358 ret = bdrv_co_pwrite(s->data_file, cluster_offset, out_len, out_buf, 0);
fcccefc5
PB
4359 if (ret < 0) {
4360 goto fail;
4361 }
4362success:
8f1efd00
KW
4363 ret = 0;
4364fail:
fcccefc5 4365 qemu_vfree(buf);
7267c094 4366 g_free(out_buf);
8f1efd00 4367 return ret;
20d97356
BS
4368}
4369
0d483dce
AS
4370static coroutine_fn int qcow2_co_pwritev_compressed_task_entry(AioTask *task)
4371{
4372 Qcow2AioTask *t = container_of(task, Qcow2AioTask, task);
4373
4374 assert(!t->cluster_type && !t->l2meta);
4375
4376 return qcow2_co_pwritev_compressed_task(t->bs, t->offset, t->bytes, t->qiov,
4377 t->qiov_offset);
4378}
4379
4380/*
4381 * XXX: put compressed sectors first, then all the cluster aligned
4382 * tables to avoid losing bytes in alignment
4383 */
4384static coroutine_fn int
4385qcow2_co_pwritev_compressed_part(BlockDriverState *bs,
4386 uint64_t offset, uint64_t bytes,
4387 QEMUIOVector *qiov, size_t qiov_offset)
4388{
4389 BDRVQcow2State *s = bs->opaque;
4390 AioTaskPool *aio = NULL;
4391 int ret = 0;
4392
4393 if (has_data_file(bs)) {
4394 return -ENOTSUP;
4395 }
4396
4397 if (bytes == 0) {
4398 /*
4399 * align end of file to a sector boundary to ease reading with
4400 * sector based I/Os
4401 */
4402 int64_t len = bdrv_getlength(bs->file->bs);
4403 if (len < 0) {
4404 return len;
4405 }
7b8e4857
KW
4406 return bdrv_co_truncate(bs->file, len, false, PREALLOC_MODE_OFF, 0,
4407 NULL);
0d483dce
AS
4408 }
4409
4410 if (offset_into_cluster(s, offset)) {
4411 return -EINVAL;
4412 }
4413
fb43d2d4
AG
4414 if (offset_into_cluster(s, bytes) &&
4415 (offset + bytes) != (bs->total_sectors << BDRV_SECTOR_BITS)) {
4416 return -EINVAL;
4417 }
4418
0d483dce
AS
4419 while (bytes && aio_task_pool_status(aio) == 0) {
4420 uint64_t chunk_size = MIN(bytes, s->cluster_size);
4421
4422 if (!aio && chunk_size != bytes) {
4423 aio = aio_task_pool_new(QCOW2_MAX_WORKERS);
4424 }
4425
4426 ret = qcow2_add_task(bs, aio, qcow2_co_pwritev_compressed_task_entry,
4427 0, 0, offset, chunk_size, qiov, qiov_offset, NULL);
4428 if (ret < 0) {
4429 break;
4430 }
4431 qiov_offset += chunk_size;
4432 offset += chunk_size;
4433 bytes -= chunk_size;
4434 }
4435
4436 if (aio) {
4437 aio_task_pool_wait_all(aio);
4438 if (ret == 0) {
4439 ret = aio_task_pool_status(aio);
4440 }
4441 g_free(aio);
4442 }
4443
4444 return ret;
4445}
4446
c3c10f72
VSO
4447static int coroutine_fn
4448qcow2_co_preadv_compressed(BlockDriverState *bs,
4449 uint64_t file_cluster_offset,
4450 uint64_t offset,
4451 uint64_t bytes,
df893d25
VSO
4452 QEMUIOVector *qiov,
4453 size_t qiov_offset)
f4b3e2a9
VSO
4454{
4455 BDRVQcow2State *s = bs->opaque;
c3c10f72 4456 int ret = 0, csize, nb_csectors;
f4b3e2a9 4457 uint64_t coffset;
c3c10f72 4458 uint8_t *buf, *out_buf;
c3c10f72 4459 int offset_in_cluster = offset_into_cluster(s, offset);
f4b3e2a9 4460
c3c10f72
VSO
4461 coffset = file_cluster_offset & s->cluster_offset_mask;
4462 nb_csectors = ((file_cluster_offset >> s->csize_shift) & s->csize_mask) + 1;
b6c24694
AG
4463 csize = nb_csectors * QCOW2_COMPRESSED_SECTOR_SIZE -
4464 (coffset & ~QCOW2_COMPRESSED_SECTOR_MASK);
f4b3e2a9 4465
c3c10f72
VSO
4466 buf = g_try_malloc(csize);
4467 if (!buf) {
4468 return -ENOMEM;
4469 }
f4b3e2a9 4470
c3c10f72 4471 out_buf = qemu_blockalign(bs, s->cluster_size);
c068a1cd 4472
c3c10f72 4473 BLKDBG_EVENT(bs->file, BLKDBG_READ_COMPRESSED);
b00cb15b 4474 ret = bdrv_co_pread(bs->file, coffset, csize, buf, 0);
c3c10f72
VSO
4475 if (ret < 0) {
4476 goto fail;
f4b3e2a9 4477 }
c3c10f72 4478
e23c9d7a 4479 if (qcow2_co_decompress(bs, out_buf, s->cluster_size, buf, csize) < 0) {
c3c10f72
VSO
4480 ret = -EIO;
4481 goto fail;
4482 }
4483
df893d25 4484 qemu_iovec_from_buf(qiov, qiov_offset, out_buf + offset_in_cluster, bytes);
c3c10f72
VSO
4485
4486fail:
4487 qemu_vfree(out_buf);
4488 g_free(buf);
4489
4490 return ret;
f4b3e2a9
VSO
4491}
4492
94054183
HR
4493static int make_completely_empty(BlockDriverState *bs)
4494{
ff99129a 4495 BDRVQcow2State *s = bs->opaque;
ed3d2ec9 4496 Error *local_err = NULL;
94054183
HR
4497 int ret, l1_clusters;
4498 int64_t offset;
4499 uint64_t *new_reftable = NULL;
4500 uint64_t rt_entry, l1_size2;
4501 struct {
4502 uint64_t l1_offset;
4503 uint64_t reftable_offset;
4504 uint32_t reftable_clusters;
4505 } QEMU_PACKED l1_ofs_rt_ofs_cls;
4506
4507 ret = qcow2_cache_empty(bs, s->l2_table_cache);
4508 if (ret < 0) {
4509 goto fail;
4510 }
4511
4512 ret = qcow2_cache_empty(bs, s->refcount_block_cache);
4513 if (ret < 0) {
4514 goto fail;
4515 }
4516
4517 /* Refcounts will be broken utterly */
4518 ret = qcow2_mark_dirty(bs);
4519 if (ret < 0) {
4520 goto fail;
4521 }
4522
4523 BLKDBG_EVENT(bs->file, BLKDBG_L1_UPDATE);
4524
4525 l1_clusters = DIV_ROUND_UP(s->l1_size, s->cluster_size / sizeof(uint64_t));
4526 l1_size2 = (uint64_t)s->l1_size * sizeof(uint64_t);
4527
4528 /* After this call, neither the in-memory nor the on-disk refcount
4529 * information accurately describe the actual references */
4530
720ff280 4531 ret = bdrv_pwrite_zeroes(bs->file, s->l1_table_offset,
74021bc4 4532 l1_clusters * s->cluster_size, 0);
94054183
HR
4533 if (ret < 0) {
4534 goto fail_broken_refcounts;
4535 }
4536 memset(s->l1_table, 0, l1_size2);
4537
4538 BLKDBG_EVENT(bs->file, BLKDBG_EMPTY_IMAGE_PREPARE);
4539
4540 /* Overwrite enough clusters at the beginning of the sectors to place
4541 * the refcount table, a refcount block and the L1 table in; this may
4542 * overwrite parts of the existing refcount and L1 table, which is not
4543 * an issue because the dirty flag is set, complete data loss is in fact
4544 * desired and partial data loss is consequently fine as well */
720ff280 4545 ret = bdrv_pwrite_zeroes(bs->file, s->cluster_size,
74021bc4 4546 (2 + l1_clusters) * s->cluster_size, 0);
94054183
HR
4547 /* This call (even if it failed overall) may have overwritten on-disk
4548 * refcount structures; in that case, the in-memory refcount information
4549 * will probably differ from the on-disk information which makes the BDS
4550 * unusable */
4551 if (ret < 0) {
4552 goto fail_broken_refcounts;
4553 }
4554
4555 BLKDBG_EVENT(bs->file, BLKDBG_L1_UPDATE);
4556 BLKDBG_EVENT(bs->file, BLKDBG_REFTABLE_UPDATE);
4557
4558 /* "Create" an empty reftable (one cluster) directly after the image
4559 * header and an empty L1 table three clusters after the image header;
4560 * the cluster between those two will be used as the first refblock */
f1f7a1dd
PM
4561 l1_ofs_rt_ofs_cls.l1_offset = cpu_to_be64(3 * s->cluster_size);
4562 l1_ofs_rt_ofs_cls.reftable_offset = cpu_to_be64(s->cluster_size);
4563 l1_ofs_rt_ofs_cls.reftable_clusters = cpu_to_be32(1);
d9ca2ea2 4564 ret = bdrv_pwrite_sync(bs->file, offsetof(QCowHeader, l1_table_offset),
94054183
HR
4565 &l1_ofs_rt_ofs_cls, sizeof(l1_ofs_rt_ofs_cls));
4566 if (ret < 0) {
4567 goto fail_broken_refcounts;
4568 }
4569
4570 s->l1_table_offset = 3 * s->cluster_size;
4571
4572 new_reftable = g_try_new0(uint64_t, s->cluster_size / sizeof(uint64_t));
4573 if (!new_reftable) {
4574 ret = -ENOMEM;
4575 goto fail_broken_refcounts;
4576 }
4577
4578 s->refcount_table_offset = s->cluster_size;
4579 s->refcount_table_size = s->cluster_size / sizeof(uint64_t);
7061a078 4580 s->max_refcount_table_index = 0;
94054183
HR
4581
4582 g_free(s->refcount_table);
4583 s->refcount_table = new_reftable;
4584 new_reftable = NULL;
4585
4586 /* Now the in-memory refcount information again corresponds to the on-disk
4587 * information (reftable is empty and no refblocks (the refblock cache is
4588 * empty)); however, this means some clusters (e.g. the image header) are
4589 * referenced, but not refcounted, but the normal qcow2 code assumes that
4590 * the in-memory information is always correct */
4591
4592 BLKDBG_EVENT(bs->file, BLKDBG_REFBLOCK_ALLOC);
4593
4594 /* Enter the first refblock into the reftable */
4595 rt_entry = cpu_to_be64(2 * s->cluster_size);
d9ca2ea2 4596 ret = bdrv_pwrite_sync(bs->file, s->cluster_size,
94054183
HR
4597 &rt_entry, sizeof(rt_entry));
4598 if (ret < 0) {
4599 goto fail_broken_refcounts;
4600 }
4601 s->refcount_table[0] = 2 * s->cluster_size;
4602
4603 s->free_cluster_index = 0;
4604 assert(3 + l1_clusters <= s->refcount_block_size);
4605 offset = qcow2_alloc_clusters(bs, 3 * s->cluster_size + l1_size2);
4606 if (offset < 0) {
4607 ret = offset;
4608 goto fail_broken_refcounts;
4609 } else if (offset > 0) {
4610 error_report("First cluster in emptied image is in use");
4611 abort();
4612 }
4613
4614 /* Now finally the in-memory information corresponds to the on-disk
4615 * structures and is correct */
4616 ret = qcow2_mark_clean(bs);
4617 if (ret < 0) {
4618 goto fail;
4619 }
4620
c80d8b06 4621 ret = bdrv_truncate(bs->file, (3 + l1_clusters) * s->cluster_size, false,
7b8e4857 4622 PREALLOC_MODE_OFF, 0, &local_err);
94054183 4623 if (ret < 0) {
ed3d2ec9 4624 error_report_err(local_err);
94054183
HR
4625 goto fail;
4626 }
4627
4628 return 0;
4629
4630fail_broken_refcounts:
4631 /* The BDS is unusable at this point. If we wanted to make it usable, we
4632 * would have to call qcow2_refcount_close(), qcow2_refcount_init(),
4633 * qcow2_check_refcounts(), qcow2_refcount_close() and qcow2_refcount_init()
4634 * again. However, because the functions which could have caused this error
4635 * path to be taken are used by those functions as well, it's very likely
4636 * that that sequence will fail as well. Therefore, just eject the BDS. */
4637 bs->drv = NULL;
4638
4639fail:
4640 g_free(new_reftable);
4641 return ret;
4642}
4643
491d27e2
HR
4644static int qcow2_make_empty(BlockDriverState *bs)
4645{
ff99129a 4646 BDRVQcow2State *s = bs->opaque;
d2cb36af
EB
4647 uint64_t offset, end_offset;
4648 int step = QEMU_ALIGN_DOWN(INT_MAX, s->cluster_size);
94054183
HR
4649 int l1_clusters, ret = 0;
4650
4651 l1_clusters = DIV_ROUND_UP(s->l1_size, s->cluster_size / sizeof(uint64_t));
4652
4096974e 4653 if (s->qcow_version >= 3 && !s->snapshots && !s->nb_bitmaps &&
f0603329 4654 3 + l1_clusters <= s->refcount_block_size &&
db04524f
KW
4655 s->crypt_method_header != QCOW_CRYPT_LUKS &&
4656 !has_data_file(bs)) {
4096974e
EB
4657 /* The following function only works for qcow2 v3 images (it
4658 * requires the dirty flag) and only as long as there are no
4659 * features that reserve extra clusters (such as snapshots,
4660 * LUKS header, or persistent bitmaps), because it completely
4661 * empties the image. Furthermore, the L1 table and three
4662 * additional clusters (image header, refcount table, one
db04524f
KW
4663 * refcount block) have to fit inside one refcount block. It
4664 * only resets the image file, i.e. does not work with an
4665 * external data file. */
94054183
HR
4666 return make_completely_empty(bs);
4667 }
491d27e2 4668
94054183
HR
4669 /* This fallback code simply discards every active cluster; this is slow,
4670 * but works in all cases */
d2cb36af
EB
4671 end_offset = bs->total_sectors * BDRV_SECTOR_SIZE;
4672 for (offset = 0; offset < end_offset; offset += step) {
491d27e2
HR
4673 /* As this function is generally used after committing an external
4674 * snapshot, QCOW2_DISCARD_SNAPSHOT seems appropriate. Also, the
4675 * default action for this kind of discard is to pass the discard,
4676 * which will ideally result in an actually smaller image file, as
4677 * is probably desired. */
d2cb36af
EB
4678 ret = qcow2_cluster_discard(bs, offset, MIN(step, end_offset - offset),
4679 QCOW2_DISCARD_SNAPSHOT, true);
491d27e2
HR
4680 if (ret < 0) {
4681 break;
4682 }
4683 }
4684
4685 return ret;
4686}
4687
a968168c 4688static coroutine_fn int qcow2_co_flush_to_os(BlockDriverState *bs)
20d97356 4689{
ff99129a 4690 BDRVQcow2State *s = bs->opaque;
29c1a730
KW
4691 int ret;
4692
8b94ff85 4693 qemu_co_mutex_lock(&s->lock);
8b220eb7 4694 ret = qcow2_write_caches(bs);
8b94ff85 4695 qemu_co_mutex_unlock(&s->lock);
29c1a730 4696
8b220eb7 4697 return ret;
eb489bb1
KW
4698}
4699
c501c352
SH
4700static BlockMeasureInfo *qcow2_measure(QemuOpts *opts, BlockDriverState *in_bs,
4701 Error **errp)
4702{
4703 Error *local_err = NULL;
4704 BlockMeasureInfo *info;
4705 uint64_t required = 0; /* bytes that contribute to required size */
4706 uint64_t virtual_size; /* disk size as seen by guest */
4707 uint64_t refcount_bits;
4708 uint64_t l2_tables;
61914f89 4709 uint64_t luks_payload_size = 0;
c501c352
SH
4710 size_t cluster_size;
4711 int version;
4712 char *optstr;
4713 PreallocMode prealloc;
4714 bool has_backing_file;
61914f89 4715 bool has_luks;
c501c352
SH
4716
4717 /* Parse image creation options */
4718 cluster_size = qcow2_opt_get_cluster_size_del(opts, &local_err);
4719 if (local_err) {
4720 goto err;
4721 }
4722
4723 version = qcow2_opt_get_version_del(opts, &local_err);
4724 if (local_err) {
4725 goto err;
4726 }
4727
4728 refcount_bits = qcow2_opt_get_refcount_bits_del(opts, version, &local_err);
4729 if (local_err) {
4730 goto err;
4731 }
4732
4733 optstr = qemu_opt_get_del(opts, BLOCK_OPT_PREALLOC);
f7abe0ec 4734 prealloc = qapi_enum_parse(&PreallocMode_lookup, optstr,
06c60b6c 4735 PREALLOC_MODE_OFF, &local_err);
c501c352
SH
4736 g_free(optstr);
4737 if (local_err) {
4738 goto err;
4739 }
4740
4741 optstr = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FILE);
4742 has_backing_file = !!optstr;
4743 g_free(optstr);
4744
61914f89
SH
4745 optstr = qemu_opt_get_del(opts, BLOCK_OPT_ENCRYPT_FORMAT);
4746 has_luks = optstr && strcmp(optstr, "luks") == 0;
4747 g_free(optstr);
4748
4749 if (has_luks) {
6d49d3a8
SH
4750 g_autoptr(QCryptoBlockCreateOptions) create_opts = NULL;
4751 QDict *opts_qdict;
4752 QDict *cryptoopts;
61914f89
SH
4753 size_t headerlen;
4754
6d49d3a8
SH
4755 opts_qdict = qemu_opts_to_qdict(opts, NULL);
4756 qdict_extract_subqdict(opts_qdict, &cryptoopts, "encrypt.");
4757 qobject_unref(opts_qdict);
4758
4759 qdict_put_str(cryptoopts, "format", "luks");
4760
4761 create_opts = block_crypto_create_opts_init(cryptoopts, errp);
4762 qobject_unref(cryptoopts);
4763 if (!create_opts) {
4764 goto err;
4765 }
4766
4767 if (!qcrypto_block_calculate_payload_offset(create_opts,
4768 "encrypt.",
4769 &headerlen,
4770 &local_err)) {
61914f89
SH
4771 goto err;
4772 }
4773
4774 luks_payload_size = ROUND_UP(headerlen, cluster_size);
4775 }
4776
9e029689
AG
4777 virtual_size = qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0);
4778 virtual_size = ROUND_UP(virtual_size, cluster_size);
c501c352
SH
4779
4780 /* Check that virtual disk size is valid */
4781 l2_tables = DIV_ROUND_UP(virtual_size / cluster_size,
4782 cluster_size / sizeof(uint64_t));
4783 if (l2_tables * sizeof(uint64_t) > QCOW_MAX_L1_SIZE) {
4784 error_setg(&local_err, "The image size is too large "
4785 "(try using a larger cluster size)");
4786 goto err;
4787 }
4788
4789 /* Account for input image */
4790 if (in_bs) {
4791 int64_t ssize = bdrv_getlength(in_bs);
4792 if (ssize < 0) {
4793 error_setg_errno(&local_err, -ssize,
4794 "Unable to get image virtual_size");
4795 goto err;
4796 }
4797
9e029689 4798 virtual_size = ROUND_UP(ssize, cluster_size);
c501c352
SH
4799
4800 if (has_backing_file) {
4801 /* We don't how much of the backing chain is shared by the input
4802 * image and the new image file. In the worst case the new image's
4803 * backing file has nothing in common with the input image. Be
4804 * conservative and assume all clusters need to be written.
4805 */
4806 required = virtual_size;
4807 } else {
b85ee453 4808 int64_t offset;
31826642 4809 int64_t pnum = 0;
c501c352 4810
31826642
EB
4811 for (offset = 0; offset < ssize; offset += pnum) {
4812 int ret;
c501c352 4813
31826642
EB
4814 ret = bdrv_block_status_above(in_bs, NULL, offset,
4815 ssize - offset, &pnum, NULL,
4816 NULL);
c501c352
SH
4817 if (ret < 0) {
4818 error_setg_errno(&local_err, -ret,
4819 "Unable to get block status");
4820 goto err;
4821 }
4822
4823 if (ret & BDRV_BLOCK_ZERO) {
4824 /* Skip zero regions (safe with no backing file) */
4825 } else if ((ret & (BDRV_BLOCK_DATA | BDRV_BLOCK_ALLOCATED)) ==
4826 (BDRV_BLOCK_DATA | BDRV_BLOCK_ALLOCATED)) {
4827 /* Extend pnum to end of cluster for next iteration */
31826642 4828 pnum = ROUND_UP(offset + pnum, cluster_size) - offset;
c501c352
SH
4829
4830 /* Count clusters we've seen */
31826642 4831 required += offset % cluster_size + pnum;
c501c352
SH
4832 }
4833 }
4834 }
4835 }
4836
4837 /* Take into account preallocation. Nothing special is needed for
4838 * PREALLOC_MODE_METADATA since metadata is always counted.
4839 */
4840 if (prealloc == PREALLOC_MODE_FULL || prealloc == PREALLOC_MODE_FALLOC) {
4841 required = virtual_size;
4842 }
4843
4844 info = g_new(BlockMeasureInfo, 1);
4845 info->fully_allocated =
4846 qcow2_calc_prealloc_size(virtual_size, cluster_size,
61914f89 4847 ctz32(refcount_bits)) + luks_payload_size;
c501c352
SH
4848
4849 /* Remove data clusters that are not required. This overestimates the
4850 * required size because metadata needed for the fully allocated file is
4851 * still counted.
4852 */
4853 info->required = info->fully_allocated - virtual_size + required;
4854 return info;
4855
4856err:
4857 error_propagate(errp, local_err);
4858 return NULL;
4859}
4860
7c80ab3f 4861static int qcow2_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
20d97356 4862{
ff99129a 4863 BDRVQcow2State *s = bs->opaque;
95de6d70 4864 bdi->unallocated_blocks_are_zero = true;
20d97356 4865 bdi->cluster_size = s->cluster_size;
7c80ab3f 4866 bdi->vm_state_offset = qcow2_vm_state_offset(s);
20d97356
BS
4867 return 0;
4868}
4869
1bf6e9ca
AS
4870static ImageInfoSpecific *qcow2_get_specific_info(BlockDriverState *bs,
4871 Error **errp)
37764dfb 4872{
ff99129a 4873 BDRVQcow2State *s = bs->opaque;
0a12f6f8
DB
4874 ImageInfoSpecific *spec_info;
4875 QCryptoBlockInfo *encrypt_info = NULL;
1bf6e9ca 4876 Error *local_err = NULL;
37764dfb 4877
0a12f6f8 4878 if (s->crypto != NULL) {
1bf6e9ca
AS
4879 encrypt_info = qcrypto_block_get_info(s->crypto, &local_err);
4880 if (local_err) {
4881 error_propagate(errp, local_err);
4882 return NULL;
4883 }
0a12f6f8
DB
4884 }
4885
4886 spec_info = g_new(ImageInfoSpecific, 1);
37764dfb 4887 *spec_info = (ImageInfoSpecific){
6a8f9661 4888 .type = IMAGE_INFO_SPECIFIC_KIND_QCOW2,
b8968c87 4889 .u.qcow2.data = g_new0(ImageInfoSpecificQCow2, 1),
37764dfb
HR
4890 };
4891 if (s->qcow_version == 2) {
32bafa8f 4892 *spec_info->u.qcow2.data = (ImageInfoSpecificQCow2){
0709c5a1
HR
4893 .compat = g_strdup("0.10"),
4894 .refcount_bits = s->refcount_bits,
37764dfb
HR
4895 };
4896 } else if (s->qcow_version == 3) {
b8968c87
AS
4897 Qcow2BitmapInfoList *bitmaps;
4898 bitmaps = qcow2_get_bitmap_info_list(bs, &local_err);
4899 if (local_err) {
4900 error_propagate(errp, local_err);
4901 qapi_free_ImageInfoSpecific(spec_info);
71eaec2e 4902 qapi_free_QCryptoBlockInfo(encrypt_info);
b8968c87
AS
4903 return NULL;
4904 }
32bafa8f 4905 *spec_info->u.qcow2.data = (ImageInfoSpecificQCow2){
37764dfb
HR
4906 .compat = g_strdup("1.1"),
4907 .lazy_refcounts = s->compatible_features &
4908 QCOW2_COMPAT_LAZY_REFCOUNTS,
4909 .has_lazy_refcounts = true,
9009b196
HR
4910 .corrupt = s->incompatible_features &
4911 QCOW2_INCOMPAT_CORRUPT,
4912 .has_corrupt = true,
0709c5a1 4913 .refcount_bits = s->refcount_bits,
b8968c87
AS
4914 .has_bitmaps = !!bitmaps,
4915 .bitmaps = bitmaps,
9b890bdc
KW
4916 .has_data_file = !!s->image_data_file,
4917 .data_file = g_strdup(s->image_data_file),
6c3944dc
KW
4918 .has_data_file_raw = has_data_file(bs),
4919 .data_file_raw = data_file_is_raw(bs),
37764dfb 4920 };
b1fc8f93
DL
4921 } else {
4922 /* if this assertion fails, this probably means a new version was
4923 * added without having it covered here */
4924 assert(false);
37764dfb
HR
4925 }
4926
0a12f6f8
DB
4927 if (encrypt_info) {
4928 ImageInfoSpecificQCow2Encryption *qencrypt =
4929 g_new(ImageInfoSpecificQCow2Encryption, 1);
4930 switch (encrypt_info->format) {
4931 case Q_CRYPTO_BLOCK_FORMAT_QCOW:
4932 qencrypt->format = BLOCKDEV_QCOW2_ENCRYPTION_FORMAT_AES;
0a12f6f8
DB
4933 break;
4934 case Q_CRYPTO_BLOCK_FORMAT_LUKS:
4935 qencrypt->format = BLOCKDEV_QCOW2_ENCRYPTION_FORMAT_LUKS;
4936 qencrypt->u.luks = encrypt_info->u.luks;
4937 break;
4938 default:
4939 abort();
4940 }
4941 /* Since we did shallow copy above, erase any pointers
4942 * in the original info */
4943 memset(&encrypt_info->u, 0, sizeof(encrypt_info->u));
4944 qapi_free_QCryptoBlockInfo(encrypt_info);
4945
4946 spec_info->u.qcow2.data->has_encrypt = true;
4947 spec_info->u.qcow2.data->encrypt = qencrypt;
4948 }
4949
37764dfb
HR
4950 return spec_info;
4951}
4952
38841dcd
HR
4953static int qcow2_has_zero_init(BlockDriverState *bs)
4954{
4955 BDRVQcow2State *s = bs->opaque;
4956 bool preallocated;
4957
4958 if (qemu_in_coroutine()) {
4959 qemu_co_mutex_lock(&s->lock);
4960 }
4961 /*
4962 * Check preallocation status: Preallocated images have all L2
4963 * tables allocated, nonpreallocated images have none. It is
4964 * therefore enough to check the first one.
4965 */
4966 preallocated = s->l1_size > 0 && s->l1_table[0] != 0;
4967 if (qemu_in_coroutine()) {
4968 qemu_co_mutex_unlock(&s->lock);
4969 }
4970
4971 if (!preallocated) {
4972 return 1;
4973 } else if (bs->encrypted) {
4974 return 0;
4975 } else {
4976 return bdrv_has_zero_init(s->data_file->bs);
4977 }
4978}
4979
cf8074b3
KW
4980static int qcow2_save_vmstate(BlockDriverState *bs, QEMUIOVector *qiov,
4981 int64_t pos)
20d97356 4982{
ff99129a 4983 BDRVQcow2State *s = bs->opaque;
20d97356 4984
66f82cee 4985 BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_SAVE);
5396234b
VSO
4986 return bs->drv->bdrv_co_pwritev_part(bs, qcow2_vm_state_offset(s) + pos,
4987 qiov->size, qiov, 0, 0);
20d97356
BS
4988}
4989
5ddda0b8
KW
4990static int qcow2_load_vmstate(BlockDriverState *bs, QEMUIOVector *qiov,
4991 int64_t pos)
20d97356 4992{
ff99129a 4993 BDRVQcow2State *s = bs->opaque;
20d97356 4994
66f82cee 4995 BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_LOAD);
df893d25
VSO
4996 return bs->drv->bdrv_co_preadv_part(bs, qcow2_vm_state_offset(s) + pos,
4997 qiov->size, qiov, 0, 0);
20d97356
BS
4998}
4999
9296b3ed
HR
5000/*
5001 * Downgrades an image's version. To achieve this, any incompatible features
5002 * have to be removed.
5003 */
4057a2b2 5004static int qcow2_downgrade(BlockDriverState *bs, int target_version,
d1402b50
HR
5005 BlockDriverAmendStatusCB *status_cb, void *cb_opaque,
5006 Error **errp)
9296b3ed 5007{
ff99129a 5008 BDRVQcow2State *s = bs->opaque;
9296b3ed
HR
5009 int current_version = s->qcow_version;
5010 int ret;
7fa140ab 5011 int i;
9296b3ed 5012
d1402b50
HR
5013 /* This is qcow2_downgrade(), not qcow2_upgrade() */
5014 assert(target_version < current_version);
5015
5016 /* There are no other versions (now) that you can downgrade to */
5017 assert(target_version == 2);
9296b3ed
HR
5018
5019 if (s->refcount_order != 4) {
d1402b50 5020 error_setg(errp, "compat=0.10 requires refcount_bits=16");
9296b3ed
HR
5021 return -ENOTSUP;
5022 }
5023
966b000f
KW
5024 if (has_data_file(bs)) {
5025 error_setg(errp, "Cannot downgrade an image with a data file");
5026 return -ENOTSUP;
5027 }
5028
7fa140ab
EB
5029 /*
5030 * If any internal snapshot has a different size than the current
5031 * image size, or VM state size that exceeds 32 bits, downgrading
5032 * is unsafe. Even though we would still use v3-compliant output
5033 * to preserve that data, other v2 programs might not realize
5034 * those optional fields are important.
5035 */
5036 for (i = 0; i < s->nb_snapshots; i++) {
5037 if (s->snapshots[i].vm_state_size > UINT32_MAX ||
5038 s->snapshots[i].disk_size != bs->total_sectors * BDRV_SECTOR_SIZE) {
5039 error_setg(errp, "Internal snapshots prevent downgrade of image");
5040 return -ENOTSUP;
5041 }
5042 }
5043
9296b3ed
HR
5044 /* clear incompatible features */
5045 if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) {
5046 ret = qcow2_mark_clean(bs);
5047 if (ret < 0) {
d1402b50 5048 error_setg_errno(errp, -ret, "Failed to make the image clean");
9296b3ed
HR
5049 return ret;
5050 }
5051 }
5052
5053 /* with QCOW2_INCOMPAT_CORRUPT, it is pretty much impossible to get here in
5054 * the first place; if that happens nonetheless, returning -ENOTSUP is the
5055 * best thing to do anyway */
5056
5057 if (s->incompatible_features) {
d1402b50
HR
5058 error_setg(errp, "Cannot downgrade an image with incompatible features "
5059 "%#" PRIx64 " set", s->incompatible_features);
9296b3ed
HR
5060 return -ENOTSUP;
5061 }
5062
5063 /* since we can ignore compatible features, we can set them to 0 as well */
5064 s->compatible_features = 0;
5065 /* if lazy refcounts have been used, they have already been fixed through
5066 * clearing the dirty flag */
5067
5068 /* clearing autoclear features is trivial */
5069 s->autoclear_features = 0;
5070
8b13976d 5071 ret = qcow2_expand_zero_clusters(bs, status_cb, cb_opaque);
9296b3ed 5072 if (ret < 0) {
d1402b50 5073 error_setg_errno(errp, -ret, "Failed to turn zero into data clusters");
9296b3ed
HR
5074 return ret;
5075 }
5076
5077 s->qcow_version = target_version;
5078 ret = qcow2_update_header(bs);
5079 if (ret < 0) {
5080 s->qcow_version = current_version;
d1402b50 5081 error_setg_errno(errp, -ret, "Failed to update the image header");
9296b3ed
HR
5082 return ret;
5083 }
5084 return 0;
5085}
5086
722efb0c
HR
5087/*
5088 * Upgrades an image's version. While newer versions encompass all
5089 * features of older versions, some things may have to be presented
5090 * differently.
5091 */
5092static int qcow2_upgrade(BlockDriverState *bs, int target_version,
5093 BlockDriverAmendStatusCB *status_cb, void *cb_opaque,
5094 Error **errp)
5095{
5096 BDRVQcow2State *s = bs->opaque;
0a85af35 5097 bool need_snapshot_update;
722efb0c 5098 int current_version = s->qcow_version;
0a85af35 5099 int i;
722efb0c
HR
5100 int ret;
5101
5102 /* This is qcow2_upgrade(), not qcow2_downgrade() */
5103 assert(target_version > current_version);
5104
5105 /* There are no other versions (yet) that you can upgrade to */
5106 assert(target_version == 3);
5107
0a85af35
HR
5108 status_cb(bs, 0, 2, cb_opaque);
5109
5110 /*
5111 * In v2, snapshots do not need to have extra data. v3 requires
5112 * the 64-bit VM state size and the virtual disk size to be
5113 * present.
5114 * qcow2_write_snapshots() will always write the list in the
5115 * v3-compliant format.
5116 */
5117 need_snapshot_update = false;
5118 for (i = 0; i < s->nb_snapshots; i++) {
5119 if (s->snapshots[i].extra_data_size <
5120 sizeof_field(QCowSnapshotExtraData, vm_state_size_large) +
5121 sizeof_field(QCowSnapshotExtraData, disk_size))
5122 {
5123 need_snapshot_update = true;
5124 break;
5125 }
5126 }
5127 if (need_snapshot_update) {
5128 ret = qcow2_write_snapshots(bs);
5129 if (ret < 0) {
5130 error_setg_errno(errp, -ret, "Failed to update the snapshot table");
5131 return ret;
5132 }
5133 }
5134 status_cb(bs, 1, 2, cb_opaque);
722efb0c
HR
5135
5136 s->qcow_version = target_version;
5137 ret = qcow2_update_header(bs);
5138 if (ret < 0) {
5139 s->qcow_version = current_version;
5140 error_setg_errno(errp, -ret, "Failed to update the image header");
5141 return ret;
5142 }
0a85af35 5143 status_cb(bs, 2, 2, cb_opaque);
722efb0c
HR
5144
5145 return 0;
5146}
5147
c293a809
HR
5148typedef enum Qcow2AmendOperation {
5149 /* This is the value Qcow2AmendHelperCBInfo::last_operation will be
5150 * statically initialized to so that the helper CB can discern the first
5151 * invocation from an operation change */
5152 QCOW2_NO_OPERATION = 0,
5153
722efb0c 5154 QCOW2_UPGRADING,
61ce55fc 5155 QCOW2_CHANGING_REFCOUNT_ORDER,
c293a809
HR
5156 QCOW2_DOWNGRADING,
5157} Qcow2AmendOperation;
5158
5159typedef struct Qcow2AmendHelperCBInfo {
5160 /* The code coordinating the amend operations should only modify
5161 * these four fields; the rest will be managed by the CB */
5162 BlockDriverAmendStatusCB *original_status_cb;
5163 void *original_cb_opaque;
5164
5165 Qcow2AmendOperation current_operation;
5166
5167 /* Total number of operations to perform (only set once) */
5168 int total_operations;
5169
5170 /* The following fields are managed by the CB */
5171
5172 /* Number of operations completed */
5173 int operations_completed;
5174
5175 /* Cumulative offset of all completed operations */
5176 int64_t offset_completed;
5177
5178 Qcow2AmendOperation last_operation;
5179 int64_t last_work_size;
5180} Qcow2AmendHelperCBInfo;
5181
5182static void qcow2_amend_helper_cb(BlockDriverState *bs,
5183 int64_t operation_offset,
5184 int64_t operation_work_size, void *opaque)
5185{
5186 Qcow2AmendHelperCBInfo *info = opaque;
5187 int64_t current_work_size;
5188 int64_t projected_work_size;
5189
5190 if (info->current_operation != info->last_operation) {
5191 if (info->last_operation != QCOW2_NO_OPERATION) {
5192 info->offset_completed += info->last_work_size;
5193 info->operations_completed++;
5194 }
5195
5196 info->last_operation = info->current_operation;
5197 }
5198
5199 assert(info->total_operations > 0);
5200 assert(info->operations_completed < info->total_operations);
5201
5202 info->last_work_size = operation_work_size;
5203
5204 current_work_size = info->offset_completed + operation_work_size;
5205
5206 /* current_work_size is the total work size for (operations_completed + 1)
5207 * operations (which includes this one), so multiply it by the number of
5208 * operations not covered and divide it by the number of operations
5209 * covered to get a projection for the operations not covered */
5210 projected_work_size = current_work_size * (info->total_operations -
5211 info->operations_completed - 1)
5212 / (info->operations_completed + 1);
5213
5214 info->original_status_cb(bs, info->offset_completed + operation_offset,
5215 current_work_size + projected_work_size,
5216 info->original_cb_opaque);
5217}
5218
77485434 5219static int qcow2_amend_options(BlockDriverState *bs, QemuOpts *opts,
8b13976d 5220 BlockDriverAmendStatusCB *status_cb,
d1402b50
HR
5221 void *cb_opaque,
5222 Error **errp)
9296b3ed 5223{
ff99129a 5224 BDRVQcow2State *s = bs->opaque;
9296b3ed
HR
5225 int old_version = s->qcow_version, new_version = old_version;
5226 uint64_t new_size = 0;
9b890bdc 5227 const char *backing_file = NULL, *backing_format = NULL, *data_file = NULL;
9296b3ed 5228 bool lazy_refcounts = s->use_lazy_refcounts;
6c3944dc 5229 bool data_file_raw = data_file_is_raw(bs);
1bd0e2d1
CL
5230 const char *compat = NULL;
5231 uint64_t cluster_size = s->cluster_size;
5232 bool encrypt;
4652b8f3 5233 int encformat;
61ce55fc 5234 int refcount_bits = s->refcount_bits;
9296b3ed 5235 int ret;
1bd0e2d1 5236 QemuOptDesc *desc = opts->list->desc;
c293a809 5237 Qcow2AmendHelperCBInfo helper_cb_info;
9296b3ed 5238
1bd0e2d1
CL
5239 while (desc && desc->name) {
5240 if (!qemu_opt_find(opts, desc->name)) {
9296b3ed 5241 /* only change explicitly defined options */
1bd0e2d1 5242 desc++;
9296b3ed
HR
5243 continue;
5244 }
5245
8a17b83c
HR
5246 if (!strcmp(desc->name, BLOCK_OPT_COMPAT_LEVEL)) {
5247 compat = qemu_opt_get(opts, BLOCK_OPT_COMPAT_LEVEL);
1bd0e2d1 5248 if (!compat) {
9296b3ed 5249 /* preserve default */
f7077c98 5250 } else if (!strcmp(compat, "0.10") || !strcmp(compat, "v2")) {
9296b3ed 5251 new_version = 2;
f7077c98 5252 } else if (!strcmp(compat, "1.1") || !strcmp(compat, "v3")) {
9296b3ed
HR
5253 new_version = 3;
5254 } else {
d1402b50 5255 error_setg(errp, "Unknown compatibility level %s", compat);
9296b3ed
HR
5256 return -EINVAL;
5257 }
8a17b83c 5258 } else if (!strcmp(desc->name, BLOCK_OPT_PREALLOC)) {
d1402b50 5259 error_setg(errp, "Cannot change preallocation mode");
9296b3ed 5260 return -ENOTSUP;
8a17b83c
HR
5261 } else if (!strcmp(desc->name, BLOCK_OPT_SIZE)) {
5262 new_size = qemu_opt_get_size(opts, BLOCK_OPT_SIZE, 0);
5263 } else if (!strcmp(desc->name, BLOCK_OPT_BACKING_FILE)) {
5264 backing_file = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
5265 } else if (!strcmp(desc->name, BLOCK_OPT_BACKING_FMT)) {
5266 backing_format = qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT);
5267 } else if (!strcmp(desc->name, BLOCK_OPT_ENCRYPT)) {
5268 encrypt = qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT,
b25b387f 5269 !!s->crypto);
f6fa64f6 5270
b25b387f 5271 if (encrypt != !!s->crypto) {
d1402b50
HR
5272 error_setg(errp,
5273 "Changing the encryption flag is not supported");
9296b3ed
HR
5274 return -ENOTSUP;
5275 }
4652b8f3
DB
5276 } else if (!strcmp(desc->name, BLOCK_OPT_ENCRYPT_FORMAT)) {
5277 encformat = qcow2_crypt_method_from_format(
5278 qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT));
5279
5280 if (encformat != s->crypt_method_header) {
d1402b50
HR
5281 error_setg(errp,
5282 "Changing the encryption format is not supported");
4652b8f3
DB
5283 return -ENOTSUP;
5284 }
f66afbe2 5285 } else if (g_str_has_prefix(desc->name, "encrypt.")) {
d1402b50
HR
5286 error_setg(errp,
5287 "Changing the encryption parameters is not supported");
f66afbe2 5288 return -ENOTSUP;
8a17b83c
HR
5289 } else if (!strcmp(desc->name, BLOCK_OPT_CLUSTER_SIZE)) {
5290 cluster_size = qemu_opt_get_size(opts, BLOCK_OPT_CLUSTER_SIZE,
1bd0e2d1
CL
5291 cluster_size);
5292 if (cluster_size != s->cluster_size) {
d1402b50 5293 error_setg(errp, "Changing the cluster size is not supported");
9296b3ed
HR
5294 return -ENOTSUP;
5295 }
8a17b83c
HR
5296 } else if (!strcmp(desc->name, BLOCK_OPT_LAZY_REFCOUNTS)) {
5297 lazy_refcounts = qemu_opt_get_bool(opts, BLOCK_OPT_LAZY_REFCOUNTS,
1bd0e2d1 5298 lazy_refcounts);
06d05fa7 5299 } else if (!strcmp(desc->name, BLOCK_OPT_REFCOUNT_BITS)) {
61ce55fc
HR
5300 refcount_bits = qemu_opt_get_number(opts, BLOCK_OPT_REFCOUNT_BITS,
5301 refcount_bits);
5302
5303 if (refcount_bits <= 0 || refcount_bits > 64 ||
5304 !is_power_of_2(refcount_bits))
5305 {
d1402b50
HR
5306 error_setg(errp, "Refcount width must be a power of two and "
5307 "may not exceed 64 bits");
61ce55fc
HR
5308 return -EINVAL;
5309 }
9b890bdc
KW
5310 } else if (!strcmp(desc->name, BLOCK_OPT_DATA_FILE)) {
5311 data_file = qemu_opt_get(opts, BLOCK_OPT_DATA_FILE);
5312 if (data_file && !has_data_file(bs)) {
5313 error_setg(errp, "data-file can only be set for images that "
5314 "use an external data file");
5315 return -EINVAL;
5316 }
6c3944dc
KW
5317 } else if (!strcmp(desc->name, BLOCK_OPT_DATA_FILE_RAW)) {
5318 data_file_raw = qemu_opt_get_bool(opts, BLOCK_OPT_DATA_FILE_RAW,
5319 data_file_raw);
5320 if (data_file_raw && !data_file_is_raw(bs)) {
5321 error_setg(errp, "data-file-raw cannot be set on existing "
5322 "images");
5323 return -EINVAL;
5324 }
9296b3ed 5325 } else {
164e0f89 5326 /* if this point is reached, this probably means a new option was
9296b3ed 5327 * added without having it covered here */
164e0f89 5328 abort();
9296b3ed 5329 }
1bd0e2d1
CL
5330
5331 desc++;
9296b3ed
HR
5332 }
5333
c293a809
HR
5334 helper_cb_info = (Qcow2AmendHelperCBInfo){
5335 .original_status_cb = status_cb,
5336 .original_cb_opaque = cb_opaque,
722efb0c 5337 .total_operations = (new_version != old_version)
61ce55fc 5338 + (s->refcount_bits != refcount_bits)
c293a809
HR
5339 };
5340
1038bbb8
HR
5341 /* Upgrade first (some features may require compat=1.1) */
5342 if (new_version > old_version) {
722efb0c
HR
5343 helper_cb_info.current_operation = QCOW2_UPGRADING;
5344 ret = qcow2_upgrade(bs, new_version, &qcow2_amend_helper_cb,
5345 &helper_cb_info, errp);
1038bbb8 5346 if (ret < 0) {
1038bbb8 5347 return ret;
9296b3ed
HR
5348 }
5349 }
5350
61ce55fc
HR
5351 if (s->refcount_bits != refcount_bits) {
5352 int refcount_order = ctz32(refcount_bits);
61ce55fc
HR
5353
5354 if (new_version < 3 && refcount_bits != 16) {
d1402b50
HR
5355 error_setg(errp, "Refcount widths other than 16 bits require "
5356 "compatibility level 1.1 or above (use compat=1.1 or "
5357 "greater)");
61ce55fc
HR
5358 return -EINVAL;
5359 }
5360
5361 helper_cb_info.current_operation = QCOW2_CHANGING_REFCOUNT_ORDER;
5362 ret = qcow2_change_refcount_order(bs, refcount_order,
5363 &qcow2_amend_helper_cb,
d1402b50 5364 &helper_cb_info, errp);
61ce55fc 5365 if (ret < 0) {
61ce55fc
HR
5366 return ret;
5367 }
5368 }
5369
6c3944dc
KW
5370 /* data-file-raw blocks backing files, so clear it first if requested */
5371 if (data_file_raw) {
5372 s->autoclear_features |= QCOW2_AUTOCLEAR_DATA_FILE_RAW;
5373 } else {
5374 s->autoclear_features &= ~QCOW2_AUTOCLEAR_DATA_FILE_RAW;
5375 }
5376
9b890bdc
KW
5377 if (data_file) {
5378 g_free(s->image_data_file);
5379 s->image_data_file = *data_file ? g_strdup(data_file) : NULL;
5380 }
5381
5382 ret = qcow2_update_header(bs);
5383 if (ret < 0) {
5384 error_setg_errno(errp, -ret, "Failed to update the image header");
5385 return ret;
5386 }
5387
9296b3ed 5388 if (backing_file || backing_format) {
e4603fe1
KW
5389 ret = qcow2_change_backing_file(bs,
5390 backing_file ?: s->image_backing_file,
5391 backing_format ?: s->image_backing_format);
9296b3ed 5392 if (ret < 0) {
d1402b50 5393 error_setg_errno(errp, -ret, "Failed to change the backing file");
9296b3ed
HR
5394 return ret;
5395 }
5396 }
5397
5398 if (s->use_lazy_refcounts != lazy_refcounts) {
5399 if (lazy_refcounts) {
1038bbb8 5400 if (new_version < 3) {
d1402b50
HR
5401 error_setg(errp, "Lazy refcounts only supported with "
5402 "compatibility level 1.1 and above (use compat=1.1 "
5403 "or greater)");
9296b3ed
HR
5404 return -EINVAL;
5405 }
5406 s->compatible_features |= QCOW2_COMPAT_LAZY_REFCOUNTS;
5407 ret = qcow2_update_header(bs);
5408 if (ret < 0) {
5409 s->compatible_features &= ~QCOW2_COMPAT_LAZY_REFCOUNTS;
d1402b50 5410 error_setg_errno(errp, -ret, "Failed to update the image header");
9296b3ed
HR
5411 return ret;
5412 }
5413 s->use_lazy_refcounts = true;
5414 } else {
5415 /* make image clean first */
5416 ret = qcow2_mark_clean(bs);
5417 if (ret < 0) {
d1402b50 5418 error_setg_errno(errp, -ret, "Failed to make the image clean");
9296b3ed
HR
5419 return ret;
5420 }
5421 /* now disallow lazy refcounts */
5422 s->compatible_features &= ~QCOW2_COMPAT_LAZY_REFCOUNTS;
5423 ret = qcow2_update_header(bs);
5424 if (ret < 0) {
5425 s->compatible_features |= QCOW2_COMPAT_LAZY_REFCOUNTS;
d1402b50 5426 error_setg_errno(errp, -ret, "Failed to update the image header");
9296b3ed
HR
5427 return ret;
5428 }
5429 s->use_lazy_refcounts = false;
5430 }
5431 }
5432
5433 if (new_size) {
a3aeeab5
EB
5434 BlockBackend *blk = blk_new_with_bs(bs, BLK_PERM_RESIZE, BLK_PERM_ALL,
5435 errp);
5436 if (!blk) {
5437 return -EPERM;
d7086422
KW
5438 }
5439
e8d04f92
HR
5440 /*
5441 * Amending image options should ensure that the image has
5442 * exactly the given new values, so pass exact=true here.
5443 */
8c6242b6 5444 ret = blk_truncate(blk, new_size, true, PREALLOC_MODE_OFF, 0, errp);
70b27f36 5445 blk_unref(blk);
9296b3ed
HR
5446 if (ret < 0) {
5447 return ret;
5448 }
5449 }
5450
1038bbb8
HR
5451 /* Downgrade last (so unsupported features can be removed before) */
5452 if (new_version < old_version) {
c293a809
HR
5453 helper_cb_info.current_operation = QCOW2_DOWNGRADING;
5454 ret = qcow2_downgrade(bs, new_version, &qcow2_amend_helper_cb,
d1402b50 5455 &helper_cb_info, errp);
1038bbb8
HR
5456 if (ret < 0) {
5457 return ret;
5458 }
5459 }
5460
9296b3ed
HR
5461 return 0;
5462}
5463
85186ebd
HR
5464/*
5465 * If offset or size are negative, respectively, they will not be included in
5466 * the BLOCK_IMAGE_CORRUPTED event emitted.
5467 * fatal will be ignored for read-only BDS; corruptions found there will always
5468 * be considered non-fatal.
5469 */
5470void qcow2_signal_corruption(BlockDriverState *bs, bool fatal, int64_t offset,
5471 int64_t size, const char *message_format, ...)
5472{
ff99129a 5473 BDRVQcow2State *s = bs->opaque;
dc881b44 5474 const char *node_name;
85186ebd
HR
5475 char *message;
5476 va_list ap;
5477
ddf3b47e 5478 fatal = fatal && bdrv_is_writable(bs);
85186ebd
HR
5479
5480 if (s->signaled_corruption &&
5481 (!fatal || (s->incompatible_features & QCOW2_INCOMPAT_CORRUPT)))
5482 {
5483 return;
5484 }
5485
5486 va_start(ap, message_format);
5487 message = g_strdup_vprintf(message_format, ap);
5488 va_end(ap);
5489
5490 if (fatal) {
5491 fprintf(stderr, "qcow2: Marking image as corrupt: %s; further "
5492 "corruption events will be suppressed\n", message);
5493 } else {
5494 fprintf(stderr, "qcow2: Image is corrupt: %s; further non-fatal "
5495 "corruption events will be suppressed\n", message);
5496 }
5497
dc881b44
AG
5498 node_name = bdrv_get_node_name(bs);
5499 qapi_event_send_block_image_corrupted(bdrv_get_device_name(bs),
5500 *node_name != '\0', node_name,
5501 message, offset >= 0, offset,
5502 size >= 0, size,
3ab72385 5503 fatal);
85186ebd
HR
5504 g_free(message);
5505
5506 if (fatal) {
5507 qcow2_mark_corrupt(bs);
5508 bs->drv = NULL; /* make BDS unusable */
5509 }
5510
5511 s->signaled_corruption = true;
5512}
5513
1bd0e2d1
CL
5514static QemuOptsList qcow2_create_opts = {
5515 .name = "qcow2-create-opts",
5516 .head = QTAILQ_HEAD_INITIALIZER(qcow2_create_opts.head),
5517 .desc = {
5518 {
5519 .name = BLOCK_OPT_SIZE,
5520 .type = QEMU_OPT_SIZE,
5521 .help = "Virtual disk size"
5522 },
5523 {
5524 .name = BLOCK_OPT_COMPAT_LEVEL,
5525 .type = QEMU_OPT_STRING,
f7077c98 5526 .help = "Compatibility level (v2 [0.10] or v3 [1.1])"
1bd0e2d1
CL
5527 },
5528 {
5529 .name = BLOCK_OPT_BACKING_FILE,
5530 .type = QEMU_OPT_STRING,
5531 .help = "File name of a base image"
5532 },
5533 {
5534 .name = BLOCK_OPT_BACKING_FMT,
5535 .type = QEMU_OPT_STRING,
5536 .help = "Image format of the base image"
5537 },
9b890bdc
KW
5538 {
5539 .name = BLOCK_OPT_DATA_FILE,
5540 .type = QEMU_OPT_STRING,
5541 .help = "File name of an external data file"
5542 },
6c3944dc
KW
5543 {
5544 .name = BLOCK_OPT_DATA_FILE_RAW,
5545 .type = QEMU_OPT_BOOL,
5546 .help = "The external data file must stay valid as a raw image"
5547 },
1bd0e2d1
CL
5548 {
5549 .name = BLOCK_OPT_ENCRYPT,
5550 .type = QEMU_OPT_BOOL,
0cb8d47b
DB
5551 .help = "Encrypt the image with format 'aes'. (Deprecated "
5552 "in favor of " BLOCK_OPT_ENCRYPT_FORMAT "=aes)",
5553 },
5554 {
5555 .name = BLOCK_OPT_ENCRYPT_FORMAT,
5556 .type = QEMU_OPT_STRING,
4652b8f3 5557 .help = "Encrypt the image, format choices: 'aes', 'luks'",
1bd0e2d1 5558 },
4652b8f3
DB
5559 BLOCK_CRYPTO_OPT_DEF_KEY_SECRET("encrypt.",
5560 "ID of secret providing qcow AES key or LUKS passphrase"),
5561 BLOCK_CRYPTO_OPT_DEF_LUKS_CIPHER_ALG("encrypt."),
5562 BLOCK_CRYPTO_OPT_DEF_LUKS_CIPHER_MODE("encrypt."),
5563 BLOCK_CRYPTO_OPT_DEF_LUKS_IVGEN_ALG("encrypt."),
5564 BLOCK_CRYPTO_OPT_DEF_LUKS_IVGEN_HASH_ALG("encrypt."),
5565 BLOCK_CRYPTO_OPT_DEF_LUKS_HASH_ALG("encrypt."),
5566 BLOCK_CRYPTO_OPT_DEF_LUKS_ITER_TIME("encrypt."),
1bd0e2d1
CL
5567 {
5568 .name = BLOCK_OPT_CLUSTER_SIZE,
5569 .type = QEMU_OPT_SIZE,
5570 .help = "qcow2 cluster size",
5571 .def_value_str = stringify(DEFAULT_CLUSTER_SIZE)
5572 },
5573 {
5574 .name = BLOCK_OPT_PREALLOC,
5575 .type = QEMU_OPT_STRING,
0e4271b7
HT
5576 .help = "Preallocation mode (allowed values: off, metadata, "
5577 "falloc, full)"
1bd0e2d1
CL
5578 },
5579 {
5580 .name = BLOCK_OPT_LAZY_REFCOUNTS,
5581 .type = QEMU_OPT_BOOL,
5582 .help = "Postpone refcount updates",
5583 .def_value_str = "off"
5584 },
06d05fa7
HR
5585 {
5586 .name = BLOCK_OPT_REFCOUNT_BITS,
5587 .type = QEMU_OPT_NUMBER,
5588 .help = "Width of a reference count entry in bits",
5589 .def_value_str = "16"
5590 },
1bd0e2d1
CL
5591 { /* end of list */ }
5592 }
20d97356
BS
5593};
5594
2654267c
HR
5595static const char *const qcow2_strong_runtime_opts[] = {
5596 "encrypt." BLOCK_CRYPTO_OPT_QCOW_KEY_SECRET,
5597
5598 NULL
5599};
5600
5f535a94 5601BlockDriver bdrv_qcow2 = {
7c80ab3f 5602 .format_name = "qcow2",
ff99129a 5603 .instance_size = sizeof(BDRVQcow2State),
7c80ab3f
JS
5604 .bdrv_probe = qcow2_probe,
5605 .bdrv_open = qcow2_open,
5606 .bdrv_close = qcow2_close,
21d82ac9 5607 .bdrv_reopen_prepare = qcow2_reopen_prepare,
5b0959a7 5608 .bdrv_reopen_commit = qcow2_reopen_commit,
65eb7c85 5609 .bdrv_reopen_commit_post = qcow2_reopen_commit_post,
5b0959a7 5610 .bdrv_reopen_abort = qcow2_reopen_abort,
5365f44d 5611 .bdrv_join_options = qcow2_join_options,
862f215f 5612 .bdrv_child_perm = bdrv_format_default_perms,
efc75e2a 5613 .bdrv_co_create_opts = qcow2_co_create_opts,
b0292b85 5614 .bdrv_co_create = qcow2_co_create,
38841dcd 5615 .bdrv_has_zero_init = qcow2_has_zero_init,
1dcaf527 5616 .bdrv_has_zero_init_truncate = bdrv_has_zero_init_1,
a320fb04 5617 .bdrv_co_block_status = qcow2_co_block_status,
7c80ab3f 5618
df893d25 5619 .bdrv_co_preadv_part = qcow2_co_preadv_part,
5396234b 5620 .bdrv_co_pwritev_part = qcow2_co_pwritev_part,
eb489bb1 5621 .bdrv_co_flush_to_os = qcow2_co_flush_to_os,
419b19d9 5622
5544b59f 5623 .bdrv_co_pwrite_zeroes = qcow2_co_pwrite_zeroes,
82e8a788 5624 .bdrv_co_pdiscard = qcow2_co_pdiscard,
fd9fcd37
FZ
5625 .bdrv_co_copy_range_from = qcow2_co_copy_range_from,
5626 .bdrv_co_copy_range_to = qcow2_co_copy_range_to,
061ca8a3 5627 .bdrv_co_truncate = qcow2_co_truncate,
5396234b 5628 .bdrv_co_pwritev_compressed_part = qcow2_co_pwritev_compressed_part,
491d27e2 5629 .bdrv_make_empty = qcow2_make_empty,
20d97356
BS
5630
5631 .bdrv_snapshot_create = qcow2_snapshot_create,
5632 .bdrv_snapshot_goto = qcow2_snapshot_goto,
5633 .bdrv_snapshot_delete = qcow2_snapshot_delete,
5634 .bdrv_snapshot_list = qcow2_snapshot_list,
1bd0e2d1 5635 .bdrv_snapshot_load_tmp = qcow2_snapshot_load_tmp,
c501c352 5636 .bdrv_measure = qcow2_measure,
1bd0e2d1 5637 .bdrv_get_info = qcow2_get_info,
37764dfb 5638 .bdrv_get_specific_info = qcow2_get_specific_info,
20d97356 5639
7c80ab3f
JS
5640 .bdrv_save_vmstate = qcow2_save_vmstate,
5641 .bdrv_load_vmstate = qcow2_load_vmstate,
20d97356 5642
8ee79e70 5643 .supports_backing = true,
20d97356
BS
5644 .bdrv_change_backing_file = qcow2_change_backing_file,
5645
d34682cd 5646 .bdrv_refresh_limits = qcow2_refresh_limits,
2b148f39 5647 .bdrv_co_invalidate_cache = qcow2_co_invalidate_cache,
ec6d8912 5648 .bdrv_inactivate = qcow2_inactivate,
06d9260f 5649
1bd0e2d1 5650 .create_opts = &qcow2_create_opts,
2654267c 5651 .strong_runtime_opts = qcow2_strong_runtime_opts,
8a2ce0bc 5652 .mutable_opts = mutable_opts,
2fd61638 5653 .bdrv_co_check = qcow2_co_check,
c282e1fd 5654 .bdrv_amend_options = qcow2_amend_options,
279621c0
AG
5655
5656 .bdrv_detach_aio_context = qcow2_detach_aio_context,
5657 .bdrv_attach_aio_context = qcow2_attach_aio_context,
1b6b0562 5658
d2c3080e
VSO
5659 .bdrv_co_can_store_new_dirty_bitmap = qcow2_co_can_store_new_dirty_bitmap,
5660 .bdrv_co_remove_persistent_dirty_bitmap =
5661 qcow2_co_remove_persistent_dirty_bitmap,
20d97356
BS
5662};
5663
5efa9d5a
AL
5664static void bdrv_qcow2_init(void)
5665{
5666 bdrv_register(&bdrv_qcow2);
5667}
5668
5669block_init(bdrv_qcow2_init);