]> Git Repo - qemu.git/blame - block/qcow2.h
hw/timer/armv7m_systick: Rewrite to use ptimers
[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
b25b387f 28#include "crypto/block.h"
10817bf0 29#include "qemu/coroutine.h"
b6a95c6d 30#include "qemu/units.h"
9353db47 31#include "block/block_int.h"
f7d0fe02 32
14899cdf
FN
33//#define DEBUG_ALLOC
34//#define DEBUG_ALLOC2
35//#define DEBUG_EXT
36
f7d0fe02 37#define QCOW_MAGIC (('Q' << 24) | ('F' << 16) | ('I' << 8) | 0xfb)
f7d0fe02
KW
38
39#define QCOW_CRYPT_NONE 0
40#define QCOW_CRYPT_AES 1
4652b8f3 41#define QCOW_CRYPT_LUKS 2
f7d0fe02
KW
42
43#define QCOW_MAX_CRYPT_CLUSTERS 32
ce48f2f4 44#define QCOW_MAX_SNAPSHOTS 65536
f7d0fe02 45
77d6a215
EB
46/* Field widths in qcow2 mean normal cluster offsets cannot reach
47 * 64PB; depending on cluster size, compressed clusters can have a
48 * smaller limit (64PB for up to 16k clusters, then ramps down to
49 * 512TB for 2M clusters). */
50#define QCOW_MAX_CLUSTER_OFFSET ((1ULL << 56) - 1)
51
2b5d5953
KW
52/* 8 MB refcount table is enough for 2 PB images at 64k cluster size
53 * (128 GB for 512 byte clusters, 2 EB for 2 MB clusters) */
14632122 54#define QCOW_MAX_REFTABLE_SIZE (8 * MiB)
2b5d5953 55
6a83f8b5
KW
56/* 32 MB L1 table is enough for 2 PB images at 64k cluster size
57 * (128 GB for 512 byte clusters, 2 EB for 2 MB clusters) */
14632122 58#define QCOW_MAX_L1_SIZE (32 * MiB)
6a83f8b5 59
5dae6e30
KW
60/* Allow for an average of 1k per snapshot table entry, should be plenty of
61 * space for snapshot names and IDs */
62#define QCOW_MAX_SNAPSHOTS_SIZE (1024 * QCOW_MAX_SNAPSHOTS)
63
fcf9a6b7
HR
64/* Maximum amount of extra data per snapshot table entry to accept */
65#define QCOW_MAX_SNAPSHOT_EXTRA_DATA 1024
66
88ddffae
VSO
67/* Bitmap header extension constraints */
68#define QCOW2_MAX_BITMAPS 65535
69#define QCOW2_MAX_BITMAP_DIRECTORY_SIZE (1024 * QCOW2_MAX_BITMAPS)
70
d710cf57
VSO
71/* Maximum of parallel sub-request per guest request */
72#define QCOW2_MAX_WORKERS 8
73
f7d0fe02 74/* indicate that the refcount of the referenced cluster is exactly one. */
127c84e1 75#define QCOW_OFLAG_COPIED (1ULL << 63)
f7d0fe02 76/* indicate that the cluster is compressed (they never have the copied flag) */
127c84e1 77#define QCOW_OFLAG_COMPRESSED (1ULL << 62)
6377af48 78/* The cluster reads as all zeros */
127c84e1 79#define QCOW_OFLAG_ZERO (1ULL << 0)
f7d0fe02 80
d0346b55
AG
81#define QCOW_EXTL2_SUBCLUSTERS_PER_CLUSTER 32
82
34905d8e
AG
83/* The subcluster X [0..31] is allocated */
84#define QCOW_OFLAG_SUB_ALLOC(X) (1ULL << (X))
85/* The subcluster X [0..31] reads as zeroes */
86#define QCOW_OFLAG_SUB_ZERO(X) (QCOW_OFLAG_SUB_ALLOC(X) << 32)
87/* Subclusters [X, Y) (0 <= X <= Y <= 32) are allocated */
88#define QCOW_OFLAG_SUB_ALLOC_RANGE(X, Y) \
89 (QCOW_OFLAG_SUB_ALLOC(Y) - QCOW_OFLAG_SUB_ALLOC(X))
90/* Subclusters [X, Y) (0 <= X <= Y <= 32) read as zeroes */
91#define QCOW_OFLAG_SUB_ZERO_RANGE(X, Y) \
92 (QCOW_OFLAG_SUB_ALLOC_RANGE(X, Y) << 32)
93/* L2 entry bitmap with all allocation bits set */
94#define QCOW_L2_BITMAP_ALL_ALLOC (QCOW_OFLAG_SUB_ALLOC_RANGE(0, 32))
95/* L2 entry bitmap with all "read as zeroes" bits set */
96#define QCOW_L2_BITMAP_ALL_ZEROES (QCOW_OFLAG_SUB_ZERO_RANGE(0, 32))
97
c8fd8554
AG
98/* Size of normal and extended L2 entries */
99#define L2E_SIZE_NORMAL (sizeof(uint64_t))
100#define L2E_SIZE_EXTENDED (sizeof(uint64_t) * 2)
101
02b1ecfa
AG
102/* Size of L1 table entries */
103#define L1E_SIZE (sizeof(uint64_t))
104
105/* Size of reftable entries */
106#define REFTABLE_ENTRY_SIZE (sizeof(uint64_t))
107
f7d0fe02 108#define MIN_CLUSTER_BITS 9
80ee15a6 109#define MAX_CLUSTER_BITS 21
f7d0fe02 110
b6c24694
AG
111/* Defined in the qcow2 spec (compressed cluster descriptor) */
112#define QCOW2_COMPRESSED_SECTOR_SIZE 512U
24552feb 113#define QCOW2_COMPRESSED_SECTOR_MASK (~(QCOW2_COMPRESSED_SECTOR_SIZE - 1ULL))
b6c24694 114
57e21669 115/* Must be at least 2 to cover COW */
1221fe6f 116#define MIN_L2_CACHE_SIZE 2 /* cache entries */
f7d0fe02 117
29c1a730 118/* Must be at least 4 to cover all cases of refcount table growth */
440ba08a
HR
119#define MIN_REFCOUNT_CACHE_SIZE 4 /* clusters */
120
80668d0f 121#ifdef CONFIG_LINUX
14632122 122#define DEFAULT_L2_CACHE_MAX_SIZE (32 * MiB)
e957b50b 123#define DEFAULT_CACHE_CLEAN_INTERVAL 600 /* seconds */
80668d0f 124#else
14632122 125#define DEFAULT_L2_CACHE_MAX_SIZE (8 * MiB)
e957b50b
LB
126/* Cache clean interval is currently available only on Linux, so must be 0 */
127#define DEFAULT_CACHE_CLEAN_INTERVAL 0
80668d0f 128#endif
440ba08a 129
14632122 130#define DEFAULT_CLUSTER_SIZE 65536
99cce9fa 131
0e8c08be 132#define QCOW2_OPT_DATA_FILE "data-file"
64aa99d3
KW
133#define QCOW2_OPT_LAZY_REFCOUNTS "lazy-refcounts"
134#define QCOW2_OPT_DISCARD_REQUEST "pass-discard-request"
135#define QCOW2_OPT_DISCARD_SNAPSHOT "pass-discard-snapshot"
136#define QCOW2_OPT_DISCARD_OTHER "pass-discard-other"
05de7e86 137#define QCOW2_OPT_OVERLAP "overlap-check"
ee42b5ce 138#define QCOW2_OPT_OVERLAP_TEMPLATE "overlap-check.template"
05de7e86
HR
139#define QCOW2_OPT_OVERLAP_MAIN_HEADER "overlap-check.main-header"
140#define QCOW2_OPT_OVERLAP_ACTIVE_L1 "overlap-check.active-l1"
141#define QCOW2_OPT_OVERLAP_ACTIVE_L2 "overlap-check.active-l2"
142#define QCOW2_OPT_OVERLAP_REFCOUNT_TABLE "overlap-check.refcount-table"
143#define QCOW2_OPT_OVERLAP_REFCOUNT_BLOCK "overlap-check.refcount-block"
144#define QCOW2_OPT_OVERLAP_SNAPSHOT_TABLE "overlap-check.snapshot-table"
145#define QCOW2_OPT_OVERLAP_INACTIVE_L1 "overlap-check.inactive-l1"
146#define QCOW2_OPT_OVERLAP_INACTIVE_L2 "overlap-check.inactive-l2"
0e4e4318 147#define QCOW2_OPT_OVERLAP_BITMAP_DIRECTORY "overlap-check.bitmap-directory"
6c1c8d5d
HR
148#define QCOW2_OPT_CACHE_SIZE "cache-size"
149#define QCOW2_OPT_L2_CACHE_SIZE "l2-cache-size"
1221fe6f 150#define QCOW2_OPT_L2_CACHE_ENTRY_SIZE "l2-cache-entry-size"
6c1c8d5d 151#define QCOW2_OPT_REFCOUNT_CACHE_SIZE "refcount-cache-size"
279621c0 152#define QCOW2_OPT_CACHE_CLEAN_INTERVAL "cache-clean-interval"
acdfb480 153
f7d0fe02
KW
154typedef struct QCowHeader {
155 uint32_t magic;
156 uint32_t version;
157 uint64_t backing_file_offset;
158 uint32_t backing_file_size;
159 uint32_t cluster_bits;
160 uint64_t size; /* in bytes */
161 uint32_t crypt_method;
162 uint32_t l1_size; /* XXX: save number of clusters instead ? */
163 uint64_t l1_table_offset;
164 uint64_t refcount_table_offset;
165 uint32_t refcount_table_clusters;
166 uint32_t nb_snapshots;
167 uint64_t snapshots_offset;
6744cbab
KW
168
169 /* The following fields are only valid for version >= 3 */
170 uint64_t incompatible_features;
171 uint64_t compatible_features;
172 uint64_t autoclear_features;
173
174 uint32_t refcount_order;
175 uint32_t header_length;
572ad978
DP
176
177 /* Additional fields */
178 uint8_t compression_type;
179
180 /* header must be a multiple of 8 */
181 uint8_t padding[7];
c4217f64 182} QEMU_PACKED QCowHeader;
f7d0fe02 183
572ad978
DP
184QEMU_BUILD_BUG_ON(!QEMU_IS_ALIGNED(sizeof(QCowHeader), 8));
185
ce48f2f4
KW
186typedef struct QEMU_PACKED QCowSnapshotHeader {
187 /* header is 8 byte aligned */
188 uint64_t l1_table_offset;
189
190 uint32_t l1_size;
191 uint16_t id_str_size;
192 uint16_t name_size;
193
194 uint32_t date_sec;
195 uint32_t date_nsec;
196
197 uint64_t vm_clock_nsec;
198
199 uint32_t vm_state_size;
200 uint32_t extra_data_size; /* for extension */
201 /* extra data follows */
202 /* id_str follows */
203 /* name follows */
204} QCowSnapshotHeader;
205
206typedef struct QEMU_PACKED QCowSnapshotExtraData {
207 uint64_t vm_state_size_large;
208 uint64_t disk_size;
bbacffc5 209 uint64_t icount;
ce48f2f4
KW
210} QCowSnapshotExtraData;
211
212
f7d0fe02
KW
213typedef struct QCowSnapshot {
214 uint64_t l1_table_offset;
215 uint32_t l1_size;
216 char *id_str;
217 char *name;
90b27759 218 uint64_t disk_size;
c2c9a466 219 uint64_t vm_state_size;
f7d0fe02
KW
220 uint32_t date_sec;
221 uint32_t date_nsec;
222 uint64_t vm_clock_nsec;
bbacffc5
PD
223 /* icount value for the moment when snapshot was taken */
224 uint64_t icount;
fcf9a6b7
HR
225 /* Size of all extra data, including QCowSnapshotExtraData if available */
226 uint32_t extra_data_size;
227 /* Data beyond QCowSnapshotExtraData, if any */
228 void *unknown_extra_data;
f7d0fe02
KW
229} QCowSnapshot;
230
49381094
KW
231struct Qcow2Cache;
232typedef struct Qcow2Cache Qcow2Cache;
233
4652b8f3
DB
234typedef struct Qcow2CryptoHeaderExtension {
235 uint64_t offset;
236 uint64_t length;
237} QEMU_PACKED Qcow2CryptoHeaderExtension;
238
75bab85c
KW
239typedef struct Qcow2UnknownHeaderExtension {
240 uint32_t magic;
241 uint32_t len;
242 QLIST_ENTRY(Qcow2UnknownHeaderExtension) next;
243 uint8_t data[];
244} Qcow2UnknownHeaderExtension;
245
cfcc4c62
KW
246enum {
247 QCOW2_FEAT_TYPE_INCOMPATIBLE = 0,
248 QCOW2_FEAT_TYPE_COMPATIBLE = 1,
249 QCOW2_FEAT_TYPE_AUTOCLEAR = 2,
250};
251
c61d0004
SH
252/* Incompatible feature bits */
253enum {
93c24936
KW
254 QCOW2_INCOMPAT_DIRTY_BITNR = 0,
255 QCOW2_INCOMPAT_CORRUPT_BITNR = 1,
256 QCOW2_INCOMPAT_DATA_FILE_BITNR = 2,
572ad978 257 QCOW2_INCOMPAT_COMPRESSION_BITNR = 3,
7be20252 258 QCOW2_INCOMPAT_EXTL2_BITNR = 4,
93c24936
KW
259 QCOW2_INCOMPAT_DIRTY = 1 << QCOW2_INCOMPAT_DIRTY_BITNR,
260 QCOW2_INCOMPAT_CORRUPT = 1 << QCOW2_INCOMPAT_CORRUPT_BITNR,
261 QCOW2_INCOMPAT_DATA_FILE = 1 << QCOW2_INCOMPAT_DATA_FILE_BITNR,
572ad978 262 QCOW2_INCOMPAT_COMPRESSION = 1 << QCOW2_INCOMPAT_COMPRESSION_BITNR,
7be20252 263 QCOW2_INCOMPAT_EXTL2 = 1 << QCOW2_INCOMPAT_EXTL2_BITNR,
93c24936
KW
264
265 QCOW2_INCOMPAT_MASK = QCOW2_INCOMPAT_DIRTY
0e8c08be 266 | QCOW2_INCOMPAT_CORRUPT
572ad978 267 | QCOW2_INCOMPAT_DATA_FILE
7be20252
AG
268 | QCOW2_INCOMPAT_COMPRESSION
269 | QCOW2_INCOMPAT_EXTL2,
c61d0004
SH
270};
271
bfe8043e
SH
272/* Compatible feature bits */
273enum {
274 QCOW2_COMPAT_LAZY_REFCOUNTS_BITNR = 0,
275 QCOW2_COMPAT_LAZY_REFCOUNTS = 1 << QCOW2_COMPAT_LAZY_REFCOUNTS_BITNR,
276
277 QCOW2_COMPAT_FEAT_MASK = QCOW2_COMPAT_LAZY_REFCOUNTS,
278};
279
88ddffae
VSO
280/* Autoclear feature bits */
281enum {
93c24936
KW
282 QCOW2_AUTOCLEAR_BITMAPS_BITNR = 0,
283 QCOW2_AUTOCLEAR_DATA_FILE_RAW_BITNR = 1,
284 QCOW2_AUTOCLEAR_BITMAPS = 1 << QCOW2_AUTOCLEAR_BITMAPS_BITNR,
285 QCOW2_AUTOCLEAR_DATA_FILE_RAW = 1 << QCOW2_AUTOCLEAR_DATA_FILE_RAW_BITNR,
88ddffae 286
6c3944dc
KW
287 QCOW2_AUTOCLEAR_MASK = QCOW2_AUTOCLEAR_BITMAPS
288 | QCOW2_AUTOCLEAR_DATA_FILE_RAW,
88ddffae
VSO
289};
290
6cfcb9b8
KW
291enum qcow2_discard_type {
292 QCOW2_DISCARD_NEVER = 0,
293 QCOW2_DISCARD_ALWAYS,
294 QCOW2_DISCARD_REQUEST,
295 QCOW2_DISCARD_SNAPSHOT,
296 QCOW2_DISCARD_OTHER,
297 QCOW2_DISCARD_MAX
298};
299
cfcc4c62
KW
300typedef struct Qcow2Feature {
301 uint8_t type;
302 uint8_t bit;
303 char name[46];
304} QEMU_PACKED Qcow2Feature;
305
0b919fae
KW
306typedef struct Qcow2DiscardRegion {
307 BlockDriverState *bs;
308 uint64_t offset;
309 uint64_t bytes;
310 QTAILQ_ENTRY(Qcow2DiscardRegion) next;
311} Qcow2DiscardRegion;
312
7453c96b
HR
313typedef uint64_t Qcow2GetRefcountFunc(const void *refcount_array,
314 uint64_t index);
315typedef void Qcow2SetRefcountFunc(void *refcount_array,
316 uint64_t index, uint64_t value);
317
88ddffae
VSO
318typedef struct Qcow2BitmapHeaderExt {
319 uint32_t nb_bitmaps;
320 uint32_t reserved32;
321 uint64_t bitmap_directory_size;
322 uint64_t bitmap_directory_offset;
323} QEMU_PACKED Qcow2BitmapHeaderExt;
324
8ac0f15f
VSO
325#define QCOW2_MAX_THREADS 4
326
ff99129a 327typedef struct BDRVQcow2State {
f7d0fe02
KW
328 int cluster_bits;
329 int cluster_size;
3c2e511a 330 int l2_slice_size;
d0346b55
AG
331 int subcluster_bits;
332 int subcluster_size;
333 int subclusters_per_cluster;
f7d0fe02
KW
334 int l2_bits;
335 int l2_size;
336 int l1_size;
337 int l1_vm_state_index;
1d13d654
HR
338 int refcount_block_bits;
339 int refcount_block_size;
f7d0fe02
KW
340 int csize_shift;
341 int csize_mask;
342 uint64_t cluster_offset_mask;
343 uint64_t l1_table_offset;
344 uint64_t *l1_table;
29c1a730
KW
345
346 Qcow2Cache* l2_table_cache;
347 Qcow2Cache* refcount_block_cache;
279621c0
AG
348 QEMUTimer *cache_clean_timer;
349 unsigned cache_clean_interval;
29c1a730 350
b58deb34 351 QLIST_HEAD(, QCowL2Meta) cluster_allocs;
f7d0fe02
KW
352
353 uint64_t *refcount_table;
354 uint64_t refcount_table_offset;
355 uint32_t refcount_table_size;
7061a078 356 uint32_t max_refcount_table_index; /* Last used entry in refcount_table */
bb572aef
KW
357 uint64_t free_cluster_index;
358 uint64_t free_byte_offset;
f7d0fe02 359
68d100e9
KW
360 CoMutex lock;
361
4652b8f3 362 Qcow2CryptoHeaderExtension crypto_header; /* QCow2 header extension */
b25b387f
DB
363 QCryptoBlockOpenOptions *crypto_opts; /* Disk encryption runtime options */
364 QCryptoBlock *crypto; /* Disk encryption format driver */
4652b8f3
DB
365 bool crypt_physical_offset; /* Whether to use virtual or physical offset
366 for encryption initialization vector tweak */
f7d0fe02 367 uint32_t crypt_method_header;
f7d0fe02
KW
368 uint64_t snapshots_offset;
369 int snapshots_size;
ce48f2f4 370 unsigned int nb_snapshots;
f7d0fe02 371 QCowSnapshot *snapshots;
06d9260f 372
88ddffae
VSO
373 uint32_t nb_bitmaps;
374 uint64_t bitmap_directory_size;
375 uint64_t bitmap_directory_offset;
376
06d9260f 377 int flags;
6744cbab 378 int qcow_version;
74c4510a 379 bool use_lazy_refcounts;
b6481f37 380 int refcount_order;
346a53df
HR
381 int refcount_bits;
382 uint64_t refcount_max;
6744cbab 383
7453c96b
HR
384 Qcow2GetRefcountFunc *get_refcount;
385 Qcow2SetRefcountFunc *set_refcount;
386
67af674e
KW
387 bool discard_passthrough[QCOW2_DISCARD_MAX];
388
3e355390 389 int overlap_check; /* bitmask of Qcow2MetadataOverlap values */
85186ebd 390 bool signaled_corruption;
3e355390 391
6744cbab
KW
392 uint64_t incompatible_features;
393 uint64_t compatible_features;
394 uint64_t autoclear_features;
395
396 size_t unknown_header_fields_size;
397 void* unknown_header_fields;
75bab85c 398 QLIST_HEAD(, Qcow2UnknownHeaderExtension) unknown_header_ext;
0b919fae
KW
399 QTAILQ_HEAD (, Qcow2DiscardRegion) discards;
400 bool cache_discards;
e4603fe1
KW
401
402 /* Backing file path and format as stored in the image (this is not the
403 * effective path/format, which may be the result of a runtime option
404 * override) */
405 char *image_backing_file;
406 char *image_backing_format;
9b890bdc 407 char *image_data_file;
ceb029cd 408
6f13a316
VSO
409 CoQueue thread_task_queue;
410 int nb_threads;
93c24936
KW
411
412 BdrvChild *data_file;
69f47505
VSO
413
414 bool metadata_preallocation_checked;
415 bool metadata_preallocation;
572ad978
DP
416 /*
417 * Compression type used for the image. Default: 0 - ZLIB
418 * The image compression type is set on image creation.
419 * For now, the only way to change the compression type
420 * is to convert the image with the desired compression type set.
421 */
422 Qcow2CompressionType compression_type;
ff99129a 423} BDRVQcow2State;
f7d0fe02 424
593fb83c
KW
425typedef struct Qcow2COWRegion {
426 /**
427 * Offset of the COW region in bytes from the start of the first cluster
428 * touched by the request.
429 */
e034f5bc 430 unsigned offset;
593fb83c 431
85567393 432 /** Number of bytes to copy */
e034f5bc 433 unsigned nb_bytes;
593fb83c
KW
434} Qcow2COWRegion;
435
f50f88b9
KW
436/**
437 * Describes an in-flight (part of a) write request that writes to clusters
438 * that are not referenced in their L2 table yet.
439 */
45aba42f
KW
440typedef struct QCowL2Meta
441{
1d3afd64 442 /** Guest offset of the first newly allocated cluster */
45aba42f 443 uint64_t offset;
1d3afd64 444
1d3afd64 445 /** Host offset of the first newly allocated cluster */
250196f1 446 uint64_t alloc_offset;
1d3afd64 447
1d3afd64 448 /** Number of newly allocated clusters */
45aba42f 449 int nb_clusters;
1d3afd64 450
564a6b69
HR
451 /** Do not free the old clusters */
452 bool keep_old_clusters;
453
1d3afd64
KW
454 /**
455 * Requests that overlap with this allocation and wait to be restarted
456 * when the allocating request has completed.
457 */
68d100e9 458 CoQueue dependent_requests;
f214978a 459
593fb83c
KW
460 /**
461 * The COW Region between the start of the first allocated cluster and the
462 * area the guest actually writes to.
463 */
464 Qcow2COWRegion cow_start;
465
466 /**
467 * The COW Region between the area the guest actually writes to and the
468 * end of the last allocated cluster.
469 */
470 Qcow2COWRegion cow_end;
471
c8bb23cb
AN
472 /*
473 * Indicates that COW regions are already handled and do not require
474 * any more processing.
475 */
476 bool skip_cow;
477
40dee943
AG
478 /**
479 * Indicates that this is not a normal write request but a preallocation.
480 * If the image has extended L2 entries this means that no new individual
481 * subclusters will be marked as allocated in the L2 bitmap (but any
482 * existing contents of that bitmap will be kept).
483 */
484 bool prealloc;
485
ee22a9d8
AG
486 /**
487 * The I/O vector with the data from the actual guest write request.
488 * If non-NULL, this is meant to be merged together with the data
489 * from @cow_start and @cow_end into one single write operation.
490 */
491 QEMUIOVector *data_qiov;
5396234b 492 size_t data_qiov_offset;
ee22a9d8 493
88c6588c
KW
494 /** Pointer to next L2Meta of the same write request */
495 struct QCowL2Meta *next;
496
72cf2d4f 497 QLIST_ENTRY(QCowL2Meta) next_in_flight;
45aba42f
KW
498} QCowL2Meta;
499
34905d8e
AG
500/*
501 * In images with standard L2 entries all clusters are treated as if
502 * they had one subcluster so QCow2ClusterType and QCow2SubclusterType
503 * can be mapped to each other and have the exact same meaning
504 * (QCOW2_SUBCLUSTER_UNALLOCATED_ALLOC cannot happen in these images).
505 *
506 * In images with extended L2 entries QCow2ClusterType refers to the
507 * complete cluster and QCow2SubclusterType to each of the individual
508 * subclusters, so there are several possible combinations:
509 *
510 * |--------------+---------------------------|
511 * | Cluster type | Possible subcluster types |
512 * |--------------+---------------------------|
513 * | UNALLOCATED | UNALLOCATED_PLAIN |
514 * | | ZERO_PLAIN |
515 * |--------------+---------------------------|
516 * | NORMAL | UNALLOCATED_ALLOC |
517 * | | ZERO_ALLOC |
518 * | | NORMAL |
519 * |--------------+---------------------------|
520 * | COMPRESSED | COMPRESSED |
521 * |--------------+---------------------------|
522 *
523 * QCOW2_SUBCLUSTER_INVALID means that the L2 entry is incorrect and
524 * the image should be marked corrupt.
525 */
526
3ef95218 527typedef enum QCow2ClusterType {
68d000a3 528 QCOW2_CLUSTER_UNALLOCATED,
fdfab37d
EB
529 QCOW2_CLUSTER_ZERO_PLAIN,
530 QCOW2_CLUSTER_ZERO_ALLOC,
68d000a3
KW
531 QCOW2_CLUSTER_NORMAL,
532 QCOW2_CLUSTER_COMPRESSED,
3ef95218 533} QCow2ClusterType;
68d000a3 534
34905d8e
AG
535typedef enum QCow2SubclusterType {
536 QCOW2_SUBCLUSTER_UNALLOCATED_PLAIN,
537 QCOW2_SUBCLUSTER_UNALLOCATED_ALLOC,
538 QCOW2_SUBCLUSTER_ZERO_PLAIN,
539 QCOW2_SUBCLUSTER_ZERO_ALLOC,
540 QCOW2_SUBCLUSTER_NORMAL,
541 QCOW2_SUBCLUSTER_COMPRESSED,
542 QCOW2_SUBCLUSTER_INVALID,
543} QCow2SubclusterType;
544
a40f1c2a 545typedef enum QCow2MetadataOverlap {
0e4e4318
VSO
546 QCOW2_OL_MAIN_HEADER_BITNR = 0,
547 QCOW2_OL_ACTIVE_L1_BITNR = 1,
548 QCOW2_OL_ACTIVE_L2_BITNR = 2,
549 QCOW2_OL_REFCOUNT_TABLE_BITNR = 3,
550 QCOW2_OL_REFCOUNT_BLOCK_BITNR = 4,
551 QCOW2_OL_SNAPSHOT_TABLE_BITNR = 5,
552 QCOW2_OL_INACTIVE_L1_BITNR = 6,
553 QCOW2_OL_INACTIVE_L2_BITNR = 7,
554 QCOW2_OL_BITMAP_DIRECTORY_BITNR = 8,
555
556 QCOW2_OL_MAX_BITNR = 9,
557
558 QCOW2_OL_NONE = 0,
559 QCOW2_OL_MAIN_HEADER = (1 << QCOW2_OL_MAIN_HEADER_BITNR),
560 QCOW2_OL_ACTIVE_L1 = (1 << QCOW2_OL_ACTIVE_L1_BITNR),
561 QCOW2_OL_ACTIVE_L2 = (1 << QCOW2_OL_ACTIVE_L2_BITNR),
562 QCOW2_OL_REFCOUNT_TABLE = (1 << QCOW2_OL_REFCOUNT_TABLE_BITNR),
563 QCOW2_OL_REFCOUNT_BLOCK = (1 << QCOW2_OL_REFCOUNT_BLOCK_BITNR),
564 QCOW2_OL_SNAPSHOT_TABLE = (1 << QCOW2_OL_SNAPSHOT_TABLE_BITNR),
565 QCOW2_OL_INACTIVE_L1 = (1 << QCOW2_OL_INACTIVE_L1_BITNR),
a40f1c2a
HR
566 /* NOTE: Checking overlaps with inactive L2 tables will result in bdrv
567 * reads. */
0e4e4318
VSO
568 QCOW2_OL_INACTIVE_L2 = (1 << QCOW2_OL_INACTIVE_L2_BITNR),
569 QCOW2_OL_BITMAP_DIRECTORY = (1 << QCOW2_OL_BITMAP_DIRECTORY_BITNR),
a40f1c2a
HR
570} QCow2MetadataOverlap;
571
4a273c39
HR
572/* Perform all overlap checks which can be done in constant time */
573#define QCOW2_OL_CONSTANT \
574 (QCOW2_OL_MAIN_HEADER | QCOW2_OL_ACTIVE_L1 | QCOW2_OL_REFCOUNT_TABLE | \
0e4e4318 575 QCOW2_OL_SNAPSHOT_TABLE | QCOW2_OL_BITMAP_DIRECTORY)
4a273c39 576
a40f1c2a
HR
577/* Perform all overlap checks which don't require disk access */
578#define QCOW2_OL_CACHED \
4a273c39
HR
579 (QCOW2_OL_CONSTANT | QCOW2_OL_ACTIVE_L2 | QCOW2_OL_REFCOUNT_BLOCK | \
580 QCOW2_OL_INACTIVE_L1)
581
582/* Perform all overlap checks */
583#define QCOW2_OL_ALL \
584 (QCOW2_OL_CACHED | QCOW2_OL_INACTIVE_L2)
a40f1c2a 585
46bae927
HT
586#define L1E_OFFSET_MASK 0x00fffffffffffe00ULL
587#define L2E_OFFSET_MASK 0x00fffffffffffe00ULL
68d000a3
KW
588#define L2E_COMPRESSED_OFFSET_SIZE_MASK 0x3fffffffffffffffULL
589
46bae927 590#define REFT_OFFSET_MASK 0xfffffffffffffe00ULL
76dc9e0c 591
c6d619cc
KW
592#define INV_OFFSET (-1ULL)
593
a3c7d916
AG
594static inline bool has_subclusters(BDRVQcow2State *s)
595{
7be20252 596 return s->incompatible_features & QCOW2_INCOMPAT_EXTL2;
a3c7d916
AG
597}
598
c8fd8554
AG
599static inline size_t l2_entry_size(BDRVQcow2State *s)
600{
601 return has_subclusters(s) ? L2E_SIZE_EXTENDED : L2E_SIZE_NORMAL;
602}
603
12c6aebe
AG
604static inline uint64_t get_l2_entry(BDRVQcow2State *s, uint64_t *l2_slice,
605 int idx)
606{
39a9f0a5 607 idx *= l2_entry_size(s) / sizeof(uint64_t);
12c6aebe
AG
608 return be64_to_cpu(l2_slice[idx]);
609}
610
39a9f0a5
AG
611static inline uint64_t get_l2_bitmap(BDRVQcow2State *s, uint64_t *l2_slice,
612 int idx)
613{
614 if (has_subclusters(s)) {
615 idx *= l2_entry_size(s) / sizeof(uint64_t);
616 return be64_to_cpu(l2_slice[idx + 1]);
617 } else {
618 return 0; /* For convenience only; this value has no meaning. */
619 }
620}
621
12c6aebe
AG
622static inline void set_l2_entry(BDRVQcow2State *s, uint64_t *l2_slice,
623 int idx, uint64_t entry)
624{
39a9f0a5 625 idx *= l2_entry_size(s) / sizeof(uint64_t);
12c6aebe
AG
626 l2_slice[idx] = cpu_to_be64(entry);
627}
628
39a9f0a5
AG
629static inline void set_l2_bitmap(BDRVQcow2State *s, uint64_t *l2_slice,
630 int idx, uint64_t bitmap)
631{
632 assert(has_subclusters(s));
633 idx *= l2_entry_size(s) / sizeof(uint64_t);
634 l2_slice[idx + 1] = cpu_to_be64(bitmap);
635}
636
93c24936
KW
637static inline bool has_data_file(BlockDriverState *bs)
638{
639 BDRVQcow2State *s = bs->opaque;
640 return (s->data_file != bs->file);
641}
642
6c3944dc
KW
643static inline bool data_file_is_raw(BlockDriverState *bs)
644{
645 BDRVQcow2State *s = bs->opaque;
646 return !!(s->autoclear_features & QCOW2_AUTOCLEAR_DATA_FILE_RAW);
647}
648
ff99129a 649static inline int64_t start_of_cluster(BDRVQcow2State *s, int64_t offset)
3b8e2e26
KW
650{
651 return offset & ~(s->cluster_size - 1);
652}
653
ff99129a 654static inline int64_t offset_into_cluster(BDRVQcow2State *s, int64_t offset)
c37f4cd7
KW
655{
656 return offset & (s->cluster_size - 1);
657}
658
3e719815
AG
659static inline int64_t offset_into_subcluster(BDRVQcow2State *s, int64_t offset)
660{
661 return offset & (s->subcluster_size - 1);
662}
663
b6d36def 664static inline uint64_t size_to_clusters(BDRVQcow2State *s, uint64_t size)
f7d0fe02
KW
665{
666 return (size + (s->cluster_size - 1)) >> s->cluster_bits;
667}
668
3e719815
AG
669static inline uint64_t size_to_subclusters(BDRVQcow2State *s, uint64_t size)
670{
671 return (size + (s->subcluster_size - 1)) >> s->subcluster_bits;
672}
673
ff99129a 674static inline int64_t size_to_l1(BDRVQcow2State *s, int64_t size)
419b19d9
SH
675{
676 int shift = s->cluster_bits + s->l2_bits;
677 return (size + (1ULL << shift) - 1) >> shift;
678}
679
05b5b6ee
AG
680static inline int offset_to_l1_index(BDRVQcow2State *s, uint64_t offset)
681{
682 return offset >> (s->l2_bits + s->cluster_bits);
683}
684
ff99129a 685static inline int offset_to_l2_index(BDRVQcow2State *s, int64_t offset)
17a71e58
KW
686{
687 return (offset >> s->cluster_bits) & (s->l2_size - 1);
688}
689
8f818175
AG
690static inline int offset_to_l2_slice_index(BDRVQcow2State *s, int64_t offset)
691{
692 return (offset >> s->cluster_bits) & (s->l2_slice_size - 1);
693}
694
a53e8b72
AG
695static inline int offset_to_sc_index(BDRVQcow2State *s, int64_t offset)
696{
697 return (offset >> s->subcluster_bits) & (s->subclusters_per_cluster - 1);
698}
699
ff99129a 700static inline int64_t qcow2_vm_state_offset(BDRVQcow2State *s)
1ebf561c
KW
701{
702 return (int64_t)s->l1_vm_state_index << (s->cluster_bits + s->l2_bits);
703}
704
808c2bb4
KW
705static inline QCow2ClusterType qcow2_get_cluster_type(BlockDriverState *bs,
706 uint64_t l2_entry)
68d000a3 707{
34905d8e
AG
708 BDRVQcow2State *s = bs->opaque;
709
68d000a3
KW
710 if (l2_entry & QCOW_OFLAG_COMPRESSED) {
711 return QCOW2_CLUSTER_COMPRESSED;
34905d8e 712 } else if ((l2_entry & QCOW_OFLAG_ZERO) && !has_subclusters(s)) {
fdfab37d
EB
713 if (l2_entry & L2E_OFFSET_MASK) {
714 return QCOW2_CLUSTER_ZERO_ALLOC;
715 }
716 return QCOW2_CLUSTER_ZERO_PLAIN;
68d000a3 717 } else if (!(l2_entry & L2E_OFFSET_MASK)) {
a4ea184d
KW
718 /* Offset 0 generally means unallocated, but it is ambiguous with
719 * external data files because 0 is a valid offset there. However, all
720 * clusters in external data files always have refcount 1, so we can
721 * rely on QCOW_OFLAG_COPIED to disambiguate. */
722 if (has_data_file(bs) && (l2_entry & QCOW_OFLAG_COPIED)) {
723 return QCOW2_CLUSTER_NORMAL;
724 } else {
725 return QCOW2_CLUSTER_UNALLOCATED;
726 }
68d000a3
KW
727 } else {
728 return QCOW2_CLUSTER_NORMAL;
729 }
730}
731
34905d8e
AG
732/*
733 * In an image without subsclusters @l2_bitmap is ignored and
734 * @sc_index must be 0.
735 * Return QCOW2_SUBCLUSTER_INVALID if an invalid l2 entry is detected
736 * (this checks the whole entry and bitmap, not only the bits related
737 * to subcluster @sc_index).
738 */
739static inline
740QCow2SubclusterType qcow2_get_subcluster_type(BlockDriverState *bs,
741 uint64_t l2_entry,
742 uint64_t l2_bitmap,
743 unsigned sc_index)
744{
745 BDRVQcow2State *s = bs->opaque;
746 QCow2ClusterType type = qcow2_get_cluster_type(bs, l2_entry);
747 assert(sc_index < s->subclusters_per_cluster);
748
749 if (has_subclusters(s)) {
750 switch (type) {
751 case QCOW2_CLUSTER_COMPRESSED:
752 return QCOW2_SUBCLUSTER_COMPRESSED;
753 case QCOW2_CLUSTER_NORMAL:
754 if ((l2_bitmap >> 32) & l2_bitmap) {
755 return QCOW2_SUBCLUSTER_INVALID;
756 } else if (l2_bitmap & QCOW_OFLAG_SUB_ZERO(sc_index)) {
757 return QCOW2_SUBCLUSTER_ZERO_ALLOC;
758 } else if (l2_bitmap & QCOW_OFLAG_SUB_ALLOC(sc_index)) {
759 return QCOW2_SUBCLUSTER_NORMAL;
760 } else {
761 return QCOW2_SUBCLUSTER_UNALLOCATED_ALLOC;
762 }
763 case QCOW2_CLUSTER_UNALLOCATED:
764 if (l2_bitmap & QCOW_L2_BITMAP_ALL_ALLOC) {
765 return QCOW2_SUBCLUSTER_INVALID;
766 } else if (l2_bitmap & QCOW_OFLAG_SUB_ZERO(sc_index)) {
767 return QCOW2_SUBCLUSTER_ZERO_PLAIN;
768 } else {
769 return QCOW2_SUBCLUSTER_UNALLOCATED_PLAIN;
770 }
771 default:
772 g_assert_not_reached();
773 }
774 } else {
3f9c6b3b
AG
775 switch (type) {
776 case QCOW2_CLUSTER_COMPRESSED:
777 return QCOW2_SUBCLUSTER_COMPRESSED;
778 case QCOW2_CLUSTER_ZERO_PLAIN:
779 return QCOW2_SUBCLUSTER_ZERO_PLAIN;
780 case QCOW2_CLUSTER_ZERO_ALLOC:
781 return QCOW2_SUBCLUSTER_ZERO_ALLOC;
782 case QCOW2_CLUSTER_NORMAL:
783 return QCOW2_SUBCLUSTER_NORMAL;
784 case QCOW2_CLUSTER_UNALLOCATED:
785 return QCOW2_SUBCLUSTER_UNALLOCATED_PLAIN;
786 default:
787 g_assert_not_reached();
788 }
34905d8e
AG
789 }
790}
791
c94d0378
AG
792static inline bool qcow2_cluster_is_allocated(QCow2ClusterType type)
793{
794 return (type == QCOW2_CLUSTER_COMPRESSED || type == QCOW2_CLUSTER_NORMAL ||
795 type == QCOW2_CLUSTER_ZERO_ALLOC);
796}
797
bfe8043e 798/* Check whether refcounts are eager or lazy */
ff99129a 799static inline bool qcow2_need_accurate_refcounts(BDRVQcow2State *s)
bfe8043e
SH
800{
801 return !(s->incompatible_features & QCOW2_INCOMPAT_DIRTY);
802}
c142442b 803
65eb2e35
KW
804static inline uint64_t l2meta_cow_start(QCowL2Meta *m)
805{
806 return m->offset + m->cow_start.offset;
807}
808
809static inline uint64_t l2meta_cow_end(QCowL2Meta *m)
810{
85567393 811 return m->offset + m->cow_end.offset + m->cow_end.nb_bytes;
65eb2e35
KW
812}
813
0e06528e 814static inline uint64_t refcount_diff(uint64_t r1, uint64_t r2)
2aabe7c7
HR
815{
816 return r1 > r2 ? r1 - r2 : r2 - r1;
817}
818
46b732cd
PB
819static inline
820uint32_t offset_to_reftable_index(BDRVQcow2State *s, uint64_t offset)
821{
822 return offset >> (s->refcount_block_bits + s->cluster_bits);
823}
824
f7d0fe02 825/* qcow2.c functions */
12cc30a8
HR
826int64_t qcow2_refcount_metadata_size(int64_t clusters, size_t cluster_size,
827 int refcount_order, bool generous_increase,
828 uint64_t *refblock_count);
829
280d3735 830int qcow2_mark_dirty(BlockDriverState *bs);
69c98726
HR
831int qcow2_mark_corrupt(BlockDriverState *bs);
832int qcow2_mark_consistent(BlockDriverState *bs);
e24e49e6 833int qcow2_update_header(BlockDriverState *bs);
f7d0fe02 834
85186ebd
HR
835void qcow2_signal_corruption(BlockDriverState *bs, bool fatal, int64_t offset,
836 int64_t size, const char *message_format, ...)
837 GCC_FMT_ATTR(5, 6);
838
0cf0e598
AG
839int qcow2_validate_table(BlockDriverState *bs, uint64_t offset,
840 uint64_t entries, size_t entry_len,
841 int64_t max_size_bytes, const char *table_name,
842 Error **errp);
843
f7d0fe02 844/* qcow2-refcount.c functions */
ed6ccf0f
KW
845int qcow2_refcount_init(BlockDriverState *bs);
846void qcow2_refcount_close(BlockDriverState *bs);
f7d0fe02 847
7324c10f 848int qcow2_get_refcount(BlockDriverState *bs, int64_t cluster_index,
0e06528e 849 uint64_t *refcount);
44751917 850
32b6444d 851int qcow2_update_cluster_refcount(BlockDriverState *bs, int64_t cluster_index,
0e06528e 852 uint64_t addend, bool decrease,
2aabe7c7 853 enum qcow2_discard_type type);
32b6444d 854
772d1f97
HR
855int64_t qcow2_refcount_area(BlockDriverState *bs, uint64_t offset,
856 uint64_t additional_clusters, bool exact_size,
857 int new_refblock_index,
858 uint64_t new_refblock_offset);
859
bb572aef 860int64_t qcow2_alloc_clusters(BlockDriverState *bs, uint64_t size);
b6d36def
HR
861int64_t qcow2_alloc_clusters_at(BlockDriverState *bs, uint64_t offset,
862 int64_t nb_clusters);
ed6ccf0f
KW
863int64_t qcow2_alloc_bytes(BlockDriverState *bs, int size);
864void qcow2_free_clusters(BlockDriverState *bs,
6cfcb9b8
KW
865 int64_t offset, int64_t size,
866 enum qcow2_discard_type type);
3fec237f
AG
867void qcow2_free_any_cluster(BlockDriverState *bs, uint64_t l2_entry,
868 enum qcow2_discard_type type);
f7d0fe02 869
ed6ccf0f
KW
870int qcow2_update_snapshot_refcount(BlockDriverState *bs,
871 int64_t l1_table_offset, int l1_size, int addend);
f7d0fe02 872
8b220eb7
PB
873int coroutine_fn qcow2_flush_caches(BlockDriverState *bs);
874int coroutine_fn qcow2_write_caches(BlockDriverState *bs);
166acf54
KW
875int qcow2_check_refcounts(BlockDriverState *bs, BdrvCheckResult *res,
876 BdrvCheckMode fix);
f7d0fe02 877
0b919fae
KW
878void qcow2_process_discards(BlockDriverState *bs, int ret);
879
231bb267 880int qcow2_check_metadata_overlap(BlockDriverState *bs, int ign, int64_t offset,
a40f1c2a 881 int64_t size);
231bb267 882int qcow2_pre_write_overlap_check(BlockDriverState *bs, int ign, int64_t offset,
966b000f 883 int64_t size, bool data_file);
8a5bb1f1
VSO
884int qcow2_inc_refcounts_imrt(BlockDriverState *bs, BdrvCheckResult *res,
885 void **refcount_table,
886 int64_t *refcount_table_size,
887 int64_t offset, int64_t size);
a40f1c2a 888
791c9a00
HR
889int qcow2_change_refcount_order(BlockDriverState *bs, int refcount_order,
890 BlockDriverAmendStatusCB *status_cb,
891 void *cb_opaque, Error **errp);
46b732cd 892int qcow2_shrink_reftable(BlockDriverState *bs);
163bc39d 893int64_t qcow2_get_last_cluster(BlockDriverState *bs, int64_t size);
69f47505 894int qcow2_detect_metadata_preallocation(BlockDriverState *bs);
791c9a00 895
45aba42f 896/* qcow2-cluster.c functions */
2cf7cfa1
KW
897int qcow2_grow_l1_table(BlockDriverState *bs, uint64_t min_size,
898 bool exact_size);
46b732cd 899int qcow2_shrink_l1_table(BlockDriverState *bs, uint64_t max_size);
e23e400e 900int qcow2_write_l1_entry(BlockDriverState *bs, int l1_index);
ff99129a 901int qcow2_encrypt_sectors(BDRVQcow2State *s, int64_t sector_num,
446d306d 902 uint8_t *buf, int nb_sectors, bool enc, Error **errp);
45aba42f 903
388e5816 904int qcow2_get_host_offset(BlockDriverState *bs, uint64_t offset,
ca4a0bb8 905 unsigned int *bytes, uint64_t *host_offset,
10dabdc5 906 QCow2SubclusterType *subcluster_type);
bfd0989a
AG
907int qcow2_alloc_host_offset(BlockDriverState *bs, uint64_t offset,
908 unsigned int *bytes, uint64_t *host_offset,
909 QCowL2Meta **m);
77e023ff
KW
910int qcow2_alloc_compressed_cluster_offset(BlockDriverState *bs,
911 uint64_t offset,
912 int compressed_size,
913 uint64_t *host_offset);
45aba42f 914
148da7ea 915int qcow2_alloc_cluster_link_l2(BlockDriverState *bs, QCowL2Meta *m);
8b24cd14 916void qcow2_alloc_cluster_abort(BlockDriverState *bs, QCowL2Meta *m);
d2cb36af
EB
917int qcow2_cluster_discard(BlockDriverState *bs, uint64_t offset,
918 uint64_t bytes, enum qcow2_discard_type type,
919 bool full_discard);
a6841a2d
AG
920int qcow2_subcluster_zeroize(BlockDriverState *bs, uint64_t offset,
921 uint64_t bytes, int flags);
45aba42f 922
4057a2b2 923int qcow2_expand_zero_clusters(BlockDriverState *bs,
8b13976d
HR
924 BlockDriverAmendStatusCB *status_cb,
925 void *cb_opaque);
32b6444d 926
c142442b 927/* qcow2-snapshot.c functions */
ed6ccf0f
KW
928int qcow2_snapshot_create(BlockDriverState *bs, QEMUSnapshotInfo *sn_info);
929int qcow2_snapshot_goto(BlockDriverState *bs, const char *snapshot_id);
a89d89d3
WX
930int qcow2_snapshot_delete(BlockDriverState *bs,
931 const char *snapshot_id,
932 const char *name,
933 Error **errp);
ed6ccf0f 934int qcow2_snapshot_list(BlockDriverState *bs, QEMUSnapshotInfo **psn_tab);
7b4c4781
WX
935int qcow2_snapshot_load_tmp(BlockDriverState *bs,
936 const char *snapshot_id,
937 const char *name,
938 Error **errp);
c142442b 939
ed6ccf0f 940void qcow2_free_snapshots(BlockDriverState *bs);
ecf6c7c0 941int qcow2_read_snapshots(BlockDriverState *bs, Error **errp);
e0314b56 942int qcow2_write_snapshots(BlockDriverState *bs);
c142442b 943
8bc584fe
HR
944int coroutine_fn qcow2_check_read_snapshot_table(BlockDriverState *bs,
945 BdrvCheckResult *result,
946 BdrvCheckMode fix);
fe446b5d
HR
947int coroutine_fn qcow2_check_fix_snapshot_table(BlockDriverState *bs,
948 BdrvCheckResult *result,
949 BdrvCheckMode fix);
8bc584fe 950
49381094 951/* qcow2-cache.c functions */
1221fe6f
AG
952Qcow2Cache *qcow2_cache_create(BlockDriverState *bs, int num_tables,
953 unsigned table_size);
e64d4072 954int qcow2_cache_destroy(Qcow2Cache *c);
49381094 955
2d135ee9 956void qcow2_cache_entry_mark_dirty(Qcow2Cache *c, void *table);
49381094 957int qcow2_cache_flush(BlockDriverState *bs, Qcow2Cache *c);
f3c3b87d 958int qcow2_cache_write(BlockDriverState *bs, Qcow2Cache *c);
49381094
KW
959int qcow2_cache_set_dependency(BlockDriverState *bs, Qcow2Cache *c,
960 Qcow2Cache *dependency);
3de0a294 961void qcow2_cache_depends_on_flush(Qcow2Cache *c);
49381094 962
b2f68bff 963void qcow2_cache_clean_unused(Qcow2Cache *c);
e7108fea
HR
964int qcow2_cache_empty(BlockDriverState *bs, Qcow2Cache *c);
965
49381094
KW
966int qcow2_cache_get(BlockDriverState *bs, Qcow2Cache *c, uint64_t offset,
967 void **table);
968int qcow2_cache_get_empty(BlockDriverState *bs, Qcow2Cache *c, uint64_t offset,
969 void **table);
2013c3d4 970void qcow2_cache_put(Qcow2Cache *c, void **table);
6e6fa760 971void *qcow2_cache_is_table_offset(Qcow2Cache *c, uint64_t offset);
77aadd7b 972void qcow2_cache_discard(Qcow2Cache *c, void *table);
49381094 973
88ddffae
VSO
974/* qcow2-bitmap.c functions */
975int qcow2_check_bitmaps_refcounts(BlockDriverState *bs, BdrvCheckResult *res,
976 void **refcount_table,
977 int64_t *refcount_table_size);
3e99da5e 978bool qcow2_load_dirty_bitmaps(BlockDriverState *bs, Error **errp);
b8968c87
AS
979Qcow2BitmapInfoList *qcow2_get_bitmap_info_list(BlockDriverState *bs,
980 Error **errp);
1b6b0562 981int qcow2_reopen_bitmaps_rw(BlockDriverState *bs, Error **errp);
d19c6b36 982int qcow2_truncate_bitmaps_check(BlockDriverState *bs, Error **errp);
644ddbb7
VSO
983void qcow2_store_persistent_dirty_bitmaps(BlockDriverState *bs,
984 bool release_stored, Error **errp);
169b8793 985int qcow2_reopen_bitmaps_ro(BlockDriverState *bs, Error **errp);
d2c3080e
VSO
986bool qcow2_co_can_store_new_dirty_bitmap(BlockDriverState *bs,
987 const char *name,
988 uint32_t granularity,
b56a1e31 989 Error **errp);
d2c3080e
VSO
990int qcow2_co_remove_persistent_dirty_bitmap(BlockDriverState *bs,
991 const char *name,
992 Error **errp);
ef893b5c 993bool qcow2_supports_persistent_dirty_bitmap(BlockDriverState *bs);
5d72c68b
EB
994uint64_t qcow2_get_persistent_dirty_bitmap_size(BlockDriverState *bs,
995 uint32_t cluster_size);
d1258dd0 996
56e2f1d8
VSO
997ssize_t coroutine_fn
998qcow2_co_compress(BlockDriverState *bs, void *dest, size_t dest_size,
999 const void *src, size_t src_size);
1000ssize_t coroutine_fn
1001qcow2_co_decompress(BlockDriverState *bs, void *dest, size_t dest_size,
1002 const void *src, size_t src_size);
8ac0f15f 1003int coroutine_fn
603fbd07
ML
1004qcow2_co_encrypt(BlockDriverState *bs, uint64_t host_offset,
1005 uint64_t guest_offset, void *buf, size_t len);
8ac0f15f 1006int coroutine_fn
603fbd07
ML
1007qcow2_co_decrypt(BlockDriverState *bs, uint64_t host_offset,
1008 uint64_t guest_offset, void *buf, size_t len);
56e2f1d8 1009
f7d0fe02 1010#endif
This page took 0.812726 seconds and 4 git commands to generate.