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_CO_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 GRAPH_RDLOCK
233 load_refcount_block(BlockDriverState
*bs
, 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 GRAPH_RDLOCK
306 alloc_refcount_block(BlockDriverState
*bs
, int64_t cluster_index
,
307 void **refcount_block
)
309 BDRVQcow2State
*s
= bs
->opaque
;
310 unsigned int refcount_table_index
;
313 BLKDBG_EVENT(bs
->file
, BLKDBG_REFBLOCK_ALLOC
);
315 /* Find the refcount block for the given cluster */
316 refcount_table_index
= cluster_index
>> s
->refcount_block_bits
;
318 if (refcount_table_index
< s
->refcount_table_size
) {
320 uint64_t refcount_block_offset
=
321 s
->refcount_table
[refcount_table_index
] & REFT_OFFSET_MASK
;
323 /* If it's already there, we're done */
324 if (refcount_block_offset
) {
325 if (offset_into_cluster(s
, refcount_block_offset
)) {
326 qcow2_signal_corruption(bs
, true, -1, -1, "Refblock offset %#"
327 PRIx64
" unaligned (reftable index: "
328 "%#x)", refcount_block_offset
,
329 refcount_table_index
);
333 return load_refcount_block(bs
, refcount_block_offset
,
339 * If we came here, we need to allocate something. Something is at least
340 * a cluster for the new refcount block. It may also include a new refcount
341 * table if the old refcount table is too small.
343 * Note that allocating clusters here needs some special care:
345 * - We can't use the normal qcow2_alloc_clusters(), it would try to
346 * increase the refcount and very likely we would end up with an endless
347 * recursion. Instead we must place the refcount blocks in a way that
348 * they can describe them themselves.
350 * - We need to consider that at this point we are inside update_refcounts
351 * and potentially doing an initial refcount increase. This means that
352 * some clusters have already been allocated by the caller, but their
353 * refcount isn't accurate yet. If we allocate clusters for metadata, we
354 * need to return -EAGAIN to signal the caller that it needs to restart
355 * the search for free clusters.
357 * - alloc_clusters_noref and qcow2_free_clusters may load a different
358 * refcount block into the cache
361 *refcount_block
= NULL
;
363 /* We write to the refcount table, so we might depend on L2 tables */
364 ret
= qcow2_cache_flush(bs
, s
->l2_table_cache
);
369 /* Allocate the refcount block itself and mark it as used */
370 int64_t new_block
= alloc_clusters_noref(bs
, s
->cluster_size
, INT64_MAX
);
375 /* The offset must fit in the offset field of the refcount table entry */
376 assert((new_block
& REFT_OFFSET_MASK
) == new_block
);
378 /* If we're allocating the block at offset 0 then something is wrong */
379 if (new_block
== 0) {
380 qcow2_signal_corruption(bs
, true, -1, -1, "Preventing invalid "
381 "allocation of refcount block at offset 0");
386 fprintf(stderr
, "qcow2: Allocate refcount block %d for %" PRIx64
388 refcount_table_index
, cluster_index
<< s
->cluster_bits
, new_block
);
391 if (in_same_refcount_block(s
, new_block
, cluster_index
<< s
->cluster_bits
)) {
392 /* Zero the new refcount block before updating it */
393 ret
= qcow2_cache_get_empty(bs
, s
->refcount_block_cache
, new_block
,
399 memset(*refcount_block
, 0, s
->cluster_size
);
401 /* The block describes itself, need to update the cache */
402 int block_index
= (new_block
>> s
->cluster_bits
) &
403 (s
->refcount_block_size
- 1);
404 s
->set_refcount(*refcount_block
, block_index
, 1);
406 /* Described somewhere else. This can recurse at most twice before we
407 * arrive at a block that describes itself. */
408 ret
= update_refcount(bs
, new_block
, s
->cluster_size
, 1, false,
409 QCOW2_DISCARD_NEVER
);
414 ret
= qcow2_cache_flush(bs
, s
->refcount_block_cache
);
419 /* Initialize the new refcount block only after updating its refcount,
420 * update_refcount uses the refcount cache itself */
421 ret
= qcow2_cache_get_empty(bs
, s
->refcount_block_cache
, new_block
,
427 memset(*refcount_block
, 0, s
->cluster_size
);
430 /* Now the new refcount block needs to be written to disk */
431 BLKDBG_EVENT(bs
->file
, BLKDBG_REFBLOCK_ALLOC_WRITE
);
432 qcow2_cache_entry_mark_dirty(s
->refcount_block_cache
, *refcount_block
);
433 ret
= qcow2_cache_flush(bs
, s
->refcount_block_cache
);
438 /* If the refcount table is big enough, just hook the block up there */
439 if (refcount_table_index
< s
->refcount_table_size
) {
440 uint64_t data64
= cpu_to_be64(new_block
);
441 BLKDBG_EVENT(bs
->file
, BLKDBG_REFBLOCK_ALLOC_HOOKUP
);
442 ret
= bdrv_pwrite_sync(bs
->file
, s
->refcount_table_offset
+
443 refcount_table_index
* REFTABLE_ENTRY_SIZE
,
444 sizeof(data64
), &data64
, 0);
449 s
->refcount_table
[refcount_table_index
] = new_block
;
450 /* If there's a hole in s->refcount_table then it can happen
451 * that refcount_table_index < s->max_refcount_table_index */
452 s
->max_refcount_table_index
=
453 MAX(s
->max_refcount_table_index
, refcount_table_index
);
455 /* The new refcount block may be where the caller intended to put its
456 * data, so let it restart the search. */
460 qcow2_cache_put(s
->refcount_block_cache
, refcount_block
);
463 * If we come here, we need to grow the refcount table. Again, a new
464 * refcount table needs some space and we can't simply allocate to avoid
467 * Therefore let's grab new refcount blocks at the end of the image, which
468 * will describe themselves and the new refcount table. This way we can
469 * reference them only in the new table and do the switch to the new
470 * refcount table at once without producing an inconsistent state in
473 BLKDBG_EVENT(bs
->file
, BLKDBG_REFTABLE_GROW
);
475 /* Calculate the number of refcount blocks needed so far; this will be the
476 * basis for calculating the index of the first cluster used for the
477 * self-describing refcount structures which we are about to create.
479 * Because we reached this point, there cannot be any refcount entries for
480 * cluster_index or higher indices yet. However, because new_block has been
481 * allocated to describe that cluster (and it will assume this role later
482 * on), we cannot use that index; also, new_block may actually have a higher
483 * cluster index than cluster_index, so it needs to be taken into account
484 * here (and 1 needs to be added to its value because that cluster is used).
486 uint64_t blocks_used
= DIV_ROUND_UP(MAX(cluster_index
+ 1,
487 (new_block
>> s
->cluster_bits
) + 1),
488 s
->refcount_block_size
);
490 /* Create the new refcount table and blocks */
491 uint64_t meta_offset
= (blocks_used
* s
->refcount_block_size
) *
494 ret
= qcow2_refcount_area(bs
, meta_offset
, 0, false,
495 refcount_table_index
, new_block
);
500 ret
= load_refcount_block(bs
, new_block
, refcount_block
);
505 /* If we were trying to do the initial refcount update for some cluster
506 * allocation, we might have used the same clusters to store newly
507 * allocated metadata. Make the caller search some new space. */
511 if (*refcount_block
!= NULL
) {
512 qcow2_cache_put(s
->refcount_block_cache
, refcount_block
);
518 * Starting at @start_offset, this function creates new self-covering refcount
519 * structures: A new refcount table and refcount blocks which cover all of
520 * themselves, and a number of @additional_clusters beyond their end.
521 * @start_offset must be at the end of the image file, that is, there must be
522 * only empty space beyond it.
523 * If @exact_size is false, the refcount table will have 50 % more entries than
524 * necessary so it will not need to grow again soon.
525 * If @new_refblock_offset is not zero, it contains the offset of a refcount
526 * block that should be entered into the new refcount table at index
527 * @new_refblock_index.
529 * Returns: The offset after the new refcount structures (i.e. where the
530 * @additional_clusters may be placed) on success, -errno on error.
532 int64_t qcow2_refcount_area(BlockDriverState
*bs
, uint64_t start_offset
,
533 uint64_t additional_clusters
, bool exact_size
,
534 int new_refblock_index
,
535 uint64_t new_refblock_offset
)
537 BDRVQcow2State
*s
= bs
->opaque
;
538 uint64_t total_refblock_count_u64
, additional_refblock_count
;
539 int total_refblock_count
, table_size
, area_reftable_index
, table_clusters
;
541 uint64_t table_offset
, block_offset
, end_offset
;
545 assert(!(start_offset
% s
->cluster_size
));
547 qcow2_refcount_metadata_size(start_offset
/ s
->cluster_size
+
549 s
->cluster_size
, s
->refcount_order
,
550 !exact_size
, &total_refblock_count_u64
);
551 if (total_refblock_count_u64
> QCOW_MAX_REFTABLE_SIZE
) {
554 total_refblock_count
= total_refblock_count_u64
;
556 /* Index in the refcount table of the first refcount block to cover the area
557 * of refcount structures we are about to create; we know that
558 * @total_refblock_count can cover @start_offset, so this will definitely
559 * fit into an int. */
560 area_reftable_index
= (start_offset
/ s
->cluster_size
) /
561 s
->refcount_block_size
;
564 table_size
= total_refblock_count
;
566 table_size
= total_refblock_count
+
567 DIV_ROUND_UP(total_refblock_count
, 2);
569 /* The qcow2 file can only store the reftable size in number of clusters */
570 table_size
= ROUND_UP(table_size
, s
->cluster_size
/ REFTABLE_ENTRY_SIZE
);
571 table_clusters
= (table_size
* REFTABLE_ENTRY_SIZE
) / s
->cluster_size
;
573 if (table_size
> QCOW_MAX_REFTABLE_SIZE
) {
577 new_table
= g_try_new0(uint64_t, table_size
);
579 assert(table_size
> 0);
580 if (new_table
== NULL
) {
585 /* Fill the new refcount table */
586 if (table_size
> s
->max_refcount_table_index
) {
587 /* We're actually growing the reftable */
588 memcpy(new_table
, s
->refcount_table
,
589 (s
->max_refcount_table_index
+ 1) * REFTABLE_ENTRY_SIZE
);
591 /* Improbable case: We're shrinking the reftable. However, the caller
592 * has assured us that there is only empty space beyond @start_offset,
593 * so we can simply drop all of the refblocks that won't fit into the
595 memcpy(new_table
, s
->refcount_table
, table_size
* REFTABLE_ENTRY_SIZE
);
598 if (new_refblock_offset
) {
599 assert(new_refblock_index
< total_refblock_count
);
600 new_table
[new_refblock_index
] = new_refblock_offset
;
603 /* Count how many new refblocks we have to create */
604 additional_refblock_count
= 0;
605 for (i
= area_reftable_index
; i
< total_refblock_count
; i
++) {
607 additional_refblock_count
++;
611 table_offset
= start_offset
+ additional_refblock_count
* s
->cluster_size
;
612 end_offset
= table_offset
+ table_clusters
* s
->cluster_size
;
614 /* Fill the refcount blocks, and create new ones, if necessary */
615 block_offset
= start_offset
;
616 for (i
= area_reftable_index
; i
< total_refblock_count
; i
++) {
618 uint64_t first_offset_covered
;
620 /* Reuse an existing refblock if possible, create a new one otherwise */
622 ret
= qcow2_cache_get(bs
, s
->refcount_block_cache
, new_table
[i
],
628 ret
= qcow2_cache_get_empty(bs
, s
->refcount_block_cache
,
629 block_offset
, &refblock_data
);
633 memset(refblock_data
, 0, s
->cluster_size
);
634 qcow2_cache_entry_mark_dirty(s
->refcount_block_cache
,
637 new_table
[i
] = block_offset
;
638 block_offset
+= s
->cluster_size
;
641 /* First host offset covered by this refblock */
642 first_offset_covered
= (uint64_t)i
* s
->refcount_block_size
*
644 if (first_offset_covered
< end_offset
) {
647 /* Set the refcount of all of the new refcount structures to 1 */
649 if (first_offset_covered
< start_offset
) {
650 assert(i
== area_reftable_index
);
651 j
= (start_offset
- first_offset_covered
) / s
->cluster_size
;
652 assert(j
< s
->refcount_block_size
);
657 end_index
= MIN((end_offset
- first_offset_covered
) /
659 s
->refcount_block_size
);
661 for (; j
< end_index
; j
++) {
662 /* The caller guaranteed us this space would be empty */
663 assert(s
->get_refcount(refblock_data
, j
) == 0);
664 s
->set_refcount(refblock_data
, j
, 1);
667 qcow2_cache_entry_mark_dirty(s
->refcount_block_cache
,
671 qcow2_cache_put(s
->refcount_block_cache
, &refblock_data
);
674 assert(block_offset
== table_offset
);
676 /* Write refcount blocks to disk */
677 BLKDBG_EVENT(bs
->file
, BLKDBG_REFBLOCK_ALLOC_WRITE_BLOCKS
);
678 ret
= qcow2_cache_flush(bs
, s
->refcount_block_cache
);
683 /* Write refcount table to disk */
684 for (i
= 0; i
< total_refblock_count
; i
++) {
685 cpu_to_be64s(&new_table
[i
]);
688 BLKDBG_EVENT(bs
->file
, BLKDBG_REFBLOCK_ALLOC_WRITE_TABLE
);
689 ret
= bdrv_pwrite_sync(bs
->file
, table_offset
,
690 table_size
* REFTABLE_ENTRY_SIZE
, new_table
, 0);
695 for (i
= 0; i
< total_refblock_count
; i
++) {
696 be64_to_cpus(&new_table
[i
]);
699 /* Hook up the new refcount table in the qcow2 header */
704 data
.d64
= cpu_to_be64(table_offset
);
705 data
.d32
= cpu_to_be32(table_clusters
);
706 BLKDBG_EVENT(bs
->file
, BLKDBG_REFBLOCK_ALLOC_SWITCH_TABLE
);
707 ret
= bdrv_pwrite_sync(bs
->file
,
708 offsetof(QCowHeader
, refcount_table_offset
),
709 sizeof(data
), &data
, 0);
714 /* And switch it in memory */
715 uint64_t old_table_offset
= s
->refcount_table_offset
;
716 uint64_t old_table_size
= s
->refcount_table_size
;
718 g_free(s
->refcount_table
);
719 s
->refcount_table
= new_table
;
720 s
->refcount_table_size
= table_size
;
721 s
->refcount_table_offset
= table_offset
;
722 update_max_refcount_table_index(s
);
724 /* Free old table. */
725 qcow2_free_clusters(bs
, old_table_offset
,
726 old_table_size
* REFTABLE_ENTRY_SIZE
,
727 QCOW2_DISCARD_OTHER
);
736 void qcow2_process_discards(BlockDriverState
*bs
, int ret
)
738 BDRVQcow2State
*s
= bs
->opaque
;
739 Qcow2DiscardRegion
*d
, *next
;
741 QTAILQ_FOREACH_SAFE(d
, &s
->discards
, next
, next
) {
742 QTAILQ_REMOVE(&s
->discards
, d
, next
);
744 /* Discard is optional, ignore the return value */
746 int r2
= bdrv_pdiscard(bs
->file
, d
->offset
, d
->bytes
);
748 trace_qcow2_process_discards_failed_region(d
->offset
, d
->bytes
,
757 static void update_refcount_discard(BlockDriverState
*bs
,
758 uint64_t offset
, uint64_t length
)
760 BDRVQcow2State
*s
= bs
->opaque
;
761 Qcow2DiscardRegion
*d
, *p
, *next
;
763 QTAILQ_FOREACH(d
, &s
->discards
, next
) {
764 uint64_t new_start
= MIN(offset
, d
->offset
);
765 uint64_t new_end
= MAX(offset
+ length
, d
->offset
+ d
->bytes
);
767 if (new_end
- new_start
<= length
+ d
->bytes
) {
768 /* There can't be any overlap, areas ending up here have no
769 * references any more and therefore shouldn't get freed another
771 assert(d
->bytes
+ length
== new_end
- new_start
);
772 d
->offset
= new_start
;
773 d
->bytes
= new_end
- new_start
;
778 d
= g_malloc(sizeof(*d
));
779 *d
= (Qcow2DiscardRegion
) {
784 QTAILQ_INSERT_TAIL(&s
->discards
, d
, next
);
787 /* Merge discard requests if they are adjacent now */
788 QTAILQ_FOREACH_SAFE(p
, &s
->discards
, next
, next
) {
790 || p
->offset
> d
->offset
+ d
->bytes
791 || d
->offset
> p
->offset
+ p
->bytes
)
796 /* Still no overlap possible */
797 assert(p
->offset
== d
->offset
+ d
->bytes
798 || d
->offset
== p
->offset
+ p
->bytes
);
800 QTAILQ_REMOVE(&s
->discards
, p
, next
);
801 d
->offset
= MIN(d
->offset
, p
->offset
);
802 d
->bytes
+= p
->bytes
;
807 /* XXX: cache several refcount block clusters ? */
808 /* @addend is the absolute value of the addend; if @decrease is set, @addend
809 * will be subtracted from the current refcount, otherwise it will be added */
810 static int GRAPH_RDLOCK
811 update_refcount(BlockDriverState
*bs
, int64_t offset
, int64_t length
,
812 uint64_t addend
, bool decrease
, enum qcow2_discard_type type
)
814 BDRVQcow2State
*s
= bs
->opaque
;
815 int64_t start
, last
, cluster_offset
;
816 void *refcount_block
= NULL
;
817 int64_t old_table_index
= -1;
821 fprintf(stderr
, "update_refcount: offset=%" PRId64
" size=%" PRId64
822 " addend=%s%" PRIu64
"\n", offset
, length
, decrease
? "-" : "",
827 } else if (length
== 0) {
832 qcow2_cache_set_dependency(bs
, s
->refcount_block_cache
,
836 start
= start_of_cluster(s
, offset
);
837 last
= start_of_cluster(s
, offset
+ length
- 1);
838 for(cluster_offset
= start
; cluster_offset
<= last
;
839 cluster_offset
+= s
->cluster_size
)
843 int64_t cluster_index
= cluster_offset
>> s
->cluster_bits
;
844 int64_t table_index
= cluster_index
>> s
->refcount_block_bits
;
846 /* Load the refcount block and allocate it if needed */
847 if (table_index
!= old_table_index
) {
848 if (refcount_block
) {
849 qcow2_cache_put(s
->refcount_block_cache
, &refcount_block
);
851 ret
= alloc_refcount_block(bs
, cluster_index
, &refcount_block
);
852 /* If the caller needs to restart the search for free clusters,
853 * try the same ones first to see if they're still free. */
854 if (ret
== -EAGAIN
) {
855 if (s
->free_cluster_index
> (start
>> s
->cluster_bits
)) {
856 s
->free_cluster_index
= (start
>> s
->cluster_bits
);
863 old_table_index
= table_index
;
865 qcow2_cache_entry_mark_dirty(s
->refcount_block_cache
, refcount_block
);
867 /* we can update the count and save it */
868 block_index
= cluster_index
& (s
->refcount_block_size
- 1);
870 refcount
= s
->get_refcount(refcount_block
, block_index
);
871 if (decrease
? (refcount
- addend
> refcount
)
872 : (refcount
+ addend
< refcount
||
873 refcount
+ addend
> s
->refcount_max
))
883 if (refcount
== 0 && cluster_index
< s
->free_cluster_index
) {
884 s
->free_cluster_index
= cluster_index
;
886 s
->set_refcount(refcount_block
, block_index
, refcount
);
891 table
= qcow2_cache_is_table_offset(s
->refcount_block_cache
,
894 qcow2_cache_put(s
->refcount_block_cache
, &refcount_block
);
895 old_table_index
= -1;
896 qcow2_cache_discard(s
->refcount_block_cache
, table
);
899 table
= qcow2_cache_is_table_offset(s
->l2_table_cache
, offset
);
901 qcow2_cache_discard(s
->l2_table_cache
, table
);
904 if (s
->discard_passthrough
[type
]) {
905 update_refcount_discard(bs
, cluster_offset
, s
->cluster_size
);
912 if (!s
->cache_discards
) {
913 qcow2_process_discards(bs
, ret
);
916 /* Write last changed block to disk */
917 if (refcount_block
) {
918 qcow2_cache_put(s
->refcount_block_cache
, &refcount_block
);
922 * Try do undo any updates if an error is returned (This may succeed in
923 * some cases like ENOSPC for allocating a new refcount block)
927 dummy
= update_refcount(bs
, offset
, cluster_offset
- offset
, addend
,
928 !decrease
, QCOW2_DISCARD_NEVER
);
936 * Increases or decreases the refcount of a given cluster.
938 * @addend is the absolute value of the addend; if @decrease is set, @addend
939 * will be subtracted from the current refcount, otherwise it will be added.
941 * On success 0 is returned; on failure -errno is returned.
943 int qcow2_update_cluster_refcount(BlockDriverState
*bs
,
944 int64_t cluster_index
,
945 uint64_t addend
, bool decrease
,
946 enum qcow2_discard_type type
)
948 BDRVQcow2State
*s
= bs
->opaque
;
951 ret
= update_refcount(bs
, cluster_index
<< s
->cluster_bits
, 1, addend
,
962 /*********************************************************/
963 /* cluster allocation functions */
967 /* return < 0 if error */
968 static int64_t GRAPH_RDLOCK
969 alloc_clusters_noref(BlockDriverState
*bs
, uint64_t size
, uint64_t max
)
971 BDRVQcow2State
*s
= bs
->opaque
;
972 uint64_t i
, nb_clusters
, refcount
;
975 /* We can't allocate clusters if they may still be queued for discard. */
976 if (s
->cache_discards
) {
977 qcow2_process_discards(bs
, 0);
980 nb_clusters
= size_to_clusters(s
, size
);
982 for(i
= 0; i
< nb_clusters
; i
++) {
983 uint64_t next_cluster_index
= s
->free_cluster_index
++;
984 ret
= qcow2_get_refcount(bs
, next_cluster_index
, &refcount
);
988 } else if (refcount
!= 0) {
993 /* Make sure that all offsets in the "allocated" range are representable
994 * in the requested max */
995 if (s
->free_cluster_index
> 0 &&
996 s
->free_cluster_index
- 1 > (max
>> s
->cluster_bits
))
1002 fprintf(stderr
, "alloc_clusters: size=%" PRId64
" -> %" PRId64
"\n",
1004 (s
->free_cluster_index
- nb_clusters
) << s
->cluster_bits
);
1006 return (s
->free_cluster_index
- nb_clusters
) << s
->cluster_bits
;
1009 int64_t qcow2_alloc_clusters(BlockDriverState
*bs
, uint64_t size
)
1014 BLKDBG_EVENT(bs
->file
, BLKDBG_CLUSTER_ALLOC
);
1016 offset
= alloc_clusters_noref(bs
, size
, QCOW_MAX_CLUSTER_OFFSET
);
1021 ret
= update_refcount(bs
, offset
, size
, 1, false, QCOW2_DISCARD_NEVER
);
1022 } while (ret
== -EAGAIN
);
1031 int64_t coroutine_fn
qcow2_alloc_clusters_at(BlockDriverState
*bs
, uint64_t offset
,
1032 int64_t nb_clusters
)
1034 BDRVQcow2State
*s
= bs
->opaque
;
1035 uint64_t cluster_index
, refcount
;
1039 assert(nb_clusters
>= 0);
1040 if (nb_clusters
== 0) {
1045 /* Check how many clusters there are free */
1046 cluster_index
= offset
>> s
->cluster_bits
;
1047 for(i
= 0; i
< nb_clusters
; i
++) {
1048 ret
= qcow2_get_refcount(bs
, cluster_index
++, &refcount
);
1051 } else if (refcount
!= 0) {
1056 /* And then allocate them */
1057 ret
= update_refcount(bs
, offset
, i
<< s
->cluster_bits
, 1, false,
1058 QCOW2_DISCARD_NEVER
);
1059 } while (ret
== -EAGAIN
);
1068 /* only used to allocate compressed sectors. We try to allocate
1069 contiguous sectors. size must be <= cluster_size */
1070 int64_t coroutine_fn GRAPH_RDLOCK
qcow2_alloc_bytes(BlockDriverState
*bs
, int size
)
1072 BDRVQcow2State
*s
= bs
->opaque
;
1074 size_t free_in_cluster
;
1077 BLKDBG_CO_EVENT(bs
->file
, BLKDBG_CLUSTER_ALLOC_BYTES
);
1078 assert(size
> 0 && size
<= s
->cluster_size
);
1079 assert(!s
->free_byte_offset
|| offset_into_cluster(s
, s
->free_byte_offset
));
1081 offset
= s
->free_byte_offset
;
1085 ret
= qcow2_get_refcount(bs
, offset
>> s
->cluster_bits
, &refcount
);
1090 if (refcount
== s
->refcount_max
) {
1095 free_in_cluster
= s
->cluster_size
- offset_into_cluster(s
, offset
);
1097 if (!offset
|| free_in_cluster
< size
) {
1098 int64_t new_cluster
;
1100 new_cluster
= alloc_clusters_noref(bs
, s
->cluster_size
,
1101 MIN(s
->cluster_offset_mask
,
1102 QCOW_MAX_CLUSTER_OFFSET
));
1103 if (new_cluster
< 0) {
1107 if (new_cluster
== 0) {
1108 qcow2_signal_corruption(bs
, true, -1, -1, "Preventing invalid "
1109 "allocation of compressed cluster "
1114 if (!offset
|| ROUND_UP(offset
, s
->cluster_size
) != new_cluster
) {
1115 offset
= new_cluster
;
1116 free_in_cluster
= s
->cluster_size
;
1118 free_in_cluster
+= s
->cluster_size
;
1123 ret
= update_refcount(bs
, offset
, size
, 1, false, QCOW2_DISCARD_NEVER
);
1127 } while (ret
== -EAGAIN
);
1132 /* The cluster refcount was incremented; refcount blocks must be flushed
1133 * before the caller's L2 table updates. */
1134 qcow2_cache_set_dependency(bs
, s
->l2_table_cache
, s
->refcount_block_cache
);
1136 s
->free_byte_offset
= offset
+ size
;
1137 if (!offset_into_cluster(s
, s
->free_byte_offset
)) {
1138 s
->free_byte_offset
= 0;
1144 void qcow2_free_clusters(BlockDriverState
*bs
,
1145 int64_t offset
, int64_t size
,
1146 enum qcow2_discard_type type
)
1150 BLKDBG_EVENT(bs
->file
, BLKDBG_CLUSTER_FREE
);
1151 ret
= update_refcount(bs
, offset
, size
, 1, true, type
);
1153 fprintf(stderr
, "qcow2_free_clusters failed: %s\n", strerror(-ret
));
1154 /* TODO Remember the clusters to free them later and avoid leaking */
1159 * Free a cluster using its L2 entry (handles clusters of all types, e.g.
1160 * normal cluster, compressed cluster, etc.)
1162 void qcow2_free_any_cluster(BlockDriverState
*bs
, uint64_t l2_entry
,
1163 enum qcow2_discard_type type
)
1165 BDRVQcow2State
*s
= bs
->opaque
;
1166 QCow2ClusterType ctype
= qcow2_get_cluster_type(bs
, l2_entry
);
1168 if (has_data_file(bs
)) {
1169 if (s
->discard_passthrough
[type
] &&
1170 (ctype
== QCOW2_CLUSTER_NORMAL
||
1171 ctype
== QCOW2_CLUSTER_ZERO_ALLOC
))
1173 bdrv_pdiscard(s
->data_file
, l2_entry
& L2E_OFFSET_MASK
,
1180 case QCOW2_CLUSTER_COMPRESSED
:
1185 qcow2_parse_compressed_l2_entry(bs
, l2_entry
, &coffset
, &csize
);
1186 qcow2_free_clusters(bs
, coffset
, csize
, type
);
1189 case QCOW2_CLUSTER_NORMAL
:
1190 case QCOW2_CLUSTER_ZERO_ALLOC
:
1191 if (offset_into_cluster(s
, l2_entry
& L2E_OFFSET_MASK
)) {
1192 qcow2_signal_corruption(bs
, false, -1, -1,
1193 "Cannot free unaligned cluster %#llx",
1194 l2_entry
& L2E_OFFSET_MASK
);
1196 qcow2_free_clusters(bs
, l2_entry
& L2E_OFFSET_MASK
,
1197 s
->cluster_size
, type
);
1200 case QCOW2_CLUSTER_ZERO_PLAIN
:
1201 case QCOW2_CLUSTER_UNALLOCATED
:
1208 int qcow2_write_caches(BlockDriverState
*bs
)
1210 BDRVQcow2State
*s
= bs
->opaque
;
1213 ret
= qcow2_cache_write(bs
, s
->l2_table_cache
);
1218 if (qcow2_need_accurate_refcounts(s
)) {
1219 ret
= qcow2_cache_write(bs
, s
->refcount_block_cache
);
1228 int qcow2_flush_caches(BlockDriverState
*bs
)
1230 int ret
= qcow2_write_caches(bs
);
1235 return bdrv_flush(bs
->file
->bs
);
1238 /*********************************************************/
1239 /* snapshots and image creation */
1243 /* update the refcounts of snapshots and the copied flag */
1244 int qcow2_update_snapshot_refcount(BlockDriverState
*bs
,
1245 int64_t l1_table_offset
, int l1_size
, int addend
)
1247 BDRVQcow2State
*s
= bs
->opaque
;
1248 uint64_t *l1_table
, *l2_slice
, l2_offset
, entry
, l1_size2
, refcount
;
1249 bool l1_allocated
= false;
1250 int64_t old_entry
, old_l2_offset
;
1251 unsigned slice
, slice_size2
, n_slices
;
1252 int i
, j
, l1_modified
= 0;
1255 assert(addend
>= -1 && addend
<= 1);
1259 l1_size2
= l1_size
* L1E_SIZE
;
1260 slice_size2
= s
->l2_slice_size
* l2_entry_size(s
);
1261 n_slices
= s
->cluster_size
/ slice_size2
;
1263 s
->cache_discards
= true;
1265 /* WARNING: qcow2_snapshot_goto relies on this function not using the
1266 * l1_table_offset when it is the current s->l1_table_offset! Be careful
1267 * when changing this! */
1268 if (l1_table_offset
!= s
->l1_table_offset
) {
1269 l1_table
= g_try_malloc0(l1_size2
);
1270 if (l1_size2
&& l1_table
== NULL
) {
1274 l1_allocated
= true;
1276 ret
= bdrv_pread(bs
->file
, l1_table_offset
, l1_size2
, l1_table
, 0);
1281 for (i
= 0; i
< l1_size
; i
++) {
1282 be64_to_cpus(&l1_table
[i
]);
1285 assert(l1_size
== s
->l1_size
);
1286 l1_table
= s
->l1_table
;
1287 l1_allocated
= false;
1290 for (i
= 0; i
< l1_size
; i
++) {
1291 l2_offset
= l1_table
[i
];
1293 old_l2_offset
= l2_offset
;
1294 l2_offset
&= L1E_OFFSET_MASK
;
1296 if (offset_into_cluster(s
, l2_offset
)) {
1297 qcow2_signal_corruption(bs
, true, -1, -1, "L2 table offset %#"
1298 PRIx64
" unaligned (L1 index: %#x)",
1304 for (slice
= 0; slice
< n_slices
; slice
++) {
1305 ret
= qcow2_cache_get(bs
, s
->l2_table_cache
,
1306 l2_offset
+ slice
* slice_size2
,
1307 (void **) &l2_slice
);
1312 for (j
= 0; j
< s
->l2_slice_size
; j
++) {
1313 uint64_t cluster_index
;
1316 entry
= get_l2_entry(s
, l2_slice
, j
);
1318 entry
&= ~QCOW_OFLAG_COPIED
;
1319 offset
= entry
& L2E_OFFSET_MASK
;
1321 switch (qcow2_get_cluster_type(bs
, entry
)) {
1322 case QCOW2_CLUSTER_COMPRESSED
:
1327 qcow2_parse_compressed_l2_entry(bs
, entry
,
1329 ret
= update_refcount(
1331 abs(addend
), addend
< 0,
1332 QCOW2_DISCARD_SNAPSHOT
);
1337 /* compressed clusters are never modified */
1341 case QCOW2_CLUSTER_NORMAL
:
1342 case QCOW2_CLUSTER_ZERO_ALLOC
:
1343 if (offset_into_cluster(s
, offset
)) {
1344 /* Here l2_index means table (not slice) index */
1345 int l2_index
= slice
* s
->l2_slice_size
+ j
;
1346 qcow2_signal_corruption(
1347 bs
, true, -1, -1, "Cluster "
1348 "allocation offset %#" PRIx64
1349 " unaligned (L2 offset: %#"
1350 PRIx64
", L2 index: %#x)",
1351 offset
, l2_offset
, l2_index
);
1356 cluster_index
= offset
>> s
->cluster_bits
;
1357 assert(cluster_index
);
1359 ret
= qcow2_update_cluster_refcount(
1360 bs
, cluster_index
, abs(addend
), addend
< 0,
1361 QCOW2_DISCARD_SNAPSHOT
);
1367 ret
= qcow2_get_refcount(bs
, cluster_index
, &refcount
);
1373 case QCOW2_CLUSTER_ZERO_PLAIN
:
1374 case QCOW2_CLUSTER_UNALLOCATED
:
1382 if (refcount
== 1) {
1383 entry
|= QCOW_OFLAG_COPIED
;
1385 if (entry
!= old_entry
) {
1387 qcow2_cache_set_dependency(bs
, s
->l2_table_cache
,
1388 s
->refcount_block_cache
);
1390 set_l2_entry(s
, l2_slice
, j
, entry
);
1391 qcow2_cache_entry_mark_dirty(s
->l2_table_cache
,
1396 qcow2_cache_put(s
->l2_table_cache
, (void **) &l2_slice
);
1400 ret
= qcow2_update_cluster_refcount(bs
, l2_offset
>>
1402 abs(addend
), addend
< 0,
1403 QCOW2_DISCARD_SNAPSHOT
);
1408 ret
= qcow2_get_refcount(bs
, l2_offset
>> s
->cluster_bits
,
1412 } else if (refcount
== 1) {
1413 l2_offset
|= QCOW_OFLAG_COPIED
;
1415 if (l2_offset
!= old_l2_offset
) {
1416 l1_table
[i
] = l2_offset
;
1422 ret
= bdrv_flush(bs
);
1425 qcow2_cache_put(s
->l2_table_cache
, (void **) &l2_slice
);
1428 s
->cache_discards
= false;
1429 qcow2_process_discards(bs
, ret
);
1431 /* Update L1 only if it isn't deleted anyway (addend = -1) */
1432 if (ret
== 0 && addend
>= 0 && l1_modified
) {
1433 for (i
= 0; i
< l1_size
; i
++) {
1434 cpu_to_be64s(&l1_table
[i
]);
1437 ret
= bdrv_pwrite_sync(bs
->file
, l1_table_offset
, l1_size2
, l1_table
,
1440 for (i
= 0; i
< l1_size
; i
++) {
1441 be64_to_cpus(&l1_table
[i
]);
1452 /*********************************************************/
1453 /* refcount checking functions */
1456 static uint64_t refcount_array_byte_size(BDRVQcow2State
*s
, uint64_t entries
)
1458 /* This assertion holds because there is no way we can address more than
1459 * 2^(64 - 9) clusters at once (with cluster size 512 = 2^9, and because
1460 * offsets have to be representable in bytes); due to every cluster
1461 * corresponding to one refcount entry, we are well below that limit */
1462 assert(entries
< (UINT64_C(1) << (64 - 9)));
1464 /* Thanks to the assertion this will not overflow, because
1465 * s->refcount_order < 7.
1466 * (note: x << s->refcount_order == x * s->refcount_bits) */
1467 return DIV_ROUND_UP(entries
<< s
->refcount_order
, 8);
1471 * Reallocates *array so that it can hold new_size entries. *size must contain
1472 * the current number of entries in *array. If the reallocation fails, *array
1473 * and *size will not be modified and -errno will be returned. If the
1474 * reallocation is successful, *array will be set to the new buffer, *size
1475 * will be set to new_size and 0 will be returned. The size of the reallocated
1476 * refcount array buffer will be aligned to a cluster boundary, and the newly
1477 * allocated area will be zeroed.
1479 static int realloc_refcount_array(BDRVQcow2State
*s
, void **array
,
1480 int64_t *size
, int64_t new_size
)
1482 int64_t old_byte_size
, new_byte_size
;
1485 /* Round to clusters so the array can be directly written to disk */
1486 old_byte_size
= size_to_clusters(s
, refcount_array_byte_size(s
, *size
))
1488 new_byte_size
= size_to_clusters(s
, refcount_array_byte_size(s
, new_size
))
1491 if (new_byte_size
== old_byte_size
) {
1496 assert(new_byte_size
> 0);
1498 if (new_byte_size
> SIZE_MAX
) {
1502 new_ptr
= g_try_realloc(*array
, new_byte_size
);
1507 if (new_byte_size
> old_byte_size
) {
1508 memset((char *)new_ptr
+ old_byte_size
, 0,
1509 new_byte_size
- old_byte_size
);
1519 * Increases the refcount for a range of clusters in a given refcount table.
1520 * This is used to construct a temporary refcount table out of L1 and L2 tables
1521 * which can be compared to the refcount table saved in the image.
1523 * Modifies the number of errors in res.
1525 int coroutine_fn GRAPH_RDLOCK
1526 qcow2_inc_refcounts_imrt(BlockDriverState
*bs
, BdrvCheckResult
*res
,
1527 void **refcount_table
,
1528 int64_t *refcount_table_size
,
1529 int64_t offset
, int64_t size
)
1531 BDRVQcow2State
*s
= bs
->opaque
;
1532 uint64_t start
, last
, cluster_offset
, k
, refcount
;
1540 file_len
= bdrv_co_getlength(bs
->file
->bs
);
1546 * Last cluster of qcow2 image may be semi-allocated, so it may be OK to
1547 * reference some space after file end but it should be less than one
1550 if (offset
+ size
- file_len
>= s
->cluster_size
) {
1551 fprintf(stderr
, "ERROR: counting reference for region exceeding the "
1552 "end of the file by one cluster or more: offset 0x%" PRIx64
1553 " size 0x%" PRIx64
"\n", offset
, size
);
1558 start
= start_of_cluster(s
, offset
);
1559 last
= start_of_cluster(s
, offset
+ size
- 1);
1560 for(cluster_offset
= start
; cluster_offset
<= last
;
1561 cluster_offset
+= s
->cluster_size
) {
1562 k
= cluster_offset
>> s
->cluster_bits
;
1563 if (k
>= *refcount_table_size
) {
1564 ret
= realloc_refcount_array(s
, refcount_table
,
1565 refcount_table_size
, k
+ 1);
1567 res
->check_errors
++;
1572 refcount
= s
->get_refcount(*refcount_table
, k
);
1573 if (refcount
== s
->refcount_max
) {
1574 fprintf(stderr
, "ERROR: overflow cluster offset=0x%" PRIx64
1575 "\n", cluster_offset
);
1576 fprintf(stderr
, "Use qemu-img amend to increase the refcount entry "
1577 "width or qemu-img convert to create a clean copy if the "
1578 "image cannot be opened for writing\n");
1582 s
->set_refcount(*refcount_table
, k
, refcount
+ 1);
1588 /* Flags for check_refcounts_l1() and check_refcounts_l2() */
1590 CHECK_FRAG_INFO
= 0x2, /* update BlockFragInfo counters */
1594 * Fix L2 entry by making it QCOW2_CLUSTER_ZERO_PLAIN (or making all its present
1595 * subclusters QCOW2_SUBCLUSTER_ZERO_PLAIN).
1597 * This function decrements res->corruptions on success, so the caller is
1598 * responsible to increment res->corruptions prior to the call.
1600 * On failure in-memory @l2_table may be modified.
1602 static int coroutine_fn GRAPH_RDLOCK
1603 fix_l2_entry_by_zero(BlockDriverState
*bs
, BdrvCheckResult
*res
,
1604 uint64_t l2_offset
, uint64_t *l2_table
,
1605 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_co_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 coroutine_fn GRAPH_RDLOCK
1663 check_refcounts_l2(BlockDriverState
*bs
, BdrvCheckResult
*res
,
1664 void **refcount_table
,
1665 int64_t *refcount_table_size
, int64_t l2_offset
,
1666 int flags
, BdrvCheckMode fix
, bool active
)
1668 BDRVQcow2State
*s
= bs
->opaque
;
1669 uint64_t l2_entry
, l2_bitmap
;
1670 uint64_t next_contiguous_offset
= 0;
1672 size_t l2_size_bytes
= s
->l2_size
* l2_entry_size(s
);
1673 g_autofree
uint64_t *l2_table
= g_malloc(l2_size_bytes
);
1674 bool metadata_overlap
;
1676 /* Read L2 table from disk */
1677 ret
= bdrv_co_pread(bs
->file
, l2_offset
, l2_size_bytes
, l2_table
, 0);
1679 fprintf(stderr
, "ERROR: I/O error in check_refcounts_l2\n");
1680 res
->check_errors
++;
1684 /* Do the actual checks */
1685 for (i
= 0; i
< s
->l2_size
; i
++) {
1688 QCow2ClusterType type
;
1690 l2_entry
= get_l2_entry(s
, l2_table
, i
);
1691 l2_bitmap
= get_l2_bitmap(s
, l2_table
, i
);
1692 type
= qcow2_get_cluster_type(bs
, l2_entry
);
1694 if (type
!= QCOW2_CLUSTER_COMPRESSED
) {
1695 /* Check reserved bits of Standard Cluster Descriptor */
1696 if (l2_entry
& L2E_STD_RESERVED_MASK
) {
1697 fprintf(stderr
, "ERROR found l2 entry with reserved bits set: "
1698 "%" PRIx64
"\n", l2_entry
);
1704 case QCOW2_CLUSTER_COMPRESSED
:
1705 /* Compressed clusters don't have QCOW_OFLAG_COPIED */
1706 if (l2_entry
& QCOW_OFLAG_COPIED
) {
1707 fprintf(stderr
, "ERROR: coffset=0x%" PRIx64
": "
1708 "copied flag must never be set for compressed "
1709 "clusters\n", l2_entry
& s
->cluster_offset_mask
);
1710 l2_entry
&= ~QCOW_OFLAG_COPIED
;
1714 if (has_data_file(bs
)) {
1715 fprintf(stderr
, "ERROR compressed cluster %d with data file, "
1716 "entry=0x%" PRIx64
"\n", i
, l2_entry
);
1722 fprintf(stderr
, "ERROR compressed cluster %d with non-zero "
1723 "subcluster allocation bitmap, entry=0x%" PRIx64
"\n",
1729 /* Mark cluster as used */
1730 qcow2_parse_compressed_l2_entry(bs
, l2_entry
, &coffset
, &csize
);
1731 ret
= qcow2_inc_refcounts_imrt(
1732 bs
, res
, refcount_table
, refcount_table_size
, coffset
, csize
);
1737 if (flags
& CHECK_FRAG_INFO
) {
1738 res
->bfi
.allocated_clusters
++;
1739 res
->bfi
.compressed_clusters
++;
1742 * Compressed clusters are fragmented by nature. Since they
1743 * take up sub-sector space but we only have sector granularity
1744 * I/O we need to re-read the same sectors even for adjacent
1745 * compressed clusters.
1747 res
->bfi
.fragmented_clusters
++;
1751 case QCOW2_CLUSTER_ZERO_ALLOC
:
1752 case QCOW2_CLUSTER_NORMAL
:
1754 uint64_t offset
= l2_entry
& L2E_OFFSET_MASK
;
1756 if ((l2_bitmap
>> 32) & l2_bitmap
) {
1758 fprintf(stderr
, "ERROR offset=%" PRIx64
": Allocated "
1759 "cluster has corrupted subcluster allocation bitmap\n",
1763 /* Correct offsets are cluster aligned */
1764 if (offset_into_cluster(s
, offset
)) {
1768 if (has_subclusters(s
)) {
1769 contains_data
= (l2_bitmap
& QCOW_L2_BITMAP_ALL_ALLOC
);
1771 contains_data
= !(l2_entry
& QCOW_OFLAG_ZERO
);
1774 if (!contains_data
) {
1775 fprintf(stderr
, "%s offset=%" PRIx64
": Preallocated "
1776 "cluster is not properly aligned; L2 entry "
1778 fix
& BDRV_FIX_ERRORS
? "Repairing" : "ERROR",
1780 if (fix
& BDRV_FIX_ERRORS
) {
1781 ret
= fix_l2_entry_by_zero(bs
, res
, l2_offset
,
1782 l2_table
, i
, active
,
1784 if (metadata_overlap
) {
1786 * Something is seriously wrong, so abort checking
1794 * Skip marking the cluster as used
1795 * (it is unused now).
1802 * Do not abort, continue checking the rest of this
1803 * L2 table's entries.
1807 fprintf(stderr
, "ERROR offset=%" PRIx64
": Data cluster is "
1808 "not properly aligned; L2 entry corrupted.\n", offset
);
1812 if (flags
& CHECK_FRAG_INFO
) {
1813 res
->bfi
.allocated_clusters
++;
1814 if (next_contiguous_offset
&&
1815 offset
!= next_contiguous_offset
) {
1816 res
->bfi
.fragmented_clusters
++;
1818 next_contiguous_offset
= offset
+ s
->cluster_size
;
1821 /* Mark cluster as used */
1822 if (!has_data_file(bs
)) {
1823 ret
= qcow2_inc_refcounts_imrt(bs
, res
, refcount_table
,
1824 refcount_table_size
,
1825 offset
, s
->cluster_size
);
1833 case QCOW2_CLUSTER_ZERO_PLAIN
:
1834 /* Impossible when image has subclusters */
1838 case QCOW2_CLUSTER_UNALLOCATED
:
1839 if (l2_bitmap
& QCOW_L2_BITMAP_ALL_ALLOC
) {
1841 fprintf(stderr
, "ERROR: Unallocated "
1842 "cluster has non-zero subcluster allocation map\n");
1855 * Increases the refcount for the L1 table, its L2 tables and all referenced
1856 * clusters in the given refcount table. While doing so, performs some checks
1857 * on L1 and L2 entries.
1859 * Returns the number of errors found by the checks or -errno if an internal
1862 static int coroutine_fn GRAPH_RDLOCK
1863 check_refcounts_l1(BlockDriverState
*bs
, BdrvCheckResult
*res
,
1864 void **refcount_table
, 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_co_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 coroutine_fn GRAPH_RDLOCK
1953 check_oflag_copied(BlockDriverState
*bs
, BdrvCheckResult
*res
, BdrvCheckMode fix
)
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_co_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_co_pwrite(bs
->file
, l2_offset
, s
->cluster_size
, l2_table
, 0);
2064 fprintf(stderr
, "ERROR: Could not write L2 table: %s\n",
2066 res
->check_errors
++;
2069 res
->corruptions
-= l2_dirty
;
2070 res
->corruptions_fixed
+= l2_dirty
;
2077 qemu_vfree(l2_table
);
2082 * Checks consistency of refblocks and accounts for each refblock in
2085 static int coroutine_fn GRAPH_RDLOCK
2086 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_co_truncate(bs
->file
, offset
+ s
->cluster_size
, false,
2131 PREALLOC_MODE_OFF
, 0, &local_err
);
2133 error_report_err(local_err
);
2136 size
= bdrv_co_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 coroutine_fn GRAPH_RDLOCK
2201 calculate_refcounts(BlockDriverState
*bs
, BdrvCheckResult
*res
,
2202 BdrvCheckMode fix
, bool *rebuild
,
2203 void **refcount_table
, int64_t *nb_clusters
)
2205 BDRVQcow2State
*s
= bs
->opaque
;
2210 if (!*refcount_table
) {
2211 int64_t old_size
= 0;
2212 ret
= realloc_refcount_array(s
, refcount_table
,
2213 &old_size
, *nb_clusters
);
2215 res
->check_errors
++;
2221 ret
= qcow2_inc_refcounts_imrt(bs
, res
, refcount_table
, nb_clusters
,
2222 0, s
->cluster_size
);
2227 /* current L1 table */
2228 ret
= check_refcounts_l1(bs
, res
, refcount_table
, nb_clusters
,
2229 s
->l1_table_offset
, s
->l1_size
, CHECK_FRAG_INFO
,
2236 if (has_data_file(bs
) && s
->nb_snapshots
) {
2237 fprintf(stderr
, "ERROR %d snapshots in image with data file\n",
2242 for (i
= 0; i
< s
->nb_snapshots
; i
++) {
2243 sn
= s
->snapshots
+ i
;
2244 if (offset_into_cluster(s
, sn
->l1_table_offset
)) {
2245 fprintf(stderr
, "ERROR snapshot %s (%s) l1_offset=%#" PRIx64
": "
2246 "L1 table is not cluster aligned; snapshot table entry "
2247 "corrupted\n", sn
->id_str
, sn
->name
, sn
->l1_table_offset
);
2251 if (sn
->l1_size
> QCOW_MAX_L1_SIZE
/ L1E_SIZE
) {
2252 fprintf(stderr
, "ERROR snapshot %s (%s) l1_size=%#" PRIx32
": "
2253 "L1 table is too large; snapshot table entry corrupted\n",
2254 sn
->id_str
, sn
->name
, sn
->l1_size
);
2258 ret
= check_refcounts_l1(bs
, res
, refcount_table
, nb_clusters
,
2259 sn
->l1_table_offset
, sn
->l1_size
, 0, fix
,
2265 ret
= qcow2_inc_refcounts_imrt(bs
, res
, refcount_table
, nb_clusters
,
2266 s
->snapshots_offset
, s
->snapshots_size
);
2272 ret
= qcow2_inc_refcounts_imrt(bs
, res
, refcount_table
, nb_clusters
,
2273 s
->refcount_table_offset
,
2274 s
->refcount_table_size
*
2275 REFTABLE_ENTRY_SIZE
);
2281 if (s
->crypto_header
.length
) {
2282 ret
= qcow2_inc_refcounts_imrt(bs
, res
, refcount_table
, nb_clusters
,
2283 s
->crypto_header
.offset
,
2284 s
->crypto_header
.length
);
2291 ret
= qcow2_check_bitmaps_refcounts(bs
, res
, refcount_table
, nb_clusters
);
2296 return check_refblocks(bs
, res
, fix
, rebuild
, refcount_table
, nb_clusters
);
2300 * Compares the actual reference count for each cluster in the image against the
2301 * refcount as reported by the refcount structures on-disk.
2303 static void coroutine_fn GRAPH_RDLOCK
2304 compare_refcounts(BlockDriverState
*bs
, BdrvCheckResult
*res
,
2305 BdrvCheckMode fix
, bool *rebuild
,
2306 int64_t *highest_cluster
,
2307 void *refcount_table
, int64_t nb_clusters
)
2309 BDRVQcow2State
*s
= bs
->opaque
;
2311 uint64_t refcount1
, refcount2
;
2314 for (i
= 0, *highest_cluster
= 0; i
< nb_clusters
; i
++) {
2315 ret
= qcow2_get_refcount(bs
, i
, &refcount1
);
2317 fprintf(stderr
, "Can't get refcount for cluster %" PRId64
": %s\n",
2319 res
->check_errors
++;
2323 refcount2
= s
->get_refcount(refcount_table
, i
);
2325 if (refcount1
> 0 || refcount2
> 0) {
2326 *highest_cluster
= i
;
2329 if (refcount1
!= refcount2
) {
2330 /* Check if we're allowed to fix the mismatch */
2331 int *num_fixed
= NULL
;
2332 if (refcount1
== 0) {
2334 } else if (refcount1
> refcount2
&& (fix
& BDRV_FIX_LEAKS
)) {
2335 num_fixed
= &res
->leaks_fixed
;
2336 } else if (refcount1
< refcount2
&& (fix
& BDRV_FIX_ERRORS
)) {
2337 num_fixed
= &res
->corruptions_fixed
;
2340 fprintf(stderr
, "%s cluster %" PRId64
" refcount=%" PRIu64
2341 " reference=%" PRIu64
"\n",
2342 num_fixed
!= NULL
? "Repairing" :
2343 refcount1
< refcount2
? "ERROR" :
2345 i
, refcount1
, refcount2
);
2348 ret
= update_refcount(bs
, i
<< s
->cluster_bits
, 1,
2349 refcount_diff(refcount1
, refcount2
),
2350 refcount1
> refcount2
,
2351 QCOW2_DISCARD_ALWAYS
);
2358 /* And if we couldn't, print an error */
2359 if (refcount1
< refcount2
) {
2369 * Allocates clusters using an in-memory refcount table (IMRT) in contrast to
2370 * the on-disk refcount structures.
2372 * On input, *first_free_cluster tells where to start looking, and need not
2373 * actually be a free cluster; the returned offset will not be before that
2374 * cluster. On output, *first_free_cluster points to the first gap found, even
2375 * if that gap was too small to be used as the returned offset.
2377 * Note that *first_free_cluster is a cluster index whereas the return value is
2380 static int64_t alloc_clusters_imrt(BlockDriverState
*bs
,
2382 void **refcount_table
,
2383 int64_t *imrt_nb_clusters
,
2384 int64_t *first_free_cluster
)
2386 BDRVQcow2State
*s
= bs
->opaque
;
2387 int64_t cluster
= *first_free_cluster
, i
;
2388 bool first_gap
= true;
2389 int contiguous_free_clusters
;
2392 /* Starting at *first_free_cluster, find a range of at least cluster_count
2393 * continuously free clusters */
2394 for (contiguous_free_clusters
= 0;
2395 cluster
< *imrt_nb_clusters
&&
2396 contiguous_free_clusters
< cluster_count
;
2399 if (!s
->get_refcount(*refcount_table
, cluster
)) {
2400 contiguous_free_clusters
++;
2402 /* If this is the first free cluster found, update
2403 * *first_free_cluster accordingly */
2404 *first_free_cluster
= cluster
;
2407 } else if (contiguous_free_clusters
) {
2408 contiguous_free_clusters
= 0;
2412 /* If contiguous_free_clusters is greater than zero, it contains the number
2413 * of continuously free clusters until the current cluster; the first free
2414 * cluster in the current "gap" is therefore
2415 * cluster - contiguous_free_clusters */
2417 /* If no such range could be found, grow the in-memory refcount table
2418 * accordingly to append free clusters at the end of the image */
2419 if (contiguous_free_clusters
< cluster_count
) {
2420 /* contiguous_free_clusters clusters are already empty at the image end;
2421 * we need cluster_count clusters; therefore, we have to allocate
2422 * cluster_count - contiguous_free_clusters new clusters at the end of
2423 * the image (which is the current value of cluster; note that cluster
2424 * may exceed old_imrt_nb_clusters if *first_free_cluster pointed beyond
2426 ret
= realloc_refcount_array(s
, refcount_table
, imrt_nb_clusters
,
2427 cluster
+ cluster_count
2428 - contiguous_free_clusters
);
2434 /* Go back to the first free cluster */
2435 cluster
-= contiguous_free_clusters
;
2436 for (i
= 0; i
< cluster_count
; i
++) {
2437 s
->set_refcount(*refcount_table
, cluster
+ i
, 1);
2440 return cluster
<< s
->cluster_bits
;
2444 * Helper function for rebuild_refcount_structure().
2446 * Scan the range of clusters [first_cluster, end_cluster) for allocated
2447 * clusters and write all corresponding refblocks to disk. The refblock
2448 * and allocation data is taken from the in-memory refcount table
2449 * *refcount_table[] (of size *nb_clusters), which is basically one big
2450 * (unlimited size) refblock for the whole image.
2452 * For these refblocks, clusters are allocated using said in-memory
2453 * refcount table. Care is taken that these allocations are reflected
2454 * in the refblocks written to disk.
2456 * The refblocks' offsets are written into a reftable, which is
2457 * *on_disk_reftable_ptr[] (of size *on_disk_reftable_entries_ptr). If
2458 * that reftable is of insufficient size, it will be resized to fit.
2459 * This reftable is not written to disk.
2461 * (If *on_disk_reftable_ptr is not NULL, the entries within are assumed
2462 * to point to existing valid refblocks that do not need to be allocated
2465 * Return whether the on-disk reftable array was resized (true/false),
2466 * or -errno on error.
2468 static int coroutine_fn GRAPH_RDLOCK
2469 rebuild_refcounts_write_refblocks(
2470 BlockDriverState
*bs
, void **refcount_table
, int64_t *nb_clusters
,
2471 int64_t first_cluster
, int64_t end_cluster
,
2472 uint64_t **on_disk_reftable_ptr
, uint32_t *on_disk_reftable_entries_ptr
,
2476 BDRVQcow2State
*s
= bs
->opaque
;
2478 int64_t refblock_offset
, refblock_start
, refblock_index
;
2479 int64_t first_free_cluster
= 0;
2480 uint64_t *on_disk_reftable
= *on_disk_reftable_ptr
;
2481 uint32_t on_disk_reftable_entries
= *on_disk_reftable_entries_ptr
;
2482 void *on_disk_refblock
;
2483 bool reftable_grown
= false;
2486 for (cluster
= first_cluster
; cluster
< end_cluster
; cluster
++) {
2487 /* Check all clusters to find refblocks that contain non-zero entries */
2488 if (!s
->get_refcount(*refcount_table
, cluster
)) {
2493 * This cluster is allocated, so we need to create a refblock
2494 * for it. The data we will write to disk is just the
2495 * respective slice from *refcount_table, so it will contain
2496 * accurate refcounts for all clusters belonging to this
2497 * refblock. After we have written it, we will therefore skip
2498 * all remaining clusters in this refblock.
2501 refblock_index
= cluster
>> s
->refcount_block_bits
;
2502 refblock_start
= refblock_index
<< s
->refcount_block_bits
;
2504 if (on_disk_reftable_entries
> refblock_index
&&
2505 on_disk_reftable
[refblock_index
])
2508 * We can get here after a `goto write_refblocks`: We have a
2509 * reftable from a previous run, and the refblock is already
2510 * allocated. No need to allocate it again.
2512 refblock_offset
= on_disk_reftable
[refblock_index
];
2514 int64_t refblock_cluster_index
;
2516 /* Don't allocate a cluster in a refblock already written to disk */
2517 if (first_free_cluster
< refblock_start
) {
2518 first_free_cluster
= refblock_start
;
2520 refblock_offset
= alloc_clusters_imrt(bs
, 1, refcount_table
,
2522 &first_free_cluster
);
2523 if (refblock_offset
< 0) {
2524 error_setg_errno(errp
, -refblock_offset
,
2525 "ERROR allocating refblock");
2526 return refblock_offset
;
2529 refblock_cluster_index
= refblock_offset
/ s
->cluster_size
;
2530 if (refblock_cluster_index
>= end_cluster
) {
2532 * We must write the refblock that holds this refblock's
2535 end_cluster
= refblock_cluster_index
+ 1;
2538 if (on_disk_reftable_entries
<= refblock_index
) {
2539 on_disk_reftable_entries
=
2540 ROUND_UP((refblock_index
+ 1) * REFTABLE_ENTRY_SIZE
,
2541 s
->cluster_size
) / REFTABLE_ENTRY_SIZE
;
2543 g_try_realloc(on_disk_reftable
,
2544 on_disk_reftable_entries
*
2545 REFTABLE_ENTRY_SIZE
);
2546 if (!on_disk_reftable
) {
2547 error_setg(errp
, "ERROR allocating reftable memory");
2551 memset(on_disk_reftable
+ *on_disk_reftable_entries_ptr
, 0,
2552 (on_disk_reftable_entries
-
2553 *on_disk_reftable_entries_ptr
) *
2554 REFTABLE_ENTRY_SIZE
);
2556 *on_disk_reftable_ptr
= on_disk_reftable
;
2557 *on_disk_reftable_entries_ptr
= on_disk_reftable_entries
;
2559 reftable_grown
= true;
2561 assert(on_disk_reftable
);
2563 on_disk_reftable
[refblock_index
] = refblock_offset
;
2566 /* Refblock is allocated, write it to disk */
2568 ret
= qcow2_pre_write_overlap_check(bs
, 0, refblock_offset
,
2569 s
->cluster_size
, false);
2571 error_setg_errno(errp
, -ret
, "ERROR writing refblock");
2576 * The refblock is simply a slice of *refcount_table.
2577 * Note that the size of *refcount_table is always aligned to
2578 * whole clusters, so the write operation will not result in
2579 * out-of-bounds accesses.
2581 on_disk_refblock
= (void *)((char *) *refcount_table
+
2582 refblock_index
* s
->cluster_size
);
2584 ret
= bdrv_co_pwrite(bs
->file
, refblock_offset
, s
->cluster_size
,
2585 on_disk_refblock
, 0);
2587 error_setg_errno(errp
, -ret
, "ERROR writing refblock");
2591 /* This refblock is done, skip to its end */
2592 cluster
= refblock_start
+ s
->refcount_block_size
- 1;
2595 return reftable_grown
;
2599 * Creates a new refcount structure based solely on the in-memory information
2600 * given through *refcount_table (this in-memory information is basically just
2601 * the concatenation of all refblocks). All necessary allocations will be
2602 * reflected in that array.
2604 * On success, the old refcount structure is leaked (it will be covered by the
2605 * new refcount structure).
2607 static int coroutine_fn GRAPH_RDLOCK
2608 rebuild_refcount_structure(BlockDriverState
*bs
, BdrvCheckResult
*res
,
2609 void **refcount_table
, int64_t *nb_clusters
,
2612 BDRVQcow2State
*s
= bs
->opaque
;
2613 int64_t reftable_offset
= -1;
2614 int64_t reftable_length
= 0;
2615 int64_t reftable_clusters
;
2616 int64_t refblock_index
;
2617 uint32_t on_disk_reftable_entries
= 0;
2618 uint64_t *on_disk_reftable
= NULL
;
2620 int reftable_size_changed
= 0;
2622 uint64_t reftable_offset
;
2623 uint32_t reftable_clusters
;
2624 } QEMU_PACKED reftable_offset_and_clusters
;
2626 qcow2_cache_empty(bs
, s
->refcount_block_cache
);
2629 * For each refblock containing entries, we try to allocate a
2630 * cluster (in the in-memory refcount table) and write its offset
2631 * into on_disk_reftable[]. We then write the whole refblock to
2632 * disk (as a slice of the in-memory refcount table).
2633 * This is done by rebuild_refcounts_write_refblocks().
2635 * Once we have scanned all clusters, we try to find space for the
2636 * reftable. This will dirty the in-memory refcount table (i.e.
2637 * make it differ from the refblocks we have already written), so we
2638 * need to run rebuild_refcounts_write_refblocks() again for the
2639 * range of clusters where the reftable has been allocated.
2641 * This second run might make the reftable grow again, in which case
2642 * we will need to allocate another space for it, which is why we
2643 * repeat all this until the reftable stops growing.
2645 * (This loop will terminate, because with every cluster the
2646 * reftable grows, it can accommodate a multitude of more refcounts,
2647 * so that at some point this must be able to cover the reftable
2648 * and all refblocks describing it.)
2650 * We then convert the reftable to big-endian and write it to disk.
2652 * Note that we never free any reftable allocations. Doing so would
2653 * needlessly complicate the algorithm: The eventual second check
2654 * run we do will clean up all leaks we have caused.
2657 reftable_size_changed
=
2658 rebuild_refcounts_write_refblocks(bs
, refcount_table
, nb_clusters
,
2661 &on_disk_reftable_entries
, errp
);
2662 if (reftable_size_changed
< 0) {
2663 res
->check_errors
++;
2664 ret
= reftable_size_changed
;
2669 * There was no reftable before, so rebuild_refcounts_write_refblocks()
2670 * must have increased its size (from 0 to something).
2672 assert(reftable_size_changed
);
2675 int64_t reftable_start_cluster
, reftable_end_cluster
;
2676 int64_t first_free_cluster
= 0;
2678 reftable_length
= on_disk_reftable_entries
* REFTABLE_ENTRY_SIZE
;
2679 reftable_clusters
= size_to_clusters(s
, reftable_length
);
2681 reftable_offset
= alloc_clusters_imrt(bs
, reftable_clusters
,
2682 refcount_table
, nb_clusters
,
2683 &first_free_cluster
);
2684 if (reftable_offset
< 0) {
2685 error_setg_errno(errp
, -reftable_offset
,
2686 "ERROR allocating reftable");
2687 res
->check_errors
++;
2688 ret
= reftable_offset
;
2693 * We need to update the affected refblocks, so re-run the
2694 * write_refblocks loop for the reftable's range of clusters.
2696 assert(offset_into_cluster(s
, reftable_offset
) == 0);
2697 reftable_start_cluster
= reftable_offset
/ s
->cluster_size
;
2698 reftable_end_cluster
= reftable_start_cluster
+ reftable_clusters
;
2699 reftable_size_changed
=
2700 rebuild_refcounts_write_refblocks(bs
, refcount_table
, nb_clusters
,
2701 reftable_start_cluster
,
2702 reftable_end_cluster
,
2704 &on_disk_reftable_entries
, errp
);
2705 if (reftable_size_changed
< 0) {
2706 res
->check_errors
++;
2707 ret
= reftable_size_changed
;
2712 * If the reftable size has changed, we will need to find a new
2713 * allocation, repeating the loop.
2715 } while (reftable_size_changed
);
2717 /* The above loop must have run at least once */
2718 assert(reftable_offset
>= 0);
2721 * All allocations are done, all refblocks are written, convert the
2722 * reftable to big-endian and write it to disk.
2725 for (refblock_index
= 0; refblock_index
< on_disk_reftable_entries
;
2728 cpu_to_be64s(&on_disk_reftable
[refblock_index
]);
2731 ret
= qcow2_pre_write_overlap_check(bs
, 0, reftable_offset
, reftable_length
,
2734 error_setg_errno(errp
, -ret
, "ERROR writing reftable");
2738 assert(reftable_length
< INT_MAX
);
2739 ret
= bdrv_co_pwrite(bs
->file
, reftable_offset
, reftable_length
,
2740 on_disk_reftable
, 0);
2742 error_setg_errno(errp
, -ret
, "ERROR writing reftable");
2746 /* Enter new reftable into the image header */
2747 reftable_offset_and_clusters
.reftable_offset
= cpu_to_be64(reftable_offset
);
2748 reftable_offset_and_clusters
.reftable_clusters
=
2749 cpu_to_be32(reftable_clusters
);
2750 ret
= bdrv_co_pwrite_sync(bs
->file
,
2751 offsetof(QCowHeader
, refcount_table_offset
),
2752 sizeof(reftable_offset_and_clusters
),
2753 &reftable_offset_and_clusters
, 0);
2755 error_setg_errno(errp
, -ret
, "ERROR setting reftable");
2759 for (refblock_index
= 0; refblock_index
< on_disk_reftable_entries
;
2762 be64_to_cpus(&on_disk_reftable
[refblock_index
]);
2764 s
->refcount_table
= on_disk_reftable
;
2765 s
->refcount_table_offset
= reftable_offset
;
2766 s
->refcount_table_size
= on_disk_reftable_entries
;
2767 update_max_refcount_table_index(s
);
2772 g_free(on_disk_reftable
);
2777 * Checks an image for refcount consistency.
2779 * Returns 0 if no errors are found, the number of errors in case the image is
2780 * detected as corrupted, and -errno when an internal error occurred.
2782 int coroutine_fn GRAPH_RDLOCK
2783 qcow2_check_refcounts(BlockDriverState
*bs
, BdrvCheckResult
*res
, BdrvCheckMode fix
)
2785 BDRVQcow2State
*s
= bs
->opaque
;
2786 BdrvCheckResult pre_compare_res
;
2787 int64_t size
, highest_cluster
, nb_clusters
;
2788 void *refcount_table
= NULL
;
2789 bool rebuild
= false;
2792 size
= bdrv_co_getlength(bs
->file
->bs
);
2794 res
->check_errors
++;
2798 nb_clusters
= size_to_clusters(s
, size
);
2799 if (nb_clusters
> INT_MAX
) {
2800 res
->check_errors
++;
2804 res
->bfi
.total_clusters
=
2805 size_to_clusters(s
, bs
->total_sectors
* BDRV_SECTOR_SIZE
);
2807 ret
= calculate_refcounts(bs
, res
, fix
, &rebuild
, &refcount_table
,
2813 /* In case we don't need to rebuild the refcount structure (but want to fix
2814 * something), this function is immediately called again, in which case the
2815 * result should be ignored */
2816 pre_compare_res
= *res
;
2817 compare_refcounts(bs
, res
, 0, &rebuild
, &highest_cluster
, refcount_table
,
2820 if (rebuild
&& (fix
& BDRV_FIX_ERRORS
)) {
2821 BdrvCheckResult old_res
= *res
;
2822 int fresh_leaks
= 0;
2823 Error
*local_err
= NULL
;
2825 fprintf(stderr
, "Rebuilding refcount structure\n");
2826 ret
= rebuild_refcount_structure(bs
, res
, &refcount_table
,
2827 &nb_clusters
, &local_err
);
2829 error_report_err(local_err
);
2833 res
->corruptions
= 0;
2836 /* Because the old reftable has been exchanged for a new one the
2837 * references have to be recalculated */
2839 memset(refcount_table
, 0, refcount_array_byte_size(s
, nb_clusters
));
2840 ret
= calculate_refcounts(bs
, res
, 0, &rebuild
, &refcount_table
,
2846 if (fix
& BDRV_FIX_LEAKS
) {
2847 /* The old refcount structures are now leaked, fix it; the result
2848 * can be ignored, aside from leaks which were introduced by
2849 * rebuild_refcount_structure() that could not be fixed */
2850 BdrvCheckResult saved_res
= *res
;
2851 *res
= (BdrvCheckResult
){ 0 };
2853 compare_refcounts(bs
, res
, BDRV_FIX_LEAKS
, &rebuild
,
2854 &highest_cluster
, refcount_table
, nb_clusters
);
2856 fprintf(stderr
, "ERROR rebuilt refcount structure is still "
2860 /* Any leaks accounted for here were introduced by
2861 * rebuild_refcount_structure() because that function has created a
2862 * new refcount structure from scratch */
2863 fresh_leaks
= res
->leaks
;
2867 if (res
->corruptions
< old_res
.corruptions
) {
2868 res
->corruptions_fixed
+= old_res
.corruptions
- res
->corruptions
;
2870 if (res
->leaks
< old_res
.leaks
) {
2871 res
->leaks_fixed
+= old_res
.leaks
- res
->leaks
;
2873 res
->leaks
+= fresh_leaks
;
2876 fprintf(stderr
, "ERROR need to rebuild refcount structures\n");
2877 res
->check_errors
++;
2882 if (res
->leaks
|| res
->corruptions
) {
2883 *res
= pre_compare_res
;
2884 compare_refcounts(bs
, res
, fix
, &rebuild
, &highest_cluster
,
2885 refcount_table
, nb_clusters
);
2889 /* check OFLAG_COPIED */
2890 ret
= check_oflag_copied(bs
, res
, fix
);
2895 res
->image_end_offset
= (highest_cluster
+ 1) * s
->cluster_size
;
2899 g_free(refcount_table
);
2904 #define overlaps_with(ofs, sz) \
2905 ranges_overlap(offset, size, ofs, sz)
2908 * Checks if the given offset into the image file is actually free to use by
2909 * looking for overlaps with important metadata sections (L1/L2 tables etc.),
2910 * i.e. a sanity check without relying on the refcount tables.
2912 * The ign parameter specifies what checks not to perform (being a bitmask of
2913 * QCow2MetadataOverlap values), i.e., what sections to ignore.
2916 * - 0 if writing to this offset will not affect the mentioned metadata
2917 * - a positive QCow2MetadataOverlap value indicating one overlapping section
2918 * - a negative value (-errno) indicating an error while performing a check,
2919 * e.g. when bdrv_pread failed on QCOW2_OL_INACTIVE_L2
2921 int qcow2_check_metadata_overlap(BlockDriverState
*bs
, int ign
, int64_t offset
,
2924 BDRVQcow2State
*s
= bs
->opaque
;
2925 int chk
= s
->overlap_check
& ~ign
;
2932 if (chk
& QCOW2_OL_MAIN_HEADER
) {
2933 if (offset
< s
->cluster_size
) {
2934 return QCOW2_OL_MAIN_HEADER
;
2938 /* align range to test to cluster boundaries */
2939 size
= ROUND_UP(offset_into_cluster(s
, offset
) + size
, s
->cluster_size
);
2940 offset
= start_of_cluster(s
, offset
);
2942 if ((chk
& QCOW2_OL_ACTIVE_L1
) && s
->l1_size
) {
2943 if (overlaps_with(s
->l1_table_offset
, s
->l1_size
* L1E_SIZE
)) {
2944 return QCOW2_OL_ACTIVE_L1
;
2948 if ((chk
& QCOW2_OL_REFCOUNT_TABLE
) && s
->refcount_table_size
) {
2949 if (overlaps_with(s
->refcount_table_offset
,
2950 s
->refcount_table_size
* REFTABLE_ENTRY_SIZE
)) {
2951 return QCOW2_OL_REFCOUNT_TABLE
;
2955 if ((chk
& QCOW2_OL_SNAPSHOT_TABLE
) && s
->snapshots_size
) {
2956 if (overlaps_with(s
->snapshots_offset
, s
->snapshots_size
)) {
2957 return QCOW2_OL_SNAPSHOT_TABLE
;
2961 if ((chk
& QCOW2_OL_INACTIVE_L1
) && s
->snapshots
) {
2962 for (i
= 0; i
< s
->nb_snapshots
; i
++) {
2963 if (s
->snapshots
[i
].l1_size
&&
2964 overlaps_with(s
->snapshots
[i
].l1_table_offset
,
2965 s
->snapshots
[i
].l1_size
* L1E_SIZE
)) {
2966 return QCOW2_OL_INACTIVE_L1
;
2971 if ((chk
& QCOW2_OL_ACTIVE_L2
) && s
->l1_table
) {
2972 for (i
= 0; i
< s
->l1_size
; i
++) {
2973 if ((s
->l1_table
[i
] & L1E_OFFSET_MASK
) &&
2974 overlaps_with(s
->l1_table
[i
] & L1E_OFFSET_MASK
,
2976 return QCOW2_OL_ACTIVE_L2
;
2981 if ((chk
& QCOW2_OL_REFCOUNT_BLOCK
) && s
->refcount_table
) {
2982 unsigned last_entry
= s
->max_refcount_table_index
;
2983 assert(last_entry
< s
->refcount_table_size
);
2984 assert(last_entry
+ 1 == s
->refcount_table_size
||
2985 (s
->refcount_table
[last_entry
+ 1] & REFT_OFFSET_MASK
) == 0);
2986 for (i
= 0; i
<= last_entry
; i
++) {
2987 if ((s
->refcount_table
[i
] & REFT_OFFSET_MASK
) &&
2988 overlaps_with(s
->refcount_table
[i
] & REFT_OFFSET_MASK
,
2990 return QCOW2_OL_REFCOUNT_BLOCK
;
2995 if ((chk
& QCOW2_OL_INACTIVE_L2
) && s
->snapshots
) {
2996 for (i
= 0; i
< s
->nb_snapshots
; i
++) {
2997 uint64_t l1_ofs
= s
->snapshots
[i
].l1_table_offset
;
2998 uint32_t l1_sz
= s
->snapshots
[i
].l1_size
;
2999 uint64_t l1_sz2
= l1_sz
* L1E_SIZE
;
3003 ret
= qcow2_validate_table(bs
, l1_ofs
, l1_sz
, L1E_SIZE
,
3004 QCOW_MAX_L1_SIZE
, "", NULL
);
3009 l1
= g_try_malloc(l1_sz2
);
3011 if (l1_sz2
&& l1
== NULL
) {
3015 ret
= bdrv_pread(bs
->file
, l1_ofs
, l1_sz2
, l1
, 0);
3021 for (j
= 0; j
< l1_sz
; j
++) {
3022 uint64_t l2_ofs
= be64_to_cpu(l1
[j
]) & L1E_OFFSET_MASK
;
3023 if (l2_ofs
&& overlaps_with(l2_ofs
, s
->cluster_size
)) {
3025 return QCOW2_OL_INACTIVE_L2
;
3033 if ((chk
& QCOW2_OL_BITMAP_DIRECTORY
) &&
3034 (s
->autoclear_features
& QCOW2_AUTOCLEAR_BITMAPS
))
3036 if (overlaps_with(s
->bitmap_directory_offset
,
3037 s
->bitmap_directory_size
))
3039 return QCOW2_OL_BITMAP_DIRECTORY
;
3046 static const char *metadata_ol_names
[] = {
3047 [QCOW2_OL_MAIN_HEADER_BITNR
] = "qcow2_header",
3048 [QCOW2_OL_ACTIVE_L1_BITNR
] = "active L1 table",
3049 [QCOW2_OL_ACTIVE_L2_BITNR
] = "active L2 table",
3050 [QCOW2_OL_REFCOUNT_TABLE_BITNR
] = "refcount table",
3051 [QCOW2_OL_REFCOUNT_BLOCK_BITNR
] = "refcount block",
3052 [QCOW2_OL_SNAPSHOT_TABLE_BITNR
] = "snapshot table",
3053 [QCOW2_OL_INACTIVE_L1_BITNR
] = "inactive L1 table",
3054 [QCOW2_OL_INACTIVE_L2_BITNR
] = "inactive L2 table",
3055 [QCOW2_OL_BITMAP_DIRECTORY_BITNR
] = "bitmap directory",
3057 QEMU_BUILD_BUG_ON(QCOW2_OL_MAX_BITNR
!= ARRAY_SIZE(metadata_ol_names
));
3060 * First performs a check for metadata overlaps (through
3061 * qcow2_check_metadata_overlap); if that fails with a negative value (error
3062 * while performing a check), that value is returned. If an impending overlap
3063 * is detected, the BDS will be made unusable, the qcow2 file marked corrupt
3064 * and -EIO returned.
3066 * Returns 0 if there were neither overlaps nor errors while checking for
3067 * overlaps; or a negative value (-errno) on error.
3069 int qcow2_pre_write_overlap_check(BlockDriverState
*bs
, int ign
, int64_t offset
,
3070 int64_t size
, bool data_file
)
3074 if (data_file
&& has_data_file(bs
)) {
3078 ret
= qcow2_check_metadata_overlap(bs
, ign
, offset
, size
);
3081 } else if (ret
> 0) {
3082 int metadata_ol_bitnr
= ctz32(ret
);
3083 assert(metadata_ol_bitnr
< QCOW2_OL_MAX_BITNR
);
3085 qcow2_signal_corruption(bs
, true, offset
, size
, "Preventing invalid "
3086 "write on metadata (overlaps with %s)",
3087 metadata_ol_names
[metadata_ol_bitnr
]);
3094 /* A pointer to a function of this type is given to walk_over_reftable(). That
3095 * function will create refblocks and pass them to a RefblockFinishOp once they
3096 * are completed (@refblock). @refblock_empty is set if the refblock is
3099 * Along with the refblock, a corresponding reftable entry is passed, in the
3100 * reftable @reftable (which may be reallocated) at @reftable_index.
3102 * @allocated should be set to true if a new cluster has been allocated.
3104 typedef int /* GRAPH_RDLOCK_PTR */
3105 (RefblockFinishOp
)(BlockDriverState
*bs
, uint64_t **reftable
,
3106 uint64_t reftable_index
, uint64_t *reftable_size
,
3107 void *refblock
, bool refblock_empty
,
3108 bool *allocated
, Error
**errp
);
3111 * This "operation" for walk_over_reftable() allocates the refblock on disk (if
3112 * it is not empty) and inserts its offset into the new reftable. The size of
3113 * this new reftable is increased as required.
3115 static int GRAPH_RDLOCK
3116 alloc_refblock(BlockDriverState
*bs
, uint64_t **reftable
,
3117 uint64_t reftable_index
, uint64_t *reftable_size
,
3118 void *refblock
, bool refblock_empty
, bool *allocated
,
3121 BDRVQcow2State
*s
= bs
->opaque
;
3124 if (!refblock_empty
&& reftable_index
>= *reftable_size
) {
3125 uint64_t *new_reftable
;
3126 uint64_t new_reftable_size
;
3128 new_reftable_size
= ROUND_UP(reftable_index
+ 1,
3129 s
->cluster_size
/ REFTABLE_ENTRY_SIZE
);
3130 if (new_reftable_size
> QCOW_MAX_REFTABLE_SIZE
/ REFTABLE_ENTRY_SIZE
) {
3132 "This operation would make the refcount table grow "
3133 "beyond the maximum size supported by QEMU, aborting");
3137 new_reftable
= g_try_realloc(*reftable
, new_reftable_size
*
3138 REFTABLE_ENTRY_SIZE
);
3139 if (!new_reftable
) {
3140 error_setg(errp
, "Failed to increase reftable buffer size");
3144 memset(new_reftable
+ *reftable_size
, 0,
3145 (new_reftable_size
- *reftable_size
) * REFTABLE_ENTRY_SIZE
);
3147 *reftable
= new_reftable
;
3148 *reftable_size
= new_reftable_size
;
3151 if (!refblock_empty
&& !(*reftable
)[reftable_index
]) {
3152 offset
= qcow2_alloc_clusters(bs
, s
->cluster_size
);
3154 error_setg_errno(errp
, -offset
, "Failed to allocate refblock");
3157 (*reftable
)[reftable_index
] = offset
;
3165 * This "operation" for walk_over_reftable() writes the refblock to disk at the
3166 * offset specified by the new reftable's entry. It does not modify the new
3167 * reftable or change any refcounts.
3169 static int GRAPH_RDLOCK
3170 flush_refblock(BlockDriverState
*bs
, uint64_t **reftable
,
3171 uint64_t reftable_index
, uint64_t *reftable_size
,
3172 void *refblock
, bool refblock_empty
, bool *allocated
,
3175 BDRVQcow2State
*s
= bs
->opaque
;
3179 if (reftable_index
< *reftable_size
&& (*reftable
)[reftable_index
]) {
3180 offset
= (*reftable
)[reftable_index
];
3182 ret
= qcow2_pre_write_overlap_check(bs
, 0, offset
, s
->cluster_size
,
3185 error_setg_errno(errp
, -ret
, "Overlap check failed");
3189 ret
= bdrv_pwrite(bs
->file
, offset
, s
->cluster_size
, refblock
, 0);
3191 error_setg_errno(errp
, -ret
, "Failed to write refblock");
3195 assert(refblock_empty
);
3202 * This function walks over the existing reftable and every referenced refblock;
3203 * if @new_set_refcount is non-NULL, it is called for every refcount entry to
3204 * create an equal new entry in the passed @new_refblock. Once that
3205 * @new_refblock is completely filled, @operation will be called.
3207 * @status_cb and @cb_opaque are used for the amend operation's status callback.
3208 * @index is the index of the walk_over_reftable() calls and @total is the total
3209 * number of walk_over_reftable() calls per amend operation. Both are used for
3210 * calculating the parameters for the status callback.
3212 * @allocated is set to true if a new cluster has been allocated.
3214 static int GRAPH_RDLOCK
3215 walk_over_reftable(BlockDriverState
*bs
, uint64_t **new_reftable
,
3216 uint64_t *new_reftable_index
,
3217 uint64_t *new_reftable_size
,
3218 void *new_refblock
, int new_refblock_size
,
3219 int new_refcount_bits
,
3220 RefblockFinishOp
*operation
, bool *allocated
,
3221 Qcow2SetRefcountFunc
*new_set_refcount
,
3222 BlockDriverAmendStatusCB
*status_cb
,
3223 void *cb_opaque
, int index
, int total
,
3226 BDRVQcow2State
*s
= bs
->opaque
;
3227 uint64_t reftable_index
;
3228 bool new_refblock_empty
= true;
3230 int new_refblock_index
= 0;
3233 for (reftable_index
= 0; reftable_index
< s
->refcount_table_size
;
3236 uint64_t refblock_offset
= s
->refcount_table
[reftable_index
]
3239 status_cb(bs
, (uint64_t)index
* s
->refcount_table_size
+ reftable_index
,
3240 (uint64_t)total
* s
->refcount_table_size
, cb_opaque
);
3242 if (refblock_offset
) {
3245 if (offset_into_cluster(s
, refblock_offset
)) {
3246 qcow2_signal_corruption(bs
, true, -1, -1, "Refblock offset %#"
3247 PRIx64
" unaligned (reftable index: %#"
3248 PRIx64
")", refblock_offset
,
3251 "Image is corrupt (unaligned refblock offset)");
3255 ret
= qcow2_cache_get(bs
, s
->refcount_block_cache
, refblock_offset
,
3258 error_setg_errno(errp
, -ret
, "Failed to retrieve refblock");
3262 for (refblock_index
= 0; refblock_index
< s
->refcount_block_size
;
3267 if (new_refblock_index
>= new_refblock_size
) {
3268 /* new_refblock is now complete */
3269 ret
= operation(bs
, new_reftable
, *new_reftable_index
,
3270 new_reftable_size
, new_refblock
,
3271 new_refblock_empty
, allocated
, errp
);
3273 qcow2_cache_put(s
->refcount_block_cache
, &refblock
);
3277 (*new_reftable_index
)++;
3278 new_refblock_index
= 0;
3279 new_refblock_empty
= true;
3282 refcount
= s
->get_refcount(refblock
, refblock_index
);
3283 if (new_refcount_bits
< 64 && refcount
>> new_refcount_bits
) {
3286 qcow2_cache_put(s
->refcount_block_cache
, &refblock
);
3288 offset
= ((reftable_index
<< s
->refcount_block_bits
)
3289 + refblock_index
) << s
->cluster_bits
;
3291 error_setg(errp
, "Cannot decrease refcount entry width to "
3292 "%i bits: Cluster at offset %#" PRIx64
" has a "
3293 "refcount of %" PRIu64
, new_refcount_bits
,
3298 if (new_set_refcount
) {
3299 new_set_refcount(new_refblock
, new_refblock_index
++,
3302 new_refblock_index
++;
3304 new_refblock_empty
= new_refblock_empty
&& refcount
== 0;
3307 qcow2_cache_put(s
->refcount_block_cache
, &refblock
);
3309 /* No refblock means every refcount is 0 */
3310 for (refblock_index
= 0; refblock_index
< s
->refcount_block_size
;
3313 if (new_refblock_index
>= new_refblock_size
) {
3314 /* new_refblock is now complete */
3315 ret
= operation(bs
, new_reftable
, *new_reftable_index
,
3316 new_reftable_size
, new_refblock
,
3317 new_refblock_empty
, allocated
, errp
);
3322 (*new_reftable_index
)++;
3323 new_refblock_index
= 0;
3324 new_refblock_empty
= true;
3327 if (new_set_refcount
) {
3328 new_set_refcount(new_refblock
, new_refblock_index
++, 0);
3330 new_refblock_index
++;
3336 if (new_refblock_index
> 0) {
3337 /* Complete the potentially existing partially filled final refblock */
3338 if (new_set_refcount
) {
3339 for (; new_refblock_index
< new_refblock_size
;
3340 new_refblock_index
++)
3342 new_set_refcount(new_refblock
, new_refblock_index
, 0);
3346 ret
= operation(bs
, new_reftable
, *new_reftable_index
,
3347 new_reftable_size
, new_refblock
, new_refblock_empty
,
3353 (*new_reftable_index
)++;
3356 status_cb(bs
, (uint64_t)(index
+ 1) * s
->refcount_table_size
,
3357 (uint64_t)total
* s
->refcount_table_size
, cb_opaque
);
3362 int qcow2_change_refcount_order(BlockDriverState
*bs
, int refcount_order
,
3363 BlockDriverAmendStatusCB
*status_cb
,
3364 void *cb_opaque
, Error
**errp
)
3366 BDRVQcow2State
*s
= bs
->opaque
;
3367 Qcow2GetRefcountFunc
*new_get_refcount
;
3368 Qcow2SetRefcountFunc
*new_set_refcount
;
3369 void *new_refblock
= qemu_blockalign(bs
->file
->bs
, s
->cluster_size
);
3370 uint64_t *new_reftable
= NULL
, new_reftable_size
= 0;
3371 uint64_t *old_reftable
, old_reftable_size
, old_reftable_offset
;
3372 uint64_t new_reftable_index
= 0;
3374 int64_t new_reftable_offset
= 0, allocated_reftable_size
= 0;
3375 int new_refblock_size
, new_refcount_bits
= 1 << refcount_order
;
3376 int old_refcount_order
;
3379 bool new_allocation
;
3381 assert(s
->qcow_version
>= 3);
3382 assert(refcount_order
>= 0 && refcount_order
<= 6);
3384 /* see qcow2_open() */
3385 new_refblock_size
= 1 << (s
->cluster_bits
- (refcount_order
- 3));
3387 new_get_refcount
= get_refcount_funcs
[refcount_order
];
3388 new_set_refcount
= set_refcount_funcs
[refcount_order
];
3394 new_allocation
= false;
3396 /* At least we have to do this walk and the one which writes the
3397 * refblocks; also, at least we have to do this loop here at least
3398 * twice (normally), first to do the allocations, and second to
3399 * determine that everything is correctly allocated, this then makes
3400 * three walks in total */
3401 total_walks
= MAX(walk_index
+ 2, 3);
3403 /* First, allocate the structures so they are present in the refcount
3405 ret
= walk_over_reftable(bs
, &new_reftable
, &new_reftable_index
,
3406 &new_reftable_size
, NULL
, new_refblock_size
,
3407 new_refcount_bits
, &alloc_refblock
,
3408 &new_allocation
, NULL
, status_cb
, cb_opaque
,
3409 walk_index
++, total_walks
, errp
);
3414 new_reftable_index
= 0;
3416 if (new_allocation
) {
3417 if (new_reftable_offset
) {
3418 qcow2_free_clusters(
3419 bs
, new_reftable_offset
,
3420 allocated_reftable_size
* REFTABLE_ENTRY_SIZE
,
3421 QCOW2_DISCARD_NEVER
);
3424 new_reftable_offset
= qcow2_alloc_clusters(bs
, new_reftable_size
*
3425 REFTABLE_ENTRY_SIZE
);
3426 if (new_reftable_offset
< 0) {
3427 error_setg_errno(errp
, -new_reftable_offset
,
3428 "Failed to allocate the new reftable");
3429 ret
= new_reftable_offset
;
3432 allocated_reftable_size
= new_reftable_size
;
3434 } while (new_allocation
);
3436 /* Second, write the new refblocks */
3437 ret
= walk_over_reftable(bs
, &new_reftable
, &new_reftable_index
,
3438 &new_reftable_size
, new_refblock
,
3439 new_refblock_size
, new_refcount_bits
,
3440 &flush_refblock
, &new_allocation
, new_set_refcount
,
3441 status_cb
, cb_opaque
, walk_index
, walk_index
+ 1,
3446 assert(!new_allocation
);
3449 /* Write the new reftable */
3450 ret
= qcow2_pre_write_overlap_check(bs
, 0, new_reftable_offset
,
3451 new_reftable_size
* REFTABLE_ENTRY_SIZE
,
3454 error_setg_errno(errp
, -ret
, "Overlap check failed");
3458 for (i
= 0; i
< new_reftable_size
; i
++) {
3459 cpu_to_be64s(&new_reftable
[i
]);
3462 ret
= bdrv_pwrite(bs
->file
, new_reftable_offset
,
3463 new_reftable_size
* REFTABLE_ENTRY_SIZE
, new_reftable
,
3466 for (i
= 0; i
< new_reftable_size
; i
++) {
3467 be64_to_cpus(&new_reftable
[i
]);
3471 error_setg_errno(errp
, -ret
, "Failed to write the new reftable");
3476 /* Empty the refcount cache */
3477 ret
= qcow2_cache_flush(bs
, s
->refcount_block_cache
);
3479 error_setg_errno(errp
, -ret
, "Failed to flush the refblock cache");
3483 /* Update the image header to point to the new reftable; this only updates
3484 * the fields which are relevant to qcow2_update_header(); other fields
3485 * such as s->refcount_table or s->refcount_bits stay stale for now
3486 * (because we have to restore everything if qcow2_update_header() fails) */
3487 old_refcount_order
= s
->refcount_order
;
3488 old_reftable_size
= s
->refcount_table_size
;
3489 old_reftable_offset
= s
->refcount_table_offset
;
3491 s
->refcount_order
= refcount_order
;
3492 s
->refcount_table_size
= new_reftable_size
;
3493 s
->refcount_table_offset
= new_reftable_offset
;
3495 ret
= qcow2_update_header(bs
);
3497 s
->refcount_order
= old_refcount_order
;
3498 s
->refcount_table_size
= old_reftable_size
;
3499 s
->refcount_table_offset
= old_reftable_offset
;
3500 error_setg_errno(errp
, -ret
, "Failed to update the qcow2 header");
3504 /* Now update the rest of the in-memory information */
3505 old_reftable
= s
->refcount_table
;
3506 s
->refcount_table
= new_reftable
;
3507 update_max_refcount_table_index(s
);
3509 s
->refcount_bits
= 1 << refcount_order
;
3510 s
->refcount_max
= UINT64_C(1) << (s
->refcount_bits
- 1);
3511 s
->refcount_max
+= s
->refcount_max
- 1;
3513 s
->refcount_block_bits
= s
->cluster_bits
- (refcount_order
- 3);
3514 s
->refcount_block_size
= 1 << s
->refcount_block_bits
;
3516 s
->get_refcount
= new_get_refcount
;
3517 s
->set_refcount
= new_set_refcount
;
3519 /* For cleaning up all old refblocks and the old reftable below the "done"
3521 new_reftable
= old_reftable
;
3522 new_reftable_size
= old_reftable_size
;
3523 new_reftable_offset
= old_reftable_offset
;
3527 /* On success, new_reftable actually points to the old reftable (and
3528 * new_reftable_size is the old reftable's size); but that is just
3530 for (i
= 0; i
< new_reftable_size
; i
++) {
3531 uint64_t offset
= new_reftable
[i
] & REFT_OFFSET_MASK
;
3533 qcow2_free_clusters(bs
, offset
, s
->cluster_size
,
3534 QCOW2_DISCARD_OTHER
);
3537 g_free(new_reftable
);
3539 if (new_reftable_offset
> 0) {
3540 qcow2_free_clusters(bs
, new_reftable_offset
,
3541 new_reftable_size
* REFTABLE_ENTRY_SIZE
,
3542 QCOW2_DISCARD_OTHER
);
3546 qemu_vfree(new_refblock
);
3550 static int64_t coroutine_fn GRAPH_RDLOCK
3551 get_refblock_offset(BlockDriverState
*bs
, uint64_t offset
)
3553 BDRVQcow2State
*s
= bs
->opaque
;
3554 uint32_t index
= offset_to_reftable_index(s
, offset
);
3555 int64_t covering_refblock_offset
= 0;
3557 if (index
< s
->refcount_table_size
) {
3558 covering_refblock_offset
= s
->refcount_table
[index
] & REFT_OFFSET_MASK
;
3560 if (!covering_refblock_offset
) {
3561 qcow2_signal_corruption(bs
, true, -1, -1, "Refblock at %#" PRIx64
" is "
3562 "not covered by the refcount structures",
3567 return covering_refblock_offset
;
3570 static int coroutine_fn GRAPH_RDLOCK
3571 qcow2_discard_refcount_block(BlockDriverState
*bs
, uint64_t discard_block_offs
)
3573 BDRVQcow2State
*s
= bs
->opaque
;
3574 int64_t refblock_offs
;
3575 uint64_t cluster_index
= discard_block_offs
>> s
->cluster_bits
;
3576 uint32_t block_index
= cluster_index
& (s
->refcount_block_size
- 1);
3580 refblock_offs
= get_refblock_offset(bs
, discard_block_offs
);
3581 if (refblock_offs
< 0) {
3582 return refblock_offs
;
3585 assert(discard_block_offs
!= 0);
3587 ret
= qcow2_cache_get(bs
, s
->refcount_block_cache
, refblock_offs
,
3593 if (s
->get_refcount(refblock
, block_index
) != 1) {
3594 qcow2_signal_corruption(bs
, true, -1, -1, "Invalid refcount:"
3595 " refblock offset %#" PRIx64
3596 ", reftable index %u"
3597 ", block offset %#" PRIx64
3598 ", refcount %#" PRIx64
,
3600 offset_to_reftable_index(s
, discard_block_offs
),
3602 s
->get_refcount(refblock
, block_index
));
3603 qcow2_cache_put(s
->refcount_block_cache
, &refblock
);
3606 s
->set_refcount(refblock
, block_index
, 0);
3608 qcow2_cache_entry_mark_dirty(s
->refcount_block_cache
, refblock
);
3610 qcow2_cache_put(s
->refcount_block_cache
, &refblock
);
3612 if (cluster_index
< s
->free_cluster_index
) {
3613 s
->free_cluster_index
= cluster_index
;
3616 refblock
= qcow2_cache_is_table_offset(s
->refcount_block_cache
,
3617 discard_block_offs
);
3619 /* discard refblock from the cache if refblock is cached */
3620 qcow2_cache_discard(s
->refcount_block_cache
, refblock
);
3622 update_refcount_discard(bs
, discard_block_offs
, s
->cluster_size
);
3627 int coroutine_fn
qcow2_shrink_reftable(BlockDriverState
*bs
)
3629 BDRVQcow2State
*s
= bs
->opaque
;
3630 uint64_t *reftable_tmp
=
3631 g_malloc(s
->refcount_table_size
* REFTABLE_ENTRY_SIZE
);
3634 for (i
= 0; i
< s
->refcount_table_size
; i
++) {
3635 int64_t refblock_offs
= s
->refcount_table
[i
] & REFT_OFFSET_MASK
;
3639 if (refblock_offs
== 0) {
3640 reftable_tmp
[i
] = 0;
3643 ret
= qcow2_cache_get(bs
, s
->refcount_block_cache
, refblock_offs
,
3649 /* the refblock has own reference */
3650 if (i
== offset_to_reftable_index(s
, refblock_offs
)) {
3651 uint64_t block_index
= (refblock_offs
>> s
->cluster_bits
) &
3652 (s
->refcount_block_size
- 1);
3653 uint64_t refcount
= s
->get_refcount(refblock
, block_index
);
3655 s
->set_refcount(refblock
, block_index
, 0);
3657 unused_block
= buffer_is_zero(refblock
, s
->cluster_size
);
3659 s
->set_refcount(refblock
, block_index
, refcount
);
3661 unused_block
= buffer_is_zero(refblock
, s
->cluster_size
);
3663 qcow2_cache_put(s
->refcount_block_cache
, &refblock
);
3665 reftable_tmp
[i
] = unused_block
? 0 : cpu_to_be64(s
->refcount_table
[i
]);
3668 ret
= bdrv_co_pwrite_sync(bs
->file
, s
->refcount_table_offset
,
3669 s
->refcount_table_size
* REFTABLE_ENTRY_SIZE
,
3672 * If the write in the reftable failed the image may contain a partially
3673 * overwritten reftable. In this case it would be better to clear the
3674 * reftable in memory to avoid possible image corruption.
3676 for (i
= 0; i
< s
->refcount_table_size
; i
++) {
3677 if (s
->refcount_table
[i
] && !reftable_tmp
[i
]) {
3679 ret
= qcow2_discard_refcount_block(bs
, s
->refcount_table
[i
] &
3682 s
->refcount_table
[i
] = 0;
3686 if (!s
->cache_discards
) {
3687 qcow2_process_discards(bs
, ret
);
3691 g_free(reftable_tmp
);
3695 int64_t coroutine_fn
qcow2_get_last_cluster(BlockDriverState
*bs
, int64_t size
)
3697 BDRVQcow2State
*s
= bs
->opaque
;
3700 for (i
= size_to_clusters(s
, size
) - 1; i
>= 0; i
--) {
3702 int ret
= qcow2_get_refcount(bs
, i
, &refcount
);
3704 fprintf(stderr
, "Can't get refcount for cluster %" PRId64
": %s\n",
3712 qcow2_signal_corruption(bs
, true, -1, -1,
3713 "There are no references in the refcount table.");
3717 int coroutine_fn GRAPH_RDLOCK
3718 qcow2_detect_metadata_preallocation(BlockDriverState
*bs
)
3720 BDRVQcow2State
*s
= bs
->opaque
;
3721 int64_t i
, end_cluster
, cluster_count
= 0, threshold
;
3722 int64_t file_length
, real_allocation
, real_clusters
;
3724 qemu_co_mutex_assert_locked(&s
->lock
);
3726 file_length
= bdrv_co_getlength(bs
->file
->bs
);
3727 if (file_length
< 0) {
3731 real_allocation
= bdrv_co_get_allocated_file_size(bs
->file
->bs
);
3732 if (real_allocation
< 0) {
3733 return real_allocation
;
3736 real_clusters
= real_allocation
/ s
->cluster_size
;
3737 threshold
= MAX(real_clusters
* 10 / 9, real_clusters
+ 2);
3739 end_cluster
= size_to_clusters(s
, file_length
);
3740 for (i
= 0; i
< end_cluster
&& cluster_count
< threshold
; i
++) {
3742 int ret
= qcow2_get_refcount(bs
, i
, &refcount
);
3746 cluster_count
+= !!refcount
;
3749 return cluster_count
>= threshold
;