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