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