]> git.proxmox.com Git - qemu.git/blob - block/qcow2.c
ad46c03c2f6daef22f5232d1df9c119c8bfc180d
[qemu.git] / block / qcow2.c
1 /*
2 * Block driver for the QCOW version 2 format
3 *
4 * Copyright (c) 2004-2006 Fabrice Bellard
5 *
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 */
24 #include "qemu-common.h"
25 #include "block_int.h"
26 #include "module.h"
27 #include <zlib.h>
28 #include "aes.h"
29 #include "block/qcow2.h"
30 #include "qemu-error.h"
31 #include "qerror.h"
32 #include "trace.h"
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.
41 - Size of compressed clusters is stored in sectors to reduce bit usage
42 in the cluster offsets.
43 - Support for storing additional data (such as the VM state) in the
44 snapshots.
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
50
51 typedef struct {
52 uint32_t magic;
53 uint32_t len;
54 } QCowExtension;
55 #define QCOW2_EXT_MAGIC_END 0
56 #define QCOW2_EXT_MAGIC_BACKING_FORMAT 0xE2792ACA
57 #define QCOW2_EXT_MAGIC_FEATURE_TABLE 0x6803f857
58
59 static int qcow2_probe(const uint8_t *buf, int buf_size, const char *filename)
60 {
61 const QCowHeader *cow_header = (const void *)buf;
62
63 if (buf_size >= sizeof(QCowHeader) &&
64 be32_to_cpu(cow_header->magic) == QCOW_MAGIC &&
65 be32_to_cpu(cow_header->version) >= 2)
66 return 100;
67 else
68 return 0;
69 }
70
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 */
79 static int qcow2_read_extensions(BlockDriverState *bs, uint64_t start_offset,
80 uint64_t end_offset, void **p_feature_table)
81 {
82 BDRVQcowState *s = bs->opaque;
83 QCowExtension ext;
84 uint64_t offset;
85 int ret;
86
87 #ifdef DEBUG_EXT
88 printf("qcow2_read_extensions: start=%ld end=%ld\n", start_offset, end_offset);
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)
96 printf("qcow2_read_extension: suspicious offset %lu\n", offset);
97
98 printf("attempting to read extended header in offset %lu\n", offset);
99 #endif
100
101 if (bdrv_pread(bs->file, offset, &ext, sizeof(ext)) != sizeof(ext)) {
102 fprintf(stderr, "qcow2_read_extension: ERROR: "
103 "pread fail from offset %" PRIu64 "\n",
104 offset);
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
113 if (ext.len > end_offset - offset) {
114 error_report("Header extension too large");
115 return -EINVAL;
116 }
117
118 switch (ext.magic) {
119 case QCOW2_EXT_MAGIC_END:
120 return 0;
121
122 case QCOW2_EXT_MAGIC_BACKING_FORMAT:
123 if (ext.len >= sizeof(bs->backing_format)) {
124 fprintf(stderr, "ERROR: ext_backing_format: len=%u too large"
125 " (>=%zu)\n",
126 ext.len, sizeof(bs->backing_format));
127 return 2;
128 }
129 if (bdrv_pread(bs->file, offset , bs->backing_format,
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
136 break;
137
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
150 default:
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 }
164 }
165 break;
166 }
167
168 offset += ((ext.len + 7) & ~7);
169 }
170
171 return 0;
172 }
173
174 static 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 }
184
185 static void report_unsupported(BlockDriverState *bs, const char *fmt, ...)
186 {
187 char msg[64];
188 va_list ap;
189
190 va_start(ap, fmt);
191 vsnprintf(msg, sizeof(msg), fmt, ap);
192 va_end(ap);
193
194 qerror_report(QERR_UNKNOWN_BLOCK_FORMAT_FEATURE,
195 bs->device_name, "qcow2", msg);
196 }
197
198 static void report_unsupported_feature(BlockDriverState *bs,
199 Qcow2Feature *table, uint64_t mask)
200 {
201 while (table && table->name[0] != '\0') {
202 if (table->type == QCOW2_FEAT_TYPE_INCOMPATIBLE) {
203 if (mask & (1 << table->bit)) {
204 report_unsupported(bs, "%.46s",table->name);
205 mask &= ~(1 << table->bit);
206 }
207 }
208 table++;
209 }
210
211 if (mask) {
212 report_unsupported(bs, "Unknown incompatible feature: %" PRIx64, mask);
213 }
214 }
215
216 static int qcow2_open(BlockDriverState *bs, int flags)
217 {
218 BDRVQcowState *s = bs->opaque;
219 int len, i, ret = 0;
220 QCowHeader header;
221 uint64_t ext_end;
222 bool writethrough;
223
224 ret = bdrv_pread(bs->file, 0, &header, sizeof(header));
225 if (ret < 0) {
226 goto fail;
227 }
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);
241
242 if (header.magic != QCOW_MAGIC) {
243 ret = -EINVAL;
244 goto fail;
245 }
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
279 if (header.backing_file_offset) {
280 ext_end = header.backing_file_offset;
281 } else {
282 ext_end = 1 << header.cluster_bits;
283 }
284
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) {
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);
296 ret = -ENOTSUP;
297 goto fail;
298 }
299
300 if (!bs->read_only && s->autoclear_features != 0) {
301 s->autoclear_features = 0;
302 qcow2_update_header(bs);
303 }
304
305 /* Check support for various header values */
306 if (header.refcount_order != 4) {
307 report_unsupported(bs, "%d bit reference counts",
308 1 << header.refcount_order);
309 ret = -ENOTSUP;
310 goto fail;
311 }
312
313 if (header.cluster_bits < MIN_CLUSTER_BITS ||
314 header.cluster_bits > MAX_CLUSTER_BITS) {
315 ret = -EINVAL;
316 goto fail;
317 }
318 if (header.crypt_method > QCOW_CRYPT_AES) {
319 ret = -EINVAL;
320 goto fail;
321 }
322 s->crypt_method_header = header.crypt_method;
323 if (s->crypt_method_header) {
324 bs->encrypted = 1;
325 }
326 s->cluster_bits = header.cluster_bits;
327 s->cluster_size = 1 << s->cluster_bits;
328 s->cluster_sectors = 1 << (s->cluster_bits - 9);
329 s->l2_bits = s->cluster_bits - 3; /* L2 is always one cluster */
330 s->l2_size = 1 << s->l2_bits;
331 bs->total_sectors = header.size / 512;
332 s->csize_shift = (62 - (s->cluster_bits - 8));
333 s->csize_mask = (1 << (s->cluster_bits - 8)) - 1;
334 s->cluster_offset_mask = (1LL << s->csize_shift) - 1;
335 s->refcount_table_offset = header.refcount_table_offset;
336 s->refcount_table_size =
337 header.refcount_table_clusters << (s->cluster_bits - 3);
338
339 s->snapshots_offset = header.snapshots_offset;
340 s->nb_snapshots = header.nb_snapshots;
341
342 /* read the level 1 table */
343 s->l1_size = header.l1_size;
344 s->l1_vm_state_index = size_to_l1(s, header.size);
345 /* the L1 table must contain at least enough entries to put
346 header.size bytes */
347 if (s->l1_size < s->l1_vm_state_index) {
348 ret = -EINVAL;
349 goto fail;
350 }
351 s->l1_table_offset = header.l1_table_offset;
352 if (s->l1_size > 0) {
353 s->l1_table = g_malloc0(
354 align_offset(s->l1_size * sizeof(uint64_t), 512));
355 ret = bdrv_pread(bs->file, s->l1_table_offset, s->l1_table,
356 s->l1_size * sizeof(uint64_t));
357 if (ret < 0) {
358 goto fail;
359 }
360 for(i = 0;i < s->l1_size; i++) {
361 be64_to_cpus(&s->l1_table[i]);
362 }
363 }
364
365 /* alloc L2 table/refcount block cache */
366 writethrough = ((flags & BDRV_O_CACHE_WB) == 0);
367 s->l2_table_cache = qcow2_cache_create(bs, L2_CACHE_SIZE, writethrough);
368 s->refcount_block_cache = qcow2_cache_create(bs, REFCOUNT_CACHE_SIZE,
369 writethrough);
370
371 s->cluster_cache = g_malloc(s->cluster_size);
372 /* one more sector for decompressed data alignment */
373 s->cluster_data = qemu_blockalign(bs, QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size
374 + 512);
375 s->cluster_cache_offset = -1;
376 s->flags = flags;
377
378 ret = qcow2_refcount_init(bs);
379 if (ret != 0) {
380 goto fail;
381 }
382
383 QLIST_INIT(&s->cluster_allocs);
384
385 /* read qcow2 extensions */
386 if (qcow2_read_extensions(bs, header.header_length, ext_end, NULL)) {
387 ret = -EINVAL;
388 goto fail;
389 }
390
391 /* read the backing file name */
392 if (header.backing_file_offset != 0) {
393 len = header.backing_file_size;
394 if (len > 1023) {
395 len = 1023;
396 }
397 ret = bdrv_pread(bs->file, header.backing_file_offset,
398 bs->backing_file, len);
399 if (ret < 0) {
400 goto fail;
401 }
402 bs->backing_file[len] = '\0';
403 }
404
405 ret = qcow2_read_snapshots(bs);
406 if (ret < 0) {
407 goto fail;
408 }
409
410 /* Initialise locks */
411 qemu_co_mutex_init(&s->lock);
412
413 #ifdef DEBUG_ALLOC
414 {
415 BdrvCheckResult result = {0};
416 qcow2_check_refcounts(bs, &result);
417 }
418 #endif
419 return ret;
420
421 fail:
422 g_free(s->unknown_header_fields);
423 cleanup_unknown_header_ext(bs);
424 qcow2_free_snapshots(bs);
425 qcow2_refcount_close(bs);
426 g_free(s->l1_table);
427 if (s->l2_table_cache) {
428 qcow2_cache_destroy(bs, s->l2_table_cache);
429 }
430 g_free(s->cluster_cache);
431 qemu_vfree(s->cluster_data);
432 return ret;
433 }
434
435 static int qcow2_set_key(BlockDriverState *bs, const char *key)
436 {
437 BDRVQcowState *s = bs->opaque;
438 uint8_t keybuf[16];
439 int len, i;
440
441 memset(keybuf, 0, 16);
442 len = strlen(key);
443 if (len > 16)
444 len = 16;
445 /* XXX: we could compress the chars to 7 bits to increase
446 entropy */
447 for(i = 0;i < len;i++) {
448 keybuf[i] = key[i];
449 }
450 s->crypt_method = s->crypt_method_header;
451
452 if (AES_set_encrypt_key(keybuf, 128, &s->aes_encrypt_key) != 0)
453 return -1;
454 if (AES_set_decrypt_key(keybuf, 128, &s->aes_decrypt_key) != 0)
455 return -1;
456 #if 0
457 /* test */
458 {
459 uint8_t in[16];
460 uint8_t out[16];
461 uint8_t tmp[16];
462 for(i=0;i<16;i++)
463 in[i] = i;
464 AES_encrypt(in, tmp, &s->aes_encrypt_key);
465 AES_decrypt(tmp, out, &s->aes_decrypt_key);
466 for(i = 0; i < 16; i++)
467 printf(" %02x", tmp[i]);
468 printf("\n");
469 for(i = 0; i < 16; i++)
470 printf(" %02x", out[i]);
471 printf("\n");
472 }
473 #endif
474 return 0;
475 }
476
477 static int coroutine_fn qcow2_co_is_allocated(BlockDriverState *bs,
478 int64_t sector_num, int nb_sectors, int *pnum)
479 {
480 BDRVQcowState *s = bs->opaque;
481 uint64_t cluster_offset;
482 int ret;
483
484 *pnum = nb_sectors;
485 /* FIXME We can get errors here, but the bdrv_co_is_allocated interface
486 * can't pass them on today */
487 qemu_co_mutex_lock(&s->lock);
488 ret = qcow2_get_cluster_offset(bs, sector_num << 9, pnum, &cluster_offset);
489 qemu_co_mutex_unlock(&s->lock);
490 if (ret < 0) {
491 *pnum = 0;
492 }
493
494 return (cluster_offset != 0);
495 }
496
497 /* handle reading after the end of the backing file */
498 int qcow2_backing_read1(BlockDriverState *bs, QEMUIOVector *qiov,
499 int64_t sector_num, int nb_sectors)
500 {
501 int n1;
502 if ((sector_num + nb_sectors) <= bs->total_sectors)
503 return nb_sectors;
504 if (sector_num >= bs->total_sectors)
505 n1 = 0;
506 else
507 n1 = bs->total_sectors - sector_num;
508
509 qemu_iovec_memset_skip(qiov, 0, 512 * (nb_sectors - n1), 512 * n1);
510
511 return n1;
512 }
513
514 static coroutine_fn int qcow2_co_readv(BlockDriverState *bs, int64_t sector_num,
515 int remaining_sectors, QEMUIOVector *qiov)
516 {
517 BDRVQcowState *s = bs->opaque;
518 int index_in_cluster, n1;
519 int ret;
520 int cur_nr_sectors; /* number of sectors in current iteration */
521 uint64_t cluster_offset = 0;
522 uint64_t bytes_done = 0;
523 QEMUIOVector hd_qiov;
524 uint8_t *cluster_data = NULL;
525
526 qemu_iovec_init(&hd_qiov, qiov->niov);
527
528 qemu_co_mutex_lock(&s->lock);
529
530 while (remaining_sectors != 0) {
531
532 /* prepare next request */
533 cur_nr_sectors = remaining_sectors;
534 if (s->crypt_method) {
535 cur_nr_sectors = MIN(cur_nr_sectors,
536 QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors);
537 }
538
539 ret = qcow2_get_cluster_offset(bs, sector_num << 9,
540 &cur_nr_sectors, &cluster_offset);
541 if (ret < 0) {
542 goto fail;
543 }
544
545 index_in_cluster = sector_num & (s->cluster_sectors - 1);
546
547 qemu_iovec_reset(&hd_qiov);
548 qemu_iovec_copy(&hd_qiov, qiov, bytes_done,
549 cur_nr_sectors * 512);
550
551 switch (ret) {
552 case QCOW2_CLUSTER_UNALLOCATED:
553
554 if (bs->backing_hd) {
555 /* read from the base image */
556 n1 = qcow2_backing_read1(bs->backing_hd, &hd_qiov,
557 sector_num, cur_nr_sectors);
558 if (n1 > 0) {
559 BLKDBG_EVENT(bs->file, BLKDBG_READ_BACKING_AIO);
560 qemu_co_mutex_unlock(&s->lock);
561 ret = bdrv_co_readv(bs->backing_hd, sector_num,
562 n1, &hd_qiov);
563 qemu_co_mutex_lock(&s->lock);
564 if (ret < 0) {
565 goto fail;
566 }
567 }
568 } else {
569 /* Note: in this case, no need to wait */
570 qemu_iovec_memset(&hd_qiov, 0, 512 * cur_nr_sectors);
571 }
572 break;
573
574 case QCOW2_CLUSTER_ZERO:
575 if (s->qcow_version < 3) {
576 ret = -EIO;
577 goto fail;
578 }
579 qemu_iovec_memset(&hd_qiov, 0, 512 * cur_nr_sectors);
580 break;
581
582 case QCOW2_CLUSTER_COMPRESSED:
583 /* add AIO support for compressed blocks ? */
584 ret = qcow2_decompress_cluster(bs, cluster_offset);
585 if (ret < 0) {
586 goto fail;
587 }
588
589 qemu_iovec_from_buffer(&hd_qiov,
590 s->cluster_cache + index_in_cluster * 512,
591 512 * cur_nr_sectors);
592 break;
593
594 case QCOW2_CLUSTER_NORMAL:
595 if ((cluster_offset & 511) != 0) {
596 ret = -EIO;
597 goto fail;
598 }
599
600 if (s->crypt_method) {
601 /*
602 * For encrypted images, read everything into a temporary
603 * contiguous buffer on which the AES functions can work.
604 */
605 if (!cluster_data) {
606 cluster_data =
607 qemu_blockalign(bs, QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size);
608 }
609
610 assert(cur_nr_sectors <=
611 QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors);
612 qemu_iovec_reset(&hd_qiov);
613 qemu_iovec_add(&hd_qiov, cluster_data,
614 512 * cur_nr_sectors);
615 }
616
617 BLKDBG_EVENT(bs->file, BLKDBG_READ_AIO);
618 qemu_co_mutex_unlock(&s->lock);
619 ret = bdrv_co_readv(bs->file,
620 (cluster_offset >> 9) + index_in_cluster,
621 cur_nr_sectors, &hd_qiov);
622 qemu_co_mutex_lock(&s->lock);
623 if (ret < 0) {
624 goto fail;
625 }
626 if (s->crypt_method) {
627 qcow2_encrypt_sectors(s, sector_num, cluster_data,
628 cluster_data, cur_nr_sectors, 0, &s->aes_decrypt_key);
629 qemu_iovec_reset(&hd_qiov);
630 qemu_iovec_copy(&hd_qiov, qiov, bytes_done,
631 cur_nr_sectors * 512);
632 qemu_iovec_from_buffer(&hd_qiov, cluster_data,
633 512 * cur_nr_sectors);
634 }
635 break;
636
637 default:
638 g_assert_not_reached();
639 ret = -EIO;
640 goto fail;
641 }
642
643 remaining_sectors -= cur_nr_sectors;
644 sector_num += cur_nr_sectors;
645 bytes_done += cur_nr_sectors * 512;
646 }
647 ret = 0;
648
649 fail:
650 qemu_co_mutex_unlock(&s->lock);
651
652 qemu_iovec_destroy(&hd_qiov);
653 qemu_vfree(cluster_data);
654
655 return ret;
656 }
657
658 static void run_dependent_requests(BDRVQcowState *s, QCowL2Meta *m)
659 {
660 /* Take the request off the list of running requests */
661 if (m->nb_clusters != 0) {
662 QLIST_REMOVE(m, next_in_flight);
663 }
664
665 /* Restart all dependent requests */
666 if (!qemu_co_queue_empty(&m->dependent_requests)) {
667 qemu_co_mutex_unlock(&s->lock);
668 qemu_co_queue_restart_all(&m->dependent_requests);
669 qemu_co_mutex_lock(&s->lock);
670 }
671 }
672
673 static coroutine_fn int qcow2_co_writev(BlockDriverState *bs,
674 int64_t sector_num,
675 int remaining_sectors,
676 QEMUIOVector *qiov)
677 {
678 BDRVQcowState *s = bs->opaque;
679 int index_in_cluster;
680 int n_end;
681 int ret;
682 int cur_nr_sectors; /* number of sectors in current iteration */
683 uint64_t cluster_offset;
684 QEMUIOVector hd_qiov;
685 uint64_t bytes_done = 0;
686 uint8_t *cluster_data = NULL;
687 QCowL2Meta l2meta = {
688 .nb_clusters = 0,
689 };
690
691 trace_qcow2_writev_start_req(qemu_coroutine_self(), sector_num,
692 remaining_sectors);
693
694 qemu_co_queue_init(&l2meta.dependent_requests);
695
696 qemu_iovec_init(&hd_qiov, qiov->niov);
697
698 s->cluster_cache_offset = -1; /* disable compressed cache */
699
700 qemu_co_mutex_lock(&s->lock);
701
702 while (remaining_sectors != 0) {
703
704 trace_qcow2_writev_start_part(qemu_coroutine_self());
705 index_in_cluster = sector_num & (s->cluster_sectors - 1);
706 n_end = index_in_cluster + remaining_sectors;
707 if (s->crypt_method &&
708 n_end > QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors) {
709 n_end = QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors;
710 }
711
712 ret = qcow2_alloc_cluster_offset(bs, sector_num << 9,
713 index_in_cluster, n_end, &cur_nr_sectors, &l2meta);
714 if (ret < 0) {
715 goto fail;
716 }
717
718 cluster_offset = l2meta.cluster_offset;
719 assert((cluster_offset & 511) == 0);
720
721 qemu_iovec_reset(&hd_qiov);
722 qemu_iovec_copy(&hd_qiov, qiov, bytes_done,
723 cur_nr_sectors * 512);
724
725 if (s->crypt_method) {
726 if (!cluster_data) {
727 cluster_data = qemu_blockalign(bs, QCOW_MAX_CRYPT_CLUSTERS *
728 s->cluster_size);
729 }
730
731 assert(hd_qiov.size <=
732 QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size);
733 qemu_iovec_to_buffer(&hd_qiov, cluster_data);
734
735 qcow2_encrypt_sectors(s, sector_num, cluster_data,
736 cluster_data, cur_nr_sectors, 1, &s->aes_encrypt_key);
737
738 qemu_iovec_reset(&hd_qiov);
739 qemu_iovec_add(&hd_qiov, cluster_data,
740 cur_nr_sectors * 512);
741 }
742
743 BLKDBG_EVENT(bs->file, BLKDBG_WRITE_AIO);
744 qemu_co_mutex_unlock(&s->lock);
745 trace_qcow2_writev_data(qemu_coroutine_self(),
746 (cluster_offset >> 9) + index_in_cluster);
747 ret = bdrv_co_writev(bs->file,
748 (cluster_offset >> 9) + index_in_cluster,
749 cur_nr_sectors, &hd_qiov);
750 qemu_co_mutex_lock(&s->lock);
751 if (ret < 0) {
752 goto fail;
753 }
754
755 ret = qcow2_alloc_cluster_link_l2(bs, &l2meta);
756 if (ret < 0) {
757 goto fail;
758 }
759
760 run_dependent_requests(s, &l2meta);
761
762 remaining_sectors -= cur_nr_sectors;
763 sector_num += cur_nr_sectors;
764 bytes_done += cur_nr_sectors * 512;
765 trace_qcow2_writev_done_part(qemu_coroutine_self(), cur_nr_sectors);
766 }
767 ret = 0;
768
769 fail:
770 run_dependent_requests(s, &l2meta);
771
772 qemu_co_mutex_unlock(&s->lock);
773
774 qemu_iovec_destroy(&hd_qiov);
775 qemu_vfree(cluster_data);
776 trace_qcow2_writev_done_req(qemu_coroutine_self(), ret);
777
778 return ret;
779 }
780
781 static void qcow2_close(BlockDriverState *bs)
782 {
783 BDRVQcowState *s = bs->opaque;
784 g_free(s->l1_table);
785
786 qcow2_cache_flush(bs, s->l2_table_cache);
787 qcow2_cache_flush(bs, s->refcount_block_cache);
788
789 qcow2_cache_destroy(bs, s->l2_table_cache);
790 qcow2_cache_destroy(bs, s->refcount_block_cache);
791
792 g_free(s->unknown_header_fields);
793 cleanup_unknown_header_ext(bs);
794
795 g_free(s->cluster_cache);
796 qemu_vfree(s->cluster_data);
797 qcow2_refcount_close(bs);
798 qcow2_free_snapshots(bs);
799 }
800
801 static void qcow2_invalidate_cache(BlockDriverState *bs)
802 {
803 BDRVQcowState *s = bs->opaque;
804 int flags = s->flags;
805 AES_KEY aes_encrypt_key;
806 AES_KEY aes_decrypt_key;
807 uint32_t crypt_method = 0;
808
809 /*
810 * Backing files are read-only which makes all of their metadata immutable,
811 * that means we don't have to worry about reopening them here.
812 */
813
814 if (s->crypt_method) {
815 crypt_method = s->crypt_method;
816 memcpy(&aes_encrypt_key, &s->aes_encrypt_key, sizeof(aes_encrypt_key));
817 memcpy(&aes_decrypt_key, &s->aes_decrypt_key, sizeof(aes_decrypt_key));
818 }
819
820 qcow2_close(bs);
821
822 memset(s, 0, sizeof(BDRVQcowState));
823 qcow2_open(bs, flags);
824
825 if (crypt_method) {
826 s->crypt_method = crypt_method;
827 memcpy(&s->aes_encrypt_key, &aes_encrypt_key, sizeof(aes_encrypt_key));
828 memcpy(&s->aes_decrypt_key, &aes_decrypt_key, sizeof(aes_decrypt_key));
829 }
830 }
831
832 static size_t header_ext_add(char *buf, uint32_t magic, const void *s,
833 size_t len, size_t buflen)
834 {
835 QCowExtension *ext_backing_fmt = (QCowExtension*) buf;
836 size_t ext_len = sizeof(QCowExtension) + ((len + 7) & ~7);
837
838 if (buflen < ext_len) {
839 return -ENOSPC;
840 }
841
842 *ext_backing_fmt = (QCowExtension) {
843 .magic = cpu_to_be32(magic),
844 .len = cpu_to_be32(len),
845 };
846 memcpy(buf + sizeof(QCowExtension), s, len);
847
848 return ext_len;
849 }
850
851 /*
852 * Updates the qcow2 header, including the variable length parts of it, i.e.
853 * the backing file name and all extensions. qcow2 was not designed to allow
854 * such changes, so if we run out of space (we can only use the first cluster)
855 * this function may fail.
856 *
857 * Returns 0 on success, -errno in error cases.
858 */
859 int qcow2_update_header(BlockDriverState *bs)
860 {
861 BDRVQcowState *s = bs->opaque;
862 QCowHeader *header;
863 char *buf;
864 size_t buflen = s->cluster_size;
865 int ret;
866 uint64_t total_size;
867 uint32_t refcount_table_clusters;
868 size_t header_length;
869 Qcow2UnknownHeaderExtension *uext;
870
871 buf = qemu_blockalign(bs, buflen);
872
873 /* Header structure */
874 header = (QCowHeader*) buf;
875
876 if (buflen < sizeof(*header)) {
877 ret = -ENOSPC;
878 goto fail;
879 }
880
881 header_length = sizeof(*header) + s->unknown_header_fields_size;
882 total_size = bs->total_sectors * BDRV_SECTOR_SIZE;
883 refcount_table_clusters = s->refcount_table_size >> (s->cluster_bits - 3);
884
885 *header = (QCowHeader) {
886 /* Version 2 fields */
887 .magic = cpu_to_be32(QCOW_MAGIC),
888 .version = cpu_to_be32(s->qcow_version),
889 .backing_file_offset = 0,
890 .backing_file_size = 0,
891 .cluster_bits = cpu_to_be32(s->cluster_bits),
892 .size = cpu_to_be64(total_size),
893 .crypt_method = cpu_to_be32(s->crypt_method_header),
894 .l1_size = cpu_to_be32(s->l1_size),
895 .l1_table_offset = cpu_to_be64(s->l1_table_offset),
896 .refcount_table_offset = cpu_to_be64(s->refcount_table_offset),
897 .refcount_table_clusters = cpu_to_be32(refcount_table_clusters),
898 .nb_snapshots = cpu_to_be32(s->nb_snapshots),
899 .snapshots_offset = cpu_to_be64(s->snapshots_offset),
900
901 /* Version 3 fields */
902 .incompatible_features = cpu_to_be64(s->incompatible_features),
903 .compatible_features = cpu_to_be64(s->compatible_features),
904 .autoclear_features = cpu_to_be64(s->autoclear_features),
905 .refcount_order = cpu_to_be32(3 + REFCOUNT_SHIFT),
906 .header_length = cpu_to_be32(header_length),
907 };
908
909 /* For older versions, write a shorter header */
910 switch (s->qcow_version) {
911 case 2:
912 ret = offsetof(QCowHeader, incompatible_features);
913 break;
914 case 3:
915 ret = sizeof(*header);
916 break;
917 default:
918 return -EINVAL;
919 }
920
921 buf += ret;
922 buflen -= ret;
923 memset(buf, 0, buflen);
924
925 /* Preserve any unknown field in the header */
926 if (s->unknown_header_fields_size) {
927 if (buflen < s->unknown_header_fields_size) {
928 ret = -ENOSPC;
929 goto fail;
930 }
931
932 memcpy(buf, s->unknown_header_fields, s->unknown_header_fields_size);
933 buf += s->unknown_header_fields_size;
934 buflen -= s->unknown_header_fields_size;
935 }
936
937 /* Backing file format header extension */
938 if (*bs->backing_format) {
939 ret = header_ext_add(buf, QCOW2_EXT_MAGIC_BACKING_FORMAT,
940 bs->backing_format, strlen(bs->backing_format),
941 buflen);
942 if (ret < 0) {
943 goto fail;
944 }
945
946 buf += ret;
947 buflen -= ret;
948 }
949
950 /* Feature table */
951 Qcow2Feature features[] = {
952 /* no feature defined yet */
953 };
954
955 ret = header_ext_add(buf, QCOW2_EXT_MAGIC_FEATURE_TABLE,
956 features, sizeof(features), buflen);
957 if (ret < 0) {
958 goto fail;
959 }
960 buf += ret;
961 buflen -= ret;
962
963 /* Keep unknown header extensions */
964 QLIST_FOREACH(uext, &s->unknown_header_ext, next) {
965 ret = header_ext_add(buf, uext->magic, uext->data, uext->len, buflen);
966 if (ret < 0) {
967 goto fail;
968 }
969
970 buf += ret;
971 buflen -= ret;
972 }
973
974 /* End of header extensions */
975 ret = header_ext_add(buf, QCOW2_EXT_MAGIC_END, NULL, 0, buflen);
976 if (ret < 0) {
977 goto fail;
978 }
979
980 buf += ret;
981 buflen -= ret;
982
983 /* Backing file name */
984 if (*bs->backing_file) {
985 size_t backing_file_len = strlen(bs->backing_file);
986
987 if (buflen < backing_file_len) {
988 ret = -ENOSPC;
989 goto fail;
990 }
991
992 strncpy(buf, bs->backing_file, buflen);
993
994 header->backing_file_offset = cpu_to_be64(buf - ((char*) header));
995 header->backing_file_size = cpu_to_be32(backing_file_len);
996 }
997
998 /* Write the new header */
999 ret = bdrv_pwrite(bs->file, 0, header, s->cluster_size);
1000 if (ret < 0) {
1001 goto fail;
1002 }
1003
1004 ret = 0;
1005 fail:
1006 qemu_vfree(header);
1007 return ret;
1008 }
1009
1010 static int qcow2_change_backing_file(BlockDriverState *bs,
1011 const char *backing_file, const char *backing_fmt)
1012 {
1013 /* Backing file format doesn't make sense without a backing file */
1014 if (backing_fmt && !backing_file) {
1015 return -EINVAL;
1016 }
1017
1018 pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: "");
1019 pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: "");
1020
1021 return qcow2_update_header(bs);
1022 }
1023
1024 static int preallocate(BlockDriverState *bs)
1025 {
1026 uint64_t nb_sectors;
1027 uint64_t offset;
1028 int num;
1029 int ret;
1030 QCowL2Meta meta;
1031
1032 nb_sectors = bdrv_getlength(bs) >> 9;
1033 offset = 0;
1034 qemu_co_queue_init(&meta.dependent_requests);
1035 meta.cluster_offset = 0;
1036
1037 while (nb_sectors) {
1038 num = MIN(nb_sectors, INT_MAX >> 9);
1039 ret = qcow2_alloc_cluster_offset(bs, offset, 0, num, &num, &meta);
1040 if (ret < 0) {
1041 return ret;
1042 }
1043
1044 ret = qcow2_alloc_cluster_link_l2(bs, &meta);
1045 if (ret < 0) {
1046 qcow2_free_any_clusters(bs, meta.cluster_offset, meta.nb_clusters);
1047 return ret;
1048 }
1049
1050 /* There are no dependent requests, but we need to remove our request
1051 * from the list of in-flight requests */
1052 run_dependent_requests(bs->opaque, &meta);
1053
1054 /* TODO Preallocate data if requested */
1055
1056 nb_sectors -= num;
1057 offset += num << 9;
1058 }
1059
1060 /*
1061 * It is expected that the image file is large enough to actually contain
1062 * all of the allocated clusters (otherwise we get failing reads after
1063 * EOF). Extend the image to the last allocated sector.
1064 */
1065 if (meta.cluster_offset != 0) {
1066 uint8_t buf[512];
1067 memset(buf, 0, 512);
1068 ret = bdrv_write(bs->file, (meta.cluster_offset >> 9) + num - 1, buf, 1);
1069 if (ret < 0) {
1070 return ret;
1071 }
1072 }
1073
1074 return 0;
1075 }
1076
1077 static int qcow2_create2(const char *filename, int64_t total_size,
1078 const char *backing_file, const char *backing_format,
1079 int flags, size_t cluster_size, int prealloc,
1080 QEMUOptionParameter *options, int version)
1081 {
1082 /* Calculate cluster_bits */
1083 int cluster_bits;
1084 cluster_bits = ffs(cluster_size) - 1;
1085 if (cluster_bits < MIN_CLUSTER_BITS || cluster_bits > MAX_CLUSTER_BITS ||
1086 (1 << cluster_bits) != cluster_size)
1087 {
1088 error_report(
1089 "Cluster size must be a power of two between %d and %dk",
1090 1 << MIN_CLUSTER_BITS, 1 << (MAX_CLUSTER_BITS - 10));
1091 return -EINVAL;
1092 }
1093
1094 /*
1095 * Open the image file and write a minimal qcow2 header.
1096 *
1097 * We keep things simple and start with a zero-sized image. We also
1098 * do without refcount blocks or a L1 table for now. We'll fix the
1099 * inconsistency later.
1100 *
1101 * We do need a refcount table because growing the refcount table means
1102 * allocating two new refcount blocks - the seconds of which would be at
1103 * 2 GB for 64k clusters, and we don't want to have a 2 GB initial file
1104 * size for any qcow2 image.
1105 */
1106 BlockDriverState* bs;
1107 QCowHeader header;
1108 uint8_t* refcount_table;
1109 int ret;
1110
1111 ret = bdrv_create_file(filename, options);
1112 if (ret < 0) {
1113 return ret;
1114 }
1115
1116 ret = bdrv_file_open(&bs, filename, BDRV_O_RDWR);
1117 if (ret < 0) {
1118 return ret;
1119 }
1120
1121 /* Write the header */
1122 memset(&header, 0, sizeof(header));
1123 header.magic = cpu_to_be32(QCOW_MAGIC);
1124 header.version = cpu_to_be32(version);
1125 header.cluster_bits = cpu_to_be32(cluster_bits);
1126 header.size = cpu_to_be64(0);
1127 header.l1_table_offset = cpu_to_be64(0);
1128 header.l1_size = cpu_to_be32(0);
1129 header.refcount_table_offset = cpu_to_be64(cluster_size);
1130 header.refcount_table_clusters = cpu_to_be32(1);
1131 header.refcount_order = cpu_to_be32(3 + REFCOUNT_SHIFT);
1132 header.header_length = cpu_to_be32(sizeof(header));
1133
1134 if (flags & BLOCK_FLAG_ENCRYPT) {
1135 header.crypt_method = cpu_to_be32(QCOW_CRYPT_AES);
1136 } else {
1137 header.crypt_method = cpu_to_be32(QCOW_CRYPT_NONE);
1138 }
1139
1140 ret = bdrv_pwrite(bs, 0, &header, sizeof(header));
1141 if (ret < 0) {
1142 goto out;
1143 }
1144
1145 /* Write an empty refcount table */
1146 refcount_table = g_malloc0(cluster_size);
1147 ret = bdrv_pwrite(bs, cluster_size, refcount_table, cluster_size);
1148 g_free(refcount_table);
1149
1150 if (ret < 0) {
1151 goto out;
1152 }
1153
1154 bdrv_close(bs);
1155
1156 /*
1157 * And now open the image and make it consistent first (i.e. increase the
1158 * refcount of the cluster that is occupied by the header and the refcount
1159 * table)
1160 */
1161 BlockDriver* drv = bdrv_find_format("qcow2");
1162 assert(drv != NULL);
1163 ret = bdrv_open(bs, filename,
1164 BDRV_O_RDWR | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH, drv);
1165 if (ret < 0) {
1166 goto out;
1167 }
1168
1169 ret = qcow2_alloc_clusters(bs, 2 * cluster_size);
1170 if (ret < 0) {
1171 goto out;
1172
1173 } else if (ret != 0) {
1174 error_report("Huh, first cluster in empty image is already in use?");
1175 abort();
1176 }
1177
1178 /* Okay, now that we have a valid image, let's give it the right size */
1179 ret = bdrv_truncate(bs, total_size * BDRV_SECTOR_SIZE);
1180 if (ret < 0) {
1181 goto out;
1182 }
1183
1184 /* Want a backing file? There you go.*/
1185 if (backing_file) {
1186 ret = bdrv_change_backing_file(bs, backing_file, backing_format);
1187 if (ret < 0) {
1188 goto out;
1189 }
1190 }
1191
1192 /* And if we're supposed to preallocate metadata, do that now */
1193 if (prealloc) {
1194 ret = preallocate(bs);
1195 if (ret < 0) {
1196 goto out;
1197 }
1198 }
1199
1200 ret = 0;
1201 out:
1202 bdrv_delete(bs);
1203 return ret;
1204 }
1205
1206 static int qcow2_create(const char *filename, QEMUOptionParameter *options)
1207 {
1208 const char *backing_file = NULL;
1209 const char *backing_fmt = NULL;
1210 uint64_t sectors = 0;
1211 int flags = 0;
1212 size_t cluster_size = DEFAULT_CLUSTER_SIZE;
1213 int prealloc = 0;
1214 int version = 2;
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 }
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 }
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
1260 return qcow2_create2(filename, sectors, backing_file, backing_fmt, flags,
1261 cluster_size, prealloc, options, version);
1262 }
1263
1264 static int qcow2_make_empty(BlockDriverState *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);
1273 if (bdrv_pwrite(bs->file, s->l1_table_offset, s->l1_table, l1_length) < 0)
1274 return -1;
1275 ret = bdrv_truncate(bs->file, s->l1_table_offset + l1_length);
1276 if (ret < 0)
1277 return ret;
1278
1279 l2_cache_reset(bs);
1280 #endif
1281 return 0;
1282 }
1283
1284 static 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
1304 static coroutine_fn int qcow2_co_discard(BlockDriverState *bs,
1305 int64_t sector_num, int nb_sectors)
1306 {
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,
1312 nb_sectors);
1313 qemu_co_mutex_unlock(&s->lock);
1314 return ret;
1315 }
1316
1317 static 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) {
1323 error_report("The new size must be a multiple of 512");
1324 return -EINVAL;
1325 }
1326
1327 /* cannot proceed if image has snapshots */
1328 if (s->nb_snapshots) {
1329 error_report("Can't resize an image which has snapshots");
1330 return -ENOTSUP;
1331 }
1332
1333 /* shrinking is currently not supported */
1334 if (offset < bs->total_sectors * 512) {
1335 error_report("qcow2 doesn't support shrinking images yet");
1336 return -ENOTSUP;
1337 }
1338
1339 new_l1_size = size_to_l1(s, offset);
1340 ret = qcow2_grow_l1_table(bs, new_l1_size, true);
1341 if (ret < 0) {
1342 return ret;
1343 }
1344
1345 /* write updated header.size */
1346 offset = cpu_to_be64(offset);
1347 ret = bdrv_pwrite_sync(bs->file, offsetof(QCowHeader, size),
1348 &offset, sizeof(uint64_t));
1349 if (ret < 0) {
1350 return ret;
1351 }
1352
1353 s->l1_vm_state_index = new_l1_size;
1354 return 0;
1355 }
1356
1357 /* XXX: put compressed sectors first, then all the cluster aligned
1358 tables to avoid losing bytes in alignment */
1359 static int qcow2_write_compressed(BlockDriverState *bs, int64_t sector_num,
1360 const uint8_t *buf, int nb_sectors)
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 */
1371 cluster_offset = bdrv_getlength(bs->file);
1372 cluster_offset = (cluster_offset + 511) & ~511;
1373 bdrv_truncate(bs->file, cluster_offset);
1374 return 0;
1375 }
1376
1377 if (nb_sectors != s->cluster_sectors)
1378 return -EINVAL;
1379
1380 out_buf = g_malloc(s->cluster_size + (s->cluster_size / 1000) + 128);
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) {
1388 ret = -EINVAL;
1389 goto fail;
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) {
1399 deflateEnd(&strm);
1400 ret = -EINVAL;
1401 goto fail;
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 */
1409 ret = bdrv_write(bs, sector_num, buf, s->cluster_sectors);
1410 if (ret < 0) {
1411 goto fail;
1412 }
1413 } else {
1414 cluster_offset = qcow2_alloc_compressed_cluster_offset(bs,
1415 sector_num << 9, out_len);
1416 if (!cluster_offset) {
1417 ret = -EIO;
1418 goto fail;
1419 }
1420 cluster_offset &= s->cluster_offset_mask;
1421 BLKDBG_EVENT(bs->file, BLKDBG_WRITE_COMPRESSED);
1422 ret = bdrv_pwrite(bs->file, cluster_offset, out_buf, out_len);
1423 if (ret < 0) {
1424 goto fail;
1425 }
1426 }
1427
1428 ret = 0;
1429 fail:
1430 g_free(out_buf);
1431 return ret;
1432 }
1433
1434 static coroutine_fn int qcow2_co_flush_to_os(BlockDriverState *bs)
1435 {
1436 BDRVQcowState *s = bs->opaque;
1437 int ret;
1438
1439 qemu_co_mutex_lock(&s->lock);
1440 ret = qcow2_cache_flush(bs, s->l2_table_cache);
1441 if (ret < 0) {
1442 qemu_co_mutex_unlock(&s->lock);
1443 return ret;
1444 }
1445
1446 ret = qcow2_cache_flush(bs, s->refcount_block_cache);
1447 if (ret < 0) {
1448 qemu_co_mutex_unlock(&s->lock);
1449 return ret;
1450 }
1451 qemu_co_mutex_unlock(&s->lock);
1452
1453 return 0;
1454 }
1455
1456 static int64_t qcow2_vm_state_offset(BDRVQcowState *s)
1457 {
1458 return (int64_t)s->l1_vm_state_index << (s->cluster_bits + s->l2_bits);
1459 }
1460
1461 static int qcow2_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
1462 {
1463 BDRVQcowState *s = bs->opaque;
1464 bdi->cluster_size = s->cluster_size;
1465 bdi->vm_state_offset = qcow2_vm_state_offset(s);
1466 return 0;
1467 }
1468
1469
1470 static int qcow2_check(BlockDriverState *bs, BdrvCheckResult *result)
1471 {
1472 return qcow2_check_refcounts(bs, result);
1473 }
1474
1475 #if 0
1476 static void dump_refcounts(BlockDriverState *bs)
1477 {
1478 BDRVQcowState *s = bs->opaque;
1479 int64_t nb_clusters, k, k1, size;
1480 int refcount;
1481
1482 size = bdrv_getlength(bs->file);
1483 nb_clusters = size_to_clusters(s, size);
1484 for(k = 0; k < nb_clusters;) {
1485 k1 = k;
1486 refcount = get_refcount(bs, k);
1487 k++;
1488 while (k < nb_clusters && get_refcount(bs, k) == refcount)
1489 k++;
1490 printf("%" PRId64 ": refcount=%d nb=%" PRId64 "\n", k, refcount,
1491 k - k1);
1492 }
1493 }
1494 #endif
1495
1496 static int qcow2_save_vmstate(BlockDriverState *bs, const uint8_t *buf,
1497 int64_t pos, int size)
1498 {
1499 BDRVQcowState *s = bs->opaque;
1500 int growable = bs->growable;
1501 int ret;
1502
1503 BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_SAVE);
1504 bs->growable = 1;
1505 ret = bdrv_pwrite(bs, qcow2_vm_state_offset(s) + pos, buf, size);
1506 bs->growable = growable;
1507
1508 return ret;
1509 }
1510
1511 static int qcow2_load_vmstate(BlockDriverState *bs, uint8_t *buf,
1512 int64_t pos, int size)
1513 {
1514 BDRVQcowState *s = bs->opaque;
1515 int growable = bs->growable;
1516 int ret;
1517
1518 BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_LOAD);
1519 bs->growable = 1;
1520 ret = bdrv_pread(bs, qcow2_vm_state_offset(s) + pos, buf, size);
1521 bs->growable = growable;
1522
1523 return ret;
1524 }
1525
1526 static QEMUOptionParameter qcow2_create_options[] = {
1527 {
1528 .name = BLOCK_OPT_SIZE,
1529 .type = OPT_SIZE,
1530 .help = "Virtual disk size"
1531 },
1532 {
1533 .name = BLOCK_OPT_COMPAT_LEVEL,
1534 .type = OPT_STRING,
1535 .help = "Compatibility level (0.10 or 1.1)"
1536 },
1537 {
1538 .name = BLOCK_OPT_BACKING_FILE,
1539 .type = OPT_STRING,
1540 .help = "File name of a base image"
1541 },
1542 {
1543 .name = BLOCK_OPT_BACKING_FMT,
1544 .type = OPT_STRING,
1545 .help = "Image format of the base image"
1546 },
1547 {
1548 .name = BLOCK_OPT_ENCRYPT,
1549 .type = OPT_FLAG,
1550 .help = "Encrypt the image"
1551 },
1552 {
1553 .name = BLOCK_OPT_CLUSTER_SIZE,
1554 .type = OPT_SIZE,
1555 .help = "qcow2 cluster size",
1556 .value = { .n = DEFAULT_CLUSTER_SIZE },
1557 },
1558 {
1559 .name = BLOCK_OPT_PREALLOC,
1560 .type = OPT_STRING,
1561 .help = "Preallocation mode (allowed values: off, metadata)"
1562 },
1563 { NULL }
1564 };
1565
1566 static BlockDriver bdrv_qcow2 = {
1567 .format_name = "qcow2",
1568 .instance_size = sizeof(BDRVQcowState),
1569 .bdrv_probe = qcow2_probe,
1570 .bdrv_open = qcow2_open,
1571 .bdrv_close = qcow2_close,
1572 .bdrv_create = qcow2_create,
1573 .bdrv_co_is_allocated = qcow2_co_is_allocated,
1574 .bdrv_set_key = qcow2_set_key,
1575 .bdrv_make_empty = qcow2_make_empty,
1576
1577 .bdrv_co_readv = qcow2_co_readv,
1578 .bdrv_co_writev = qcow2_co_writev,
1579 .bdrv_co_flush_to_os = qcow2_co_flush_to_os,
1580
1581 .bdrv_co_write_zeroes = qcow2_co_write_zeroes,
1582 .bdrv_co_discard = qcow2_co_discard,
1583 .bdrv_truncate = qcow2_truncate,
1584 .bdrv_write_compressed = qcow2_write_compressed,
1585
1586 .bdrv_snapshot_create = qcow2_snapshot_create,
1587 .bdrv_snapshot_goto = qcow2_snapshot_goto,
1588 .bdrv_snapshot_delete = qcow2_snapshot_delete,
1589 .bdrv_snapshot_list = qcow2_snapshot_list,
1590 .bdrv_snapshot_load_tmp = qcow2_snapshot_load_tmp,
1591 .bdrv_get_info = qcow2_get_info,
1592
1593 .bdrv_save_vmstate = qcow2_save_vmstate,
1594 .bdrv_load_vmstate = qcow2_load_vmstate,
1595
1596 .bdrv_change_backing_file = qcow2_change_backing_file,
1597
1598 .bdrv_invalidate_cache = qcow2_invalidate_cache,
1599
1600 .create_options = qcow2_create_options,
1601 .bdrv_check = qcow2_check,
1602 };
1603
1604 static void bdrv_qcow2_init(void)
1605 {
1606 bdrv_register(&bdrv_qcow2);
1607 }
1608
1609 block_init(bdrv_qcow2_init);