]>
Commit | Line | Data |
---|---|---|
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 |
97 | typedef 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 |
121 | typedef 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 | ||
141 | typedef struct QEMU_PACKED QCowSnapshotExtraData { | |
142 | uint64_t vm_state_size_large; | |
143 | uint64_t disk_size; | |
144 | } QCowSnapshotExtraData; | |
145 | ||
146 | ||
f7d0fe02 KW |
147 | typedef 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 |
159 | struct Qcow2Cache; |
160 | typedef struct Qcow2Cache Qcow2Cache; | |
161 | ||
75bab85c KW |
162 | typedef struct Qcow2UnknownHeaderExtension { |
163 | uint32_t magic; | |
164 | uint32_t len; | |
165 | QLIST_ENTRY(Qcow2UnknownHeaderExtension) next; | |
166 | uint8_t data[]; | |
167 | } Qcow2UnknownHeaderExtension; | |
168 | ||
cfcc4c62 KW |
169 | enum { |
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 */ |
176 | enum { | |
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 */ |
187 | enum { | |
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 |
194 | enum 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 |
203 | typedef struct Qcow2Feature { |
204 | uint8_t type; | |
205 | uint8_t bit; | |
206 | char name[46]; | |
207 | } QEMU_PACKED Qcow2Feature; | |
208 | ||
0b919fae KW |
209 | typedef struct Qcow2DiscardRegion { |
210 | BlockDriverState *bs; | |
211 | uint64_t offset; | |
212 | uint64_t bytes; | |
213 | QTAILQ_ENTRY(Qcow2DiscardRegion) next; | |
214 | } Qcow2DiscardRegion; | |
215 | ||
f7d0fe02 | 216 | typedef struct BDRVQcowState { |
f7d0fe02 KW |
217 | int cluster_bits; |
218 | int cluster_size; | |
219 | int cluster_sectors; | |
220 | int l2_bits; | |
221 | int l2_size; | |
222 | int l1_size; | |
223 | int l1_vm_state_index; | |
1d13d654 HR |
224 | int refcount_block_bits; |
225 | int refcount_block_size; | |
f7d0fe02 KW |
226 | int csize_shift; |
227 | int csize_mask; | |
228 | uint64_t cluster_offset_mask; | |
229 | uint64_t l1_table_offset; | |
230 | uint64_t *l1_table; | |
29c1a730 KW |
231 | |
232 | Qcow2Cache* l2_table_cache; | |
233 | Qcow2Cache* refcount_block_cache; | |
234 | ||
f7d0fe02 KW |
235 | uint8_t *cluster_cache; |
236 | uint8_t *cluster_data; | |
237 | uint64_t cluster_cache_offset; | |
72cf2d4f | 238 | QLIST_HEAD(QCowClusterAlloc, QCowL2Meta) cluster_allocs; |
f7d0fe02 KW |
239 | |
240 | uint64_t *refcount_table; | |
241 | uint64_t refcount_table_offset; | |
242 | uint32_t refcount_table_size; | |
bb572aef KW |
243 | uint64_t free_cluster_index; |
244 | uint64_t free_byte_offset; | |
f7d0fe02 | 245 | |
68d100e9 KW |
246 | CoMutex lock; |
247 | ||
f7d0fe02 KW |
248 | uint32_t crypt_method; /* current crypt method, 0 if no key yet */ |
249 | uint32_t crypt_method_header; | |
250 | AES_KEY aes_encrypt_key; | |
251 | AES_KEY aes_decrypt_key; | |
252 | uint64_t snapshots_offset; | |
253 | int snapshots_size; | |
ce48f2f4 | 254 | unsigned int nb_snapshots; |
f7d0fe02 | 255 | QCowSnapshot *snapshots; |
06d9260f AL |
256 | |
257 | int flags; | |
6744cbab | 258 | int qcow_version; |
74c4510a | 259 | bool use_lazy_refcounts; |
b6481f37 | 260 | int refcount_order; |
346a53df HR |
261 | int refcount_bits; |
262 | uint64_t refcount_max; | |
6744cbab | 263 | |
67af674e KW |
264 | bool discard_passthrough[QCOW2_DISCARD_MAX]; |
265 | ||
3e355390 | 266 | int overlap_check; /* bitmask of Qcow2MetadataOverlap values */ |
85186ebd | 267 | bool signaled_corruption; |
3e355390 | 268 | |
6744cbab KW |
269 | uint64_t incompatible_features; |
270 | uint64_t compatible_features; | |
271 | uint64_t autoclear_features; | |
272 | ||
273 | size_t unknown_header_fields_size; | |
274 | void* unknown_header_fields; | |
75bab85c | 275 | QLIST_HEAD(, Qcow2UnknownHeaderExtension) unknown_header_ext; |
0b919fae KW |
276 | QTAILQ_HEAD (, Qcow2DiscardRegion) discards; |
277 | bool cache_discards; | |
f7d0fe02 KW |
278 | } BDRVQcowState; |
279 | ||
f214978a KW |
280 | struct QCowAIOCB; |
281 | ||
593fb83c KW |
282 | typedef struct Qcow2COWRegion { |
283 | /** | |
284 | * Offset of the COW region in bytes from the start of the first cluster | |
285 | * touched by the request. | |
286 | */ | |
287 | uint64_t offset; | |
288 | ||
289 | /** Number of sectors to copy */ | |
290 | int nb_sectors; | |
291 | } Qcow2COWRegion; | |
292 | ||
f50f88b9 KW |
293 | /** |
294 | * Describes an in-flight (part of a) write request that writes to clusters | |
295 | * that are not referenced in their L2 table yet. | |
296 | */ | |
45aba42f KW |
297 | typedef struct QCowL2Meta |
298 | { | |
1d3afd64 | 299 | /** Guest offset of the first newly allocated cluster */ |
45aba42f | 300 | uint64_t offset; |
1d3afd64 | 301 | |
1d3afd64 | 302 | /** Host offset of the first newly allocated cluster */ |
250196f1 | 303 | uint64_t alloc_offset; |
1d3afd64 | 304 | |
1d3afd64 KW |
305 | /** |
306 | * Number of sectors from the start of the first allocated cluster to | |
307 | * the end of the (possibly shortened) request | |
308 | */ | |
45aba42f | 309 | int nb_available; |
1d3afd64 KW |
310 | |
311 | /** Number of newly allocated clusters */ | |
45aba42f | 312 | int nb_clusters; |
1d3afd64 KW |
313 | |
314 | /** | |
315 | * Requests that overlap with this allocation and wait to be restarted | |
316 | * when the allocating request has completed. | |
317 | */ | |
68d100e9 | 318 | CoQueue dependent_requests; |
f214978a | 319 | |
593fb83c KW |
320 | /** |
321 | * The COW Region between the start of the first allocated cluster and the | |
322 | * area the guest actually writes to. | |
323 | */ | |
324 | Qcow2COWRegion cow_start; | |
325 | ||
326 | /** | |
327 | * The COW Region between the area the guest actually writes to and the | |
328 | * end of the last allocated cluster. | |
329 | */ | |
330 | Qcow2COWRegion cow_end; | |
331 | ||
88c6588c KW |
332 | /** Pointer to next L2Meta of the same write request */ |
333 | struct QCowL2Meta *next; | |
334 | ||
72cf2d4f | 335 | QLIST_ENTRY(QCowL2Meta) next_in_flight; |
45aba42f KW |
336 | } QCowL2Meta; |
337 | ||
68d000a3 KW |
338 | enum { |
339 | QCOW2_CLUSTER_UNALLOCATED, | |
340 | QCOW2_CLUSTER_NORMAL, | |
341 | QCOW2_CLUSTER_COMPRESSED, | |
6377af48 | 342 | QCOW2_CLUSTER_ZERO |
68d000a3 KW |
343 | }; |
344 | ||
a40f1c2a HR |
345 | typedef enum QCow2MetadataOverlap { |
346 | QCOW2_OL_MAIN_HEADER_BITNR = 0, | |
347 | QCOW2_OL_ACTIVE_L1_BITNR = 1, | |
348 | QCOW2_OL_ACTIVE_L2_BITNR = 2, | |
349 | QCOW2_OL_REFCOUNT_TABLE_BITNR = 3, | |
350 | QCOW2_OL_REFCOUNT_BLOCK_BITNR = 4, | |
351 | QCOW2_OL_SNAPSHOT_TABLE_BITNR = 5, | |
352 | QCOW2_OL_INACTIVE_L1_BITNR = 6, | |
353 | QCOW2_OL_INACTIVE_L2_BITNR = 7, | |
354 | ||
355 | QCOW2_OL_MAX_BITNR = 8, | |
356 | ||
357 | QCOW2_OL_NONE = 0, | |
358 | QCOW2_OL_MAIN_HEADER = (1 << QCOW2_OL_MAIN_HEADER_BITNR), | |
359 | QCOW2_OL_ACTIVE_L1 = (1 << QCOW2_OL_ACTIVE_L1_BITNR), | |
360 | QCOW2_OL_ACTIVE_L2 = (1 << QCOW2_OL_ACTIVE_L2_BITNR), | |
361 | QCOW2_OL_REFCOUNT_TABLE = (1 << QCOW2_OL_REFCOUNT_TABLE_BITNR), | |
362 | QCOW2_OL_REFCOUNT_BLOCK = (1 << QCOW2_OL_REFCOUNT_BLOCK_BITNR), | |
363 | QCOW2_OL_SNAPSHOT_TABLE = (1 << QCOW2_OL_SNAPSHOT_TABLE_BITNR), | |
364 | QCOW2_OL_INACTIVE_L1 = (1 << QCOW2_OL_INACTIVE_L1_BITNR), | |
365 | /* NOTE: Checking overlaps with inactive L2 tables will result in bdrv | |
366 | * reads. */ | |
367 | QCOW2_OL_INACTIVE_L2 = (1 << QCOW2_OL_INACTIVE_L2_BITNR), | |
368 | } QCow2MetadataOverlap; | |
369 | ||
4a273c39 HR |
370 | /* Perform all overlap checks which can be done in constant time */ |
371 | #define QCOW2_OL_CONSTANT \ | |
372 | (QCOW2_OL_MAIN_HEADER | QCOW2_OL_ACTIVE_L1 | QCOW2_OL_REFCOUNT_TABLE | \ | |
373 | QCOW2_OL_SNAPSHOT_TABLE) | |
374 | ||
a40f1c2a HR |
375 | /* Perform all overlap checks which don't require disk access */ |
376 | #define QCOW2_OL_CACHED \ | |
4a273c39 HR |
377 | (QCOW2_OL_CONSTANT | QCOW2_OL_ACTIVE_L2 | QCOW2_OL_REFCOUNT_BLOCK | \ |
378 | QCOW2_OL_INACTIVE_L1) | |
379 | ||
380 | /* Perform all overlap checks */ | |
381 | #define QCOW2_OL_ALL \ | |
382 | (QCOW2_OL_CACHED | QCOW2_OL_INACTIVE_L2) | |
a40f1c2a | 383 | |
46bae927 HT |
384 | #define L1E_OFFSET_MASK 0x00fffffffffffe00ULL |
385 | #define L2E_OFFSET_MASK 0x00fffffffffffe00ULL | |
68d000a3 KW |
386 | #define L2E_COMPRESSED_OFFSET_SIZE_MASK 0x3fffffffffffffffULL |
387 | ||
46bae927 | 388 | #define REFT_OFFSET_MASK 0xfffffffffffffe00ULL |
76dc9e0c | 389 | |
3b8e2e26 KW |
390 | static inline int64_t start_of_cluster(BDRVQcowState *s, int64_t offset) |
391 | { | |
392 | return offset & ~(s->cluster_size - 1); | |
393 | } | |
394 | ||
c37f4cd7 KW |
395 | static inline int64_t offset_into_cluster(BDRVQcowState *s, int64_t offset) |
396 | { | |
397 | return offset & (s->cluster_size - 1); | |
398 | } | |
399 | ||
45aba42f | 400 | static inline int size_to_clusters(BDRVQcowState *s, int64_t size) |
f7d0fe02 KW |
401 | { |
402 | return (size + (s->cluster_size - 1)) >> s->cluster_bits; | |
403 | } | |
404 | ||
2cf7cfa1 | 405 | static inline int64_t size_to_l1(BDRVQcowState *s, int64_t size) |
419b19d9 SH |
406 | { |
407 | int shift = s->cluster_bits + s->l2_bits; | |
408 | return (size + (1ULL << shift) - 1) >> shift; | |
409 | } | |
410 | ||
17a71e58 KW |
411 | static inline int offset_to_l2_index(BDRVQcowState *s, int64_t offset) |
412 | { | |
413 | return (offset >> s->cluster_bits) & (s->l2_size - 1); | |
414 | } | |
415 | ||
c142442b KW |
416 | static inline int64_t align_offset(int64_t offset, int n) |
417 | { | |
418 | offset = (offset + n - 1) & ~(n - 1); | |
419 | return offset; | |
420 | } | |
421 | ||
1ebf561c KW |
422 | static inline int64_t qcow2_vm_state_offset(BDRVQcowState *s) |
423 | { | |
424 | return (int64_t)s->l1_vm_state_index << (s->cluster_bits + s->l2_bits); | |
425 | } | |
426 | ||
2b5d5953 KW |
427 | static inline uint64_t qcow2_max_refcount_clusters(BDRVQcowState *s) |
428 | { | |
429 | return QCOW_MAX_REFTABLE_SIZE >> s->cluster_bits; | |
430 | } | |
431 | ||
68d000a3 KW |
432 | static inline int qcow2_get_cluster_type(uint64_t l2_entry) |
433 | { | |
434 | if (l2_entry & QCOW_OFLAG_COMPRESSED) { | |
435 | return QCOW2_CLUSTER_COMPRESSED; | |
6377af48 KW |
436 | } else if (l2_entry & QCOW_OFLAG_ZERO) { |
437 | return QCOW2_CLUSTER_ZERO; | |
68d000a3 KW |
438 | } else if (!(l2_entry & L2E_OFFSET_MASK)) { |
439 | return QCOW2_CLUSTER_UNALLOCATED; | |
440 | } else { | |
441 | return QCOW2_CLUSTER_NORMAL; | |
442 | } | |
443 | } | |
444 | ||
bfe8043e SH |
445 | /* Check whether refcounts are eager or lazy */ |
446 | static inline bool qcow2_need_accurate_refcounts(BDRVQcowState *s) | |
447 | { | |
448 | return !(s->incompatible_features & QCOW2_INCOMPAT_DIRTY); | |
449 | } | |
c142442b | 450 | |
65eb2e35 KW |
451 | static inline uint64_t l2meta_cow_start(QCowL2Meta *m) |
452 | { | |
453 | return m->offset + m->cow_start.offset; | |
454 | } | |
455 | ||
456 | static inline uint64_t l2meta_cow_end(QCowL2Meta *m) | |
457 | { | |
458 | return m->offset + m->cow_end.offset | |
459 | + (m->cow_end.nb_sectors << BDRV_SECTOR_BITS); | |
460 | } | |
461 | ||
2aabe7c7 HR |
462 | static inline uint16_t refcount_diff(uint16_t r1, uint16_t r2) |
463 | { | |
464 | return r1 > r2 ? r1 - r2 : r2 - r1; | |
465 | } | |
466 | ||
f7d0fe02 KW |
467 | // FIXME Need qcow2_ prefix to global functions |
468 | ||
469 | /* qcow2.c functions */ | |
bd28f835 KW |
470 | int qcow2_backing_read1(BlockDriverState *bs, QEMUIOVector *qiov, |
471 | int64_t sector_num, int nb_sectors); | |
280d3735 KW |
472 | |
473 | int qcow2_mark_dirty(BlockDriverState *bs); | |
69c98726 HR |
474 | int qcow2_mark_corrupt(BlockDriverState *bs); |
475 | int qcow2_mark_consistent(BlockDriverState *bs); | |
e24e49e6 | 476 | int qcow2_update_header(BlockDriverState *bs); |
f7d0fe02 | 477 | |
85186ebd HR |
478 | void qcow2_signal_corruption(BlockDriverState *bs, bool fatal, int64_t offset, |
479 | int64_t size, const char *message_format, ...) | |
480 | GCC_FMT_ATTR(5, 6); | |
481 | ||
f7d0fe02 | 482 | /* qcow2-refcount.c functions */ |
ed6ccf0f KW |
483 | int qcow2_refcount_init(BlockDriverState *bs); |
484 | void qcow2_refcount_close(BlockDriverState *bs); | |
f7d0fe02 | 485 | |
7324c10f HR |
486 | int qcow2_get_refcount(BlockDriverState *bs, int64_t cluster_index, |
487 | uint16_t *refcount); | |
44751917 | 488 | |
32b6444d | 489 | int qcow2_update_cluster_refcount(BlockDriverState *bs, int64_t cluster_index, |
2aabe7c7 HR |
490 | uint16_t addend, bool decrease, |
491 | enum qcow2_discard_type type); | |
32b6444d | 492 | |
bb572aef | 493 | int64_t qcow2_alloc_clusters(BlockDriverState *bs, uint64_t size); |
256900b1 KW |
494 | int qcow2_alloc_clusters_at(BlockDriverState *bs, uint64_t offset, |
495 | int nb_clusters); | |
ed6ccf0f KW |
496 | int64_t qcow2_alloc_bytes(BlockDriverState *bs, int size); |
497 | void qcow2_free_clusters(BlockDriverState *bs, | |
6cfcb9b8 KW |
498 | int64_t offset, int64_t size, |
499 | enum qcow2_discard_type type); | |
500 | void qcow2_free_any_clusters(BlockDriverState *bs, uint64_t l2_entry, | |
501 | int nb_clusters, enum qcow2_discard_type type); | |
f7d0fe02 | 502 | |
ed6ccf0f KW |
503 | int qcow2_update_snapshot_refcount(BlockDriverState *bs, |
504 | int64_t l1_table_offset, int l1_size, int addend); | |
f7d0fe02 | 505 | |
166acf54 KW |
506 | int qcow2_check_refcounts(BlockDriverState *bs, BdrvCheckResult *res, |
507 | BdrvCheckMode fix); | |
f7d0fe02 | 508 | |
0b919fae KW |
509 | void qcow2_process_discards(BlockDriverState *bs, int ret); |
510 | ||
231bb267 | 511 | int qcow2_check_metadata_overlap(BlockDriverState *bs, int ign, int64_t offset, |
a40f1c2a | 512 | int64_t size); |
231bb267 | 513 | int qcow2_pre_write_overlap_check(BlockDriverState *bs, int ign, int64_t offset, |
a40f1c2a HR |
514 | int64_t size); |
515 | ||
45aba42f | 516 | /* qcow2-cluster.c functions */ |
2cf7cfa1 KW |
517 | int qcow2_grow_l1_table(BlockDriverState *bs, uint64_t min_size, |
518 | bool exact_size); | |
e23e400e | 519 | int qcow2_write_l1_entry(BlockDriverState *bs, int l1_index); |
ed6ccf0f | 520 | void qcow2_l2_cache_reset(BlockDriverState *bs); |
66f82cee | 521 | int qcow2_decompress_cluster(BlockDriverState *bs, uint64_t cluster_offset); |
ed6ccf0f | 522 | void qcow2_encrypt_sectors(BDRVQcowState *s, int64_t sector_num, |
45aba42f KW |
523 | uint8_t *out_buf, const uint8_t *in_buf, |
524 | int nb_sectors, int enc, | |
525 | const AES_KEY *key); | |
526 | ||
1c46efaa KW |
527 | int qcow2_get_cluster_offset(BlockDriverState *bs, uint64_t offset, |
528 | int *num, uint64_t *cluster_offset); | |
f4f0d391 | 529 | int qcow2_alloc_cluster_offset(BlockDriverState *bs, uint64_t offset, |
16f0587e | 530 | int *num, uint64_t *host_offset, QCowL2Meta **m); |
ed6ccf0f | 531 | uint64_t qcow2_alloc_compressed_cluster_offset(BlockDriverState *bs, |
45aba42f KW |
532 | uint64_t offset, |
533 | int compressed_size); | |
534 | ||
148da7ea | 535 | int qcow2_alloc_cluster_link_l2(BlockDriverState *bs, QCowL2Meta *m); |
5ea929e3 | 536 | int qcow2_discard_clusters(BlockDriverState *bs, uint64_t offset, |
808c4b6f | 537 | int nb_sectors, enum qcow2_discard_type type, bool full_discard); |
621f0589 | 538 | int qcow2_zero_clusters(BlockDriverState *bs, uint64_t offset, int nb_sectors); |
45aba42f | 539 | |
4057a2b2 HR |
540 | int qcow2_expand_zero_clusters(BlockDriverState *bs, |
541 | BlockDriverAmendStatusCB *status_cb); | |
32b6444d | 542 | |
c142442b | 543 | /* qcow2-snapshot.c functions */ |
ed6ccf0f KW |
544 | int qcow2_snapshot_create(BlockDriverState *bs, QEMUSnapshotInfo *sn_info); |
545 | int qcow2_snapshot_goto(BlockDriverState *bs, const char *snapshot_id); | |
a89d89d3 WX |
546 | int qcow2_snapshot_delete(BlockDriverState *bs, |
547 | const char *snapshot_id, | |
548 | const char *name, | |
549 | Error **errp); | |
ed6ccf0f | 550 | int qcow2_snapshot_list(BlockDriverState *bs, QEMUSnapshotInfo **psn_tab); |
7b4c4781 WX |
551 | int qcow2_snapshot_load_tmp(BlockDriverState *bs, |
552 | const char *snapshot_id, | |
553 | const char *name, | |
554 | Error **errp); | |
c142442b | 555 | |
ed6ccf0f KW |
556 | void qcow2_free_snapshots(BlockDriverState *bs); |
557 | int qcow2_read_snapshots(BlockDriverState *bs); | |
c142442b | 558 | |
49381094 | 559 | /* qcow2-cache.c functions */ |
6af4e9ea | 560 | Qcow2Cache *qcow2_cache_create(BlockDriverState *bs, int num_tables); |
49381094 KW |
561 | int qcow2_cache_destroy(BlockDriverState* bs, Qcow2Cache *c); |
562 | ||
563 | void qcow2_cache_entry_mark_dirty(Qcow2Cache *c, void *table); | |
564 | int qcow2_cache_flush(BlockDriverState *bs, Qcow2Cache *c); | |
565 | int qcow2_cache_set_dependency(BlockDriverState *bs, Qcow2Cache *c, | |
566 | Qcow2Cache *dependency); | |
3de0a294 | 567 | void qcow2_cache_depends_on_flush(Qcow2Cache *c); |
49381094 | 568 | |
e7108fea HR |
569 | int qcow2_cache_empty(BlockDriverState *bs, Qcow2Cache *c); |
570 | ||
49381094 KW |
571 | int qcow2_cache_get(BlockDriverState *bs, Qcow2Cache *c, uint64_t offset, |
572 | void **table); | |
573 | int qcow2_cache_get_empty(BlockDriverState *bs, Qcow2Cache *c, uint64_t offset, | |
574 | void **table); | |
575 | int qcow2_cache_put(BlockDriverState *bs, Qcow2Cache *c, void **table); | |
576 | ||
f7d0fe02 | 577 | #endif |