]> git.proxmox.com Git - mirror_qemu.git/blame - block/qcow2.h
qcow2: use a hash to look for entries in the L2 cache
[mirror_qemu.git] / block / qcow2.h
CommitLineData
f7d0fe02
KW
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
753d9b82 28#include "qemu/aes.h"
737e150e 29#include "block/coroutine.h"
f7d0fe02 30
14899cdf
FN
31//#define DEBUG_ALLOC
32//#define DEBUG_ALLOC2
33//#define DEBUG_EXT
34
f7d0fe02 35#define QCOW_MAGIC (('Q' << 24) | ('F' << 16) | ('I' << 8) | 0xfb)
f7d0fe02
KW
36
37#define QCOW_CRYPT_NONE 0
38#define QCOW_CRYPT_AES 1
39
40#define QCOW_MAX_CRYPT_CLUSTERS 32
ce48f2f4 41#define QCOW_MAX_SNAPSHOTS 65536
f7d0fe02 42
2b5d5953
KW
43/* 8 MB refcount table is enough for 2 PB images at 64k cluster size
44 * (128 GB for 512 byte clusters, 2 EB for 2 MB clusters) */
45#define QCOW_MAX_REFTABLE_SIZE 0x800000
46
6a83f8b5
KW
47/* 32 MB L1 table is enough for 2 PB images at 64k cluster size
48 * (128 GB for 512 byte clusters, 2 EB for 2 MB clusters) */
49#define QCOW_MAX_L1_SIZE 0x2000000
50
5dae6e30
KW
51/* Allow for an average of 1k per snapshot table entry, should be plenty of
52 * space for snapshot names and IDs */
53#define QCOW_MAX_SNAPSHOTS_SIZE (1024 * QCOW_MAX_SNAPSHOTS)
54
f7d0fe02 55/* indicate that the refcount of the referenced cluster is exactly one. */
127c84e1 56#define QCOW_OFLAG_COPIED (1ULL << 63)
f7d0fe02 57/* indicate that the cluster is compressed (they never have the copied flag) */
127c84e1 58#define QCOW_OFLAG_COMPRESSED (1ULL << 62)
6377af48 59/* The cluster reads as all zeros */
127c84e1 60#define QCOW_OFLAG_ZERO (1ULL << 0)
f7d0fe02 61
f7d0fe02 62#define MIN_CLUSTER_BITS 9
80ee15a6 63#define MAX_CLUSTER_BITS 21
f7d0fe02 64
440ba08a 65#define MIN_L2_CACHE_SIZE 1 /* cluster */
f7d0fe02 66
29c1a730 67/* Must be at least 4 to cover all cases of refcount table growth */
440ba08a
HR
68#define MIN_REFCOUNT_CACHE_SIZE 4 /* clusters */
69
70#define DEFAULT_L2_CACHE_BYTE_SIZE 1048576 /* bytes */
71
72/* The refblock cache needs only a fourth of the L2 cache size to cover as many
73 * clusters */
74#define DEFAULT_L2_REFCOUNT_SIZE_RATIO 4
29c1a730 75
99cce9fa
KW
76#define DEFAULT_CLUSTER_SIZE 65536
77
acdfb480 78
64aa99d3
KW
79#define QCOW2_OPT_LAZY_REFCOUNTS "lazy-refcounts"
80#define QCOW2_OPT_DISCARD_REQUEST "pass-discard-request"
81#define QCOW2_OPT_DISCARD_SNAPSHOT "pass-discard-snapshot"
82#define QCOW2_OPT_DISCARD_OTHER "pass-discard-other"
05de7e86 83#define QCOW2_OPT_OVERLAP "overlap-check"
ee42b5ce 84#define QCOW2_OPT_OVERLAP_TEMPLATE "overlap-check.template"
05de7e86
HR
85#define QCOW2_OPT_OVERLAP_MAIN_HEADER "overlap-check.main-header"
86#define QCOW2_OPT_OVERLAP_ACTIVE_L1 "overlap-check.active-l1"
87#define QCOW2_OPT_OVERLAP_ACTIVE_L2 "overlap-check.active-l2"
88#define QCOW2_OPT_OVERLAP_REFCOUNT_TABLE "overlap-check.refcount-table"
89#define QCOW2_OPT_OVERLAP_REFCOUNT_BLOCK "overlap-check.refcount-block"
90#define QCOW2_OPT_OVERLAP_SNAPSHOT_TABLE "overlap-check.snapshot-table"
91#define QCOW2_OPT_OVERLAP_INACTIVE_L1 "overlap-check.inactive-l1"
92#define QCOW2_OPT_OVERLAP_INACTIVE_L2 "overlap-check.inactive-l2"
6c1c8d5d
HR
93#define QCOW2_OPT_CACHE_SIZE "cache-size"
94#define QCOW2_OPT_L2_CACHE_SIZE "l2-cache-size"
95#define QCOW2_OPT_REFCOUNT_CACHE_SIZE "refcount-cache-size"
acdfb480 96
f7d0fe02
KW
97typedef struct QCowHeader {
98 uint32_t magic;
99 uint32_t version;
100 uint64_t backing_file_offset;
101 uint32_t backing_file_size;
102 uint32_t cluster_bits;
103 uint64_t size; /* in bytes */
104 uint32_t crypt_method;
105 uint32_t l1_size; /* XXX: save number of clusters instead ? */
106 uint64_t l1_table_offset;
107 uint64_t refcount_table_offset;
108 uint32_t refcount_table_clusters;
109 uint32_t nb_snapshots;
110 uint64_t snapshots_offset;
6744cbab
KW
111
112 /* The following fields are only valid for version >= 3 */
113 uint64_t incompatible_features;
114 uint64_t compatible_features;
115 uint64_t autoclear_features;
116
117 uint32_t refcount_order;
118 uint32_t header_length;
c4217f64 119} QEMU_PACKED QCowHeader;
f7d0fe02 120
ce48f2f4
KW
121typedef struct QEMU_PACKED QCowSnapshotHeader {
122 /* header is 8 byte aligned */
123 uint64_t l1_table_offset;
124
125 uint32_t l1_size;
126 uint16_t id_str_size;
127 uint16_t name_size;
128
129 uint32_t date_sec;
130 uint32_t date_nsec;
131
132 uint64_t vm_clock_nsec;
133
134 uint32_t vm_state_size;
135 uint32_t extra_data_size; /* for extension */
136 /* extra data follows */
137 /* id_str follows */
138 /* name follows */
139} QCowSnapshotHeader;
140
141typedef struct QEMU_PACKED QCowSnapshotExtraData {
142 uint64_t vm_state_size_large;
143 uint64_t disk_size;
144} QCowSnapshotExtraData;
145
146
f7d0fe02
KW
147typedef struct QCowSnapshot {
148 uint64_t l1_table_offset;
149 uint32_t l1_size;
150 char *id_str;
151 char *name;
90b27759 152 uint64_t disk_size;
c2c9a466 153 uint64_t vm_state_size;
f7d0fe02
KW
154 uint32_t date_sec;
155 uint32_t date_nsec;
156 uint64_t vm_clock_nsec;
157} QCowSnapshot;
158
49381094
KW
159struct Qcow2Cache;
160typedef struct Qcow2Cache Qcow2Cache;
161
75bab85c
KW
162typedef struct Qcow2UnknownHeaderExtension {
163 uint32_t magic;
164 uint32_t len;
165 QLIST_ENTRY(Qcow2UnknownHeaderExtension) next;
166 uint8_t data[];
167} Qcow2UnknownHeaderExtension;
168
cfcc4c62
KW
169enum {
170 QCOW2_FEAT_TYPE_INCOMPATIBLE = 0,
171 QCOW2_FEAT_TYPE_COMPATIBLE = 1,
172 QCOW2_FEAT_TYPE_AUTOCLEAR = 2,
173};
174
c61d0004
SH
175/* Incompatible feature bits */
176enum {
177 QCOW2_INCOMPAT_DIRTY_BITNR = 0,
69c98726 178 QCOW2_INCOMPAT_CORRUPT_BITNR = 1,
c61d0004 179 QCOW2_INCOMPAT_DIRTY = 1 << QCOW2_INCOMPAT_DIRTY_BITNR,
69c98726 180 QCOW2_INCOMPAT_CORRUPT = 1 << QCOW2_INCOMPAT_CORRUPT_BITNR,
c61d0004 181
69c98726
HR
182 QCOW2_INCOMPAT_MASK = QCOW2_INCOMPAT_DIRTY
183 | QCOW2_INCOMPAT_CORRUPT,
c61d0004
SH
184};
185
bfe8043e
SH
186/* Compatible feature bits */
187enum {
188 QCOW2_COMPAT_LAZY_REFCOUNTS_BITNR = 0,
189 QCOW2_COMPAT_LAZY_REFCOUNTS = 1 << QCOW2_COMPAT_LAZY_REFCOUNTS_BITNR,
190
191 QCOW2_COMPAT_FEAT_MASK = QCOW2_COMPAT_LAZY_REFCOUNTS,
192};
193
6cfcb9b8
KW
194enum qcow2_discard_type {
195 QCOW2_DISCARD_NEVER = 0,
196 QCOW2_DISCARD_ALWAYS,
197 QCOW2_DISCARD_REQUEST,
198 QCOW2_DISCARD_SNAPSHOT,
199 QCOW2_DISCARD_OTHER,
200 QCOW2_DISCARD_MAX
201};
202
cfcc4c62
KW
203typedef struct Qcow2Feature {
204 uint8_t type;
205 uint8_t bit;
206 char name[46];
207} QEMU_PACKED Qcow2Feature;
208
0b919fae
KW
209typedef struct Qcow2DiscardRegion {
210 BlockDriverState *bs;
211 uint64_t offset;
212 uint64_t bytes;
213 QTAILQ_ENTRY(Qcow2DiscardRegion) next;
214} Qcow2DiscardRegion;
215
7453c96b
HR
216typedef uint64_t Qcow2GetRefcountFunc(const void *refcount_array,
217 uint64_t index);
218typedef void Qcow2SetRefcountFunc(void *refcount_array,
219 uint64_t index, uint64_t value);
220
f7d0fe02 221typedef struct BDRVQcowState {
f7d0fe02
KW
222 int cluster_bits;
223 int cluster_size;
224 int cluster_sectors;
225 int l2_bits;
226 int l2_size;
227 int l1_size;
228 int l1_vm_state_index;
1d13d654
HR
229 int refcount_block_bits;
230 int refcount_block_size;
f7d0fe02
KW
231 int csize_shift;
232 int csize_mask;
233 uint64_t cluster_offset_mask;
234 uint64_t l1_table_offset;
235 uint64_t *l1_table;
29c1a730
KW
236
237 Qcow2Cache* l2_table_cache;
238 Qcow2Cache* refcount_block_cache;
239
f7d0fe02
KW
240 uint8_t *cluster_cache;
241 uint8_t *cluster_data;
242 uint64_t cluster_cache_offset;
72cf2d4f 243 QLIST_HEAD(QCowClusterAlloc, QCowL2Meta) cluster_allocs;
f7d0fe02
KW
244
245 uint64_t *refcount_table;
246 uint64_t refcount_table_offset;
247 uint32_t refcount_table_size;
bb572aef
KW
248 uint64_t free_cluster_index;
249 uint64_t free_byte_offset;
f7d0fe02 250
68d100e9
KW
251 CoMutex lock;
252
f7d0fe02
KW
253 uint32_t crypt_method; /* current crypt method, 0 if no key yet */
254 uint32_t crypt_method_header;
255 AES_KEY aes_encrypt_key;
256 AES_KEY aes_decrypt_key;
257 uint64_t snapshots_offset;
258 int snapshots_size;
ce48f2f4 259 unsigned int nb_snapshots;
f7d0fe02 260 QCowSnapshot *snapshots;
06d9260f
AL
261
262 int flags;
6744cbab 263 int qcow_version;
74c4510a 264 bool use_lazy_refcounts;
b6481f37 265 int refcount_order;
346a53df
HR
266 int refcount_bits;
267 uint64_t refcount_max;
6744cbab 268
7453c96b
HR
269 Qcow2GetRefcountFunc *get_refcount;
270 Qcow2SetRefcountFunc *set_refcount;
271
67af674e
KW
272 bool discard_passthrough[QCOW2_DISCARD_MAX];
273
3e355390 274 int overlap_check; /* bitmask of Qcow2MetadataOverlap values */
85186ebd 275 bool signaled_corruption;
3e355390 276
6744cbab
KW
277 uint64_t incompatible_features;
278 uint64_t compatible_features;
279 uint64_t autoclear_features;
280
281 size_t unknown_header_fields_size;
282 void* unknown_header_fields;
75bab85c 283 QLIST_HEAD(, Qcow2UnknownHeaderExtension) unknown_header_ext;
0b919fae
KW
284 QTAILQ_HEAD (, Qcow2DiscardRegion) discards;
285 bool cache_discards;
e4603fe1
KW
286
287 /* Backing file path and format as stored in the image (this is not the
288 * effective path/format, which may be the result of a runtime option
289 * override) */
290 char *image_backing_file;
291 char *image_backing_format;
f7d0fe02
KW
292} BDRVQcowState;
293
f214978a
KW
294struct QCowAIOCB;
295
593fb83c
KW
296typedef struct Qcow2COWRegion {
297 /**
298 * Offset of the COW region in bytes from the start of the first cluster
299 * touched by the request.
300 */
301 uint64_t offset;
302
303 /** Number of sectors to copy */
304 int nb_sectors;
305} Qcow2COWRegion;
306
f50f88b9
KW
307/**
308 * Describes an in-flight (part of a) write request that writes to clusters
309 * that are not referenced in their L2 table yet.
310 */
45aba42f
KW
311typedef struct QCowL2Meta
312{
1d3afd64 313 /** Guest offset of the first newly allocated cluster */
45aba42f 314 uint64_t offset;
1d3afd64 315
1d3afd64 316 /** Host offset of the first newly allocated cluster */
250196f1 317 uint64_t alloc_offset;
1d3afd64 318
1d3afd64
KW
319 /**
320 * Number of sectors from the start of the first allocated cluster to
321 * the end of the (possibly shortened) request
322 */
45aba42f 323 int nb_available;
1d3afd64
KW
324
325 /** Number of newly allocated clusters */
45aba42f 326 int nb_clusters;
1d3afd64
KW
327
328 /**
329 * Requests that overlap with this allocation and wait to be restarted
330 * when the allocating request has completed.
331 */
68d100e9 332 CoQueue dependent_requests;
f214978a 333
593fb83c
KW
334 /**
335 * The COW Region between the start of the first allocated cluster and the
336 * area the guest actually writes to.
337 */
338 Qcow2COWRegion cow_start;
339
340 /**
341 * The COW Region between the area the guest actually writes to and the
342 * end of the last allocated cluster.
343 */
344 Qcow2COWRegion cow_end;
345
88c6588c
KW
346 /** Pointer to next L2Meta of the same write request */
347 struct QCowL2Meta *next;
348
72cf2d4f 349 QLIST_ENTRY(QCowL2Meta) next_in_flight;
45aba42f
KW
350} QCowL2Meta;
351
68d000a3
KW
352enum {
353 QCOW2_CLUSTER_UNALLOCATED,
354 QCOW2_CLUSTER_NORMAL,
355 QCOW2_CLUSTER_COMPRESSED,
6377af48 356 QCOW2_CLUSTER_ZERO
68d000a3
KW
357};
358
a40f1c2a
HR
359typedef enum QCow2MetadataOverlap {
360 QCOW2_OL_MAIN_HEADER_BITNR = 0,
361 QCOW2_OL_ACTIVE_L1_BITNR = 1,
362 QCOW2_OL_ACTIVE_L2_BITNR = 2,
363 QCOW2_OL_REFCOUNT_TABLE_BITNR = 3,
364 QCOW2_OL_REFCOUNT_BLOCK_BITNR = 4,
365 QCOW2_OL_SNAPSHOT_TABLE_BITNR = 5,
366 QCOW2_OL_INACTIVE_L1_BITNR = 6,
367 QCOW2_OL_INACTIVE_L2_BITNR = 7,
368
369 QCOW2_OL_MAX_BITNR = 8,
370
371 QCOW2_OL_NONE = 0,
372 QCOW2_OL_MAIN_HEADER = (1 << QCOW2_OL_MAIN_HEADER_BITNR),
373 QCOW2_OL_ACTIVE_L1 = (1 << QCOW2_OL_ACTIVE_L1_BITNR),
374 QCOW2_OL_ACTIVE_L2 = (1 << QCOW2_OL_ACTIVE_L2_BITNR),
375 QCOW2_OL_REFCOUNT_TABLE = (1 << QCOW2_OL_REFCOUNT_TABLE_BITNR),
376 QCOW2_OL_REFCOUNT_BLOCK = (1 << QCOW2_OL_REFCOUNT_BLOCK_BITNR),
377 QCOW2_OL_SNAPSHOT_TABLE = (1 << QCOW2_OL_SNAPSHOT_TABLE_BITNR),
378 QCOW2_OL_INACTIVE_L1 = (1 << QCOW2_OL_INACTIVE_L1_BITNR),
379 /* NOTE: Checking overlaps with inactive L2 tables will result in bdrv
380 * reads. */
381 QCOW2_OL_INACTIVE_L2 = (1 << QCOW2_OL_INACTIVE_L2_BITNR),
382} QCow2MetadataOverlap;
383
4a273c39
HR
384/* Perform all overlap checks which can be done in constant time */
385#define QCOW2_OL_CONSTANT \
386 (QCOW2_OL_MAIN_HEADER | QCOW2_OL_ACTIVE_L1 | QCOW2_OL_REFCOUNT_TABLE | \
387 QCOW2_OL_SNAPSHOT_TABLE)
388
a40f1c2a
HR
389/* Perform all overlap checks which don't require disk access */
390#define QCOW2_OL_CACHED \
4a273c39
HR
391 (QCOW2_OL_CONSTANT | QCOW2_OL_ACTIVE_L2 | QCOW2_OL_REFCOUNT_BLOCK | \
392 QCOW2_OL_INACTIVE_L1)
393
394/* Perform all overlap checks */
395#define QCOW2_OL_ALL \
396 (QCOW2_OL_CACHED | QCOW2_OL_INACTIVE_L2)
a40f1c2a 397
46bae927
HT
398#define L1E_OFFSET_MASK 0x00fffffffffffe00ULL
399#define L2E_OFFSET_MASK 0x00fffffffffffe00ULL
68d000a3
KW
400#define L2E_COMPRESSED_OFFSET_SIZE_MASK 0x3fffffffffffffffULL
401
46bae927 402#define REFT_OFFSET_MASK 0xfffffffffffffe00ULL
76dc9e0c 403
3b8e2e26
KW
404static inline int64_t start_of_cluster(BDRVQcowState *s, int64_t offset)
405{
406 return offset & ~(s->cluster_size - 1);
407}
408
c37f4cd7
KW
409static inline int64_t offset_into_cluster(BDRVQcowState *s, int64_t offset)
410{
411 return offset & (s->cluster_size - 1);
412}
413
45aba42f 414static inline int size_to_clusters(BDRVQcowState *s, int64_t size)
f7d0fe02
KW
415{
416 return (size + (s->cluster_size - 1)) >> s->cluster_bits;
417}
418
2cf7cfa1 419static inline int64_t size_to_l1(BDRVQcowState *s, int64_t size)
419b19d9
SH
420{
421 int shift = s->cluster_bits + s->l2_bits;
422 return (size + (1ULL << shift) - 1) >> shift;
423}
424
17a71e58
KW
425static inline int offset_to_l2_index(BDRVQcowState *s, int64_t offset)
426{
427 return (offset >> s->cluster_bits) & (s->l2_size - 1);
428}
429
c142442b
KW
430static inline int64_t align_offset(int64_t offset, int n)
431{
432 offset = (offset + n - 1) & ~(n - 1);
433 return offset;
434}
435
1ebf561c
KW
436static inline int64_t qcow2_vm_state_offset(BDRVQcowState *s)
437{
438 return (int64_t)s->l1_vm_state_index << (s->cluster_bits + s->l2_bits);
439}
440
2b5d5953
KW
441static inline uint64_t qcow2_max_refcount_clusters(BDRVQcowState *s)
442{
443 return QCOW_MAX_REFTABLE_SIZE >> s->cluster_bits;
444}
445
68d000a3
KW
446static inline int qcow2_get_cluster_type(uint64_t l2_entry)
447{
448 if (l2_entry & QCOW_OFLAG_COMPRESSED) {
449 return QCOW2_CLUSTER_COMPRESSED;
6377af48
KW
450 } else if (l2_entry & QCOW_OFLAG_ZERO) {
451 return QCOW2_CLUSTER_ZERO;
68d000a3
KW
452 } else if (!(l2_entry & L2E_OFFSET_MASK)) {
453 return QCOW2_CLUSTER_UNALLOCATED;
454 } else {
455 return QCOW2_CLUSTER_NORMAL;
456 }
457}
458
bfe8043e
SH
459/* Check whether refcounts are eager or lazy */
460static inline bool qcow2_need_accurate_refcounts(BDRVQcowState *s)
461{
462 return !(s->incompatible_features & QCOW2_INCOMPAT_DIRTY);
463}
c142442b 464
65eb2e35
KW
465static inline uint64_t l2meta_cow_start(QCowL2Meta *m)
466{
467 return m->offset + m->cow_start.offset;
468}
469
470static inline uint64_t l2meta_cow_end(QCowL2Meta *m)
471{
472 return m->offset + m->cow_end.offset
473 + (m->cow_end.nb_sectors << BDRV_SECTOR_BITS);
474}
475
0e06528e 476static inline uint64_t refcount_diff(uint64_t r1, uint64_t r2)
2aabe7c7
HR
477{
478 return r1 > r2 ? r1 - r2 : r2 - r1;
479}
480
f7d0fe02
KW
481// FIXME Need qcow2_ prefix to global functions
482
483/* qcow2.c functions */
bd28f835
KW
484int qcow2_backing_read1(BlockDriverState *bs, QEMUIOVector *qiov,
485 int64_t sector_num, int nb_sectors);
280d3735
KW
486
487int qcow2_mark_dirty(BlockDriverState *bs);
69c98726
HR
488int qcow2_mark_corrupt(BlockDriverState *bs);
489int qcow2_mark_consistent(BlockDriverState *bs);
e24e49e6 490int qcow2_update_header(BlockDriverState *bs);
f7d0fe02 491
85186ebd
HR
492void qcow2_signal_corruption(BlockDriverState *bs, bool fatal, int64_t offset,
493 int64_t size, const char *message_format, ...)
494 GCC_FMT_ATTR(5, 6);
495
f7d0fe02 496/* qcow2-refcount.c functions */
ed6ccf0f
KW
497int qcow2_refcount_init(BlockDriverState *bs);
498void qcow2_refcount_close(BlockDriverState *bs);
f7d0fe02 499
7324c10f 500int qcow2_get_refcount(BlockDriverState *bs, int64_t cluster_index,
0e06528e 501 uint64_t *refcount);
44751917 502
32b6444d 503int qcow2_update_cluster_refcount(BlockDriverState *bs, int64_t cluster_index,
0e06528e 504 uint64_t addend, bool decrease,
2aabe7c7 505 enum qcow2_discard_type type);
32b6444d 506
bb572aef 507int64_t qcow2_alloc_clusters(BlockDriverState *bs, uint64_t size);
256900b1
KW
508int qcow2_alloc_clusters_at(BlockDriverState *bs, uint64_t offset,
509 int nb_clusters);
ed6ccf0f
KW
510int64_t qcow2_alloc_bytes(BlockDriverState *bs, int size);
511void qcow2_free_clusters(BlockDriverState *bs,
6cfcb9b8
KW
512 int64_t offset, int64_t size,
513 enum qcow2_discard_type type);
514void qcow2_free_any_clusters(BlockDriverState *bs, uint64_t l2_entry,
515 int nb_clusters, enum qcow2_discard_type type);
f7d0fe02 516
ed6ccf0f
KW
517int qcow2_update_snapshot_refcount(BlockDriverState *bs,
518 int64_t l1_table_offset, int l1_size, int addend);
f7d0fe02 519
166acf54
KW
520int qcow2_check_refcounts(BlockDriverState *bs, BdrvCheckResult *res,
521 BdrvCheckMode fix);
f7d0fe02 522
0b919fae
KW
523void qcow2_process_discards(BlockDriverState *bs, int ret);
524
231bb267 525int qcow2_check_metadata_overlap(BlockDriverState *bs, int ign, int64_t offset,
a40f1c2a 526 int64_t size);
231bb267 527int qcow2_pre_write_overlap_check(BlockDriverState *bs, int ign, int64_t offset,
a40f1c2a
HR
528 int64_t size);
529
45aba42f 530/* qcow2-cluster.c functions */
2cf7cfa1
KW
531int qcow2_grow_l1_table(BlockDriverState *bs, uint64_t min_size,
532 bool exact_size);
e23e400e 533int qcow2_write_l1_entry(BlockDriverState *bs, int l1_index);
ed6ccf0f 534void qcow2_l2_cache_reset(BlockDriverState *bs);
66f82cee 535int qcow2_decompress_cluster(BlockDriverState *bs, uint64_t cluster_offset);
ed6ccf0f 536void qcow2_encrypt_sectors(BDRVQcowState *s, int64_t sector_num,
45aba42f
KW
537 uint8_t *out_buf, const uint8_t *in_buf,
538 int nb_sectors, int enc,
539 const AES_KEY *key);
540
1c46efaa
KW
541int qcow2_get_cluster_offset(BlockDriverState *bs, uint64_t offset,
542 int *num, uint64_t *cluster_offset);
f4f0d391 543int qcow2_alloc_cluster_offset(BlockDriverState *bs, uint64_t offset,
16f0587e 544 int *num, uint64_t *host_offset, QCowL2Meta **m);
ed6ccf0f 545uint64_t qcow2_alloc_compressed_cluster_offset(BlockDriverState *bs,
45aba42f
KW
546 uint64_t offset,
547 int compressed_size);
548
148da7ea 549int qcow2_alloc_cluster_link_l2(BlockDriverState *bs, QCowL2Meta *m);
5ea929e3 550int qcow2_discard_clusters(BlockDriverState *bs, uint64_t offset,
808c4b6f 551 int nb_sectors, enum qcow2_discard_type type, bool full_discard);
621f0589 552int qcow2_zero_clusters(BlockDriverState *bs, uint64_t offset, int nb_sectors);
45aba42f 553
4057a2b2
HR
554int qcow2_expand_zero_clusters(BlockDriverState *bs,
555 BlockDriverAmendStatusCB *status_cb);
32b6444d 556
c142442b 557/* qcow2-snapshot.c functions */
ed6ccf0f
KW
558int qcow2_snapshot_create(BlockDriverState *bs, QEMUSnapshotInfo *sn_info);
559int qcow2_snapshot_goto(BlockDriverState *bs, const char *snapshot_id);
a89d89d3
WX
560int qcow2_snapshot_delete(BlockDriverState *bs,
561 const char *snapshot_id,
562 const char *name,
563 Error **errp);
ed6ccf0f 564int qcow2_snapshot_list(BlockDriverState *bs, QEMUSnapshotInfo **psn_tab);
7b4c4781
WX
565int qcow2_snapshot_load_tmp(BlockDriverState *bs,
566 const char *snapshot_id,
567 const char *name,
568 Error **errp);
c142442b 569
ed6ccf0f
KW
570void qcow2_free_snapshots(BlockDriverState *bs);
571int qcow2_read_snapshots(BlockDriverState *bs);
c142442b 572
49381094 573/* qcow2-cache.c functions */
6af4e9ea 574Qcow2Cache *qcow2_cache_create(BlockDriverState *bs, int num_tables);
49381094
KW
575int qcow2_cache_destroy(BlockDriverState* bs, Qcow2Cache *c);
576
72e80b89
AG
577void qcow2_cache_entry_mark_dirty(BlockDriverState *bs, Qcow2Cache *c,
578 void *table);
49381094
KW
579int qcow2_cache_flush(BlockDriverState *bs, Qcow2Cache *c);
580int qcow2_cache_set_dependency(BlockDriverState *bs, Qcow2Cache *c,
581 Qcow2Cache *dependency);
3de0a294 582void qcow2_cache_depends_on_flush(Qcow2Cache *c);
49381094 583
e7108fea
HR
584int qcow2_cache_empty(BlockDriverState *bs, Qcow2Cache *c);
585
49381094
KW
586int qcow2_cache_get(BlockDriverState *bs, Qcow2Cache *c, uint64_t offset,
587 void **table);
588int qcow2_cache_get_empty(BlockDriverState *bs, Qcow2Cache *c, uint64_t offset,
589 void **table);
590int qcow2_cache_put(BlockDriverState *bs, Qcow2Cache *c, void **table);
591
f7d0fe02 592#endif