]> git.proxmox.com Git - mirror_qemu.git/blame - block/qcow2.c
qcow2: Keep option in qcow2_invalidate_cache()
[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 */
faf07963 24#include "qemu-common.h"
737e150e 25#include "block/block_int.h"
1de7afc9 26#include "qemu/module.h"
585f8587 27#include <zlib.h>
753d9b82 28#include "qemu/aes.h"
f7d0fe02 29#include "block/qcow2.h"
1de7afc9 30#include "qemu/error-report.h"
7b1b5d19 31#include "qapi/qmp/qerror.h"
acdfb480 32#include "qapi/qmp/qbool.h"
3cce16f4 33#include "trace.h"
585f8587
FB
34
35/*
36 Differences with QCOW:
37
38 - Support for multiple incremental snapshots.
39 - Memory management by reference counts.
40 - Clusters which have a reference count of one have the bit
41 QCOW_OFLAG_COPIED to optimize write performance.
5fafdf24 42 - Size of compressed clusters is stored in sectors to reduce bit usage
585f8587
FB
43 in the cluster offsets.
44 - Support for storing additional data (such as the VM state) in the
3b46e624 45 snapshots.
585f8587
FB
46 - If a backing store is used, the cluster size is not constrained
47 (could be backported to QCOW).
48 - L2 tables have always a size of one cluster.
49*/
50
9b80ddf3
AL
51
52typedef struct {
53 uint32_t magic;
54 uint32_t len;
c4217f64 55} QEMU_PACKED QCowExtension;
21d82ac9 56
7c80ab3f
JS
57#define QCOW2_EXT_MAGIC_END 0
58#define QCOW2_EXT_MAGIC_BACKING_FORMAT 0xE2792ACA
cfcc4c62 59#define QCOW2_EXT_MAGIC_FEATURE_TABLE 0x6803f857
9b80ddf3 60
7c80ab3f 61static int qcow2_probe(const uint8_t *buf, int buf_size, const char *filename)
585f8587
FB
62{
63 const QCowHeader *cow_header = (const void *)buf;
3b46e624 64
585f8587
FB
65 if (buf_size >= sizeof(QCowHeader) &&
66 be32_to_cpu(cow_header->magic) == QCOW_MAGIC &&
6744cbab 67 be32_to_cpu(cow_header->version) >= 2)
585f8587
FB
68 return 100;
69 else
70 return 0;
71}
72
9b80ddf3
AL
73
74/*
75 * read qcow2 extension and fill bs
76 * start reading from start_offset
77 * finish reading upon magic of value 0 or when end_offset reached
78 * unknown magic is skipped (future extension this version knows nothing about)
79 * return 0 upon success, non-0 otherwise
80 */
7c80ab3f 81static int qcow2_read_extensions(BlockDriverState *bs, uint64_t start_offset,
3ef6c40a
HR
82 uint64_t end_offset, void **p_feature_table,
83 Error **errp)
9b80ddf3 84{
75bab85c 85 BDRVQcowState *s = bs->opaque;
9b80ddf3
AL
86 QCowExtension ext;
87 uint64_t offset;
75bab85c 88 int ret;
9b80ddf3
AL
89
90#ifdef DEBUG_EXT
7c80ab3f 91 printf("qcow2_read_extensions: start=%ld end=%ld\n", start_offset, end_offset);
9b80ddf3
AL
92#endif
93 offset = start_offset;
94 while (offset < end_offset) {
95
96#ifdef DEBUG_EXT
97 /* Sanity check */
98 if (offset > s->cluster_size)
7c80ab3f 99 printf("qcow2_read_extension: suspicious offset %lu\n", offset);
9b80ddf3 100
9b2260cb 101 printf("attempting to read extended header in offset %lu\n", offset);
9b80ddf3
AL
102#endif
103
3ef6c40a
HR
104 ret = bdrv_pread(bs->file, offset, &ext, sizeof(ext));
105 if (ret < 0) {
106 error_setg_errno(errp, -ret, "qcow2_read_extension: ERROR: "
107 "pread fail from offset %" PRIu64, offset);
9b80ddf3
AL
108 return 1;
109 }
110 be32_to_cpus(&ext.magic);
111 be32_to_cpus(&ext.len);
112 offset += sizeof(ext);
113#ifdef DEBUG_EXT
114 printf("ext.magic = 0x%x\n", ext.magic);
115#endif
64ca6aee 116 if (ext.len > end_offset - offset) {
3ef6c40a 117 error_setg(errp, "Header extension too large");
64ca6aee
KW
118 return -EINVAL;
119 }
120
9b80ddf3 121 switch (ext.magic) {
7c80ab3f 122 case QCOW2_EXT_MAGIC_END:
9b80ddf3 123 return 0;
f965509c 124
7c80ab3f 125 case QCOW2_EXT_MAGIC_BACKING_FORMAT:
f965509c 126 if (ext.len >= sizeof(bs->backing_format)) {
3ef6c40a
HR
127 error_setg(errp, "ERROR: ext_backing_format: len=%u too large"
128 " (>=%zu)", ext.len, sizeof(bs->backing_format));
f965509c
AL
129 return 2;
130 }
3ef6c40a
HR
131 ret = bdrv_pread(bs->file, offset, bs->backing_format, ext.len);
132 if (ret < 0) {
133 error_setg_errno(errp, -ret, "ERROR: ext_backing_format: "
134 "Could not read format name");
f965509c 135 return 3;
3ef6c40a 136 }
f965509c
AL
137 bs->backing_format[ext.len] = '\0';
138#ifdef DEBUG_EXT
139 printf("Qcow2: Got format extension %s\n", bs->backing_format);
140#endif
f965509c
AL
141 break;
142
cfcc4c62
KW
143 case QCOW2_EXT_MAGIC_FEATURE_TABLE:
144 if (p_feature_table != NULL) {
145 void* feature_table = g_malloc0(ext.len + 2 * sizeof(Qcow2Feature));
146 ret = bdrv_pread(bs->file, offset , feature_table, ext.len);
147 if (ret < 0) {
3ef6c40a
HR
148 error_setg_errno(errp, -ret, "ERROR: ext_feature_table: "
149 "Could not read table");
cfcc4c62
KW
150 return ret;
151 }
152
153 *p_feature_table = feature_table;
154 }
155 break;
156
9b80ddf3 157 default:
75bab85c
KW
158 /* unknown magic - save it in case we need to rewrite the header */
159 {
160 Qcow2UnknownHeaderExtension *uext;
161
162 uext = g_malloc0(sizeof(*uext) + ext.len);
163 uext->magic = ext.magic;
164 uext->len = ext.len;
165 QLIST_INSERT_HEAD(&s->unknown_header_ext, uext, next);
166
167 ret = bdrv_pread(bs->file, offset , uext->data, uext->len);
168 if (ret < 0) {
3ef6c40a
HR
169 error_setg_errno(errp, -ret, "ERROR: unknown extension: "
170 "Could not read data");
75bab85c
KW
171 return ret;
172 }
75bab85c 173 }
9b80ddf3
AL
174 break;
175 }
fd29b4bb
KW
176
177 offset += ((ext.len + 7) & ~7);
9b80ddf3
AL
178 }
179
180 return 0;
181}
182
75bab85c
KW
183static void cleanup_unknown_header_ext(BlockDriverState *bs)
184{
185 BDRVQcowState *s = bs->opaque;
186 Qcow2UnknownHeaderExtension *uext, *next;
187
188 QLIST_FOREACH_SAFE(uext, &s->unknown_header_ext, next, next) {
189 QLIST_REMOVE(uext, next);
190 g_free(uext);
191 }
192}
9b80ddf3 193
3ef6c40a
HR
194static void GCC_FMT_ATTR(3, 4) report_unsupported(BlockDriverState *bs,
195 Error **errp, const char *fmt, ...)
6744cbab
KW
196{
197 char msg[64];
198 va_list ap;
199
200 va_start(ap, fmt);
201 vsnprintf(msg, sizeof(msg), fmt, ap);
202 va_end(ap);
203
3ef6c40a
HR
204 error_set(errp, QERR_UNKNOWN_BLOCK_FORMAT_FEATURE, bs->device_name, "qcow2",
205 msg);
6744cbab
KW
206}
207
cfcc4c62 208static void report_unsupported_feature(BlockDriverState *bs,
3ef6c40a 209 Error **errp, Qcow2Feature *table, uint64_t mask)
cfcc4c62
KW
210{
211 while (table && table->name[0] != '\0') {
212 if (table->type == QCOW2_FEAT_TYPE_INCOMPATIBLE) {
213 if (mask & (1 << table->bit)) {
3ef6c40a 214 report_unsupported(bs, errp, "%.46s", table->name);
cfcc4c62
KW
215 mask &= ~(1 << table->bit);
216 }
217 }
218 table++;
219 }
220
221 if (mask) {
3ef6c40a
HR
222 report_unsupported(bs, errp, "Unknown incompatible feature: %" PRIx64,
223 mask);
cfcc4c62
KW
224 }
225}
226
bfe8043e
SH
227/*
228 * Sets the dirty bit and flushes afterwards if necessary.
229 *
230 * The incompatible_features bit is only set if the image file header was
231 * updated successfully. Therefore it is not required to check the return
232 * value of this function.
233 */
280d3735 234int qcow2_mark_dirty(BlockDriverState *bs)
bfe8043e
SH
235{
236 BDRVQcowState *s = bs->opaque;
237 uint64_t val;
238 int ret;
239
240 assert(s->qcow_version >= 3);
241
242 if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) {
243 return 0; /* already dirty */
244 }
245
246 val = cpu_to_be64(s->incompatible_features | QCOW2_INCOMPAT_DIRTY);
247 ret = bdrv_pwrite(bs->file, offsetof(QCowHeader, incompatible_features),
248 &val, sizeof(val));
249 if (ret < 0) {
250 return ret;
251 }
252 ret = bdrv_flush(bs->file);
253 if (ret < 0) {
254 return ret;
255 }
256
257 /* Only treat image as dirty if the header was updated successfully */
258 s->incompatible_features |= QCOW2_INCOMPAT_DIRTY;
259 return 0;
260}
261
c61d0004
SH
262/*
263 * Clears the dirty bit and flushes before if necessary. Only call this
264 * function when there are no pending requests, it does not guard against
265 * concurrent requests dirtying the image.
266 */
267static int qcow2_mark_clean(BlockDriverState *bs)
268{
269 BDRVQcowState *s = bs->opaque;
270
271 if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) {
272 int ret = bdrv_flush(bs);
273 if (ret < 0) {
274 return ret;
275 }
276
277 s->incompatible_features &= ~QCOW2_INCOMPAT_DIRTY;
278 return qcow2_update_header(bs);
279 }
280 return 0;
281}
282
69c98726
HR
283/*
284 * Marks the image as corrupt.
285 */
286int qcow2_mark_corrupt(BlockDriverState *bs)
287{
288 BDRVQcowState *s = bs->opaque;
289
290 s->incompatible_features |= QCOW2_INCOMPAT_CORRUPT;
291 return qcow2_update_header(bs);
292}
293
294/*
295 * Marks the image as consistent, i.e., unsets the corrupt bit, and flushes
296 * before if necessary.
297 */
298int qcow2_mark_consistent(BlockDriverState *bs)
299{
300 BDRVQcowState *s = bs->opaque;
301
302 if (s->incompatible_features & QCOW2_INCOMPAT_CORRUPT) {
303 int ret = bdrv_flush(bs);
304 if (ret < 0) {
305 return ret;
306 }
307
308 s->incompatible_features &= ~QCOW2_INCOMPAT_CORRUPT;
309 return qcow2_update_header(bs);
310 }
311 return 0;
312}
313
acbe5982
SH
314static int qcow2_check(BlockDriverState *bs, BdrvCheckResult *result,
315 BdrvCheckMode fix)
316{
317 int ret = qcow2_check_refcounts(bs, result, fix);
318 if (ret < 0) {
319 return ret;
320 }
321
322 if (fix && result->check_errors == 0 && result->corruptions == 0) {
24530f3e
HR
323 ret = qcow2_mark_clean(bs);
324 if (ret < 0) {
325 return ret;
326 }
327 return qcow2_mark_consistent(bs);
acbe5982
SH
328 }
329 return ret;
330}
331
74c4510a
KW
332static QemuOptsList qcow2_runtime_opts = {
333 .name = "qcow2",
334 .head = QTAILQ_HEAD_INITIALIZER(qcow2_runtime_opts.head),
335 .desc = {
336 {
64aa99d3 337 .name = QCOW2_OPT_LAZY_REFCOUNTS,
74c4510a
KW
338 .type = QEMU_OPT_BOOL,
339 .help = "Postpone refcount updates",
340 },
67af674e
KW
341 {
342 .name = QCOW2_OPT_DISCARD_REQUEST,
343 .type = QEMU_OPT_BOOL,
344 .help = "Pass guest discard requests to the layer below",
345 },
346 {
347 .name = QCOW2_OPT_DISCARD_SNAPSHOT,
348 .type = QEMU_OPT_BOOL,
349 .help = "Generate discard requests when snapshot related space "
350 "is freed",
351 },
352 {
353 .name = QCOW2_OPT_DISCARD_OTHER,
354 .type = QEMU_OPT_BOOL,
355 .help = "Generate discard requests when other clusters are freed",
356 },
05de7e86
HR
357 {
358 .name = QCOW2_OPT_OVERLAP,
359 .type = QEMU_OPT_STRING,
360 .help = "Selects which overlap checks to perform from a range of "
361 "templates (none, constant, cached, all)",
362 },
363 {
364 .name = QCOW2_OPT_OVERLAP_MAIN_HEADER,
365 .type = QEMU_OPT_BOOL,
366 .help = "Check for unintended writes into the main qcow2 header",
367 },
368 {
369 .name = QCOW2_OPT_OVERLAP_ACTIVE_L1,
370 .type = QEMU_OPT_BOOL,
371 .help = "Check for unintended writes into the active L1 table",
372 },
373 {
374 .name = QCOW2_OPT_OVERLAP_ACTIVE_L2,
375 .type = QEMU_OPT_BOOL,
376 .help = "Check for unintended writes into an active L2 table",
377 },
378 {
379 .name = QCOW2_OPT_OVERLAP_REFCOUNT_TABLE,
380 .type = QEMU_OPT_BOOL,
381 .help = "Check for unintended writes into the refcount table",
382 },
383 {
384 .name = QCOW2_OPT_OVERLAP_REFCOUNT_BLOCK,
385 .type = QEMU_OPT_BOOL,
386 .help = "Check for unintended writes into a refcount block",
387 },
388 {
389 .name = QCOW2_OPT_OVERLAP_SNAPSHOT_TABLE,
390 .type = QEMU_OPT_BOOL,
391 .help = "Check for unintended writes into the snapshot table",
392 },
393 {
394 .name = QCOW2_OPT_OVERLAP_INACTIVE_L1,
395 .type = QEMU_OPT_BOOL,
396 .help = "Check for unintended writes into an inactive L1 table",
397 },
398 {
399 .name = QCOW2_OPT_OVERLAP_INACTIVE_L2,
400 .type = QEMU_OPT_BOOL,
401 .help = "Check for unintended writes into an inactive L2 table",
402 },
74c4510a
KW
403 { /* end of list */ }
404 },
405};
406
4092e99d
HR
407static const char *overlap_bool_option_names[QCOW2_OL_MAX_BITNR] = {
408 [QCOW2_OL_MAIN_HEADER_BITNR] = QCOW2_OPT_OVERLAP_MAIN_HEADER,
409 [QCOW2_OL_ACTIVE_L1_BITNR] = QCOW2_OPT_OVERLAP_ACTIVE_L1,
410 [QCOW2_OL_ACTIVE_L2_BITNR] = QCOW2_OPT_OVERLAP_ACTIVE_L2,
411 [QCOW2_OL_REFCOUNT_TABLE_BITNR] = QCOW2_OPT_OVERLAP_REFCOUNT_TABLE,
412 [QCOW2_OL_REFCOUNT_BLOCK_BITNR] = QCOW2_OPT_OVERLAP_REFCOUNT_BLOCK,
413 [QCOW2_OL_SNAPSHOT_TABLE_BITNR] = QCOW2_OPT_OVERLAP_SNAPSHOT_TABLE,
414 [QCOW2_OL_INACTIVE_L1_BITNR] = QCOW2_OPT_OVERLAP_INACTIVE_L1,
415 [QCOW2_OL_INACTIVE_L2_BITNR] = QCOW2_OPT_OVERLAP_INACTIVE_L2,
416};
417
015a1036
HR
418static int qcow2_open(BlockDriverState *bs, QDict *options, int flags,
419 Error **errp)
585f8587
FB
420{
421 BDRVQcowState *s = bs->opaque;
6d85a57e 422 int len, i, ret = 0;
585f8587 423 QCowHeader header;
74c4510a
KW
424 QemuOpts *opts;
425 Error *local_err = NULL;
9b80ddf3 426 uint64_t ext_end;
2cf7cfa1 427 uint64_t l1_vm_state_index;
1fa5cc83
HR
428 const char *opt_overlap_check;
429 int overlap_check_template = 0;
585f8587 430
6d85a57e
JS
431 ret = bdrv_pread(bs->file, 0, &header, sizeof(header));
432 if (ret < 0) {
3ef6c40a 433 error_setg_errno(errp, -ret, "Could not read qcow2 header");
585f8587 434 goto fail;
6d85a57e 435 }
585f8587
FB
436 be32_to_cpus(&header.magic);
437 be32_to_cpus(&header.version);
438 be64_to_cpus(&header.backing_file_offset);
439 be32_to_cpus(&header.backing_file_size);
440 be64_to_cpus(&header.size);
441 be32_to_cpus(&header.cluster_bits);
442 be32_to_cpus(&header.crypt_method);
443 be64_to_cpus(&header.l1_table_offset);
444 be32_to_cpus(&header.l1_size);
445 be64_to_cpus(&header.refcount_table_offset);
446 be32_to_cpus(&header.refcount_table_clusters);
447 be64_to_cpus(&header.snapshots_offset);
448 be32_to_cpus(&header.nb_snapshots);
3b46e624 449
e8cdcec1 450 if (header.magic != QCOW_MAGIC) {
3ef6c40a 451 error_setg(errp, "Image is not in qcow2 format");
76abe407 452 ret = -EINVAL;
585f8587 453 goto fail;
6d85a57e 454 }
6744cbab 455 if (header.version < 2 || header.version > 3) {
3ef6c40a 456 report_unsupported(bs, errp, "QCOW version %d", header.version);
6744cbab
KW
457 ret = -ENOTSUP;
458 goto fail;
459 }
460
461 s->qcow_version = header.version;
462
463 /* Initialise version 3 header fields */
464 if (header.version == 2) {
465 header.incompatible_features = 0;
466 header.compatible_features = 0;
467 header.autoclear_features = 0;
468 header.refcount_order = 4;
469 header.header_length = 72;
470 } else {
471 be64_to_cpus(&header.incompatible_features);
472 be64_to_cpus(&header.compatible_features);
473 be64_to_cpus(&header.autoclear_features);
474 be32_to_cpus(&header.refcount_order);
475 be32_to_cpus(&header.header_length);
476 }
477
478 if (header.header_length > sizeof(header)) {
479 s->unknown_header_fields_size = header.header_length - sizeof(header);
480 s->unknown_header_fields = g_malloc(s->unknown_header_fields_size);
481 ret = bdrv_pread(bs->file, sizeof(header), s->unknown_header_fields,
482 s->unknown_header_fields_size);
483 if (ret < 0) {
3ef6c40a
HR
484 error_setg_errno(errp, -ret, "Could not read unknown qcow2 header "
485 "fields");
6744cbab
KW
486 goto fail;
487 }
488 }
489
cfcc4c62
KW
490 if (header.backing_file_offset) {
491 ext_end = header.backing_file_offset;
492 } else {
493 ext_end = 1 << header.cluster_bits;
494 }
495
6744cbab
KW
496 /* Handle feature bits */
497 s->incompatible_features = header.incompatible_features;
498 s->compatible_features = header.compatible_features;
499 s->autoclear_features = header.autoclear_features;
500
c61d0004 501 if (s->incompatible_features & ~QCOW2_INCOMPAT_MASK) {
cfcc4c62
KW
502 void *feature_table = NULL;
503 qcow2_read_extensions(bs, header.header_length, ext_end,
3ef6c40a
HR
504 &feature_table, NULL);
505 report_unsupported_feature(bs, errp, feature_table,
c61d0004
SH
506 s->incompatible_features &
507 ~QCOW2_INCOMPAT_MASK);
6744cbab
KW
508 ret = -ENOTSUP;
509 goto fail;
510 }
511
69c98726
HR
512 if (s->incompatible_features & QCOW2_INCOMPAT_CORRUPT) {
513 /* Corrupt images may not be written to unless they are being repaired
514 */
515 if ((flags & BDRV_O_RDWR) && !(flags & BDRV_O_CHECK)) {
3ef6c40a
HR
516 error_setg(errp, "qcow2: Image is corrupt; cannot be opened "
517 "read/write");
69c98726
HR
518 ret = -EACCES;
519 goto fail;
520 }
521 }
522
6744cbab
KW
523 /* Check support for various header values */
524 if (header.refcount_order != 4) {
3ef6c40a 525 report_unsupported(bs, errp, "%d bit reference counts",
6744cbab 526 1 << header.refcount_order);
e8cdcec1
KW
527 ret = -ENOTSUP;
528 goto fail;
529 }
b6481f37 530 s->refcount_order = header.refcount_order;
6744cbab 531
d191d12d 532 if (header.cluster_bits < MIN_CLUSTER_BITS ||
6d85a57e 533 header.cluster_bits > MAX_CLUSTER_BITS) {
3ef6c40a 534 error_setg(errp, "Unsupported cluster size: 2^%i", header.cluster_bits);
6d85a57e 535 ret = -EINVAL;
585f8587 536 goto fail;
6d85a57e
JS
537 }
538 if (header.crypt_method > QCOW_CRYPT_AES) {
3ef6c40a
HR
539 error_setg(errp, "Unsupported encryption method: %i",
540 header.crypt_method);
6d85a57e 541 ret = -EINVAL;
585f8587 542 goto fail;
6d85a57e 543 }
585f8587 544 s->crypt_method_header = header.crypt_method;
6d85a57e 545 if (s->crypt_method_header) {
585f8587 546 bs->encrypted = 1;
6d85a57e 547 }
585f8587
FB
548 s->cluster_bits = header.cluster_bits;
549 s->cluster_size = 1 << s->cluster_bits;
550 s->cluster_sectors = 1 << (s->cluster_bits - 9);
551 s->l2_bits = s->cluster_bits - 3; /* L2 is always one cluster */
552 s->l2_size = 1 << s->l2_bits;
553 bs->total_sectors = header.size / 512;
554 s->csize_shift = (62 - (s->cluster_bits - 8));
555 s->csize_mask = (1 << (s->cluster_bits - 8)) - 1;
556 s->cluster_offset_mask = (1LL << s->csize_shift) - 1;
557 s->refcount_table_offset = header.refcount_table_offset;
5fafdf24 558 s->refcount_table_size =
585f8587
FB
559 header.refcount_table_clusters << (s->cluster_bits - 3);
560
561 s->snapshots_offset = header.snapshots_offset;
562 s->nb_snapshots = header.nb_snapshots;
563
564 /* read the level 1 table */
565 s->l1_size = header.l1_size;
2cf7cfa1
KW
566
567 l1_vm_state_index = size_to_l1(s, header.size);
568 if (l1_vm_state_index > INT_MAX) {
3ef6c40a 569 error_setg(errp, "Image is too big");
2cf7cfa1
KW
570 ret = -EFBIG;
571 goto fail;
572 }
573 s->l1_vm_state_index = l1_vm_state_index;
574
585f8587
FB
575 /* the L1 table must contain at least enough entries to put
576 header.size bytes */
6d85a57e 577 if (s->l1_size < s->l1_vm_state_index) {
3ef6c40a 578 error_setg(errp, "L1 table is too small");
6d85a57e 579 ret = -EINVAL;
585f8587 580 goto fail;
6d85a57e 581 }
585f8587 582 s->l1_table_offset = header.l1_table_offset;
d191d12d 583 if (s->l1_size > 0) {
7267c094 584 s->l1_table = g_malloc0(
d191d12d 585 align_offset(s->l1_size * sizeof(uint64_t), 512));
6d85a57e
JS
586 ret = bdrv_pread(bs->file, s->l1_table_offset, s->l1_table,
587 s->l1_size * sizeof(uint64_t));
588 if (ret < 0) {
3ef6c40a 589 error_setg_errno(errp, -ret, "Could not read L1 table");
d191d12d 590 goto fail;
6d85a57e 591 }
d191d12d
SW
592 for(i = 0;i < s->l1_size; i++) {
593 be64_to_cpus(&s->l1_table[i]);
594 }
585f8587 595 }
29c1a730
KW
596
597 /* alloc L2 table/refcount block cache */
6af4e9ea
PB
598 s->l2_table_cache = qcow2_cache_create(bs, L2_CACHE_SIZE);
599 s->refcount_block_cache = qcow2_cache_create(bs, REFCOUNT_CACHE_SIZE);
29c1a730 600
7267c094 601 s->cluster_cache = g_malloc(s->cluster_size);
585f8587 602 /* one more sector for decompressed data alignment */
dea43a65 603 s->cluster_data = qemu_blockalign(bs, QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size
095a9c58 604 + 512);
585f8587 605 s->cluster_cache_offset = -1;
06d9260f 606 s->flags = flags;
3b46e624 607
6d85a57e
JS
608 ret = qcow2_refcount_init(bs);
609 if (ret != 0) {
3ef6c40a 610 error_setg_errno(errp, -ret, "Could not initialize refcount handling");
585f8587 611 goto fail;
6d85a57e 612 }
585f8587 613
72cf2d4f 614 QLIST_INIT(&s->cluster_allocs);
0b919fae 615 QTAILQ_INIT(&s->discards);
f214978a 616
9b80ddf3 617 /* read qcow2 extensions */
3ef6c40a
HR
618 if (qcow2_read_extensions(bs, header.header_length, ext_end, NULL,
619 &local_err)) {
620 error_propagate(errp, local_err);
6d85a57e 621 ret = -EINVAL;
9b80ddf3 622 goto fail;
6d85a57e 623 }
9b80ddf3 624
585f8587
FB
625 /* read the backing file name */
626 if (header.backing_file_offset != 0) {
627 len = header.backing_file_size;
6d85a57e 628 if (len > 1023) {
585f8587 629 len = 1023;
6d85a57e
JS
630 }
631 ret = bdrv_pread(bs->file, header.backing_file_offset,
632 bs->backing_file, len);
633 if (ret < 0) {
3ef6c40a 634 error_setg_errno(errp, -ret, "Could not read backing file name");
585f8587 635 goto fail;
6d85a57e 636 }
585f8587
FB
637 bs->backing_file[len] = '\0';
638 }
42deb29f
KW
639
640 ret = qcow2_read_snapshots(bs);
641 if (ret < 0) {
3ef6c40a 642 error_setg_errno(errp, -ret, "Could not read snapshots");
585f8587 643 goto fail;
6d85a57e 644 }
585f8587 645
af7b708d
SH
646 /* Clear unknown autoclear feature bits */
647 if (!bs->read_only && s->autoclear_features != 0) {
648 s->autoclear_features = 0;
649 ret = qcow2_update_header(bs);
650 if (ret < 0) {
3ef6c40a 651 error_setg_errno(errp, -ret, "Could not update qcow2 header");
af7b708d
SH
652 goto fail;
653 }
654 }
655
68d100e9
KW
656 /* Initialise locks */
657 qemu_co_mutex_init(&s->lock);
658
c61d0004 659 /* Repair image if dirty */
058f8f16
SH
660 if (!(flags & BDRV_O_CHECK) && !bs->read_only &&
661 (s->incompatible_features & QCOW2_INCOMPAT_DIRTY)) {
c61d0004
SH
662 BdrvCheckResult result = {0};
663
acbe5982 664 ret = qcow2_check(bs, &result, BDRV_FIX_ERRORS);
c61d0004 665 if (ret < 0) {
3ef6c40a 666 error_setg_errno(errp, -ret, "Could not repair dirty image");
c61d0004
SH
667 goto fail;
668 }
669 }
670
74c4510a 671 /* Enable lazy_refcounts according to image and command line options */
87ea75d5 672 opts = qemu_opts_create(&qcow2_runtime_opts, NULL, 0, &error_abort);
74c4510a 673 qemu_opts_absorb_qdict(opts, options, &local_err);
84d18f06 674 if (local_err) {
3ef6c40a 675 error_propagate(errp, local_err);
74c4510a
KW
676 ret = -EINVAL;
677 goto fail;
678 }
679
acdfb480 680 s->use_lazy_refcounts = qemu_opt_get_bool(opts, QCOW2_OPT_LAZY_REFCOUNTS,
74c4510a
KW
681 (s->compatible_features & QCOW2_COMPAT_LAZY_REFCOUNTS));
682
67af674e
KW
683 s->discard_passthrough[QCOW2_DISCARD_NEVER] = false;
684 s->discard_passthrough[QCOW2_DISCARD_ALWAYS] = true;
685 s->discard_passthrough[QCOW2_DISCARD_REQUEST] =
686 qemu_opt_get_bool(opts, QCOW2_OPT_DISCARD_REQUEST,
687 flags & BDRV_O_UNMAP);
688 s->discard_passthrough[QCOW2_DISCARD_SNAPSHOT] =
689 qemu_opt_get_bool(opts, QCOW2_OPT_DISCARD_SNAPSHOT, true);
690 s->discard_passthrough[QCOW2_DISCARD_OTHER] =
691 qemu_opt_get_bool(opts, QCOW2_OPT_DISCARD_OTHER, false);
692
1fa5cc83
HR
693 opt_overlap_check = qemu_opt_get(opts, "overlap-check") ?: "cached";
694 if (!strcmp(opt_overlap_check, "none")) {
695 overlap_check_template = 0;
696 } else if (!strcmp(opt_overlap_check, "constant")) {
697 overlap_check_template = QCOW2_OL_CONSTANT;
698 } else if (!strcmp(opt_overlap_check, "cached")) {
699 overlap_check_template = QCOW2_OL_CACHED;
700 } else if (!strcmp(opt_overlap_check, "all")) {
701 overlap_check_template = QCOW2_OL_ALL;
702 } else {
703 error_setg(errp, "Unsupported value '%s' for qcow2 option "
704 "'overlap-check'. Allowed are either of the following: "
705 "none, constant, cached, all", opt_overlap_check);
706 qemu_opts_del(opts);
707 ret = -EINVAL;
708 goto fail;
709 }
710
711 s->overlap_check = 0;
712 for (i = 0; i < QCOW2_OL_MAX_BITNR; i++) {
713 /* overlap-check defines a template bitmask, but every flag may be
714 * overwritten through the associated boolean option */
715 s->overlap_check |=
716 qemu_opt_get_bool(opts, overlap_bool_option_names[i],
717 overlap_check_template & (1 << i)) << i;
718 }
3e355390 719
74c4510a
KW
720 qemu_opts_del(opts);
721
722 if (s->use_lazy_refcounts && s->qcow_version < 3) {
3ef6c40a
HR
723 error_setg(errp, "Lazy refcounts require a qcow2 image with at least "
724 "qemu 1.1 compatibility level");
74c4510a
KW
725 ret = -EINVAL;
726 goto fail;
727 }
728
585f8587 729#ifdef DEBUG_ALLOC
6cbc3031
PH
730 {
731 BdrvCheckResult result = {0};
b35278f7 732 qcow2_check_refcounts(bs, &result, 0);
6cbc3031 733 }
585f8587 734#endif
6d85a57e 735 return ret;
585f8587
FB
736
737 fail:
6744cbab 738 g_free(s->unknown_header_fields);
75bab85c 739 cleanup_unknown_header_ext(bs);
ed6ccf0f
KW
740 qcow2_free_snapshots(bs);
741 qcow2_refcount_close(bs);
7267c094 742 g_free(s->l1_table);
cf93980e
HR
743 /* else pre-write overlap checks in cache_destroy may crash */
744 s->l1_table = NULL;
29c1a730
KW
745 if (s->l2_table_cache) {
746 qcow2_cache_destroy(bs, s->l2_table_cache);
747 }
7267c094 748 g_free(s->cluster_cache);
dea43a65 749 qemu_vfree(s->cluster_data);
6d85a57e 750 return ret;
585f8587
FB
751}
752
d34682cd
KW
753static int qcow2_refresh_limits(BlockDriverState *bs)
754{
755 BDRVQcowState *s = bs->opaque;
756
757 bs->bl.write_zeroes_alignment = s->cluster_sectors;
758
759 return 0;
760}
761
7c80ab3f 762static int qcow2_set_key(BlockDriverState *bs, const char *key)
585f8587
FB
763{
764 BDRVQcowState *s = bs->opaque;
765 uint8_t keybuf[16];
766 int len, i;
3b46e624 767
585f8587
FB
768 memset(keybuf, 0, 16);
769 len = strlen(key);
770 if (len > 16)
771 len = 16;
772 /* XXX: we could compress the chars to 7 bits to increase
773 entropy */
774 for(i = 0;i < len;i++) {
775 keybuf[i] = key[i];
776 }
777 s->crypt_method = s->crypt_method_header;
778
779 if (AES_set_encrypt_key(keybuf, 128, &s->aes_encrypt_key) != 0)
780 return -1;
781 if (AES_set_decrypt_key(keybuf, 128, &s->aes_decrypt_key) != 0)
782 return -1;
783#if 0
784 /* test */
785 {
786 uint8_t in[16];
787 uint8_t out[16];
788 uint8_t tmp[16];
789 for(i=0;i<16;i++)
790 in[i] = i;
791 AES_encrypt(in, tmp, &s->aes_encrypt_key);
792 AES_decrypt(tmp, out, &s->aes_decrypt_key);
793 for(i = 0; i < 16; i++)
794 printf(" %02x", tmp[i]);
795 printf("\n");
796 for(i = 0; i < 16; i++)
797 printf(" %02x", out[i]);
798 printf("\n");
799 }
800#endif
801 return 0;
802}
803
21d82ac9
JC
804/* We have nothing to do for QCOW2 reopen, stubs just return
805 * success */
806static int qcow2_reopen_prepare(BDRVReopenState *state,
807 BlockReopenQueue *queue, Error **errp)
808{
809 return 0;
810}
811
b6b8a333 812static int64_t coroutine_fn qcow2_co_get_block_status(BlockDriverState *bs,
f8a2e5e3 813 int64_t sector_num, int nb_sectors, int *pnum)
585f8587 814{
f8a2e5e3 815 BDRVQcowState *s = bs->opaque;
585f8587 816 uint64_t cluster_offset;
4bc74be9
PB
817 int index_in_cluster, ret;
818 int64_t status = 0;
585f8587 819
095a9c58 820 *pnum = nb_sectors;
f8a2e5e3 821 qemu_co_mutex_lock(&s->lock);
1c46efaa 822 ret = qcow2_get_cluster_offset(bs, sector_num << 9, pnum, &cluster_offset);
f8a2e5e3 823 qemu_co_mutex_unlock(&s->lock);
1c46efaa 824 if (ret < 0) {
d663640c 825 return ret;
1c46efaa 826 }
095a9c58 827
4bc74be9
PB
828 if (cluster_offset != 0 && ret != QCOW2_CLUSTER_COMPRESSED &&
829 !s->crypt_method) {
830 index_in_cluster = sector_num & (s->cluster_sectors - 1);
831 cluster_offset |= (index_in_cluster << BDRV_SECTOR_BITS);
832 status |= BDRV_BLOCK_OFFSET_VALID | cluster_offset;
833 }
834 if (ret == QCOW2_CLUSTER_ZERO) {
835 status |= BDRV_BLOCK_ZERO;
836 } else if (ret != QCOW2_CLUSTER_UNALLOCATED) {
837 status |= BDRV_BLOCK_DATA;
838 }
839 return status;
585f8587
FB
840}
841
a9465922 842/* handle reading after the end of the backing file */
bd28f835
KW
843int qcow2_backing_read1(BlockDriverState *bs, QEMUIOVector *qiov,
844 int64_t sector_num, int nb_sectors)
a9465922
FB
845{
846 int n1;
847 if ((sector_num + nb_sectors) <= bs->total_sectors)
848 return nb_sectors;
849 if (sector_num >= bs->total_sectors)
850 n1 = 0;
851 else
852 n1 = bs->total_sectors - sector_num;
bd28f835 853
3d9b4925 854 qemu_iovec_memset(qiov, 512 * n1, 0, 512 * (nb_sectors - n1));
bd28f835 855
a9465922
FB
856 return n1;
857}
858
a968168c 859static coroutine_fn int qcow2_co_readv(BlockDriverState *bs, int64_t sector_num,
3fc48d09 860 int remaining_sectors, QEMUIOVector *qiov)
585f8587 861{
585f8587 862 BDRVQcowState *s = bs->opaque;
a9465922 863 int index_in_cluster, n1;
68d100e9 864 int ret;
faf575c1 865 int cur_nr_sectors; /* number of sectors in current iteration */
c2bdd990 866 uint64_t cluster_offset = 0;
3fc48d09
FZ
867 uint64_t bytes_done = 0;
868 QEMUIOVector hd_qiov;
869 uint8_t *cluster_data = NULL;
585f8587 870
3fc48d09
FZ
871 qemu_iovec_init(&hd_qiov, qiov->niov);
872
873 qemu_co_mutex_lock(&s->lock);
874
875 while (remaining_sectors != 0) {
bd28f835 876
5ebaa27e 877 /* prepare next request */
3fc48d09 878 cur_nr_sectors = remaining_sectors;
5ebaa27e
FZ
879 if (s->crypt_method) {
880 cur_nr_sectors = MIN(cur_nr_sectors,
881 QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors);
585f8587 882 }
5ebaa27e 883
3fc48d09 884 ret = qcow2_get_cluster_offset(bs, sector_num << 9,
5ebaa27e 885 &cur_nr_sectors, &cluster_offset);
8af36488 886 if (ret < 0) {
3fc48d09 887 goto fail;
8af36488 888 }
bd28f835 889
3fc48d09 890 index_in_cluster = sector_num & (s->cluster_sectors - 1);
c87c0672 891
3fc48d09 892 qemu_iovec_reset(&hd_qiov);
1b093c48 893 qemu_iovec_concat(&hd_qiov, qiov, bytes_done,
5ebaa27e
FZ
894 cur_nr_sectors * 512);
895
68d000a3
KW
896 switch (ret) {
897 case QCOW2_CLUSTER_UNALLOCATED:
5ebaa27e
FZ
898
899 if (bs->backing_hd) {
900 /* read from the base image */
3fc48d09
FZ
901 n1 = qcow2_backing_read1(bs->backing_hd, &hd_qiov,
902 sector_num, cur_nr_sectors);
5ebaa27e
FZ
903 if (n1 > 0) {
904 BLKDBG_EVENT(bs->file, BLKDBG_READ_BACKING_AIO);
905 qemu_co_mutex_unlock(&s->lock);
3fc48d09
FZ
906 ret = bdrv_co_readv(bs->backing_hd, sector_num,
907 n1, &hd_qiov);
5ebaa27e
FZ
908 qemu_co_mutex_lock(&s->lock);
909 if (ret < 0) {
3fc48d09 910 goto fail;
5ebaa27e
FZ
911 }
912 }
913 } else {
914 /* Note: in this case, no need to wait */
3d9b4925 915 qemu_iovec_memset(&hd_qiov, 0, 0, 512 * cur_nr_sectors);
5ebaa27e 916 }
68d000a3
KW
917 break;
918
6377af48 919 case QCOW2_CLUSTER_ZERO:
3d9b4925 920 qemu_iovec_memset(&hd_qiov, 0, 0, 512 * cur_nr_sectors);
6377af48
KW
921 break;
922
68d000a3 923 case QCOW2_CLUSTER_COMPRESSED:
5ebaa27e
FZ
924 /* add AIO support for compressed blocks ? */
925 ret = qcow2_decompress_cluster(bs, cluster_offset);
926 if (ret < 0) {
3fc48d09 927 goto fail;
bd28f835
KW
928 }
929
03396148 930 qemu_iovec_from_buf(&hd_qiov, 0,
5ebaa27e 931 s->cluster_cache + index_in_cluster * 512,
faf575c1 932 512 * cur_nr_sectors);
68d000a3
KW
933 break;
934
935 case QCOW2_CLUSTER_NORMAL:
5ebaa27e 936 if ((cluster_offset & 511) != 0) {
3fc48d09
FZ
937 ret = -EIO;
938 goto fail;
5ebaa27e 939 }
bd28f835 940
5ebaa27e
FZ
941 if (s->crypt_method) {
942 /*
943 * For encrypted images, read everything into a temporary
944 * contiguous buffer on which the AES functions can work.
945 */
3fc48d09
FZ
946 if (!cluster_data) {
947 cluster_data =
dea43a65 948 qemu_blockalign(bs, QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size);
5ebaa27e
FZ
949 }
950
951 assert(cur_nr_sectors <=
952 QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors);
3fc48d09
FZ
953 qemu_iovec_reset(&hd_qiov);
954 qemu_iovec_add(&hd_qiov, cluster_data,
5ebaa27e
FZ
955 512 * cur_nr_sectors);
956 }
957
958 BLKDBG_EVENT(bs->file, BLKDBG_READ_AIO);
959 qemu_co_mutex_unlock(&s->lock);
960 ret = bdrv_co_readv(bs->file,
961 (cluster_offset >> 9) + index_in_cluster,
3fc48d09 962 cur_nr_sectors, &hd_qiov);
5ebaa27e
FZ
963 qemu_co_mutex_lock(&s->lock);
964 if (ret < 0) {
3fc48d09 965 goto fail;
5ebaa27e
FZ
966 }
967 if (s->crypt_method) {
3fc48d09
FZ
968 qcow2_encrypt_sectors(s, sector_num, cluster_data,
969 cluster_data, cur_nr_sectors, 0, &s->aes_decrypt_key);
03396148
MT
970 qemu_iovec_from_buf(qiov, bytes_done,
971 cluster_data, 512 * cur_nr_sectors);
5ebaa27e 972 }
68d000a3
KW
973 break;
974
975 default:
976 g_assert_not_reached();
977 ret = -EIO;
978 goto fail;
faf575c1 979 }
f141eafe 980
3fc48d09
FZ
981 remaining_sectors -= cur_nr_sectors;
982 sector_num += cur_nr_sectors;
983 bytes_done += cur_nr_sectors * 512;
5ebaa27e 984 }
3fc48d09 985 ret = 0;
faf575c1 986
3fc48d09 987fail:
68d100e9 988 qemu_co_mutex_unlock(&s->lock);
42496d62 989
3fc48d09 990 qemu_iovec_destroy(&hd_qiov);
dea43a65 991 qemu_vfree(cluster_data);
68d100e9
KW
992
993 return ret;
585f8587
FB
994}
995
a968168c 996static coroutine_fn int qcow2_co_writev(BlockDriverState *bs,
3fc48d09
FZ
997 int64_t sector_num,
998 int remaining_sectors,
999 QEMUIOVector *qiov)
585f8587 1000{
585f8587 1001 BDRVQcowState *s = bs->opaque;
585f8587 1002 int index_in_cluster;
68d100e9 1003 int ret;
faf575c1 1004 int cur_nr_sectors; /* number of sectors in current iteration */
c2bdd990 1005 uint64_t cluster_offset;
3fc48d09
FZ
1006 QEMUIOVector hd_qiov;
1007 uint64_t bytes_done = 0;
1008 uint8_t *cluster_data = NULL;
8d2497c3 1009 QCowL2Meta *l2meta = NULL;
c2271403 1010
3cce16f4
KW
1011 trace_qcow2_writev_start_req(qemu_coroutine_self(), sector_num,
1012 remaining_sectors);
1013
3fc48d09
FZ
1014 qemu_iovec_init(&hd_qiov, qiov->niov);
1015
1016 s->cluster_cache_offset = -1; /* disable compressed cache */
3b46e624 1017
3fc48d09
FZ
1018 qemu_co_mutex_lock(&s->lock);
1019
1020 while (remaining_sectors != 0) {
1021
f50f88b9 1022 l2meta = NULL;
cf5c1a23 1023
3cce16f4 1024 trace_qcow2_writev_start_part(qemu_coroutine_self());
3fc48d09 1025 index_in_cluster = sector_num & (s->cluster_sectors - 1);
16f0587e 1026 cur_nr_sectors = remaining_sectors;
5ebaa27e 1027 if (s->crypt_method &&
16f0587e
HT
1028 cur_nr_sectors >
1029 QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors - index_in_cluster) {
1030 cur_nr_sectors =
1031 QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors - index_in_cluster;
5ebaa27e 1032 }
095a9c58 1033
3fc48d09 1034 ret = qcow2_alloc_cluster_offset(bs, sector_num << 9,
16f0587e 1035 &cur_nr_sectors, &cluster_offset, &l2meta);
5ebaa27e 1036 if (ret < 0) {
3fc48d09 1037 goto fail;
5ebaa27e 1038 }
148da7ea 1039
5ebaa27e 1040 assert((cluster_offset & 511) == 0);
148da7ea 1041
3fc48d09 1042 qemu_iovec_reset(&hd_qiov);
1b093c48 1043 qemu_iovec_concat(&hd_qiov, qiov, bytes_done,
5ebaa27e 1044 cur_nr_sectors * 512);
6f5f060b 1045
5ebaa27e 1046 if (s->crypt_method) {
3fc48d09 1047 if (!cluster_data) {
dea43a65 1048 cluster_data = qemu_blockalign(bs, QCOW_MAX_CRYPT_CLUSTERS *
5ebaa27e
FZ
1049 s->cluster_size);
1050 }
6f5f060b 1051
3fc48d09 1052 assert(hd_qiov.size <=
5ebaa27e 1053 QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size);
d5e6b161 1054 qemu_iovec_to_buf(&hd_qiov, 0, cluster_data, hd_qiov.size);
6f5f060b 1055
3fc48d09
FZ
1056 qcow2_encrypt_sectors(s, sector_num, cluster_data,
1057 cluster_data, cur_nr_sectors, 1, &s->aes_encrypt_key);
6f5f060b 1058
3fc48d09
FZ
1059 qemu_iovec_reset(&hd_qiov);
1060 qemu_iovec_add(&hd_qiov, cluster_data,
5ebaa27e
FZ
1061 cur_nr_sectors * 512);
1062 }
6f5f060b 1063
231bb267 1064 ret = qcow2_pre_write_overlap_check(bs, 0,
cf93980e
HR
1065 cluster_offset + index_in_cluster * BDRV_SECTOR_SIZE,
1066 cur_nr_sectors * BDRV_SECTOR_SIZE);
1067 if (ret < 0) {
1068 goto fail;
1069 }
1070
5ebaa27e 1071 qemu_co_mutex_unlock(&s->lock);
67a7a0eb 1072 BLKDBG_EVENT(bs->file, BLKDBG_WRITE_AIO);
3cce16f4
KW
1073 trace_qcow2_writev_data(qemu_coroutine_self(),
1074 (cluster_offset >> 9) + index_in_cluster);
5ebaa27e
FZ
1075 ret = bdrv_co_writev(bs->file,
1076 (cluster_offset >> 9) + index_in_cluster,
3fc48d09 1077 cur_nr_sectors, &hd_qiov);
5ebaa27e
FZ
1078 qemu_co_mutex_lock(&s->lock);
1079 if (ret < 0) {
3fc48d09 1080 goto fail;
5ebaa27e 1081 }
f141eafe 1082
88c6588c
KW
1083 while (l2meta != NULL) {
1084 QCowL2Meta *next;
1085
f50f88b9
KW
1086 ret = qcow2_alloc_cluster_link_l2(bs, l2meta);
1087 if (ret < 0) {
1088 goto fail;
1089 }
faf575c1 1090
4e95314e
KW
1091 /* Take the request off the list of running requests */
1092 if (l2meta->nb_clusters != 0) {
1093 QLIST_REMOVE(l2meta, next_in_flight);
1094 }
1095
4e95314e 1096 qemu_co_queue_restart_all(&l2meta->dependent_requests);
4e95314e 1097
88c6588c 1098 next = l2meta->next;
f50f88b9 1099 g_free(l2meta);
88c6588c 1100 l2meta = next;
f50f88b9 1101 }
0fa9131a 1102
3fc48d09
FZ
1103 remaining_sectors -= cur_nr_sectors;
1104 sector_num += cur_nr_sectors;
1105 bytes_done += cur_nr_sectors * 512;
3cce16f4 1106 trace_qcow2_writev_done_part(qemu_coroutine_self(), cur_nr_sectors);
5ebaa27e 1107 }
3fc48d09 1108 ret = 0;
faf575c1 1109
3fc48d09 1110fail:
4e95314e
KW
1111 qemu_co_mutex_unlock(&s->lock);
1112
88c6588c
KW
1113 while (l2meta != NULL) {
1114 QCowL2Meta *next;
1115
4e95314e
KW
1116 if (l2meta->nb_clusters != 0) {
1117 QLIST_REMOVE(l2meta, next_in_flight);
1118 }
1119 qemu_co_queue_restart_all(&l2meta->dependent_requests);
88c6588c
KW
1120
1121 next = l2meta->next;
cf5c1a23 1122 g_free(l2meta);
88c6588c 1123 l2meta = next;
cf5c1a23 1124 }
0fa9131a 1125
3fc48d09 1126 qemu_iovec_destroy(&hd_qiov);
dea43a65 1127 qemu_vfree(cluster_data);
3cce16f4 1128 trace_qcow2_writev_done_req(qemu_coroutine_self(), ret);
42496d62 1129
68d100e9 1130 return ret;
585f8587
FB
1131}
1132
7c80ab3f 1133static void qcow2_close(BlockDriverState *bs)
585f8587
FB
1134{
1135 BDRVQcowState *s = bs->opaque;
7267c094 1136 g_free(s->l1_table);
cf93980e
HR
1137 /* else pre-write overlap checks in cache_destroy may crash */
1138 s->l1_table = NULL;
29c1a730
KW
1139
1140 qcow2_cache_flush(bs, s->l2_table_cache);
1141 qcow2_cache_flush(bs, s->refcount_block_cache);
1142
c61d0004
SH
1143 qcow2_mark_clean(bs);
1144
29c1a730
KW
1145 qcow2_cache_destroy(bs, s->l2_table_cache);
1146 qcow2_cache_destroy(bs, s->refcount_block_cache);
1147
6744cbab 1148 g_free(s->unknown_header_fields);
75bab85c 1149 cleanup_unknown_header_ext(bs);
6744cbab 1150
7267c094 1151 g_free(s->cluster_cache);
dea43a65 1152 qemu_vfree(s->cluster_data);
ed6ccf0f 1153 qcow2_refcount_close(bs);
28c1202b 1154 qcow2_free_snapshots(bs);
585f8587
FB
1155}
1156
06d9260f
AL
1157static void qcow2_invalidate_cache(BlockDriverState *bs)
1158{
1159 BDRVQcowState *s = bs->opaque;
1160 int flags = s->flags;
1161 AES_KEY aes_encrypt_key;
1162 AES_KEY aes_decrypt_key;
1163 uint32_t crypt_method = 0;
acdfb480 1164 QDict *options;
06d9260f
AL
1165
1166 /*
1167 * Backing files are read-only which makes all of their metadata immutable,
1168 * that means we don't have to worry about reopening them here.
1169 */
1170
1171 if (s->crypt_method) {
1172 crypt_method = s->crypt_method;
1173 memcpy(&aes_encrypt_key, &s->aes_encrypt_key, sizeof(aes_encrypt_key));
1174 memcpy(&aes_decrypt_key, &s->aes_decrypt_key, sizeof(aes_decrypt_key));
1175 }
1176
1177 qcow2_close(bs);
1178
3456a8d1
KW
1179 bdrv_invalidate_cache(bs->file);
1180
06d9260f 1181 memset(s, 0, sizeof(BDRVQcowState));
d475e5ac 1182 options = qdict_clone_shallow(bs->options);
015a1036 1183 qcow2_open(bs, options, flags, NULL);
acdfb480
KW
1184
1185 QDECREF(options);
06d9260f
AL
1186
1187 if (crypt_method) {
1188 s->crypt_method = crypt_method;
1189 memcpy(&s->aes_encrypt_key, &aes_encrypt_key, sizeof(aes_encrypt_key));
1190 memcpy(&s->aes_decrypt_key, &aes_decrypt_key, sizeof(aes_decrypt_key));
1191 }
1192}
1193
e24e49e6
KW
1194static size_t header_ext_add(char *buf, uint32_t magic, const void *s,
1195 size_t len, size_t buflen)
1196{
1197 QCowExtension *ext_backing_fmt = (QCowExtension*) buf;
1198 size_t ext_len = sizeof(QCowExtension) + ((len + 7) & ~7);
1199
1200 if (buflen < ext_len) {
1201 return -ENOSPC;
1202 }
1203
1204 *ext_backing_fmt = (QCowExtension) {
1205 .magic = cpu_to_be32(magic),
1206 .len = cpu_to_be32(len),
1207 };
1208 memcpy(buf + sizeof(QCowExtension), s, len);
1209
1210 return ext_len;
1211}
1212
756e6736 1213/*
e24e49e6
KW
1214 * Updates the qcow2 header, including the variable length parts of it, i.e.
1215 * the backing file name and all extensions. qcow2 was not designed to allow
1216 * such changes, so if we run out of space (we can only use the first cluster)
1217 * this function may fail.
756e6736
KW
1218 *
1219 * Returns 0 on success, -errno in error cases.
1220 */
e24e49e6 1221int qcow2_update_header(BlockDriverState *bs)
756e6736 1222{
756e6736 1223 BDRVQcowState *s = bs->opaque;
e24e49e6
KW
1224 QCowHeader *header;
1225 char *buf;
1226 size_t buflen = s->cluster_size;
756e6736 1227 int ret;
e24e49e6
KW
1228 uint64_t total_size;
1229 uint32_t refcount_table_clusters;
6744cbab 1230 size_t header_length;
75bab85c 1231 Qcow2UnknownHeaderExtension *uext;
756e6736 1232
e24e49e6 1233 buf = qemu_blockalign(bs, buflen);
756e6736 1234
e24e49e6
KW
1235 /* Header structure */
1236 header = (QCowHeader*) buf;
756e6736 1237
e24e49e6
KW
1238 if (buflen < sizeof(*header)) {
1239 ret = -ENOSPC;
1240 goto fail;
756e6736
KW
1241 }
1242
6744cbab 1243 header_length = sizeof(*header) + s->unknown_header_fields_size;
e24e49e6
KW
1244 total_size = bs->total_sectors * BDRV_SECTOR_SIZE;
1245 refcount_table_clusters = s->refcount_table_size >> (s->cluster_bits - 3);
1246
1247 *header = (QCowHeader) {
6744cbab 1248 /* Version 2 fields */
e24e49e6 1249 .magic = cpu_to_be32(QCOW_MAGIC),
6744cbab 1250 .version = cpu_to_be32(s->qcow_version),
e24e49e6
KW
1251 .backing_file_offset = 0,
1252 .backing_file_size = 0,
1253 .cluster_bits = cpu_to_be32(s->cluster_bits),
1254 .size = cpu_to_be64(total_size),
1255 .crypt_method = cpu_to_be32(s->crypt_method_header),
1256 .l1_size = cpu_to_be32(s->l1_size),
1257 .l1_table_offset = cpu_to_be64(s->l1_table_offset),
1258 .refcount_table_offset = cpu_to_be64(s->refcount_table_offset),
1259 .refcount_table_clusters = cpu_to_be32(refcount_table_clusters),
1260 .nb_snapshots = cpu_to_be32(s->nb_snapshots),
1261 .snapshots_offset = cpu_to_be64(s->snapshots_offset),
6744cbab
KW
1262
1263 /* Version 3 fields */
1264 .incompatible_features = cpu_to_be64(s->incompatible_features),
1265 .compatible_features = cpu_to_be64(s->compatible_features),
1266 .autoclear_features = cpu_to_be64(s->autoclear_features),
b6481f37 1267 .refcount_order = cpu_to_be32(s->refcount_order),
6744cbab 1268 .header_length = cpu_to_be32(header_length),
e24e49e6 1269 };
756e6736 1270
6744cbab
KW
1271 /* For older versions, write a shorter header */
1272 switch (s->qcow_version) {
1273 case 2:
1274 ret = offsetof(QCowHeader, incompatible_features);
1275 break;
1276 case 3:
1277 ret = sizeof(*header);
1278 break;
1279 default:
b6c14762
JM
1280 ret = -EINVAL;
1281 goto fail;
6744cbab
KW
1282 }
1283
1284 buf += ret;
1285 buflen -= ret;
1286 memset(buf, 0, buflen);
1287
1288 /* Preserve any unknown field in the header */
1289 if (s->unknown_header_fields_size) {
1290 if (buflen < s->unknown_header_fields_size) {
1291 ret = -ENOSPC;
1292 goto fail;
1293 }
1294
1295 memcpy(buf, s->unknown_header_fields, s->unknown_header_fields_size);
1296 buf += s->unknown_header_fields_size;
1297 buflen -= s->unknown_header_fields_size;
1298 }
756e6736 1299
e24e49e6
KW
1300 /* Backing file format header extension */
1301 if (*bs->backing_format) {
1302 ret = header_ext_add(buf, QCOW2_EXT_MAGIC_BACKING_FORMAT,
1303 bs->backing_format, strlen(bs->backing_format),
1304 buflen);
1305 if (ret < 0) {
1306 goto fail;
756e6736
KW
1307 }
1308
e24e49e6
KW
1309 buf += ret;
1310 buflen -= ret;
756e6736
KW
1311 }
1312
cfcc4c62
KW
1313 /* Feature table */
1314 Qcow2Feature features[] = {
c61d0004
SH
1315 {
1316 .type = QCOW2_FEAT_TYPE_INCOMPATIBLE,
1317 .bit = QCOW2_INCOMPAT_DIRTY_BITNR,
1318 .name = "dirty bit",
1319 },
69c98726
HR
1320 {
1321 .type = QCOW2_FEAT_TYPE_INCOMPATIBLE,
1322 .bit = QCOW2_INCOMPAT_CORRUPT_BITNR,
1323 .name = "corrupt bit",
1324 },
bfe8043e
SH
1325 {
1326 .type = QCOW2_FEAT_TYPE_COMPATIBLE,
1327 .bit = QCOW2_COMPAT_LAZY_REFCOUNTS_BITNR,
1328 .name = "lazy refcounts",
1329 },
cfcc4c62
KW
1330 };
1331
1332 ret = header_ext_add(buf, QCOW2_EXT_MAGIC_FEATURE_TABLE,
1333 features, sizeof(features), buflen);
1334 if (ret < 0) {
1335 goto fail;
1336 }
1337 buf += ret;
1338 buflen -= ret;
1339
75bab85c
KW
1340 /* Keep unknown header extensions */
1341 QLIST_FOREACH(uext, &s->unknown_header_ext, next) {
1342 ret = header_ext_add(buf, uext->magic, uext->data, uext->len, buflen);
1343 if (ret < 0) {
1344 goto fail;
1345 }
1346
1347 buf += ret;
1348 buflen -= ret;
1349 }
1350
e24e49e6
KW
1351 /* End of header extensions */
1352 ret = header_ext_add(buf, QCOW2_EXT_MAGIC_END, NULL, 0, buflen);
756e6736
KW
1353 if (ret < 0) {
1354 goto fail;
1355 }
1356
e24e49e6
KW
1357 buf += ret;
1358 buflen -= ret;
756e6736 1359
e24e49e6
KW
1360 /* Backing file name */
1361 if (*bs->backing_file) {
1362 size_t backing_file_len = strlen(bs->backing_file);
1363
1364 if (buflen < backing_file_len) {
1365 ret = -ENOSPC;
1366 goto fail;
1367 }
1368
00ea1881 1369 /* Using strncpy is ok here, since buf is not NUL-terminated. */
e24e49e6
KW
1370 strncpy(buf, bs->backing_file, buflen);
1371
1372 header->backing_file_offset = cpu_to_be64(buf - ((char*) header));
1373 header->backing_file_size = cpu_to_be32(backing_file_len);
756e6736
KW
1374 }
1375
e24e49e6
KW
1376 /* Write the new header */
1377 ret = bdrv_pwrite(bs->file, 0, header, s->cluster_size);
756e6736
KW
1378 if (ret < 0) {
1379 goto fail;
1380 }
1381
1382 ret = 0;
1383fail:
e24e49e6 1384 qemu_vfree(header);
756e6736
KW
1385 return ret;
1386}
1387
1388static int qcow2_change_backing_file(BlockDriverState *bs,
1389 const char *backing_file, const char *backing_fmt)
1390{
e24e49e6
KW
1391 pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: "");
1392 pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: "");
1393
1394 return qcow2_update_header(bs);
756e6736
KW
1395}
1396
a35e1c17
KW
1397static int preallocate(BlockDriverState *bs)
1398{
a35e1c17
KW
1399 uint64_t nb_sectors;
1400 uint64_t offset;
060bee89 1401 uint64_t host_offset = 0;
a35e1c17 1402 int num;
148da7ea 1403 int ret;
f50f88b9 1404 QCowL2Meta *meta;
a35e1c17 1405
7c2bbf4a 1406 nb_sectors = bdrv_getlength(bs) >> BDRV_SECTOR_BITS;
a35e1c17
KW
1407 offset = 0;
1408
1409 while (nb_sectors) {
7c2bbf4a 1410 num = MIN(nb_sectors, INT_MAX >> BDRV_SECTOR_BITS);
16f0587e 1411 ret = qcow2_alloc_cluster_offset(bs, offset, &num,
060bee89 1412 &host_offset, &meta);
148da7ea 1413 if (ret < 0) {
19dbcbf7 1414 return ret;
a35e1c17
KW
1415 }
1416
f50f88b9 1417 if (meta != NULL) {
7c2bbf4a
HT
1418 ret = qcow2_alloc_cluster_link_l2(bs, meta);
1419 if (ret < 0) {
1420 qcow2_free_any_clusters(bs, meta->alloc_offset,
1421 meta->nb_clusters, QCOW2_DISCARD_NEVER);
1422 return ret;
1423 }
1424
1425 /* There are no dependent requests, but we need to remove our
1426 * request from the list of in-flight requests */
4e95314e 1427 QLIST_REMOVE(meta, next_in_flight);
f50f88b9 1428 }
f214978a 1429
a35e1c17
KW
1430 /* TODO Preallocate data if requested */
1431
1432 nb_sectors -= num;
7c2bbf4a 1433 offset += num << BDRV_SECTOR_BITS;
a35e1c17
KW
1434 }
1435
1436 /*
1437 * It is expected that the image file is large enough to actually contain
1438 * all of the allocated clusters (otherwise we get failing reads after
1439 * EOF). Extend the image to the last allocated sector.
1440 */
060bee89 1441 if (host_offset != 0) {
7c2bbf4a
HT
1442 uint8_t buf[BDRV_SECTOR_SIZE];
1443 memset(buf, 0, BDRV_SECTOR_SIZE);
1444 ret = bdrv_write(bs->file, (host_offset >> BDRV_SECTOR_BITS) + num - 1,
1445 buf, 1);
19dbcbf7
KW
1446 if (ret < 0) {
1447 return ret;
1448 }
a35e1c17
KW
1449 }
1450
1451 return 0;
1452}
1453
7c80ab3f
JS
1454static int qcow2_create2(const char *filename, int64_t total_size,
1455 const char *backing_file, const char *backing_format,
1456 int flags, size_t cluster_size, int prealloc,
3ef6c40a
HR
1457 QEMUOptionParameter *options, int version,
1458 Error **errp)
a9420734 1459{
9b2260cb 1460 /* Calculate cluster_bits */
a9420734
KW
1461 int cluster_bits;
1462 cluster_bits = ffs(cluster_size) - 1;
1463 if (cluster_bits < MIN_CLUSTER_BITS || cluster_bits > MAX_CLUSTER_BITS ||
1464 (1 << cluster_bits) != cluster_size)
1465 {
3ef6c40a
HR
1466 error_setg(errp, "Cluster size must be a power of two between %d and "
1467 "%dk", 1 << MIN_CLUSTER_BITS, 1 << (MAX_CLUSTER_BITS - 10));
a9420734
KW
1468 return -EINVAL;
1469 }
1470
1471 /*
1472 * Open the image file and write a minimal qcow2 header.
1473 *
1474 * We keep things simple and start with a zero-sized image. We also
1475 * do without refcount blocks or a L1 table for now. We'll fix the
1476 * inconsistency later.
1477 *
1478 * We do need a refcount table because growing the refcount table means
1479 * allocating two new refcount blocks - the seconds of which would be at
1480 * 2 GB for 64k clusters, and we don't want to have a 2 GB initial file
1481 * size for any qcow2 image.
1482 */
1483 BlockDriverState* bs;
f8413b3c 1484 QCowHeader *header;
a9420734 1485 uint8_t* refcount_table;
3ef6c40a 1486 Error *local_err = NULL;
a9420734
KW
1487 int ret;
1488
3ef6c40a 1489 ret = bdrv_create_file(filename, options, &local_err);
a9420734 1490 if (ret < 0) {
3ef6c40a 1491 error_propagate(errp, local_err);
a9420734
KW
1492 return ret;
1493 }
1494
2e40134b
HR
1495 bs = NULL;
1496 ret = bdrv_open(&bs, filename, NULL, NULL, BDRV_O_RDWR | BDRV_O_PROTOCOL,
1497 NULL, &local_err);
a9420734 1498 if (ret < 0) {
3ef6c40a 1499 error_propagate(errp, local_err);
a9420734
KW
1500 return ret;
1501 }
1502
1503 /* Write the header */
f8413b3c
KW
1504 QEMU_BUILD_BUG_ON((1 << MIN_CLUSTER_BITS) < sizeof(*header));
1505 header = g_malloc0(cluster_size);
1506 *header = (QCowHeader) {
1507 .magic = cpu_to_be32(QCOW_MAGIC),
1508 .version = cpu_to_be32(version),
1509 .cluster_bits = cpu_to_be32(cluster_bits),
1510 .size = cpu_to_be64(0),
1511 .l1_table_offset = cpu_to_be64(0),
1512 .l1_size = cpu_to_be32(0),
1513 .refcount_table_offset = cpu_to_be64(cluster_size),
1514 .refcount_table_clusters = cpu_to_be32(1),
1515 .refcount_order = cpu_to_be32(3 + REFCOUNT_SHIFT),
1516 .header_length = cpu_to_be32(sizeof(*header)),
1517 };
a9420734
KW
1518
1519 if (flags & BLOCK_FLAG_ENCRYPT) {
f8413b3c 1520 header->crypt_method = cpu_to_be32(QCOW_CRYPT_AES);
a9420734 1521 } else {
f8413b3c 1522 header->crypt_method = cpu_to_be32(QCOW_CRYPT_NONE);
a9420734
KW
1523 }
1524
bfe8043e 1525 if (flags & BLOCK_FLAG_LAZY_REFCOUNTS) {
f8413b3c 1526 header->compatible_features |=
bfe8043e
SH
1527 cpu_to_be64(QCOW2_COMPAT_LAZY_REFCOUNTS);
1528 }
1529
f8413b3c
KW
1530 ret = bdrv_pwrite(bs, 0, header, cluster_size);
1531 g_free(header);
a9420734 1532 if (ret < 0) {
3ef6c40a 1533 error_setg_errno(errp, -ret, "Could not write qcow2 header");
a9420734
KW
1534 goto out;
1535 }
1536
1537 /* Write an empty refcount table */
7267c094 1538 refcount_table = g_malloc0(cluster_size);
a9420734 1539 ret = bdrv_pwrite(bs, cluster_size, refcount_table, cluster_size);
7267c094 1540 g_free(refcount_table);
a9420734
KW
1541
1542 if (ret < 0) {
3ef6c40a 1543 error_setg_errno(errp, -ret, "Could not write refcount table");
a9420734
KW
1544 goto out;
1545 }
1546
f67503e5
HR
1547 bdrv_unref(bs);
1548 bs = NULL;
a9420734
KW
1549
1550 /*
1551 * And now open the image and make it consistent first (i.e. increase the
1552 * refcount of the cluster that is occupied by the header and the refcount
1553 * table)
1554 */
1555 BlockDriver* drv = bdrv_find_format("qcow2");
1556 assert(drv != NULL);
ddf5636d 1557 ret = bdrv_open(&bs, filename, NULL, NULL,
3ef6c40a 1558 BDRV_O_RDWR | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH, drv, &local_err);
a9420734 1559 if (ret < 0) {
3ef6c40a 1560 error_propagate(errp, local_err);
a9420734
KW
1561 goto out;
1562 }
1563
1564 ret = qcow2_alloc_clusters(bs, 2 * cluster_size);
1565 if (ret < 0) {
3ef6c40a
HR
1566 error_setg_errno(errp, -ret, "Could not allocate clusters for qcow2 "
1567 "header and refcount table");
a9420734
KW
1568 goto out;
1569
1570 } else if (ret != 0) {
1571 error_report("Huh, first cluster in empty image is already in use?");
1572 abort();
1573 }
1574
1575 /* Okay, now that we have a valid image, let's give it the right size */
1576 ret = bdrv_truncate(bs, total_size * BDRV_SECTOR_SIZE);
1577 if (ret < 0) {
3ef6c40a 1578 error_setg_errno(errp, -ret, "Could not resize image");
a9420734
KW
1579 goto out;
1580 }
1581
1582 /* Want a backing file? There you go.*/
1583 if (backing_file) {
1584 ret = bdrv_change_backing_file(bs, backing_file, backing_format);
1585 if (ret < 0) {
3ef6c40a
HR
1586 error_setg_errno(errp, -ret, "Could not assign backing file '%s' "
1587 "with format '%s'", backing_file, backing_format);
a9420734
KW
1588 goto out;
1589 }
1590 }
1591
1592 /* And if we're supposed to preallocate metadata, do that now */
1593 if (prealloc) {
15552c4a
ZYW
1594 BDRVQcowState *s = bs->opaque;
1595 qemu_co_mutex_lock(&s->lock);
a9420734 1596 ret = preallocate(bs);
15552c4a 1597 qemu_co_mutex_unlock(&s->lock);
a9420734 1598 if (ret < 0) {
3ef6c40a 1599 error_setg_errno(errp, -ret, "Could not preallocate metadata");
a9420734
KW
1600 goto out;
1601 }
1602 }
1603
f67503e5
HR
1604 bdrv_unref(bs);
1605 bs = NULL;
ba2ab2f2
HR
1606
1607 /* Reopen the image without BDRV_O_NO_FLUSH to flush it before returning */
ddf5636d 1608 ret = bdrv_open(&bs, filename, NULL, NULL,
c9fbb99d
KW
1609 BDRV_O_RDWR | BDRV_O_CACHE_WB | BDRV_O_NO_BACKING,
1610 drv, &local_err);
84d18f06 1611 if (local_err) {
ba2ab2f2
HR
1612 error_propagate(errp, local_err);
1613 goto out;
1614 }
1615
a9420734
KW
1616 ret = 0;
1617out:
f67503e5
HR
1618 if (bs) {
1619 bdrv_unref(bs);
1620 }
a9420734
KW
1621 return ret;
1622}
de5f3f40 1623
d5124c00
HR
1624static int qcow2_create(const char *filename, QEMUOptionParameter *options,
1625 Error **errp)
de5f3f40
KW
1626{
1627 const char *backing_file = NULL;
1628 const char *backing_fmt = NULL;
1629 uint64_t sectors = 0;
1630 int flags = 0;
99cce9fa 1631 size_t cluster_size = DEFAULT_CLUSTER_SIZE;
de5f3f40 1632 int prealloc = 0;
8ad1898c 1633 int version = 3;
3ef6c40a
HR
1634 Error *local_err = NULL;
1635 int ret;
de5f3f40
KW
1636
1637 /* Read out options */
1638 while (options && options->name) {
1639 if (!strcmp(options->name, BLOCK_OPT_SIZE)) {
1640 sectors = options->value.n / 512;
1641 } else if (!strcmp(options->name, BLOCK_OPT_BACKING_FILE)) {
1642 backing_file = options->value.s;
1643 } else if (!strcmp(options->name, BLOCK_OPT_BACKING_FMT)) {
1644 backing_fmt = options->value.s;
1645 } else if (!strcmp(options->name, BLOCK_OPT_ENCRYPT)) {
1646 flags |= options->value.n ? BLOCK_FLAG_ENCRYPT : 0;
1647 } else if (!strcmp(options->name, BLOCK_OPT_CLUSTER_SIZE)) {
1648 if (options->value.n) {
1649 cluster_size = options->value.n;
1650 }
1651 } else if (!strcmp(options->name, BLOCK_OPT_PREALLOC)) {
1652 if (!options->value.s || !strcmp(options->value.s, "off")) {
1653 prealloc = 0;
1654 } else if (!strcmp(options->value.s, "metadata")) {
1655 prealloc = 1;
1656 } else {
3ef6c40a
HR
1657 error_setg(errp, "Invalid preallocation mode: '%s'",
1658 options->value.s);
de5f3f40
KW
1659 return -EINVAL;
1660 }
6744cbab 1661 } else if (!strcmp(options->name, BLOCK_OPT_COMPAT_LEVEL)) {
9117b477
KW
1662 if (!options->value.s) {
1663 /* keep the default */
1664 } else if (!strcmp(options->value.s, "0.10")) {
6744cbab
KW
1665 version = 2;
1666 } else if (!strcmp(options->value.s, "1.1")) {
1667 version = 3;
1668 } else {
3ef6c40a
HR
1669 error_setg(errp, "Invalid compatibility level: '%s'",
1670 options->value.s);
6744cbab
KW
1671 return -EINVAL;
1672 }
bfe8043e
SH
1673 } else if (!strcmp(options->name, BLOCK_OPT_LAZY_REFCOUNTS)) {
1674 flags |= options->value.n ? BLOCK_FLAG_LAZY_REFCOUNTS : 0;
de5f3f40
KW
1675 }
1676 options++;
1677 }
1678
1679 if (backing_file && prealloc) {
3ef6c40a
HR
1680 error_setg(errp, "Backing file and preallocation cannot be used at "
1681 "the same time");
de5f3f40
KW
1682 return -EINVAL;
1683 }
1684
bfe8043e 1685 if (version < 3 && (flags & BLOCK_FLAG_LAZY_REFCOUNTS)) {
3ef6c40a
HR
1686 error_setg(errp, "Lazy refcounts only supported with compatibility "
1687 "level 1.1 and above (use compat=1.1 or greater)");
bfe8043e
SH
1688 return -EINVAL;
1689 }
1690
3ef6c40a
HR
1691 ret = qcow2_create2(filename, sectors, backing_file, backing_fmt, flags,
1692 cluster_size, prealloc, options, version, &local_err);
84d18f06 1693 if (local_err) {
3ef6c40a
HR
1694 error_propagate(errp, local_err);
1695 }
1696 return ret;
de5f3f40
KW
1697}
1698
621f0589 1699static coroutine_fn int qcow2_co_write_zeroes(BlockDriverState *bs,
aa7bfbff 1700 int64_t sector_num, int nb_sectors, BdrvRequestFlags flags)
621f0589
KW
1701{
1702 int ret;
1703 BDRVQcowState *s = bs->opaque;
1704
1705 /* Emulate misaligned zero writes */
1706 if (sector_num % s->cluster_sectors || nb_sectors % s->cluster_sectors) {
1707 return -ENOTSUP;
1708 }
1709
1710 /* Whatever is left can use real zero clusters */
1711 qemu_co_mutex_lock(&s->lock);
1712 ret = qcow2_zero_clusters(bs, sector_num << BDRV_SECTOR_BITS,
1713 nb_sectors);
1714 qemu_co_mutex_unlock(&s->lock);
1715
1716 return ret;
1717}
1718
6db39ae2
PB
1719static coroutine_fn int qcow2_co_discard(BlockDriverState *bs,
1720 int64_t sector_num, int nb_sectors)
5ea929e3 1721{
6db39ae2
PB
1722 int ret;
1723 BDRVQcowState *s = bs->opaque;
1724
1725 qemu_co_mutex_lock(&s->lock);
1726 ret = qcow2_discard_clusters(bs, sector_num << BDRV_SECTOR_BITS,
670df5e3 1727 nb_sectors, QCOW2_DISCARD_REQUEST);
6db39ae2
PB
1728 qemu_co_mutex_unlock(&s->lock);
1729 return ret;
5ea929e3
KW
1730}
1731
419b19d9
SH
1732static int qcow2_truncate(BlockDriverState *bs, int64_t offset)
1733{
1734 BDRVQcowState *s = bs->opaque;
2cf7cfa1
KW
1735 int64_t new_l1_size;
1736 int ret;
419b19d9
SH
1737
1738 if (offset & 511) {
259b2173 1739 error_report("The new size must be a multiple of 512");
419b19d9
SH
1740 return -EINVAL;
1741 }
1742
1743 /* cannot proceed if image has snapshots */
1744 if (s->nb_snapshots) {
259b2173 1745 error_report("Can't resize an image which has snapshots");
419b19d9
SH
1746 return -ENOTSUP;
1747 }
1748
1749 /* shrinking is currently not supported */
1750 if (offset < bs->total_sectors * 512) {
259b2173 1751 error_report("qcow2 doesn't support shrinking images yet");
419b19d9
SH
1752 return -ENOTSUP;
1753 }
1754
1755 new_l1_size = size_to_l1(s, offset);
72893756 1756 ret = qcow2_grow_l1_table(bs, new_l1_size, true);
419b19d9
SH
1757 if (ret < 0) {
1758 return ret;
1759 }
1760
1761 /* write updated header.size */
1762 offset = cpu_to_be64(offset);
8b3b7206
KW
1763 ret = bdrv_pwrite_sync(bs->file, offsetof(QCowHeader, size),
1764 &offset, sizeof(uint64_t));
419b19d9
SH
1765 if (ret < 0) {
1766 return ret;
1767 }
1768
1769 s->l1_vm_state_index = new_l1_size;
1770 return 0;
1771}
1772
20d97356
BS
1773/* XXX: put compressed sectors first, then all the cluster aligned
1774 tables to avoid losing bytes in alignment */
7c80ab3f
JS
1775static int qcow2_write_compressed(BlockDriverState *bs, int64_t sector_num,
1776 const uint8_t *buf, int nb_sectors)
20d97356
BS
1777{
1778 BDRVQcowState *s = bs->opaque;
1779 z_stream strm;
1780 int ret, out_len;
1781 uint8_t *out_buf;
1782 uint64_t cluster_offset;
1783
1784 if (nb_sectors == 0) {
1785 /* align end of file to a sector boundary to ease reading with
1786 sector based I/Os */
66f82cee 1787 cluster_offset = bdrv_getlength(bs->file);
20d97356 1788 cluster_offset = (cluster_offset + 511) & ~511;
66f82cee 1789 bdrv_truncate(bs->file, cluster_offset);
20d97356
BS
1790 return 0;
1791 }
1792
f4d38bef
SH
1793 if (nb_sectors != s->cluster_sectors) {
1794 ret = -EINVAL;
1795
1796 /* Zero-pad last write if image size is not cluster aligned */
1797 if (sector_num + nb_sectors == bs->total_sectors &&
1798 nb_sectors < s->cluster_sectors) {
1799 uint8_t *pad_buf = qemu_blockalign(bs, s->cluster_size);
1800 memset(pad_buf, 0, s->cluster_size);
1801 memcpy(pad_buf, buf, nb_sectors * BDRV_SECTOR_SIZE);
1802 ret = qcow2_write_compressed(bs, sector_num,
1803 pad_buf, s->cluster_sectors);
1804 qemu_vfree(pad_buf);
1805 }
1806 return ret;
1807 }
20d97356 1808
7267c094 1809 out_buf = g_malloc(s->cluster_size + (s->cluster_size / 1000) + 128);
20d97356
BS
1810
1811 /* best compression, small window, no zlib header */
1812 memset(&strm, 0, sizeof(strm));
1813 ret = deflateInit2(&strm, Z_DEFAULT_COMPRESSION,
1814 Z_DEFLATED, -12,
1815 9, Z_DEFAULT_STRATEGY);
1816 if (ret != 0) {
8f1efd00
KW
1817 ret = -EINVAL;
1818 goto fail;
20d97356
BS
1819 }
1820
1821 strm.avail_in = s->cluster_size;
1822 strm.next_in = (uint8_t *)buf;
1823 strm.avail_out = s->cluster_size;
1824 strm.next_out = out_buf;
1825
1826 ret = deflate(&strm, Z_FINISH);
1827 if (ret != Z_STREAM_END && ret != Z_OK) {
20d97356 1828 deflateEnd(&strm);
8f1efd00
KW
1829 ret = -EINVAL;
1830 goto fail;
20d97356
BS
1831 }
1832 out_len = strm.next_out - out_buf;
1833
1834 deflateEnd(&strm);
1835
1836 if (ret != Z_STREAM_END || out_len >= s->cluster_size) {
1837 /* could not compress: write normal cluster */
8f1efd00
KW
1838 ret = bdrv_write(bs, sector_num, buf, s->cluster_sectors);
1839 if (ret < 0) {
1840 goto fail;
1841 }
20d97356
BS
1842 } else {
1843 cluster_offset = qcow2_alloc_compressed_cluster_offset(bs,
1844 sector_num << 9, out_len);
8f1efd00
KW
1845 if (!cluster_offset) {
1846 ret = -EIO;
1847 goto fail;
1848 }
20d97356 1849 cluster_offset &= s->cluster_offset_mask;
cf93980e 1850
231bb267 1851 ret = qcow2_pre_write_overlap_check(bs, 0, cluster_offset, out_len);
cf93980e
HR
1852 if (ret < 0) {
1853 goto fail;
1854 }
1855
66f82cee 1856 BLKDBG_EVENT(bs->file, BLKDBG_WRITE_COMPRESSED);
8f1efd00
KW
1857 ret = bdrv_pwrite(bs->file, cluster_offset, out_buf, out_len);
1858 if (ret < 0) {
1859 goto fail;
20d97356
BS
1860 }
1861 }
1862
8f1efd00
KW
1863 ret = 0;
1864fail:
7267c094 1865 g_free(out_buf);
8f1efd00 1866 return ret;
20d97356
BS
1867}
1868
a968168c 1869static coroutine_fn int qcow2_co_flush_to_os(BlockDriverState *bs)
20d97356 1870{
29c1a730
KW
1871 BDRVQcowState *s = bs->opaque;
1872 int ret;
1873
8b94ff85 1874 qemu_co_mutex_lock(&s->lock);
29c1a730
KW
1875 ret = qcow2_cache_flush(bs, s->l2_table_cache);
1876 if (ret < 0) {
c95de7e2 1877 qemu_co_mutex_unlock(&s->lock);
8b94ff85 1878 return ret;
29c1a730
KW
1879 }
1880
bfe8043e
SH
1881 if (qcow2_need_accurate_refcounts(s)) {
1882 ret = qcow2_cache_flush(bs, s->refcount_block_cache);
1883 if (ret < 0) {
1884 qemu_co_mutex_unlock(&s->lock);
1885 return ret;
1886 }
29c1a730 1887 }
8b94ff85 1888 qemu_co_mutex_unlock(&s->lock);
29c1a730 1889
eb489bb1
KW
1890 return 0;
1891}
1892
7c80ab3f 1893static int qcow2_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
20d97356
BS
1894{
1895 BDRVQcowState *s = bs->opaque;
95de6d70
PB
1896 bdi->unallocated_blocks_are_zero = true;
1897 bdi->can_write_zeroes_with_unmap = (s->qcow_version >= 3);
20d97356 1898 bdi->cluster_size = s->cluster_size;
7c80ab3f 1899 bdi->vm_state_offset = qcow2_vm_state_offset(s);
20d97356
BS
1900 return 0;
1901}
1902
37764dfb
HR
1903static ImageInfoSpecific *qcow2_get_specific_info(BlockDriverState *bs)
1904{
1905 BDRVQcowState *s = bs->opaque;
1906 ImageInfoSpecific *spec_info = g_new(ImageInfoSpecific, 1);
1907
1908 *spec_info = (ImageInfoSpecific){
1909 .kind = IMAGE_INFO_SPECIFIC_KIND_QCOW2,
1910 {
1911 .qcow2 = g_new(ImageInfoSpecificQCow2, 1),
1912 },
1913 };
1914 if (s->qcow_version == 2) {
1915 *spec_info->qcow2 = (ImageInfoSpecificQCow2){
1916 .compat = g_strdup("0.10"),
1917 };
1918 } else if (s->qcow_version == 3) {
1919 *spec_info->qcow2 = (ImageInfoSpecificQCow2){
1920 .compat = g_strdup("1.1"),
1921 .lazy_refcounts = s->compatible_features &
1922 QCOW2_COMPAT_LAZY_REFCOUNTS,
1923 .has_lazy_refcounts = true,
1924 };
1925 }
1926
1927 return spec_info;
1928}
1929
20d97356
BS
1930#if 0
1931static void dump_refcounts(BlockDriverState *bs)
1932{
1933 BDRVQcowState *s = bs->opaque;
1934 int64_t nb_clusters, k, k1, size;
1935 int refcount;
1936
66f82cee 1937 size = bdrv_getlength(bs->file);
20d97356
BS
1938 nb_clusters = size_to_clusters(s, size);
1939 for(k = 0; k < nb_clusters;) {
1940 k1 = k;
1941 refcount = get_refcount(bs, k);
1942 k++;
1943 while (k < nb_clusters && get_refcount(bs, k) == refcount)
1944 k++;
0bfcd599
BS
1945 printf("%" PRId64 ": refcount=%d nb=%" PRId64 "\n", k, refcount,
1946 k - k1);
20d97356
BS
1947 }
1948}
1949#endif
1950
cf8074b3
KW
1951static int qcow2_save_vmstate(BlockDriverState *bs, QEMUIOVector *qiov,
1952 int64_t pos)
20d97356
BS
1953{
1954 BDRVQcowState *s = bs->opaque;
eedff66f 1955 int64_t total_sectors = bs->total_sectors;
20d97356 1956 int growable = bs->growable;
6e13610a 1957 bool zero_beyond_eof = bs->zero_beyond_eof;
20d97356
BS
1958 int ret;
1959
66f82cee 1960 BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_SAVE);
20d97356 1961 bs->growable = 1;
6e13610a 1962 bs->zero_beyond_eof = false;
8d3b1a2d 1963 ret = bdrv_pwritev(bs, qcow2_vm_state_offset(s) + pos, qiov);
20d97356 1964 bs->growable = growable;
6e13610a 1965 bs->zero_beyond_eof = zero_beyond_eof;
20d97356 1966
eedff66f
HR
1967 /* bdrv_co_do_writev will have increased the total_sectors value to include
1968 * the VM state - the VM state is however not an actual part of the block
1969 * device, therefore, we need to restore the old value. */
1970 bs->total_sectors = total_sectors;
1971
20d97356
BS
1972 return ret;
1973}
1974
7c80ab3f
JS
1975static int qcow2_load_vmstate(BlockDriverState *bs, uint8_t *buf,
1976 int64_t pos, int size)
20d97356
BS
1977{
1978 BDRVQcowState *s = bs->opaque;
1979 int growable = bs->growable;
0d51b4de 1980 bool zero_beyond_eof = bs->zero_beyond_eof;
20d97356
BS
1981 int ret;
1982
66f82cee 1983 BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_LOAD);
20d97356 1984 bs->growable = 1;
0d51b4de 1985 bs->zero_beyond_eof = false;
7c80ab3f 1986 ret = bdrv_pread(bs, qcow2_vm_state_offset(s) + pos, buf, size);
20d97356 1987 bs->growable = growable;
0d51b4de 1988 bs->zero_beyond_eof = zero_beyond_eof;
20d97356
BS
1989
1990 return ret;
1991}
1992
9296b3ed
HR
1993/*
1994 * Downgrades an image's version. To achieve this, any incompatible features
1995 * have to be removed.
1996 */
1997static int qcow2_downgrade(BlockDriverState *bs, int target_version)
1998{
1999 BDRVQcowState *s = bs->opaque;
2000 int current_version = s->qcow_version;
2001 int ret;
2002
2003 if (target_version == current_version) {
2004 return 0;
2005 } else if (target_version > current_version) {
2006 return -EINVAL;
2007 } else if (target_version != 2) {
2008 return -EINVAL;
2009 }
2010
2011 if (s->refcount_order != 4) {
2012 /* we would have to convert the image to a refcount_order == 4 image
2013 * here; however, since qemu (at the time of writing this) does not
2014 * support anything different than 4 anyway, there is no point in doing
2015 * so right now; however, we should error out (if qemu supports this in
2016 * the future and this code has not been adapted) */
9e3f0892 2017 error_report("qcow2_downgrade: Image refcount orders other than 4 are "
9296b3ed
HR
2018 "currently not supported.");
2019 return -ENOTSUP;
2020 }
2021
2022 /* clear incompatible features */
2023 if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) {
2024 ret = qcow2_mark_clean(bs);
2025 if (ret < 0) {
2026 return ret;
2027 }
2028 }
2029
2030 /* with QCOW2_INCOMPAT_CORRUPT, it is pretty much impossible to get here in
2031 * the first place; if that happens nonetheless, returning -ENOTSUP is the
2032 * best thing to do anyway */
2033
2034 if (s->incompatible_features) {
2035 return -ENOTSUP;
2036 }
2037
2038 /* since we can ignore compatible features, we can set them to 0 as well */
2039 s->compatible_features = 0;
2040 /* if lazy refcounts have been used, they have already been fixed through
2041 * clearing the dirty flag */
2042
2043 /* clearing autoclear features is trivial */
2044 s->autoclear_features = 0;
2045
2046 ret = qcow2_expand_zero_clusters(bs);
2047 if (ret < 0) {
2048 return ret;
2049 }
2050
2051 s->qcow_version = target_version;
2052 ret = qcow2_update_header(bs);
2053 if (ret < 0) {
2054 s->qcow_version = current_version;
2055 return ret;
2056 }
2057 return 0;
2058}
2059
2060static int qcow2_amend_options(BlockDriverState *bs,
2061 QEMUOptionParameter *options)
2062{
2063 BDRVQcowState *s = bs->opaque;
2064 int old_version = s->qcow_version, new_version = old_version;
2065 uint64_t new_size = 0;
2066 const char *backing_file = NULL, *backing_format = NULL;
2067 bool lazy_refcounts = s->use_lazy_refcounts;
2068 int ret;
2069 int i;
2070
2071 for (i = 0; options[i].name; i++)
2072 {
2073 if (!options[i].assigned) {
2074 /* only change explicitly defined options */
2075 continue;
2076 }
2077
2078 if (!strcmp(options[i].name, "compat")) {
2079 if (!options[i].value.s) {
2080 /* preserve default */
2081 } else if (!strcmp(options[i].value.s, "0.10")) {
2082 new_version = 2;
2083 } else if (!strcmp(options[i].value.s, "1.1")) {
2084 new_version = 3;
2085 } else {
2086 fprintf(stderr, "Unknown compatibility level %s.\n",
2087 options[i].value.s);
2088 return -EINVAL;
2089 }
2090 } else if (!strcmp(options[i].name, "preallocation")) {
2091 fprintf(stderr, "Cannot change preallocation mode.\n");
2092 return -ENOTSUP;
2093 } else if (!strcmp(options[i].name, "size")) {
2094 new_size = options[i].value.n;
2095 } else if (!strcmp(options[i].name, "backing_file")) {
2096 backing_file = options[i].value.s;
2097 } else if (!strcmp(options[i].name, "backing_fmt")) {
2098 backing_format = options[i].value.s;
2099 } else if (!strcmp(options[i].name, "encryption")) {
2100 if ((options[i].value.n != !!s->crypt_method)) {
2101 fprintf(stderr, "Changing the encryption flag is not "
2102 "supported.\n");
2103 return -ENOTSUP;
2104 }
2105 } else if (!strcmp(options[i].name, "cluster_size")) {
2106 if (options[i].value.n != s->cluster_size) {
2107 fprintf(stderr, "Changing the cluster size is not "
2108 "supported.\n");
2109 return -ENOTSUP;
2110 }
2111 } else if (!strcmp(options[i].name, "lazy_refcounts")) {
2112 lazy_refcounts = options[i].value.n;
2113 } else {
2114 /* if this assertion fails, this probably means a new option was
2115 * added without having it covered here */
2116 assert(false);
2117 }
2118 }
2119
2120 if (new_version != old_version) {
2121 if (new_version > old_version) {
2122 /* Upgrade */
2123 s->qcow_version = new_version;
2124 ret = qcow2_update_header(bs);
2125 if (ret < 0) {
2126 s->qcow_version = old_version;
2127 return ret;
2128 }
2129 } else {
2130 ret = qcow2_downgrade(bs, new_version);
2131 if (ret < 0) {
2132 return ret;
2133 }
2134 }
2135 }
2136
2137 if (backing_file || backing_format) {
2138 ret = qcow2_change_backing_file(bs, backing_file ?: bs->backing_file,
2139 backing_format ?: bs->backing_format);
2140 if (ret < 0) {
2141 return ret;
2142 }
2143 }
2144
2145 if (s->use_lazy_refcounts != lazy_refcounts) {
2146 if (lazy_refcounts) {
2147 if (s->qcow_version < 3) {
2148 fprintf(stderr, "Lazy refcounts only supported with compatibility "
2149 "level 1.1 and above (use compat=1.1 or greater)\n");
2150 return -EINVAL;
2151 }
2152 s->compatible_features |= QCOW2_COMPAT_LAZY_REFCOUNTS;
2153 ret = qcow2_update_header(bs);
2154 if (ret < 0) {
2155 s->compatible_features &= ~QCOW2_COMPAT_LAZY_REFCOUNTS;
2156 return ret;
2157 }
2158 s->use_lazy_refcounts = true;
2159 } else {
2160 /* make image clean first */
2161 ret = qcow2_mark_clean(bs);
2162 if (ret < 0) {
2163 return ret;
2164 }
2165 /* now disallow lazy refcounts */
2166 s->compatible_features &= ~QCOW2_COMPAT_LAZY_REFCOUNTS;
2167 ret = qcow2_update_header(bs);
2168 if (ret < 0) {
2169 s->compatible_features |= QCOW2_COMPAT_LAZY_REFCOUNTS;
2170 return ret;
2171 }
2172 s->use_lazy_refcounts = false;
2173 }
2174 }
2175
2176 if (new_size) {
2177 ret = bdrv_truncate(bs, new_size);
2178 if (ret < 0) {
2179 return ret;
2180 }
2181 }
2182
2183 return 0;
2184}
2185
7c80ab3f 2186static QEMUOptionParameter qcow2_create_options[] = {
20d97356
BS
2187 {
2188 .name = BLOCK_OPT_SIZE,
2189 .type = OPT_SIZE,
2190 .help = "Virtual disk size"
2191 },
6744cbab
KW
2192 {
2193 .name = BLOCK_OPT_COMPAT_LEVEL,
2194 .type = OPT_STRING,
2195 .help = "Compatibility level (0.10 or 1.1)"
2196 },
20d97356
BS
2197 {
2198 .name = BLOCK_OPT_BACKING_FILE,
2199 .type = OPT_STRING,
2200 .help = "File name of a base image"
2201 },
2202 {
2203 .name = BLOCK_OPT_BACKING_FMT,
2204 .type = OPT_STRING,
2205 .help = "Image format of the base image"
2206 },
2207 {
2208 .name = BLOCK_OPT_ENCRYPT,
2209 .type = OPT_FLAG,
2210 .help = "Encrypt the image"
2211 },
2212 {
2213 .name = BLOCK_OPT_CLUSTER_SIZE,
2214 .type = OPT_SIZE,
99cce9fa
KW
2215 .help = "qcow2 cluster size",
2216 .value = { .n = DEFAULT_CLUSTER_SIZE },
20d97356
BS
2217 },
2218 {
2219 .name = BLOCK_OPT_PREALLOC,
2220 .type = OPT_STRING,
2221 .help = "Preallocation mode (allowed values: off, metadata)"
2222 },
bfe8043e
SH
2223 {
2224 .name = BLOCK_OPT_LAZY_REFCOUNTS,
2225 .type = OPT_FLAG,
2226 .help = "Postpone refcount updates",
2227 },
20d97356
BS
2228 { NULL }
2229};
2230
2231static BlockDriver bdrv_qcow2 = {
7c80ab3f
JS
2232 .format_name = "qcow2",
2233 .instance_size = sizeof(BDRVQcowState),
2234 .bdrv_probe = qcow2_probe,
2235 .bdrv_open = qcow2_open,
2236 .bdrv_close = qcow2_close,
21d82ac9 2237 .bdrv_reopen_prepare = qcow2_reopen_prepare,
7c80ab3f 2238 .bdrv_create = qcow2_create,
3ac21627 2239 .bdrv_has_zero_init = bdrv_has_zero_init_1,
b6b8a333 2240 .bdrv_co_get_block_status = qcow2_co_get_block_status,
7c80ab3f 2241 .bdrv_set_key = qcow2_set_key,
7c80ab3f 2242
c68b89ac
KW
2243 .bdrv_co_readv = qcow2_co_readv,
2244 .bdrv_co_writev = qcow2_co_writev,
eb489bb1 2245 .bdrv_co_flush_to_os = qcow2_co_flush_to_os,
419b19d9 2246
621f0589 2247 .bdrv_co_write_zeroes = qcow2_co_write_zeroes,
6db39ae2 2248 .bdrv_co_discard = qcow2_co_discard,
419b19d9 2249 .bdrv_truncate = qcow2_truncate,
7c80ab3f 2250 .bdrv_write_compressed = qcow2_write_compressed,
20d97356
BS
2251
2252 .bdrv_snapshot_create = qcow2_snapshot_create,
2253 .bdrv_snapshot_goto = qcow2_snapshot_goto,
2254 .bdrv_snapshot_delete = qcow2_snapshot_delete,
2255 .bdrv_snapshot_list = qcow2_snapshot_list,
51ef6727 2256 .bdrv_snapshot_load_tmp = qcow2_snapshot_load_tmp,
7c80ab3f 2257 .bdrv_get_info = qcow2_get_info,
37764dfb 2258 .bdrv_get_specific_info = qcow2_get_specific_info,
20d97356 2259
7c80ab3f
JS
2260 .bdrv_save_vmstate = qcow2_save_vmstate,
2261 .bdrv_load_vmstate = qcow2_load_vmstate,
20d97356
BS
2262
2263 .bdrv_change_backing_file = qcow2_change_backing_file,
2264
d34682cd 2265 .bdrv_refresh_limits = qcow2_refresh_limits,
06d9260f
AL
2266 .bdrv_invalidate_cache = qcow2_invalidate_cache,
2267
7c80ab3f
JS
2268 .create_options = qcow2_create_options,
2269 .bdrv_check = qcow2_check,
9296b3ed 2270 .bdrv_amend_options = qcow2_amend_options,
20d97356
BS
2271};
2272
5efa9d5a
AL
2273static void bdrv_qcow2_init(void)
2274{
2275 bdrv_register(&bdrv_qcow2);
2276}
2277
2278block_init(bdrv_qcow2_init);