]>
Commit | Line | Data |
---|---|---|
88ddffae VSO |
1 | /* |
2 | * Bitmaps for the QCOW version 2 format | |
3 | * | |
4 | * Copyright (c) 2014-2017 Vladimir Sementsov-Ogievskiy | |
5 | * | |
6 | * This file is derived from qcow2-snapshot.c, original copyright: | |
7 | * Copyright (c) 2004-2006 Fabrice Bellard | |
8 | * | |
9 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
10 | * of this software and associated documentation files (the "Software"), to deal | |
11 | * in the Software without restriction, including without limitation the rights | |
12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
13 | * copies of the Software, and to permit persons to whom the Software is | |
14 | * furnished to do so, subject to the following conditions: | |
15 | * | |
16 | * The above copyright notice and this permission notice shall be included in | |
17 | * all copies or substantial portions of the Software. | |
18 | * | |
19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | |
22 | * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
25 | * THE SOFTWARE. | |
26 | */ | |
27 | ||
28 | #include "qemu/osdep.h" | |
29 | #include "qapi/error.h" | |
5f72826e | 30 | #include "qemu/cutils.h" |
88ddffae VSO |
31 | |
32 | #include "block/block_int.h" | |
33 | #include "block/qcow2.h" | |
34 | ||
35 | /* NOTICE: BME here means Bitmaps Extension and used as a namespace for | |
36 | * _internal_ constants. Please do not use this _internal_ abbreviation for | |
37 | * other needs and/or outside of this file. */ | |
38 | ||
39 | /* Bitmap directory entry constraints */ | |
40 | #define BME_MAX_TABLE_SIZE 0x8000000 | |
41 | #define BME_MAX_PHYS_SIZE 0x20000000 /* restrict BdrvDirtyBitmap size in RAM */ | |
42 | #define BME_MAX_GRANULARITY_BITS 31 | |
43 | #define BME_MIN_GRANULARITY_BITS 9 | |
44 | #define BME_MAX_NAME_SIZE 1023 | |
45 | ||
5f72826e VSO |
46 | #if BME_MAX_TABLE_SIZE * 8ULL > INT_MAX |
47 | #error In the code bitmap table physical size assumed to fit into int | |
48 | #endif | |
49 | ||
88ddffae VSO |
50 | /* Bitmap directory entry flags */ |
51 | #define BME_RESERVED_FLAGS 0xfffffffcU | |
d1258dd0 VSO |
52 | #define BME_FLAG_IN_USE (1U << 0) |
53 | #define BME_FLAG_AUTO (1U << 1) | |
88ddffae VSO |
54 | |
55 | /* bits [1, 8] U [56, 63] are reserved */ | |
56 | #define BME_TABLE_ENTRY_RESERVED_MASK 0xff000000000001feULL | |
57 | #define BME_TABLE_ENTRY_OFFSET_MASK 0x00fffffffffffe00ULL | |
58 | #define BME_TABLE_ENTRY_FLAG_ALL_ONES (1ULL << 0) | |
59 | ||
60 | typedef struct QEMU_PACKED Qcow2BitmapDirEntry { | |
61 | /* header is 8 byte aligned */ | |
62 | uint64_t bitmap_table_offset; | |
63 | ||
64 | uint32_t bitmap_table_size; | |
65 | uint32_t flags; | |
66 | ||
67 | uint8_t type; | |
68 | uint8_t granularity_bits; | |
69 | uint16_t name_size; | |
70 | uint32_t extra_data_size; | |
71 | /* extra data follows */ | |
72 | /* name follows */ | |
73 | } Qcow2BitmapDirEntry; | |
74 | ||
75 | typedef struct Qcow2BitmapTable { | |
76 | uint64_t offset; | |
77 | uint32_t size; /* number of 64bit entries */ | |
78 | QSIMPLEQ_ENTRY(Qcow2BitmapTable) entry; | |
79 | } Qcow2BitmapTable; | |
5f72826e VSO |
80 | typedef QSIMPLEQ_HEAD(Qcow2BitmapTableList, Qcow2BitmapTable) |
81 | Qcow2BitmapTableList; | |
88ddffae VSO |
82 | |
83 | typedef struct Qcow2Bitmap { | |
84 | Qcow2BitmapTable table; | |
85 | uint32_t flags; | |
86 | uint8_t granularity_bits; | |
87 | char *name; | |
88 | ||
5f72826e VSO |
89 | BdrvDirtyBitmap *dirty_bitmap; |
90 | ||
88ddffae VSO |
91 | QSIMPLEQ_ENTRY(Qcow2Bitmap) entry; |
92 | } Qcow2Bitmap; | |
93 | typedef QSIMPLEQ_HEAD(Qcow2BitmapList, Qcow2Bitmap) Qcow2BitmapList; | |
94 | ||
95 | typedef enum BitmapType { | |
96 | BT_DIRTY_TRACKING_BITMAP = 1 | |
97 | } BitmapType; | |
98 | ||
d1258dd0 VSO |
99 | static inline bool can_write(BlockDriverState *bs) |
100 | { | |
101 | return !bdrv_is_read_only(bs) && !(bdrv_get_flags(bs) & BDRV_O_INACTIVE); | |
102 | } | |
103 | ||
104 | static int update_header_sync(BlockDriverState *bs) | |
105 | { | |
106 | int ret; | |
107 | ||
108 | ret = qcow2_update_header(bs); | |
109 | if (ret < 0) { | |
110 | return ret; | |
111 | } | |
112 | ||
113 | return bdrv_flush(bs); | |
114 | } | |
115 | ||
5f72826e VSO |
116 | static inline void bitmap_table_to_be(uint64_t *bitmap_table, size_t size) |
117 | { | |
118 | size_t i; | |
119 | ||
120 | for (i = 0; i < size; ++i) { | |
121 | cpu_to_be64s(&bitmap_table[i]); | |
122 | } | |
123 | } | |
124 | ||
88ddffae VSO |
125 | static int check_table_entry(uint64_t entry, int cluster_size) |
126 | { | |
127 | uint64_t offset; | |
128 | ||
129 | if (entry & BME_TABLE_ENTRY_RESERVED_MASK) { | |
130 | return -EINVAL; | |
131 | } | |
132 | ||
133 | offset = entry & BME_TABLE_ENTRY_OFFSET_MASK; | |
134 | if (offset != 0) { | |
135 | /* if offset specified, bit 0 is reserved */ | |
136 | if (entry & BME_TABLE_ENTRY_FLAG_ALL_ONES) { | |
137 | return -EINVAL; | |
138 | } | |
139 | ||
140 | if (offset % cluster_size != 0) { | |
141 | return -EINVAL; | |
142 | } | |
143 | } | |
144 | ||
145 | return 0; | |
146 | } | |
147 | ||
5f72826e VSO |
148 | static int check_constraints_on_bitmap(BlockDriverState *bs, |
149 | const char *name, | |
150 | uint32_t granularity, | |
151 | Error **errp) | |
152 | { | |
153 | BDRVQcow2State *s = bs->opaque; | |
154 | int granularity_bits = ctz32(granularity); | |
155 | int64_t len = bdrv_getlength(bs); | |
156 | ||
157 | assert(granularity > 0); | |
158 | assert((granularity & (granularity - 1)) == 0); | |
159 | ||
160 | if (len < 0) { | |
161 | error_setg_errno(errp, -len, "Failed to get size of '%s'", | |
162 | bdrv_get_device_or_node_name(bs)); | |
163 | return len; | |
164 | } | |
165 | ||
166 | if (granularity_bits > BME_MAX_GRANULARITY_BITS) { | |
167 | error_setg(errp, "Granularity exceeds maximum (%llu bytes)", | |
168 | 1ULL << BME_MAX_GRANULARITY_BITS); | |
169 | return -EINVAL; | |
170 | } | |
171 | if (granularity_bits < BME_MIN_GRANULARITY_BITS) { | |
172 | error_setg(errp, "Granularity is under minimum (%llu bytes)", | |
173 | 1ULL << BME_MIN_GRANULARITY_BITS); | |
174 | return -EINVAL; | |
175 | } | |
176 | ||
177 | if ((len > (uint64_t)BME_MAX_PHYS_SIZE << granularity_bits) || | |
178 | (len > (uint64_t)BME_MAX_TABLE_SIZE * s->cluster_size << | |
179 | granularity_bits)) | |
180 | { | |
181 | error_setg(errp, "Too much space will be occupied by the bitmap. " | |
182 | "Use larger granularity"); | |
183 | return -EINVAL; | |
184 | } | |
185 | ||
186 | if (strlen(name) > BME_MAX_NAME_SIZE) { | |
187 | error_setg(errp, "Name length exceeds maximum (%u characters)", | |
188 | BME_MAX_NAME_SIZE); | |
189 | return -EINVAL; | |
190 | } | |
191 | ||
192 | return 0; | |
193 | } | |
194 | ||
195 | static void clear_bitmap_table(BlockDriverState *bs, uint64_t *bitmap_table, | |
196 | uint32_t bitmap_table_size) | |
197 | { | |
198 | BDRVQcow2State *s = bs->opaque; | |
199 | int i; | |
200 | ||
201 | for (i = 0; i < bitmap_table_size; ++i) { | |
202 | uint64_t addr = bitmap_table[i] & BME_TABLE_ENTRY_OFFSET_MASK; | |
203 | if (!addr) { | |
204 | continue; | |
205 | } | |
206 | ||
207 | qcow2_free_clusters(bs, addr, s->cluster_size, QCOW2_DISCARD_OTHER); | |
208 | bitmap_table[i] = 0; | |
209 | } | |
210 | } | |
211 | ||
88ddffae VSO |
212 | static int bitmap_table_load(BlockDriverState *bs, Qcow2BitmapTable *tb, |
213 | uint64_t **bitmap_table) | |
214 | { | |
215 | int ret; | |
216 | BDRVQcow2State *s = bs->opaque; | |
217 | uint32_t i; | |
218 | uint64_t *table; | |
219 | ||
220 | assert(tb->size != 0); | |
221 | table = g_try_new(uint64_t, tb->size); | |
222 | if (table == NULL) { | |
223 | return -ENOMEM; | |
224 | } | |
225 | ||
226 | assert(tb->size <= BME_MAX_TABLE_SIZE); | |
227 | ret = bdrv_pread(bs->file, tb->offset, | |
228 | table, tb->size * sizeof(uint64_t)); | |
229 | if (ret < 0) { | |
230 | goto fail; | |
231 | } | |
232 | ||
233 | for (i = 0; i < tb->size; ++i) { | |
234 | be64_to_cpus(&table[i]); | |
235 | ret = check_table_entry(table[i], s->cluster_size); | |
236 | if (ret < 0) { | |
237 | goto fail; | |
238 | } | |
239 | } | |
240 | ||
241 | *bitmap_table = table; | |
242 | return 0; | |
243 | ||
244 | fail: | |
245 | g_free(table); | |
246 | ||
247 | return ret; | |
248 | } | |
249 | ||
5f72826e VSO |
250 | static int free_bitmap_clusters(BlockDriverState *bs, Qcow2BitmapTable *tb) |
251 | { | |
252 | int ret; | |
253 | uint64_t *bitmap_table; | |
254 | ||
255 | ret = bitmap_table_load(bs, tb, &bitmap_table); | |
256 | if (ret < 0) { | |
257 | assert(bitmap_table == NULL); | |
258 | return ret; | |
259 | } | |
260 | ||
261 | clear_bitmap_table(bs, bitmap_table, tb->size); | |
262 | qcow2_free_clusters(bs, tb->offset, tb->size * sizeof(uint64_t), | |
263 | QCOW2_DISCARD_OTHER); | |
264 | g_free(bitmap_table); | |
265 | ||
266 | tb->offset = 0; | |
267 | tb->size = 0; | |
268 | ||
269 | return 0; | |
270 | } | |
271 | ||
c7e7c87a EB |
272 | /* Return the disk size covered by a single qcow2 cluster of bitmap data. */ |
273 | static uint64_t bytes_covered_by_bitmap_cluster(const BDRVQcow2State *s, | |
274 | const BdrvDirtyBitmap *bitmap) | |
d1258dd0 | 275 | { |
c7e7c87a EB |
276 | uint64_t granularity = bdrv_dirty_bitmap_granularity(bitmap); |
277 | uint64_t limit = granularity * (s->cluster_size << 3); | |
d1258dd0 | 278 | |
c7e7c87a | 279 | assert(QEMU_IS_ALIGNED(limit, |
113754f3 | 280 | bdrv_dirty_bitmap_serialization_align(bitmap))); |
c7e7c87a | 281 | return limit; |
d1258dd0 VSO |
282 | } |
283 | ||
284 | /* load_bitmap_data | |
285 | * @bitmap_table entries must satisfy specification constraints. | |
286 | * @bitmap must be cleared */ | |
287 | static int load_bitmap_data(BlockDriverState *bs, | |
288 | const uint64_t *bitmap_table, | |
289 | uint32_t bitmap_table_size, | |
290 | BdrvDirtyBitmap *bitmap) | |
291 | { | |
292 | int ret = 0; | |
293 | BDRVQcow2State *s = bs->opaque; | |
c7e7c87a | 294 | uint64_t sector, limit, sbc; |
d1258dd0 | 295 | uint64_t bm_size = bdrv_dirty_bitmap_size(bitmap); |
ebfcd2e7 | 296 | uint64_t bm_sectors = DIV_ROUND_UP(bm_size, BDRV_SECTOR_SIZE); |
d1258dd0 VSO |
297 | uint8_t *buf = NULL; |
298 | uint64_t i, tab_size = | |
299 | size_to_clusters(s, | |
86f6ae67 | 300 | bdrv_dirty_bitmap_serialization_size(bitmap, 0, bm_size)); |
d1258dd0 VSO |
301 | |
302 | if (tab_size != bitmap_table_size || tab_size > BME_MAX_TABLE_SIZE) { | |
303 | return -EINVAL; | |
304 | } | |
305 | ||
306 | buf = g_malloc(s->cluster_size); | |
c7e7c87a EB |
307 | limit = bytes_covered_by_bitmap_cluster(s, bitmap); |
308 | sbc = limit >> BDRV_SECTOR_BITS; | |
d1258dd0 | 309 | for (i = 0, sector = 0; i < tab_size; ++i, sector += sbc) { |
ebfcd2e7 | 310 | uint64_t count = MIN(bm_sectors - sector, sbc); |
d1258dd0 VSO |
311 | uint64_t entry = bitmap_table[i]; |
312 | uint64_t offset = entry & BME_TABLE_ENTRY_OFFSET_MASK; | |
313 | ||
314 | assert(check_table_entry(entry, s->cluster_size) == 0); | |
315 | ||
316 | if (offset == 0) { | |
317 | if (entry & BME_TABLE_ENTRY_FLAG_ALL_ONES) { | |
86f6ae67 EB |
318 | bdrv_dirty_bitmap_deserialize_ones(bitmap, |
319 | sector * BDRV_SECTOR_SIZE, | |
320 | count * BDRV_SECTOR_SIZE, | |
d1258dd0 VSO |
321 | false); |
322 | } else { | |
323 | /* No need to deserialize zeros because the dirty bitmap is | |
324 | * already cleared */ | |
325 | } | |
326 | } else { | |
327 | ret = bdrv_pread(bs->file, offset, buf, s->cluster_size); | |
328 | if (ret < 0) { | |
329 | goto finish; | |
330 | } | |
86f6ae67 EB |
331 | bdrv_dirty_bitmap_deserialize_part(bitmap, buf, |
332 | sector * BDRV_SECTOR_SIZE, | |
333 | count * BDRV_SECTOR_SIZE, | |
d1258dd0 VSO |
334 | false); |
335 | } | |
336 | } | |
337 | ret = 0; | |
338 | ||
339 | bdrv_dirty_bitmap_deserialize_finish(bitmap); | |
340 | ||
341 | finish: | |
342 | g_free(buf); | |
343 | ||
344 | return ret; | |
345 | } | |
346 | ||
347 | static BdrvDirtyBitmap *load_bitmap(BlockDriverState *bs, | |
348 | Qcow2Bitmap *bm, Error **errp) | |
349 | { | |
350 | int ret; | |
351 | uint64_t *bitmap_table = NULL; | |
352 | uint32_t granularity; | |
353 | BdrvDirtyBitmap *bitmap = NULL; | |
354 | ||
355 | if (bm->flags & BME_FLAG_IN_USE) { | |
356 | error_setg(errp, "Bitmap '%s' is in use", bm->name); | |
357 | goto fail; | |
358 | } | |
359 | ||
360 | ret = bitmap_table_load(bs, &bm->table, &bitmap_table); | |
361 | if (ret < 0) { | |
362 | error_setg_errno(errp, -ret, | |
363 | "Could not read bitmap_table table from image for " | |
364 | "bitmap '%s'", bm->name); | |
365 | goto fail; | |
366 | } | |
367 | ||
368 | granularity = 1U << bm->granularity_bits; | |
369 | bitmap = bdrv_create_dirty_bitmap(bs, granularity, bm->name, errp); | |
370 | if (bitmap == NULL) { | |
371 | goto fail; | |
372 | } | |
373 | ||
374 | ret = load_bitmap_data(bs, bitmap_table, bm->table.size, bitmap); | |
375 | if (ret < 0) { | |
376 | error_setg_errno(errp, -ret, "Could not read bitmap '%s' from image", | |
377 | bm->name); | |
378 | goto fail; | |
379 | } | |
380 | ||
381 | g_free(bitmap_table); | |
382 | return bitmap; | |
383 | ||
384 | fail: | |
385 | g_free(bitmap_table); | |
386 | if (bitmap != NULL) { | |
387 | bdrv_release_dirty_bitmap(bs, bitmap); | |
388 | } | |
389 | ||
390 | return NULL; | |
391 | } | |
392 | ||
88ddffae VSO |
393 | /* |
394 | * Bitmap List | |
395 | */ | |
396 | ||
397 | /* | |
398 | * Bitmap List private functions | |
399 | * Only Bitmap List knows about bitmap directory structure in Qcow2. | |
400 | */ | |
401 | ||
402 | static inline void bitmap_dir_entry_to_cpu(Qcow2BitmapDirEntry *entry) | |
403 | { | |
404 | be64_to_cpus(&entry->bitmap_table_offset); | |
405 | be32_to_cpus(&entry->bitmap_table_size); | |
406 | be32_to_cpus(&entry->flags); | |
407 | be16_to_cpus(&entry->name_size); | |
408 | be32_to_cpus(&entry->extra_data_size); | |
409 | } | |
410 | ||
d1258dd0 VSO |
411 | static inline void bitmap_dir_entry_to_be(Qcow2BitmapDirEntry *entry) |
412 | { | |
413 | cpu_to_be64s(&entry->bitmap_table_offset); | |
414 | cpu_to_be32s(&entry->bitmap_table_size); | |
415 | cpu_to_be32s(&entry->flags); | |
416 | cpu_to_be16s(&entry->name_size); | |
417 | cpu_to_be32s(&entry->extra_data_size); | |
418 | } | |
419 | ||
88ddffae VSO |
420 | static inline int calc_dir_entry_size(size_t name_size, size_t extra_data_size) |
421 | { | |
422 | return align_offset(sizeof(Qcow2BitmapDirEntry) + | |
423 | name_size + extra_data_size, 8); | |
424 | } | |
425 | ||
426 | static inline int dir_entry_size(Qcow2BitmapDirEntry *entry) | |
427 | { | |
428 | return calc_dir_entry_size(entry->name_size, entry->extra_data_size); | |
429 | } | |
430 | ||
431 | static inline const char *dir_entry_name_field(Qcow2BitmapDirEntry *entry) | |
432 | { | |
433 | return (const char *)(entry + 1) + entry->extra_data_size; | |
434 | } | |
435 | ||
436 | static inline char *dir_entry_copy_name(Qcow2BitmapDirEntry *entry) | |
437 | { | |
438 | const char *name_field = dir_entry_name_field(entry); | |
439 | return g_strndup(name_field, entry->name_size); | |
440 | } | |
441 | ||
442 | static inline Qcow2BitmapDirEntry *next_dir_entry(Qcow2BitmapDirEntry *entry) | |
443 | { | |
444 | return (Qcow2BitmapDirEntry *)((uint8_t *)entry + dir_entry_size(entry)); | |
445 | } | |
446 | ||
447 | static int check_dir_entry(BlockDriverState *bs, Qcow2BitmapDirEntry *entry) | |
448 | { | |
449 | BDRVQcow2State *s = bs->opaque; | |
450 | uint64_t phys_bitmap_bytes; | |
451 | int64_t len; | |
452 | ||
453 | bool fail = (entry->bitmap_table_size == 0) || | |
454 | (entry->bitmap_table_offset == 0) || | |
455 | (entry->bitmap_table_offset % s->cluster_size) || | |
456 | (entry->bitmap_table_size > BME_MAX_TABLE_SIZE) || | |
457 | (entry->granularity_bits > BME_MAX_GRANULARITY_BITS) || | |
458 | (entry->granularity_bits < BME_MIN_GRANULARITY_BITS) || | |
459 | (entry->flags & BME_RESERVED_FLAGS) || | |
460 | (entry->name_size > BME_MAX_NAME_SIZE) || | |
461 | (entry->type != BT_DIRTY_TRACKING_BITMAP); | |
462 | ||
463 | if (fail) { | |
464 | return -EINVAL; | |
465 | } | |
466 | ||
467 | phys_bitmap_bytes = (uint64_t)entry->bitmap_table_size * s->cluster_size; | |
468 | len = bdrv_getlength(bs); | |
469 | ||
470 | if (len < 0) { | |
471 | return len; | |
472 | } | |
473 | ||
474 | fail = (phys_bitmap_bytes > BME_MAX_PHYS_SIZE) || | |
475 | (len > ((phys_bitmap_bytes * 8) << entry->granularity_bits)); | |
476 | ||
477 | return fail ? -EINVAL : 0; | |
478 | } | |
479 | ||
d1258dd0 VSO |
480 | static inline void bitmap_directory_to_be(uint8_t *dir, size_t size) |
481 | { | |
482 | uint8_t *end = dir + size; | |
483 | while (dir < end) { | |
484 | Qcow2BitmapDirEntry *e = (Qcow2BitmapDirEntry *)dir; | |
485 | dir += dir_entry_size(e); | |
486 | ||
487 | bitmap_dir_entry_to_be(e); | |
488 | } | |
489 | } | |
490 | ||
88ddffae VSO |
491 | /* |
492 | * Bitmap List public functions | |
493 | */ | |
494 | ||
495 | static void bitmap_free(Qcow2Bitmap *bm) | |
496 | { | |
b6b75a99 VSO |
497 | if (bm == NULL) { |
498 | return; | |
499 | } | |
500 | ||
88ddffae VSO |
501 | g_free(bm->name); |
502 | g_free(bm); | |
503 | } | |
504 | ||
505 | static void bitmap_list_free(Qcow2BitmapList *bm_list) | |
506 | { | |
507 | Qcow2Bitmap *bm; | |
508 | ||
509 | if (bm_list == NULL) { | |
510 | return; | |
511 | } | |
512 | ||
513 | while ((bm = QSIMPLEQ_FIRST(bm_list)) != NULL) { | |
514 | QSIMPLEQ_REMOVE_HEAD(bm_list, entry); | |
515 | bitmap_free(bm); | |
516 | } | |
517 | ||
518 | g_free(bm_list); | |
519 | } | |
520 | ||
521 | static Qcow2BitmapList *bitmap_list_new(void) | |
522 | { | |
523 | Qcow2BitmapList *bm_list = g_new(Qcow2BitmapList, 1); | |
524 | QSIMPLEQ_INIT(bm_list); | |
525 | ||
526 | return bm_list; | |
527 | } | |
528 | ||
d1258dd0 VSO |
529 | static uint32_t bitmap_list_count(Qcow2BitmapList *bm_list) |
530 | { | |
531 | Qcow2Bitmap *bm; | |
532 | uint32_t nb_bitmaps = 0; | |
533 | ||
534 | QSIMPLEQ_FOREACH(bm, bm_list, entry) { | |
535 | nb_bitmaps++; | |
536 | } | |
537 | ||
538 | return nb_bitmaps; | |
539 | } | |
540 | ||
88ddffae VSO |
541 | /* bitmap_list_load |
542 | * Get bitmap list from qcow2 image. Actually reads bitmap directory, | |
543 | * checks it and convert to bitmap list. | |
544 | */ | |
545 | static Qcow2BitmapList *bitmap_list_load(BlockDriverState *bs, uint64_t offset, | |
546 | uint64_t size, Error **errp) | |
547 | { | |
548 | int ret; | |
549 | BDRVQcow2State *s = bs->opaque; | |
550 | uint8_t *dir, *dir_end; | |
551 | Qcow2BitmapDirEntry *e; | |
552 | uint32_t nb_dir_entries = 0; | |
553 | Qcow2BitmapList *bm_list = NULL; | |
554 | ||
555 | if (size == 0) { | |
556 | error_setg(errp, "Requested bitmap directory size is zero"); | |
557 | return NULL; | |
558 | } | |
559 | ||
560 | if (size > QCOW2_MAX_BITMAP_DIRECTORY_SIZE) { | |
561 | error_setg(errp, "Requested bitmap directory size is too big"); | |
562 | return NULL; | |
563 | } | |
564 | ||
565 | dir = g_try_malloc(size); | |
566 | if (dir == NULL) { | |
567 | error_setg(errp, "Failed to allocate space for bitmap directory"); | |
568 | return NULL; | |
569 | } | |
570 | dir_end = dir + size; | |
571 | ||
572 | ret = bdrv_pread(bs->file, offset, dir, size); | |
573 | if (ret < 0) { | |
574 | error_setg_errno(errp, -ret, "Failed to read bitmap directory"); | |
575 | goto fail; | |
576 | } | |
577 | ||
578 | bm_list = bitmap_list_new(); | |
579 | for (e = (Qcow2BitmapDirEntry *)dir; | |
580 | e < (Qcow2BitmapDirEntry *)dir_end; | |
581 | e = next_dir_entry(e)) | |
582 | { | |
583 | Qcow2Bitmap *bm; | |
584 | ||
585 | if ((uint8_t *)(e + 1) > dir_end) { | |
586 | goto broken_dir; | |
587 | } | |
588 | ||
589 | if (++nb_dir_entries > s->nb_bitmaps) { | |
590 | error_setg(errp, "More bitmaps found than specified in header" | |
591 | " extension"); | |
592 | goto fail; | |
593 | } | |
594 | bitmap_dir_entry_to_cpu(e); | |
595 | ||
596 | if ((uint8_t *)next_dir_entry(e) > dir_end) { | |
597 | goto broken_dir; | |
598 | } | |
599 | ||
600 | if (e->extra_data_size != 0) { | |
601 | error_setg(errp, "Bitmap extra data is not supported"); | |
602 | goto fail; | |
603 | } | |
604 | ||
605 | ret = check_dir_entry(bs, e); | |
606 | if (ret < 0) { | |
607 | error_setg(errp, "Bitmap '%.*s' doesn't satisfy the constraints", | |
608 | e->name_size, dir_entry_name_field(e)); | |
609 | goto fail; | |
610 | } | |
611 | ||
5330f32b | 612 | bm = g_new0(Qcow2Bitmap, 1); |
88ddffae VSO |
613 | bm->table.offset = e->bitmap_table_offset; |
614 | bm->table.size = e->bitmap_table_size; | |
615 | bm->flags = e->flags; | |
616 | bm->granularity_bits = e->granularity_bits; | |
617 | bm->name = dir_entry_copy_name(e); | |
618 | QSIMPLEQ_INSERT_TAIL(bm_list, bm, entry); | |
619 | } | |
620 | ||
621 | if (nb_dir_entries != s->nb_bitmaps) { | |
622 | error_setg(errp, "Less bitmaps found than specified in header" | |
623 | " extension"); | |
624 | goto fail; | |
625 | } | |
626 | ||
627 | if ((uint8_t *)e != dir_end) { | |
628 | goto broken_dir; | |
629 | } | |
630 | ||
631 | g_free(dir); | |
632 | return bm_list; | |
633 | ||
634 | broken_dir: | |
635 | ret = -EINVAL; | |
636 | error_setg(errp, "Broken bitmap directory"); | |
637 | ||
638 | fail: | |
639 | g_free(dir); | |
640 | bitmap_list_free(bm_list); | |
641 | ||
642 | return NULL; | |
643 | } | |
644 | ||
645 | int qcow2_check_bitmaps_refcounts(BlockDriverState *bs, BdrvCheckResult *res, | |
646 | void **refcount_table, | |
647 | int64_t *refcount_table_size) | |
648 | { | |
649 | int ret; | |
650 | BDRVQcow2State *s = bs->opaque; | |
651 | Qcow2BitmapList *bm_list; | |
652 | Qcow2Bitmap *bm; | |
653 | ||
654 | if (s->nb_bitmaps == 0) { | |
655 | return 0; | |
656 | } | |
657 | ||
658 | ret = qcow2_inc_refcounts_imrt(bs, res, refcount_table, refcount_table_size, | |
659 | s->bitmap_directory_offset, | |
660 | s->bitmap_directory_size); | |
661 | if (ret < 0) { | |
662 | return ret; | |
663 | } | |
664 | ||
665 | bm_list = bitmap_list_load(bs, s->bitmap_directory_offset, | |
666 | s->bitmap_directory_size, NULL); | |
667 | if (bm_list == NULL) { | |
668 | res->corruptions++; | |
669 | return -EINVAL; | |
670 | } | |
671 | ||
672 | QSIMPLEQ_FOREACH(bm, bm_list, entry) { | |
673 | uint64_t *bitmap_table = NULL; | |
674 | int i; | |
675 | ||
676 | ret = qcow2_inc_refcounts_imrt(bs, res, | |
677 | refcount_table, refcount_table_size, | |
678 | bm->table.offset, | |
679 | bm->table.size * sizeof(uint64_t)); | |
680 | if (ret < 0) { | |
681 | goto out; | |
682 | } | |
683 | ||
684 | ret = bitmap_table_load(bs, &bm->table, &bitmap_table); | |
685 | if (ret < 0) { | |
686 | res->corruptions++; | |
687 | goto out; | |
688 | } | |
689 | ||
690 | for (i = 0; i < bm->table.size; ++i) { | |
691 | uint64_t entry = bitmap_table[i]; | |
692 | uint64_t offset = entry & BME_TABLE_ENTRY_OFFSET_MASK; | |
693 | ||
694 | if (check_table_entry(entry, s->cluster_size) < 0) { | |
695 | res->corruptions++; | |
696 | continue; | |
697 | } | |
698 | ||
699 | if (offset == 0) { | |
700 | continue; | |
701 | } | |
702 | ||
703 | ret = qcow2_inc_refcounts_imrt(bs, res, | |
704 | refcount_table, refcount_table_size, | |
705 | offset, s->cluster_size); | |
706 | if (ret < 0) { | |
707 | g_free(bitmap_table); | |
708 | goto out; | |
709 | } | |
710 | } | |
711 | ||
712 | g_free(bitmap_table); | |
713 | } | |
714 | ||
715 | out: | |
716 | bitmap_list_free(bm_list); | |
717 | ||
718 | return ret; | |
719 | } | |
d1258dd0 VSO |
720 | |
721 | /* bitmap_list_store | |
722 | * Store bitmap list to qcow2 image as a bitmap directory. | |
723 | * Everything is checked. | |
724 | */ | |
725 | static int bitmap_list_store(BlockDriverState *bs, Qcow2BitmapList *bm_list, | |
726 | uint64_t *offset, uint64_t *size, bool in_place) | |
727 | { | |
728 | int ret; | |
729 | uint8_t *dir; | |
730 | int64_t dir_offset = 0; | |
731 | uint64_t dir_size = 0; | |
732 | Qcow2Bitmap *bm; | |
733 | Qcow2BitmapDirEntry *e; | |
734 | ||
735 | QSIMPLEQ_FOREACH(bm, bm_list, entry) { | |
736 | dir_size += calc_dir_entry_size(strlen(bm->name), 0); | |
737 | } | |
738 | ||
739 | if (dir_size == 0 || dir_size > QCOW2_MAX_BITMAP_DIRECTORY_SIZE) { | |
740 | return -EINVAL; | |
741 | } | |
742 | ||
743 | if (in_place) { | |
744 | if (*size != dir_size || *offset == 0) { | |
745 | return -EINVAL; | |
746 | } | |
747 | ||
748 | dir_offset = *offset; | |
749 | } | |
750 | ||
751 | dir = g_try_malloc(dir_size); | |
752 | if (dir == NULL) { | |
753 | return -ENOMEM; | |
754 | } | |
755 | ||
756 | e = (Qcow2BitmapDirEntry *)dir; | |
757 | QSIMPLEQ_FOREACH(bm, bm_list, entry) { | |
758 | e->bitmap_table_offset = bm->table.offset; | |
759 | e->bitmap_table_size = bm->table.size; | |
760 | e->flags = bm->flags; | |
761 | e->type = BT_DIRTY_TRACKING_BITMAP; | |
762 | e->granularity_bits = bm->granularity_bits; | |
763 | e->name_size = strlen(bm->name); | |
764 | e->extra_data_size = 0; | |
765 | memcpy(e + 1, bm->name, e->name_size); | |
766 | ||
767 | if (check_dir_entry(bs, e) < 0) { | |
768 | ret = -EINVAL; | |
769 | goto fail; | |
770 | } | |
771 | ||
772 | e = next_dir_entry(e); | |
773 | } | |
774 | ||
775 | bitmap_directory_to_be(dir, dir_size); | |
776 | ||
777 | if (!in_place) { | |
778 | dir_offset = qcow2_alloc_clusters(bs, dir_size); | |
779 | if (dir_offset < 0) { | |
780 | ret = dir_offset; | |
781 | goto fail; | |
782 | } | |
783 | } | |
784 | ||
785 | ret = qcow2_pre_write_overlap_check(bs, 0, dir_offset, dir_size); | |
786 | if (ret < 0) { | |
787 | goto fail; | |
788 | } | |
789 | ||
790 | ret = bdrv_pwrite(bs->file, dir_offset, dir, dir_size); | |
791 | if (ret < 0) { | |
792 | goto fail; | |
793 | } | |
794 | ||
795 | g_free(dir); | |
796 | ||
797 | if (!in_place) { | |
798 | *size = dir_size; | |
799 | *offset = dir_offset; | |
800 | } | |
801 | ||
802 | return 0; | |
803 | ||
804 | fail: | |
805 | g_free(dir); | |
806 | ||
807 | if (!in_place && dir_offset > 0) { | |
808 | qcow2_free_clusters(bs, dir_offset, dir_size, QCOW2_DISCARD_OTHER); | |
809 | } | |
810 | ||
811 | return ret; | |
812 | } | |
813 | ||
814 | /* | |
815 | * Bitmap List end | |
816 | */ | |
817 | ||
818 | static int update_ext_header_and_dir_in_place(BlockDriverState *bs, | |
819 | Qcow2BitmapList *bm_list) | |
820 | { | |
821 | BDRVQcow2State *s = bs->opaque; | |
822 | int ret; | |
823 | ||
824 | if (!(s->autoclear_features & QCOW2_AUTOCLEAR_BITMAPS) || | |
825 | bm_list == NULL || QSIMPLEQ_EMPTY(bm_list) || | |
826 | bitmap_list_count(bm_list) != s->nb_bitmaps) | |
827 | { | |
828 | return -EINVAL; | |
829 | } | |
830 | ||
831 | s->autoclear_features &= ~(uint64_t)QCOW2_AUTOCLEAR_BITMAPS; | |
832 | ret = update_header_sync(bs); | |
833 | if (ret < 0) { | |
834 | /* Two variants are possible here: | |
835 | * 1. Autoclear flag is dropped, all bitmaps will be lost. | |
836 | * 2. Autoclear flag is not dropped, old state is left. | |
837 | */ | |
838 | return ret; | |
839 | } | |
840 | ||
841 | /* autoclear bit is not set, so we can safely update bitmap directory */ | |
842 | ||
843 | ret = bitmap_list_store(bs, bm_list, &s->bitmap_directory_offset, | |
844 | &s->bitmap_directory_size, true); | |
845 | if (ret < 0) { | |
846 | /* autoclear bit is cleared, so all leaked clusters would be removed on | |
847 | * qemu-img check */ | |
848 | return ret; | |
849 | } | |
850 | ||
851 | ret = update_header_sync(bs); | |
852 | if (ret < 0) { | |
853 | /* autoclear bit is cleared, so all leaked clusters would be removed on | |
854 | * qemu-img check */ | |
855 | return ret; | |
856 | } | |
857 | ||
858 | s->autoclear_features |= QCOW2_AUTOCLEAR_BITMAPS; | |
859 | return update_header_sync(bs); | |
860 | /* If final update_header_sync() fails, two variants are possible: | |
861 | * 1. Autoclear flag is not set, all bitmaps will be lost. | |
862 | * 2. Autoclear flag is set, header and directory are successfully updated. | |
863 | */ | |
864 | } | |
865 | ||
5f72826e VSO |
866 | static int update_ext_header_and_dir(BlockDriverState *bs, |
867 | Qcow2BitmapList *bm_list) | |
868 | { | |
869 | BDRVQcow2State *s = bs->opaque; | |
870 | int ret; | |
871 | uint64_t new_offset = 0; | |
872 | uint64_t new_size = 0; | |
873 | uint32_t new_nb_bitmaps = 0; | |
874 | uint64_t old_offset = s->bitmap_directory_offset; | |
875 | uint64_t old_size = s->bitmap_directory_size; | |
876 | uint32_t old_nb_bitmaps = s->nb_bitmaps; | |
877 | uint64_t old_autocl = s->autoclear_features; | |
878 | ||
879 | if (bm_list != NULL && !QSIMPLEQ_EMPTY(bm_list)) { | |
880 | new_nb_bitmaps = bitmap_list_count(bm_list); | |
881 | ||
882 | if (new_nb_bitmaps > QCOW2_MAX_BITMAPS) { | |
883 | return -EINVAL; | |
884 | } | |
885 | ||
886 | ret = bitmap_list_store(bs, bm_list, &new_offset, &new_size, false); | |
887 | if (ret < 0) { | |
888 | return ret; | |
889 | } | |
890 | ||
891 | ret = bdrv_flush(bs->file->bs); | |
892 | if (ret < 0) { | |
893 | goto fail; | |
894 | } | |
895 | ||
896 | s->autoclear_features |= QCOW2_AUTOCLEAR_BITMAPS; | |
897 | } else { | |
898 | s->autoclear_features &= ~(uint64_t)QCOW2_AUTOCLEAR_BITMAPS; | |
899 | } | |
900 | ||
901 | s->bitmap_directory_offset = new_offset; | |
902 | s->bitmap_directory_size = new_size; | |
903 | s->nb_bitmaps = new_nb_bitmaps; | |
904 | ||
905 | ret = update_header_sync(bs); | |
906 | if (ret < 0) { | |
907 | goto fail; | |
908 | } | |
909 | ||
910 | if (old_size > 0) { | |
911 | qcow2_free_clusters(bs, old_offset, old_size, QCOW2_DISCARD_OTHER); | |
912 | } | |
913 | ||
914 | return 0; | |
915 | ||
916 | fail: | |
917 | if (new_offset > 0) { | |
918 | qcow2_free_clusters(bs, new_offset, new_size, QCOW2_DISCARD_OTHER); | |
919 | } | |
920 | ||
921 | s->bitmap_directory_offset = old_offset; | |
922 | s->bitmap_directory_size = old_size; | |
923 | s->nb_bitmaps = old_nb_bitmaps; | |
924 | s->autoclear_features = old_autocl; | |
925 | ||
926 | return ret; | |
927 | } | |
928 | ||
d1258dd0 VSO |
929 | /* for g_slist_foreach for GSList of BdrvDirtyBitmap* elements */ |
930 | static void release_dirty_bitmap_helper(gpointer bitmap, | |
931 | gpointer bs) | |
932 | { | |
933 | bdrv_release_dirty_bitmap(bs, bitmap); | |
934 | } | |
935 | ||
936 | /* for g_slist_foreach for GSList of BdrvDirtyBitmap* elements */ | |
937 | static void set_readonly_helper(gpointer bitmap, gpointer value) | |
938 | { | |
939 | bdrv_dirty_bitmap_set_readonly(bitmap, (bool)value); | |
940 | } | |
941 | ||
942 | /* qcow2_load_autoloading_dirty_bitmaps() | |
943 | * Return value is a hint for caller: true means that the Qcow2 header was | |
944 | * updated. (false doesn't mean that the header should be updated by the | |
945 | * caller, it just means that updating was not needed or the image cannot be | |
946 | * written to). | |
947 | * On failure the function returns false. | |
948 | */ | |
949 | bool qcow2_load_autoloading_dirty_bitmaps(BlockDriverState *bs, Error **errp) | |
950 | { | |
951 | BDRVQcow2State *s = bs->opaque; | |
952 | Qcow2BitmapList *bm_list; | |
953 | Qcow2Bitmap *bm; | |
954 | GSList *created_dirty_bitmaps = NULL; | |
955 | bool header_updated = false; | |
956 | ||
957 | if (s->nb_bitmaps == 0) { | |
958 | /* No bitmaps - nothing to do */ | |
959 | return false; | |
960 | } | |
961 | ||
962 | bm_list = bitmap_list_load(bs, s->bitmap_directory_offset, | |
963 | s->bitmap_directory_size, errp); | |
964 | if (bm_list == NULL) { | |
965 | return false; | |
966 | } | |
967 | ||
968 | QSIMPLEQ_FOREACH(bm, bm_list, entry) { | |
969 | if ((bm->flags & BME_FLAG_AUTO) && !(bm->flags & BME_FLAG_IN_USE)) { | |
970 | BdrvDirtyBitmap *bitmap = load_bitmap(bs, bm, errp); | |
971 | if (bitmap == NULL) { | |
972 | goto fail; | |
973 | } | |
a0319aac | 974 | |
a88b179f | 975 | bdrv_dirty_bitmap_set_persistance(bitmap, true); |
a0319aac | 976 | bdrv_dirty_bitmap_set_autoload(bitmap, true); |
d1258dd0 VSO |
977 | bm->flags |= BME_FLAG_IN_USE; |
978 | created_dirty_bitmaps = | |
979 | g_slist_append(created_dirty_bitmaps, bitmap); | |
980 | } | |
981 | } | |
982 | ||
983 | if (created_dirty_bitmaps != NULL) { | |
984 | if (can_write(bs)) { | |
985 | /* in_use flags must be updated */ | |
986 | int ret = update_ext_header_and_dir_in_place(bs, bm_list); | |
987 | if (ret < 0) { | |
988 | error_setg_errno(errp, -ret, "Can't update bitmap directory"); | |
989 | goto fail; | |
990 | } | |
991 | header_updated = true; | |
992 | } else { | |
993 | g_slist_foreach(created_dirty_bitmaps, set_readonly_helper, | |
994 | (gpointer)true); | |
995 | } | |
996 | } | |
997 | ||
998 | g_slist_free(created_dirty_bitmaps); | |
999 | bitmap_list_free(bm_list); | |
1000 | ||
1001 | return header_updated; | |
1002 | ||
1003 | fail: | |
1004 | g_slist_foreach(created_dirty_bitmaps, release_dirty_bitmap_helper, bs); | |
1005 | g_slist_free(created_dirty_bitmaps); | |
1006 | bitmap_list_free(bm_list); | |
1007 | ||
1008 | return false; | |
1009 | } | |
1b6b0562 VSO |
1010 | |
1011 | int qcow2_reopen_bitmaps_rw(BlockDriverState *bs, Error **errp) | |
1012 | { | |
1013 | BDRVQcow2State *s = bs->opaque; | |
1014 | Qcow2BitmapList *bm_list; | |
1015 | Qcow2Bitmap *bm; | |
1016 | GSList *ro_dirty_bitmaps = NULL; | |
1017 | int ret = 0; | |
1018 | ||
1019 | if (s->nb_bitmaps == 0) { | |
1020 | /* No bitmaps - nothing to do */ | |
1021 | return 0; | |
1022 | } | |
1023 | ||
1024 | if (!can_write(bs)) { | |
1025 | error_setg(errp, "Can't write to the image on reopening bitmaps rw"); | |
1026 | return -EINVAL; | |
1027 | } | |
1028 | ||
1029 | bm_list = bitmap_list_load(bs, s->bitmap_directory_offset, | |
1030 | s->bitmap_directory_size, errp); | |
1031 | if (bm_list == NULL) { | |
1032 | return -EINVAL; | |
1033 | } | |
1034 | ||
1035 | QSIMPLEQ_FOREACH(bm, bm_list, entry) { | |
1036 | if (!(bm->flags & BME_FLAG_IN_USE)) { | |
1037 | BdrvDirtyBitmap *bitmap = bdrv_find_dirty_bitmap(bs, bm->name); | |
1038 | if (bitmap == NULL) { | |
1039 | continue; | |
1040 | } | |
1041 | ||
1042 | if (!bdrv_dirty_bitmap_readonly(bitmap)) { | |
1043 | error_setg(errp, "Bitmap %s is not readonly but not marked" | |
1044 | "'IN_USE' in the image. Something went wrong," | |
1045 | "all the bitmaps may be corrupted", bm->name); | |
1046 | ret = -EINVAL; | |
1047 | goto out; | |
1048 | } | |
1049 | ||
1050 | bm->flags |= BME_FLAG_IN_USE; | |
1051 | ro_dirty_bitmaps = g_slist_append(ro_dirty_bitmaps, bitmap); | |
1052 | } | |
1053 | } | |
1054 | ||
1055 | if (ro_dirty_bitmaps != NULL) { | |
1056 | /* in_use flags must be updated */ | |
1057 | ret = update_ext_header_and_dir_in_place(bs, bm_list); | |
1058 | if (ret < 0) { | |
1059 | error_setg_errno(errp, -ret, "Can't update bitmap directory"); | |
1060 | goto out; | |
1061 | } | |
1062 | g_slist_foreach(ro_dirty_bitmaps, set_readonly_helper, false); | |
1063 | } | |
1064 | ||
1065 | out: | |
1066 | g_slist_free(ro_dirty_bitmaps); | |
1067 | bitmap_list_free(bm_list); | |
1068 | ||
1069 | return ret; | |
1070 | } | |
5f72826e VSO |
1071 | |
1072 | /* store_bitmap_data() | |
1073 | * Store bitmap to image, filling bitmap table accordingly. | |
1074 | */ | |
1075 | static uint64_t *store_bitmap_data(BlockDriverState *bs, | |
1076 | BdrvDirtyBitmap *bitmap, | |
1077 | uint32_t *bitmap_table_size, Error **errp) | |
1078 | { | |
1079 | int ret; | |
1080 | BDRVQcow2State *s = bs->opaque; | |
1081 | int64_t sector; | |
c7e7c87a | 1082 | uint64_t limit, sbc; |
5f72826e | 1083 | uint64_t bm_size = bdrv_dirty_bitmap_size(bitmap); |
ebfcd2e7 | 1084 | uint64_t bm_sectors = DIV_ROUND_UP(bm_size, BDRV_SECTOR_SIZE); |
5f72826e VSO |
1085 | const char *bm_name = bdrv_dirty_bitmap_name(bitmap); |
1086 | uint8_t *buf = NULL; | |
1087 | BdrvDirtyBitmapIter *dbi; | |
1088 | uint64_t *tb; | |
1089 | uint64_t tb_size = | |
1090 | size_to_clusters(s, | |
86f6ae67 | 1091 | bdrv_dirty_bitmap_serialization_size(bitmap, 0, bm_size)); |
5f72826e VSO |
1092 | |
1093 | if (tb_size > BME_MAX_TABLE_SIZE || | |
1094 | tb_size * s->cluster_size > BME_MAX_PHYS_SIZE) | |
1095 | { | |
1096 | error_setg(errp, "Bitmap '%s' is too big", bm_name); | |
1097 | return NULL; | |
1098 | } | |
1099 | ||
1100 | tb = g_try_new0(uint64_t, tb_size); | |
1101 | if (tb == NULL) { | |
1102 | error_setg(errp, "No memory"); | |
1103 | return NULL; | |
1104 | } | |
1105 | ||
1106 | dbi = bdrv_dirty_iter_new(bitmap, 0); | |
1107 | buf = g_malloc(s->cluster_size); | |
c7e7c87a EB |
1108 | limit = bytes_covered_by_bitmap_cluster(s, bitmap); |
1109 | sbc = limit >> BDRV_SECTOR_BITS; | |
1110 | assert(DIV_ROUND_UP(bm_size, limit) == tb_size); | |
5f72826e VSO |
1111 | |
1112 | while ((sector = bdrv_dirty_iter_next(dbi)) != -1) { | |
1113 | uint64_t cluster = sector / sbc; | |
1114 | uint64_t end, write_size; | |
1115 | int64_t off; | |
1116 | ||
1117 | sector = cluster * sbc; | |
ebfcd2e7 | 1118 | end = MIN(bm_sectors, sector + sbc); |
86f6ae67 EB |
1119 | write_size = bdrv_dirty_bitmap_serialization_size(bitmap, |
1120 | sector * BDRV_SECTOR_SIZE, (end - sector) * BDRV_SECTOR_SIZE); | |
5f72826e VSO |
1121 | assert(write_size <= s->cluster_size); |
1122 | ||
1123 | off = qcow2_alloc_clusters(bs, s->cluster_size); | |
1124 | if (off < 0) { | |
1125 | error_setg_errno(errp, -off, | |
1126 | "Failed to allocate clusters for bitmap '%s'", | |
1127 | bm_name); | |
1128 | goto fail; | |
1129 | } | |
1130 | tb[cluster] = off; | |
1131 | ||
86f6ae67 EB |
1132 | bdrv_dirty_bitmap_serialize_part(bitmap, buf, |
1133 | sector * BDRV_SECTOR_SIZE, | |
1134 | (end - sector) * BDRV_SECTOR_SIZE); | |
5f72826e VSO |
1135 | if (write_size < s->cluster_size) { |
1136 | memset(buf + write_size, 0, s->cluster_size - write_size); | |
1137 | } | |
1138 | ||
1139 | ret = qcow2_pre_write_overlap_check(bs, 0, off, s->cluster_size); | |
1140 | if (ret < 0) { | |
1141 | error_setg_errno(errp, -ret, "Qcow2 overlap check failed"); | |
1142 | goto fail; | |
1143 | } | |
1144 | ||
1145 | ret = bdrv_pwrite(bs->file, off, buf, s->cluster_size); | |
1146 | if (ret < 0) { | |
1147 | error_setg_errno(errp, -ret, "Failed to write bitmap '%s' to file", | |
1148 | bm_name); | |
1149 | goto fail; | |
1150 | } | |
1151 | ||
ebfcd2e7 | 1152 | if (end >= bm_sectors) { |
5f72826e VSO |
1153 | break; |
1154 | } | |
1155 | ||
1156 | bdrv_set_dirty_iter(dbi, end); | |
1157 | } | |
1158 | ||
1159 | *bitmap_table_size = tb_size; | |
1160 | g_free(buf); | |
1161 | bdrv_dirty_iter_free(dbi); | |
1162 | ||
1163 | return tb; | |
1164 | ||
1165 | fail: | |
1166 | clear_bitmap_table(bs, tb, tb_size); | |
1167 | g_free(buf); | |
1168 | bdrv_dirty_iter_free(dbi); | |
1169 | g_free(tb); | |
1170 | ||
1171 | return NULL; | |
1172 | } | |
1173 | ||
1174 | /* store_bitmap() | |
1175 | * Store bm->dirty_bitmap to qcow2. | |
1176 | * Set bm->table_offset and bm->table_size accordingly. | |
1177 | */ | |
1178 | static int store_bitmap(BlockDriverState *bs, Qcow2Bitmap *bm, Error **errp) | |
1179 | { | |
1180 | int ret; | |
1181 | uint64_t *tb; | |
1182 | int64_t tb_offset; | |
1183 | uint32_t tb_size; | |
1184 | BdrvDirtyBitmap *bitmap = bm->dirty_bitmap; | |
1185 | const char *bm_name; | |
1186 | ||
1187 | assert(bitmap != NULL); | |
1188 | ||
1189 | bm_name = bdrv_dirty_bitmap_name(bitmap); | |
1190 | ||
1191 | tb = store_bitmap_data(bs, bitmap, &tb_size, errp); | |
1192 | if (tb == NULL) { | |
1193 | return -EINVAL; | |
1194 | } | |
1195 | ||
1196 | assert(tb_size <= BME_MAX_TABLE_SIZE); | |
1197 | tb_offset = qcow2_alloc_clusters(bs, tb_size * sizeof(tb[0])); | |
1198 | if (tb_offset < 0) { | |
1199 | error_setg_errno(errp, -tb_offset, | |
1200 | "Failed to allocate clusters for bitmap '%s'", | |
1201 | bm_name); | |
1202 | ret = tb_offset; | |
1203 | goto fail; | |
1204 | } | |
1205 | ||
1206 | ret = qcow2_pre_write_overlap_check(bs, 0, tb_offset, | |
1207 | tb_size * sizeof(tb[0])); | |
1208 | if (ret < 0) { | |
1209 | error_setg_errno(errp, -ret, "Qcow2 overlap check failed"); | |
1210 | goto fail; | |
1211 | } | |
1212 | ||
1213 | bitmap_table_to_be(tb, tb_size); | |
1214 | ret = bdrv_pwrite(bs->file, tb_offset, tb, tb_size * sizeof(tb[0])); | |
1215 | if (ret < 0) { | |
1216 | error_setg_errno(errp, -ret, "Failed to write bitmap '%s' to file", | |
1217 | bm_name); | |
1218 | goto fail; | |
1219 | } | |
1220 | ||
1221 | g_free(tb); | |
1222 | ||
1223 | bm->table.offset = tb_offset; | |
1224 | bm->table.size = tb_size; | |
1225 | ||
1226 | return 0; | |
1227 | ||
1228 | fail: | |
1229 | clear_bitmap_table(bs, tb, tb_size); | |
1230 | ||
1231 | if (tb_offset > 0) { | |
1232 | qcow2_free_clusters(bs, tb_offset, tb_size * sizeof(tb[0]), | |
1233 | QCOW2_DISCARD_OTHER); | |
1234 | } | |
1235 | ||
1236 | g_free(tb); | |
1237 | ||
1238 | return ret; | |
1239 | } | |
1240 | ||
1241 | static Qcow2Bitmap *find_bitmap_by_name(Qcow2BitmapList *bm_list, | |
1242 | const char *name) | |
1243 | { | |
1244 | Qcow2Bitmap *bm; | |
1245 | ||
1246 | QSIMPLEQ_FOREACH(bm, bm_list, entry) { | |
1247 | if (strcmp(name, bm->name) == 0) { | |
1248 | return bm; | |
1249 | } | |
1250 | } | |
1251 | ||
1252 | return NULL; | |
1253 | } | |
1254 | ||
469c71ed VSO |
1255 | void qcow2_remove_persistent_dirty_bitmap(BlockDriverState *bs, |
1256 | const char *name, | |
1257 | Error **errp) | |
1258 | { | |
1259 | int ret; | |
1260 | BDRVQcow2State *s = bs->opaque; | |
1261 | Qcow2Bitmap *bm; | |
1262 | Qcow2BitmapList *bm_list; | |
1263 | ||
1264 | if (s->nb_bitmaps == 0) { | |
1265 | /* Absence of the bitmap is not an error: see explanation above | |
1266 | * bdrv_remove_persistent_dirty_bitmap() definition. */ | |
1267 | return; | |
1268 | } | |
1269 | ||
1270 | bm_list = bitmap_list_load(bs, s->bitmap_directory_offset, | |
1271 | s->bitmap_directory_size, errp); | |
1272 | if (bm_list == NULL) { | |
1273 | return; | |
1274 | } | |
1275 | ||
1276 | bm = find_bitmap_by_name(bm_list, name); | |
1277 | if (bm == NULL) { | |
1278 | goto fail; | |
1279 | } | |
1280 | ||
1281 | QSIMPLEQ_REMOVE(bm_list, bm, Qcow2Bitmap, entry); | |
1282 | ||
1283 | ret = update_ext_header_and_dir(bs, bm_list); | |
1284 | if (ret < 0) { | |
1285 | error_setg_errno(errp, -ret, "Failed to update bitmap extension"); | |
1286 | goto fail; | |
1287 | } | |
1288 | ||
1289 | free_bitmap_clusters(bs, &bm->table); | |
1290 | ||
1291 | fail: | |
1292 | bitmap_free(bm); | |
1293 | bitmap_list_free(bm_list); | |
1294 | } | |
1295 | ||
5f72826e VSO |
1296 | void qcow2_store_persistent_dirty_bitmaps(BlockDriverState *bs, Error **errp) |
1297 | { | |
1298 | BdrvDirtyBitmap *bitmap; | |
1299 | BDRVQcow2State *s = bs->opaque; | |
1300 | uint32_t new_nb_bitmaps = s->nb_bitmaps; | |
1301 | uint64_t new_dir_size = s->bitmap_directory_size; | |
1302 | int ret; | |
1303 | Qcow2BitmapList *bm_list; | |
1304 | Qcow2Bitmap *bm; | |
1305 | Qcow2BitmapTableList drop_tables; | |
1306 | Qcow2BitmapTable *tb, *tb_next; | |
1307 | ||
1308 | if (!bdrv_has_changed_persistent_bitmaps(bs)) { | |
1309 | /* nothing to do */ | |
1310 | return; | |
1311 | } | |
1312 | ||
1313 | if (!can_write(bs)) { | |
1314 | error_setg(errp, "No write access"); | |
1315 | return; | |
1316 | } | |
1317 | ||
1318 | QSIMPLEQ_INIT(&drop_tables); | |
1319 | ||
1320 | if (s->nb_bitmaps == 0) { | |
1321 | bm_list = bitmap_list_new(); | |
1322 | } else { | |
1323 | bm_list = bitmap_list_load(bs, s->bitmap_directory_offset, | |
1324 | s->bitmap_directory_size, errp); | |
1325 | if (bm_list == NULL) { | |
1326 | return; | |
1327 | } | |
1328 | } | |
1329 | ||
1330 | /* check constraints and names */ | |
1331 | for (bitmap = bdrv_dirty_bitmap_next(bs, NULL); bitmap != NULL; | |
1332 | bitmap = bdrv_dirty_bitmap_next(bs, bitmap)) | |
1333 | { | |
1334 | const char *name = bdrv_dirty_bitmap_name(bitmap); | |
1335 | uint32_t granularity = bdrv_dirty_bitmap_granularity(bitmap); | |
1336 | Qcow2Bitmap *bm; | |
1337 | ||
1338 | if (!bdrv_dirty_bitmap_get_persistance(bitmap) || | |
1339 | bdrv_dirty_bitmap_readonly(bitmap)) | |
1340 | { | |
1341 | continue; | |
1342 | } | |
1343 | ||
1344 | if (check_constraints_on_bitmap(bs, name, granularity, errp) < 0) { | |
1345 | error_prepend(errp, "Bitmap '%s' doesn't satisfy the constraints: ", | |
1346 | name); | |
1347 | goto fail; | |
1348 | } | |
1349 | ||
1350 | bm = find_bitmap_by_name(bm_list, name); | |
1351 | if (bm == NULL) { | |
1352 | if (++new_nb_bitmaps > QCOW2_MAX_BITMAPS) { | |
1353 | error_setg(errp, "Too many persistent bitmaps"); | |
1354 | goto fail; | |
1355 | } | |
1356 | ||
1357 | new_dir_size += calc_dir_entry_size(strlen(name), 0); | |
1358 | if (new_dir_size > QCOW2_MAX_BITMAP_DIRECTORY_SIZE) { | |
1359 | error_setg(errp, "Bitmap directory is too large"); | |
1360 | goto fail; | |
1361 | } | |
1362 | ||
1363 | bm = g_new0(Qcow2Bitmap, 1); | |
1364 | bm->name = g_strdup(name); | |
1365 | QSIMPLEQ_INSERT_TAIL(bm_list, bm, entry); | |
1366 | } else { | |
1367 | if (!(bm->flags & BME_FLAG_IN_USE)) { | |
1368 | error_setg(errp, "Bitmap '%s' already exists in the image", | |
1369 | name); | |
1370 | goto fail; | |
1371 | } | |
1372 | tb = g_memdup(&bm->table, sizeof(bm->table)); | |
1373 | bm->table.offset = 0; | |
1374 | bm->table.size = 0; | |
1375 | QSIMPLEQ_INSERT_TAIL(&drop_tables, tb, entry); | |
1376 | } | |
1377 | bm->flags = bdrv_dirty_bitmap_get_autoload(bitmap) ? BME_FLAG_AUTO : 0; | |
1378 | bm->granularity_bits = ctz32(bdrv_dirty_bitmap_granularity(bitmap)); | |
1379 | bm->dirty_bitmap = bitmap; | |
1380 | } | |
1381 | ||
1382 | /* allocate clusters and store bitmaps */ | |
1383 | QSIMPLEQ_FOREACH(bm, bm_list, entry) { | |
1384 | if (bm->dirty_bitmap == NULL) { | |
1385 | continue; | |
1386 | } | |
1387 | ||
1388 | ret = store_bitmap(bs, bm, errp); | |
1389 | if (ret < 0) { | |
1390 | goto fail; | |
1391 | } | |
1392 | } | |
1393 | ||
1394 | ret = update_ext_header_and_dir(bs, bm_list); | |
1395 | if (ret < 0) { | |
1396 | error_setg_errno(errp, -ret, "Failed to update bitmap extension"); | |
1397 | goto fail; | |
1398 | } | |
1399 | ||
1400 | /* Bitmap directory was successfully updated, so, old data can be dropped. | |
1401 | * TODO it is better to reuse these clusters */ | |
1402 | QSIMPLEQ_FOREACH_SAFE(tb, &drop_tables, entry, tb_next) { | |
1403 | free_bitmap_clusters(bs, tb); | |
1404 | g_free(tb); | |
1405 | } | |
1406 | ||
1407 | bitmap_list_free(bm_list); | |
1408 | return; | |
1409 | ||
1410 | fail: | |
1411 | QSIMPLEQ_FOREACH(bm, bm_list, entry) { | |
1412 | if (bm->dirty_bitmap == NULL || bm->table.offset == 0) { | |
1413 | continue; | |
1414 | } | |
1415 | ||
1416 | free_bitmap_clusters(bs, &bm->table); | |
1417 | } | |
1418 | ||
1419 | QSIMPLEQ_FOREACH_SAFE(tb, &drop_tables, entry, tb_next) { | |
1420 | g_free(tb); | |
1421 | } | |
1422 | ||
1423 | bitmap_list_free(bm_list); | |
1424 | } | |
169b8793 VSO |
1425 | |
1426 | int qcow2_reopen_bitmaps_ro(BlockDriverState *bs, Error **errp) | |
1427 | { | |
1428 | BdrvDirtyBitmap *bitmap; | |
1429 | Error *local_err = NULL; | |
1430 | ||
1431 | qcow2_store_persistent_dirty_bitmaps(bs, &local_err); | |
1432 | if (local_err != NULL) { | |
1433 | error_propagate(errp, local_err); | |
1434 | return -EINVAL; | |
1435 | } | |
1436 | ||
1437 | for (bitmap = bdrv_dirty_bitmap_next(bs, NULL); bitmap != NULL; | |
1438 | bitmap = bdrv_dirty_bitmap_next(bs, bitmap)) | |
1439 | { | |
1440 | if (bdrv_dirty_bitmap_get_persistance(bitmap)) { | |
1441 | bdrv_dirty_bitmap_set_readonly(bitmap, true); | |
1442 | } | |
1443 | } | |
1444 | ||
1445 | return 0; | |
1446 | } | |
da0eb242 VSO |
1447 | |
1448 | bool qcow2_can_store_new_dirty_bitmap(BlockDriverState *bs, | |
1449 | const char *name, | |
1450 | uint32_t granularity, | |
1451 | Error **errp) | |
1452 | { | |
1453 | BDRVQcow2State *s = bs->opaque; | |
1454 | bool found; | |
1455 | Qcow2BitmapList *bm_list; | |
1456 | ||
1457 | if (check_constraints_on_bitmap(bs, name, granularity, errp) != 0) { | |
1458 | goto fail; | |
1459 | } | |
1460 | ||
1461 | if (s->nb_bitmaps == 0) { | |
1462 | return true; | |
1463 | } | |
1464 | ||
1465 | if (s->nb_bitmaps >= QCOW2_MAX_BITMAPS) { | |
1466 | error_setg(errp, | |
1467 | "Maximum number of persistent bitmaps is already reached"); | |
1468 | goto fail; | |
1469 | } | |
1470 | ||
1471 | if (s->bitmap_directory_size + calc_dir_entry_size(strlen(name), 0) > | |
1472 | QCOW2_MAX_BITMAP_DIRECTORY_SIZE) | |
1473 | { | |
1474 | error_setg(errp, "Not enough space in the bitmap directory"); | |
1475 | goto fail; | |
1476 | } | |
1477 | ||
1478 | bm_list = bitmap_list_load(bs, s->bitmap_directory_offset, | |
1479 | s->bitmap_directory_size, errp); | |
1480 | if (bm_list == NULL) { | |
1481 | goto fail; | |
1482 | } | |
1483 | ||
1484 | found = find_bitmap_by_name(bm_list, name); | |
1485 | bitmap_list_free(bm_list); | |
1486 | if (found) { | |
1487 | error_setg(errp, "Bitmap with the same name is already stored"); | |
1488 | goto fail; | |
1489 | } | |
1490 | ||
1491 | return true; | |
1492 | ||
1493 | fail: | |
1494 | error_prepend(errp, "Can't make bitmap '%s' persistent in '%s': ", | |
1495 | name, bdrv_get_device_or_node_name(bs)); | |
1496 | return false; | |
1497 | } |