1 /* 2 * Block driver for the QCOW version 2 format 3 * 4 * Copyright (c) 2004-2006 Fabrice Bellard 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a copy 7 * of this software and associated documentation files (the "Software"), to deal 8 * in the Software without restriction, including without limitation the rights 9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10 * copies of the Software, and to permit persons to whom the Software is 11 * furnished to do so, subject to the following conditions: 12 * 13 * The above copyright notice and this permission notice shall be included in 14 * all copies or substantial portions of the Software. 15 * 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 22 * THE SOFTWARE. 23 */ 24 25 #ifndef BLOCK_QCOW2_H 26 #define BLOCK_QCOW2_H 27 28 #include "crypto/block.h" 29 #include "qemu/coroutine.h" 30 #include "qemu/units.h" 31 32 //#define DEBUG_ALLOC 33 //#define DEBUG_ALLOC2 34 //#define DEBUG_EXT 35 36 #define QCOW_MAGIC (('Q' << 24) | ('F' << 16) | ('I' << 8) | 0xfb) 37 38 #define QCOW_CRYPT_NONE 0 39 #define QCOW_CRYPT_AES 1 40 #define QCOW_CRYPT_LUKS 2 41 42 #define QCOW_MAX_CRYPT_CLUSTERS 32 43 #define QCOW_MAX_SNAPSHOTS 65536 44 45 /* 8 MB refcount table is enough for 2 PB images at 64k cluster size 46 * (128 GB for 512 byte clusters, 2 EB for 2 MB clusters) */ 47 #define QCOW_MAX_REFTABLE_SIZE S_8MiB 48 49 /* 32 MB L1 table is enough for 2 PB images at 64k cluster size 50 * (128 GB for 512 byte clusters, 2 EB for 2 MB clusters) */ 51 #define QCOW_MAX_L1_SIZE S_32MiB 52 53 /* Allow for an average of 1k per snapshot table entry, should be plenty of 54 * space for snapshot names and IDs */ 55 #define QCOW_MAX_SNAPSHOTS_SIZE (1024 * QCOW_MAX_SNAPSHOTS) 56 57 /* Bitmap header extension constraints */ 58 #define QCOW2_MAX_BITMAPS 65535 59 #define QCOW2_MAX_BITMAP_DIRECTORY_SIZE (1024 * QCOW2_MAX_BITMAPS) 60 61 /* indicate that the refcount of the referenced cluster is exactly one. */ 62 #define QCOW_OFLAG_COPIED (1ULL << 63) 63 /* indicate that the cluster is compressed (they never have the copied flag) */ 64 #define QCOW_OFLAG_COMPRESSED (1ULL << 62) 65 /* The cluster reads as all zeros */ 66 #define QCOW_OFLAG_ZERO (1ULL << 0) 67 68 #define MIN_CLUSTER_BITS 9 69 #define MAX_CLUSTER_BITS 21 70 71 /* Must be at least 2 to cover COW */ 72 #define MIN_L2_CACHE_SIZE 2 /* cache entries */ 73 74 /* Must be at least 4 to cover all cases of refcount table growth */ 75 #define MIN_REFCOUNT_CACHE_SIZE 4 /* clusters */ 76 77 #ifdef CONFIG_LINUX 78 #define DEFAULT_L2_CACHE_MAX_SIZE S_32MiB 79 #define DEFAULT_CACHE_CLEAN_INTERVAL 600 /* seconds */ 80 #else 81 #define DEFAULT_L2_CACHE_MAX_SIZE S_8MiB 82 /* Cache clean interval is currently available only on Linux, so must be 0 */ 83 #define DEFAULT_CACHE_CLEAN_INTERVAL 0 84 #endif 85 86 #define DEFAULT_CLUSTER_SIZE S_64KiB 87 88 #define QCOW2_OPT_LAZY_REFCOUNTS "lazy-refcounts" 89 #define QCOW2_OPT_DISCARD_REQUEST "pass-discard-request" 90 #define QCOW2_OPT_DISCARD_SNAPSHOT "pass-discard-snapshot" 91 #define QCOW2_OPT_DISCARD_OTHER "pass-discard-other" 92 #define QCOW2_OPT_OVERLAP "overlap-check" 93 #define QCOW2_OPT_OVERLAP_TEMPLATE "overlap-check.template" 94 #define QCOW2_OPT_OVERLAP_MAIN_HEADER "overlap-check.main-header" 95 #define QCOW2_OPT_OVERLAP_ACTIVE_L1 "overlap-check.active-l1" 96 #define QCOW2_OPT_OVERLAP_ACTIVE_L2 "overlap-check.active-l2" 97 #define QCOW2_OPT_OVERLAP_REFCOUNT_TABLE "overlap-check.refcount-table" 98 #define QCOW2_OPT_OVERLAP_REFCOUNT_BLOCK "overlap-check.refcount-block" 99 #define QCOW2_OPT_OVERLAP_SNAPSHOT_TABLE "overlap-check.snapshot-table" 100 #define QCOW2_OPT_OVERLAP_INACTIVE_L1 "overlap-check.inactive-l1" 101 #define QCOW2_OPT_OVERLAP_INACTIVE_L2 "overlap-check.inactive-l2" 102 #define QCOW2_OPT_OVERLAP_BITMAP_DIRECTORY "overlap-check.bitmap-directory" 103 #define QCOW2_OPT_CACHE_SIZE "cache-size" 104 #define QCOW2_OPT_L2_CACHE_SIZE "l2-cache-size" 105 #define QCOW2_OPT_L2_CACHE_ENTRY_SIZE "l2-cache-entry-size" 106 #define QCOW2_OPT_REFCOUNT_CACHE_SIZE "refcount-cache-size" 107 #define QCOW2_OPT_CACHE_CLEAN_INTERVAL "cache-clean-interval" 108 109 typedef struct QCowHeader { 110 uint32_t magic; 111 uint32_t version; 112 uint64_t backing_file_offset; 113 uint32_t backing_file_size; 114 uint32_t cluster_bits; 115 uint64_t size; /* in bytes */ 116 uint32_t crypt_method; 117 uint32_t l1_size; /* XXX: save number of clusters instead ? */ 118 uint64_t l1_table_offset; 119 uint64_t refcount_table_offset; 120 uint32_t refcount_table_clusters; 121 uint32_t nb_snapshots; 122 uint64_t snapshots_offset; 123 124 /* The following fields are only valid for version >= 3 */ 125 uint64_t incompatible_features; 126 uint64_t compatible_features; 127 uint64_t autoclear_features; 128 129 uint32_t refcount_order; 130 uint32_t header_length; 131 } QEMU_PACKED QCowHeader; 132 133 typedef struct QEMU_PACKED QCowSnapshotHeader { 134 /* header is 8 byte aligned */ 135 uint64_t l1_table_offset; 136 137 uint32_t l1_size; 138 uint16_t id_str_size; 139 uint16_t name_size; 140 141 uint32_t date_sec; 142 uint32_t date_nsec; 143 144 uint64_t vm_clock_nsec; 145 146 uint32_t vm_state_size; 147 uint32_t extra_data_size; /* for extension */ 148 /* extra data follows */ 149 /* id_str follows */ 150 /* name follows */ 151 } QCowSnapshotHeader; 152 153 typedef struct QEMU_PACKED QCowSnapshotExtraData { 154 uint64_t vm_state_size_large; 155 uint64_t disk_size; 156 } QCowSnapshotExtraData; 157 158 159 typedef struct QCowSnapshot { 160 uint64_t l1_table_offset; 161 uint32_t l1_size; 162 char *id_str; 163 char *name; 164 uint64_t disk_size; 165 uint64_t vm_state_size; 166 uint32_t date_sec; 167 uint32_t date_nsec; 168 uint64_t vm_clock_nsec; 169 } QCowSnapshot; 170 171 struct Qcow2Cache; 172 typedef struct Qcow2Cache Qcow2Cache; 173 174 typedef struct Qcow2CryptoHeaderExtension { 175 uint64_t offset; 176 uint64_t length; 177 } QEMU_PACKED Qcow2CryptoHeaderExtension; 178 179 typedef struct Qcow2UnknownHeaderExtension { 180 uint32_t magic; 181 uint32_t len; 182 QLIST_ENTRY(Qcow2UnknownHeaderExtension) next; 183 uint8_t data[]; 184 } Qcow2UnknownHeaderExtension; 185 186 enum { 187 QCOW2_FEAT_TYPE_INCOMPATIBLE = 0, 188 QCOW2_FEAT_TYPE_COMPATIBLE = 1, 189 QCOW2_FEAT_TYPE_AUTOCLEAR = 2, 190 }; 191 192 /* Incompatible feature bits */ 193 enum { 194 QCOW2_INCOMPAT_DIRTY_BITNR = 0, 195 QCOW2_INCOMPAT_CORRUPT_BITNR = 1, 196 QCOW2_INCOMPAT_DIRTY = 1 << QCOW2_INCOMPAT_DIRTY_BITNR, 197 QCOW2_INCOMPAT_CORRUPT = 1 << QCOW2_INCOMPAT_CORRUPT_BITNR, 198 199 QCOW2_INCOMPAT_MASK = QCOW2_INCOMPAT_DIRTY 200 | QCOW2_INCOMPAT_CORRUPT, 201 }; 202 203 /* Compatible feature bits */ 204 enum { 205 QCOW2_COMPAT_LAZY_REFCOUNTS_BITNR = 0, 206 QCOW2_COMPAT_LAZY_REFCOUNTS = 1 << QCOW2_COMPAT_LAZY_REFCOUNTS_BITNR, 207 208 QCOW2_COMPAT_FEAT_MASK = QCOW2_COMPAT_LAZY_REFCOUNTS, 209 }; 210 211 /* Autoclear feature bits */ 212 enum { 213 QCOW2_AUTOCLEAR_BITMAPS_BITNR = 0, 214 QCOW2_AUTOCLEAR_BITMAPS = 1 << QCOW2_AUTOCLEAR_BITMAPS_BITNR, 215 216 QCOW2_AUTOCLEAR_MASK = QCOW2_AUTOCLEAR_BITMAPS, 217 }; 218 219 enum qcow2_discard_type { 220 QCOW2_DISCARD_NEVER = 0, 221 QCOW2_DISCARD_ALWAYS, 222 QCOW2_DISCARD_REQUEST, 223 QCOW2_DISCARD_SNAPSHOT, 224 QCOW2_DISCARD_OTHER, 225 QCOW2_DISCARD_MAX 226 }; 227 228 typedef struct Qcow2Feature { 229 uint8_t type; 230 uint8_t bit; 231 char name[46]; 232 } QEMU_PACKED Qcow2Feature; 233 234 typedef struct Qcow2DiscardRegion { 235 BlockDriverState *bs; 236 uint64_t offset; 237 uint64_t bytes; 238 QTAILQ_ENTRY(Qcow2DiscardRegion) next; 239 } Qcow2DiscardRegion; 240 241 typedef uint64_t Qcow2GetRefcountFunc(const void *refcount_array, 242 uint64_t index); 243 typedef void Qcow2SetRefcountFunc(void *refcount_array, 244 uint64_t index, uint64_t value); 245 246 typedef struct Qcow2BitmapHeaderExt { 247 uint32_t nb_bitmaps; 248 uint32_t reserved32; 249 uint64_t bitmap_directory_size; 250 uint64_t bitmap_directory_offset; 251 } QEMU_PACKED Qcow2BitmapHeaderExt; 252 253 typedef struct BDRVQcow2State { 254 int cluster_bits; 255 int cluster_size; 256 int cluster_sectors; 257 int l2_slice_size; 258 int l2_bits; 259 int l2_size; 260 int l1_size; 261 int l1_vm_state_index; 262 int refcount_block_bits; 263 int refcount_block_size; 264 int csize_shift; 265 int csize_mask; 266 uint64_t cluster_offset_mask; 267 uint64_t l1_table_offset; 268 uint64_t *l1_table; 269 270 Qcow2Cache* l2_table_cache; 271 Qcow2Cache* refcount_block_cache; 272 QEMUTimer *cache_clean_timer; 273 unsigned cache_clean_interval; 274 275 uint8_t *cluster_cache; 276 uint8_t *cluster_data; 277 uint64_t cluster_cache_offset; 278 QLIST_HEAD(QCowClusterAlloc, QCowL2Meta) cluster_allocs; 279 280 uint64_t *refcount_table; 281 uint64_t refcount_table_offset; 282 uint32_t refcount_table_size; 283 uint32_t max_refcount_table_index; /* Last used entry in refcount_table */ 284 uint64_t free_cluster_index; 285 uint64_t free_byte_offset; 286 287 CoMutex lock; 288 289 Qcow2CryptoHeaderExtension crypto_header; /* QCow2 header extension */ 290 QCryptoBlockOpenOptions *crypto_opts; /* Disk encryption runtime options */ 291 QCryptoBlock *crypto; /* Disk encryption format driver */ 292 bool crypt_physical_offset; /* Whether to use virtual or physical offset 293 for encryption initialization vector tweak */ 294 uint32_t crypt_method_header; 295 uint64_t snapshots_offset; 296 int snapshots_size; 297 unsigned int nb_snapshots; 298 QCowSnapshot *snapshots; 299 300 uint32_t nb_bitmaps; 301 uint64_t bitmap_directory_size; 302 uint64_t bitmap_directory_offset; 303 304 int flags; 305 int qcow_version; 306 bool use_lazy_refcounts; 307 int refcount_order; 308 int refcount_bits; 309 uint64_t refcount_max; 310 311 Qcow2GetRefcountFunc *get_refcount; 312 Qcow2SetRefcountFunc *set_refcount; 313 314 bool discard_passthrough[QCOW2_DISCARD_MAX]; 315 316 int overlap_check; /* bitmask of Qcow2MetadataOverlap values */ 317 bool signaled_corruption; 318 319 uint64_t incompatible_features; 320 uint64_t compatible_features; 321 uint64_t autoclear_features; 322 323 size_t unknown_header_fields_size; 324 void* unknown_header_fields; 325 QLIST_HEAD(, Qcow2UnknownHeaderExtension) unknown_header_ext; 326 QTAILQ_HEAD (, Qcow2DiscardRegion) discards; 327 bool cache_discards; 328 329 /* Backing file path and format as stored in the image (this is not the 330 * effective path/format, which may be the result of a runtime option 331 * override) */ 332 char *image_backing_file; 333 char *image_backing_format; 334 335 CoQueue compress_wait_queue; 336 int nb_compress_threads; 337 } BDRVQcow2State; 338 339 typedef struct Qcow2COWRegion { 340 /** 341 * Offset of the COW region in bytes from the start of the first cluster 342 * touched by the request. 343 */ 344 unsigned offset; 345 346 /** Number of bytes to copy */ 347 unsigned nb_bytes; 348 } Qcow2COWRegion; 349 350 /** 351 * Describes an in-flight (part of a) write request that writes to clusters 352 * that are not referenced in their L2 table yet. 353 */ 354 typedef struct QCowL2Meta 355 { 356 /** Guest offset of the first newly allocated cluster */ 357 uint64_t offset; 358 359 /** Host offset of the first newly allocated cluster */ 360 uint64_t alloc_offset; 361 362 /** Number of newly allocated clusters */ 363 int nb_clusters; 364 365 /** Do not free the old clusters */ 366 bool keep_old_clusters; 367 368 /** 369 * Requests that overlap with this allocation and wait to be restarted 370 * when the allocating request has completed. 371 */ 372 CoQueue dependent_requests; 373 374 /** 375 * The COW Region between the start of the first allocated cluster and the 376 * area the guest actually writes to. 377 */ 378 Qcow2COWRegion cow_start; 379 380 /** 381 * The COW Region between the area the guest actually writes to and the 382 * end of the last allocated cluster. 383 */ 384 Qcow2COWRegion cow_end; 385 386 /** 387 * The I/O vector with the data from the actual guest write request. 388 * If non-NULL, this is meant to be merged together with the data 389 * from @cow_start and @cow_end into one single write operation. 390 */ 391 QEMUIOVector *data_qiov; 392 393 /** Pointer to next L2Meta of the same write request */ 394 struct QCowL2Meta *next; 395 396 QLIST_ENTRY(QCowL2Meta) next_in_flight; 397 } QCowL2Meta; 398 399 typedef enum QCow2ClusterType { 400 QCOW2_CLUSTER_UNALLOCATED, 401 QCOW2_CLUSTER_ZERO_PLAIN, 402 QCOW2_CLUSTER_ZERO_ALLOC, 403 QCOW2_CLUSTER_NORMAL, 404 QCOW2_CLUSTER_COMPRESSED, 405 } QCow2ClusterType; 406 407 typedef enum QCow2MetadataOverlap { 408 QCOW2_OL_MAIN_HEADER_BITNR = 0, 409 QCOW2_OL_ACTIVE_L1_BITNR = 1, 410 QCOW2_OL_ACTIVE_L2_BITNR = 2, 411 QCOW2_OL_REFCOUNT_TABLE_BITNR = 3, 412 QCOW2_OL_REFCOUNT_BLOCK_BITNR = 4, 413 QCOW2_OL_SNAPSHOT_TABLE_BITNR = 5, 414 QCOW2_OL_INACTIVE_L1_BITNR = 6, 415 QCOW2_OL_INACTIVE_L2_BITNR = 7, 416 QCOW2_OL_BITMAP_DIRECTORY_BITNR = 8, 417 418 QCOW2_OL_MAX_BITNR = 9, 419 420 QCOW2_OL_NONE = 0, 421 QCOW2_OL_MAIN_HEADER = (1 << QCOW2_OL_MAIN_HEADER_BITNR), 422 QCOW2_OL_ACTIVE_L1 = (1 << QCOW2_OL_ACTIVE_L1_BITNR), 423 QCOW2_OL_ACTIVE_L2 = (1 << QCOW2_OL_ACTIVE_L2_BITNR), 424 QCOW2_OL_REFCOUNT_TABLE = (1 << QCOW2_OL_REFCOUNT_TABLE_BITNR), 425 QCOW2_OL_REFCOUNT_BLOCK = (1 << QCOW2_OL_REFCOUNT_BLOCK_BITNR), 426 QCOW2_OL_SNAPSHOT_TABLE = (1 << QCOW2_OL_SNAPSHOT_TABLE_BITNR), 427 QCOW2_OL_INACTIVE_L1 = (1 << QCOW2_OL_INACTIVE_L1_BITNR), 428 /* NOTE: Checking overlaps with inactive L2 tables will result in bdrv 429 * reads. */ 430 QCOW2_OL_INACTIVE_L2 = (1 << QCOW2_OL_INACTIVE_L2_BITNR), 431 QCOW2_OL_BITMAP_DIRECTORY = (1 << QCOW2_OL_BITMAP_DIRECTORY_BITNR), 432 } QCow2MetadataOverlap; 433 434 /* Perform all overlap checks which can be done in constant time */ 435 #define QCOW2_OL_CONSTANT \ 436 (QCOW2_OL_MAIN_HEADER | QCOW2_OL_ACTIVE_L1 | QCOW2_OL_REFCOUNT_TABLE | \ 437 QCOW2_OL_SNAPSHOT_TABLE | QCOW2_OL_BITMAP_DIRECTORY) 438 439 /* Perform all overlap checks which don't require disk access */ 440 #define QCOW2_OL_CACHED \ 441 (QCOW2_OL_CONSTANT | QCOW2_OL_ACTIVE_L2 | QCOW2_OL_REFCOUNT_BLOCK | \ 442 QCOW2_OL_INACTIVE_L1) 443 444 /* Perform all overlap checks */ 445 #define QCOW2_OL_ALL \ 446 (QCOW2_OL_CACHED | QCOW2_OL_INACTIVE_L2) 447 448 #define L1E_OFFSET_MASK 0x00fffffffffffe00ULL 449 #define L2E_OFFSET_MASK 0x00fffffffffffe00ULL 450 #define L2E_COMPRESSED_OFFSET_SIZE_MASK 0x3fffffffffffffffULL 451 452 #define REFT_OFFSET_MASK 0xfffffffffffffe00ULL 453 454 static inline int64_t start_of_cluster(BDRVQcow2State *s, int64_t offset) 455 { 456 return offset & ~(s->cluster_size - 1); 457 } 458 459 static inline int64_t offset_into_cluster(BDRVQcow2State *s, int64_t offset) 460 { 461 return offset & (s->cluster_size - 1); 462 } 463 464 static inline uint64_t size_to_clusters(BDRVQcow2State *s, uint64_t size) 465 { 466 return (size + (s->cluster_size - 1)) >> s->cluster_bits; 467 } 468 469 static inline int64_t size_to_l1(BDRVQcow2State *s, int64_t size) 470 { 471 int shift = s->cluster_bits + s->l2_bits; 472 return (size + (1ULL << shift) - 1) >> shift; 473 } 474 475 static inline int offset_to_l1_index(BDRVQcow2State *s, uint64_t offset) 476 { 477 return offset >> (s->l2_bits + s->cluster_bits); 478 } 479 480 static inline int offset_to_l2_index(BDRVQcow2State *s, int64_t offset) 481 { 482 return (offset >> s->cluster_bits) & (s->l2_size - 1); 483 } 484 485 static inline int offset_to_l2_slice_index(BDRVQcow2State *s, int64_t offset) 486 { 487 return (offset >> s->cluster_bits) & (s->l2_slice_size - 1); 488 } 489 490 static inline int64_t qcow2_vm_state_offset(BDRVQcow2State *s) 491 { 492 return (int64_t)s->l1_vm_state_index << (s->cluster_bits + s->l2_bits); 493 } 494 495 static inline QCow2ClusterType qcow2_get_cluster_type(uint64_t l2_entry) 496 { 497 if (l2_entry & QCOW_OFLAG_COMPRESSED) { 498 return QCOW2_CLUSTER_COMPRESSED; 499 } else if (l2_entry & QCOW_OFLAG_ZERO) { 500 if (l2_entry & L2E_OFFSET_MASK) { 501 return QCOW2_CLUSTER_ZERO_ALLOC; 502 } 503 return QCOW2_CLUSTER_ZERO_PLAIN; 504 } else if (!(l2_entry & L2E_OFFSET_MASK)) { 505 return QCOW2_CLUSTER_UNALLOCATED; 506 } else { 507 return QCOW2_CLUSTER_NORMAL; 508 } 509 } 510 511 /* Check whether refcounts are eager or lazy */ 512 static inline bool qcow2_need_accurate_refcounts(BDRVQcow2State *s) 513 { 514 return !(s->incompatible_features & QCOW2_INCOMPAT_DIRTY); 515 } 516 517 static inline uint64_t l2meta_cow_start(QCowL2Meta *m) 518 { 519 return m->offset + m->cow_start.offset; 520 } 521 522 static inline uint64_t l2meta_cow_end(QCowL2Meta *m) 523 { 524 return m->offset + m->cow_end.offset + m->cow_end.nb_bytes; 525 } 526 527 static inline uint64_t refcount_diff(uint64_t r1, uint64_t r2) 528 { 529 return r1 > r2 ? r1 - r2 : r2 - r1; 530 } 531 532 static inline 533 uint32_t offset_to_reftable_index(BDRVQcow2State *s, uint64_t offset) 534 { 535 return offset >> (s->refcount_block_bits + s->cluster_bits); 536 } 537 538 /* qcow2.c functions */ 539 int64_t qcow2_refcount_metadata_size(int64_t clusters, size_t cluster_size, 540 int refcount_order, bool generous_increase, 541 uint64_t *refblock_count); 542 543 int qcow2_mark_dirty(BlockDriverState *bs); 544 int qcow2_mark_corrupt(BlockDriverState *bs); 545 int qcow2_mark_consistent(BlockDriverState *bs); 546 int qcow2_update_header(BlockDriverState *bs); 547 548 void qcow2_signal_corruption(BlockDriverState *bs, bool fatal, int64_t offset, 549 int64_t size, const char *message_format, ...) 550 GCC_FMT_ATTR(5, 6); 551 552 int qcow2_validate_table(BlockDriverState *bs, uint64_t offset, 553 uint64_t entries, size_t entry_len, 554 int64_t max_size_bytes, const char *table_name, 555 Error **errp); 556 557 /* qcow2-refcount.c functions */ 558 int qcow2_refcount_init(BlockDriverState *bs); 559 void qcow2_refcount_close(BlockDriverState *bs); 560 561 int qcow2_get_refcount(BlockDriverState *bs, int64_t cluster_index, 562 uint64_t *refcount); 563 564 int qcow2_update_cluster_refcount(BlockDriverState *bs, int64_t cluster_index, 565 uint64_t addend, bool decrease, 566 enum qcow2_discard_type type); 567 568 int64_t qcow2_refcount_area(BlockDriverState *bs, uint64_t offset, 569 uint64_t additional_clusters, bool exact_size, 570 int new_refblock_index, 571 uint64_t new_refblock_offset); 572 573 int64_t qcow2_alloc_clusters(BlockDriverState *bs, uint64_t size); 574 int64_t qcow2_alloc_clusters_at(BlockDriverState *bs, uint64_t offset, 575 int64_t nb_clusters); 576 int64_t qcow2_alloc_bytes(BlockDriverState *bs, int size); 577 void qcow2_free_clusters(BlockDriverState *bs, 578 int64_t offset, int64_t size, 579 enum qcow2_discard_type type); 580 void qcow2_free_any_clusters(BlockDriverState *bs, uint64_t l2_entry, 581 int nb_clusters, enum qcow2_discard_type type); 582 583 int qcow2_update_snapshot_refcount(BlockDriverState *bs, 584 int64_t l1_table_offset, int l1_size, int addend); 585 586 int coroutine_fn qcow2_flush_caches(BlockDriverState *bs); 587 int coroutine_fn qcow2_write_caches(BlockDriverState *bs); 588 int qcow2_check_refcounts(BlockDriverState *bs, BdrvCheckResult *res, 589 BdrvCheckMode fix); 590 591 void qcow2_process_discards(BlockDriverState *bs, int ret); 592 593 int qcow2_check_metadata_overlap(BlockDriverState *bs, int ign, int64_t offset, 594 int64_t size); 595 int qcow2_pre_write_overlap_check(BlockDriverState *bs, int ign, int64_t offset, 596 int64_t size); 597 int qcow2_inc_refcounts_imrt(BlockDriverState *bs, BdrvCheckResult *res, 598 void **refcount_table, 599 int64_t *refcount_table_size, 600 int64_t offset, int64_t size); 601 602 int qcow2_change_refcount_order(BlockDriverState *bs, int refcount_order, 603 BlockDriverAmendStatusCB *status_cb, 604 void *cb_opaque, Error **errp); 605 int qcow2_shrink_reftable(BlockDriverState *bs); 606 int64_t qcow2_get_last_cluster(BlockDriverState *bs, int64_t size); 607 608 /* qcow2-cluster.c functions */ 609 int qcow2_grow_l1_table(BlockDriverState *bs, uint64_t min_size, 610 bool exact_size); 611 int qcow2_shrink_l1_table(BlockDriverState *bs, uint64_t max_size); 612 int qcow2_write_l1_entry(BlockDriverState *bs, int l1_index); 613 int qcow2_decompress_cluster(BlockDriverState *bs, uint64_t cluster_offset); 614 int qcow2_encrypt_sectors(BDRVQcow2State *s, int64_t sector_num, 615 uint8_t *buf, int nb_sectors, bool enc, Error **errp); 616 617 int qcow2_get_cluster_offset(BlockDriverState *bs, uint64_t offset, 618 unsigned int *bytes, uint64_t *cluster_offset); 619 int qcow2_alloc_cluster_offset(BlockDriverState *bs, uint64_t offset, 620 unsigned int *bytes, uint64_t *host_offset, 621 QCowL2Meta **m); 622 uint64_t qcow2_alloc_compressed_cluster_offset(BlockDriverState *bs, 623 uint64_t offset, 624 int compressed_size); 625 626 int qcow2_alloc_cluster_link_l2(BlockDriverState *bs, QCowL2Meta *m); 627 void qcow2_alloc_cluster_abort(BlockDriverState *bs, QCowL2Meta *m); 628 int qcow2_cluster_discard(BlockDriverState *bs, uint64_t offset, 629 uint64_t bytes, enum qcow2_discard_type type, 630 bool full_discard); 631 int qcow2_cluster_zeroize(BlockDriverState *bs, uint64_t offset, 632 uint64_t bytes, int flags); 633 634 int qcow2_expand_zero_clusters(BlockDriverState *bs, 635 BlockDriverAmendStatusCB *status_cb, 636 void *cb_opaque); 637 638 /* qcow2-snapshot.c functions */ 639 int qcow2_snapshot_create(BlockDriverState *bs, QEMUSnapshotInfo *sn_info); 640 int qcow2_snapshot_goto(BlockDriverState *bs, const char *snapshot_id); 641 int qcow2_snapshot_delete(BlockDriverState *bs, 642 const char *snapshot_id, 643 const char *name, 644 Error **errp); 645 int qcow2_snapshot_list(BlockDriverState *bs, QEMUSnapshotInfo **psn_tab); 646 int qcow2_snapshot_load_tmp(BlockDriverState *bs, 647 const char *snapshot_id, 648 const char *name, 649 Error **errp); 650 651 void qcow2_free_snapshots(BlockDriverState *bs); 652 int qcow2_read_snapshots(BlockDriverState *bs); 653 654 /* qcow2-cache.c functions */ 655 Qcow2Cache *qcow2_cache_create(BlockDriverState *bs, int num_tables, 656 unsigned table_size); 657 int qcow2_cache_destroy(Qcow2Cache *c); 658 659 void qcow2_cache_entry_mark_dirty(Qcow2Cache *c, void *table); 660 int qcow2_cache_flush(BlockDriverState *bs, Qcow2Cache *c); 661 int qcow2_cache_write(BlockDriverState *bs, Qcow2Cache *c); 662 int qcow2_cache_set_dependency(BlockDriverState *bs, Qcow2Cache *c, 663 Qcow2Cache *dependency); 664 void qcow2_cache_depends_on_flush(Qcow2Cache *c); 665 666 void qcow2_cache_clean_unused(Qcow2Cache *c); 667 int qcow2_cache_empty(BlockDriverState *bs, Qcow2Cache *c); 668 669 int qcow2_cache_get(BlockDriverState *bs, Qcow2Cache *c, uint64_t offset, 670 void **table); 671 int qcow2_cache_get_empty(BlockDriverState *bs, Qcow2Cache *c, uint64_t offset, 672 void **table); 673 void qcow2_cache_put(Qcow2Cache *c, void **table); 674 void *qcow2_cache_is_table_offset(Qcow2Cache *c, uint64_t offset); 675 void qcow2_cache_discard(Qcow2Cache *c, void *table); 676 677 /* qcow2-bitmap.c functions */ 678 int qcow2_check_bitmaps_refcounts(BlockDriverState *bs, BdrvCheckResult *res, 679 void **refcount_table, 680 int64_t *refcount_table_size); 681 bool qcow2_load_dirty_bitmaps(BlockDriverState *bs, Error **errp); 682 int qcow2_reopen_bitmaps_rw_hint(BlockDriverState *bs, bool *header_updated, 683 Error **errp); 684 int qcow2_reopen_bitmaps_rw(BlockDriverState *bs, Error **errp); 685 void qcow2_store_persistent_dirty_bitmaps(BlockDriverState *bs, Error **errp); 686 int qcow2_reopen_bitmaps_ro(BlockDriverState *bs, Error **errp); 687 bool qcow2_can_store_new_dirty_bitmap(BlockDriverState *bs, 688 const char *name, 689 uint32_t granularity, 690 Error **errp); 691 void qcow2_remove_persistent_dirty_bitmap(BlockDriverState *bs, 692 const char *name, 693 Error **errp); 694 695 #endif 696