Coverage Report

Created: 2026-11-20 08:13

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/qemu/block/qed-check.c
Line
Count
Source
1
/*
2
 * QEMU Enhanced Disk Format Consistency Check
3
 *
4
 * Copyright IBM, Corp. 2010
5
 *
6
 * Authors:
7
 *  Stefan Hajnoczi   <stefanha@linux.vnet.ibm.com>
8
 *
9
 * This work is licensed under the terms of the GNU LGPL, version 2 or later.
10
 * See the COPYING.LIB file in the top-level directory.
11
 *
12
 */
13
14
#include "qemu/osdep.h"
15
#include "block/block-io.h"
16
#include "qed.h"
17
18
typedef struct {
19
    BDRVQEDState *s;
20
    BdrvCheckResult *result;
21
    bool fix;                           /* whether to fix invalid offsets */
22
23
    uint64_t nclusters;
24
    uint32_t *used_clusters;            /* referenced cluster bitmap */
25
26
    QEDRequest request;
27
} QEDCheck;
28
29
0
static bool qed_test_bit(uint32_t *bitmap, uint64_t n) {
30
0
    return !!(bitmap[n / 32] & (1 << (n % 32)));
31
0
}
32
33
0
static void qed_set_bit(uint32_t *bitmap, uint64_t n) {
34
0
    bitmap[n / 32] |= 1 << (n % 32);
35
0
}
36
37
/**
38
 * Set bitmap bits for clusters
39
 *
40
 * @check:          Check structure
41
 * @offset:         Starting offset in bytes
42
 * @n:              Number of clusters
43
 */
44
static bool qed_set_used_clusters(QEDCheck *check, uint64_t offset,
45
                                  unsigned int n)
46
0
{
47
0
    uint64_t cluster = qed_bytes_to_clusters(check->s, offset);
48
0
    unsigned int corruptions = 0;
49
50
0
    while (n-- != 0) {
51
        /* Clusters should only be referenced once */
52
0
        if (qed_test_bit(check->used_clusters, cluster)) {
53
0
            corruptions++;
54
0
        }
55
56
0
        qed_set_bit(check->used_clusters, cluster);
57
0
        cluster++;
58
0
    }
59
60
0
    check->result->corruptions += corruptions;
61
0
    return corruptions == 0;
62
0
}
63
64
/**
65
 * Check an L2 table
66
 *
67
 * @ret:            Number of invalid cluster offsets
68
 */
69
static unsigned int qed_check_l2_table(QEDCheck *check, QEDTable *table)
70
0
{
71
0
    BDRVQEDState *s = check->s;
72
0
    unsigned int i, num_invalid = 0;
73
0
    uint64_t last_offset = 0;
74
75
0
    for (i = 0; i < s->table_nelems; i++) {
76
0
        uint64_t offset = table->offsets[i];
77
78
0
        if (qed_offset_is_unalloc_cluster(offset) ||
79
0
            qed_offset_is_zero_cluster(offset)) {
80
0
            continue;
81
0
        }
82
0
        check->result->bfi.allocated_clusters++;
83
0
        if (last_offset && (last_offset + s->header.cluster_size != offset)) {
84
0
            check->result->bfi.fragmented_clusters++;
85
0
        }
86
0
        last_offset = offset;
87
88
        /* Detect invalid cluster offset */
89
0
        if (!qed_check_cluster_offset(s, offset)) {
90
0
            if (check->fix) {
91
0
                table->offsets[i] = 0;
92
0
                check->result->corruptions_fixed++;
93
0
            } else {
94
0
                check->result->corruptions++;
95
0
            }
96
97
0
            num_invalid++;
98
0
            continue;
99
0
        }
100
101
0
        qed_set_used_clusters(check, offset, 1);
102
0
    }
103
104
0
    return num_invalid;
105
0
}
106
107
/**
108
 * Descend tables and check each cluster is referenced once only
109
 */
110
static int coroutine_fn GRAPH_RDLOCK
111
qed_check_l1_table(QEDCheck *check, QEDTable *table)
112
0
{
113
0
    BDRVQEDState *s = check->s;
114
0
    unsigned int i, num_invalid_l1 = 0;
115
0
    int ret, last_error = 0;
116
117
    /* Mark L1 table clusters used */
118
0
    qed_set_used_clusters(check, s->header.l1_table_offset,
119
0
                          s->header.table_size);
120
121
0
    for (i = 0; i < s->table_nelems; i++) {
122
0
        unsigned int num_invalid_l2;
123
0
        uint64_t offset = table->offsets[i];
124
125
0
        if (qed_offset_is_unalloc_cluster(offset)) {
126
0
            continue;
127
0
        }
128
129
        /* Detect invalid L2 offset */
130
0
        if (!qed_check_table_offset(s, offset)) {
131
            /* Clear invalid offset */
132
0
            if (check->fix) {
133
0
                table->offsets[i] = 0;
134
0
                check->result->corruptions_fixed++;
135
0
            } else {
136
0
                check->result->corruptions++;
137
0
            }
138
139
0
            num_invalid_l1++;
140
0
            continue;
141
0
        }
142
143
0
        if (!qed_set_used_clusters(check, offset, s->header.table_size)) {
144
0
            continue; /* skip an invalid table */
145
0
        }
146
147
0
        ret = qed_read_l2_table_sync(s, &check->request, offset);
148
0
        if (ret) {
149
0
            check->result->check_errors++;
150
0
            last_error = ret;
151
0
            continue;
152
0
        }
153
154
0
        num_invalid_l2 = qed_check_l2_table(check,
155
0
                                            check->request.l2_table->table);
156
157
        /* Write out fixed L2 table */
158
0
        if (num_invalid_l2 > 0 && check->fix) {
159
0
            ret = qed_write_l2_table_sync(s, &check->request, 0,
160
0
                                          s->table_nelems, false);
161
0
            if (ret) {
162
0
                check->result->check_errors++;
163
0
                last_error = ret;
164
0
                continue;
165
0
            }
166
0
        }
167
0
    }
168
169
    /* Drop reference to final table */
170
0
    qed_unref_l2_cache_entry(check->request.l2_table);
171
0
    check->request.l2_table = NULL;
172
173
    /* Write out fixed L1 table */
174
0
    if (num_invalid_l1 > 0 && check->fix) {
175
0
        ret = qed_write_l1_table_sync(s, 0, s->table_nelems);
176
0
        if (ret) {
177
0
            check->result->check_errors++;
178
0
            last_error = ret;
179
0
        }
180
0
    }
181
182
0
    return last_error;
183
0
}
184
185
/**
186
 * Check for unreferenced (leaked) clusters
187
 */
188
static void qed_check_for_leaks(QEDCheck *check)
189
0
{
190
0
    BDRVQEDState *s = check->s;
191
0
    uint64_t i;
192
193
0
    for (i = s->header.header_size; i < check->nclusters; i++) {
194
0
        if (!qed_test_bit(check->used_clusters, i)) {
195
0
            check->result->leaks++;
196
0
        }
197
0
    }
198
0
}
199
200
/**
201
 * Mark an image clean once it passes check or has been repaired
202
 */
203
static void coroutine_fn GRAPH_RDLOCK
204
qed_check_mark_clean(BDRVQEDState *s, BdrvCheckResult *result)
205
0
{
206
    /* Skip if there were unfixable corruptions or I/O errors */
207
0
    if (result->corruptions > 0 || result->check_errors > 0) {
208
0
        return;
209
0
    }
210
211
    /* Skip if image is already marked clean */
212
0
    if (!(s->header.features & QED_F_NEED_CHECK)) {
213
0
        return;
214
0
    }
215
216
    /* Ensure fixes reach storage before clearing check bit */
217
0
    bdrv_co_flush(s->bs);
218
219
0
    s->header.features &= ~QED_F_NEED_CHECK;
220
0
    qed_write_header_sync(s);
221
0
}
222
223
/* Called with table_lock held.  */
224
int coroutine_fn qed_check(BDRVQEDState *s, BdrvCheckResult *result, bool fix)
225
0
{
226
0
    QEDCheck check = {
227
0
        .s = s,
228
0
        .result = result,
229
0
        .nclusters = qed_bytes_to_clusters(s, s->file_size),
230
0
        .request = { .l2_table = NULL },
231
0
        .fix = fix,
232
0
    };
233
0
    int ret;
234
235
0
    check.used_clusters = g_try_new0(uint32_t, (check.nclusters + 31) / 32);
236
0
    if (check.nclusters && check.used_clusters == NULL) {
237
0
        return -ENOMEM;
238
0
    }
239
240
0
    check.result->bfi.total_clusters =
241
0
        DIV_ROUND_UP(s->header.image_size, s->header.cluster_size);
242
0
    ret = qed_check_l1_table(&check, s->l1_table);
243
0
    if (ret == 0) {
244
        /* Only check for leaks if entire image was scanned successfully */
245
0
        qed_check_for_leaks(&check);
246
247
0
        if (fix) {
248
0
            qed_check_mark_clean(s, result);
249
0
        }
250
0
    }
251
252
0
    g_free(check.used_clusters);
253
0
    return ret;
254
0
}