2 * Block driver for the QCOW version 2 format
4 * Copyright (c) 2004-2006 Fabrice Bellard
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
25 #include "qemu/osdep.h"
26 #include "block/block-io.h"
27 #include "qapi/error.h"
29 #include "qemu/range.h"
30 #include "qemu/bswap.h"
31 #include "qemu/cutils.h"
32 #include "qemu/memalign.h"
35 static int64_t alloc_clusters_noref(BlockDriverState
*bs
, uint64_t size
,
38 G_GNUC_WARN_UNUSED_RESULT
39 static int update_refcount(BlockDriverState
*bs
,
40 int64_t offset
, int64_t length
, uint64_t addend
,
41 bool decrease
, enum qcow2_discard_type type
);
43 static uint64_t get_refcount_ro0(const void *refcount_array
, uint64_t index
);
44 static uint64_t get_refcount_ro1(const void *refcount_array
, uint64_t index
);
45 static uint64_t get_refcount_ro2(const void *refcount_array
, uint64_t index
);
46 static uint64_t get_refcount_ro3(const void *refcount_array
, uint64_t index
);
47 static uint64_t get_refcount_ro4(const void *refcount_array
, uint64_t index
);
48 static uint64_t get_refcount_ro5(const void *refcount_array
, uint64_t index
);
49 static uint64_t get_refcount_ro6(const void *refcount_array
, uint64_t index
);
51 static void set_refcount_ro0(void *refcount_array
, uint64_t index
,
53 static void set_refcount_ro1(void *refcount_array
, uint64_t index
,
55 static void set_refcount_ro2(void *refcount_array
, uint64_t index
,
57 static void set_refcount_ro3(void *refcount_array
, uint64_t index
,
59 static void set_refcount_ro4(void *refcount_array
, uint64_t index
,
61 static void set_refcount_ro5(void *refcount_array
, uint64_t index
,
63 static void set_refcount_ro6(void *refcount_array
, uint64_t index
,
67 static Qcow2GetRefcountFunc
*const get_refcount_funcs
[] = {
77 static Qcow2SetRefcountFunc
*const set_refcount_funcs
[] = {
88 /*********************************************************/
89 /* refcount handling */
91 static void update_max_refcount_table_index(BDRVQcow2State
*s
)
93 unsigned i
= s
->refcount_table_size
- 1;
94 while (i
> 0 && (s
->refcount_table
[i
] & REFT_OFFSET_MASK
) == 0) {
97 /* Set s->max_refcount_table_index to the index of the last used entry */
98 s
->max_refcount_table_index
= i
;
101 int coroutine_fn
qcow2_refcount_init(BlockDriverState
*bs
)
103 BDRVQcow2State
*s
= bs
->opaque
;
104 unsigned int refcount_table_size2
, i
;
107 assert(s
->refcount_order
>= 0 && s
->refcount_order
<= 6);
109 s
->get_refcount
= get_refcount_funcs
[s
->refcount_order
];
110 s
->set_refcount
= set_refcount_funcs
[s
->refcount_order
];
112 assert(s
->refcount_table_size
<= INT_MAX
/ REFTABLE_ENTRY_SIZE
);
113 refcount_table_size2
= s
->refcount_table_size
* REFTABLE_ENTRY_SIZE
;
114 s
->refcount_table
= g_try_malloc(refcount_table_size2
);
116 if (s
->refcount_table_size
> 0) {
117 if (s
->refcount_table
== NULL
) {
121 BLKDBG_EVENT(bs
->file
, BLKDBG_REFTABLE_LOAD
);
122 ret
= bdrv_co_pread(bs
->file
, s
->refcount_table_offset
,
123 refcount_table_size2
, s
->refcount_table
, 0);
127 for(i
= 0; i
< s
->refcount_table_size
; i
++)
128 be64_to_cpus(&s
->refcount_table
[i
]);
129 update_max_refcount_table_index(s
);
136 void qcow2_refcount_close(BlockDriverState
*bs
)
138 BDRVQcow2State
*s
= bs
->opaque
;
139 g_free(s
->refcount_table
);
143 static uint64_t get_refcount_ro0(const void *refcount_array
, uint64_t index
)
145 return (((const uint8_t *)refcount_array
)[index
/ 8] >> (index
% 8)) & 0x1;
148 static void set_refcount_ro0(void *refcount_array
, uint64_t index
,
151 assert(!(value
>> 1));
152 ((uint8_t *)refcount_array
)[index
/ 8] &= ~(0x1 << (index
% 8));
153 ((uint8_t *)refcount_array
)[index
/ 8] |= value
<< (index
% 8);
156 static uint64_t get_refcount_ro1(const void *refcount_array
, uint64_t index
)
158 return (((const uint8_t *)refcount_array
)[index
/ 4] >> (2 * (index
% 4)))
162 static void set_refcount_ro1(void *refcount_array
, uint64_t index
,
165 assert(!(value
>> 2));
166 ((uint8_t *)refcount_array
)[index
/ 4] &= ~(0x3 << (2 * (index
% 4)));
167 ((uint8_t *)refcount_array
)[index
/ 4] |= value
<< (2 * (index
% 4));
170 static uint64_t get_refcount_ro2(const void *refcount_array
, uint64_t index
)
172 return (((const uint8_t *)refcount_array
)[index
/ 2] >> (4 * (index
% 2)))
176 static void set_refcount_ro2(void *refcount_array
, uint64_t index
,
179 assert(!(value
>> 4));
180 ((uint8_t *)refcount_array
)[index
/ 2] &= ~(0xf << (4 * (index
% 2)));
181 ((uint8_t *)refcount_array
)[index
/ 2] |= value
<< (4 * (index
% 2));
184 static uint64_t get_refcount_ro3(const void *refcount_array
, uint64_t index
)
186 return ((const uint8_t *)refcount_array
)[index
];
189 static void set_refcount_ro3(void *refcount_array
, uint64_t index
,
192 assert(!(value
>> 8));
193 ((uint8_t *)refcount_array
)[index
] = value
;
196 static uint64_t get_refcount_ro4(const void *refcount_array
, uint64_t index
)
198 return be16_to_cpu(((const uint16_t *)refcount_array
)[index
]);
201 static void set_refcount_ro4(void *refcount_array
, uint64_t index
,
204 assert(!(value
>> 16));
205 ((uint16_t *)refcount_array
)[index
] = cpu_to_be16(value
);
208 static uint64_t get_refcount_ro5(const void *refcount_array
, uint64_t index
)
210 return be32_to_cpu(((const uint32_t *)refcount_array
)[index
]);
213 static void set_refcount_ro5(void *refcount_array
, uint64_t index
,
216 assert(!(value
>> 32));
217 ((uint32_t *)refcount_array
)[index
] = cpu_to_be32(value
);
220 static uint64_t get_refcount_ro6(const void *refcount_array
, uint64_t index
)
222 return be64_to_cpu(((const uint64_t *)refcount_array
)[index
]);
225 static void set_refcount_ro6(void *refcount_array
, uint64_t index
,
228 ((uint64_t *)refcount_array
)[index
] = cpu_to_be64(value
);
232 static int load_refcount_block(BlockDriverState
*bs
,
233 int64_t refcount_block_offset
,
234 void **refcount_block
)
236 BDRVQcow2State
*s
= bs
->opaque
;
238 BLKDBG_EVENT(bs
->file
, BLKDBG_REFBLOCK_LOAD
);
239 return qcow2_cache_get(bs
, s
->refcount_block_cache
, refcount_block_offset
,
244 * Retrieves the refcount of the cluster given by its index and stores it in
245 * *refcount. Returns 0 on success and -errno on failure.
247 int qcow2_get_refcount(BlockDriverState
*bs
, int64_t cluster_index
,
250 BDRVQcow2State
*s
= bs
->opaque
;
251 uint64_t refcount_table_index
, block_index
;
252 int64_t refcount_block_offset
;
254 void *refcount_block
;
256 refcount_table_index
= cluster_index
>> s
->refcount_block_bits
;
257 if (refcount_table_index
>= s
->refcount_table_size
) {
261 refcount_block_offset
=
262 s
->refcount_table
[refcount_table_index
] & REFT_OFFSET_MASK
;
263 if (!refcount_block_offset
) {
268 if (offset_into_cluster(s
, refcount_block_offset
)) {
269 qcow2_signal_corruption(bs
, true, -1, -1, "Refblock offset %#" PRIx64
270 " unaligned (reftable index: %#" PRIx64
")",
271 refcount_block_offset
, refcount_table_index
);
275 ret
= qcow2_cache_get(bs
, s
->refcount_block_cache
, refcount_block_offset
,
281 block_index
= cluster_index
& (s
->refcount_block_size
- 1);
282 *refcount
= s
->get_refcount(refcount_block
, block_index
);
284 qcow2_cache_put(s
->refcount_block_cache
, &refcount_block
);
289 /* Checks if two offsets are described by the same refcount block */
290 static int in_same_refcount_block(BDRVQcow2State
*s
, uint64_t offset_a
,
293 uint64_t block_a
= offset_a
>> (s
->cluster_bits
+ s
->refcount_block_bits
);
294 uint64_t block_b
= offset_b
>> (s
->cluster_bits
+ s
->refcount_block_bits
);
296 return (block_a
== block_b
);
300 * Loads a refcount block. If it doesn't exist yet, it is allocated first
301 * (including growing the refcount table if needed).
303 * Returns 0 on success or -errno in error case
305 static int alloc_refcount_block(BlockDriverState
*bs
,
306 int64_t cluster_index
, void **refcount_block
)
308 BDRVQcow2State
*s
= bs
->opaque
;
309 unsigned int refcount_table_index
;
312 BLKDBG_EVENT(bs
->file
, BLKDBG_REFBLOCK_ALLOC
);
314 /* Find the refcount block for the given cluster */
315 refcount_table_index
= cluster_index
>> s
->refcount_block_bits
;
317 if (refcount_table_index
< s
->refcount_table_size
) {
319 uint64_t refcount_block_offset
=
320 s
->refcount_table
[refcount_table_index
] & REFT_OFFSET_MASK
;
322 /* If it's already there, we're done */
323 if (refcount_block_offset
) {
324 if (offset_into_cluster(s
, refcount_block_offset
)) {
325 qcow2_signal_corruption(bs
, true, -1, -1, "Refblock offset %#"
326 PRIx64
" unaligned (reftable index: "
327 "%#x)", refcount_block_offset
,
328 refcount_table_index
);
332 return load_refcount_block(bs
, refcount_block_offset
,
338 * If we came here, we need to allocate something. Something is at least
339 * a cluster for the new refcount block. It may also include a new refcount
340 * table if the old refcount table is too small.
342 * Note that allocating clusters here needs some special care:
344 * - We can't use the normal qcow2_alloc_clusters(), it would try to
345 * increase the refcount and very likely we would end up with an endless
346 * recursion. Instead we must place the refcount blocks in a way that
347 * they can describe them themselves.
349 * - We need to consider that at this point we are inside update_refcounts
350 * and potentially doing an initial refcount increase. This means that
351 * some clusters have already been allocated by the caller, but their
352 * refcount isn't accurate yet. If we allocate clusters for metadata, we
353 * need to return -EAGAIN to signal the caller that it needs to restart
354 * the search for free clusters.
356 * - alloc_clusters_noref and qcow2_free_clusters may load a different
357 * refcount block into the cache
360 *refcount_block
= NULL
;
362 /* We write to the refcount table, so we might depend on L2 tables */
363 ret
= qcow2_cache_flush(bs
, s
->l2_table_cache
);
368 /* Allocate the refcount block itself and mark it as used */
369 int64_t new_block
= alloc_clusters_noref(bs
, s
->cluster_size
, INT64_MAX
);
374 /* The offset must fit in the offset field of the refcount table entry */
375 assert((new_block
& REFT_OFFSET_MASK
) == new_block
);
377 /* If we're allocating the block at offset 0 then something is wrong */
378 if (new_block
== 0) {
379 qcow2_signal_corruption(bs
, true, -1, -1, "Preventing invalid "
380 "allocation of refcount block at offset 0");
385 fprintf(stderr
, "qcow2: Allocate refcount block %d for %" PRIx64
387 refcount_table_index
, cluster_index
<< s
->cluster_bits
, new_block
);
390 if (in_same_refcount_block(s
, new_block
, cluster_index
<< s
->cluster_bits
)) {
391 /* Zero the new refcount block before updating it */
392 ret
= qcow2_cache_get_empty(bs
, s
->refcount_block_cache
, new_block
,
398 memset(*refcount_block
, 0, s
->cluster_size
);
400 /* The block describes itself, need to update the cache */
401 int block_index
= (new_block
>> s
->cluster_bits
) &
402 (s
->refcount_block_size
- 1);
403 s
->set_refcount(*refcount_block
, block_index
, 1);
405 /* Described somewhere else. This can recurse at most twice before we
406 * arrive at a block that describes itself. */
407 ret
= update_refcount(bs
, new_block
, s
->cluster_size
, 1, false,
408 QCOW2_DISCARD_NEVER
);
413 ret
= qcow2_cache_flush(bs
, s
->refcount_block_cache
);
418 /* Initialize the new refcount block only after updating its refcount,
419 * update_refcount uses the refcount cache itself */
420 ret
= qcow2_cache_get_empty(bs
, s
->refcount_block_cache
, new_block
,
426 memset(*refcount_block
, 0, s
->cluster_size
);
429 /* Now the new refcount block needs to be written to disk */
430 BLKDBG_EVENT(bs
->file
, BLKDBG_REFBLOCK_ALLOC_WRITE
);
431 qcow2_cache_entry_mark_dirty(s
->refcount_block_cache
, *refcount_block
);
432 ret
= qcow2_cache_flush(bs
, s
->refcount_block_cache
);
437 /* If the refcount table is big enough, just hook the block up there */
438 if (refcount_table_index
< s
->refcount_table_size
) {
439 uint64_t data64
= cpu_to_be64(new_block
);
440 BLKDBG_EVENT(bs
->file
, BLKDBG_REFBLOCK_ALLOC_HOOKUP
);
441 ret
= bdrv_pwrite_sync(bs
->file
, s
->refcount_table_offset
+
442 refcount_table_index
* REFTABLE_ENTRY_SIZE
,
443 sizeof(data64
), &data64
, 0);
448 s
->refcount_table
[refcount_table_index
] = new_block
;
449 /* If there's a hole in s->refcount_table then it can happen
450 * that refcount_table_index < s->max_refcount_table_index */
451 s
->max_refcount_table_index
=
452 MAX(s
->max_refcount_table_index
, refcount_table_index
);
454 /* The new refcount block may be where the caller intended to put its
455 * data, so let it restart the search. */
459 qcow2_cache_put(s
->refcount_block_cache
, refcount_block
);
462 * If we come here, we need to grow the refcount table. Again, a new
463 * refcount table needs some space and we can't simply allocate to avoid
466 * Therefore let's grab new refcount blocks at the end of the image, which
467 * will describe themselves and the new refcount table. This way we can
468 * reference them only in the new table and do the switch to the new
469 * refcount table at once without producing an inconsistent state in
472 BLKDBG_EVENT(bs
->file
, BLKDBG_REFTABLE_GROW
);
474 /* Calculate the number of refcount blocks needed so far; this will be the
475 * basis for calculating the index of the first cluster used for the
476 * self-describing refcount structures which we are about to create.
478 * Because we reached this point, there cannot be any refcount entries for
479 * cluster_index or higher indices yet. However, because new_block has been
480 * allocated to describe that cluster (and it will assume this role later
481 * on), we cannot use that index; also, new_block may actually have a higher
482 * cluster index than cluster_index, so it needs to be taken into account
483 * here (and 1 needs to be added to its value because that cluster is used).
485 uint64_t blocks_used
= DIV_ROUND_UP(MAX(cluster_index
+ 1,
486 (new_block
>> s
->cluster_bits
) + 1),
487 s
->refcount_block_size
);
489 /* Create the new refcount table and blocks */
490 uint64_t meta_offset
= (blocks_used
* s
->refcount_block_size
) *
493 ret
= qcow2_refcount_area(bs
, meta_offset
, 0, false,
494 refcount_table_index
, new_block
);
499 ret
= load_refcount_block(bs
, new_block
, refcount_block
);
504 /* If we were trying to do the initial refcount update for some cluster
505 * allocation, we might have used the same clusters to store newly
506 * allocated metadata. Make the caller search some new space. */
510 if (*refcount_block
!= NULL
) {
511 qcow2_cache_put(s
->refcount_block_cache
, refcount_block
);
517 * Starting at @start_offset, this function creates new self-covering refcount
518 * structures: A new refcount table and refcount blocks which cover all of
519 * themselves, and a number of @additional_clusters beyond their end.
520 * @start_offset must be at the end of the image file, that is, there must be
521 * only empty space beyond it.
522 * If @exact_size is false, the refcount table will have 50 % more entries than
523 * necessary so it will not need to grow again soon.
524 * If @new_refblock_offset is not zero, it contains the offset of a refcount
525 * block that should be entered into the new refcount table at index
526 * @new_refblock_index.
528 * Returns: The offset after the new refcount structures (i.e. where the
529 * @additional_clusters may be placed) on success, -errno on error.
531 int64_t qcow2_refcount_area(BlockDriverState
*bs
, uint64_t start_offset
,
532 uint64_t additional_clusters
, bool exact_size
,
533 int new_refblock_index
,
534 uint64_t new_refblock_offset
)
536 BDRVQcow2State
*s
= bs
->opaque
;
537 uint64_t total_refblock_count_u64
, additional_refblock_count
;
538 int total_refblock_count
, table_size
, area_reftable_index
, table_clusters
;
540 uint64_t table_offset
, block_offset
, end_offset
;
544 assert(!(start_offset
% s
->cluster_size
));
546 qcow2_refcount_metadata_size(start_offset
/ s
->cluster_size
+
548 s
->cluster_size
, s
->refcount_order
,
549 !exact_size
, &total_refblock_count_u64
);
550 if (total_refblock_count_u64
> QCOW_MAX_REFTABLE_SIZE
) {
553 total_refblock_count
= total_refblock_count_u64
;
555 /* Index in the refcount table of the first refcount block to cover the area
556 * of refcount structures we are about to create; we know that
557 * @total_refblock_count can cover @start_offset, so this will definitely
558 * fit into an int. */
559 area_reftable_index
= (start_offset
/ s
->cluster_size
) /
560 s
->refcount_block_size
;
563 table_size
= total_refblock_count
;
565 table_size
= total_refblock_count
+
566 DIV_ROUND_UP(total_refblock_count
, 2);
568 /* The qcow2 file can only store the reftable size in number of clusters */
569 table_size
= ROUND_UP(table_size
, s
->cluster_size
/ REFTABLE_ENTRY_SIZE
);
570 table_clusters
= (table_size
* REFTABLE_ENTRY_SIZE
) / s
->cluster_size
;
572 if (table_size
> QCOW_MAX_REFTABLE_SIZE
) {
576 new_table
= g_try_new0(uint64_t, table_size
);
578 assert(table_size
> 0);
579 if (new_table
== NULL
) {
584 /* Fill the new refcount table */
585 if (table_size
> s
->max_refcount_table_index
) {
586 /* We're actually growing the reftable */
587 memcpy(new_table
, s
->refcount_table
,
588 (s
->max_refcount_table_index
+ 1) * REFTABLE_ENTRY_SIZE
);
590 /* Improbable case: We're shrinking the reftable. However, the caller
591 * has assured us that there is only empty space beyond @start_offset,
592 * so we can simply drop all of the refblocks that won't fit into the
594 memcpy(new_table
, s
->refcount_table
, table_size
* REFTABLE_ENTRY_SIZE
);
597 if (new_refblock_offset
) {
598 assert(new_refblock_index
< total_refblock_count
);
599 new_table
[new_refblock_index
] = new_refblock_offset
;
602 /* Count how many new refblocks we have to create */
603 additional_refblock_count
= 0;
604 for (i
= area_reftable_index
; i
< total_refblock_count
; i
++) {
606 additional_refblock_count
++;
610 table_offset
= start_offset
+ additional_refblock_count
* s
->cluster_size
;
611 end_offset
= table_offset
+ table_clusters
* s
->cluster_size
;
613 /* Fill the refcount blocks, and create new ones, if necessary */
614 block_offset
= start_offset
;
615 for (i
= area_reftable_index
; i
< total_refblock_count
; i
++) {
617 uint64_t first_offset_covered
;
619 /* Reuse an existing refblock if possible, create a new one otherwise */
621 ret
= qcow2_cache_get(bs
, s
->refcount_block_cache
, new_table
[i
],
627 ret
= qcow2_cache_get_empty(bs
, s
->refcount_block_cache
,
628 block_offset
, &refblock_data
);
632 memset(refblock_data
, 0, s
->cluster_size
);
633 qcow2_cache_entry_mark_dirty(s
->refcount_block_cache
,
636 new_table
[i
] = block_offset
;
637 block_offset
+= s
->cluster_size
;
640 /* First host offset covered by this refblock */
641 first_offset_covered
= (uint64_t)i
* s
->refcount_block_size
*
643 if (first_offset_covered
< end_offset
) {
646 /* Set the refcount of all of the new refcount structures to 1 */
648 if (first_offset_covered
< start_offset
) {
649 assert(i
== area_reftable_index
);
650 j
= (start_offset
- first_offset_covered
) / s
->cluster_size
;
651 assert(j
< s
->refcount_block_size
);
656 end_index
= MIN((end_offset
- first_offset_covered
) /
658 s
->refcount_block_size
);
660 for (; j
< end_index
; j
++) {
661 /* The caller guaranteed us this space would be empty */
662 assert(s
->get_refcount(refblock_data
, j
) == 0);
663 s
->set_refcount(refblock_data
, j
, 1);
666 qcow2_cache_entry_mark_dirty(s
->refcount_block_cache
,
670 qcow2_cache_put(s
->refcount_block_cache
, &refblock_data
);
673 assert(block_offset
== table_offset
);
675 /* Write refcount blocks to disk */
676 BLKDBG_EVENT(bs
->file
, BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS
);
677 ret
= qcow2_cache_flush(bs
, s
->refcount_block_cache
);
682 /* Write refcount table to disk */
683 for (i
= 0; i
< total_refblock_count
; i
++) {
684 cpu_to_be64s(&new_table
[i
]);
687 BLKDBG_EVENT(bs
->file
, BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE
);
688 ret
= bdrv_pwrite_sync(bs
->file
, table_offset
,
689 table_size
* REFTABLE_ENTRY_SIZE
, new_table
, 0);
694 for (i
= 0; i
< total_refblock_count
; i
++) {
695 be64_to_cpus(&new_table
[i
]);
698 /* Hook up the new refcount table in the qcow2 header */
703 data
.d64
= cpu_to_be64(table_offset
);
704 data
.d32
= cpu_to_be32(table_clusters
);
705 BLKDBG_EVENT(bs
->file
, BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE
);
706 ret
= bdrv_pwrite_sync(bs
->file
,
707 offsetof(QCowHeader
, refcount_table_offset
),
708 sizeof(data
), &data
, 0);
713 /* And switch it in memory */
714 uint64_t old_table_offset
= s
->refcount_table_offset
;
715 uint64_t old_table_size
= s
->refcount_table_size
;
717 g_free(s
->refcount_table
);
718 s
->refcount_table
= new_table
;
719 s
->refcount_table_size
= table_size
;
720 s
->refcount_table_offset
= table_offset
;
721 update_max_refcount_table_index(s
);
723 /* Free old table. */
724 qcow2_free_clusters(bs
, old_table_offset
,
725 old_table_size
* REFTABLE_ENTRY_SIZE
,
726 QCOW2_DISCARD_OTHER
);
735 void qcow2_process_discards(BlockDriverState
*bs
, int ret
)
737 BDRVQcow2State
*s
= bs
->opaque
;
738 Qcow2DiscardRegion
*d
, *next
;
740 QTAILQ_FOREACH_SAFE(d
, &s
->discards
, next
, next
) {
741 QTAILQ_REMOVE(&s
->discards
, d
, next
);
743 /* Discard is optional, ignore the return value */
745 int r2
= bdrv_pdiscard(bs
->file
, d
->offset
, d
->bytes
);
747 trace_qcow2_process_discards_failed_region(d
->offset
, d
->bytes
,
756 static void update_refcount_discard(BlockDriverState
*bs
,
757 uint64_t offset
, uint64_t length
)
759 BDRVQcow2State
*s
= bs
->opaque
;
760 Qcow2DiscardRegion
*d
, *p
, *next
;
762 QTAILQ_FOREACH(d
, &s
->discards
, next
) {
763 uint64_t new_start
= MIN(offset
, d
->offset
);
764 uint64_t new_end
= MAX(offset
+ length
, d
->offset
+ d
->bytes
);
766 if (new_end
- new_start
<= length
+ d
->bytes
) {
767 /* There can't be any overlap, areas ending up here have no
768 * references any more and therefore shouldn't get freed another
770 assert(d
->bytes
+ length
== new_end
- new_start
);
771 d
->offset
= new_start
;
772 d
->bytes
= new_end
- new_start
;
777 d
= g_malloc(sizeof(*d
));
778 *d
= (Qcow2DiscardRegion
) {
783 QTAILQ_INSERT_TAIL(&s
->discards
, d
, next
);
786 /* Merge discard requests if they are adjacent now */
787 QTAILQ_FOREACH_SAFE(p
, &s
->discards
, next
, next
) {
789 || p
->offset
> d
->offset
+ d
->bytes
790 || d
->offset
> p
->offset
+ p
->bytes
)
795 /* Still no overlap possible */
796 assert(p
->offset
== d
->offset
+ d
->bytes
797 || d
->offset
== p
->offset
+ p
->bytes
);
799 QTAILQ_REMOVE(&s
->discards
, p
, next
);
800 d
->offset
= MIN(d
->offset
, p
->offset
);
801 d
->bytes
+= p
->bytes
;
806 /* XXX: cache several refcount block clusters ? */
807 /* @addend is the absolute value of the addend; if @decrease is set, @addend
808 * will be subtracted from the current refcount, otherwise it will be added */
809 static int update_refcount(BlockDriverState
*bs
,
814 enum qcow2_discard_type type
)
816 BDRVQcow2State
*s
= bs
->opaque
;
817 int64_t start
, last
, cluster_offset
;
818 void *refcount_block
= NULL
;
819 int64_t old_table_index
= -1;
823 fprintf(stderr
, "update_refcount: offset=%" PRId64
" size=%" PRId64
824 " addend=%s%" PRIu64
"\n", offset
, length
, decrease
? "-" : "",
829 } else if (length
== 0) {
834 qcow2_cache_set_dependency(bs
, s
->refcount_block_cache
,
838 start
= start_of_cluster(s
, offset
);
839 last
= start_of_cluster(s
, offset
+ length
- 1);
840 for(cluster_offset
= start
; cluster_offset
<= last
;
841 cluster_offset
+= s
->cluster_size
)
845 int64_t cluster_index
= cluster_offset
>> s
->cluster_bits
;
846 int64_t table_index
= cluster_index
>> s
->refcount_block_bits
;
848 /* Load the refcount block and allocate it if needed */
849 if (table_index
!= old_table_index
) {
850 if (refcount_block
) {
851 qcow2_cache_put(s
->refcount_block_cache
, &refcount_block
);
853 ret
= alloc_refcount_block(bs
, cluster_index
, &refcount_block
);
854 /* If the caller needs to restart the search for free clusters,
855 * try the same ones first to see if they're still free. */
856 if (ret
== -EAGAIN
) {
857 if (s
->free_cluster_index
> (start
>> s
->cluster_bits
)) {
858 s
->free_cluster_index
= (start
>> s
->cluster_bits
);
865 old_table_index
= table_index
;
867 qcow2_cache_entry_mark_dirty(s
->refcount_block_cache
, refcount_block
);
869 /* we can update the count and save it */
870 block_index
= cluster_index
& (s
->refcount_block_size
- 1);
872 refcount
= s
->get_refcount(refcount_block
, block_index
);
873 if (decrease
? (refcount
- addend
> refcount
)
874 : (refcount
+ addend
< refcount
||
875 refcount
+ addend
> s
->refcount_max
))
885 if (refcount
== 0 && cluster_index
< s
->free_cluster_index
) {
886 s
->free_cluster_index
= cluster_index
;
888 s
->set_refcount(refcount_block
, block_index
, refcount
);
893 table
= qcow2_cache_is_table_offset(s
->refcount_block_cache
,
896 qcow2_cache_put(s
->refcount_block_cache
, &refcount_block
);
897 old_table_index
= -1;
898 qcow2_cache_discard(s
->refcount_block_cache
, table
);
901 table
= qcow2_cache_is_table_offset(s
->l2_table_cache
, offset
);
903 qcow2_cache_discard(s
->l2_table_cache
, table
);
906 if (s
->discard_passthrough
[type
]) {
907 update_refcount_discard(bs
, cluster_offset
, s
->cluster_size
);
914 if (!s
->cache_discards
) {
915 qcow2_process_discards(bs
, ret
);
918 /* Write last changed block to disk */
919 if (refcount_block
) {
920 qcow2_cache_put(s
->refcount_block_cache
, &refcount_block
);
924 * Try do undo any updates if an error is returned (This may succeed in
925 * some cases like ENOSPC for allocating a new refcount block)
929 dummy
= update_refcount(bs
, offset
, cluster_offset
- offset
, addend
,
930 !decrease
, QCOW2_DISCARD_NEVER
);
938 * Increases or decreases the refcount of a given cluster.
940 * @addend is the absolute value of the addend; if @decrease is set, @addend
941 * will be subtracted from the current refcount, otherwise it will be added.
943 * On success 0 is returned; on failure -errno is returned.
945 int qcow2_update_cluster_refcount(BlockDriverState
*bs
,
946 int64_t cluster_index
,
947 uint64_t addend
, bool decrease
,
948 enum qcow2_discard_type type
)
950 BDRVQcow2State
*s
= bs
->opaque
;
953 ret
= update_refcount(bs
, cluster_index
<< s
->cluster_bits
, 1, addend
,
964 /*********************************************************/
965 /* cluster allocation functions */
969 /* return < 0 if error */
970 static int64_t alloc_clusters_noref(BlockDriverState
*bs
, uint64_t size
,
973 BDRVQcow2State
*s
= bs
->opaque
;
974 uint64_t i
, nb_clusters
, refcount
;
977 /* We can't allocate clusters if they may still be queued for discard. */
978 if (s
->cache_discards
) {
979 qcow2_process_discards(bs
, 0);
982 nb_clusters
= size_to_clusters(s
, size
);
984 for(i
= 0; i
< nb_clusters
; i
++) {
985 uint64_t next_cluster_index
= s
->free_cluster_index
++;
986 ret
= qcow2_get_refcount(bs
, next_cluster_index
, &refcount
);
990 } else if (refcount
!= 0) {
995 /* Make sure that all offsets in the "allocated" range are representable
996 * in the requested max */
997 if (s
->free_cluster_index
> 0 &&
998 s
->free_cluster_index
- 1 > (max
>> s
->cluster_bits
))
1004 fprintf(stderr
, "alloc_clusters: size=%" PRId64
" -> %" PRId64
"\n",
1006 (s
->free_cluster_index
- nb_clusters
) << s
->cluster_bits
);
1008 return (s
->free_cluster_index
- nb_clusters
) << s
->cluster_bits
;
1011 int64_t qcow2_alloc_clusters(BlockDriverState
*bs
, uint64_t size
)
1016 BLKDBG_EVENT(bs
->file
, BLKDBG_CLUSTER_ALLOC
);
1018 offset
= alloc_clusters_noref(bs
, size
, QCOW_MAX_CLUSTER_OFFSET
);
1023 ret
= update_refcount(bs
, offset
, size
, 1, false, QCOW2_DISCARD_NEVER
);
1024 } while (ret
== -EAGAIN
);
1033 int64_t coroutine_fn
qcow2_alloc_clusters_at(BlockDriverState
*bs
, uint64_t offset
,
1034 int64_t nb_clusters
)
1036 BDRVQcow2State
*s
= bs
->opaque
;
1037 uint64_t cluster_index
, refcount
;
1041 assert(nb_clusters
>= 0);
1042 if (nb_clusters
== 0) {
1047 /* Check how many clusters there are free */
1048 cluster_index
= offset
>> s
->cluster_bits
;
1049 for(i
= 0; i
< nb_clusters
; i
++) {
1050 ret
= qcow2_get_refcount(bs
, cluster_index
++, &refcount
);
1053 } else if (refcount
!= 0) {
1058 /* And then allocate them */
1059 ret
= update_refcount(bs
, offset
, i
<< s
->cluster_bits
, 1, false,
1060 QCOW2_DISCARD_NEVER
);
1061 } while (ret
== -EAGAIN
);
1070 /* only used to allocate compressed sectors. We try to allocate
1071 contiguous sectors. size must be <= cluster_size */
1072 int64_t coroutine_fn
qcow2_alloc_bytes(BlockDriverState
*bs
, int size
)
1074 BDRVQcow2State
*s
= bs
->opaque
;
1076 size_t free_in_cluster
;
1079 BLKDBG_EVENT(bs
->file
, BLKDBG_CLUSTER_ALLOC_BYTES
);
1080 assert(size
> 0 && size
<= s
->cluster_size
);
1081 assert(!s
->free_byte_offset
|| offset_into_cluster(s
, s
->free_byte_offset
));
1083 offset
= s
->free_byte_offset
;
1087 ret
= qcow2_get_refcount(bs
, offset
>> s
->cluster_bits
, &refcount
);
1092 if (refcount
== s
->refcount_max
) {
1097 free_in_cluster
= s
->cluster_size
- offset_into_cluster(s
, offset
);
1099 if (!offset
|| free_in_cluster
< size
) {
1100 int64_t new_cluster
;
1102 new_cluster
= alloc_clusters_noref(bs
, s
->cluster_size
,
1103 MIN(s
->cluster_offset_mask
,
1104 QCOW_MAX_CLUSTER_OFFSET
));
1105 if (new_cluster
< 0) {
1109 if (new_cluster
== 0) {
1110 qcow2_signal_corruption(bs
, true, -1, -1, "Preventing invalid "
1111 "allocation of compressed cluster "
1116 if (!offset
|| ROUND_UP(offset
, s
->cluster_size
) != new_cluster
) {
1117 offset
= new_cluster
;
1118 free_in_cluster
= s
->cluster_size
;
1120 free_in_cluster
+= s
->cluster_size
;
1125 ret
= update_refcount(bs
, offset
, size
, 1, false, QCOW2_DISCARD_NEVER
);
1129 } while (ret
== -EAGAIN
);
1134 /* The cluster refcount was incremented; refcount blocks must be flushed
1135 * before the caller's L2 table updates. */
1136 qcow2_cache_set_dependency(bs
, s
->l2_table_cache
, s
->refcount_block_cache
);
1138 s
->free_byte_offset
= offset
+ size
;
1139 if (!offset_into_cluster(s
, s
->free_byte_offset
)) {
1140 s
->free_byte_offset
= 0;
1146 void qcow2_free_clusters(BlockDriverState
*bs
,
1147 int64_t offset
, int64_t size
,
1148 enum qcow2_discard_type type
)
1152 BLKDBG_EVENT(bs
->file
, BLKDBG_CLUSTER_FREE
);
1153 ret
= update_refcount(bs
, offset
, size
, 1, true, type
);
1155 fprintf(stderr
, "qcow2_free_clusters failed: %s\n", strerror(-ret
));
1156 /* TODO Remember the clusters to free them later and avoid leaking */
1161 * Free a cluster using its L2 entry (handles clusters of all types, e.g.
1162 * normal cluster, compressed cluster, etc.)
1164 void qcow2_free_any_cluster(BlockDriverState
*bs
, uint64_t l2_entry
,
1165 enum qcow2_discard_type type
)
1167 BDRVQcow2State
*s
= bs
->opaque
;
1168 QCow2ClusterType ctype
= qcow2_get_cluster_type(bs
, l2_entry
);
1170 if (has_data_file(bs
)) {
1171 if (s
->discard_passthrough
[type
] &&
1172 (ctype
== QCOW2_CLUSTER_NORMAL
||
1173 ctype
== QCOW2_CLUSTER_ZERO_ALLOC
))
1175 bdrv_pdiscard(s
->data_file
, l2_entry
& L2E_OFFSET_MASK
,
1182 case QCOW2_CLUSTER_COMPRESSED
:
1187 qcow2_parse_compressed_l2_entry(bs
, l2_entry
, &coffset
, &csize
);
1188 qcow2_free_clusters(bs
, coffset
, csize
, type
);
1191 case QCOW2_CLUSTER_NORMAL
:
1192 case QCOW2_CLUSTER_ZERO_ALLOC
:
1193 if (offset_into_cluster(s
, l2_entry
& L2E_OFFSET_MASK
)) {
1194 qcow2_signal_corruption(bs
, false, -1, -1,
1195 "Cannot free unaligned cluster %#llx",
1196 l2_entry
& L2E_OFFSET_MASK
);
1198 qcow2_free_clusters(bs
, l2_entry
& L2E_OFFSET_MASK
,
1199 s
->cluster_size
, type
);
1202 case QCOW2_CLUSTER_ZERO_PLAIN
:
1203 case QCOW2_CLUSTER_UNALLOCATED
:
1210 int qcow2_write_caches(BlockDriverState
*bs
)
1212 BDRVQcow2State
*s
= bs
->opaque
;
1215 ret
= qcow2_cache_write(bs
, s
->l2_table_cache
);
1220 if (qcow2_need_accurate_refcounts(s
)) {
1221 ret
= qcow2_cache_write(bs
, s
->refcount_block_cache
);
1230 int qcow2_flush_caches(BlockDriverState
*bs
)
1232 int ret
= qcow2_write_caches(bs
);
1237 return bdrv_flush(bs
->file
->bs
);
1240 /*********************************************************/
1241 /* snapshots and image creation */
1245 /* update the refcounts of snapshots and the copied flag */
1246 int qcow2_update_snapshot_refcount(BlockDriverState
*bs
,
1247 int64_t l1_table_offset
, int l1_size
, int addend
)
1249 BDRVQcow2State
*s
= bs
->opaque
;
1250 uint64_t *l1_table
, *l2_slice
, l2_offset
, entry
, l1_size2
, refcount
;
1251 bool l1_allocated
= false;
1252 int64_t old_entry
, old_l2_offset
;
1253 unsigned slice
, slice_size2
, n_slices
;
1254 int i
, j
, l1_modified
= 0;
1257 assert(addend
>= -1 && addend
<= 1);
1261 l1_size2
= l1_size
* L1E_SIZE
;
1262 slice_size2
= s
->l2_slice_size
* l2_entry_size(s
);
1263 n_slices
= s
->cluster_size
/ slice_size2
;
1265 s
->cache_discards
= true;
1267 /* WARNING: qcow2_snapshot_goto relies on this function not using the
1268 * l1_table_offset when it is the current s->l1_table_offset! Be careful
1269 * when changing this! */
1270 if (l1_table_offset
!= s
->l1_table_offset
) {
1271 l1_table
= g_try_malloc0(l1_size2
);
1272 if (l1_size2
&& l1_table
== NULL
) {
1276 l1_allocated
= true;
1278 ret
= bdrv_pread(bs
->file
, l1_table_offset
, l1_size2
, l1_table
, 0);
1283 for (i
= 0; i
< l1_size
; i
++) {
1284 be64_to_cpus(&l1_table
[i
]);
1287 assert(l1_size
== s
->l1_size
);
1288 l1_table
= s
->l1_table
;
1289 l1_allocated
= false;
1292 for (i
= 0; i
< l1_size
; i
++) {
1293 l2_offset
= l1_table
[i
];
1295 old_l2_offset
= l2_offset
;
1296 l2_offset
&= L1E_OFFSET_MASK
;
1298 if (offset_into_cluster(s
, l2_offset
)) {
1299 qcow2_signal_corruption(bs
, true, -1, -1, "L2 table offset %#"
1300 PRIx64
" unaligned (L1 index: %#x)",
1306 for (slice
= 0; slice
< n_slices
; slice
++) {
1307 ret
= qcow2_cache_get(bs
, s
->l2_table_cache
,
1308 l2_offset
+ slice
* slice_size2
,
1309 (void **) &l2_slice
);
1314 for (j
= 0; j
< s
->l2_slice_size
; j
++) {
1315 uint64_t cluster_index
;
1318 entry
= get_l2_entry(s
, l2_slice
, j
);
1320 entry
&= ~QCOW_OFLAG_COPIED
;
1321 offset
= entry
& L2E_OFFSET_MASK
;
1323 switch (qcow2_get_cluster_type(bs
, entry
)) {
1324 case QCOW2_CLUSTER_COMPRESSED
:
1329 qcow2_parse_compressed_l2_entry(bs
, entry
,
1331 ret
= update_refcount(
1333 abs(addend
), addend
< 0,
1334 QCOW2_DISCARD_SNAPSHOT
);
1339 /* compressed clusters are never modified */
1343 case QCOW2_CLUSTER_NORMAL
:
1344 case QCOW2_CLUSTER_ZERO_ALLOC
:
1345 if (offset_into_cluster(s
, offset
)) {
1346 /* Here l2_index means table (not slice) index */
1347 int l2_index
= slice
* s
->l2_slice_size
+ j
;
1348 qcow2_signal_corruption(
1349 bs
, true, -1, -1, "Cluster "
1350 "allocation offset %#" PRIx64
1351 " unaligned (L2 offset: %#"
1352 PRIx64
", L2 index: %#x)",
1353 offset
, l2_offset
, l2_index
);
1358 cluster_index
= offset
>> s
->cluster_bits
;
1359 assert(cluster_index
);
1361 ret
= qcow2_update_cluster_refcount(
1362 bs
, cluster_index
, abs(addend
), addend
< 0,
1363 QCOW2_DISCARD_SNAPSHOT
);
1369 ret
= qcow2_get_refcount(bs
, cluster_index
, &refcount
);
1375 case QCOW2_CLUSTER_ZERO_PLAIN
:
1376 case QCOW2_CLUSTER_UNALLOCATED
:
1384 if (refcount
== 1) {
1385 entry
|= QCOW_OFLAG_COPIED
;
1387 if (entry
!= old_entry
) {
1389 qcow2_cache_set_dependency(bs
, s
->l2_table_cache
,
1390 s
->refcount_block_cache
);
1392 set_l2_entry(s
, l2_slice
, j
, entry
);
1393 qcow2_cache_entry_mark_dirty(s
->l2_table_cache
,
1398 qcow2_cache_put(s
->l2_table_cache
, (void **) &l2_slice
);
1402 ret
= qcow2_update_cluster_refcount(bs
, l2_offset
>>
1404 abs(addend
), addend
< 0,
1405 QCOW2_DISCARD_SNAPSHOT
);
1410 ret
= qcow2_get_refcount(bs
, l2_offset
>> s
->cluster_bits
,
1414 } else if (refcount
== 1) {
1415 l2_offset
|= QCOW_OFLAG_COPIED
;
1417 if (l2_offset
!= old_l2_offset
) {
1418 l1_table
[i
] = l2_offset
;
1424 ret
= bdrv_flush(bs
);
1427 qcow2_cache_put(s
->l2_table_cache
, (void **) &l2_slice
);
1430 s
->cache_discards
= false;
1431 qcow2_process_discards(bs
, ret
);
1433 /* Update L1 only if it isn't deleted anyway (addend = -1) */
1434 if (ret
== 0 && addend
>= 0 && l1_modified
) {
1435 for (i
= 0; i
< l1_size
; i
++) {
1436 cpu_to_be64s(&l1_table
[i
]);
1439 ret
= bdrv_pwrite_sync(bs
->file
, l1_table_offset
, l1_size2
, l1_table
,
1442 for (i
= 0; i
< l1_size
; i
++) {
1443 be64_to_cpus(&l1_table
[i
]);
1454 /*********************************************************/
1455 /* refcount checking functions */
1458 static uint64_t refcount_array_byte_size(BDRVQcow2State
*s
, uint64_t entries
)
1460 /* This assertion holds because there is no way we can address more than
1461 * 2^(64 - 9) clusters at once (with cluster size 512 = 2^9, and because
1462 * offsets have to be representable in bytes); due to every cluster
1463 * corresponding to one refcount entry, we are well below that limit */
1464 assert(entries
< (UINT64_C(1) << (64 - 9)));
1466 /* Thanks to the assertion this will not overflow, because
1467 * s->refcount_order < 7.
1468 * (note: x << s->refcount_order == x * s->refcount_bits) */
1469 return DIV_ROUND_UP(entries
<< s
->refcount_order
, 8);
1473 * Reallocates *array so that it can hold new_size entries. *size must contain
1474 * the current number of entries in *array. If the reallocation fails, *array
1475 * and *size will not be modified and -errno will be returned. If the
1476 * reallocation is successful, *array will be set to the new buffer, *size
1477 * will be set to new_size and 0 will be returned. The size of the reallocated
1478 * refcount array buffer will be aligned to a cluster boundary, and the newly
1479 * allocated area will be zeroed.
1481 static int realloc_refcount_array(BDRVQcow2State
*s
, void **array
,
1482 int64_t *size
, int64_t new_size
)
1484 int64_t old_byte_size
, new_byte_size
;
1487 /* Round to clusters so the array can be directly written to disk */
1488 old_byte_size
= size_to_clusters(s
, refcount_array_byte_size(s
, *size
))
1490 new_byte_size
= size_to_clusters(s
, refcount_array_byte_size(s
, new_size
))
1493 if (new_byte_size
== old_byte_size
) {
1498 assert(new_byte_size
> 0);
1500 if (new_byte_size
> SIZE_MAX
) {
1504 new_ptr
= g_try_realloc(*array
, new_byte_size
);
1509 if (new_byte_size
> old_byte_size
) {
1510 memset((char *)new_ptr
+ old_byte_size
, 0,
1511 new_byte_size
- old_byte_size
);
1521 * Increases the refcount for a range of clusters in a given refcount table.
1522 * This is used to construct a temporary refcount table out of L1 and L2 tables
1523 * which can be compared to the refcount table saved in the image.
1525 * Modifies the number of errors in res.
1527 int qcow2_inc_refcounts_imrt(BlockDriverState
*bs
, BdrvCheckResult
*res
,
1528 void **refcount_table
,
1529 int64_t *refcount_table_size
,
1530 int64_t offset
, int64_t size
)
1532 BDRVQcow2State
*s
= bs
->opaque
;
1533 uint64_t start
, last
, cluster_offset
, k
, refcount
;
1541 file_len
= bdrv_getlength(bs
->file
->bs
);
1547 * Last cluster of qcow2 image may be semi-allocated, so it may be OK to
1548 * reference some space after file end but it should be less than one
1551 if (offset
+ size
- file_len
>= s
->cluster_size
) {
1552 fprintf(stderr
, "ERROR: counting reference for region exceeding the "
1553 "end of the file by one cluster or more: offset 0x%" PRIx64
1554 " size 0x%" PRIx64
"\n", offset
, size
);
1559 start
= start_of_cluster(s
, offset
);
1560 last
= start_of_cluster(s
, offset
+ size
- 1);
1561 for(cluster_offset
= start
; cluster_offset
<= last
;
1562 cluster_offset
+= s
->cluster_size
) {
1563 k
= cluster_offset
>> s
->cluster_bits
;
1564 if (k
>= *refcount_table_size
) {
1565 ret
= realloc_refcount_array(s
, refcount_table
,
1566 refcount_table_size
, k
+ 1);
1568 res
->check_errors
++;
1573 refcount
= s
->get_refcount(*refcount_table
, k
);
1574 if (refcount
== s
->refcount_max
) {
1575 fprintf(stderr
, "ERROR: overflow cluster offset=0x%" PRIx64
1576 "\n", cluster_offset
);
1577 fprintf(stderr
, "Use qemu-img amend to increase the refcount entry "
1578 "width or qemu-img convert to create a clean copy if the "
1579 "image cannot be opened for writing\n");
1583 s
->set_refcount(*refcount_table
, k
, refcount
+ 1);
1589 /* Flags for check_refcounts_l1() and check_refcounts_l2() */
1591 CHECK_FRAG_INFO
= 0x2, /* update BlockFragInfo counters */
1595 * Fix L2 entry by making it QCOW2_CLUSTER_ZERO_PLAIN (or making all its present
1596 * subclusters QCOW2_SUBCLUSTER_ZERO_PLAIN).
1598 * This function decrements res->corruptions on success, so the caller is
1599 * responsible to increment res->corruptions prior to the call.
1601 * On failure in-memory @l2_table may be modified.
1603 static int fix_l2_entry_by_zero(BlockDriverState
*bs
, BdrvCheckResult
*res
,
1605 uint64_t *l2_table
, int l2_index
, bool active
,
1606 bool *metadata_overlap
)
1608 BDRVQcow2State
*s
= bs
->opaque
;
1610 int idx
= l2_index
* (l2_entry_size(s
) / sizeof(uint64_t));
1611 uint64_t l2e_offset
= l2_offset
+ (uint64_t)l2_index
* l2_entry_size(s
);
1612 int ign
= active
? QCOW2_OL_ACTIVE_L2
: QCOW2_OL_INACTIVE_L2
;
1614 if (has_subclusters(s
)) {
1615 uint64_t l2_bitmap
= get_l2_bitmap(s
, l2_table
, l2_index
);
1617 /* Allocated subclusters become zero */
1618 l2_bitmap
|= l2_bitmap
<< 32;
1619 l2_bitmap
&= QCOW_L2_BITMAP_ALL_ZEROES
;
1621 set_l2_bitmap(s
, l2_table
, l2_index
, l2_bitmap
);
1622 set_l2_entry(s
, l2_table
, l2_index
, 0);
1624 set_l2_entry(s
, l2_table
, l2_index
, QCOW_OFLAG_ZERO
);
1627 ret
= qcow2_pre_write_overlap_check(bs
, ign
, l2e_offset
, l2_entry_size(s
),
1629 if (metadata_overlap
) {
1630 *metadata_overlap
= ret
< 0;
1633 fprintf(stderr
, "ERROR: Overlap check failed\n");
1637 ret
= bdrv_pwrite_sync(bs
->file
, l2e_offset
, l2_entry_size(s
),
1640 fprintf(stderr
, "ERROR: Failed to overwrite L2 "
1641 "table entry: %s\n", strerror(-ret
));
1646 res
->corruptions_fixed
++;
1650 res
->check_errors
++;
1655 * Increases the refcount in the given refcount table for the all clusters
1656 * referenced in the L2 table. While doing so, performs some checks on L2
1659 * Returns the number of errors found by the checks or -errno if an internal
1662 static int check_refcounts_l2(BlockDriverState
*bs
, BdrvCheckResult
*res
,
1663 void **refcount_table
,
1664 int64_t *refcount_table_size
, int64_t l2_offset
,
1665 int flags
, BdrvCheckMode fix
, bool active
)
1667 BDRVQcow2State
*s
= bs
->opaque
;
1668 uint64_t l2_entry
, l2_bitmap
;
1669 uint64_t next_contiguous_offset
= 0;
1671 size_t l2_size_bytes
= s
->l2_size
* l2_entry_size(s
);
1672 g_autofree
uint64_t *l2_table
= g_malloc(l2_size_bytes
);
1673 bool metadata_overlap
;
1675 /* Read L2 table from disk */
1676 ret
= bdrv_pread(bs
->file
, l2_offset
, l2_size_bytes
, l2_table
, 0);
1678 fprintf(stderr
, "ERROR: I/O error in check_refcounts_l2\n");
1679 res
->check_errors
++;
1683 /* Do the actual checks */
1684 for (i
= 0; i
< s
->l2_size
; i
++) {
1687 QCow2ClusterType type
;
1689 l2_entry
= get_l2_entry(s
, l2_table
, i
);
1690 l2_bitmap
= get_l2_bitmap(s
, l2_table
, i
);
1691 type
= qcow2_get_cluster_type(bs
, l2_entry
);
1693 if (type
!= QCOW2_CLUSTER_COMPRESSED
) {
1694 /* Check reserved bits of Standard Cluster Descriptor */
1695 if (l2_entry
& L2E_STD_RESERVED_MASK
) {
1696 fprintf(stderr
, "ERROR found l2 entry with reserved bits set: "
1697 "%" PRIx64
"\n", l2_entry
);
1703 case QCOW2_CLUSTER_COMPRESSED
:
1704 /* Compressed clusters don't have QCOW_OFLAG_COPIED */
1705 if (l2_entry
& QCOW_OFLAG_COPIED
) {
1706 fprintf(stderr
, "ERROR: coffset=0x%" PRIx64
": "
1707 "copied flag must never be set for compressed "
1708 "clusters\n", l2_entry
& s
->cluster_offset_mask
);
1709 l2_entry
&= ~QCOW_OFLAG_COPIED
;
1713 if (has_data_file(bs
)) {
1714 fprintf(stderr
, "ERROR compressed cluster %d with data file, "
1715 "entry=0x%" PRIx64
"\n", i
, l2_entry
);
1721 fprintf(stderr
, "ERROR compressed cluster %d with non-zero "
1722 "subcluster allocation bitmap, entry=0x%" PRIx64
"\n",
1728 /* Mark cluster as used */
1729 qcow2_parse_compressed_l2_entry(bs
, l2_entry
, &coffset
, &csize
);
1730 ret
= qcow2_inc_refcounts_imrt(
1731 bs
, res
, refcount_table
, refcount_table_size
, coffset
, csize
);
1736 if (flags
& CHECK_FRAG_INFO
) {
1737 res
->bfi
.allocated_clusters
++;
1738 res
->bfi
.compressed_clusters
++;
1741 * Compressed clusters are fragmented by nature. Since they
1742 * take up sub-sector space but we only have sector granularity
1743 * I/O we need to re-read the same sectors even for adjacent
1744 * compressed clusters.
1746 res
->bfi
.fragmented_clusters
++;
1750 case QCOW2_CLUSTER_ZERO_ALLOC
:
1751 case QCOW2_CLUSTER_NORMAL
:
1753 uint64_t offset
= l2_entry
& L2E_OFFSET_MASK
;
1755 if ((l2_bitmap
>> 32) & l2_bitmap
) {
1757 fprintf(stderr
, "ERROR offset=%" PRIx64
": Allocated "
1758 "cluster has corrupted subcluster allocation bitmap\n",
1762 /* Correct offsets are cluster aligned */
1763 if (offset_into_cluster(s
, offset
)) {
1767 if (has_subclusters(s
)) {
1768 contains_data
= (l2_bitmap
& QCOW_L2_BITMAP_ALL_ALLOC
);
1770 contains_data
= !(l2_entry
& QCOW_OFLAG_ZERO
);
1773 if (!contains_data
) {
1774 fprintf(stderr
, "%s offset=%" PRIx64
": Preallocated "
1775 "cluster is not properly aligned; L2 entry "
1777 fix
& BDRV_FIX_ERRORS
? "Repairing" : "ERROR",
1779 if (fix
& BDRV_FIX_ERRORS
) {
1780 ret
= fix_l2_entry_by_zero(bs
, res
, l2_offset
,
1781 l2_table
, i
, active
,
1783 if (metadata_overlap
) {
1785 * Something is seriously wrong, so abort checking
1793 * Skip marking the cluster as used
1794 * (it is unused now).
1801 * Do not abort, continue checking the rest of this
1802 * L2 table's entries.
1806 fprintf(stderr
, "ERROR offset=%" PRIx64
": Data cluster is "
1807 "not properly aligned; L2 entry corrupted.\n", offset
);
1811 if (flags
& CHECK_FRAG_INFO
) {
1812 res
->bfi
.allocated_clusters
++;
1813 if (next_contiguous_offset
&&
1814 offset
!= next_contiguous_offset
) {
1815 res
->bfi
.fragmented_clusters
++;
1817 next_contiguous_offset
= offset
+ s
->cluster_size
;
1820 /* Mark cluster as used */
1821 if (!has_data_file(bs
)) {
1822 ret
= qcow2_inc_refcounts_imrt(bs
, res
, refcount_table
,
1823 refcount_table_size
,
1824 offset
, s
->cluster_size
);
1832 case QCOW2_CLUSTER_ZERO_PLAIN
:
1833 /* Impossible when image has subclusters */
1837 case QCOW2_CLUSTER_UNALLOCATED
:
1838 if (l2_bitmap
& QCOW_L2_BITMAP_ALL_ALLOC
) {
1840 fprintf(stderr
, "ERROR: Unallocated "
1841 "cluster has non-zero subcluster allocation map\n");
1854 * Increases the refcount for the L1 table, its L2 tables and all referenced
1855 * clusters in the given refcount table. While doing so, performs some checks
1856 * on L1 and L2 entries.
1858 * Returns the number of errors found by the checks or -errno if an internal
1861 static int check_refcounts_l1(BlockDriverState
*bs
,
1862 BdrvCheckResult
*res
,
1863 void **refcount_table
,
1864 int64_t *refcount_table_size
,
1865 int64_t l1_table_offset
, int l1_size
,
1866 int flags
, BdrvCheckMode fix
, bool active
)
1868 BDRVQcow2State
*s
= bs
->opaque
;
1869 size_t l1_size_bytes
= l1_size
* L1E_SIZE
;
1870 g_autofree
uint64_t *l1_table
= NULL
;
1878 /* Mark L1 table as used */
1879 ret
= qcow2_inc_refcounts_imrt(bs
, res
, refcount_table
, refcount_table_size
,
1880 l1_table_offset
, l1_size_bytes
);
1885 l1_table
= g_try_malloc(l1_size_bytes
);
1886 if (l1_table
== NULL
) {
1887 res
->check_errors
++;
1891 /* Read L1 table entries from disk */
1892 ret
= bdrv_pread(bs
->file
, l1_table_offset
, l1_size_bytes
, l1_table
, 0);
1894 fprintf(stderr
, "ERROR: I/O error in check_refcounts_l1\n");
1895 res
->check_errors
++;
1899 for (i
= 0; i
< l1_size
; i
++) {
1900 be64_to_cpus(&l1_table
[i
]);
1903 /* Do the actual checks */
1904 for (i
= 0; i
< l1_size
; i
++) {
1909 if (l1_table
[i
] & L1E_RESERVED_MASK
) {
1910 fprintf(stderr
, "ERROR found L1 entry with reserved bits set: "
1911 "%" PRIx64
"\n", l1_table
[i
]);
1915 l2_offset
= l1_table
[i
] & L1E_OFFSET_MASK
;
1917 /* Mark L2 table as used */
1918 ret
= qcow2_inc_refcounts_imrt(bs
, res
,
1919 refcount_table
, refcount_table_size
,
1920 l2_offset
, s
->cluster_size
);
1925 /* L2 tables are cluster aligned */
1926 if (offset_into_cluster(s
, l2_offset
)) {
1927 fprintf(stderr
, "ERROR l2_offset=%" PRIx64
": Table is not "
1928 "cluster aligned; L1 entry corrupted\n", l2_offset
);
1932 /* Process and check L2 entries */
1933 ret
= check_refcounts_l2(bs
, res
, refcount_table
,
1934 refcount_table_size
, l2_offset
, flags
,
1945 * Checks the OFLAG_COPIED flag for all L1 and L2 entries.
1947 * This function does not print an error message nor does it increment
1948 * check_errors if qcow2_get_refcount fails (this is because such an error will
1949 * have been already detected and sufficiently signaled by the calling function
1950 * (qcow2_check_refcounts) by the time this function is called).
1952 static int check_oflag_copied(BlockDriverState
*bs
, BdrvCheckResult
*res
,
1955 BDRVQcow2State
*s
= bs
->opaque
;
1956 uint64_t *l2_table
= qemu_blockalign(bs
, s
->cluster_size
);
1962 if (fix
& BDRV_FIX_ERRORS
) {
1965 } else if (fix
& BDRV_FIX_LEAKS
) {
1966 /* Repair only if that seems safe: This function is always
1967 * called after the refcounts have been fixed, so the refcount
1968 * is accurate if that repair was successful */
1969 repair
= !res
->check_errors
&& !res
->corruptions
&& !res
->leaks
;
1974 for (i
= 0; i
< s
->l1_size
; i
++) {
1975 uint64_t l1_entry
= s
->l1_table
[i
];
1976 uint64_t l2_offset
= l1_entry
& L1E_OFFSET_MASK
;
1983 ret
= qcow2_get_refcount(bs
, l2_offset
>> s
->cluster_bits
,
1986 /* don't print message nor increment check_errors */
1989 if ((refcount
== 1) != ((l1_entry
& QCOW_OFLAG_COPIED
) != 0)) {
1991 fprintf(stderr
, "%s OFLAG_COPIED L2 cluster: l1_index=%d "
1992 "l1_entry=%" PRIx64
" refcount=%" PRIu64
"\n",
1993 repair
? "Repairing" : "ERROR", i
, l1_entry
, refcount
);
1995 s
->l1_table
[i
] = refcount
== 1
1996 ? l1_entry
| QCOW_OFLAG_COPIED
1997 : l1_entry
& ~QCOW_OFLAG_COPIED
;
1998 ret
= qcow2_write_l1_entry(bs
, i
);
2000 res
->check_errors
++;
2004 res
->corruptions_fixed
++;
2008 ret
= bdrv_pread(bs
->file
, l2_offset
, s
->l2_size
* l2_entry_size(s
),
2011 fprintf(stderr
, "ERROR: Could not read L2 table: %s\n",
2013 res
->check_errors
++;
2017 for (j
= 0; j
< s
->l2_size
; j
++) {
2018 uint64_t l2_entry
= get_l2_entry(s
, l2_table
, j
);
2019 uint64_t data_offset
= l2_entry
& L2E_OFFSET_MASK
;
2020 QCow2ClusterType cluster_type
= qcow2_get_cluster_type(bs
, l2_entry
);
2022 if (cluster_type
== QCOW2_CLUSTER_NORMAL
||
2023 cluster_type
== QCOW2_CLUSTER_ZERO_ALLOC
) {
2024 if (has_data_file(bs
)) {
2027 ret
= qcow2_get_refcount(bs
,
2028 data_offset
>> s
->cluster_bits
,
2031 /* don't print message nor increment check_errors */
2035 if ((refcount
== 1) != ((l2_entry
& QCOW_OFLAG_COPIED
) != 0)) {
2037 fprintf(stderr
, "%s OFLAG_COPIED data cluster: "
2038 "l2_entry=%" PRIx64
" refcount=%" PRIu64
"\n",
2039 repair
? "Repairing" : "ERROR", l2_entry
, refcount
);
2041 set_l2_entry(s
, l2_table
, j
,
2043 l2_entry
| QCOW_OFLAG_COPIED
:
2044 l2_entry
& ~QCOW_OFLAG_COPIED
);
2052 ret
= qcow2_pre_write_overlap_check(bs
, QCOW2_OL_ACTIVE_L2
,
2053 l2_offset
, s
->cluster_size
,
2056 fprintf(stderr
, "ERROR: Could not write L2 table; metadata "
2057 "overlap check failed: %s\n", strerror(-ret
));
2058 res
->check_errors
++;
2062 ret
= bdrv_pwrite(bs
->file
, l2_offset
, s
->cluster_size
, l2_table
,
2065 fprintf(stderr
, "ERROR: Could not write L2 table: %s\n",
2067 res
->check_errors
++;
2070 res
->corruptions
-= l2_dirty
;
2071 res
->corruptions_fixed
+= l2_dirty
;
2078 qemu_vfree(l2_table
);
2083 * Checks consistency of refblocks and accounts for each refblock in
2086 static int check_refblocks(BlockDriverState
*bs
, BdrvCheckResult
*res
,
2087 BdrvCheckMode fix
, bool *rebuild
,
2088 void **refcount_table
, int64_t *nb_clusters
)
2090 BDRVQcow2State
*s
= bs
->opaque
;
2094 for(i
= 0; i
< s
->refcount_table_size
; i
++) {
2095 uint64_t offset
, cluster
;
2096 offset
= s
->refcount_table
[i
] & REFT_OFFSET_MASK
;
2097 cluster
= offset
>> s
->cluster_bits
;
2099 if (s
->refcount_table
[i
] & REFT_RESERVED_MASK
) {
2100 fprintf(stderr
, "ERROR refcount table entry %" PRId64
" has "
2101 "reserved bits set\n", i
);
2107 /* Refcount blocks are cluster aligned */
2108 if (offset_into_cluster(s
, offset
)) {
2109 fprintf(stderr
, "ERROR refcount block %" PRId64
" is not "
2110 "cluster aligned; refcount table entry corrupted\n", i
);
2116 if (cluster
>= *nb_clusters
) {
2118 fprintf(stderr
, "%s refcount block %" PRId64
" is outside image\n",
2119 fix
& BDRV_FIX_ERRORS
? "Repairing" : "ERROR", i
);
2121 if (fix
& BDRV_FIX_ERRORS
) {
2122 int64_t new_nb_clusters
;
2123 Error
*local_err
= NULL
;
2125 if (offset
> INT64_MAX
- s
->cluster_size
) {
2130 ret
= bdrv_truncate(bs
->file
, offset
+ s
->cluster_size
, false,
2131 PREALLOC_MODE_OFF
, 0, &local_err
);
2133 error_report_err(local_err
);
2136 size
= bdrv_getlength(bs
->file
->bs
);
2142 new_nb_clusters
= size_to_clusters(s
, size
);
2143 assert(new_nb_clusters
>= *nb_clusters
);
2145 ret
= realloc_refcount_array(s
, refcount_table
,
2146 nb_clusters
, new_nb_clusters
);
2148 res
->check_errors
++;
2152 if (cluster
>= *nb_clusters
) {
2158 res
->corruptions_fixed
++;
2159 ret
= qcow2_inc_refcounts_imrt(bs
, res
,
2160 refcount_table
, nb_clusters
,
2161 offset
, s
->cluster_size
);
2165 /* No need to check whether the refcount is now greater than 1:
2166 * This area was just allocated and zeroed, so it can only be
2167 * exactly 1 after qcow2_inc_refcounts_imrt() */
2172 fprintf(stderr
, "ERROR could not resize image: %s\n",
2179 ret
= qcow2_inc_refcounts_imrt(bs
, res
, refcount_table
, nb_clusters
,
2180 offset
, s
->cluster_size
);
2184 if (s
->get_refcount(*refcount_table
, cluster
) != 1) {
2185 fprintf(stderr
, "ERROR refcount block %" PRId64
2186 " refcount=%" PRIu64
"\n", i
,
2187 s
->get_refcount(*refcount_table
, cluster
));
2198 * Calculates an in-memory refcount table.
2200 static int calculate_refcounts(BlockDriverState
*bs
, BdrvCheckResult
*res
,
2201 BdrvCheckMode fix
, bool *rebuild
,
2202 void **refcount_table
, int64_t *nb_clusters
)
2204 BDRVQcow2State
*s
= bs
->opaque
;
2209 if (!*refcount_table
) {
2210 int64_t old_size
= 0;
2211 ret
= realloc_refcount_array(s
, refcount_table
,
2212 &old_size
, *nb_clusters
);
2214 res
->check_errors
++;
2220 ret
= qcow2_inc_refcounts_imrt(bs
, res
, refcount_table
, nb_clusters
,
2221 0, s
->cluster_size
);
2226 /* current L1 table */
2227 ret
= check_refcounts_l1(bs
, res
, refcount_table
, nb_clusters
,
2228 s
->l1_table_offset
, s
->l1_size
, CHECK_FRAG_INFO
,
2235 if (has_data_file(bs
) && s
->nb_snapshots
) {
2236 fprintf(stderr
, "ERROR %d snapshots in image with data file\n",
2241 for (i
= 0; i
< s
->nb_snapshots
; i
++) {
2242 sn
= s
->snapshots
+ i
;
2243 if (offset_into_cluster(s
, sn
->l1_table_offset
)) {
2244 fprintf(stderr
, "ERROR snapshot %s (%s) l1_offset=%#" PRIx64
": "
2245 "L1 table is not cluster aligned; snapshot table entry "
2246 "corrupted\n", sn
->id_str
, sn
->name
, sn
->l1_table_offset
);
2250 if (sn
->l1_size
> QCOW_MAX_L1_SIZE
/ L1E_SIZE
) {
2251 fprintf(stderr
, "ERROR snapshot %s (%s) l1_size=%#" PRIx32
": "
2252 "L1 table is too large; snapshot table entry corrupted\n",
2253 sn
->id_str
, sn
->name
, sn
->l1_size
);
2257 ret
= check_refcounts_l1(bs
, res
, refcount_table
, nb_clusters
,
2258 sn
->l1_table_offset
, sn
->l1_size
, 0, fix
,
2264 ret
= qcow2_inc_refcounts_imrt(bs
, res
, refcount_table
, nb_clusters
,
2265 s
->snapshots_offset
, s
->snapshots_size
);
2271 ret
= qcow2_inc_refcounts_imrt(bs
, res
, refcount_table
, nb_clusters
,
2272 s
->refcount_table_offset
,
2273 s
->refcount_table_size
*
2274 REFTABLE_ENTRY_SIZE
);
2280 if (s
->crypto_header
.length
) {
2281 ret
= qcow2_inc_refcounts_imrt(bs
, res
, refcount_table
, nb_clusters
,
2282 s
->crypto_header
.offset
,
2283 s
->crypto_header
.length
);
2290 ret
= qcow2_check_bitmaps_refcounts(bs
, res
, refcount_table
, nb_clusters
);
2295 return check_refblocks(bs
, res
, fix
, rebuild
, refcount_table
, nb_clusters
);
2299 * Compares the actual reference count for each cluster in the image against the
2300 * refcount as reported by the refcount structures on-disk.
2302 static void compare_refcounts(BlockDriverState
*bs
, BdrvCheckResult
*res
,
2303 BdrvCheckMode fix
, bool *rebuild
,
2304 int64_t *highest_cluster
,
2305 void *refcount_table
, int64_t nb_clusters
)
2307 BDRVQcow2State
*s
= bs
->opaque
;
2309 uint64_t refcount1
, refcount2
;
2312 for (i
= 0, *highest_cluster
= 0; i
< nb_clusters
; i
++) {
2313 ret
= qcow2_get_refcount(bs
, i
, &refcount1
);
2315 fprintf(stderr
, "Can't get refcount for cluster %" PRId64
": %s\n",
2317 res
->check_errors
++;
2321 refcount2
= s
->get_refcount(refcount_table
, i
);
2323 if (refcount1
> 0 || refcount2
> 0) {
2324 *highest_cluster
= i
;
2327 if (refcount1
!= refcount2
) {
2328 /* Check if we're allowed to fix the mismatch */
2329 int *num_fixed
= NULL
;
2330 if (refcount1
== 0) {
2332 } else if (refcount1
> refcount2
&& (fix
& BDRV_FIX_LEAKS
)) {
2333 num_fixed
= &res
->leaks_fixed
;
2334 } else if (refcount1
< refcount2
&& (fix
& BDRV_FIX_ERRORS
)) {
2335 num_fixed
= &res
->corruptions_fixed
;
2338 fprintf(stderr
, "%s cluster %" PRId64
" refcount=%" PRIu64
2339 " reference=%" PRIu64
"\n",
2340 num_fixed
!= NULL
? "Repairing" :
2341 refcount1
< refcount2
? "ERROR" :
2343 i
, refcount1
, refcount2
);
2346 ret
= update_refcount(bs
, i
<< s
->cluster_bits
, 1,
2347 refcount_diff(refcount1
, refcount2
),
2348 refcount1
> refcount2
,
2349 QCOW2_DISCARD_ALWAYS
);
2356 /* And if we couldn't, print an error */
2357 if (refcount1
< refcount2
) {
2367 * Allocates clusters using an in-memory refcount table (IMRT) in contrast to
2368 * the on-disk refcount structures.
2370 * On input, *first_free_cluster tells where to start looking, and need not
2371 * actually be a free cluster; the returned offset will not be before that
2372 * cluster. On output, *first_free_cluster points to the first gap found, even
2373 * if that gap was too small to be used as the returned offset.
2375 * Note that *first_free_cluster is a cluster index whereas the return value is
2378 static int64_t alloc_clusters_imrt(BlockDriverState
*bs
,
2380 void **refcount_table
,
2381 int64_t *imrt_nb_clusters
,
2382 int64_t *first_free_cluster
)
2384 BDRVQcow2State
*s
= bs
->opaque
;
2385 int64_t cluster
= *first_free_cluster
, i
;
2386 bool first_gap
= true;
2387 int contiguous_free_clusters
;
2390 /* Starting at *first_free_cluster, find a range of at least cluster_count
2391 * continuously free clusters */
2392 for (contiguous_free_clusters
= 0;
2393 cluster
< *imrt_nb_clusters
&&
2394 contiguous_free_clusters
< cluster_count
;
2397 if (!s
->get_refcount(*refcount_table
, cluster
)) {
2398 contiguous_free_clusters
++;
2400 /* If this is the first free cluster found, update
2401 * *first_free_cluster accordingly */
2402 *first_free_cluster
= cluster
;
2405 } else if (contiguous_free_clusters
) {
2406 contiguous_free_clusters
= 0;
2410 /* If contiguous_free_clusters is greater than zero, it contains the number
2411 * of continuously free clusters until the current cluster; the first free
2412 * cluster in the current "gap" is therefore
2413 * cluster - contiguous_free_clusters */
2415 /* If no such range could be found, grow the in-memory refcount table
2416 * accordingly to append free clusters at the end of the image */
2417 if (contiguous_free_clusters
< cluster_count
) {
2418 /* contiguous_free_clusters clusters are already empty at the image end;
2419 * we need cluster_count clusters; therefore, we have to allocate
2420 * cluster_count - contiguous_free_clusters new clusters at the end of
2421 * the image (which is the current value of cluster; note that cluster
2422 * may exceed old_imrt_nb_clusters if *first_free_cluster pointed beyond
2424 ret
= realloc_refcount_array(s
, refcount_table
, imrt_nb_clusters
,
2425 cluster
+ cluster_count
2426 - contiguous_free_clusters
);
2432 /* Go back to the first free cluster */
2433 cluster
-= contiguous_free_clusters
;
2434 for (i
= 0; i
< cluster_count
; i
++) {
2435 s
->set_refcount(*refcount_table
, cluster
+ i
, 1);
2438 return cluster
<< s
->cluster_bits
;
2442 * Helper function for rebuild_refcount_structure().
2444 * Scan the range of clusters [first_cluster, end_cluster) for allocated
2445 * clusters and write all corresponding refblocks to disk. The refblock
2446 * and allocation data is taken from the in-memory refcount table
2447 * *refcount_table[] (of size *nb_clusters), which is basically one big
2448 * (unlimited size) refblock for the whole image.
2450 * For these refblocks, clusters are allocated using said in-memory
2451 * refcount table. Care is taken that these allocations are reflected
2452 * in the refblocks written to disk.
2454 * The refblocks' offsets are written into a reftable, which is
2455 * *on_disk_reftable_ptr[] (of size *on_disk_reftable_entries_ptr). If
2456 * that reftable is of insufficient size, it will be resized to fit.
2457 * This reftable is not written to disk.
2459 * (If *on_disk_reftable_ptr is not NULL, the entries within are assumed
2460 * to point to existing valid refblocks that do not need to be allocated
2463 * Return whether the on-disk reftable array was resized (true/false),
2464 * or -errno on error.
2466 static int rebuild_refcounts_write_refblocks(
2467 BlockDriverState
*bs
, void **refcount_table
, int64_t *nb_clusters
,
2468 int64_t first_cluster
, int64_t end_cluster
,
2469 uint64_t **on_disk_reftable_ptr
, uint32_t *on_disk_reftable_entries_ptr
,
2473 BDRVQcow2State
*s
= bs
->opaque
;
2475 int64_t refblock_offset
, refblock_start
, refblock_index
;
2476 int64_t first_free_cluster
= 0;
2477 uint64_t *on_disk_reftable
= *on_disk_reftable_ptr
;
2478 uint32_t on_disk_reftable_entries
= *on_disk_reftable_entries_ptr
;
2479 void *on_disk_refblock
;
2480 bool reftable_grown
= false;
2483 for (cluster
= first_cluster
; cluster
< end_cluster
; cluster
++) {
2484 /* Check all clusters to find refblocks that contain non-zero entries */
2485 if (!s
->get_refcount(*refcount_table
, cluster
)) {
2490 * This cluster is allocated, so we need to create a refblock
2491 * for it. The data we will write to disk is just the
2492 * respective slice from *refcount_table, so it will contain
2493 * accurate refcounts for all clusters belonging to this
2494 * refblock. After we have written it, we will therefore skip
2495 * all remaining clusters in this refblock.
2498 refblock_index
= cluster
>> s
->refcount_block_bits
;
2499 refblock_start
= refblock_index
<< s
->refcount_block_bits
;
2501 if (on_disk_reftable_entries
> refblock_index
&&
2502 on_disk_reftable
[refblock_index
])
2505 * We can get here after a `goto write_refblocks`: We have a
2506 * reftable from a previous run, and the refblock is already
2507 * allocated. No need to allocate it again.
2509 refblock_offset
= on_disk_reftable
[refblock_index
];
2511 int64_t refblock_cluster_index
;
2513 /* Don't allocate a cluster in a refblock already written to disk */
2514 if (first_free_cluster
< refblock_start
) {
2515 first_free_cluster
= refblock_start
;
2517 refblock_offset
= alloc_clusters_imrt(bs
, 1, refcount_table
,
2519 &first_free_cluster
);
2520 if (refblock_offset
< 0) {
2521 error_setg_errno(errp
, -refblock_offset
,
2522 "ERROR allocating refblock");
2523 return refblock_offset
;
2526 refblock_cluster_index
= refblock_offset
/ s
->cluster_size
;
2527 if (refblock_cluster_index
>= end_cluster
) {
2529 * We must write the refblock that holds this refblock's
2532 end_cluster
= refblock_cluster_index
+ 1;
2535 if (on_disk_reftable_entries
<= refblock_index
) {
2536 on_disk_reftable_entries
=
2537 ROUND_UP((refblock_index
+ 1) * REFTABLE_ENTRY_SIZE
,
2538 s
->cluster_size
) / REFTABLE_ENTRY_SIZE
;
2540 g_try_realloc(on_disk_reftable
,
2541 on_disk_reftable_entries
*
2542 REFTABLE_ENTRY_SIZE
);
2543 if (!on_disk_reftable
) {
2544 error_setg(errp
, "ERROR allocating reftable memory");
2548 memset(on_disk_reftable
+ *on_disk_reftable_entries_ptr
, 0,
2549 (on_disk_reftable_entries
-
2550 *on_disk_reftable_entries_ptr
) *
2551 REFTABLE_ENTRY_SIZE
);
2553 *on_disk_reftable_ptr
= on_disk_reftable
;
2554 *on_disk_reftable_entries_ptr
= on_disk_reftable_entries
;
2556 reftable_grown
= true;
2558 assert(on_disk_reftable
);
2560 on_disk_reftable
[refblock_index
] = refblock_offset
;
2563 /* Refblock is allocated, write it to disk */
2565 ret
= qcow2_pre_write_overlap_check(bs
, 0, refblock_offset
,
2566 s
->cluster_size
, false);
2568 error_setg_errno(errp
, -ret
, "ERROR writing refblock");
2573 * The refblock is simply a slice of *refcount_table.
2574 * Note that the size of *refcount_table is always aligned to
2575 * whole clusters, so the write operation will not result in
2576 * out-of-bounds accesses.
2578 on_disk_refblock
= (void *)((char *) *refcount_table
+
2579 refblock_index
* s
->cluster_size
);
2581 ret
= bdrv_pwrite(bs
->file
, refblock_offset
, s
->cluster_size
,
2582 on_disk_refblock
, 0);
2584 error_setg_errno(errp
, -ret
, "ERROR writing refblock");
2588 /* This refblock is done, skip to its end */
2589 cluster
= refblock_start
+ s
->refcount_block_size
- 1;
2592 return reftable_grown
;
2596 * Creates a new refcount structure based solely on the in-memory information
2597 * given through *refcount_table (this in-memory information is basically just
2598 * the concatenation of all refblocks). All necessary allocations will be
2599 * reflected in that array.
2601 * On success, the old refcount structure is leaked (it will be covered by the
2602 * new refcount structure).
2604 static int rebuild_refcount_structure(BlockDriverState
*bs
,
2605 BdrvCheckResult
*res
,
2606 void **refcount_table
,
2607 int64_t *nb_clusters
,
2610 BDRVQcow2State
*s
= bs
->opaque
;
2611 int64_t reftable_offset
= -1;
2612 int64_t reftable_length
= 0;
2613 int64_t reftable_clusters
;
2614 int64_t refblock_index
;
2615 uint32_t on_disk_reftable_entries
= 0;
2616 uint64_t *on_disk_reftable
= NULL
;
2618 int reftable_size_changed
= 0;
2620 uint64_t reftable_offset
;
2621 uint32_t reftable_clusters
;
2622 } QEMU_PACKED reftable_offset_and_clusters
;
2624 qcow2_cache_empty(bs
, s
->refcount_block_cache
);
2627 * For each refblock containing entries, we try to allocate a
2628 * cluster (in the in-memory refcount table) and write its offset
2629 * into on_disk_reftable[]. We then write the whole refblock to
2630 * disk (as a slice of the in-memory refcount table).
2631 * This is done by rebuild_refcounts_write_refblocks().
2633 * Once we have scanned all clusters, we try to find space for the
2634 * reftable. This will dirty the in-memory refcount table (i.e.
2635 * make it differ from the refblocks we have already written), so we
2636 * need to run rebuild_refcounts_write_refblocks() again for the
2637 * range of clusters where the reftable has been allocated.
2639 * This second run might make the reftable grow again, in which case
2640 * we will need to allocate another space for it, which is why we
2641 * repeat all this until the reftable stops growing.
2643 * (This loop will terminate, because with every cluster the
2644 * reftable grows, it can accomodate a multitude of more refcounts,
2645 * so that at some point this must be able to cover the reftable
2646 * and all refblocks describing it.)
2648 * We then convert the reftable to big-endian and write it to disk.
2650 * Note that we never free any reftable allocations. Doing so would
2651 * needlessly complicate the algorithm: The eventual second check
2652 * run we do will clean up all leaks we have caused.
2655 reftable_size_changed
=
2656 rebuild_refcounts_write_refblocks(bs
, refcount_table
, nb_clusters
,
2659 &on_disk_reftable_entries
, errp
);
2660 if (reftable_size_changed
< 0) {
2661 res
->check_errors
++;
2662 ret
= reftable_size_changed
;
2667 * There was no reftable before, so rebuild_refcounts_write_refblocks()
2668 * must have increased its size (from 0 to something).
2670 assert(reftable_size_changed
);
2673 int64_t reftable_start_cluster
, reftable_end_cluster
;
2674 int64_t first_free_cluster
= 0;
2676 reftable_length
= on_disk_reftable_entries
* REFTABLE_ENTRY_SIZE
;
2677 reftable_clusters
= size_to_clusters(s
, reftable_length
);
2679 reftable_offset
= alloc_clusters_imrt(bs
, reftable_clusters
,
2680 refcount_table
, nb_clusters
,
2681 &first_free_cluster
);
2682 if (reftable_offset
< 0) {
2683 error_setg_errno(errp
, -reftable_offset
,
2684 "ERROR allocating reftable");
2685 res
->check_errors
++;
2686 ret
= reftable_offset
;
2691 * We need to update the affected refblocks, so re-run the
2692 * write_refblocks loop for the reftable's range of clusters.
2694 assert(offset_into_cluster(s
, reftable_offset
) == 0);
2695 reftable_start_cluster
= reftable_offset
/ s
->cluster_size
;
2696 reftable_end_cluster
= reftable_start_cluster
+ reftable_clusters
;
2697 reftable_size_changed
=
2698 rebuild_refcounts_write_refblocks(bs
, refcount_table
, nb_clusters
,
2699 reftable_start_cluster
,
2700 reftable_end_cluster
,
2702 &on_disk_reftable_entries
, errp
);
2703 if (reftable_size_changed
< 0) {
2704 res
->check_errors
++;
2705 ret
= reftable_size_changed
;
2710 * If the reftable size has changed, we will need to find a new
2711 * allocation, repeating the loop.
2713 } while (reftable_size_changed
);
2715 /* The above loop must have run at least once */
2716 assert(reftable_offset
>= 0);
2719 * All allocations are done, all refblocks are written, convert the
2720 * reftable to big-endian and write it to disk.
2723 for (refblock_index
= 0; refblock_index
< on_disk_reftable_entries
;
2726 cpu_to_be64s(&on_disk_reftable
[refblock_index
]);
2729 ret
= qcow2_pre_write_overlap_check(bs
, 0, reftable_offset
, reftable_length
,
2732 error_setg_errno(errp
, -ret
, "ERROR writing reftable");
2736 assert(reftable_length
< INT_MAX
);
2737 ret
= bdrv_pwrite(bs
->file
, reftable_offset
, reftable_length
,
2738 on_disk_reftable
, 0);
2740 error_setg_errno(errp
, -ret
, "ERROR writing reftable");
2744 /* Enter new reftable into the image header */
2745 reftable_offset_and_clusters
.reftable_offset
= cpu_to_be64(reftable_offset
);
2746 reftable_offset_and_clusters
.reftable_clusters
=
2747 cpu_to_be32(reftable_clusters
);
2748 ret
= bdrv_pwrite_sync(bs
->file
,
2749 offsetof(QCowHeader
, refcount_table_offset
),
2750 sizeof(reftable_offset_and_clusters
),
2751 &reftable_offset_and_clusters
, 0);
2753 error_setg_errno(errp
, -ret
, "ERROR setting reftable");
2757 for (refblock_index
= 0; refblock_index
< on_disk_reftable_entries
;
2760 be64_to_cpus(&on_disk_reftable
[refblock_index
]);
2762 s
->refcount_table
= on_disk_reftable
;
2763 s
->refcount_table_offset
= reftable_offset
;
2764 s
->refcount_table_size
= on_disk_reftable_entries
;
2765 update_max_refcount_table_index(s
);
2770 g_free(on_disk_reftable
);
2775 * Checks an image for refcount consistency.
2777 * Returns 0 if no errors are found, the number of errors in case the image is
2778 * detected as corrupted, and -errno when an internal error occurred.
2780 int qcow2_check_refcounts(BlockDriverState
*bs
, BdrvCheckResult
*res
,
2783 BDRVQcow2State
*s
= bs
->opaque
;
2784 BdrvCheckResult pre_compare_res
;
2785 int64_t size
, highest_cluster
, nb_clusters
;
2786 void *refcount_table
= NULL
;
2787 bool rebuild
= false;
2790 size
= bdrv_getlength(bs
->file
->bs
);
2792 res
->check_errors
++;
2796 nb_clusters
= size_to_clusters(s
, size
);
2797 if (nb_clusters
> INT_MAX
) {
2798 res
->check_errors
++;
2802 res
->bfi
.total_clusters
=
2803 size_to_clusters(s
, bs
->total_sectors
* BDRV_SECTOR_SIZE
);
2805 ret
= calculate_refcounts(bs
, res
, fix
, &rebuild
, &refcount_table
,
2811 /* In case we don't need to rebuild the refcount structure (but want to fix
2812 * something), this function is immediately called again, in which case the
2813 * result should be ignored */
2814 pre_compare_res
= *res
;
2815 compare_refcounts(bs
, res
, 0, &rebuild
, &highest_cluster
, refcount_table
,
2818 if (rebuild
&& (fix
& BDRV_FIX_ERRORS
)) {
2819 BdrvCheckResult old_res
= *res
;
2820 int fresh_leaks
= 0;
2821 Error
*local_err
= NULL
;
2823 fprintf(stderr
, "Rebuilding refcount structure\n");
2824 ret
= rebuild_refcount_structure(bs
, res
, &refcount_table
,
2825 &nb_clusters
, &local_err
);
2827 error_report_err(local_err
);
2831 res
->corruptions
= 0;
2834 /* Because the old reftable has been exchanged for a new one the
2835 * references have to be recalculated */
2837 memset(refcount_table
, 0, refcount_array_byte_size(s
, nb_clusters
));
2838 ret
= calculate_refcounts(bs
, res
, 0, &rebuild
, &refcount_table
,
2844 if (fix
& BDRV_FIX_LEAKS
) {
2845 /* The old refcount structures are now leaked, fix it; the result
2846 * can be ignored, aside from leaks which were introduced by
2847 * rebuild_refcount_structure() that could not be fixed */
2848 BdrvCheckResult saved_res
= *res
;
2849 *res
= (BdrvCheckResult
){ 0 };
2851 compare_refcounts(bs
, res
, BDRV_FIX_LEAKS
, &rebuild
,
2852 &highest_cluster
, refcount_table
, nb_clusters
);
2854 fprintf(stderr
, "ERROR rebuilt refcount structure is still "
2858 /* Any leaks accounted for here were introduced by
2859 * rebuild_refcount_structure() because that function has created a
2860 * new refcount structure from scratch */
2861 fresh_leaks
= res
->leaks
;
2865 if (res
->corruptions
< old_res
.corruptions
) {
2866 res
->corruptions_fixed
+= old_res
.corruptions
- res
->corruptions
;
2868 if (res
->leaks
< old_res
.leaks
) {
2869 res
->leaks_fixed
+= old_res
.leaks
- res
->leaks
;
2871 res
->leaks
+= fresh_leaks
;
2874 fprintf(stderr
, "ERROR need to rebuild refcount structures\n");
2875 res
->check_errors
++;
2880 if (res
->leaks
|| res
->corruptions
) {
2881 *res
= pre_compare_res
;
2882 compare_refcounts(bs
, res
, fix
, &rebuild
, &highest_cluster
,
2883 refcount_table
, nb_clusters
);
2887 /* check OFLAG_COPIED */
2888 ret
= check_oflag_copied(bs
, res
, fix
);
2893 res
->image_end_offset
= (highest_cluster
+ 1) * s
->cluster_size
;
2897 g_free(refcount_table
);
2902 #define overlaps_with(ofs, sz) \
2903 ranges_overlap(offset, size, ofs, sz)
2906 * Checks if the given offset into the image file is actually free to use by
2907 * looking for overlaps with important metadata sections (L1/L2 tables etc.),
2908 * i.e. a sanity check without relying on the refcount tables.
2910 * The ign parameter specifies what checks not to perform (being a bitmask of
2911 * QCow2MetadataOverlap values), i.e., what sections to ignore.
2914 * - 0 if writing to this offset will not affect the mentioned metadata
2915 * - a positive QCow2MetadataOverlap value indicating one overlapping section
2916 * - a negative value (-errno) indicating an error while performing a check,
2917 * e.g. when bdrv_pread failed on QCOW2_OL_INACTIVE_L2
2919 int qcow2_check_metadata_overlap(BlockDriverState
*bs
, int ign
, int64_t offset
,
2922 BDRVQcow2State
*s
= bs
->opaque
;
2923 int chk
= s
->overlap_check
& ~ign
;
2930 if (chk
& QCOW2_OL_MAIN_HEADER
) {
2931 if (offset
< s
->cluster_size
) {
2932 return QCOW2_OL_MAIN_HEADER
;
2936 /* align range to test to cluster boundaries */
2937 size
= ROUND_UP(offset_into_cluster(s
, offset
) + size
, s
->cluster_size
);
2938 offset
= start_of_cluster(s
, offset
);
2940 if ((chk
& QCOW2_OL_ACTIVE_L1
) && s
->l1_size
) {
2941 if (overlaps_with(s
->l1_table_offset
, s
->l1_size
* L1E_SIZE
)) {
2942 return QCOW2_OL_ACTIVE_L1
;
2946 if ((chk
& QCOW2_OL_REFCOUNT_TABLE
) && s
->refcount_table_size
) {
2947 if (overlaps_with(s
->refcount_table_offset
,
2948 s
->refcount_table_size
* REFTABLE_ENTRY_SIZE
)) {
2949 return QCOW2_OL_REFCOUNT_TABLE
;
2953 if ((chk
& QCOW2_OL_SNAPSHOT_TABLE
) && s
->snapshots_size
) {
2954 if (overlaps_with(s
->snapshots_offset
, s
->snapshots_size
)) {
2955 return QCOW2_OL_SNAPSHOT_TABLE
;
2959 if ((chk
& QCOW2_OL_INACTIVE_L1
) && s
->snapshots
) {
2960 for (i
= 0; i
< s
->nb_snapshots
; i
++) {
2961 if (s
->snapshots
[i
].l1_size
&&
2962 overlaps_with(s
->snapshots
[i
].l1_table_offset
,
2963 s
->snapshots
[i
].l1_size
* L1E_SIZE
)) {
2964 return QCOW2_OL_INACTIVE_L1
;
2969 if ((chk
& QCOW2_OL_ACTIVE_L2
) && s
->l1_table
) {
2970 for (i
= 0; i
< s
->l1_size
; i
++) {
2971 if ((s
->l1_table
[i
] & L1E_OFFSET_MASK
) &&
2972 overlaps_with(s
->l1_table
[i
] & L1E_OFFSET_MASK
,
2974 return QCOW2_OL_ACTIVE_L2
;
2979 if ((chk
& QCOW2_OL_REFCOUNT_BLOCK
) && s
->refcount_table
) {
2980 unsigned last_entry
= s
->max_refcount_table_index
;
2981 assert(last_entry
< s
->refcount_table_size
);
2982 assert(last_entry
+ 1 == s
->refcount_table_size
||
2983 (s
->refcount_table
[last_entry
+ 1] & REFT_OFFSET_MASK
) == 0);
2984 for (i
= 0; i
<= last_entry
; i
++) {
2985 if ((s
->refcount_table
[i
] & REFT_OFFSET_MASK
) &&
2986 overlaps_with(s
->refcount_table
[i
] & REFT_OFFSET_MASK
,
2988 return QCOW2_OL_REFCOUNT_BLOCK
;
2993 if ((chk
& QCOW2_OL_INACTIVE_L2
) && s
->snapshots
) {
2994 for (i
= 0; i
< s
->nb_snapshots
; i
++) {
2995 uint64_t l1_ofs
= s
->snapshots
[i
].l1_table_offset
;
2996 uint32_t l1_sz
= s
->snapshots
[i
].l1_size
;
2997 uint64_t l1_sz2
= l1_sz
* L1E_SIZE
;
3001 ret
= qcow2_validate_table(bs
, l1_ofs
, l1_sz
, L1E_SIZE
,
3002 QCOW_MAX_L1_SIZE
, "", NULL
);
3007 l1
= g_try_malloc(l1_sz2
);
3009 if (l1_sz2
&& l1
== NULL
) {
3013 ret
= bdrv_pread(bs
->file
, l1_ofs
, l1_sz2
, l1
, 0);
3019 for (j
= 0; j
< l1_sz
; j
++) {
3020 uint64_t l2_ofs
= be64_to_cpu(l1
[j
]) & L1E_OFFSET_MASK
;
3021 if (l2_ofs
&& overlaps_with(l2_ofs
, s
->cluster_size
)) {
3023 return QCOW2_OL_INACTIVE_L2
;
3031 if ((chk
& QCOW2_OL_BITMAP_DIRECTORY
) &&
3032 (s
->autoclear_features
& QCOW2_AUTOCLEAR_BITMAPS
))
3034 if (overlaps_with(s
->bitmap_directory_offset
,
3035 s
->bitmap_directory_size
))
3037 return QCOW2_OL_BITMAP_DIRECTORY
;
3044 static const char *metadata_ol_names
[] = {
3045 [QCOW2_OL_MAIN_HEADER_BITNR
] = "qcow2_header",
3046 [QCOW2_OL_ACTIVE_L1_BITNR
] = "active L1 table",
3047 [QCOW2_OL_ACTIVE_L2_BITNR
] = "active L2 table",
3048 [QCOW2_OL_REFCOUNT_TABLE_BITNR
] = "refcount table",
3049 [QCOW2_OL_REFCOUNT_BLOCK_BITNR
] = "refcount block",
3050 [QCOW2_OL_SNAPSHOT_TABLE_BITNR
] = "snapshot table",
3051 [QCOW2_OL_INACTIVE_L1_BITNR
] = "inactive L1 table",
3052 [QCOW2_OL_INACTIVE_L2_BITNR
] = "inactive L2 table",
3053 [QCOW2_OL_BITMAP_DIRECTORY_BITNR
] = "bitmap directory",
3055 QEMU_BUILD_BUG_ON(QCOW2_OL_MAX_BITNR
!= ARRAY_SIZE(metadata_ol_names
));
3058 * First performs a check for metadata overlaps (through
3059 * qcow2_check_metadata_overlap); if that fails with a negative value (error
3060 * while performing a check), that value is returned. If an impending overlap
3061 * is detected, the BDS will be made unusable, the qcow2 file marked corrupt
3062 * and -EIO returned.
3064 * Returns 0 if there were neither overlaps nor errors while checking for
3065 * overlaps; or a negative value (-errno) on error.
3067 int qcow2_pre_write_overlap_check(BlockDriverState
*bs
, int ign
, int64_t offset
,
3068 int64_t size
, bool data_file
)
3072 if (data_file
&& has_data_file(bs
)) {
3076 ret
= qcow2_check_metadata_overlap(bs
, ign
, offset
, size
);
3079 } else if (ret
> 0) {
3080 int metadata_ol_bitnr
= ctz32(ret
);
3081 assert(metadata_ol_bitnr
< QCOW2_OL_MAX_BITNR
);
3083 qcow2_signal_corruption(bs
, true, offset
, size
, "Preventing invalid "
3084 "write on metadata (overlaps with %s)",
3085 metadata_ol_names
[metadata_ol_bitnr
]);
3092 /* A pointer to a function of this type is given to walk_over_reftable(). That
3093 * function will create refblocks and pass them to a RefblockFinishOp once they
3094 * are completed (@refblock). @refblock_empty is set if the refblock is
3097 * Along with the refblock, a corresponding reftable entry is passed, in the
3098 * reftable @reftable (which may be reallocated) at @reftable_index.
3100 * @allocated should be set to true if a new cluster has been allocated.
3102 typedef int (RefblockFinishOp
)(BlockDriverState
*bs
, uint64_t **reftable
,
3103 uint64_t reftable_index
, uint64_t *reftable_size
,
3104 void *refblock
, bool refblock_empty
,
3105 bool *allocated
, Error
**errp
);
3108 * This "operation" for walk_over_reftable() allocates the refblock on disk (if
3109 * it is not empty) and inserts its offset into the new reftable. The size of
3110 * this new reftable is increased as required.
3112 static int alloc_refblock(BlockDriverState
*bs
, uint64_t **reftable
,
3113 uint64_t reftable_index
, uint64_t *reftable_size
,
3114 void *refblock
, bool refblock_empty
, bool *allocated
,
3117 BDRVQcow2State
*s
= bs
->opaque
;
3120 if (!refblock_empty
&& reftable_index
>= *reftable_size
) {
3121 uint64_t *new_reftable
;
3122 uint64_t new_reftable_size
;
3124 new_reftable_size
= ROUND_UP(reftable_index
+ 1,
3125 s
->cluster_size
/ REFTABLE_ENTRY_SIZE
);
3126 if (new_reftable_size
> QCOW_MAX_REFTABLE_SIZE
/ REFTABLE_ENTRY_SIZE
) {
3128 "This operation would make the refcount table grow "
3129 "beyond the maximum size supported by QEMU, aborting");
3133 new_reftable
= g_try_realloc(*reftable
, new_reftable_size
*
3134 REFTABLE_ENTRY_SIZE
);
3135 if (!new_reftable
) {
3136 error_setg(errp
, "Failed to increase reftable buffer size");
3140 memset(new_reftable
+ *reftable_size
, 0,
3141 (new_reftable_size
- *reftable_size
) * REFTABLE_ENTRY_SIZE
);
3143 *reftable
= new_reftable
;
3144 *reftable_size
= new_reftable_size
;
3147 if (!refblock_empty
&& !(*reftable
)[reftable_index
]) {
3148 offset
= qcow2_alloc_clusters(bs
, s
->cluster_size
);
3150 error_setg_errno(errp
, -offset
, "Failed to allocate refblock");
3153 (*reftable
)[reftable_index
] = offset
;
3161 * This "operation" for walk_over_reftable() writes the refblock to disk at the
3162 * offset specified by the new reftable's entry. It does not modify the new
3163 * reftable or change any refcounts.
3165 static int flush_refblock(BlockDriverState
*bs
, uint64_t **reftable
,
3166 uint64_t reftable_index
, uint64_t *reftable_size
,
3167 void *refblock
, bool refblock_empty
, bool *allocated
,
3170 BDRVQcow2State
*s
= bs
->opaque
;
3174 if (reftable_index
< *reftable_size
&& (*reftable
)[reftable_index
]) {
3175 offset
= (*reftable
)[reftable_index
];
3177 ret
= qcow2_pre_write_overlap_check(bs
, 0, offset
, s
->cluster_size
,
3180 error_setg_errno(errp
, -ret
, "Overlap check failed");
3184 ret
= bdrv_pwrite(bs
->file
, offset
, s
->cluster_size
, refblock
, 0);
3186 error_setg_errno(errp
, -ret
, "Failed to write refblock");
3190 assert(refblock_empty
);
3197 * This function walks over the existing reftable and every referenced refblock;
3198 * if @new_set_refcount is non-NULL, it is called for every refcount entry to
3199 * create an equal new entry in the passed @new_refblock. Once that
3200 * @new_refblock is completely filled, @operation will be called.
3202 * @status_cb and @cb_opaque are used for the amend operation's status callback.
3203 * @index is the index of the walk_over_reftable() calls and @total is the total
3204 * number of walk_over_reftable() calls per amend operation. Both are used for
3205 * calculating the parameters for the status callback.
3207 * @allocated is set to true if a new cluster has been allocated.
3209 static int walk_over_reftable(BlockDriverState
*bs
, uint64_t **new_reftable
,
3210 uint64_t *new_reftable_index
,
3211 uint64_t *new_reftable_size
,
3212 void *new_refblock
, int new_refblock_size
,
3213 int new_refcount_bits
,
3214 RefblockFinishOp
*operation
, bool *allocated
,
3215 Qcow2SetRefcountFunc
*new_set_refcount
,
3216 BlockDriverAmendStatusCB
*status_cb
,
3217 void *cb_opaque
, int index
, int total
,
3220 BDRVQcow2State
*s
= bs
->opaque
;
3221 uint64_t reftable_index
;
3222 bool new_refblock_empty
= true;
3224 int new_refblock_index
= 0;
3227 for (reftable_index
= 0; reftable_index
< s
->refcount_table_size
;
3230 uint64_t refblock_offset
= s
->refcount_table
[reftable_index
]
3233 status_cb(bs
, (uint64_t)index
* s
->refcount_table_size
+ reftable_index
,
3234 (uint64_t)total
* s
->refcount_table_size
, cb_opaque
);
3236 if (refblock_offset
) {
3239 if (offset_into_cluster(s
, refblock_offset
)) {
3240 qcow2_signal_corruption(bs
, true, -1, -1, "Refblock offset %#"
3241 PRIx64
" unaligned (reftable index: %#"
3242 PRIx64
")", refblock_offset
,
3245 "Image is corrupt (unaligned refblock offset)");
3249 ret
= qcow2_cache_get(bs
, s
->refcount_block_cache
, refblock_offset
,
3252 error_setg_errno(errp
, -ret
, "Failed to retrieve refblock");
3256 for (refblock_index
= 0; refblock_index
< s
->refcount_block_size
;
3261 if (new_refblock_index
>= new_refblock_size
) {
3262 /* new_refblock is now complete */
3263 ret
= operation(bs
, new_reftable
, *new_reftable_index
,
3264 new_reftable_size
, new_refblock
,
3265 new_refblock_empty
, allocated
, errp
);
3267 qcow2_cache_put(s
->refcount_block_cache
, &refblock
);
3271 (*new_reftable_index
)++;
3272 new_refblock_index
= 0;
3273 new_refblock_empty
= true;
3276 refcount
= s
->get_refcount(refblock
, refblock_index
);
3277 if (new_refcount_bits
< 64 && refcount
>> new_refcount_bits
) {
3280 qcow2_cache_put(s
->refcount_block_cache
, &refblock
);
3282 offset
= ((reftable_index
<< s
->refcount_block_bits
)
3283 + refblock_index
) << s
->cluster_bits
;
3285 error_setg(errp
, "Cannot decrease refcount entry width to "
3286 "%i bits: Cluster at offset %#" PRIx64
" has a "
3287 "refcount of %" PRIu64
, new_refcount_bits
,
3292 if (new_set_refcount
) {
3293 new_set_refcount(new_refblock
, new_refblock_index
++,
3296 new_refblock_index
++;
3298 new_refblock_empty
= new_refblock_empty
&& refcount
== 0;
3301 qcow2_cache_put(s
->refcount_block_cache
, &refblock
);
3303 /* No refblock means every refcount is 0 */
3304 for (refblock_index
= 0; refblock_index
< s
->refcount_block_size
;
3307 if (new_refblock_index
>= new_refblock_size
) {
3308 /* new_refblock is now complete */
3309 ret
= operation(bs
, new_reftable
, *new_reftable_index
,
3310 new_reftable_size
, new_refblock
,
3311 new_refblock_empty
, allocated
, errp
);
3316 (*new_reftable_index
)++;
3317 new_refblock_index
= 0;
3318 new_refblock_empty
= true;
3321 if (new_set_refcount
) {
3322 new_set_refcount(new_refblock
, new_refblock_index
++, 0);
3324 new_refblock_index
++;
3330 if (new_refblock_index
> 0) {
3331 /* Complete the potentially existing partially filled final refblock */
3332 if (new_set_refcount
) {
3333 for (; new_refblock_index
< new_refblock_size
;
3334 new_refblock_index
++)
3336 new_set_refcount(new_refblock
, new_refblock_index
, 0);
3340 ret
= operation(bs
, new_reftable
, *new_reftable_index
,
3341 new_reftable_size
, new_refblock
, new_refblock_empty
,
3347 (*new_reftable_index
)++;
3350 status_cb(bs
, (uint64_t)(index
+ 1) * s
->refcount_table_size
,
3351 (uint64_t)total
* s
->refcount_table_size
, cb_opaque
);
3356 int qcow2_change_refcount_order(BlockDriverState
*bs
, int refcount_order
,
3357 BlockDriverAmendStatusCB
*status_cb
,
3358 void *cb_opaque
, Error
**errp
)
3360 BDRVQcow2State
*s
= bs
->opaque
;
3361 Qcow2GetRefcountFunc
*new_get_refcount
;
3362 Qcow2SetRefcountFunc
*new_set_refcount
;
3363 void *new_refblock
= qemu_blockalign(bs
->file
->bs
, s
->cluster_size
);
3364 uint64_t *new_reftable
= NULL
, new_reftable_size
= 0;
3365 uint64_t *old_reftable
, old_reftable_size
, old_reftable_offset
;
3366 uint64_t new_reftable_index
= 0;
3368 int64_t new_reftable_offset
= 0, allocated_reftable_size
= 0;
3369 int new_refblock_size
, new_refcount_bits
= 1 << refcount_order
;
3370 int old_refcount_order
;
3373 bool new_allocation
;
3375 assert(s
->qcow_version
>= 3);
3376 assert(refcount_order
>= 0 && refcount_order
<= 6);
3378 /* see qcow2_open() */
3379 new_refblock_size
= 1 << (s
->cluster_bits
- (refcount_order
- 3));
3381 new_get_refcount
= get_refcount_funcs
[refcount_order
];
3382 new_set_refcount
= set_refcount_funcs
[refcount_order
];
3388 new_allocation
= false;
3390 /* At least we have to do this walk and the one which writes the
3391 * refblocks; also, at least we have to do this loop here at least
3392 * twice (normally), first to do the allocations, and second to
3393 * determine that everything is correctly allocated, this then makes
3394 * three walks in total */
3395 total_walks
= MAX(walk_index
+ 2, 3);
3397 /* First, allocate the structures so they are present in the refcount
3399 ret
= walk_over_reftable(bs
, &new_reftable
, &new_reftable_index
,
3400 &new_reftable_size
, NULL
, new_refblock_size
,
3401 new_refcount_bits
, &alloc_refblock
,
3402 &new_allocation
, NULL
, status_cb
, cb_opaque
,
3403 walk_index
++, total_walks
, errp
);
3408 new_reftable_index
= 0;
3410 if (new_allocation
) {
3411 if (new_reftable_offset
) {
3412 qcow2_free_clusters(
3413 bs
, new_reftable_offset
,
3414 allocated_reftable_size
* REFTABLE_ENTRY_SIZE
,
3415 QCOW2_DISCARD_NEVER
);
3418 new_reftable_offset
= qcow2_alloc_clusters(bs
, new_reftable_size
*
3419 REFTABLE_ENTRY_SIZE
);
3420 if (new_reftable_offset
< 0) {
3421 error_setg_errno(errp
, -new_reftable_offset
,
3422 "Failed to allocate the new reftable");
3423 ret
= new_reftable_offset
;
3426 allocated_reftable_size
= new_reftable_size
;
3428 } while (new_allocation
);
3430 /* Second, write the new refblocks */
3431 ret
= walk_over_reftable(bs
, &new_reftable
, &new_reftable_index
,
3432 &new_reftable_size
, new_refblock
,
3433 new_refblock_size
, new_refcount_bits
,
3434 &flush_refblock
, &new_allocation
, new_set_refcount
,
3435 status_cb
, cb_opaque
, walk_index
, walk_index
+ 1,
3440 assert(!new_allocation
);
3443 /* Write the new reftable */
3444 ret
= qcow2_pre_write_overlap_check(bs
, 0, new_reftable_offset
,
3445 new_reftable_size
* REFTABLE_ENTRY_SIZE
,
3448 error_setg_errno(errp
, -ret
, "Overlap check failed");
3452 for (i
= 0; i
< new_reftable_size
; i
++) {
3453 cpu_to_be64s(&new_reftable
[i
]);
3456 ret
= bdrv_pwrite(bs
->file
, new_reftable_offset
,
3457 new_reftable_size
* REFTABLE_ENTRY_SIZE
, new_reftable
,
3460 for (i
= 0; i
< new_reftable_size
; i
++) {
3461 be64_to_cpus(&new_reftable
[i
]);
3465 error_setg_errno(errp
, -ret
, "Failed to write the new reftable");
3470 /* Empty the refcount cache */
3471 ret
= qcow2_cache_flush(bs
, s
->refcount_block_cache
);
3473 error_setg_errno(errp
, -ret
, "Failed to flush the refblock cache");
3477 /* Update the image header to point to the new reftable; this only updates
3478 * the fields which are relevant to qcow2_update_header(); other fields
3479 * such as s->refcount_table or s->refcount_bits stay stale for now
3480 * (because we have to restore everything if qcow2_update_header() fails) */
3481 old_refcount_order
= s
->refcount_order
;
3482 old_reftable_size
= s
->refcount_table_size
;
3483 old_reftable_offset
= s
->refcount_table_offset
;
3485 s
->refcount_order
= refcount_order
;
3486 s
->refcount_table_size
= new_reftable_size
;
3487 s
->refcount_table_offset
= new_reftable_offset
;
3489 ret
= qcow2_update_header(bs
);
3491 s
->refcount_order
= old_refcount_order
;
3492 s
->refcount_table_size
= old_reftable_size
;
3493 s
->refcount_table_offset
= old_reftable_offset
;
3494 error_setg_errno(errp
, -ret
, "Failed to update the qcow2 header");
3498 /* Now update the rest of the in-memory information */
3499 old_reftable
= s
->refcount_table
;
3500 s
->refcount_table
= new_reftable
;
3501 update_max_refcount_table_index(s
);
3503 s
->refcount_bits
= 1 << refcount_order
;
3504 s
->refcount_max
= UINT64_C(1) << (s
->refcount_bits
- 1);
3505 s
->refcount_max
+= s
->refcount_max
- 1;
3507 s
->refcount_block_bits
= s
->cluster_bits
- (refcount_order
- 3);
3508 s
->refcount_block_size
= 1 << s
->refcount_block_bits
;
3510 s
->get_refcount
= new_get_refcount
;
3511 s
->set_refcount
= new_set_refcount
;
3513 /* For cleaning up all old refblocks and the old reftable below the "done"
3515 new_reftable
= old_reftable
;
3516 new_reftable_size
= old_reftable_size
;
3517 new_reftable_offset
= old_reftable_offset
;
3521 /* On success, new_reftable actually points to the old reftable (and
3522 * new_reftable_size is the old reftable's size); but that is just
3524 for (i
= 0; i
< new_reftable_size
; i
++) {
3525 uint64_t offset
= new_reftable
[i
] & REFT_OFFSET_MASK
;
3527 qcow2_free_clusters(bs
, offset
, s
->cluster_size
,
3528 QCOW2_DISCARD_OTHER
);
3531 g_free(new_reftable
);
3533 if (new_reftable_offset
> 0) {
3534 qcow2_free_clusters(bs
, new_reftable_offset
,
3535 new_reftable_size
* REFTABLE_ENTRY_SIZE
,
3536 QCOW2_DISCARD_OTHER
);
3540 qemu_vfree(new_refblock
);
3544 static int64_t get_refblock_offset(BlockDriverState
*bs
, uint64_t offset
)
3546 BDRVQcow2State
*s
= bs
->opaque
;
3547 uint32_t index
= offset_to_reftable_index(s
, offset
);
3548 int64_t covering_refblock_offset
= 0;
3550 if (index
< s
->refcount_table_size
) {
3551 covering_refblock_offset
= s
->refcount_table
[index
] & REFT_OFFSET_MASK
;
3553 if (!covering_refblock_offset
) {
3554 qcow2_signal_corruption(bs
, true, -1, -1, "Refblock at %#" PRIx64
" is "
3555 "not covered by the refcount structures",
3560 return covering_refblock_offset
;
3563 static int coroutine_fn
3564 qcow2_discard_refcount_block(BlockDriverState
*bs
, uint64_t discard_block_offs
)
3566 BDRVQcow2State
*s
= bs
->opaque
;
3567 int64_t refblock_offs
;
3568 uint64_t cluster_index
= discard_block_offs
>> s
->cluster_bits
;
3569 uint32_t block_index
= cluster_index
& (s
->refcount_block_size
- 1);
3573 refblock_offs
= get_refblock_offset(bs
, discard_block_offs
);
3574 if (refblock_offs
< 0) {
3575 return refblock_offs
;
3578 assert(discard_block_offs
!= 0);
3580 ret
= qcow2_cache_get(bs
, s
->refcount_block_cache
, refblock_offs
,
3586 if (s
->get_refcount(refblock
, block_index
) != 1) {
3587 qcow2_signal_corruption(bs
, true, -1, -1, "Invalid refcount:"
3588 " refblock offset %#" PRIx64
3589 ", reftable index %u"
3590 ", block offset %#" PRIx64
3591 ", refcount %#" PRIx64
,
3593 offset_to_reftable_index(s
, discard_block_offs
),
3595 s
->get_refcount(refblock
, block_index
));
3596 qcow2_cache_put(s
->refcount_block_cache
, &refblock
);
3599 s
->set_refcount(refblock
, block_index
, 0);
3601 qcow2_cache_entry_mark_dirty(s
->refcount_block_cache
, refblock
);
3603 qcow2_cache_put(s
->refcount_block_cache
, &refblock
);
3605 if (cluster_index
< s
->free_cluster_index
) {
3606 s
->free_cluster_index
= cluster_index
;
3609 refblock
= qcow2_cache_is_table_offset(s
->refcount_block_cache
,
3610 discard_block_offs
);
3612 /* discard refblock from the cache if refblock is cached */
3613 qcow2_cache_discard(s
->refcount_block_cache
, refblock
);
3615 update_refcount_discard(bs
, discard_block_offs
, s
->cluster_size
);
3620 int coroutine_fn
qcow2_shrink_reftable(BlockDriverState
*bs
)
3622 BDRVQcow2State
*s
= bs
->opaque
;
3623 uint64_t *reftable_tmp
=
3624 g_malloc(s
->refcount_table_size
* REFTABLE_ENTRY_SIZE
);
3627 for (i
= 0; i
< s
->refcount_table_size
; i
++) {
3628 int64_t refblock_offs
= s
->refcount_table
[i
] & REFT_OFFSET_MASK
;
3632 if (refblock_offs
== 0) {
3633 reftable_tmp
[i
] = 0;
3636 ret
= qcow2_cache_get(bs
, s
->refcount_block_cache
, refblock_offs
,
3642 /* the refblock has own reference */
3643 if (i
== offset_to_reftable_index(s
, refblock_offs
)) {
3644 uint64_t block_index
= (refblock_offs
>> s
->cluster_bits
) &
3645 (s
->refcount_block_size
- 1);
3646 uint64_t refcount
= s
->get_refcount(refblock
, block_index
);
3648 s
->set_refcount(refblock
, block_index
, 0);
3650 unused_block
= buffer_is_zero(refblock
, s
->cluster_size
);
3652 s
->set_refcount(refblock
, block_index
, refcount
);
3654 unused_block
= buffer_is_zero(refblock
, s
->cluster_size
);
3656 qcow2_cache_put(s
->refcount_block_cache
, &refblock
);
3658 reftable_tmp
[i
] = unused_block
? 0 : cpu_to_be64(s
->refcount_table
[i
]);
3661 ret
= bdrv_co_pwrite_sync(bs
->file
, s
->refcount_table_offset
,
3662 s
->refcount_table_size
* REFTABLE_ENTRY_SIZE
,
3665 * If the write in the reftable failed the image may contain a partially
3666 * overwritten reftable. In this case it would be better to clear the
3667 * reftable in memory to avoid possible image corruption.
3669 for (i
= 0; i
< s
->refcount_table_size
; i
++) {
3670 if (s
->refcount_table
[i
] && !reftable_tmp
[i
]) {
3672 ret
= qcow2_discard_refcount_block(bs
, s
->refcount_table
[i
] &
3675 s
->refcount_table
[i
] = 0;
3679 if (!s
->cache_discards
) {
3680 qcow2_process_discards(bs
, ret
);
3684 g_free(reftable_tmp
);
3688 int64_t coroutine_fn
qcow2_get_last_cluster(BlockDriverState
*bs
, int64_t size
)
3690 BDRVQcow2State
*s
= bs
->opaque
;
3693 for (i
= size_to_clusters(s
, size
) - 1; i
>= 0; i
--) {
3695 int ret
= qcow2_get_refcount(bs
, i
, &refcount
);
3697 fprintf(stderr
, "Can't get refcount for cluster %" PRId64
": %s\n",
3705 qcow2_signal_corruption(bs
, true, -1, -1,
3706 "There are no references in the refcount table.");
3710 int coroutine_fn
qcow2_detect_metadata_preallocation(BlockDriverState
*bs
)
3712 BDRVQcow2State
*s
= bs
->opaque
;
3713 int64_t i
, end_cluster
, cluster_count
= 0, threshold
;
3714 int64_t file_length
, real_allocation
, real_clusters
;
3716 qemu_co_mutex_assert_locked(&s
->lock
);
3718 file_length
= bdrv_co_getlength(bs
->file
->bs
);
3719 if (file_length
< 0) {
3723 real_allocation
= bdrv_co_get_allocated_file_size(bs
->file
->bs
);
3724 if (real_allocation
< 0) {
3725 return real_allocation
;
3728 real_clusters
= real_allocation
/ s
->cluster_size
;
3729 threshold
= MAX(real_clusters
* 10 / 9, real_clusters
+ 2);
3731 end_cluster
= size_to_clusters(s
, file_length
);
3732 for (i
= 0; i
< end_cluster
&& cluster_count
< threshold
; i
++) {
3734 int ret
= qcow2_get_refcount(bs
, i
, &refcount
);
3738 cluster_count
+= !!refcount
;
3741 return cluster_count
>= threshold
;