]> git.proxmox.com Git - qemu.git/blame - block/qcow2.c
qemu-iotests: ignore qemu-img create lazy_refcounts output
[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"
585f8587 25#include "block_int.h"
5efa9d5a 26#include "module.h"
585f8587
FB
27#include <zlib.h>
28#include "aes.h"
f7d0fe02 29#include "block/qcow2.h"
a9420734 30#include "qemu-error.h"
e8cdcec1 31#include "qerror.h"
3cce16f4 32#include "trace.h"
585f8587
FB
33
34/*
35 Differences with QCOW:
36
37 - Support for multiple incremental snapshots.
38 - Memory management by reference counts.
39 - Clusters which have a reference count of one have the bit
40 QCOW_OFLAG_COPIED to optimize write performance.
5fafdf24 41 - Size of compressed clusters is stored in sectors to reduce bit usage
585f8587
FB
42 in the cluster offsets.
43 - Support for storing additional data (such as the VM state) in the
3b46e624 44 snapshots.
585f8587
FB
45 - If a backing store is used, the cluster size is not constrained
46 (could be backported to QCOW).
47 - L2 tables have always a size of one cluster.
48*/
49
9b80ddf3
AL
50
51typedef struct {
52 uint32_t magic;
53 uint32_t len;
54} QCowExtension;
7c80ab3f
JS
55#define QCOW2_EXT_MAGIC_END 0
56#define QCOW2_EXT_MAGIC_BACKING_FORMAT 0xE2792ACA
cfcc4c62 57#define QCOW2_EXT_MAGIC_FEATURE_TABLE 0x6803f857
9b80ddf3 58
7c80ab3f 59static int qcow2_probe(const uint8_t *buf, int buf_size, const char *filename)
585f8587
FB
60{
61 const QCowHeader *cow_header = (const void *)buf;
3b46e624 62
585f8587
FB
63 if (buf_size >= sizeof(QCowHeader) &&
64 be32_to_cpu(cow_header->magic) == QCOW_MAGIC &&
6744cbab 65 be32_to_cpu(cow_header->version) >= 2)
585f8587
FB
66 return 100;
67 else
68 return 0;
69}
70
9b80ddf3
AL
71
72/*
73 * read qcow2 extension and fill bs
74 * start reading from start_offset
75 * finish reading upon magic of value 0 or when end_offset reached
76 * unknown magic is skipped (future extension this version knows nothing about)
77 * return 0 upon success, non-0 otherwise
78 */
7c80ab3f 79static int qcow2_read_extensions(BlockDriverState *bs, uint64_t start_offset,
cfcc4c62 80 uint64_t end_offset, void **p_feature_table)
9b80ddf3 81{
75bab85c 82 BDRVQcowState *s = bs->opaque;
9b80ddf3
AL
83 QCowExtension ext;
84 uint64_t offset;
75bab85c 85 int ret;
9b80ddf3
AL
86
87#ifdef DEBUG_EXT
7c80ab3f 88 printf("qcow2_read_extensions: start=%ld end=%ld\n", start_offset, end_offset);
9b80ddf3
AL
89#endif
90 offset = start_offset;
91 while (offset < end_offset) {
92
93#ifdef DEBUG_EXT
94 /* Sanity check */
95 if (offset > s->cluster_size)
7c80ab3f 96 printf("qcow2_read_extension: suspicious offset %lu\n", offset);
9b80ddf3 97
9b2260cb 98 printf("attempting to read extended header in offset %lu\n", offset);
9b80ddf3
AL
99#endif
100
66f82cee 101 if (bdrv_pread(bs->file, offset, &ext, sizeof(ext)) != sizeof(ext)) {
7c80ab3f 102 fprintf(stderr, "qcow2_read_extension: ERROR: "
0bfcd599
BS
103 "pread fail from offset %" PRIu64 "\n",
104 offset);
9b80ddf3
AL
105 return 1;
106 }
107 be32_to_cpus(&ext.magic);
108 be32_to_cpus(&ext.len);
109 offset += sizeof(ext);
110#ifdef DEBUG_EXT
111 printf("ext.magic = 0x%x\n", ext.magic);
112#endif
64ca6aee
KW
113 if (ext.len > end_offset - offset) {
114 error_report("Header extension too large");
115 return -EINVAL;
116 }
117
9b80ddf3 118 switch (ext.magic) {
7c80ab3f 119 case QCOW2_EXT_MAGIC_END:
9b80ddf3 120 return 0;
f965509c 121
7c80ab3f 122 case QCOW2_EXT_MAGIC_BACKING_FORMAT:
f965509c
AL
123 if (ext.len >= sizeof(bs->backing_format)) {
124 fprintf(stderr, "ERROR: ext_backing_format: len=%u too large"
4c978075 125 " (>=%zu)\n",
f965509c
AL
126 ext.len, sizeof(bs->backing_format));
127 return 2;
128 }
66f82cee 129 if (bdrv_pread(bs->file, offset , bs->backing_format,
f965509c
AL
130 ext.len) != ext.len)
131 return 3;
132 bs->backing_format[ext.len] = '\0';
133#ifdef DEBUG_EXT
134 printf("Qcow2: Got format extension %s\n", bs->backing_format);
135#endif
f965509c
AL
136 break;
137
cfcc4c62
KW
138 case QCOW2_EXT_MAGIC_FEATURE_TABLE:
139 if (p_feature_table != NULL) {
140 void* feature_table = g_malloc0(ext.len + 2 * sizeof(Qcow2Feature));
141 ret = bdrv_pread(bs->file, offset , feature_table, ext.len);
142 if (ret < 0) {
143 return ret;
144 }
145
146 *p_feature_table = feature_table;
147 }
148 break;
149
9b80ddf3 150 default:
75bab85c
KW
151 /* unknown magic - save it in case we need to rewrite the header */
152 {
153 Qcow2UnknownHeaderExtension *uext;
154
155 uext = g_malloc0(sizeof(*uext) + ext.len);
156 uext->magic = ext.magic;
157 uext->len = ext.len;
158 QLIST_INSERT_HEAD(&s->unknown_header_ext, uext, next);
159
160 ret = bdrv_pread(bs->file, offset , uext->data, uext->len);
161 if (ret < 0) {
162 return ret;
163 }
75bab85c 164 }
9b80ddf3
AL
165 break;
166 }
fd29b4bb
KW
167
168 offset += ((ext.len + 7) & ~7);
9b80ddf3
AL
169 }
170
171 return 0;
172}
173
75bab85c
KW
174static void cleanup_unknown_header_ext(BlockDriverState *bs)
175{
176 BDRVQcowState *s = bs->opaque;
177 Qcow2UnknownHeaderExtension *uext, *next;
178
179 QLIST_FOREACH_SAFE(uext, &s->unknown_header_ext, next, next) {
180 QLIST_REMOVE(uext, next);
181 g_free(uext);
182 }
183}
9b80ddf3 184
b9531b6e
SW
185static void GCC_FMT_ATTR(2, 3) report_unsupported(BlockDriverState *bs,
186 const char *fmt, ...)
6744cbab
KW
187{
188 char msg[64];
189 va_list ap;
190
191 va_start(ap, fmt);
192 vsnprintf(msg, sizeof(msg), fmt, ap);
193 va_end(ap);
194
195 qerror_report(QERR_UNKNOWN_BLOCK_FORMAT_FEATURE,
196 bs->device_name, "qcow2", msg);
197}
198
cfcc4c62
KW
199static void report_unsupported_feature(BlockDriverState *bs,
200 Qcow2Feature *table, uint64_t mask)
201{
202 while (table && table->name[0] != '\0') {
203 if (table->type == QCOW2_FEAT_TYPE_INCOMPATIBLE) {
204 if (mask & (1 << table->bit)) {
205 report_unsupported(bs, "%.46s",table->name);
206 mask &= ~(1 << table->bit);
207 }
208 }
209 table++;
210 }
211
212 if (mask) {
213 report_unsupported(bs, "Unknown incompatible feature: %" PRIx64, mask);
214 }
215}
216
c61d0004
SH
217/*
218 * Clears the dirty bit and flushes before if necessary. Only call this
219 * function when there are no pending requests, it does not guard against
220 * concurrent requests dirtying the image.
221 */
222static int qcow2_mark_clean(BlockDriverState *bs)
223{
224 BDRVQcowState *s = bs->opaque;
225
226 if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) {
227 int ret = bdrv_flush(bs);
228 if (ret < 0) {
229 return ret;
230 }
231
232 s->incompatible_features &= ~QCOW2_INCOMPAT_DIRTY;
233 return qcow2_update_header(bs);
234 }
235 return 0;
236}
237
7c80ab3f 238static int qcow2_open(BlockDriverState *bs, int flags)
585f8587
FB
239{
240 BDRVQcowState *s = bs->opaque;
6d85a57e 241 int len, i, ret = 0;
585f8587 242 QCowHeader header;
9b80ddf3 243 uint64_t ext_end;
585f8587 244
6d85a57e
JS
245 ret = bdrv_pread(bs->file, 0, &header, sizeof(header));
246 if (ret < 0) {
585f8587 247 goto fail;
6d85a57e 248 }
585f8587
FB
249 be32_to_cpus(&header.magic);
250 be32_to_cpus(&header.version);
251 be64_to_cpus(&header.backing_file_offset);
252 be32_to_cpus(&header.backing_file_size);
253 be64_to_cpus(&header.size);
254 be32_to_cpus(&header.cluster_bits);
255 be32_to_cpus(&header.crypt_method);
256 be64_to_cpus(&header.l1_table_offset);
257 be32_to_cpus(&header.l1_size);
258 be64_to_cpus(&header.refcount_table_offset);
259 be32_to_cpus(&header.refcount_table_clusters);
260 be64_to_cpus(&header.snapshots_offset);
261 be32_to_cpus(&header.nb_snapshots);
3b46e624 262
e8cdcec1 263 if (header.magic != QCOW_MAGIC) {
6d85a57e 264 ret = -EINVAL;
585f8587 265 goto fail;
6d85a57e 266 }
6744cbab
KW
267 if (header.version < 2 || header.version > 3) {
268 report_unsupported(bs, "QCOW version %d", header.version);
269 ret = -ENOTSUP;
270 goto fail;
271 }
272
273 s->qcow_version = header.version;
274
275 /* Initialise version 3 header fields */
276 if (header.version == 2) {
277 header.incompatible_features = 0;
278 header.compatible_features = 0;
279 header.autoclear_features = 0;
280 header.refcount_order = 4;
281 header.header_length = 72;
282 } else {
283 be64_to_cpus(&header.incompatible_features);
284 be64_to_cpus(&header.compatible_features);
285 be64_to_cpus(&header.autoclear_features);
286 be32_to_cpus(&header.refcount_order);
287 be32_to_cpus(&header.header_length);
288 }
289
290 if (header.header_length > sizeof(header)) {
291 s->unknown_header_fields_size = header.header_length - sizeof(header);
292 s->unknown_header_fields = g_malloc(s->unknown_header_fields_size);
293 ret = bdrv_pread(bs->file, sizeof(header), s->unknown_header_fields,
294 s->unknown_header_fields_size);
295 if (ret < 0) {
296 goto fail;
297 }
298 }
299
cfcc4c62
KW
300 if (header.backing_file_offset) {
301 ext_end = header.backing_file_offset;
302 } else {
303 ext_end = 1 << header.cluster_bits;
304 }
305
6744cbab
KW
306 /* Handle feature bits */
307 s->incompatible_features = header.incompatible_features;
308 s->compatible_features = header.compatible_features;
309 s->autoclear_features = header.autoclear_features;
310
c61d0004 311 if (s->incompatible_features & ~QCOW2_INCOMPAT_MASK) {
cfcc4c62
KW
312 void *feature_table = NULL;
313 qcow2_read_extensions(bs, header.header_length, ext_end,
314 &feature_table);
315 report_unsupported_feature(bs, feature_table,
c61d0004
SH
316 s->incompatible_features &
317 ~QCOW2_INCOMPAT_MASK);
6744cbab
KW
318 ret = -ENOTSUP;
319 goto fail;
320 }
321
6744cbab
KW
322 /* Check support for various header values */
323 if (header.refcount_order != 4) {
324 report_unsupported(bs, "%d bit reference counts",
325 1 << header.refcount_order);
e8cdcec1
KW
326 ret = -ENOTSUP;
327 goto fail;
328 }
6744cbab 329
d191d12d 330 if (header.cluster_bits < MIN_CLUSTER_BITS ||
6d85a57e
JS
331 header.cluster_bits > MAX_CLUSTER_BITS) {
332 ret = -EINVAL;
585f8587 333 goto fail;
6d85a57e
JS
334 }
335 if (header.crypt_method > QCOW_CRYPT_AES) {
336 ret = -EINVAL;
585f8587 337 goto fail;
6d85a57e 338 }
585f8587 339 s->crypt_method_header = header.crypt_method;
6d85a57e 340 if (s->crypt_method_header) {
585f8587 341 bs->encrypted = 1;
6d85a57e 342 }
585f8587
FB
343 s->cluster_bits = header.cluster_bits;
344 s->cluster_size = 1 << s->cluster_bits;
345 s->cluster_sectors = 1 << (s->cluster_bits - 9);
346 s->l2_bits = s->cluster_bits - 3; /* L2 is always one cluster */
347 s->l2_size = 1 << s->l2_bits;
348 bs->total_sectors = header.size / 512;
349 s->csize_shift = (62 - (s->cluster_bits - 8));
350 s->csize_mask = (1 << (s->cluster_bits - 8)) - 1;
351 s->cluster_offset_mask = (1LL << s->csize_shift) - 1;
352 s->refcount_table_offset = header.refcount_table_offset;
5fafdf24 353 s->refcount_table_size =
585f8587
FB
354 header.refcount_table_clusters << (s->cluster_bits - 3);
355
356 s->snapshots_offset = header.snapshots_offset;
357 s->nb_snapshots = header.nb_snapshots;
358
359 /* read the level 1 table */
360 s->l1_size = header.l1_size;
419b19d9 361 s->l1_vm_state_index = size_to_l1(s, header.size);
585f8587
FB
362 /* the L1 table must contain at least enough entries to put
363 header.size bytes */
6d85a57e
JS
364 if (s->l1_size < s->l1_vm_state_index) {
365 ret = -EINVAL;
585f8587 366 goto fail;
6d85a57e 367 }
585f8587 368 s->l1_table_offset = header.l1_table_offset;
d191d12d 369 if (s->l1_size > 0) {
7267c094 370 s->l1_table = g_malloc0(
d191d12d 371 align_offset(s->l1_size * sizeof(uint64_t), 512));
6d85a57e
JS
372 ret = bdrv_pread(bs->file, s->l1_table_offset, s->l1_table,
373 s->l1_size * sizeof(uint64_t));
374 if (ret < 0) {
d191d12d 375 goto fail;
6d85a57e 376 }
d191d12d
SW
377 for(i = 0;i < s->l1_size; i++) {
378 be64_to_cpus(&s->l1_table[i]);
379 }
585f8587 380 }
29c1a730
KW
381
382 /* alloc L2 table/refcount block cache */
6af4e9ea
PB
383 s->l2_table_cache = qcow2_cache_create(bs, L2_CACHE_SIZE);
384 s->refcount_block_cache = qcow2_cache_create(bs, REFCOUNT_CACHE_SIZE);
29c1a730 385
7267c094 386 s->cluster_cache = g_malloc(s->cluster_size);
585f8587 387 /* one more sector for decompressed data alignment */
dea43a65 388 s->cluster_data = qemu_blockalign(bs, QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size
095a9c58 389 + 512);
585f8587 390 s->cluster_cache_offset = -1;
06d9260f 391 s->flags = flags;
3b46e624 392
6d85a57e
JS
393 ret = qcow2_refcount_init(bs);
394 if (ret != 0) {
585f8587 395 goto fail;
6d85a57e 396 }
585f8587 397
72cf2d4f 398 QLIST_INIT(&s->cluster_allocs);
f214978a 399
9b80ddf3 400 /* read qcow2 extensions */
cfcc4c62 401 if (qcow2_read_extensions(bs, header.header_length, ext_end, NULL)) {
6d85a57e 402 ret = -EINVAL;
9b80ddf3 403 goto fail;
6d85a57e 404 }
9b80ddf3 405
585f8587
FB
406 /* read the backing file name */
407 if (header.backing_file_offset != 0) {
408 len = header.backing_file_size;
6d85a57e 409 if (len > 1023) {
585f8587 410 len = 1023;
6d85a57e
JS
411 }
412 ret = bdrv_pread(bs->file, header.backing_file_offset,
413 bs->backing_file, len);
414 if (ret < 0) {
585f8587 415 goto fail;
6d85a57e 416 }
585f8587
FB
417 bs->backing_file[len] = '\0';
418 }
42deb29f
KW
419
420 ret = qcow2_read_snapshots(bs);
421 if (ret < 0) {
585f8587 422 goto fail;
6d85a57e 423 }
585f8587 424
af7b708d
SH
425 /* Clear unknown autoclear feature bits */
426 if (!bs->read_only && s->autoclear_features != 0) {
427 s->autoclear_features = 0;
428 ret = qcow2_update_header(bs);
429 if (ret < 0) {
430 goto fail;
431 }
432 }
433
68d100e9
KW
434 /* Initialise locks */
435 qemu_co_mutex_init(&s->lock);
436
c61d0004
SH
437 /* Repair image if dirty */
438 if ((s->incompatible_features & QCOW2_INCOMPAT_DIRTY) &&
439 !bs->read_only) {
440 BdrvCheckResult result = {0};
441
442 ret = qcow2_check_refcounts(bs, &result, BDRV_FIX_ERRORS);
443 if (ret < 0) {
444 goto fail;
445 }
446
447 ret = qcow2_mark_clean(bs);
448 if (ret < 0) {
449 goto fail;
450 }
451 }
452
585f8587 453#ifdef DEBUG_ALLOC
6cbc3031
PH
454 {
455 BdrvCheckResult result = {0};
b35278f7 456 qcow2_check_refcounts(bs, &result, 0);
6cbc3031 457 }
585f8587 458#endif
6d85a57e 459 return ret;
585f8587
FB
460
461 fail:
6744cbab 462 g_free(s->unknown_header_fields);
75bab85c 463 cleanup_unknown_header_ext(bs);
ed6ccf0f
KW
464 qcow2_free_snapshots(bs);
465 qcow2_refcount_close(bs);
7267c094 466 g_free(s->l1_table);
29c1a730
KW
467 if (s->l2_table_cache) {
468 qcow2_cache_destroy(bs, s->l2_table_cache);
469 }
7267c094 470 g_free(s->cluster_cache);
dea43a65 471 qemu_vfree(s->cluster_data);
6d85a57e 472 return ret;
585f8587
FB
473}
474
7c80ab3f 475static int qcow2_set_key(BlockDriverState *bs, const char *key)
585f8587
FB
476{
477 BDRVQcowState *s = bs->opaque;
478 uint8_t keybuf[16];
479 int len, i;
3b46e624 480
585f8587
FB
481 memset(keybuf, 0, 16);
482 len = strlen(key);
483 if (len > 16)
484 len = 16;
485 /* XXX: we could compress the chars to 7 bits to increase
486 entropy */
487 for(i = 0;i < len;i++) {
488 keybuf[i] = key[i];
489 }
490 s->crypt_method = s->crypt_method_header;
491
492 if (AES_set_encrypt_key(keybuf, 128, &s->aes_encrypt_key) != 0)
493 return -1;
494 if (AES_set_decrypt_key(keybuf, 128, &s->aes_decrypt_key) != 0)
495 return -1;
496#if 0
497 /* test */
498 {
499 uint8_t in[16];
500 uint8_t out[16];
501 uint8_t tmp[16];
502 for(i=0;i<16;i++)
503 in[i] = i;
504 AES_encrypt(in, tmp, &s->aes_encrypt_key);
505 AES_decrypt(tmp, out, &s->aes_decrypt_key);
506 for(i = 0; i < 16; i++)
507 printf(" %02x", tmp[i]);
508 printf("\n");
509 for(i = 0; i < 16; i++)
510 printf(" %02x", out[i]);
511 printf("\n");
512 }
513#endif
514 return 0;
515}
516
f8a2e5e3
SH
517static int coroutine_fn qcow2_co_is_allocated(BlockDriverState *bs,
518 int64_t sector_num, int nb_sectors, int *pnum)
585f8587 519{
f8a2e5e3 520 BDRVQcowState *s = bs->opaque;
585f8587 521 uint64_t cluster_offset;
1c46efaa 522 int ret;
585f8587 523
095a9c58 524 *pnum = nb_sectors;
f8a2e5e3
SH
525 /* FIXME We can get errors here, but the bdrv_co_is_allocated interface
526 * can't pass them on today */
527 qemu_co_mutex_lock(&s->lock);
1c46efaa 528 ret = qcow2_get_cluster_offset(bs, sector_num << 9, pnum, &cluster_offset);
f8a2e5e3 529 qemu_co_mutex_unlock(&s->lock);
1c46efaa
KW
530 if (ret < 0) {
531 *pnum = 0;
532 }
095a9c58 533
585f8587
FB
534 return (cluster_offset != 0);
535}
536
a9465922 537/* handle reading after the end of the backing file */
bd28f835
KW
538int qcow2_backing_read1(BlockDriverState *bs, QEMUIOVector *qiov,
539 int64_t sector_num, int nb_sectors)
a9465922
FB
540{
541 int n1;
542 if ((sector_num + nb_sectors) <= bs->total_sectors)
543 return nb_sectors;
544 if (sector_num >= bs->total_sectors)
545 n1 = 0;
546 else
547 n1 = bs->total_sectors - sector_num;
bd28f835 548
3d9b4925 549 qemu_iovec_memset(qiov, 512 * n1, 0, 512 * (nb_sectors - n1));
bd28f835 550
a9465922
FB
551 return n1;
552}
553
a968168c 554static coroutine_fn int qcow2_co_readv(BlockDriverState *bs, int64_t sector_num,
3fc48d09 555 int remaining_sectors, QEMUIOVector *qiov)
585f8587 556{
585f8587 557 BDRVQcowState *s = bs->opaque;
a9465922 558 int index_in_cluster, n1;
68d100e9 559 int ret;
faf575c1 560 int cur_nr_sectors; /* number of sectors in current iteration */
c2bdd990 561 uint64_t cluster_offset = 0;
3fc48d09
FZ
562 uint64_t bytes_done = 0;
563 QEMUIOVector hd_qiov;
564 uint8_t *cluster_data = NULL;
585f8587 565
3fc48d09
FZ
566 qemu_iovec_init(&hd_qiov, qiov->niov);
567
568 qemu_co_mutex_lock(&s->lock);
569
570 while (remaining_sectors != 0) {
bd28f835 571
5ebaa27e 572 /* prepare next request */
3fc48d09 573 cur_nr_sectors = remaining_sectors;
5ebaa27e
FZ
574 if (s->crypt_method) {
575 cur_nr_sectors = MIN(cur_nr_sectors,
576 QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors);
585f8587 577 }
5ebaa27e 578
3fc48d09 579 ret = qcow2_get_cluster_offset(bs, sector_num << 9,
5ebaa27e 580 &cur_nr_sectors, &cluster_offset);
8af36488 581 if (ret < 0) {
3fc48d09 582 goto fail;
8af36488 583 }
bd28f835 584
3fc48d09 585 index_in_cluster = sector_num & (s->cluster_sectors - 1);
c87c0672 586
3fc48d09 587 qemu_iovec_reset(&hd_qiov);
1b093c48 588 qemu_iovec_concat(&hd_qiov, qiov, bytes_done,
5ebaa27e
FZ
589 cur_nr_sectors * 512);
590
68d000a3
KW
591 switch (ret) {
592 case QCOW2_CLUSTER_UNALLOCATED:
5ebaa27e
FZ
593
594 if (bs->backing_hd) {
595 /* read from the base image */
3fc48d09
FZ
596 n1 = qcow2_backing_read1(bs->backing_hd, &hd_qiov,
597 sector_num, cur_nr_sectors);
5ebaa27e
FZ
598 if (n1 > 0) {
599 BLKDBG_EVENT(bs->file, BLKDBG_READ_BACKING_AIO);
600 qemu_co_mutex_unlock(&s->lock);
3fc48d09
FZ
601 ret = bdrv_co_readv(bs->backing_hd, sector_num,
602 n1, &hd_qiov);
5ebaa27e
FZ
603 qemu_co_mutex_lock(&s->lock);
604 if (ret < 0) {
3fc48d09 605 goto fail;
5ebaa27e
FZ
606 }
607 }
608 } else {
609 /* Note: in this case, no need to wait */
3d9b4925 610 qemu_iovec_memset(&hd_qiov, 0, 0, 512 * cur_nr_sectors);
5ebaa27e 611 }
68d000a3
KW
612 break;
613
6377af48
KW
614 case QCOW2_CLUSTER_ZERO:
615 if (s->qcow_version < 3) {
616 ret = -EIO;
617 goto fail;
618 }
3d9b4925 619 qemu_iovec_memset(&hd_qiov, 0, 0, 512 * cur_nr_sectors);
6377af48
KW
620 break;
621
68d000a3 622 case QCOW2_CLUSTER_COMPRESSED:
5ebaa27e
FZ
623 /* add AIO support for compressed blocks ? */
624 ret = qcow2_decompress_cluster(bs, cluster_offset);
625 if (ret < 0) {
3fc48d09 626 goto fail;
bd28f835
KW
627 }
628
03396148 629 qemu_iovec_from_buf(&hd_qiov, 0,
5ebaa27e 630 s->cluster_cache + index_in_cluster * 512,
faf575c1 631 512 * cur_nr_sectors);
68d000a3
KW
632 break;
633
634 case QCOW2_CLUSTER_NORMAL:
5ebaa27e 635 if ((cluster_offset & 511) != 0) {
3fc48d09
FZ
636 ret = -EIO;
637 goto fail;
5ebaa27e 638 }
bd28f835 639
5ebaa27e
FZ
640 if (s->crypt_method) {
641 /*
642 * For encrypted images, read everything into a temporary
643 * contiguous buffer on which the AES functions can work.
644 */
3fc48d09
FZ
645 if (!cluster_data) {
646 cluster_data =
dea43a65 647 qemu_blockalign(bs, QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size);
5ebaa27e
FZ
648 }
649
650 assert(cur_nr_sectors <=
651 QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors);
3fc48d09
FZ
652 qemu_iovec_reset(&hd_qiov);
653 qemu_iovec_add(&hd_qiov, cluster_data,
5ebaa27e
FZ
654 512 * cur_nr_sectors);
655 }
656
657 BLKDBG_EVENT(bs->file, BLKDBG_READ_AIO);
658 qemu_co_mutex_unlock(&s->lock);
659 ret = bdrv_co_readv(bs->file,
660 (cluster_offset >> 9) + index_in_cluster,
3fc48d09 661 cur_nr_sectors, &hd_qiov);
5ebaa27e
FZ
662 qemu_co_mutex_lock(&s->lock);
663 if (ret < 0) {
3fc48d09 664 goto fail;
5ebaa27e
FZ
665 }
666 if (s->crypt_method) {
3fc48d09
FZ
667 qcow2_encrypt_sectors(s, sector_num, cluster_data,
668 cluster_data, cur_nr_sectors, 0, &s->aes_decrypt_key);
03396148
MT
669 qemu_iovec_from_buf(qiov, bytes_done,
670 cluster_data, 512 * cur_nr_sectors);
5ebaa27e 671 }
68d000a3
KW
672 break;
673
674 default:
675 g_assert_not_reached();
676 ret = -EIO;
677 goto fail;
faf575c1 678 }
f141eafe 679
3fc48d09
FZ
680 remaining_sectors -= cur_nr_sectors;
681 sector_num += cur_nr_sectors;
682 bytes_done += cur_nr_sectors * 512;
5ebaa27e 683 }
3fc48d09 684 ret = 0;
faf575c1 685
3fc48d09 686fail:
68d100e9 687 qemu_co_mutex_unlock(&s->lock);
42496d62 688
3fc48d09 689 qemu_iovec_destroy(&hd_qiov);
dea43a65 690 qemu_vfree(cluster_data);
68d100e9
KW
691
692 return ret;
585f8587
FB
693}
694
68d100e9 695static void run_dependent_requests(BDRVQcowState *s, QCowL2Meta *m)
f214978a 696{
f214978a
KW
697 /* Take the request off the list of running requests */
698 if (m->nb_clusters != 0) {
72cf2d4f 699 QLIST_REMOVE(m, next_in_flight);
f214978a
KW
700 }
701
d4c146f0 702 /* Restart all dependent requests */
68d100e9
KW
703 if (!qemu_co_queue_empty(&m->dependent_requests)) {
704 qemu_co_mutex_unlock(&s->lock);
e8ee5e4c 705 qemu_co_queue_restart_all(&m->dependent_requests);
68d100e9 706 qemu_co_mutex_lock(&s->lock);
f214978a 707 }
f214978a
KW
708}
709
a968168c 710static coroutine_fn int qcow2_co_writev(BlockDriverState *bs,
3fc48d09
FZ
711 int64_t sector_num,
712 int remaining_sectors,
713 QEMUIOVector *qiov)
585f8587 714{
585f8587 715 BDRVQcowState *s = bs->opaque;
585f8587 716 int index_in_cluster;
095a9c58 717 int n_end;
68d100e9 718 int ret;
faf575c1 719 int cur_nr_sectors; /* number of sectors in current iteration */
c2bdd990 720 uint64_t cluster_offset;
3fc48d09
FZ
721 QEMUIOVector hd_qiov;
722 uint64_t bytes_done = 0;
723 uint8_t *cluster_data = NULL;
8e217d53
KW
724 QCowL2Meta l2meta = {
725 .nb_clusters = 0,
726 };
c2271403 727
3cce16f4
KW
728 trace_qcow2_writev_start_req(qemu_coroutine_self(), sector_num,
729 remaining_sectors);
730
c2271403 731 qemu_co_queue_init(&l2meta.dependent_requests);
585f8587 732
3fc48d09
FZ
733 qemu_iovec_init(&hd_qiov, qiov->niov);
734
735 s->cluster_cache_offset = -1; /* disable compressed cache */
3b46e624 736
3fc48d09
FZ
737 qemu_co_mutex_lock(&s->lock);
738
739 while (remaining_sectors != 0) {
740
3cce16f4 741 trace_qcow2_writev_start_part(qemu_coroutine_self());
3fc48d09
FZ
742 index_in_cluster = sector_num & (s->cluster_sectors - 1);
743 n_end = index_in_cluster + remaining_sectors;
5ebaa27e
FZ
744 if (s->crypt_method &&
745 n_end > QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors) {
746 n_end = QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors;
747 }
095a9c58 748
3fc48d09 749 ret = qcow2_alloc_cluster_offset(bs, sector_num << 9,
5ebaa27e
FZ
750 index_in_cluster, n_end, &cur_nr_sectors, &l2meta);
751 if (ret < 0) {
3fc48d09 752 goto fail;
5ebaa27e 753 }
148da7ea 754
5ebaa27e
FZ
755 cluster_offset = l2meta.cluster_offset;
756 assert((cluster_offset & 511) == 0);
148da7ea 757
3fc48d09 758 qemu_iovec_reset(&hd_qiov);
1b093c48 759 qemu_iovec_concat(&hd_qiov, qiov, bytes_done,
5ebaa27e 760 cur_nr_sectors * 512);
6f5f060b 761
5ebaa27e 762 if (s->crypt_method) {
3fc48d09 763 if (!cluster_data) {
dea43a65 764 cluster_data = qemu_blockalign(bs, QCOW_MAX_CRYPT_CLUSTERS *
5ebaa27e
FZ
765 s->cluster_size);
766 }
6f5f060b 767
3fc48d09 768 assert(hd_qiov.size <=
5ebaa27e 769 QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size);
d5e6b161 770 qemu_iovec_to_buf(&hd_qiov, 0, cluster_data, hd_qiov.size);
6f5f060b 771
3fc48d09
FZ
772 qcow2_encrypt_sectors(s, sector_num, cluster_data,
773 cluster_data, cur_nr_sectors, 1, &s->aes_encrypt_key);
6f5f060b 774
3fc48d09
FZ
775 qemu_iovec_reset(&hd_qiov);
776 qemu_iovec_add(&hd_qiov, cluster_data,
5ebaa27e
FZ
777 cur_nr_sectors * 512);
778 }
6f5f060b 779
5ebaa27e
FZ
780 BLKDBG_EVENT(bs->file, BLKDBG_WRITE_AIO);
781 qemu_co_mutex_unlock(&s->lock);
3cce16f4
KW
782 trace_qcow2_writev_data(qemu_coroutine_self(),
783 (cluster_offset >> 9) + index_in_cluster);
5ebaa27e
FZ
784 ret = bdrv_co_writev(bs->file,
785 (cluster_offset >> 9) + index_in_cluster,
3fc48d09 786 cur_nr_sectors, &hd_qiov);
5ebaa27e
FZ
787 qemu_co_mutex_lock(&s->lock);
788 if (ret < 0) {
3fc48d09 789 goto fail;
5ebaa27e 790 }
f141eafe 791
5ebaa27e 792 ret = qcow2_alloc_cluster_link_l2(bs, &l2meta);
5ebaa27e 793 if (ret < 0) {
3fc48d09 794 goto fail;
5ebaa27e 795 }
faf575c1 796
0fa9131a
KW
797 run_dependent_requests(s, &l2meta);
798
3fc48d09
FZ
799 remaining_sectors -= cur_nr_sectors;
800 sector_num += cur_nr_sectors;
801 bytes_done += cur_nr_sectors * 512;
3cce16f4 802 trace_qcow2_writev_done_part(qemu_coroutine_self(), cur_nr_sectors);
5ebaa27e 803 }
3fc48d09 804 ret = 0;
faf575c1 805
3fc48d09 806fail:
0fa9131a
KW
807 run_dependent_requests(s, &l2meta);
808
68d100e9 809 qemu_co_mutex_unlock(&s->lock);
3b46e624 810
3fc48d09 811 qemu_iovec_destroy(&hd_qiov);
dea43a65 812 qemu_vfree(cluster_data);
3cce16f4 813 trace_qcow2_writev_done_req(qemu_coroutine_self(), ret);
42496d62 814
68d100e9 815 return ret;
585f8587
FB
816}
817
7c80ab3f 818static void qcow2_close(BlockDriverState *bs)
585f8587
FB
819{
820 BDRVQcowState *s = bs->opaque;
7267c094 821 g_free(s->l1_table);
29c1a730
KW
822
823 qcow2_cache_flush(bs, s->l2_table_cache);
824 qcow2_cache_flush(bs, s->refcount_block_cache);
825
c61d0004
SH
826 qcow2_mark_clean(bs);
827
29c1a730
KW
828 qcow2_cache_destroy(bs, s->l2_table_cache);
829 qcow2_cache_destroy(bs, s->refcount_block_cache);
830
6744cbab 831 g_free(s->unknown_header_fields);
75bab85c 832 cleanup_unknown_header_ext(bs);
6744cbab 833
7267c094 834 g_free(s->cluster_cache);
dea43a65 835 qemu_vfree(s->cluster_data);
ed6ccf0f 836 qcow2_refcount_close(bs);
28c1202b 837 qcow2_free_snapshots(bs);
585f8587
FB
838}
839
06d9260f
AL
840static void qcow2_invalidate_cache(BlockDriverState *bs)
841{
842 BDRVQcowState *s = bs->opaque;
843 int flags = s->flags;
844 AES_KEY aes_encrypt_key;
845 AES_KEY aes_decrypt_key;
846 uint32_t crypt_method = 0;
847
848 /*
849 * Backing files are read-only which makes all of their metadata immutable,
850 * that means we don't have to worry about reopening them here.
851 */
852
853 if (s->crypt_method) {
854 crypt_method = s->crypt_method;
855 memcpy(&aes_encrypt_key, &s->aes_encrypt_key, sizeof(aes_encrypt_key));
856 memcpy(&aes_decrypt_key, &s->aes_decrypt_key, sizeof(aes_decrypt_key));
857 }
858
859 qcow2_close(bs);
860
861 memset(s, 0, sizeof(BDRVQcowState));
862 qcow2_open(bs, flags);
863
864 if (crypt_method) {
865 s->crypt_method = crypt_method;
866 memcpy(&s->aes_encrypt_key, &aes_encrypt_key, sizeof(aes_encrypt_key));
867 memcpy(&s->aes_decrypt_key, &aes_decrypt_key, sizeof(aes_decrypt_key));
868 }
869}
870
e24e49e6
KW
871static size_t header_ext_add(char *buf, uint32_t magic, const void *s,
872 size_t len, size_t buflen)
873{
874 QCowExtension *ext_backing_fmt = (QCowExtension*) buf;
875 size_t ext_len = sizeof(QCowExtension) + ((len + 7) & ~7);
876
877 if (buflen < ext_len) {
878 return -ENOSPC;
879 }
880
881 *ext_backing_fmt = (QCowExtension) {
882 .magic = cpu_to_be32(magic),
883 .len = cpu_to_be32(len),
884 };
885 memcpy(buf + sizeof(QCowExtension), s, len);
886
887 return ext_len;
888}
889
756e6736 890/*
e24e49e6
KW
891 * Updates the qcow2 header, including the variable length parts of it, i.e.
892 * the backing file name and all extensions. qcow2 was not designed to allow
893 * such changes, so if we run out of space (we can only use the first cluster)
894 * this function may fail.
756e6736
KW
895 *
896 * Returns 0 on success, -errno in error cases.
897 */
e24e49e6 898int qcow2_update_header(BlockDriverState *bs)
756e6736 899{
756e6736 900 BDRVQcowState *s = bs->opaque;
e24e49e6
KW
901 QCowHeader *header;
902 char *buf;
903 size_t buflen = s->cluster_size;
756e6736 904 int ret;
e24e49e6
KW
905 uint64_t total_size;
906 uint32_t refcount_table_clusters;
6744cbab 907 size_t header_length;
75bab85c 908 Qcow2UnknownHeaderExtension *uext;
756e6736 909
e24e49e6 910 buf = qemu_blockalign(bs, buflen);
756e6736 911
e24e49e6
KW
912 /* Header structure */
913 header = (QCowHeader*) buf;
756e6736 914
e24e49e6
KW
915 if (buflen < sizeof(*header)) {
916 ret = -ENOSPC;
917 goto fail;
756e6736
KW
918 }
919
6744cbab 920 header_length = sizeof(*header) + s->unknown_header_fields_size;
e24e49e6
KW
921 total_size = bs->total_sectors * BDRV_SECTOR_SIZE;
922 refcount_table_clusters = s->refcount_table_size >> (s->cluster_bits - 3);
923
924 *header = (QCowHeader) {
6744cbab 925 /* Version 2 fields */
e24e49e6 926 .magic = cpu_to_be32(QCOW_MAGIC),
6744cbab 927 .version = cpu_to_be32(s->qcow_version),
e24e49e6
KW
928 .backing_file_offset = 0,
929 .backing_file_size = 0,
930 .cluster_bits = cpu_to_be32(s->cluster_bits),
931 .size = cpu_to_be64(total_size),
932 .crypt_method = cpu_to_be32(s->crypt_method_header),
933 .l1_size = cpu_to_be32(s->l1_size),
934 .l1_table_offset = cpu_to_be64(s->l1_table_offset),
935 .refcount_table_offset = cpu_to_be64(s->refcount_table_offset),
936 .refcount_table_clusters = cpu_to_be32(refcount_table_clusters),
937 .nb_snapshots = cpu_to_be32(s->nb_snapshots),
938 .snapshots_offset = cpu_to_be64(s->snapshots_offset),
6744cbab
KW
939
940 /* Version 3 fields */
941 .incompatible_features = cpu_to_be64(s->incompatible_features),
942 .compatible_features = cpu_to_be64(s->compatible_features),
943 .autoclear_features = cpu_to_be64(s->autoclear_features),
944 .refcount_order = cpu_to_be32(3 + REFCOUNT_SHIFT),
945 .header_length = cpu_to_be32(header_length),
e24e49e6 946 };
756e6736 947
6744cbab
KW
948 /* For older versions, write a shorter header */
949 switch (s->qcow_version) {
950 case 2:
951 ret = offsetof(QCowHeader, incompatible_features);
952 break;
953 case 3:
954 ret = sizeof(*header);
955 break;
956 default:
b6c14762
JM
957 ret = -EINVAL;
958 goto fail;
6744cbab
KW
959 }
960
961 buf += ret;
962 buflen -= ret;
963 memset(buf, 0, buflen);
964
965 /* Preserve any unknown field in the header */
966 if (s->unknown_header_fields_size) {
967 if (buflen < s->unknown_header_fields_size) {
968 ret = -ENOSPC;
969 goto fail;
970 }
971
972 memcpy(buf, s->unknown_header_fields, s->unknown_header_fields_size);
973 buf += s->unknown_header_fields_size;
974 buflen -= s->unknown_header_fields_size;
975 }
756e6736 976
e24e49e6
KW
977 /* Backing file format header extension */
978 if (*bs->backing_format) {
979 ret = header_ext_add(buf, QCOW2_EXT_MAGIC_BACKING_FORMAT,
980 bs->backing_format, strlen(bs->backing_format),
981 buflen);
982 if (ret < 0) {
983 goto fail;
756e6736
KW
984 }
985
e24e49e6
KW
986 buf += ret;
987 buflen -= ret;
756e6736
KW
988 }
989
cfcc4c62
KW
990 /* Feature table */
991 Qcow2Feature features[] = {
c61d0004
SH
992 {
993 .type = QCOW2_FEAT_TYPE_INCOMPATIBLE,
994 .bit = QCOW2_INCOMPAT_DIRTY_BITNR,
995 .name = "dirty bit",
996 },
cfcc4c62
KW
997 };
998
999 ret = header_ext_add(buf, QCOW2_EXT_MAGIC_FEATURE_TABLE,
1000 features, sizeof(features), buflen);
1001 if (ret < 0) {
1002 goto fail;
1003 }
1004 buf += ret;
1005 buflen -= ret;
1006
75bab85c
KW
1007 /* Keep unknown header extensions */
1008 QLIST_FOREACH(uext, &s->unknown_header_ext, next) {
1009 ret = header_ext_add(buf, uext->magic, uext->data, uext->len, buflen);
1010 if (ret < 0) {
1011 goto fail;
1012 }
1013
1014 buf += ret;
1015 buflen -= ret;
1016 }
1017
e24e49e6
KW
1018 /* End of header extensions */
1019 ret = header_ext_add(buf, QCOW2_EXT_MAGIC_END, NULL, 0, buflen);
756e6736
KW
1020 if (ret < 0) {
1021 goto fail;
1022 }
1023
e24e49e6
KW
1024 buf += ret;
1025 buflen -= ret;
756e6736 1026
e24e49e6
KW
1027 /* Backing file name */
1028 if (*bs->backing_file) {
1029 size_t backing_file_len = strlen(bs->backing_file);
1030
1031 if (buflen < backing_file_len) {
1032 ret = -ENOSPC;
1033 goto fail;
1034 }
1035
1036 strncpy(buf, bs->backing_file, buflen);
1037
1038 header->backing_file_offset = cpu_to_be64(buf - ((char*) header));
1039 header->backing_file_size = cpu_to_be32(backing_file_len);
756e6736
KW
1040 }
1041
e24e49e6
KW
1042 /* Write the new header */
1043 ret = bdrv_pwrite(bs->file, 0, header, s->cluster_size);
756e6736
KW
1044 if (ret < 0) {
1045 goto fail;
1046 }
1047
1048 ret = 0;
1049fail:
e24e49e6 1050 qemu_vfree(header);
756e6736
KW
1051 return ret;
1052}
1053
1054static int qcow2_change_backing_file(BlockDriverState *bs,
1055 const char *backing_file, const char *backing_fmt)
1056{
e24e49e6
KW
1057 pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: "");
1058 pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: "");
1059
1060 return qcow2_update_header(bs);
756e6736
KW
1061}
1062
a35e1c17
KW
1063static int preallocate(BlockDriverState *bs)
1064{
a35e1c17
KW
1065 uint64_t nb_sectors;
1066 uint64_t offset;
1067 int num;
148da7ea 1068 int ret;
a35e1c17
KW
1069 QCowL2Meta meta;
1070
1071 nb_sectors = bdrv_getlength(bs) >> 9;
1072 offset = 0;
68d100e9 1073 qemu_co_queue_init(&meta.dependent_requests);
148da7ea 1074 meta.cluster_offset = 0;
a35e1c17
KW
1075
1076 while (nb_sectors) {
1077 num = MIN(nb_sectors, INT_MAX >> 9);
148da7ea 1078 ret = qcow2_alloc_cluster_offset(bs, offset, 0, num, &num, &meta);
148da7ea 1079 if (ret < 0) {
19dbcbf7 1080 return ret;
a35e1c17
KW
1081 }
1082
19dbcbf7
KW
1083 ret = qcow2_alloc_cluster_link_l2(bs, &meta);
1084 if (ret < 0) {
148da7ea 1085 qcow2_free_any_clusters(bs, meta.cluster_offset, meta.nb_clusters);
19dbcbf7 1086 return ret;
a35e1c17
KW
1087 }
1088
f214978a
KW
1089 /* There are no dependent requests, but we need to remove our request
1090 * from the list of in-flight requests */
68d100e9 1091 run_dependent_requests(bs->opaque, &meta);
f214978a 1092
a35e1c17
KW
1093 /* TODO Preallocate data if requested */
1094
1095 nb_sectors -= num;
1096 offset += num << 9;
1097 }
1098
1099 /*
1100 * It is expected that the image file is large enough to actually contain
1101 * all of the allocated clusters (otherwise we get failing reads after
1102 * EOF). Extend the image to the last allocated sector.
1103 */
148da7ea 1104 if (meta.cluster_offset != 0) {
ea80b906
KW
1105 uint8_t buf[512];
1106 memset(buf, 0, 512);
19dbcbf7
KW
1107 ret = bdrv_write(bs->file, (meta.cluster_offset >> 9) + num - 1, buf, 1);
1108 if (ret < 0) {
1109 return ret;
1110 }
a35e1c17
KW
1111 }
1112
1113 return 0;
1114}
1115
7c80ab3f
JS
1116static int qcow2_create2(const char *filename, int64_t total_size,
1117 const char *backing_file, const char *backing_format,
1118 int flags, size_t cluster_size, int prealloc,
6744cbab 1119 QEMUOptionParameter *options, int version)
a9420734 1120{
9b2260cb 1121 /* Calculate cluster_bits */
a9420734
KW
1122 int cluster_bits;
1123 cluster_bits = ffs(cluster_size) - 1;
1124 if (cluster_bits < MIN_CLUSTER_BITS || cluster_bits > MAX_CLUSTER_BITS ||
1125 (1 << cluster_bits) != cluster_size)
1126 {
1127 error_report(
6daf194d 1128 "Cluster size must be a power of two between %d and %dk",
a9420734
KW
1129 1 << MIN_CLUSTER_BITS, 1 << (MAX_CLUSTER_BITS - 10));
1130 return -EINVAL;
1131 }
1132
1133 /*
1134 * Open the image file and write a minimal qcow2 header.
1135 *
1136 * We keep things simple and start with a zero-sized image. We also
1137 * do without refcount blocks or a L1 table for now. We'll fix the
1138 * inconsistency later.
1139 *
1140 * We do need a refcount table because growing the refcount table means
1141 * allocating two new refcount blocks - the seconds of which would be at
1142 * 2 GB for 64k clusters, and we don't want to have a 2 GB initial file
1143 * size for any qcow2 image.
1144 */
1145 BlockDriverState* bs;
1146 QCowHeader header;
1147 uint8_t* refcount_table;
1148 int ret;
1149
1150 ret = bdrv_create_file(filename, options);
1151 if (ret < 0) {
1152 return ret;
1153 }
1154
1155 ret = bdrv_file_open(&bs, filename, BDRV_O_RDWR);
1156 if (ret < 0) {
1157 return ret;
1158 }
1159
1160 /* Write the header */
1161 memset(&header, 0, sizeof(header));
1162 header.magic = cpu_to_be32(QCOW_MAGIC);
6744cbab 1163 header.version = cpu_to_be32(version);
a9420734
KW
1164 header.cluster_bits = cpu_to_be32(cluster_bits);
1165 header.size = cpu_to_be64(0);
1166 header.l1_table_offset = cpu_to_be64(0);
1167 header.l1_size = cpu_to_be32(0);
1168 header.refcount_table_offset = cpu_to_be64(cluster_size);
1169 header.refcount_table_clusters = cpu_to_be32(1);
6744cbab
KW
1170 header.refcount_order = cpu_to_be32(3 + REFCOUNT_SHIFT);
1171 header.header_length = cpu_to_be32(sizeof(header));
a9420734
KW
1172
1173 if (flags & BLOCK_FLAG_ENCRYPT) {
1174 header.crypt_method = cpu_to_be32(QCOW_CRYPT_AES);
1175 } else {
1176 header.crypt_method = cpu_to_be32(QCOW_CRYPT_NONE);
1177 }
1178
1179 ret = bdrv_pwrite(bs, 0, &header, sizeof(header));
1180 if (ret < 0) {
1181 goto out;
1182 }
1183
1184 /* Write an empty refcount table */
7267c094 1185 refcount_table = g_malloc0(cluster_size);
a9420734 1186 ret = bdrv_pwrite(bs, cluster_size, refcount_table, cluster_size);
7267c094 1187 g_free(refcount_table);
a9420734
KW
1188
1189 if (ret < 0) {
1190 goto out;
1191 }
1192
1193 bdrv_close(bs);
1194
1195 /*
1196 * And now open the image and make it consistent first (i.e. increase the
1197 * refcount of the cluster that is occupied by the header and the refcount
1198 * table)
1199 */
1200 BlockDriver* drv = bdrv_find_format("qcow2");
1201 assert(drv != NULL);
e1a7107f
KW
1202 ret = bdrv_open(bs, filename,
1203 BDRV_O_RDWR | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH, drv);
a9420734
KW
1204 if (ret < 0) {
1205 goto out;
1206 }
1207
1208 ret = qcow2_alloc_clusters(bs, 2 * cluster_size);
1209 if (ret < 0) {
1210 goto out;
1211
1212 } else if (ret != 0) {
1213 error_report("Huh, first cluster in empty image is already in use?");
1214 abort();
1215 }
1216
1217 /* Okay, now that we have a valid image, let's give it the right size */
1218 ret = bdrv_truncate(bs, total_size * BDRV_SECTOR_SIZE);
1219 if (ret < 0) {
1220 goto out;
1221 }
1222
1223 /* Want a backing file? There you go.*/
1224 if (backing_file) {
1225 ret = bdrv_change_backing_file(bs, backing_file, backing_format);
1226 if (ret < 0) {
1227 goto out;
1228 }
1229 }
1230
1231 /* And if we're supposed to preallocate metadata, do that now */
1232 if (prealloc) {
15552c4a
ZYW
1233 BDRVQcowState *s = bs->opaque;
1234 qemu_co_mutex_lock(&s->lock);
a9420734 1235 ret = preallocate(bs);
15552c4a 1236 qemu_co_mutex_unlock(&s->lock);
a9420734
KW
1237 if (ret < 0) {
1238 goto out;
1239 }
1240 }
1241
1242 ret = 0;
1243out:
1244 bdrv_delete(bs);
1245 return ret;
1246}
de5f3f40 1247
7c80ab3f 1248static int qcow2_create(const char *filename, QEMUOptionParameter *options)
de5f3f40
KW
1249{
1250 const char *backing_file = NULL;
1251 const char *backing_fmt = NULL;
1252 uint64_t sectors = 0;
1253 int flags = 0;
99cce9fa 1254 size_t cluster_size = DEFAULT_CLUSTER_SIZE;
de5f3f40 1255 int prealloc = 0;
6744cbab 1256 int version = 2;
de5f3f40
KW
1257
1258 /* Read out options */
1259 while (options && options->name) {
1260 if (!strcmp(options->name, BLOCK_OPT_SIZE)) {
1261 sectors = options->value.n / 512;
1262 } else if (!strcmp(options->name, BLOCK_OPT_BACKING_FILE)) {
1263 backing_file = options->value.s;
1264 } else if (!strcmp(options->name, BLOCK_OPT_BACKING_FMT)) {
1265 backing_fmt = options->value.s;
1266 } else if (!strcmp(options->name, BLOCK_OPT_ENCRYPT)) {
1267 flags |= options->value.n ? BLOCK_FLAG_ENCRYPT : 0;
1268 } else if (!strcmp(options->name, BLOCK_OPT_CLUSTER_SIZE)) {
1269 if (options->value.n) {
1270 cluster_size = options->value.n;
1271 }
1272 } else if (!strcmp(options->name, BLOCK_OPT_PREALLOC)) {
1273 if (!options->value.s || !strcmp(options->value.s, "off")) {
1274 prealloc = 0;
1275 } else if (!strcmp(options->value.s, "metadata")) {
1276 prealloc = 1;
1277 } else {
1278 fprintf(stderr, "Invalid preallocation mode: '%s'\n",
1279 options->value.s);
1280 return -EINVAL;
1281 }
6744cbab
KW
1282 } else if (!strcmp(options->name, BLOCK_OPT_COMPAT_LEVEL)) {
1283 if (!options->value.s || !strcmp(options->value.s, "0.10")) {
1284 version = 2;
1285 } else if (!strcmp(options->value.s, "1.1")) {
1286 version = 3;
1287 } else {
1288 fprintf(stderr, "Invalid compatibility level: '%s'\n",
1289 options->value.s);
1290 return -EINVAL;
1291 }
de5f3f40
KW
1292 }
1293 options++;
1294 }
1295
1296 if (backing_file && prealloc) {
1297 fprintf(stderr, "Backing file and preallocation cannot be used at "
1298 "the same time\n");
1299 return -EINVAL;
1300 }
1301
7c80ab3f 1302 return qcow2_create2(filename, sectors, backing_file, backing_fmt, flags,
6744cbab 1303 cluster_size, prealloc, options, version);
de5f3f40
KW
1304}
1305
7c80ab3f 1306static int qcow2_make_empty(BlockDriverState *bs)
20d97356
BS
1307{
1308#if 0
1309 /* XXX: not correct */
1310 BDRVQcowState *s = bs->opaque;
1311 uint32_t l1_length = s->l1_size * sizeof(uint64_t);
1312 int ret;
1313
1314 memset(s->l1_table, 0, l1_length);
66f82cee 1315 if (bdrv_pwrite(bs->file, s->l1_table_offset, s->l1_table, l1_length) < 0)
20d97356 1316 return -1;
66f82cee 1317 ret = bdrv_truncate(bs->file, s->l1_table_offset + l1_length);
20d97356
BS
1318 if (ret < 0)
1319 return ret;
1320
1321 l2_cache_reset(bs);
1322#endif
1323 return 0;
1324}
1325
621f0589
KW
1326static coroutine_fn int qcow2_co_write_zeroes(BlockDriverState *bs,
1327 int64_t sector_num, int nb_sectors)
1328{
1329 int ret;
1330 BDRVQcowState *s = bs->opaque;
1331
1332 /* Emulate misaligned zero writes */
1333 if (sector_num % s->cluster_sectors || nb_sectors % s->cluster_sectors) {
1334 return -ENOTSUP;
1335 }
1336
1337 /* Whatever is left can use real zero clusters */
1338 qemu_co_mutex_lock(&s->lock);
1339 ret = qcow2_zero_clusters(bs, sector_num << BDRV_SECTOR_BITS,
1340 nb_sectors);
1341 qemu_co_mutex_unlock(&s->lock);
1342
1343 return ret;
1344}
1345
6db39ae2
PB
1346static coroutine_fn int qcow2_co_discard(BlockDriverState *bs,
1347 int64_t sector_num, int nb_sectors)
5ea929e3 1348{
6db39ae2
PB
1349 int ret;
1350 BDRVQcowState *s = bs->opaque;
1351
1352 qemu_co_mutex_lock(&s->lock);
1353 ret = qcow2_discard_clusters(bs, sector_num << BDRV_SECTOR_BITS,
5ea929e3 1354 nb_sectors);
6db39ae2
PB
1355 qemu_co_mutex_unlock(&s->lock);
1356 return ret;
5ea929e3
KW
1357}
1358
419b19d9
SH
1359static int qcow2_truncate(BlockDriverState *bs, int64_t offset)
1360{
1361 BDRVQcowState *s = bs->opaque;
1362 int ret, new_l1_size;
1363
1364 if (offset & 511) {
259b2173 1365 error_report("The new size must be a multiple of 512");
419b19d9
SH
1366 return -EINVAL;
1367 }
1368
1369 /* cannot proceed if image has snapshots */
1370 if (s->nb_snapshots) {
259b2173 1371 error_report("Can't resize an image which has snapshots");
419b19d9
SH
1372 return -ENOTSUP;
1373 }
1374
1375 /* shrinking is currently not supported */
1376 if (offset < bs->total_sectors * 512) {
259b2173 1377 error_report("qcow2 doesn't support shrinking images yet");
419b19d9
SH
1378 return -ENOTSUP;
1379 }
1380
1381 new_l1_size = size_to_l1(s, offset);
72893756 1382 ret = qcow2_grow_l1_table(bs, new_l1_size, true);
419b19d9
SH
1383 if (ret < 0) {
1384 return ret;
1385 }
1386
1387 /* write updated header.size */
1388 offset = cpu_to_be64(offset);
8b3b7206
KW
1389 ret = bdrv_pwrite_sync(bs->file, offsetof(QCowHeader, size),
1390 &offset, sizeof(uint64_t));
419b19d9
SH
1391 if (ret < 0) {
1392 return ret;
1393 }
1394
1395 s->l1_vm_state_index = new_l1_size;
1396 return 0;
1397}
1398
20d97356
BS
1399/* XXX: put compressed sectors first, then all the cluster aligned
1400 tables to avoid losing bytes in alignment */
7c80ab3f
JS
1401static int qcow2_write_compressed(BlockDriverState *bs, int64_t sector_num,
1402 const uint8_t *buf, int nb_sectors)
20d97356
BS
1403{
1404 BDRVQcowState *s = bs->opaque;
1405 z_stream strm;
1406 int ret, out_len;
1407 uint8_t *out_buf;
1408 uint64_t cluster_offset;
1409
1410 if (nb_sectors == 0) {
1411 /* align end of file to a sector boundary to ease reading with
1412 sector based I/Os */
66f82cee 1413 cluster_offset = bdrv_getlength(bs->file);
20d97356 1414 cluster_offset = (cluster_offset + 511) & ~511;
66f82cee 1415 bdrv_truncate(bs->file, cluster_offset);
20d97356
BS
1416 return 0;
1417 }
1418
1419 if (nb_sectors != s->cluster_sectors)
1420 return -EINVAL;
1421
7267c094 1422 out_buf = g_malloc(s->cluster_size + (s->cluster_size / 1000) + 128);
20d97356
BS
1423
1424 /* best compression, small window, no zlib header */
1425 memset(&strm, 0, sizeof(strm));
1426 ret = deflateInit2(&strm, Z_DEFAULT_COMPRESSION,
1427 Z_DEFLATED, -12,
1428 9, Z_DEFAULT_STRATEGY);
1429 if (ret != 0) {
8f1efd00
KW
1430 ret = -EINVAL;
1431 goto fail;
20d97356
BS
1432 }
1433
1434 strm.avail_in = s->cluster_size;
1435 strm.next_in = (uint8_t *)buf;
1436 strm.avail_out = s->cluster_size;
1437 strm.next_out = out_buf;
1438
1439 ret = deflate(&strm, Z_FINISH);
1440 if (ret != Z_STREAM_END && ret != Z_OK) {
20d97356 1441 deflateEnd(&strm);
8f1efd00
KW
1442 ret = -EINVAL;
1443 goto fail;
20d97356
BS
1444 }
1445 out_len = strm.next_out - out_buf;
1446
1447 deflateEnd(&strm);
1448
1449 if (ret != Z_STREAM_END || out_len >= s->cluster_size) {
1450 /* could not compress: write normal cluster */
8f1efd00
KW
1451 ret = bdrv_write(bs, sector_num, buf, s->cluster_sectors);
1452 if (ret < 0) {
1453 goto fail;
1454 }
20d97356
BS
1455 } else {
1456 cluster_offset = qcow2_alloc_compressed_cluster_offset(bs,
1457 sector_num << 9, out_len);
8f1efd00
KW
1458 if (!cluster_offset) {
1459 ret = -EIO;
1460 goto fail;
1461 }
20d97356 1462 cluster_offset &= s->cluster_offset_mask;
66f82cee 1463 BLKDBG_EVENT(bs->file, BLKDBG_WRITE_COMPRESSED);
8f1efd00
KW
1464 ret = bdrv_pwrite(bs->file, cluster_offset, out_buf, out_len);
1465 if (ret < 0) {
1466 goto fail;
20d97356
BS
1467 }
1468 }
1469
8f1efd00
KW
1470 ret = 0;
1471fail:
7267c094 1472 g_free(out_buf);
8f1efd00 1473 return ret;
20d97356
BS
1474}
1475
a968168c 1476static coroutine_fn int qcow2_co_flush_to_os(BlockDriverState *bs)
20d97356 1477{
29c1a730
KW
1478 BDRVQcowState *s = bs->opaque;
1479 int ret;
1480
8b94ff85 1481 qemu_co_mutex_lock(&s->lock);
29c1a730
KW
1482 ret = qcow2_cache_flush(bs, s->l2_table_cache);
1483 if (ret < 0) {
c95de7e2 1484 qemu_co_mutex_unlock(&s->lock);
8b94ff85 1485 return ret;
29c1a730
KW
1486 }
1487
1488 ret = qcow2_cache_flush(bs, s->refcount_block_cache);
1489 if (ret < 0) {
c95de7e2 1490 qemu_co_mutex_unlock(&s->lock);
8b94ff85 1491 return ret;
29c1a730 1492 }
8b94ff85 1493 qemu_co_mutex_unlock(&s->lock);
29c1a730 1494
eb489bb1
KW
1495 return 0;
1496}
1497
7c80ab3f 1498static int64_t qcow2_vm_state_offset(BDRVQcowState *s)
20d97356
BS
1499{
1500 return (int64_t)s->l1_vm_state_index << (s->cluster_bits + s->l2_bits);
1501}
1502
7c80ab3f 1503static int qcow2_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
20d97356
BS
1504{
1505 BDRVQcowState *s = bs->opaque;
1506 bdi->cluster_size = s->cluster_size;
7c80ab3f 1507 bdi->vm_state_offset = qcow2_vm_state_offset(s);
20d97356
BS
1508 return 0;
1509}
1510
1511
4534ff54
KW
1512static int qcow2_check(BlockDriverState *bs, BdrvCheckResult *result,
1513 BdrvCheckMode fix)
20d97356 1514{
166acf54 1515 return qcow2_check_refcounts(bs, result, fix);
20d97356
BS
1516}
1517
1518#if 0
1519static void dump_refcounts(BlockDriverState *bs)
1520{
1521 BDRVQcowState *s = bs->opaque;
1522 int64_t nb_clusters, k, k1, size;
1523 int refcount;
1524
66f82cee 1525 size = bdrv_getlength(bs->file);
20d97356
BS
1526 nb_clusters = size_to_clusters(s, size);
1527 for(k = 0; k < nb_clusters;) {
1528 k1 = k;
1529 refcount = get_refcount(bs, k);
1530 k++;
1531 while (k < nb_clusters && get_refcount(bs, k) == refcount)
1532 k++;
0bfcd599
BS
1533 printf("%" PRId64 ": refcount=%d nb=%" PRId64 "\n", k, refcount,
1534 k - k1);
20d97356
BS
1535 }
1536}
1537#endif
1538
7c80ab3f
JS
1539static int qcow2_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
1540 int64_t pos, int size)
20d97356
BS
1541{
1542 BDRVQcowState *s = bs->opaque;
1543 int growable = bs->growable;
1544 int ret;
1545
66f82cee 1546 BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_SAVE);
20d97356 1547 bs->growable = 1;
7c80ab3f 1548 ret = bdrv_pwrite(bs, qcow2_vm_state_offset(s) + pos, buf, size);
20d97356
BS
1549 bs->growable = growable;
1550
1551 return ret;
1552}
1553
7c80ab3f
JS
1554static int qcow2_load_vmstate(BlockDriverState *bs, uint8_t *buf,
1555 int64_t pos, int size)
20d97356
BS
1556{
1557 BDRVQcowState *s = bs->opaque;
1558 int growable = bs->growable;
1559 int ret;
1560
66f82cee 1561 BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_LOAD);
20d97356 1562 bs->growable = 1;
7c80ab3f 1563 ret = bdrv_pread(bs, qcow2_vm_state_offset(s) + pos, buf, size);
20d97356
BS
1564 bs->growable = growable;
1565
1566 return ret;
1567}
1568
7c80ab3f 1569static QEMUOptionParameter qcow2_create_options[] = {
20d97356
BS
1570 {
1571 .name = BLOCK_OPT_SIZE,
1572 .type = OPT_SIZE,
1573 .help = "Virtual disk size"
1574 },
6744cbab
KW
1575 {
1576 .name = BLOCK_OPT_COMPAT_LEVEL,
1577 .type = OPT_STRING,
1578 .help = "Compatibility level (0.10 or 1.1)"
1579 },
20d97356
BS
1580 {
1581 .name = BLOCK_OPT_BACKING_FILE,
1582 .type = OPT_STRING,
1583 .help = "File name of a base image"
1584 },
1585 {
1586 .name = BLOCK_OPT_BACKING_FMT,
1587 .type = OPT_STRING,
1588 .help = "Image format of the base image"
1589 },
1590 {
1591 .name = BLOCK_OPT_ENCRYPT,
1592 .type = OPT_FLAG,
1593 .help = "Encrypt the image"
1594 },
1595 {
1596 .name = BLOCK_OPT_CLUSTER_SIZE,
1597 .type = OPT_SIZE,
99cce9fa
KW
1598 .help = "qcow2 cluster size",
1599 .value = { .n = DEFAULT_CLUSTER_SIZE },
20d97356
BS
1600 },
1601 {
1602 .name = BLOCK_OPT_PREALLOC,
1603 .type = OPT_STRING,
1604 .help = "Preallocation mode (allowed values: off, metadata)"
1605 },
1606 { NULL }
1607};
1608
1609static BlockDriver bdrv_qcow2 = {
7c80ab3f
JS
1610 .format_name = "qcow2",
1611 .instance_size = sizeof(BDRVQcowState),
1612 .bdrv_probe = qcow2_probe,
1613 .bdrv_open = qcow2_open,
1614 .bdrv_close = qcow2_close,
1615 .bdrv_create = qcow2_create,
f8a2e5e3 1616 .bdrv_co_is_allocated = qcow2_co_is_allocated,
7c80ab3f
JS
1617 .bdrv_set_key = qcow2_set_key,
1618 .bdrv_make_empty = qcow2_make_empty,
1619
c68b89ac
KW
1620 .bdrv_co_readv = qcow2_co_readv,
1621 .bdrv_co_writev = qcow2_co_writev,
eb489bb1 1622 .bdrv_co_flush_to_os = qcow2_co_flush_to_os,
419b19d9 1623
621f0589 1624 .bdrv_co_write_zeroes = qcow2_co_write_zeroes,
6db39ae2 1625 .bdrv_co_discard = qcow2_co_discard,
419b19d9 1626 .bdrv_truncate = qcow2_truncate,
7c80ab3f 1627 .bdrv_write_compressed = qcow2_write_compressed,
20d97356
BS
1628
1629 .bdrv_snapshot_create = qcow2_snapshot_create,
1630 .bdrv_snapshot_goto = qcow2_snapshot_goto,
1631 .bdrv_snapshot_delete = qcow2_snapshot_delete,
1632 .bdrv_snapshot_list = qcow2_snapshot_list,
51ef6727 1633 .bdrv_snapshot_load_tmp = qcow2_snapshot_load_tmp,
7c80ab3f 1634 .bdrv_get_info = qcow2_get_info,
20d97356 1635
7c80ab3f
JS
1636 .bdrv_save_vmstate = qcow2_save_vmstate,
1637 .bdrv_load_vmstate = qcow2_load_vmstate,
20d97356
BS
1638
1639 .bdrv_change_backing_file = qcow2_change_backing_file,
1640
06d9260f
AL
1641 .bdrv_invalidate_cache = qcow2_invalidate_cache,
1642
7c80ab3f
JS
1643 .create_options = qcow2_create_options,
1644 .bdrv_check = qcow2_check,
20d97356
BS
1645};
1646
5efa9d5a
AL
1647static void bdrv_qcow2_init(void)
1648{
1649 bdrv_register(&bdrv_qcow2);
1650}
1651
1652block_init(bdrv_qcow2_init);