Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 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 | |
Daniel P. Berrange | b25b387 | 2017-06-23 17:24:10 +0100 | [diff] [blame] | 28 | #include "crypto/block.h" |
Daniel P. Berrange | 10817bf | 2015-09-01 14:48:02 +0100 | [diff] [blame] | 29 | #include "qemu/coroutine.h" |
Leonid Bloch | b6a95c6 | 2018-09-26 19:04:41 +0300 | [diff] [blame] | 30 | #include "qemu/units.h" |
Vladimir Sementsov-Ogievskiy | 9353db4 | 2019-05-06 17:27:34 +0300 | [diff] [blame] | 31 | #include "block/block_int.h" |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 32 | |
Filip Navara | 14899cd | 2009-06-23 19:17:30 -0500 | [diff] [blame] | 33 | //#define DEBUG_ALLOC |
| 34 | //#define DEBUG_ALLOC2 |
| 35 | //#define DEBUG_EXT |
| 36 | |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 37 | #define QCOW_MAGIC (('Q' << 24) | ('F' << 16) | ('I' << 8) | 0xfb) |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 38 | |
| 39 | #define QCOW_CRYPT_NONE 0 |
| 40 | #define QCOW_CRYPT_AES 1 |
Daniel P. Berrange | 4652b8f | 2017-06-23 17:24:12 +0100 | [diff] [blame] | 41 | #define QCOW_CRYPT_LUKS 2 |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 42 | |
| 43 | #define QCOW_MAX_CRYPT_CLUSTERS 32 |
Kevin Wolf | ce48f2f4 | 2014-03-26 13:05:45 +0100 | [diff] [blame] | 44 | #define QCOW_MAX_SNAPSHOTS 65536 |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 45 | |
Eric Blake | 77d6a21 | 2018-11-13 17:03:18 -0600 | [diff] [blame] | 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 | |
Kevin Wolf | 2b5d595 | 2014-03-26 13:05:50 +0100 | [diff] [blame] | 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) */ |
Markus Armbruster | 1463212 | 2019-01-11 20:14:01 +0100 | [diff] [blame] | 54 | #define QCOW_MAX_REFTABLE_SIZE (8 * MiB) |
Kevin Wolf | 2b5d595 | 2014-03-26 13:05:50 +0100 | [diff] [blame] | 55 | |
Kevin Wolf | 6a83f8b | 2014-03-26 13:06:06 +0100 | [diff] [blame] | 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) */ |
Markus Armbruster | 1463212 | 2019-01-11 20:14:01 +0100 | [diff] [blame] | 58 | #define QCOW_MAX_L1_SIZE (32 * MiB) |
Kevin Wolf | 6a83f8b | 2014-03-26 13:06:06 +0100 | [diff] [blame] | 59 | |
Kevin Wolf | 5dae6e3 | 2014-03-26 13:06:07 +0100 | [diff] [blame] | 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 | |
Max Reitz | fcf9a6b | 2019-10-11 17:28:02 +0200 | [diff] [blame] | 64 | /* Maximum amount of extra data per snapshot table entry to accept */ |
| 65 | #define QCOW_MAX_SNAPSHOT_EXTRA_DATA 1024 |
| 66 | |
Vladimir Sementsov-Ogievskiy | 88ddffa | 2017-06-28 15:05:08 +0300 | [diff] [blame] | 67 | /* Bitmap header extension constraints */ |
| 68 | #define QCOW2_MAX_BITMAPS 65535 |
| 69 | #define QCOW2_MAX_BITMAP_DIRECTORY_SIZE (1024 * QCOW2_MAX_BITMAPS) |
| 70 | |
Vladimir Sementsov-Ogievskiy | d710cf5 | 2019-09-16 20:53:24 +0300 | [diff] [blame] | 71 | /* Maximum of parallel sub-request per guest request */ |
| 72 | #define QCOW2_MAX_WORKERS 8 |
| 73 | |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 74 | /* indicate that the refcount of the referenced cluster is exactly one. */ |
Peter Maydell | 127c84e | 2013-08-23 17:35:45 +0100 | [diff] [blame] | 75 | #define QCOW_OFLAG_COPIED (1ULL << 63) |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 76 | /* indicate that the cluster is compressed (they never have the copied flag) */ |
Peter Maydell | 127c84e | 2013-08-23 17:35:45 +0100 | [diff] [blame] | 77 | #define QCOW_OFLAG_COMPRESSED (1ULL << 62) |
Kevin Wolf | 6377af4 | 2012-03-16 15:02:38 +0100 | [diff] [blame] | 78 | /* The cluster reads as all zeros */ |
Peter Maydell | 127c84e | 2013-08-23 17:35:45 +0100 | [diff] [blame] | 79 | #define QCOW_OFLAG_ZERO (1ULL << 0) |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 80 | |
Alberto Garcia | d0346b5 | 2020-07-10 18:12:51 +0200 | [diff] [blame] | 81 | #define QCOW_EXTL2_SUBCLUSTERS_PER_CLUSTER 32 |
| 82 | |
Alberto Garcia | 34905d8 | 2020-07-10 18:12:56 +0200 | [diff] [blame] | 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 | |
Alberto Garcia | c8fd855 | 2020-07-10 18:12:54 +0200 | [diff] [blame] | 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 | |
Alberto Garcia | 02b1ecf | 2020-08-28 13:08:28 +0200 | [diff] [blame] | 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 | |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 108 | #define MIN_CLUSTER_BITS 9 |
Kevin Wolf | 80ee15a | 2009-09-15 12:30:43 +0200 | [diff] [blame] | 109 | #define MAX_CLUSTER_BITS 21 |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 110 | |
Alberto Garcia | b6c2469 | 2019-05-10 19:22:54 +0300 | [diff] [blame] | 111 | /* Defined in the qcow2 spec (compressed cluster descriptor) */ |
| 112 | #define QCOW2_COMPRESSED_SECTOR_SIZE 512U |
Max Reitz | 24552fe | 2019-10-28 17:18:40 +0100 | [diff] [blame] | 113 | #define QCOW2_COMPRESSED_SECTOR_MASK (~(QCOW2_COMPRESSED_SECTOR_SIZE - 1ULL)) |
Alberto Garcia | b6c2469 | 2019-05-10 19:22:54 +0300 | [diff] [blame] | 114 | |
Max Reitz | 57e2166 | 2015-06-01 18:09:17 +0200 | [diff] [blame] | 115 | /* Must be at least 2 to cover COW */ |
Alberto Garcia | 1221fe6 | 2018-02-05 16:33:36 +0200 | [diff] [blame] | 116 | #define MIN_L2_CACHE_SIZE 2 /* cache entries */ |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 117 | |
Kevin Wolf | 29c1a73 | 2011-01-10 17:17:28 +0100 | [diff] [blame] | 118 | /* Must be at least 4 to cover all cases of refcount table growth */ |
Max Reitz | 440ba08 | 2014-08-18 22:07:31 +0200 | [diff] [blame] | 119 | #define MIN_REFCOUNT_CACHE_SIZE 4 /* clusters */ |
| 120 | |
Leonid Bloch | 80668d0 | 2018-09-26 19:04:44 +0300 | [diff] [blame] | 121 | #ifdef CONFIG_LINUX |
Markus Armbruster | 1463212 | 2019-01-11 20:14:01 +0100 | [diff] [blame] | 122 | #define DEFAULT_L2_CACHE_MAX_SIZE (32 * MiB) |
Leonid Bloch | e957b50 | 2018-09-26 19:04:46 +0300 | [diff] [blame] | 123 | #define DEFAULT_CACHE_CLEAN_INTERVAL 600 /* seconds */ |
Leonid Bloch | 80668d0 | 2018-09-26 19:04:44 +0300 | [diff] [blame] | 124 | #else |
Markus Armbruster | 1463212 | 2019-01-11 20:14:01 +0100 | [diff] [blame] | 125 | #define DEFAULT_L2_CACHE_MAX_SIZE (8 * MiB) |
Leonid Bloch | e957b50 | 2018-09-26 19:04:46 +0300 | [diff] [blame] | 126 | /* Cache clean interval is currently available only on Linux, so must be 0 */ |
| 127 | #define DEFAULT_CACHE_CLEAN_INTERVAL 0 |
Leonid Bloch | 80668d0 | 2018-09-26 19:04:44 +0300 | [diff] [blame] | 128 | #endif |
Max Reitz | 440ba08 | 2014-08-18 22:07:31 +0200 | [diff] [blame] | 129 | |
Markus Armbruster | 1463212 | 2019-01-11 20:14:01 +0100 | [diff] [blame] | 130 | #define DEFAULT_CLUSTER_SIZE 65536 |
Kevin Wolf | 99cce9f | 2011-05-31 15:01:46 +0200 | [diff] [blame] | 131 | |
Kevin Wolf | 0e8c08b | 2019-01-29 17:13:57 +0100 | [diff] [blame] | 132 | #define QCOW2_OPT_DATA_FILE "data-file" |
Kevin Wolf | 64aa99d | 2013-07-17 14:45:34 +0200 | [diff] [blame] | 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" |
Max Reitz | 05de7e8 | 2013-10-10 11:09:25 +0200 | [diff] [blame] | 137 | #define QCOW2_OPT_OVERLAP "overlap-check" |
Max Reitz | ee42b5c | 2014-08-20 19:59:35 +0200 | [diff] [blame] | 138 | #define QCOW2_OPT_OVERLAP_TEMPLATE "overlap-check.template" |
Max Reitz | 05de7e8 | 2013-10-10 11:09:25 +0200 | [diff] [blame] | 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" |
Vladimir Sementsov-Ogievskiy | 0e4e431 | 2018-07-05 18:15:15 +0300 | [diff] [blame] | 147 | #define QCOW2_OPT_OVERLAP_BITMAP_DIRECTORY "overlap-check.bitmap-directory" |
Max Reitz | 6c1c8d5 | 2014-08-18 22:07:33 +0200 | [diff] [blame] | 148 | #define QCOW2_OPT_CACHE_SIZE "cache-size" |
| 149 | #define QCOW2_OPT_L2_CACHE_SIZE "l2-cache-size" |
Alberto Garcia | 1221fe6 | 2018-02-05 16:33:36 +0200 | [diff] [blame] | 150 | #define QCOW2_OPT_L2_CACHE_ENTRY_SIZE "l2-cache-entry-size" |
Max Reitz | 6c1c8d5 | 2014-08-18 22:07:33 +0200 | [diff] [blame] | 151 | #define QCOW2_OPT_REFCOUNT_CACHE_SIZE "refcount-cache-size" |
Alberto Garcia | 279621c | 2015-08-04 15:14:40 +0300 | [diff] [blame] | 152 | #define QCOW2_OPT_CACHE_CLEAN_INTERVAL "cache-clean-interval" |
Kevin Wolf | acdfb48 | 2013-03-18 13:08:10 +0100 | [diff] [blame] | 153 | |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 154 | typedef 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; |
Kevin Wolf | 6744cba | 2011-12-15 12:20:58 +0100 | [diff] [blame] | 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; |
Denis Plotnikov | 572ad97 | 2020-05-07 11:25:18 +0300 | [diff] [blame] | 176 | |
| 177 | /* Additional fields */ |
| 178 | uint8_t compression_type; |
| 179 | |
| 180 | /* header must be a multiple of 8 */ |
| 181 | uint8_t padding[7]; |
Jeff Cody | c4217f6 | 2013-09-25 12:08:50 -0400 | [diff] [blame] | 182 | } QEMU_PACKED QCowHeader; |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 183 | |
Denis Plotnikov | 572ad97 | 2020-05-07 11:25:18 +0300 | [diff] [blame] | 184 | QEMU_BUILD_BUG_ON(!QEMU_IS_ALIGNED(sizeof(QCowHeader), 8)); |
| 185 | |
Kevin Wolf | ce48f2f4 | 2014-03-26 13:05:45 +0100 | [diff] [blame] | 186 | typedef 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 | |
| 206 | typedef struct QEMU_PACKED QCowSnapshotExtraData { |
| 207 | uint64_t vm_state_size_large; |
| 208 | uint64_t disk_size; |
Pavel Dovgalyuk | bbacffc | 2020-10-03 20:13:02 +0300 | [diff] [blame] | 209 | uint64_t icount; |
Kevin Wolf | ce48f2f4 | 2014-03-26 13:05:45 +0100 | [diff] [blame] | 210 | } QCowSnapshotExtraData; |
| 211 | |
| 212 | |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 213 | typedef struct QCowSnapshot { |
| 214 | uint64_t l1_table_offset; |
| 215 | uint32_t l1_size; |
| 216 | char *id_str; |
| 217 | char *name; |
Kevin Wolf | 90b2775 | 2012-04-11 16:33:50 +0200 | [diff] [blame] | 218 | uint64_t disk_size; |
Kevin Wolf | c2c9a46 | 2011-11-16 11:35:54 +0100 | [diff] [blame] | 219 | uint64_t vm_state_size; |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 220 | uint32_t date_sec; |
| 221 | uint32_t date_nsec; |
| 222 | uint64_t vm_clock_nsec; |
Pavel Dovgalyuk | bbacffc | 2020-10-03 20:13:02 +0300 | [diff] [blame] | 223 | /* icount value for the moment when snapshot was taken */ |
| 224 | uint64_t icount; |
Max Reitz | fcf9a6b | 2019-10-11 17:28:02 +0200 | [diff] [blame] | 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; |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 229 | } QCowSnapshot; |
| 230 | |
Kevin Wolf | 4938109 | 2011-01-10 17:15:10 +0100 | [diff] [blame] | 231 | struct Qcow2Cache; |
| 232 | typedef struct Qcow2Cache Qcow2Cache; |
| 233 | |
Daniel P. Berrange | 4652b8f | 2017-06-23 17:24:12 +0100 | [diff] [blame] | 234 | typedef struct Qcow2CryptoHeaderExtension { |
| 235 | uint64_t offset; |
| 236 | uint64_t length; |
| 237 | } QEMU_PACKED Qcow2CryptoHeaderExtension; |
| 238 | |
Kevin Wolf | 75bab85 | 2012-02-02 14:52:08 +0100 | [diff] [blame] | 239 | typedef struct Qcow2UnknownHeaderExtension { |
| 240 | uint32_t magic; |
| 241 | uint32_t len; |
| 242 | QLIST_ENTRY(Qcow2UnknownHeaderExtension) next; |
| 243 | uint8_t data[]; |
| 244 | } Qcow2UnknownHeaderExtension; |
| 245 | |
Kevin Wolf | cfcc4c6 | 2012-04-12 15:20:27 +0200 | [diff] [blame] | 246 | enum { |
| 247 | QCOW2_FEAT_TYPE_INCOMPATIBLE = 0, |
| 248 | QCOW2_FEAT_TYPE_COMPATIBLE = 1, |
| 249 | QCOW2_FEAT_TYPE_AUTOCLEAR = 2, |
| 250 | }; |
| 251 | |
Stefan Hajnoczi | c61d000 | 2012-07-27 09:05:19 +0100 | [diff] [blame] | 252 | /* Incompatible feature bits */ |
| 253 | enum { |
Kevin Wolf | 93c2493 | 2019-01-14 16:48:25 +0100 | [diff] [blame] | 254 | QCOW2_INCOMPAT_DIRTY_BITNR = 0, |
| 255 | QCOW2_INCOMPAT_CORRUPT_BITNR = 1, |
| 256 | QCOW2_INCOMPAT_DATA_FILE_BITNR = 2, |
Denis Plotnikov | 572ad97 | 2020-05-07 11:25:18 +0300 | [diff] [blame] | 257 | QCOW2_INCOMPAT_COMPRESSION_BITNR = 3, |
Alberto Garcia | 7be2025 | 2020-07-10 18:13:13 +0200 | [diff] [blame] | 258 | QCOW2_INCOMPAT_EXTL2_BITNR = 4, |
Kevin Wolf | 93c2493 | 2019-01-14 16:48:25 +0100 | [diff] [blame] | 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, |
Denis Plotnikov | 572ad97 | 2020-05-07 11:25:18 +0300 | [diff] [blame] | 262 | QCOW2_INCOMPAT_COMPRESSION = 1 << QCOW2_INCOMPAT_COMPRESSION_BITNR, |
Alberto Garcia | 7be2025 | 2020-07-10 18:13:13 +0200 | [diff] [blame] | 263 | QCOW2_INCOMPAT_EXTL2 = 1 << QCOW2_INCOMPAT_EXTL2_BITNR, |
Stefan Hajnoczi | c61d000 | 2012-07-27 09:05:19 +0100 | [diff] [blame] | 264 | |
Kevin Wolf | 93c2493 | 2019-01-14 16:48:25 +0100 | [diff] [blame] | 265 | QCOW2_INCOMPAT_MASK = QCOW2_INCOMPAT_DIRTY |
Kevin Wolf | 0e8c08b | 2019-01-29 17:13:57 +0100 | [diff] [blame] | 266 | | QCOW2_INCOMPAT_CORRUPT |
Denis Plotnikov | 572ad97 | 2020-05-07 11:25:18 +0300 | [diff] [blame] | 267 | | QCOW2_INCOMPAT_DATA_FILE |
Alberto Garcia | 7be2025 | 2020-07-10 18:13:13 +0200 | [diff] [blame] | 268 | | QCOW2_INCOMPAT_COMPRESSION |
| 269 | | QCOW2_INCOMPAT_EXTL2, |
Stefan Hajnoczi | c61d000 | 2012-07-27 09:05:19 +0100 | [diff] [blame] | 270 | }; |
| 271 | |
Stefan Hajnoczi | bfe8043 | 2012-07-27 09:05:22 +0100 | [diff] [blame] | 272 | /* Compatible feature bits */ |
| 273 | enum { |
| 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 | |
Vladimir Sementsov-Ogievskiy | 88ddffa | 2017-06-28 15:05:08 +0300 | [diff] [blame] | 280 | /* Autoclear feature bits */ |
| 281 | enum { |
Kevin Wolf | 93c2493 | 2019-01-14 16:48:25 +0100 | [diff] [blame] | 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, |
Vladimir Sementsov-Ogievskiy | 88ddffa | 2017-06-28 15:05:08 +0300 | [diff] [blame] | 286 | |
Kevin Wolf | 6c3944d | 2019-02-22 14:29:38 +0100 | [diff] [blame] | 287 | QCOW2_AUTOCLEAR_MASK = QCOW2_AUTOCLEAR_BITMAPS |
| 288 | | QCOW2_AUTOCLEAR_DATA_FILE_RAW, |
Vladimir Sementsov-Ogievskiy | 88ddffa | 2017-06-28 15:05:08 +0300 | [diff] [blame] | 289 | }; |
| 290 | |
Kevin Wolf | 6cfcb9b | 2013-06-19 13:44:18 +0200 | [diff] [blame] | 291 | enum 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 | |
Kevin Wolf | cfcc4c6 | 2012-04-12 15:20:27 +0200 | [diff] [blame] | 300 | typedef struct Qcow2Feature { |
| 301 | uint8_t type; |
| 302 | uint8_t bit; |
| 303 | char name[46]; |
| 304 | } QEMU_PACKED Qcow2Feature; |
| 305 | |
Kevin Wolf | 0b919fa | 2013-06-19 13:44:20 +0200 | [diff] [blame] | 306 | typedef struct Qcow2DiscardRegion { |
| 307 | BlockDriverState *bs; |
| 308 | uint64_t offset; |
| 309 | uint64_t bytes; |
| 310 | QTAILQ_ENTRY(Qcow2DiscardRegion) next; |
| 311 | } Qcow2DiscardRegion; |
| 312 | |
Max Reitz | 7453c96 | 2015-02-10 15:28:50 -0500 | [diff] [blame] | 313 | typedef uint64_t Qcow2GetRefcountFunc(const void *refcount_array, |
| 314 | uint64_t index); |
| 315 | typedef void Qcow2SetRefcountFunc(void *refcount_array, |
| 316 | uint64_t index, uint64_t value); |
| 317 | |
Vladimir Sementsov-Ogievskiy | 88ddffa | 2017-06-28 15:05:08 +0300 | [diff] [blame] | 318 | typedef 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 | |
Vladimir Sementsov-Ogievskiy | 8ac0f15 | 2019-05-06 17:27:41 +0300 | [diff] [blame] | 325 | #define QCOW2_MAX_THREADS 4 |
| 326 | |
Kevin Wolf | ff99129 | 2015-09-07 17:12:56 +0200 | [diff] [blame] | 327 | typedef struct BDRVQcow2State { |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 328 | int cluster_bits; |
| 329 | int cluster_size; |
Alberto Garcia | 3c2e511 | 2018-02-05 16:33:13 +0200 | [diff] [blame] | 330 | int l2_slice_size; |
Alberto Garcia | d0346b5 | 2020-07-10 18:12:51 +0200 | [diff] [blame] | 331 | int subcluster_bits; |
| 332 | int subcluster_size; |
| 333 | int subclusters_per_cluster; |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 334 | int l2_bits; |
| 335 | int l2_size; |
| 336 | int l1_size; |
| 337 | int l1_vm_state_index; |
Max Reitz | 1d13d65 | 2014-10-22 14:09:28 +0200 | [diff] [blame] | 338 | int refcount_block_bits; |
| 339 | int refcount_block_size; |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 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; |
Kevin Wolf | 29c1a73 | 2011-01-10 17:17:28 +0100 | [diff] [blame] | 345 | |
| 346 | Qcow2Cache* l2_table_cache; |
| 347 | Qcow2Cache* refcount_block_cache; |
Alberto Garcia | 279621c | 2015-08-04 15:14:40 +0300 | [diff] [blame] | 348 | QEMUTimer *cache_clean_timer; |
| 349 | unsigned cache_clean_interval; |
Kevin Wolf | 29c1a73 | 2011-01-10 17:17:28 +0100 | [diff] [blame] | 350 | |
Paolo Bonzini | b58deb3 | 2018-12-06 11:58:10 +0100 | [diff] [blame] | 351 | QLIST_HEAD(, QCowL2Meta) cluster_allocs; |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 352 | |
| 353 | uint64_t *refcount_table; |
| 354 | uint64_t refcount_table_offset; |
| 355 | uint32_t refcount_table_size; |
Alberto Garcia | 7061a07 | 2017-02-01 14:38:28 +0200 | [diff] [blame] | 356 | uint32_t max_refcount_table_index; /* Last used entry in refcount_table */ |
Kevin Wolf | bb572ae | 2014-03-26 13:05:51 +0100 | [diff] [blame] | 357 | uint64_t free_cluster_index; |
| 358 | uint64_t free_byte_offset; |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 359 | |
Kevin Wolf | 68d100e | 2011-06-30 17:42:09 +0200 | [diff] [blame] | 360 | CoMutex lock; |
| 361 | |
Daniel P. Berrange | 4652b8f | 2017-06-23 17:24:12 +0100 | [diff] [blame] | 362 | Qcow2CryptoHeaderExtension crypto_header; /* QCow2 header extension */ |
Daniel P. Berrange | b25b387 | 2017-06-23 17:24:10 +0100 | [diff] [blame] | 363 | QCryptoBlockOpenOptions *crypto_opts; /* Disk encryption runtime options */ |
| 364 | QCryptoBlock *crypto; /* Disk encryption format driver */ |
Daniel P. Berrange | 4652b8f | 2017-06-23 17:24:12 +0100 | [diff] [blame] | 365 | bool crypt_physical_offset; /* Whether to use virtual or physical offset |
| 366 | for encryption initialization vector tweak */ |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 367 | uint32_t crypt_method_header; |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 368 | uint64_t snapshots_offset; |
| 369 | int snapshots_size; |
Kevin Wolf | ce48f2f4 | 2014-03-26 13:05:45 +0100 | [diff] [blame] | 370 | unsigned int nb_snapshots; |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 371 | QCowSnapshot *snapshots; |
Anthony Liguori | 06d9260 | 2011-11-14 15:09:46 -0600 | [diff] [blame] | 372 | |
Vladimir Sementsov-Ogievskiy | 88ddffa | 2017-06-28 15:05:08 +0300 | [diff] [blame] | 373 | uint32_t nb_bitmaps; |
| 374 | uint64_t bitmap_directory_size; |
| 375 | uint64_t bitmap_directory_offset; |
| 376 | |
Anthony Liguori | 06d9260 | 2011-11-14 15:09:46 -0600 | [diff] [blame] | 377 | int flags; |
Kevin Wolf | 6744cba | 2011-12-15 12:20:58 +0100 | [diff] [blame] | 378 | int qcow_version; |
Kevin Wolf | 74c4510 | 2013-03-15 10:35:08 +0100 | [diff] [blame] | 379 | bool use_lazy_refcounts; |
Max Reitz | b6481f3 | 2013-09-03 10:09:53 +0200 | [diff] [blame] | 380 | int refcount_order; |
Max Reitz | 346a53d | 2015-02-10 15:28:43 -0500 | [diff] [blame] | 381 | int refcount_bits; |
| 382 | uint64_t refcount_max; |
Kevin Wolf | 6744cba | 2011-12-15 12:20:58 +0100 | [diff] [blame] | 383 | |
Max Reitz | 7453c96 | 2015-02-10 15:28:50 -0500 | [diff] [blame] | 384 | Qcow2GetRefcountFunc *get_refcount; |
| 385 | Qcow2SetRefcountFunc *set_refcount; |
| 386 | |
Kevin Wolf | 67af674 | 2013-06-19 13:44:19 +0200 | [diff] [blame] | 387 | bool discard_passthrough[QCOW2_DISCARD_MAX]; |
| 388 | |
Max Reitz | 3e35539 | 2013-10-10 11:09:24 +0200 | [diff] [blame] | 389 | int overlap_check; /* bitmask of Qcow2MetadataOverlap values */ |
Max Reitz | 85186eb | 2014-09-05 16:07:16 +0200 | [diff] [blame] | 390 | bool signaled_corruption; |
Max Reitz | 3e35539 | 2013-10-10 11:09:24 +0200 | [diff] [blame] | 391 | |
Kevin Wolf | 6744cba | 2011-12-15 12:20:58 +0100 | [diff] [blame] | 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; |
Kevin Wolf | 75bab85 | 2012-02-02 14:52:08 +0100 | [diff] [blame] | 398 | QLIST_HEAD(, Qcow2UnknownHeaderExtension) unknown_header_ext; |
Kevin Wolf | 0b919fa | 2013-06-19 13:44:20 +0200 | [diff] [blame] | 399 | QTAILQ_HEAD (, Qcow2DiscardRegion) discards; |
| 400 | bool cache_discards; |
Kevin Wolf | e4603fe | 2015-04-07 15:03:16 +0200 | [diff] [blame] | 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; |
Kevin Wolf | 9b890bd | 2019-01-15 19:02:40 +0100 | [diff] [blame] | 407 | char *image_data_file; |
Vladimir Sementsov-Ogievskiy | ceb029c | 2018-06-20 17:48:37 +0300 | [diff] [blame] | 408 | |
Vladimir Sementsov-Ogievskiy | 6f13a31 | 2019-05-06 17:27:38 +0300 | [diff] [blame] | 409 | CoQueue thread_task_queue; |
| 410 | int nb_threads; |
Kevin Wolf | 93c2493 | 2019-01-14 16:48:25 +0100 | [diff] [blame] | 411 | |
| 412 | BdrvChild *data_file; |
Vladimir Sementsov-Ogievskiy | 69f4750 | 2019-04-08 19:26:17 +0300 | [diff] [blame] | 413 | |
| 414 | bool metadata_preallocation_checked; |
| 415 | bool metadata_preallocation; |
Denis Plotnikov | 572ad97 | 2020-05-07 11:25:18 +0300 | [diff] [blame] | 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; |
Kevin Wolf | ff99129 | 2015-09-07 17:12:56 +0200 | [diff] [blame] | 423 | } BDRVQcow2State; |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 424 | |
Kevin Wolf | 593fb83 | 2012-12-07 18:08:43 +0100 | [diff] [blame] | 425 | typedef struct Qcow2COWRegion { |
| 426 | /** |
| 427 | * Offset of the COW region in bytes from the start of the first cluster |
| 428 | * touched by the request. |
| 429 | */ |
Alberto Garcia | e034f5b | 2017-06-19 16:40:03 +0300 | [diff] [blame] | 430 | unsigned offset; |
Kevin Wolf | 593fb83 | 2012-12-07 18:08:43 +0100 | [diff] [blame] | 431 | |
Kevin Wolf | 8556739 | 2016-06-01 14:08:56 +0200 | [diff] [blame] | 432 | /** Number of bytes to copy */ |
Alberto Garcia | e034f5b | 2017-06-19 16:40:03 +0300 | [diff] [blame] | 433 | unsigned nb_bytes; |
Kevin Wolf | 593fb83 | 2012-12-07 18:08:43 +0100 | [diff] [blame] | 434 | } Qcow2COWRegion; |
| 435 | |
Kevin Wolf | f50f88b | 2012-12-07 18:08:46 +0100 | [diff] [blame] | 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 | */ |
Kevin Wolf | 45aba42 | 2009-05-28 16:07:05 +0200 | [diff] [blame] | 440 | typedef struct QCowL2Meta |
| 441 | { |
Kevin Wolf | 1d3afd6 | 2012-12-07 18:08:42 +0100 | [diff] [blame] | 442 | /** Guest offset of the first newly allocated cluster */ |
Kevin Wolf | 45aba42 | 2009-05-28 16:07:05 +0200 | [diff] [blame] | 443 | uint64_t offset; |
Kevin Wolf | 1d3afd6 | 2012-12-07 18:08:42 +0100 | [diff] [blame] | 444 | |
Kevin Wolf | 1d3afd6 | 2012-12-07 18:08:42 +0100 | [diff] [blame] | 445 | /** Host offset of the first newly allocated cluster */ |
Kevin Wolf | 250196f | 2012-03-02 14:10:54 +0100 | [diff] [blame] | 446 | uint64_t alloc_offset; |
Kevin Wolf | 1d3afd6 | 2012-12-07 18:08:42 +0100 | [diff] [blame] | 447 | |
Kevin Wolf | 1d3afd6 | 2012-12-07 18:08:42 +0100 | [diff] [blame] | 448 | /** Number of newly allocated clusters */ |
Kevin Wolf | 45aba42 | 2009-05-28 16:07:05 +0200 | [diff] [blame] | 449 | int nb_clusters; |
Kevin Wolf | 1d3afd6 | 2012-12-07 18:08:42 +0100 | [diff] [blame] | 450 | |
Max Reitz | 564a6b6 | 2017-05-04 01:11:18 +0200 | [diff] [blame] | 451 | /** Do not free the old clusters */ |
| 452 | bool keep_old_clusters; |
| 453 | |
Kevin Wolf | 1d3afd6 | 2012-12-07 18:08:42 +0100 | [diff] [blame] | 454 | /** |
| 455 | * Requests that overlap with this allocation and wait to be restarted |
| 456 | * when the allocating request has completed. |
| 457 | */ |
Kevin Wolf | 68d100e | 2011-06-30 17:42:09 +0200 | [diff] [blame] | 458 | CoQueue dependent_requests; |
Kevin Wolf | f214978 | 2009-08-31 16:48:49 +0200 | [diff] [blame] | 459 | |
Kevin Wolf | 593fb83 | 2012-12-07 18:08:43 +0100 | [diff] [blame] | 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 | |
Anton Nefedov | c8bb23c | 2019-05-16 17:27:49 +0300 | [diff] [blame] | 472 | /* |
| 473 | * Indicates that COW regions are already handled and do not require |
| 474 | * any more processing. |
| 475 | */ |
| 476 | bool skip_cow; |
| 477 | |
Alberto Garcia | ee22a9d | 2017-06-19 16:40:08 +0300 | [diff] [blame] | 478 | /** |
Alberto Garcia | 40dee94 | 2020-07-10 18:13:12 +0200 | [diff] [blame] | 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 | |
| 486 | /** |
Alberto Garcia | ee22a9d | 2017-06-19 16:40:08 +0300 | [diff] [blame] | 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; |
Vladimir Sementsov-Ogievskiy | 5396234 | 2019-06-04 19:15:14 +0300 | [diff] [blame] | 492 | size_t data_qiov_offset; |
Alberto Garcia | ee22a9d | 2017-06-19 16:40:08 +0300 | [diff] [blame] | 493 | |
Kevin Wolf | 88c6588 | 2013-03-26 17:50:11 +0100 | [diff] [blame] | 494 | /** Pointer to next L2Meta of the same write request */ |
| 495 | struct QCowL2Meta *next; |
| 496 | |
Blue Swirl | 72cf2d4 | 2009-09-12 07:36:22 +0000 | [diff] [blame] | 497 | QLIST_ENTRY(QCowL2Meta) next_in_flight; |
Kevin Wolf | 45aba42 | 2009-05-28 16:07:05 +0200 | [diff] [blame] | 498 | } QCowL2Meta; |
| 499 | |
Alberto Garcia | 34905d8 | 2020-07-10 18:12:56 +0200 | [diff] [blame] | 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 | |
Eric Blake | 3ef9521 | 2017-05-06 19:05:45 -0500 | [diff] [blame] | 527 | typedef enum QCow2ClusterType { |
Kevin Wolf | 68d000a | 2012-03-14 19:15:03 +0100 | [diff] [blame] | 528 | QCOW2_CLUSTER_UNALLOCATED, |
Eric Blake | fdfab37 | 2017-05-06 19:05:46 -0500 | [diff] [blame] | 529 | QCOW2_CLUSTER_ZERO_PLAIN, |
| 530 | QCOW2_CLUSTER_ZERO_ALLOC, |
Kevin Wolf | 68d000a | 2012-03-14 19:15:03 +0100 | [diff] [blame] | 531 | QCOW2_CLUSTER_NORMAL, |
| 532 | QCOW2_CLUSTER_COMPRESSED, |
Eric Blake | 3ef9521 | 2017-05-06 19:05:45 -0500 | [diff] [blame] | 533 | } QCow2ClusterType; |
Kevin Wolf | 68d000a | 2012-03-14 19:15:03 +0100 | [diff] [blame] | 534 | |
Alberto Garcia | 34905d8 | 2020-07-10 18:12:56 +0200 | [diff] [blame] | 535 | typedef 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 | |
Max Reitz | a40f1c2 | 2013-08-30 14:34:25 +0200 | [diff] [blame] | 545 | typedef enum QCow2MetadataOverlap { |
Vladimir Sementsov-Ogievskiy | 0e4e431 | 2018-07-05 18:15:15 +0300 | [diff] [blame] | 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, |
Max Reitz | a40f1c2 | 2013-08-30 14:34:25 +0200 | [diff] [blame] | 555 | |
Vladimir Sementsov-Ogievskiy | 0e4e431 | 2018-07-05 18:15:15 +0300 | [diff] [blame] | 556 | QCOW2_OL_MAX_BITNR = 9, |
Max Reitz | a40f1c2 | 2013-08-30 14:34:25 +0200 | [diff] [blame] | 557 | |
Vladimir Sementsov-Ogievskiy | 0e4e431 | 2018-07-05 18:15:15 +0300 | [diff] [blame] | 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), |
Max Reitz | a40f1c2 | 2013-08-30 14:34:25 +0200 | [diff] [blame] | 566 | /* NOTE: Checking overlaps with inactive L2 tables will result in bdrv |
| 567 | * reads. */ |
Vladimir Sementsov-Ogievskiy | 0e4e431 | 2018-07-05 18:15:15 +0300 | [diff] [blame] | 568 | QCOW2_OL_INACTIVE_L2 = (1 << QCOW2_OL_INACTIVE_L2_BITNR), |
| 569 | QCOW2_OL_BITMAP_DIRECTORY = (1 << QCOW2_OL_BITMAP_DIRECTORY_BITNR), |
Max Reitz | a40f1c2 | 2013-08-30 14:34:25 +0200 | [diff] [blame] | 570 | } QCow2MetadataOverlap; |
| 571 | |
Max Reitz | 4a273c3 | 2013-10-10 11:09:27 +0200 | [diff] [blame] | 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 | \ |
Vladimir Sementsov-Ogievskiy | 0e4e431 | 2018-07-05 18:15:15 +0300 | [diff] [blame] | 575 | QCOW2_OL_SNAPSHOT_TABLE | QCOW2_OL_BITMAP_DIRECTORY) |
Max Reitz | 4a273c3 | 2013-10-10 11:09:27 +0200 | [diff] [blame] | 576 | |
Max Reitz | a40f1c2 | 2013-08-30 14:34:25 +0200 | [diff] [blame] | 577 | /* Perform all overlap checks which don't require disk access */ |
| 578 | #define QCOW2_OL_CACHED \ |
Max Reitz | 4a273c3 | 2013-10-10 11:09:27 +0200 | [diff] [blame] | 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) |
Max Reitz | a40f1c2 | 2013-08-30 14:34:25 +0200 | [diff] [blame] | 585 | |
Hu Tao | 46bae92 | 2014-01-21 11:30:02 +0800 | [diff] [blame] | 586 | #define L1E_OFFSET_MASK 0x00fffffffffffe00ULL |
| 587 | #define L2E_OFFSET_MASK 0x00fffffffffffe00ULL |
Kevin Wolf | 68d000a | 2012-03-14 19:15:03 +0100 | [diff] [blame] | 588 | #define L2E_COMPRESSED_OFFSET_SIZE_MASK 0x3fffffffffffffffULL |
| 589 | |
Hu Tao | 46bae92 | 2014-01-21 11:30:02 +0800 | [diff] [blame] | 590 | #define REFT_OFFSET_MASK 0xfffffffffffffe00ULL |
Kevin Wolf | 76dc9e0 | 2012-03-16 14:09:08 +0100 | [diff] [blame] | 591 | |
Kevin Wolf | c6d619c | 2019-01-18 14:40:36 +0100 | [diff] [blame] | 592 | #define INV_OFFSET (-1ULL) |
| 593 | |
Alberto Garcia | a3c7d91 | 2020-07-10 18:12:50 +0200 | [diff] [blame] | 594 | static inline bool has_subclusters(BDRVQcow2State *s) |
| 595 | { |
Alberto Garcia | 7be2025 | 2020-07-10 18:13:13 +0200 | [diff] [blame] | 596 | return s->incompatible_features & QCOW2_INCOMPAT_EXTL2; |
Alberto Garcia | a3c7d91 | 2020-07-10 18:12:50 +0200 | [diff] [blame] | 597 | } |
| 598 | |
Alberto Garcia | c8fd855 | 2020-07-10 18:12:54 +0200 | [diff] [blame] | 599 | static inline size_t l2_entry_size(BDRVQcow2State *s) |
| 600 | { |
| 601 | return has_subclusters(s) ? L2E_SIZE_EXTENDED : L2E_SIZE_NORMAL; |
| 602 | } |
| 603 | |
Alberto Garcia | 12c6aeb | 2020-07-10 18:12:48 +0200 | [diff] [blame] | 604 | static inline uint64_t get_l2_entry(BDRVQcow2State *s, uint64_t *l2_slice, |
| 605 | int idx) |
| 606 | { |
Alberto Garcia | 39a9f0a | 2020-07-10 18:12:55 +0200 | [diff] [blame] | 607 | idx *= l2_entry_size(s) / sizeof(uint64_t); |
Alberto Garcia | 12c6aeb | 2020-07-10 18:12:48 +0200 | [diff] [blame] | 608 | return be64_to_cpu(l2_slice[idx]); |
| 609 | } |
| 610 | |
Alberto Garcia | 39a9f0a | 2020-07-10 18:12:55 +0200 | [diff] [blame] | 611 | static 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 | |
Alberto Garcia | 12c6aeb | 2020-07-10 18:12:48 +0200 | [diff] [blame] | 622 | static inline void set_l2_entry(BDRVQcow2State *s, uint64_t *l2_slice, |
| 623 | int idx, uint64_t entry) |
| 624 | { |
Alberto Garcia | 39a9f0a | 2020-07-10 18:12:55 +0200 | [diff] [blame] | 625 | idx *= l2_entry_size(s) / sizeof(uint64_t); |
Alberto Garcia | 12c6aeb | 2020-07-10 18:12:48 +0200 | [diff] [blame] | 626 | l2_slice[idx] = cpu_to_be64(entry); |
| 627 | } |
| 628 | |
Alberto Garcia | 39a9f0a | 2020-07-10 18:12:55 +0200 | [diff] [blame] | 629 | static 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 | |
Kevin Wolf | 93c2493 | 2019-01-14 16:48:25 +0100 | [diff] [blame] | 637 | static inline bool has_data_file(BlockDriverState *bs) |
| 638 | { |
| 639 | BDRVQcow2State *s = bs->opaque; |
| 640 | return (s->data_file != bs->file); |
| 641 | } |
| 642 | |
Kevin Wolf | 6c3944d | 2019-02-22 14:29:38 +0100 | [diff] [blame] | 643 | static 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 | |
Kevin Wolf | ff99129 | 2015-09-07 17:12:56 +0200 | [diff] [blame] | 649 | static inline int64_t start_of_cluster(BDRVQcow2State *s, int64_t offset) |
Kevin Wolf | 3b8e2e2 | 2013-03-26 17:50:02 +0100 | [diff] [blame] | 650 | { |
| 651 | return offset & ~(s->cluster_size - 1); |
| 652 | } |
| 653 | |
Kevin Wolf | ff99129 | 2015-09-07 17:12:56 +0200 | [diff] [blame] | 654 | static inline int64_t offset_into_cluster(BDRVQcow2State *s, int64_t offset) |
Kevin Wolf | c37f4cd | 2013-03-26 17:50:03 +0100 | [diff] [blame] | 655 | { |
| 656 | return offset & (s->cluster_size - 1); |
| 657 | } |
| 658 | |
Alberto Garcia | 3e71981 | 2020-07-10 18:12:53 +0200 | [diff] [blame] | 659 | static inline int64_t offset_into_subcluster(BDRVQcow2State *s, int64_t offset) |
| 660 | { |
| 661 | return offset & (s->subcluster_size - 1); |
| 662 | } |
| 663 | |
Max Reitz | b6d36de | 2015-09-14 16:39:47 +0200 | [diff] [blame] | 664 | static inline uint64_t size_to_clusters(BDRVQcow2State *s, uint64_t size) |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 665 | { |
| 666 | return (size + (s->cluster_size - 1)) >> s->cluster_bits; |
| 667 | } |
| 668 | |
Alberto Garcia | 3e71981 | 2020-07-10 18:12:53 +0200 | [diff] [blame] | 669 | static inline uint64_t size_to_subclusters(BDRVQcow2State *s, uint64_t size) |
| 670 | { |
| 671 | return (size + (s->subcluster_size - 1)) >> s->subcluster_bits; |
| 672 | } |
| 673 | |
Kevin Wolf | ff99129 | 2015-09-07 17:12:56 +0200 | [diff] [blame] | 674 | static inline int64_t size_to_l1(BDRVQcow2State *s, int64_t size) |
Stefan Hajnoczi | 419b19d | 2010-04-28 11:36:11 +0100 | [diff] [blame] | 675 | { |
| 676 | int shift = s->cluster_bits + s->l2_bits; |
| 677 | return (size + (1ULL << shift) - 1) >> shift; |
| 678 | } |
| 679 | |
Alberto Garcia | 05b5b6e | 2018-02-05 16:33:12 +0200 | [diff] [blame] | 680 | static inline int offset_to_l1_index(BDRVQcow2State *s, uint64_t offset) |
| 681 | { |
| 682 | return offset >> (s->l2_bits + s->cluster_bits); |
| 683 | } |
| 684 | |
Kevin Wolf | ff99129 | 2015-09-07 17:12:56 +0200 | [diff] [blame] | 685 | static inline int offset_to_l2_index(BDRVQcow2State *s, int64_t offset) |
Kevin Wolf | 17a71e5 | 2013-03-26 17:49:56 +0100 | [diff] [blame] | 686 | { |
| 687 | return (offset >> s->cluster_bits) & (s->l2_size - 1); |
| 688 | } |
| 689 | |
Alberto Garcia | 8f81817 | 2018-02-05 16:33:14 +0200 | [diff] [blame] | 690 | static 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 | |
Alberto Garcia | a53e8b7 | 2020-07-10 18:12:52 +0200 | [diff] [blame] | 695 | static 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 | |
Kevin Wolf | ff99129 | 2015-09-07 17:12:56 +0200 | [diff] [blame] | 700 | static inline int64_t qcow2_vm_state_offset(BDRVQcow2State *s) |
Kevin Wolf | 1ebf561 | 2013-09-06 12:20:08 +0200 | [diff] [blame] | 701 | { |
| 702 | return (int64_t)s->l1_vm_state_index << (s->cluster_bits + s->l2_bits); |
| 703 | } |
| 704 | |
Kevin Wolf | 808c2bb | 2019-01-17 18:42:40 +0100 | [diff] [blame] | 705 | static inline QCow2ClusterType qcow2_get_cluster_type(BlockDriverState *bs, |
| 706 | uint64_t l2_entry) |
Kevin Wolf | 68d000a | 2012-03-14 19:15:03 +0100 | [diff] [blame] | 707 | { |
Alberto Garcia | 34905d8 | 2020-07-10 18:12:56 +0200 | [diff] [blame] | 708 | BDRVQcow2State *s = bs->opaque; |
| 709 | |
Kevin Wolf | 68d000a | 2012-03-14 19:15:03 +0100 | [diff] [blame] | 710 | if (l2_entry & QCOW_OFLAG_COMPRESSED) { |
| 711 | return QCOW2_CLUSTER_COMPRESSED; |
Alberto Garcia | 34905d8 | 2020-07-10 18:12:56 +0200 | [diff] [blame] | 712 | } else if ((l2_entry & QCOW_OFLAG_ZERO) && !has_subclusters(s)) { |
Eric Blake | fdfab37 | 2017-05-06 19:05:46 -0500 | [diff] [blame] | 713 | if (l2_entry & L2E_OFFSET_MASK) { |
| 714 | return QCOW2_CLUSTER_ZERO_ALLOC; |
| 715 | } |
| 716 | return QCOW2_CLUSTER_ZERO_PLAIN; |
Kevin Wolf | 68d000a | 2012-03-14 19:15:03 +0100 | [diff] [blame] | 717 | } else if (!(l2_entry & L2E_OFFSET_MASK)) { |
Kevin Wolf | a4ea184 | 2019-01-29 13:47:24 +0100 | [diff] [blame] | 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 | } |
Kevin Wolf | 68d000a | 2012-03-14 19:15:03 +0100 | [diff] [blame] | 727 | } else { |
| 728 | return QCOW2_CLUSTER_NORMAL; |
| 729 | } |
| 730 | } |
| 731 | |
Alberto Garcia | 34905d8 | 2020-07-10 18:12:56 +0200 | [diff] [blame] | 732 | /* |
Alberto Garcia | 34905d8 | 2020-07-10 18:12:56 +0200 | [diff] [blame] | 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 | */ |
| 739 | static inline |
| 740 | QCow2SubclusterType 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 { |
Alberto Garcia | 3f9c6b3 | 2020-07-10 18:13:03 +0200 | [diff] [blame] | 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 | } |
Alberto Garcia | 34905d8 | 2020-07-10 18:12:56 +0200 | [diff] [blame] | 789 | } |
| 790 | } |
| 791 | |
Alberto Garcia | c94d037 | 2020-07-10 18:12:58 +0200 | [diff] [blame] | 792 | static 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 | |
Stefan Hajnoczi | bfe8043 | 2012-07-27 09:05:22 +0100 | [diff] [blame] | 798 | /* Check whether refcounts are eager or lazy */ |
Kevin Wolf | ff99129 | 2015-09-07 17:12:56 +0200 | [diff] [blame] | 799 | static inline bool qcow2_need_accurate_refcounts(BDRVQcow2State *s) |
Stefan Hajnoczi | bfe8043 | 2012-07-27 09:05:22 +0100 | [diff] [blame] | 800 | { |
| 801 | return !(s->incompatible_features & QCOW2_INCOMPAT_DIRTY); |
| 802 | } |
Kevin Wolf | c142442 | 2009-05-28 16:07:06 +0200 | [diff] [blame] | 803 | |
Kevin Wolf | 65eb2e3 | 2013-03-26 17:49:58 +0100 | [diff] [blame] | 804 | static inline uint64_t l2meta_cow_start(QCowL2Meta *m) |
| 805 | { |
| 806 | return m->offset + m->cow_start.offset; |
| 807 | } |
| 808 | |
| 809 | static inline uint64_t l2meta_cow_end(QCowL2Meta *m) |
| 810 | { |
Kevin Wolf | 8556739 | 2016-06-01 14:08:56 +0200 | [diff] [blame] | 811 | return m->offset + m->cow_end.offset + m->cow_end.nb_bytes; |
Kevin Wolf | 65eb2e3 | 2013-03-26 17:49:58 +0100 | [diff] [blame] | 812 | } |
| 813 | |
Max Reitz | 0e06528 | 2015-02-10 15:28:48 -0500 | [diff] [blame] | 814 | static inline uint64_t refcount_diff(uint64_t r1, uint64_t r2) |
Max Reitz | 2aabe7c | 2015-02-10 15:28:47 -0500 | [diff] [blame] | 815 | { |
| 816 | return r1 > r2 ? r1 - r2 : r2 - r1; |
| 817 | } |
| 818 | |
Pavel Butsykin | 46b732c | 2017-09-18 15:42:29 +0300 | [diff] [blame] | 819 | static inline |
| 820 | uint32_t offset_to_reftable_index(BDRVQcow2State *s, uint64_t offset) |
| 821 | { |
| 822 | return offset >> (s->refcount_block_bits + s->cluster_bits); |
| 823 | } |
| 824 | |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 825 | /* qcow2.c functions */ |
Max Reitz | 12cc30a | 2017-06-13 22:21:03 +0200 | [diff] [blame] | 826 | int64_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 | |
Kevin Wolf | 280d373 | 2012-12-07 18:08:47 +0100 | [diff] [blame] | 830 | int qcow2_mark_dirty(BlockDriverState *bs); |
Max Reitz | 69c9872 | 2013-08-30 14:34:24 +0200 | [diff] [blame] | 831 | int qcow2_mark_corrupt(BlockDriverState *bs); |
| 832 | int qcow2_mark_consistent(BlockDriverState *bs); |
Kevin Wolf | e24e49e | 2012-02-02 12:32:31 +0100 | [diff] [blame] | 833 | int qcow2_update_header(BlockDriverState *bs); |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 834 | |
Max Reitz | 85186eb | 2014-09-05 16:07:16 +0200 | [diff] [blame] | 835 | void 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 | |
Alberto Garcia | 0cf0e59 | 2018-03-06 18:14:06 +0200 | [diff] [blame] | 839 | int 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 | |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 844 | /* qcow2-refcount.c functions */ |
Kevin Wolf | ed6ccf0 | 2009-05-28 16:07:07 +0200 | [diff] [blame] | 845 | int qcow2_refcount_init(BlockDriverState *bs); |
| 846 | void qcow2_refcount_close(BlockDriverState *bs); |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 847 | |
Max Reitz | 7324c10 | 2015-02-10 15:28:46 -0500 | [diff] [blame] | 848 | int qcow2_get_refcount(BlockDriverState *bs, int64_t cluster_index, |
Max Reitz | 0e06528 | 2015-02-10 15:28:48 -0500 | [diff] [blame] | 849 | uint64_t *refcount); |
Max Reitz | 4475191 | 2014-10-27 11:12:54 +0100 | [diff] [blame] | 850 | |
Max Reitz | 32b6444 | 2013-09-03 10:09:52 +0200 | [diff] [blame] | 851 | int qcow2_update_cluster_refcount(BlockDriverState *bs, int64_t cluster_index, |
Max Reitz | 0e06528 | 2015-02-10 15:28:48 -0500 | [diff] [blame] | 852 | uint64_t addend, bool decrease, |
Max Reitz | 2aabe7c | 2015-02-10 15:28:47 -0500 | [diff] [blame] | 853 | enum qcow2_discard_type type); |
Max Reitz | 32b6444 | 2013-09-03 10:09:52 +0200 | [diff] [blame] | 854 | |
Max Reitz | 772d1f9 | 2017-06-13 22:21:05 +0200 | [diff] [blame] | 855 | int64_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 | |
Kevin Wolf | bb572ae | 2014-03-26 13:05:51 +0100 | [diff] [blame] | 860 | int64_t qcow2_alloc_clusters(BlockDriverState *bs, uint64_t size); |
Max Reitz | b6d36de | 2015-09-14 16:39:47 +0200 | [diff] [blame] | 861 | int64_t qcow2_alloc_clusters_at(BlockDriverState *bs, uint64_t offset, |
| 862 | int64_t nb_clusters); |
Kevin Wolf | ed6ccf0 | 2009-05-28 16:07:07 +0200 | [diff] [blame] | 863 | int64_t qcow2_alloc_bytes(BlockDriverState *bs, int size); |
| 864 | void qcow2_free_clusters(BlockDriverState *bs, |
Kevin Wolf | 6cfcb9b | 2013-06-19 13:44:18 +0200 | [diff] [blame] | 865 | int64_t offset, int64_t size, |
| 866 | enum qcow2_discard_type type); |
Alberto Garcia | 3fec237 | 2020-09-08 16:08:28 +0200 | [diff] [blame] | 867 | void qcow2_free_any_cluster(BlockDriverState *bs, uint64_t l2_entry, |
| 868 | enum qcow2_discard_type type); |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 869 | |
Kevin Wolf | ed6ccf0 | 2009-05-28 16:07:07 +0200 | [diff] [blame] | 870 | int qcow2_update_snapshot_refcount(BlockDriverState *bs, |
| 871 | int64_t l1_table_offset, int l1_size, int addend); |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 872 | |
Paolo Bonzini | 8b220eb | 2018-03-01 17:36:14 +0100 | [diff] [blame] | 873 | int coroutine_fn qcow2_flush_caches(BlockDriverState *bs); |
| 874 | int coroutine_fn qcow2_write_caches(BlockDriverState *bs); |
Kevin Wolf | 166acf5 | 2012-05-11 18:18:36 +0200 | [diff] [blame] | 875 | int qcow2_check_refcounts(BlockDriverState *bs, BdrvCheckResult *res, |
| 876 | BdrvCheckMode fix); |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 877 | |
Kevin Wolf | 0b919fa | 2013-06-19 13:44:20 +0200 | [diff] [blame] | 878 | void qcow2_process_discards(BlockDriverState *bs, int ret); |
| 879 | |
Max Reitz | 231bb26 | 2013-10-10 11:09:23 +0200 | [diff] [blame] | 880 | int qcow2_check_metadata_overlap(BlockDriverState *bs, int ign, int64_t offset, |
Max Reitz | a40f1c2 | 2013-08-30 14:34:25 +0200 | [diff] [blame] | 881 | int64_t size); |
Max Reitz | 231bb26 | 2013-10-10 11:09:23 +0200 | [diff] [blame] | 882 | int qcow2_pre_write_overlap_check(BlockDriverState *bs, int ign, int64_t offset, |
Kevin Wolf | 966b000 | 2019-01-15 20:39:06 +0100 | [diff] [blame] | 883 | int64_t size, bool data_file); |
Vladimir Sementsov-Ogievskiy | 8a5bb1f | 2017-06-28 15:05:07 +0300 | [diff] [blame] | 884 | int 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); |
Max Reitz | a40f1c2 | 2013-08-30 14:34:25 +0200 | [diff] [blame] | 888 | |
Max Reitz | 791c9a0 | 2015-07-27 17:51:37 +0200 | [diff] [blame] | 889 | int qcow2_change_refcount_order(BlockDriverState *bs, int refcount_order, |
| 890 | BlockDriverAmendStatusCB *status_cb, |
| 891 | void *cb_opaque, Error **errp); |
Pavel Butsykin | 46b732c | 2017-09-18 15:42:29 +0300 | [diff] [blame] | 892 | int qcow2_shrink_reftable(BlockDriverState *bs); |
Pavel Butsykin | 163bc39 | 2017-09-29 15:16:13 +0300 | [diff] [blame] | 893 | int64_t qcow2_get_last_cluster(BlockDriverState *bs, int64_t size); |
Vladimir Sementsov-Ogievskiy | 69f4750 | 2019-04-08 19:26:17 +0300 | [diff] [blame] | 894 | int qcow2_detect_metadata_preallocation(BlockDriverState *bs); |
Max Reitz | 791c9a0 | 2015-07-27 17:51:37 +0200 | [diff] [blame] | 895 | |
Kevin Wolf | 45aba42 | 2009-05-28 16:07:05 +0200 | [diff] [blame] | 896 | /* qcow2-cluster.c functions */ |
Kevin Wolf | 2cf7cfa | 2013-05-14 16:14:33 +0200 | [diff] [blame] | 897 | int qcow2_grow_l1_table(BlockDriverState *bs, uint64_t min_size, |
| 898 | bool exact_size); |
Pavel Butsykin | 46b732c | 2017-09-18 15:42:29 +0300 | [diff] [blame] | 899 | int qcow2_shrink_l1_table(BlockDriverState *bs, uint64_t max_size); |
Max Reitz | e23e400 | 2013-08-30 14:34:28 +0200 | [diff] [blame] | 900 | int qcow2_write_l1_entry(BlockDriverState *bs, int l1_index); |
Kevin Wolf | ff99129 | 2015-09-07 17:12:56 +0200 | [diff] [blame] | 901 | int qcow2_encrypt_sectors(BDRVQcow2State *s, int64_t sector_num, |
Daniel P. Berrange | 446d306 | 2017-06-23 17:24:09 +0100 | [diff] [blame] | 902 | uint8_t *buf, int nb_sectors, bool enc, Error **errp); |
Kevin Wolf | 45aba42 | 2009-05-28 16:07:05 +0200 | [diff] [blame] | 903 | |
Alberto Garcia | 388e581 | 2020-07-10 18:12:44 +0200 | [diff] [blame] | 904 | int qcow2_get_host_offset(BlockDriverState *bs, uint64_t offset, |
Alberto Garcia | ca4a0bb | 2020-07-10 18:12:59 +0200 | [diff] [blame] | 905 | unsigned int *bytes, uint64_t *host_offset, |
Alberto Garcia | 10dabdc5 | 2020-07-10 18:13:00 +0200 | [diff] [blame] | 906 | QCow2SubclusterType *subcluster_type); |
Alberto Garcia | bfd0989 | 2020-09-11 16:09:42 +0200 | [diff] [blame] | 907 | int qcow2_alloc_host_offset(BlockDriverState *bs, uint64_t offset, |
| 908 | unsigned int *bytes, uint64_t *host_offset, |
| 909 | QCowL2Meta **m); |
Kevin Wolf | 77e023f | 2019-02-27 10:26:24 +0100 | [diff] [blame] | 910 | int qcow2_alloc_compressed_cluster_offset(BlockDriverState *bs, |
| 911 | uint64_t offset, |
| 912 | int compressed_size, |
| 913 | uint64_t *host_offset); |
Kevin Wolf | 45aba42 | 2009-05-28 16:07:05 +0200 | [diff] [blame] | 914 | |
Kevin Wolf | 148da7e | 2010-01-20 15:03:01 +0100 | [diff] [blame] | 915 | int qcow2_alloc_cluster_link_l2(BlockDriverState *bs, QCowL2Meta *m); |
Kevin Wolf | 8b24cd1 | 2018-06-28 17:05:45 +0200 | [diff] [blame] | 916 | void qcow2_alloc_cluster_abort(BlockDriverState *bs, QCowL2Meta *m); |
Eric Blake | d2cb36a | 2017-05-06 19:05:52 -0500 | [diff] [blame] | 917 | int qcow2_cluster_discard(BlockDriverState *bs, uint64_t offset, |
| 918 | uint64_t bytes, enum qcow2_discard_type type, |
| 919 | bool full_discard); |
Alberto Garcia | a6841a2 | 2020-07-10 18:13:10 +0200 | [diff] [blame] | 920 | int qcow2_subcluster_zeroize(BlockDriverState *bs, uint64_t offset, |
| 921 | uint64_t bytes, int flags); |
Kevin Wolf | 45aba42 | 2009-05-28 16:07:05 +0200 | [diff] [blame] | 922 | |
Max Reitz | 4057a2b | 2014-10-27 11:12:53 +0100 | [diff] [blame] | 923 | int qcow2_expand_zero_clusters(BlockDriverState *bs, |
Max Reitz | 8b13976 | 2015-07-27 17:51:32 +0200 | [diff] [blame] | 924 | BlockDriverAmendStatusCB *status_cb, |
| 925 | void *cb_opaque); |
Max Reitz | 32b6444 | 2013-09-03 10:09:52 +0200 | [diff] [blame] | 926 | |
Kevin Wolf | c142442 | 2009-05-28 16:07:06 +0200 | [diff] [blame] | 927 | /* qcow2-snapshot.c functions */ |
Kevin Wolf | ed6ccf0 | 2009-05-28 16:07:07 +0200 | [diff] [blame] | 928 | int qcow2_snapshot_create(BlockDriverState *bs, QEMUSnapshotInfo *sn_info); |
| 929 | int qcow2_snapshot_goto(BlockDriverState *bs, const char *snapshot_id); |
Wenchao Xia | a89d89d | 2013-09-11 14:04:33 +0800 | [diff] [blame] | 930 | int qcow2_snapshot_delete(BlockDriverState *bs, |
| 931 | const char *snapshot_id, |
| 932 | const char *name, |
| 933 | Error **errp); |
Kevin Wolf | ed6ccf0 | 2009-05-28 16:07:07 +0200 | [diff] [blame] | 934 | int qcow2_snapshot_list(BlockDriverState *bs, QEMUSnapshotInfo **psn_tab); |
Wenchao Xia | 7b4c478 | 2013-12-04 17:10:54 +0800 | [diff] [blame] | 935 | int qcow2_snapshot_load_tmp(BlockDriverState *bs, |
| 936 | const char *snapshot_id, |
| 937 | const char *name, |
| 938 | Error **errp); |
Kevin Wolf | c142442 | 2009-05-28 16:07:06 +0200 | [diff] [blame] | 939 | |
Kevin Wolf | ed6ccf0 | 2009-05-28 16:07:07 +0200 | [diff] [blame] | 940 | void qcow2_free_snapshots(BlockDriverState *bs); |
Max Reitz | ecf6c7c | 2019-10-11 17:28:01 +0200 | [diff] [blame] | 941 | int qcow2_read_snapshots(BlockDriverState *bs, Error **errp); |
Max Reitz | e0314b5 | 2019-10-11 17:28:03 +0200 | [diff] [blame] | 942 | int qcow2_write_snapshots(BlockDriverState *bs); |
Kevin Wolf | c142442 | 2009-05-28 16:07:06 +0200 | [diff] [blame] | 943 | |
Max Reitz | 8bc584f | 2019-10-11 17:28:06 +0200 | [diff] [blame] | 944 | int coroutine_fn qcow2_check_read_snapshot_table(BlockDriverState *bs, |
| 945 | BdrvCheckResult *result, |
| 946 | BdrvCheckMode fix); |
Max Reitz | fe446b5 | 2019-10-11 17:28:07 +0200 | [diff] [blame] | 947 | int coroutine_fn qcow2_check_fix_snapshot_table(BlockDriverState *bs, |
| 948 | BdrvCheckResult *result, |
| 949 | BdrvCheckMode fix); |
Max Reitz | 8bc584f | 2019-10-11 17:28:06 +0200 | [diff] [blame] | 950 | |
Kevin Wolf | 4938109 | 2011-01-10 17:15:10 +0100 | [diff] [blame] | 951 | /* qcow2-cache.c functions */ |
Alberto Garcia | 1221fe6 | 2018-02-05 16:33:36 +0200 | [diff] [blame] | 952 | Qcow2Cache *qcow2_cache_create(BlockDriverState *bs, int num_tables, |
| 953 | unsigned table_size); |
Alberto Garcia | e64d407 | 2018-02-05 16:33:08 +0200 | [diff] [blame] | 954 | int qcow2_cache_destroy(Qcow2Cache *c); |
Kevin Wolf | 4938109 | 2011-01-10 17:15:10 +0100 | [diff] [blame] | 955 | |
Alberto Garcia | 2d135ee | 2018-02-05 16:33:06 +0200 | [diff] [blame] | 956 | void qcow2_cache_entry_mark_dirty(Qcow2Cache *c, void *table); |
Kevin Wolf | 4938109 | 2011-01-10 17:15:10 +0100 | [diff] [blame] | 957 | int qcow2_cache_flush(BlockDriverState *bs, Qcow2Cache *c); |
Denis V. Lunev | f3c3b87 | 2016-06-02 18:58:15 +0300 | [diff] [blame] | 958 | int qcow2_cache_write(BlockDriverState *bs, Qcow2Cache *c); |
Kevin Wolf | 4938109 | 2011-01-10 17:15:10 +0100 | [diff] [blame] | 959 | int qcow2_cache_set_dependency(BlockDriverState *bs, Qcow2Cache *c, |
| 960 | Qcow2Cache *dependency); |
Kevin Wolf | 3de0a29 | 2011-01-14 15:55:38 +0100 | [diff] [blame] | 961 | void qcow2_cache_depends_on_flush(Qcow2Cache *c); |
Kevin Wolf | 4938109 | 2011-01-10 17:15:10 +0100 | [diff] [blame] | 962 | |
Alberto Garcia | b2f68bf | 2018-02-05 16:33:09 +0200 | [diff] [blame] | 963 | void qcow2_cache_clean_unused(Qcow2Cache *c); |
Max Reitz | e7108fe | 2013-09-03 10:09:51 +0200 | [diff] [blame] | 964 | int qcow2_cache_empty(BlockDriverState *bs, Qcow2Cache *c); |
| 965 | |
Kevin Wolf | 4938109 | 2011-01-10 17:15:10 +0100 | [diff] [blame] | 966 | int qcow2_cache_get(BlockDriverState *bs, Qcow2Cache *c, uint64_t offset, |
| 967 | void **table); |
| 968 | int qcow2_cache_get_empty(BlockDriverState *bs, Qcow2Cache *c, uint64_t offset, |
| 969 | void **table); |
Alberto Garcia | 2013c3d | 2018-02-05 16:33:07 +0200 | [diff] [blame] | 970 | void qcow2_cache_put(Qcow2Cache *c, void **table); |
Alberto Garcia | 6e6fa76 | 2018-02-05 16:33:11 +0200 | [diff] [blame] | 971 | void *qcow2_cache_is_table_offset(Qcow2Cache *c, uint64_t offset); |
Alberto Garcia | 77aadd7 | 2018-02-05 16:33:10 +0200 | [diff] [blame] | 972 | void qcow2_cache_discard(Qcow2Cache *c, void *table); |
Kevin Wolf | 4938109 | 2011-01-10 17:15:10 +0100 | [diff] [blame] | 973 | |
Vladimir Sementsov-Ogievskiy | 88ddffa | 2017-06-28 15:05:08 +0300 | [diff] [blame] | 974 | /* qcow2-bitmap.c functions */ |
| 975 | int qcow2_check_bitmaps_refcounts(BlockDriverState *bs, BdrvCheckResult *res, |
| 976 | void **refcount_table, |
| 977 | int64_t *refcount_table_size); |
Vladimir Sementsov-Ogievskiy | 3e99da5 | 2018-02-02 19:07:52 +0300 | [diff] [blame] | 978 | bool qcow2_load_dirty_bitmaps(BlockDriverState *bs, Error **errp); |
Andrey Shinkevich | b8968c8 | 2019-02-08 18:06:07 +0300 | [diff] [blame] | 979 | Qcow2BitmapInfoList *qcow2_get_bitmap_info_list(BlockDriverState *bs, |
| 980 | Error **errp); |
Vladimir Sementsov-Ogievskiy | 1b6b056 | 2017-06-28 15:05:14 +0300 | [diff] [blame] | 981 | int qcow2_reopen_bitmaps_rw(BlockDriverState *bs, Error **errp); |
John Snow | d19c6b3 | 2019-03-11 21:51:46 +0300 | [diff] [blame] | 982 | int qcow2_truncate_bitmaps_check(BlockDriverState *bs, Error **errp); |
Vladimir Sementsov-Ogievskiy | 644ddbb | 2019-09-27 15:23:52 +0300 | [diff] [blame] | 983 | void qcow2_store_persistent_dirty_bitmaps(BlockDriverState *bs, |
| 984 | bool release_stored, Error **errp); |
Vladimir Sementsov-Ogievskiy | 169b879 | 2017-06-28 15:05:20 +0300 | [diff] [blame] | 985 | int qcow2_reopen_bitmaps_ro(BlockDriverState *bs, Error **errp); |
Vladimir Sementsov-Ogievskiy | d2c3080 | 2019-09-20 11:25:43 +0300 | [diff] [blame] | 986 | bool qcow2_co_can_store_new_dirty_bitmap(BlockDriverState *bs, |
| 987 | const char *name, |
| 988 | uint32_t granularity, |
Vladimir Sementsov-Ogievskiy | b56a1e3 | 2019-09-20 11:25:42 +0300 | [diff] [blame] | 989 | Error **errp); |
Vladimir Sementsov-Ogievskiy | d2c3080 | 2019-09-20 11:25:43 +0300 | [diff] [blame] | 990 | int qcow2_co_remove_persistent_dirty_bitmap(BlockDriverState *bs, |
| 991 | const char *name, |
| 992 | Error **errp); |
Eric Blake | ef893b5 | 2020-05-12 20:16:42 -0500 | [diff] [blame] | 993 | bool qcow2_supports_persistent_dirty_bitmap(BlockDriverState *bs); |
Eric Blake | 5d72c68 | 2020-05-21 14:21:34 -0500 | [diff] [blame] | 994 | uint64_t qcow2_get_persistent_dirty_bitmap_size(BlockDriverState *bs, |
| 995 | uint32_t cluster_size); |
Vladimir Sementsov-Ogievskiy | d1258dd | 2017-06-28 15:05:11 +0300 | [diff] [blame] | 996 | |
Vladimir Sementsov-Ogievskiy | 56e2f1d | 2019-05-06 17:27:35 +0300 | [diff] [blame] | 997 | ssize_t coroutine_fn |
| 998 | qcow2_co_compress(BlockDriverState *bs, void *dest, size_t dest_size, |
| 999 | const void *src, size_t src_size); |
| 1000 | ssize_t coroutine_fn |
| 1001 | qcow2_co_decompress(BlockDriverState *bs, void *dest, size_t dest_size, |
| 1002 | const void *src, size_t src_size); |
Vladimir Sementsov-Ogievskiy | 8ac0f15 | 2019-05-06 17:27:41 +0300 | [diff] [blame] | 1003 | int coroutine_fn |
Maxim Levitsky | 603fbd0 | 2019-09-15 23:36:54 +0300 | [diff] [blame] | 1004 | qcow2_co_encrypt(BlockDriverState *bs, uint64_t host_offset, |
| 1005 | uint64_t guest_offset, void *buf, size_t len); |
Vladimir Sementsov-Ogievskiy | 8ac0f15 | 2019-05-06 17:27:41 +0300 | [diff] [blame] | 1006 | int coroutine_fn |
Maxim Levitsky | 603fbd0 | 2019-09-15 23:36:54 +0300 | [diff] [blame] | 1007 | qcow2_co_decrypt(BlockDriverState *bs, uint64_t host_offset, |
| 1008 | uint64_t guest_offset, void *buf, size_t len); |
Vladimir Sementsov-Ogievskiy | 56e2f1d | 2019-05-06 17:27:35 +0300 | [diff] [blame] | 1009 | |
Kevin Wolf | f7d0fe0 | 2009-05-28 16:07:04 +0200 | [diff] [blame] | 1010 | #endif |