]>
Commit | Line | Data |
---|---|---|
585f8587 FB |
1 | /* |
2 | * Block driver for the QCOW version 2 format | |
5fafdf24 | 3 | * |
585f8587 | 4 | * Copyright (c) 2004-2006 Fabrice Bellard |
5fafdf24 | 5 | * |
585f8587 FB |
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 | */ | |
e688df6b | 24 | |
80c71a24 | 25 | #include "qemu/osdep.h" |
2714f13d | 26 | |
609f45ea | 27 | #include "block/qdict.h" |
23588797 | 28 | #include "sysemu/block-backend.h" |
db725815 | 29 | #include "qemu/main-loop.h" |
1de7afc9 | 30 | #include "qemu/module.h" |
0d8c41da | 31 | #include "qcow2.h" |
1de7afc9 | 32 | #include "qemu/error-report.h" |
e688df6b | 33 | #include "qapi/error.h" |
9af23989 | 34 | #include "qapi/qapi-events-block-core.h" |
6b673957 MA |
35 | #include "qapi/qmp/qdict.h" |
36 | #include "qapi/qmp/qstring.h" | |
3cce16f4 | 37 | #include "trace.h" |
1bd0e2d1 | 38 | #include "qemu/option_int.h" |
f348b6d1 | 39 | #include "qemu/cutils.h" |
58369e22 | 40 | #include "qemu/bswap.h" |
5df022cf | 41 | #include "qemu/memalign.h" |
b76b4f60 KW |
42 | #include "qapi/qobject-input-visitor.h" |
43 | #include "qapi/qapi-visit-block-core.h" | |
0d8c41da | 44 | #include "crypto.h" |
d710cf57 | 45 | #include "block/aio_task.h" |
e2c1c34f | 46 | #include "block/dirty-bitmap.h" |
585f8587 FB |
47 | |
48 | /* | |
49 | Differences with QCOW: | |
50 | ||
51 | - Support for multiple incremental snapshots. | |
52 | - Memory management by reference counts. | |
53 | - Clusters which have a reference count of one have the bit | |
54 | QCOW_OFLAG_COPIED to optimize write performance. | |
5fafdf24 | 55 | - Size of compressed clusters is stored in sectors to reduce bit usage |
585f8587 FB |
56 | in the cluster offsets. |
57 | - Support for storing additional data (such as the VM state) in the | |
3b46e624 | 58 | snapshots. |
585f8587 FB |
59 | - If a backing store is used, the cluster size is not constrained |
60 | (could be backported to QCOW). | |
61 | - L2 tables have always a size of one cluster. | |
62 | */ | |
63 | ||
9b80ddf3 AL |
64 | |
65 | typedef struct { | |
66 | uint32_t magic; | |
67 | uint32_t len; | |
c4217f64 | 68 | } QEMU_PACKED QCowExtension; |
21d82ac9 | 69 | |
7c80ab3f | 70 | #define QCOW2_EXT_MAGIC_END 0 |
8098969c | 71 | #define QCOW2_EXT_MAGIC_BACKING_FORMAT 0xe2792aca |
cfcc4c62 | 72 | #define QCOW2_EXT_MAGIC_FEATURE_TABLE 0x6803f857 |
4652b8f3 | 73 | #define QCOW2_EXT_MAGIC_CRYPTO_HEADER 0x0537be77 |
88ddffae | 74 | #define QCOW2_EXT_MAGIC_BITMAPS 0x23852875 |
93c24936 | 75 | #define QCOW2_EXT_MAGIC_DATA_FILE 0x44415441 |
9b80ddf3 | 76 | |
c3c10f72 VSO |
77 | static int coroutine_fn |
78 | qcow2_co_preadv_compressed(BlockDriverState *bs, | |
9a3978a4 | 79 | uint64_t l2_entry, |
c3c10f72 VSO |
80 | uint64_t offset, |
81 | uint64_t bytes, | |
df893d25 VSO |
82 | QEMUIOVector *qiov, |
83 | size_t qiov_offset); | |
c3c10f72 | 84 | |
7c80ab3f | 85 | static int qcow2_probe(const uint8_t *buf, int buf_size, const char *filename) |
585f8587 FB |
86 | { |
87 | const QCowHeader *cow_header = (const void *)buf; | |
3b46e624 | 88 | |
585f8587 FB |
89 | if (buf_size >= sizeof(QCowHeader) && |
90 | be32_to_cpu(cow_header->magic) == QCOW_MAGIC && | |
6744cbab | 91 | be32_to_cpu(cow_header->version) >= 2) |
585f8587 FB |
92 | return 100; |
93 | else | |
94 | return 0; | |
95 | } | |
96 | ||
9b80ddf3 | 97 | |
757dda54 AF |
98 | static int qcow2_crypto_hdr_read_func(QCryptoBlock *block, size_t offset, |
99 | uint8_t *buf, size_t buflen, | |
100 | void *opaque, Error **errp) | |
4652b8f3 DB |
101 | { |
102 | BlockDriverState *bs = opaque; | |
103 | BDRVQcow2State *s = bs->opaque; | |
104 | ssize_t ret; | |
105 | ||
106 | if ((offset + buflen) > s->crypto_header.length) { | |
107 | error_setg(errp, "Request for data outside of extension header"); | |
108 | return -1; | |
109 | } | |
110 | ||
32cc71de | 111 | ret = bdrv_pread(bs->file, s->crypto_header.offset + offset, buflen, buf, |
53fb7844 | 112 | 0); |
4652b8f3 DB |
113 | if (ret < 0) { |
114 | error_setg_errno(errp, -ret, "Could not read encryption header"); | |
115 | return -1; | |
116 | } | |
757dda54 | 117 | return 0; |
4652b8f3 DB |
118 | } |
119 | ||
120 | ||
757dda54 AF |
121 | static int qcow2_crypto_hdr_init_func(QCryptoBlock *block, size_t headerlen, |
122 | void *opaque, Error **errp) | |
4652b8f3 DB |
123 | { |
124 | BlockDriverState *bs = opaque; | |
125 | BDRVQcow2State *s = bs->opaque; | |
126 | int64_t ret; | |
127 | int64_t clusterlen; | |
128 | ||
129 | ret = qcow2_alloc_clusters(bs, headerlen); | |
130 | if (ret < 0) { | |
131 | error_setg_errno(errp, -ret, | |
132 | "Cannot allocate cluster for LUKS header size %zu", | |
133 | headerlen); | |
134 | return -1; | |
135 | } | |
136 | ||
137 | s->crypto_header.length = headerlen; | |
138 | s->crypto_header.offset = ret; | |
139 | ||
087ab8e7 DB |
140 | /* |
141 | * Zero fill all space in cluster so it has predictable | |
142 | * content, as we may not initialize some regions of the | |
143 | * header (eg only 1 out of 8 key slots will be initialized) | |
144 | */ | |
4652b8f3 | 145 | clusterlen = size_to_clusters(s, headerlen) * s->cluster_size; |
966b000f | 146 | assert(qcow2_pre_write_overlap_check(bs, 0, ret, clusterlen, false) == 0); |
4652b8f3 | 147 | ret = bdrv_pwrite_zeroes(bs->file, |
087ab8e7 DB |
148 | ret, |
149 | clusterlen, 0); | |
4652b8f3 DB |
150 | if (ret < 0) { |
151 | error_setg_errno(errp, -ret, "Could not zero fill encryption header"); | |
152 | return -1; | |
153 | } | |
154 | ||
757dda54 | 155 | return 0; |
4652b8f3 DB |
156 | } |
157 | ||
158 | ||
757dda54 AF |
159 | static int qcow2_crypto_hdr_write_func(QCryptoBlock *block, size_t offset, |
160 | const uint8_t *buf, size_t buflen, | |
161 | void *opaque, Error **errp) | |
4652b8f3 DB |
162 | { |
163 | BlockDriverState *bs = opaque; | |
164 | BDRVQcow2State *s = bs->opaque; | |
165 | ssize_t ret; | |
166 | ||
167 | if ((offset + buflen) > s->crypto_header.length) { | |
168 | error_setg(errp, "Request for data outside of extension header"); | |
169 | return -1; | |
170 | } | |
171 | ||
32cc71de | 172 | ret = bdrv_pwrite(bs->file, s->crypto_header.offset + offset, buflen, buf, |
53fb7844 | 173 | 0); |
4652b8f3 DB |
174 | if (ret < 0) { |
175 | error_setg_errno(errp, -ret, "Could not read encryption header"); | |
176 | return -1; | |
177 | } | |
757dda54 | 178 | return 0; |
4652b8f3 DB |
179 | } |
180 | ||
90766d9d ML |
181 | static QDict* |
182 | qcow2_extract_crypto_opts(QemuOpts *opts, const char *fmt, Error **errp) | |
183 | { | |
184 | QDict *cryptoopts_qdict; | |
185 | QDict *opts_qdict; | |
186 | ||
187 | /* Extract "encrypt." options into a qdict */ | |
188 | opts_qdict = qemu_opts_to_qdict(opts, NULL); | |
189 | qdict_extract_subqdict(opts_qdict, &cryptoopts_qdict, "encrypt."); | |
190 | qobject_unref(opts_qdict); | |
191 | qdict_put_str(cryptoopts_qdict, "format", fmt); | |
192 | return cryptoopts_qdict; | |
193 | } | |
4652b8f3 | 194 | |
a951a631 | 195 | /* |
9b80ddf3 AL |
196 | * read qcow2 extension and fill bs |
197 | * start reading from start_offset | |
198 | * finish reading upon magic of value 0 or when end_offset reached | |
199 | * unknown magic is skipped (future extension this version knows nothing about) | |
200 | * return 0 upon success, non-0 otherwise | |
201 | */ | |
7c80ab3f | 202 | static int qcow2_read_extensions(BlockDriverState *bs, uint64_t start_offset, |
3ef6c40a | 203 | uint64_t end_offset, void **p_feature_table, |
88ddffae VSO |
204 | int flags, bool *need_update_header, |
205 | Error **errp) | |
9b80ddf3 | 206 | { |
ff99129a | 207 | BDRVQcow2State *s = bs->opaque; |
9b80ddf3 AL |
208 | QCowExtension ext; |
209 | uint64_t offset; | |
75bab85c | 210 | int ret; |
88ddffae VSO |
211 | Qcow2BitmapHeaderExt bitmaps_ext; |
212 | ||
213 | if (need_update_header != NULL) { | |
214 | *need_update_header = false; | |
215 | } | |
9b80ddf3 AL |
216 | |
217 | #ifdef DEBUG_EXT | |
7c80ab3f | 218 | printf("qcow2_read_extensions: start=%ld end=%ld\n", start_offset, end_offset); |
9b80ddf3 AL |
219 | #endif |
220 | offset = start_offset; | |
221 | while (offset < end_offset) { | |
222 | ||
223 | #ifdef DEBUG_EXT | |
224 | /* Sanity check */ | |
225 | if (offset > s->cluster_size) | |
7c80ab3f | 226 | printf("qcow2_read_extension: suspicious offset %lu\n", offset); |
9b80ddf3 | 227 | |
9b2260cb | 228 | printf("attempting to read extended header in offset %lu\n", offset); |
9b80ddf3 AL |
229 | #endif |
230 | ||
32cc71de | 231 | ret = bdrv_pread(bs->file, offset, sizeof(ext), &ext, 0); |
3ef6c40a HR |
232 | if (ret < 0) { |
233 | error_setg_errno(errp, -ret, "qcow2_read_extension: ERROR: " | |
234 | "pread fail from offset %" PRIu64, offset); | |
9b80ddf3 AL |
235 | return 1; |
236 | } | |
3b698f52 PM |
237 | ext.magic = be32_to_cpu(ext.magic); |
238 | ext.len = be32_to_cpu(ext.len); | |
9b80ddf3 AL |
239 | offset += sizeof(ext); |
240 | #ifdef DEBUG_EXT | |
241 | printf("ext.magic = 0x%x\n", ext.magic); | |
242 | #endif | |
2ebafc85 | 243 | if (offset > end_offset || ext.len > end_offset - offset) { |
3ef6c40a | 244 | error_setg(errp, "Header extension too large"); |
64ca6aee KW |
245 | return -EINVAL; |
246 | } | |
247 | ||
9b80ddf3 | 248 | switch (ext.magic) { |
7c80ab3f | 249 | case QCOW2_EXT_MAGIC_END: |
9b80ddf3 | 250 | return 0; |
f965509c | 251 | |
7c80ab3f | 252 | case QCOW2_EXT_MAGIC_BACKING_FORMAT: |
f965509c | 253 | if (ext.len >= sizeof(bs->backing_format)) { |
521b2b5d HR |
254 | error_setg(errp, "ERROR: ext_backing_format: len=%" PRIu32 |
255 | " too large (>=%zu)", ext.len, | |
256 | sizeof(bs->backing_format)); | |
f965509c AL |
257 | return 2; |
258 | } | |
32cc71de | 259 | ret = bdrv_pread(bs->file, offset, ext.len, bs->backing_format, 0); |
3ef6c40a HR |
260 | if (ret < 0) { |
261 | error_setg_errno(errp, -ret, "ERROR: ext_backing_format: " | |
262 | "Could not read format name"); | |
f965509c | 263 | return 3; |
3ef6c40a | 264 | } |
f965509c | 265 | bs->backing_format[ext.len] = '\0'; |
e4603fe1 | 266 | s->image_backing_format = g_strdup(bs->backing_format); |
f965509c AL |
267 | #ifdef DEBUG_EXT |
268 | printf("Qcow2: Got format extension %s\n", bs->backing_format); | |
269 | #endif | |
f965509c AL |
270 | break; |
271 | ||
cfcc4c62 KW |
272 | case QCOW2_EXT_MAGIC_FEATURE_TABLE: |
273 | if (p_feature_table != NULL) { | |
5f14f31d | 274 | void *feature_table = g_malloc0(ext.len + 2 * sizeof(Qcow2Feature)); |
32cc71de | 275 | ret = bdrv_pread(bs->file, offset, ext.len, feature_table, 0); |
cfcc4c62 | 276 | if (ret < 0) { |
3ef6c40a HR |
277 | error_setg_errno(errp, -ret, "ERROR: ext_feature_table: " |
278 | "Could not read table"); | |
38f034e7 | 279 | g_free(feature_table); |
cfcc4c62 KW |
280 | return ret; |
281 | } | |
282 | ||
283 | *p_feature_table = feature_table; | |
284 | } | |
285 | break; | |
286 | ||
4652b8f3 DB |
287 | case QCOW2_EXT_MAGIC_CRYPTO_HEADER: { |
288 | unsigned int cflags = 0; | |
289 | if (s->crypt_method_header != QCOW_CRYPT_LUKS) { | |
290 | error_setg(errp, "CRYPTO header extension only " | |
291 | "expected with LUKS encryption method"); | |
292 | return -EINVAL; | |
293 | } | |
294 | if (ext.len != sizeof(Qcow2CryptoHeaderExtension)) { | |
295 | error_setg(errp, "CRYPTO header extension size %u, " | |
296 | "but expected size %zu", ext.len, | |
297 | sizeof(Qcow2CryptoHeaderExtension)); | |
298 | return -EINVAL; | |
299 | } | |
300 | ||
32cc71de | 301 | ret = bdrv_pread(bs->file, offset, ext.len, &s->crypto_header, 0); |
4652b8f3 DB |
302 | if (ret < 0) { |
303 | error_setg_errno(errp, -ret, | |
304 | "Unable to read CRYPTO header extension"); | |
305 | return ret; | |
306 | } | |
3b698f52 PM |
307 | s->crypto_header.offset = be64_to_cpu(s->crypto_header.offset); |
308 | s->crypto_header.length = be64_to_cpu(s->crypto_header.length); | |
4652b8f3 DB |
309 | |
310 | if ((s->crypto_header.offset % s->cluster_size) != 0) { | |
311 | error_setg(errp, "Encryption header offset '%" PRIu64 "' is " | |
312 | "not a multiple of cluster size '%u'", | |
313 | s->crypto_header.offset, s->cluster_size); | |
314 | return -EINVAL; | |
315 | } | |
316 | ||
317 | if (flags & BDRV_O_NO_IO) { | |
318 | cflags |= QCRYPTO_BLOCK_OPEN_NO_IO; | |
319 | } | |
1cd9a787 | 320 | s->crypto = qcrypto_block_open(s->crypto_opts, "encrypt.", |
4652b8f3 | 321 | qcow2_crypto_hdr_read_func, |
8ac0f15f | 322 | bs, cflags, QCOW2_MAX_THREADS, errp); |
4652b8f3 DB |
323 | if (!s->crypto) { |
324 | return -EINVAL; | |
325 | } | |
326 | } break; | |
327 | ||
88ddffae VSO |
328 | case QCOW2_EXT_MAGIC_BITMAPS: |
329 | if (ext.len != sizeof(bitmaps_ext)) { | |
330 | error_setg_errno(errp, -ret, "bitmaps_ext: " | |
331 | "Invalid extension length"); | |
332 | return -EINVAL; | |
333 | } | |
334 | ||
335 | if (!(s->autoclear_features & QCOW2_AUTOCLEAR_BITMAPS)) { | |
c9ceb3ec HR |
336 | if (s->qcow_version < 3) { |
337 | /* Let's be a bit more specific */ | |
338 | warn_report("This qcow2 v2 image contains bitmaps, but " | |
339 | "they may have been modified by a program " | |
340 | "without persistent bitmap support; so now " | |
341 | "they must all be considered inconsistent"); | |
342 | } else { | |
343 | warn_report("a program lacking bitmap support " | |
344 | "modified this file, so all bitmaps are now " | |
345 | "considered inconsistent"); | |
346 | } | |
55d527a9 AF |
347 | error_printf("Some clusters may be leaked, " |
348 | "run 'qemu-img check -r' on the image " | |
88ddffae VSO |
349 | "file to fix."); |
350 | if (need_update_header != NULL) { | |
351 | /* Updating is needed to drop invalid bitmap extension. */ | |
352 | *need_update_header = true; | |
353 | } | |
354 | break; | |
355 | } | |
356 | ||
32cc71de | 357 | ret = bdrv_pread(bs->file, offset, ext.len, &bitmaps_ext, 0); |
88ddffae VSO |
358 | if (ret < 0) { |
359 | error_setg_errno(errp, -ret, "bitmaps_ext: " | |
360 | "Could not read ext header"); | |
361 | return ret; | |
362 | } | |
363 | ||
364 | if (bitmaps_ext.reserved32 != 0) { | |
365 | error_setg_errno(errp, -ret, "bitmaps_ext: " | |
366 | "Reserved field is not zero"); | |
367 | return -EINVAL; | |
368 | } | |
369 | ||
3b698f52 PM |
370 | bitmaps_ext.nb_bitmaps = be32_to_cpu(bitmaps_ext.nb_bitmaps); |
371 | bitmaps_ext.bitmap_directory_size = | |
372 | be64_to_cpu(bitmaps_ext.bitmap_directory_size); | |
373 | bitmaps_ext.bitmap_directory_offset = | |
374 | be64_to_cpu(bitmaps_ext.bitmap_directory_offset); | |
88ddffae VSO |
375 | |
376 | if (bitmaps_ext.nb_bitmaps > QCOW2_MAX_BITMAPS) { | |
377 | error_setg(errp, | |
378 | "bitmaps_ext: Image has %" PRIu32 " bitmaps, " | |
379 | "exceeding the QEMU supported maximum of %d", | |
380 | bitmaps_ext.nb_bitmaps, QCOW2_MAX_BITMAPS); | |
381 | return -EINVAL; | |
382 | } | |
383 | ||
384 | if (bitmaps_ext.nb_bitmaps == 0) { | |
385 | error_setg(errp, "found bitmaps extension with zero bitmaps"); | |
386 | return -EINVAL; | |
387 | } | |
388 | ||
74e60fb5 | 389 | if (offset_into_cluster(s, bitmaps_ext.bitmap_directory_offset)) { |
88ddffae VSO |
390 | error_setg(errp, "bitmaps_ext: " |
391 | "invalid bitmap directory offset"); | |
392 | return -EINVAL; | |
393 | } | |
394 | ||
395 | if (bitmaps_ext.bitmap_directory_size > | |
396 | QCOW2_MAX_BITMAP_DIRECTORY_SIZE) { | |
397 | error_setg(errp, "bitmaps_ext: " | |
398 | "bitmap directory size (%" PRIu64 ") exceeds " | |
399 | "the maximum supported size (%d)", | |
400 | bitmaps_ext.bitmap_directory_size, | |
401 | QCOW2_MAX_BITMAP_DIRECTORY_SIZE); | |
402 | return -EINVAL; | |
403 | } | |
404 | ||
405 | s->nb_bitmaps = bitmaps_ext.nb_bitmaps; | |
406 | s->bitmap_directory_offset = | |
407 | bitmaps_ext.bitmap_directory_offset; | |
408 | s->bitmap_directory_size = | |
409 | bitmaps_ext.bitmap_directory_size; | |
410 | ||
411 | #ifdef DEBUG_EXT | |
412 | printf("Qcow2: Got bitmaps extension: " | |
413 | "offset=%" PRIu64 " nb_bitmaps=%" PRIu32 "\n", | |
414 | s->bitmap_directory_offset, s->nb_bitmaps); | |
415 | #endif | |
416 | break; | |
417 | ||
9b890bdc KW |
418 | case QCOW2_EXT_MAGIC_DATA_FILE: |
419 | { | |
420 | s->image_data_file = g_malloc0(ext.len + 1); | |
32cc71de | 421 | ret = bdrv_pread(bs->file, offset, ext.len, s->image_data_file, 0); |
9b890bdc KW |
422 | if (ret < 0) { |
423 | error_setg_errno(errp, -ret, | |
424 | "ERROR: Could not read data file name"); | |
425 | return ret; | |
426 | } | |
427 | #ifdef DEBUG_EXT | |
428 | printf("Qcow2: Got external data file %s\n", s->image_data_file); | |
429 | #endif | |
430 | break; | |
431 | } | |
432 | ||
9b80ddf3 | 433 | default: |
75bab85c | 434 | /* unknown magic - save it in case we need to rewrite the header */ |
4096974e EB |
435 | /* If you add a new feature, make sure to also update the fast |
436 | * path of qcow2_make_empty() to deal with it. */ | |
75bab85c KW |
437 | { |
438 | Qcow2UnknownHeaderExtension *uext; | |
439 | ||
440 | uext = g_malloc0(sizeof(*uext) + ext.len); | |
441 | uext->magic = ext.magic; | |
442 | uext->len = ext.len; | |
443 | QLIST_INSERT_HEAD(&s->unknown_header_ext, uext, next); | |
444 | ||
32cc71de | 445 | ret = bdrv_pread(bs->file, offset, uext->len, uext->data, 0); |
75bab85c | 446 | if (ret < 0) { |
3ef6c40a HR |
447 | error_setg_errno(errp, -ret, "ERROR: unknown extension: " |
448 | "Could not read data"); | |
75bab85c KW |
449 | return ret; |
450 | } | |
75bab85c | 451 | } |
9b80ddf3 AL |
452 | break; |
453 | } | |
fd29b4bb KW |
454 | |
455 | offset += ((ext.len + 7) & ~7); | |
9b80ddf3 AL |
456 | } |
457 | ||
458 | return 0; | |
459 | } | |
460 | ||
75bab85c KW |
461 | static void cleanup_unknown_header_ext(BlockDriverState *bs) |
462 | { | |
ff99129a | 463 | BDRVQcow2State *s = bs->opaque; |
75bab85c KW |
464 | Qcow2UnknownHeaderExtension *uext, *next; |
465 | ||
466 | QLIST_FOREACH_SAFE(uext, &s->unknown_header_ext, next, next) { | |
467 | QLIST_REMOVE(uext, next); | |
468 | g_free(uext); | |
469 | } | |
470 | } | |
9b80ddf3 | 471 | |
a55448b3 HR |
472 | static void report_unsupported_feature(Error **errp, Qcow2Feature *table, |
473 | uint64_t mask) | |
cfcc4c62 | 474 | { |
7cdca2e2 | 475 | g_autoptr(GString) features = g_string_sized_new(60); |
12ac6d3d | 476 | |
cfcc4c62 KW |
477 | while (table && table->name[0] != '\0') { |
478 | if (table->type == QCOW2_FEAT_TYPE_INCOMPATIBLE) { | |
12ac6d3d | 479 | if (mask & (1ULL << table->bit)) { |
7cdca2e2 AG |
480 | if (features->len > 0) { |
481 | g_string_append(features, ", "); | |
482 | } | |
483 | g_string_append_printf(features, "%.46s", table->name); | |
12ac6d3d | 484 | mask &= ~(1ULL << table->bit); |
cfcc4c62 KW |
485 | } |
486 | } | |
487 | table++; | |
488 | } | |
489 | ||
490 | if (mask) { | |
7cdca2e2 AG |
491 | if (features->len > 0) { |
492 | g_string_append(features, ", "); | |
493 | } | |
494 | g_string_append_printf(features, | |
495 | "Unknown incompatible feature: %" PRIx64, mask); | |
cfcc4c62 | 496 | } |
12ac6d3d | 497 | |
7cdca2e2 | 498 | error_setg(errp, "Unsupported qcow2 feature(s): %s", features->str); |
cfcc4c62 KW |
499 | } |
500 | ||
bfe8043e SH |
501 | /* |
502 | * Sets the dirty bit and flushes afterwards if necessary. | |
503 | * | |
504 | * The incompatible_features bit is only set if the image file header was | |
505 | * updated successfully. Therefore it is not required to check the return | |
506 | * value of this function. | |
507 | */ | |
280d3735 | 508 | int qcow2_mark_dirty(BlockDriverState *bs) |
bfe8043e | 509 | { |
ff99129a | 510 | BDRVQcow2State *s = bs->opaque; |
bfe8043e SH |
511 | uint64_t val; |
512 | int ret; | |
513 | ||
514 | assert(s->qcow_version >= 3); | |
515 | ||
516 | if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) { | |
517 | return 0; /* already dirty */ | |
518 | } | |
519 | ||
520 | val = cpu_to_be64(s->incompatible_features | QCOW2_INCOMPAT_DIRTY); | |
86da4322 AF |
521 | ret = bdrv_pwrite_sync(bs->file, |
522 | offsetof(QCowHeader, incompatible_features), | |
523 | sizeof(val), &val, 0); | |
bfe8043e SH |
524 | if (ret < 0) { |
525 | return ret; | |
526 | } | |
527 | ||
528 | /* Only treat image as dirty if the header was updated successfully */ | |
529 | s->incompatible_features |= QCOW2_INCOMPAT_DIRTY; | |
530 | return 0; | |
531 | } | |
532 | ||
c61d0004 SH |
533 | /* |
534 | * Clears the dirty bit and flushes before if necessary. Only call this | |
535 | * function when there are no pending requests, it does not guard against | |
536 | * concurrent requests dirtying the image. | |
537 | */ | |
538 | static int qcow2_mark_clean(BlockDriverState *bs) | |
539 | { | |
ff99129a | 540 | BDRVQcow2State *s = bs->opaque; |
c61d0004 SH |
541 | |
542 | if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) { | |
4c2e5f8f KW |
543 | int ret; |
544 | ||
545 | s->incompatible_features &= ~QCOW2_INCOMPAT_DIRTY; | |
546 | ||
8b220eb7 | 547 | ret = qcow2_flush_caches(bs); |
c61d0004 SH |
548 | if (ret < 0) { |
549 | return ret; | |
550 | } | |
551 | ||
c61d0004 SH |
552 | return qcow2_update_header(bs); |
553 | } | |
554 | return 0; | |
555 | } | |
556 | ||
69c98726 HR |
557 | /* |
558 | * Marks the image as corrupt. | |
559 | */ | |
560 | int qcow2_mark_corrupt(BlockDriverState *bs) | |
561 | { | |
ff99129a | 562 | BDRVQcow2State *s = bs->opaque; |
69c98726 HR |
563 | |
564 | s->incompatible_features |= QCOW2_INCOMPAT_CORRUPT; | |
565 | return qcow2_update_header(bs); | |
566 | } | |
567 | ||
568 | /* | |
569 | * Marks the image as consistent, i.e., unsets the corrupt bit, and flushes | |
570 | * before if necessary. | |
571 | */ | |
572 | int qcow2_mark_consistent(BlockDriverState *bs) | |
573 | { | |
ff99129a | 574 | BDRVQcow2State *s = bs->opaque; |
69c98726 HR |
575 | |
576 | if (s->incompatible_features & QCOW2_INCOMPAT_CORRUPT) { | |
8b220eb7 | 577 | int ret = qcow2_flush_caches(bs); |
69c98726 HR |
578 | if (ret < 0) { |
579 | return ret; | |
580 | } | |
581 | ||
582 | s->incompatible_features &= ~QCOW2_INCOMPAT_CORRUPT; | |
583 | return qcow2_update_header(bs); | |
584 | } | |
585 | return 0; | |
586 | } | |
587 | ||
8bc584fe HR |
588 | static void qcow2_add_check_result(BdrvCheckResult *out, |
589 | const BdrvCheckResult *src, | |
590 | bool set_allocation_info) | |
591 | { | |
592 | out->corruptions += src->corruptions; | |
593 | out->leaks += src->leaks; | |
594 | out->check_errors += src->check_errors; | |
595 | out->corruptions_fixed += src->corruptions_fixed; | |
596 | out->leaks_fixed += src->leaks_fixed; | |
597 | ||
598 | if (set_allocation_info) { | |
599 | out->image_end_offset = src->image_end_offset; | |
600 | out->bfi = src->bfi; | |
601 | } | |
602 | } | |
603 | ||
2fd61638 PB |
604 | static int coroutine_fn qcow2_co_check_locked(BlockDriverState *bs, |
605 | BdrvCheckResult *result, | |
606 | BdrvCheckMode fix) | |
acbe5982 | 607 | { |
8bc584fe HR |
608 | BdrvCheckResult snapshot_res = {}; |
609 | BdrvCheckResult refcount_res = {}; | |
610 | int ret; | |
611 | ||
612 | memset(result, 0, sizeof(*result)); | |
613 | ||
614 | ret = qcow2_check_read_snapshot_table(bs, &snapshot_res, fix); | |
8bc584fe | 615 | if (ret < 0) { |
fe446b5d | 616 | qcow2_add_check_result(result, &snapshot_res, false); |
8bc584fe HR |
617 | return ret; |
618 | } | |
619 | ||
620 | ret = qcow2_check_refcounts(bs, &refcount_res, fix); | |
621 | qcow2_add_check_result(result, &refcount_res, true); | |
fe446b5d HR |
622 | if (ret < 0) { |
623 | qcow2_add_check_result(result, &snapshot_res, false); | |
624 | return ret; | |
625 | } | |
626 | ||
627 | ret = qcow2_check_fix_snapshot_table(bs, &snapshot_res, fix); | |
628 | qcow2_add_check_result(result, &snapshot_res, false); | |
acbe5982 SH |
629 | if (ret < 0) { |
630 | return ret; | |
631 | } | |
632 | ||
633 | if (fix && result->check_errors == 0 && result->corruptions == 0) { | |
24530f3e HR |
634 | ret = qcow2_mark_clean(bs); |
635 | if (ret < 0) { | |
636 | return ret; | |
637 | } | |
638 | return qcow2_mark_consistent(bs); | |
acbe5982 SH |
639 | } |
640 | return ret; | |
641 | } | |
642 | ||
2fd61638 PB |
643 | static int coroutine_fn qcow2_co_check(BlockDriverState *bs, |
644 | BdrvCheckResult *result, | |
645 | BdrvCheckMode fix) | |
646 | { | |
647 | BDRVQcow2State *s = bs->opaque; | |
648 | int ret; | |
649 | ||
650 | qemu_co_mutex_lock(&s->lock); | |
651 | ret = qcow2_co_check_locked(bs, result, fix); | |
652 | qemu_co_mutex_unlock(&s->lock); | |
653 | return ret; | |
654 | } | |
655 | ||
0cf0e598 AG |
656 | int qcow2_validate_table(BlockDriverState *bs, uint64_t offset, |
657 | uint64_t entries, size_t entry_len, | |
658 | int64_t max_size_bytes, const char *table_name, | |
659 | Error **errp) | |
8c7de283 | 660 | { |
ff99129a | 661 | BDRVQcow2State *s = bs->opaque; |
8c7de283 | 662 | |
0cf0e598 AG |
663 | if (entries > max_size_bytes / entry_len) { |
664 | error_setg(errp, "%s too large", table_name); | |
665 | return -EFBIG; | |
8c7de283 KW |
666 | } |
667 | ||
0cf0e598 AG |
668 | /* Use signed INT64_MAX as the maximum even for uint64_t header fields, |
669 | * because values will be passed to qemu functions taking int64_t. */ | |
670 | if ((INT64_MAX - entries * entry_len < offset) || | |
671 | (offset_into_cluster(s, offset) != 0)) { | |
672 | error_setg(errp, "%s offset invalid", table_name); | |
8c7de283 KW |
673 | return -EINVAL; |
674 | } | |
675 | ||
676 | return 0; | |
677 | } | |
678 | ||
8a2ce0bc AG |
679 | static const char *const mutable_opts[] = { |
680 | QCOW2_OPT_LAZY_REFCOUNTS, | |
681 | QCOW2_OPT_DISCARD_REQUEST, | |
682 | QCOW2_OPT_DISCARD_SNAPSHOT, | |
683 | QCOW2_OPT_DISCARD_OTHER, | |
684 | QCOW2_OPT_OVERLAP, | |
685 | QCOW2_OPT_OVERLAP_TEMPLATE, | |
686 | QCOW2_OPT_OVERLAP_MAIN_HEADER, | |
687 | QCOW2_OPT_OVERLAP_ACTIVE_L1, | |
688 | QCOW2_OPT_OVERLAP_ACTIVE_L2, | |
689 | QCOW2_OPT_OVERLAP_REFCOUNT_TABLE, | |
690 | QCOW2_OPT_OVERLAP_REFCOUNT_BLOCK, | |
691 | QCOW2_OPT_OVERLAP_SNAPSHOT_TABLE, | |
692 | QCOW2_OPT_OVERLAP_INACTIVE_L1, | |
693 | QCOW2_OPT_OVERLAP_INACTIVE_L2, | |
694 | QCOW2_OPT_OVERLAP_BITMAP_DIRECTORY, | |
695 | QCOW2_OPT_CACHE_SIZE, | |
696 | QCOW2_OPT_L2_CACHE_SIZE, | |
697 | QCOW2_OPT_L2_CACHE_ENTRY_SIZE, | |
698 | QCOW2_OPT_REFCOUNT_CACHE_SIZE, | |
699 | QCOW2_OPT_CACHE_CLEAN_INTERVAL, | |
700 | NULL | |
701 | }; | |
702 | ||
74c4510a KW |
703 | static QemuOptsList qcow2_runtime_opts = { |
704 | .name = "qcow2", | |
705 | .head = QTAILQ_HEAD_INITIALIZER(qcow2_runtime_opts.head), | |
706 | .desc = { | |
707 | { | |
64aa99d3 | 708 | .name = QCOW2_OPT_LAZY_REFCOUNTS, |
74c4510a KW |
709 | .type = QEMU_OPT_BOOL, |
710 | .help = "Postpone refcount updates", | |
711 | }, | |
67af674e KW |
712 | { |
713 | .name = QCOW2_OPT_DISCARD_REQUEST, | |
714 | .type = QEMU_OPT_BOOL, | |
715 | .help = "Pass guest discard requests to the layer below", | |
716 | }, | |
717 | { | |
718 | .name = QCOW2_OPT_DISCARD_SNAPSHOT, | |
719 | .type = QEMU_OPT_BOOL, | |
720 | .help = "Generate discard requests when snapshot related space " | |
721 | "is freed", | |
722 | }, | |
723 | { | |
724 | .name = QCOW2_OPT_DISCARD_OTHER, | |
725 | .type = QEMU_OPT_BOOL, | |
726 | .help = "Generate discard requests when other clusters are freed", | |
727 | }, | |
05de7e86 HR |
728 | { |
729 | .name = QCOW2_OPT_OVERLAP, | |
730 | .type = QEMU_OPT_STRING, | |
731 | .help = "Selects which overlap checks to perform from a range of " | |
732 | "templates (none, constant, cached, all)", | |
733 | }, | |
ee42b5ce HR |
734 | { |
735 | .name = QCOW2_OPT_OVERLAP_TEMPLATE, | |
736 | .type = QEMU_OPT_STRING, | |
737 | .help = "Selects which overlap checks to perform from a range of " | |
738 | "templates (none, constant, cached, all)", | |
739 | }, | |
05de7e86 HR |
740 | { |
741 | .name = QCOW2_OPT_OVERLAP_MAIN_HEADER, | |
742 | .type = QEMU_OPT_BOOL, | |
743 | .help = "Check for unintended writes into the main qcow2 header", | |
744 | }, | |
745 | { | |
746 | .name = QCOW2_OPT_OVERLAP_ACTIVE_L1, | |
747 | .type = QEMU_OPT_BOOL, | |
748 | .help = "Check for unintended writes into the active L1 table", | |
749 | }, | |
750 | { | |
751 | .name = QCOW2_OPT_OVERLAP_ACTIVE_L2, | |
752 | .type = QEMU_OPT_BOOL, | |
753 | .help = "Check for unintended writes into an active L2 table", | |
754 | }, | |
755 | { | |
756 | .name = QCOW2_OPT_OVERLAP_REFCOUNT_TABLE, | |
757 | .type = QEMU_OPT_BOOL, | |
758 | .help = "Check for unintended writes into the refcount table", | |
759 | }, | |
760 | { | |
761 | .name = QCOW2_OPT_OVERLAP_REFCOUNT_BLOCK, | |
762 | .type = QEMU_OPT_BOOL, | |
763 | .help = "Check for unintended writes into a refcount block", | |
764 | }, | |
765 | { | |
766 | .name = QCOW2_OPT_OVERLAP_SNAPSHOT_TABLE, | |
767 | .type = QEMU_OPT_BOOL, | |
768 | .help = "Check for unintended writes into the snapshot table", | |
769 | }, | |
770 | { | |
771 | .name = QCOW2_OPT_OVERLAP_INACTIVE_L1, | |
772 | .type = QEMU_OPT_BOOL, | |
773 | .help = "Check for unintended writes into an inactive L1 table", | |
774 | }, | |
775 | { | |
776 | .name = QCOW2_OPT_OVERLAP_INACTIVE_L2, | |
777 | .type = QEMU_OPT_BOOL, | |
778 | .help = "Check for unintended writes into an inactive L2 table", | |
779 | }, | |
0e4e4318 VSO |
780 | { |
781 | .name = QCOW2_OPT_OVERLAP_BITMAP_DIRECTORY, | |
782 | .type = QEMU_OPT_BOOL, | |
783 | .help = "Check for unintended writes into the bitmap directory", | |
784 | }, | |
6c1c8d5d HR |
785 | { |
786 | .name = QCOW2_OPT_CACHE_SIZE, | |
787 | .type = QEMU_OPT_SIZE, | |
788 | .help = "Maximum combined metadata (L2 tables and refcount blocks) " | |
789 | "cache size", | |
790 | }, | |
791 | { | |
792 | .name = QCOW2_OPT_L2_CACHE_SIZE, | |
793 | .type = QEMU_OPT_SIZE, | |
794 | .help = "Maximum L2 table cache size", | |
795 | }, | |
1221fe6f AG |
796 | { |
797 | .name = QCOW2_OPT_L2_CACHE_ENTRY_SIZE, | |
798 | .type = QEMU_OPT_SIZE, | |
799 | .help = "Size of each entry in the L2 cache", | |
800 | }, | |
6c1c8d5d HR |
801 | { |
802 | .name = QCOW2_OPT_REFCOUNT_CACHE_SIZE, | |
803 | .type = QEMU_OPT_SIZE, | |
804 | .help = "Maximum refcount block cache size", | |
805 | }, | |
279621c0 AG |
806 | { |
807 | .name = QCOW2_OPT_CACHE_CLEAN_INTERVAL, | |
808 | .type = QEMU_OPT_NUMBER, | |
809 | .help = "Clean unused cache entries after this time (in seconds)", | |
810 | }, | |
4652b8f3 DB |
811 | BLOCK_CRYPTO_OPT_DEF_KEY_SECRET("encrypt.", |
812 | "ID of secret providing qcow2 AES key or LUKS passphrase"), | |
74c4510a KW |
813 | { /* end of list */ } |
814 | }, | |
815 | }; | |
816 | ||
4092e99d | 817 | static const char *overlap_bool_option_names[QCOW2_OL_MAX_BITNR] = { |
0e4e4318 VSO |
818 | [QCOW2_OL_MAIN_HEADER_BITNR] = QCOW2_OPT_OVERLAP_MAIN_HEADER, |
819 | [QCOW2_OL_ACTIVE_L1_BITNR] = QCOW2_OPT_OVERLAP_ACTIVE_L1, | |
820 | [QCOW2_OL_ACTIVE_L2_BITNR] = QCOW2_OPT_OVERLAP_ACTIVE_L2, | |
821 | [QCOW2_OL_REFCOUNT_TABLE_BITNR] = QCOW2_OPT_OVERLAP_REFCOUNT_TABLE, | |
822 | [QCOW2_OL_REFCOUNT_BLOCK_BITNR] = QCOW2_OPT_OVERLAP_REFCOUNT_BLOCK, | |
823 | [QCOW2_OL_SNAPSHOT_TABLE_BITNR] = QCOW2_OPT_OVERLAP_SNAPSHOT_TABLE, | |
824 | [QCOW2_OL_INACTIVE_L1_BITNR] = QCOW2_OPT_OVERLAP_INACTIVE_L1, | |
825 | [QCOW2_OL_INACTIVE_L2_BITNR] = QCOW2_OPT_OVERLAP_INACTIVE_L2, | |
826 | [QCOW2_OL_BITMAP_DIRECTORY_BITNR] = QCOW2_OPT_OVERLAP_BITMAP_DIRECTORY, | |
4092e99d HR |
827 | }; |
828 | ||
279621c0 AG |
829 | static void cache_clean_timer_cb(void *opaque) |
830 | { | |
831 | BlockDriverState *bs = opaque; | |
ff99129a | 832 | BDRVQcow2State *s = bs->opaque; |
b2f68bff AG |
833 | qcow2_cache_clean_unused(s->l2_table_cache); |
834 | qcow2_cache_clean_unused(s->refcount_block_cache); | |
279621c0 AG |
835 | timer_mod(s->cache_clean_timer, qemu_clock_get_ms(QEMU_CLOCK_VIRTUAL) + |
836 | (int64_t) s->cache_clean_interval * 1000); | |
837 | } | |
838 | ||
839 | static void cache_clean_timer_init(BlockDriverState *bs, AioContext *context) | |
840 | { | |
ff99129a | 841 | BDRVQcow2State *s = bs->opaque; |
279621c0 | 842 | if (s->cache_clean_interval > 0) { |
ad0ce642 PD |
843 | s->cache_clean_timer = |
844 | aio_timer_new_with_attrs(context, QEMU_CLOCK_VIRTUAL, | |
845 | SCALE_MS, QEMU_TIMER_ATTR_EXTERNAL, | |
846 | cache_clean_timer_cb, bs); | |
279621c0 AG |
847 | timer_mod(s->cache_clean_timer, qemu_clock_get_ms(QEMU_CLOCK_VIRTUAL) + |
848 | (int64_t) s->cache_clean_interval * 1000); | |
849 | } | |
850 | } | |
851 | ||
852 | static void cache_clean_timer_del(BlockDriverState *bs) | |
853 | { | |
ff99129a | 854 | BDRVQcow2State *s = bs->opaque; |
279621c0 | 855 | if (s->cache_clean_timer) { |
279621c0 AG |
856 | timer_free(s->cache_clean_timer); |
857 | s->cache_clean_timer = NULL; | |
858 | } | |
859 | } | |
860 | ||
861 | static void qcow2_detach_aio_context(BlockDriverState *bs) | |
862 | { | |
863 | cache_clean_timer_del(bs); | |
864 | } | |
865 | ||
866 | static void qcow2_attach_aio_context(BlockDriverState *bs, | |
867 | AioContext *new_context) | |
868 | { | |
869 | cache_clean_timer_init(bs, new_context); | |
870 | } | |
871 | ||
772c4cad | 872 | static bool read_cache_sizes(BlockDriverState *bs, QemuOpts *opts, |
bc85ef26 | 873 | uint64_t *l2_cache_size, |
1221fe6f | 874 | uint64_t *l2_cache_entry_size, |
6c1c8d5d HR |
875 | uint64_t *refcount_cache_size, Error **errp) |
876 | { | |
ff99129a | 877 | BDRVQcow2State *s = bs->opaque; |
b749562d | 878 | uint64_t combined_cache_size, l2_cache_max_setting; |
6c1c8d5d | 879 | bool l2_cache_size_set, refcount_cache_size_set, combined_cache_size_set; |
af39bd0d | 880 | bool l2_cache_entry_size_set; |
7af5eea9 | 881 | int min_refcount_cache = MIN_REFCOUNT_CACHE_SIZE * s->cluster_size; |
b749562d | 882 | uint64_t virtual_disk_size = bs->total_sectors * BDRV_SECTOR_SIZE; |
b70d0820 AG |
883 | uint64_t max_l2_entries = DIV_ROUND_UP(virtual_disk_size, s->cluster_size); |
884 | /* An L2 table is always one cluster in size so the max cache size | |
885 | * should be a multiple of the cluster size. */ | |
c8fd8554 | 886 | uint64_t max_l2_cache = ROUND_UP(max_l2_entries * l2_entry_size(s), |
b70d0820 | 887 | s->cluster_size); |
6c1c8d5d HR |
888 | |
889 | combined_cache_size_set = qemu_opt_get(opts, QCOW2_OPT_CACHE_SIZE); | |
890 | l2_cache_size_set = qemu_opt_get(opts, QCOW2_OPT_L2_CACHE_SIZE); | |
891 | refcount_cache_size_set = qemu_opt_get(opts, QCOW2_OPT_REFCOUNT_CACHE_SIZE); | |
af39bd0d | 892 | l2_cache_entry_size_set = qemu_opt_get(opts, QCOW2_OPT_L2_CACHE_ENTRY_SIZE); |
6c1c8d5d HR |
893 | |
894 | combined_cache_size = qemu_opt_get_size(opts, QCOW2_OPT_CACHE_SIZE, 0); | |
b749562d LB |
895 | l2_cache_max_setting = qemu_opt_get_size(opts, QCOW2_OPT_L2_CACHE_SIZE, |
896 | DEFAULT_L2_CACHE_MAX_SIZE); | |
6c1c8d5d HR |
897 | *refcount_cache_size = qemu_opt_get_size(opts, |
898 | QCOW2_OPT_REFCOUNT_CACHE_SIZE, 0); | |
899 | ||
1221fe6f AG |
900 | *l2_cache_entry_size = qemu_opt_get_size( |
901 | opts, QCOW2_OPT_L2_CACHE_ENTRY_SIZE, s->cluster_size); | |
902 | ||
b749562d LB |
903 | *l2_cache_size = MIN(max_l2_cache, l2_cache_max_setting); |
904 | ||
6c1c8d5d HR |
905 | if (combined_cache_size_set) { |
906 | if (l2_cache_size_set && refcount_cache_size_set) { | |
907 | error_setg(errp, QCOW2_OPT_CACHE_SIZE ", " QCOW2_OPT_L2_CACHE_SIZE | |
908 | " and " QCOW2_OPT_REFCOUNT_CACHE_SIZE " may not be set " | |
308999e9 | 909 | "at the same time"); |
772c4cad | 910 | return false; |
b749562d LB |
911 | } else if (l2_cache_size_set && |
912 | (l2_cache_max_setting > combined_cache_size)) { | |
6c1c8d5d HR |
913 | error_setg(errp, QCOW2_OPT_L2_CACHE_SIZE " may not exceed " |
914 | QCOW2_OPT_CACHE_SIZE); | |
772c4cad | 915 | return false; |
6c1c8d5d HR |
916 | } else if (*refcount_cache_size > combined_cache_size) { |
917 | error_setg(errp, QCOW2_OPT_REFCOUNT_CACHE_SIZE " may not exceed " | |
918 | QCOW2_OPT_CACHE_SIZE); | |
772c4cad | 919 | return false; |
6c1c8d5d HR |
920 | } |
921 | ||
922 | if (l2_cache_size_set) { | |
923 | *refcount_cache_size = combined_cache_size - *l2_cache_size; | |
924 | } else if (refcount_cache_size_set) { | |
925 | *l2_cache_size = combined_cache_size - *refcount_cache_size; | |
926 | } else { | |
52253998 AG |
927 | /* Assign as much memory as possible to the L2 cache, and |
928 | * use the remainder for the refcount cache */ | |
929 | if (combined_cache_size >= max_l2_cache + min_refcount_cache) { | |
930 | *l2_cache_size = max_l2_cache; | |
931 | *refcount_cache_size = combined_cache_size - *l2_cache_size; | |
932 | } else { | |
933 | *refcount_cache_size = | |
934 | MIN(combined_cache_size, min_refcount_cache); | |
935 | *l2_cache_size = combined_cache_size - *refcount_cache_size; | |
936 | } | |
6c1c8d5d | 937 | } |
6c1c8d5d | 938 | } |
af39bd0d AG |
939 | |
940 | /* | |
941 | * If the L2 cache is not enough to cover the whole disk then | |
942 | * default to 4KB entries. Smaller entries reduce the cost of | |
943 | * loads and evictions and increase I/O performance. | |
944 | */ | |
945 | if (*l2_cache_size < max_l2_cache && !l2_cache_entry_size_set) { | |
946 | *l2_cache_entry_size = MIN(s->cluster_size, 4096); | |
947 | } | |
948 | ||
657ada52 LB |
949 | /* l2_cache_size and refcount_cache_size are ensured to have at least |
950 | * their minimum values in qcow2_update_options_prepare() */ | |
1221fe6f AG |
951 | |
952 | if (*l2_cache_entry_size < (1 << MIN_CLUSTER_BITS) || | |
953 | *l2_cache_entry_size > s->cluster_size || | |
954 | !is_power_of_2(*l2_cache_entry_size)) { | |
955 | error_setg(errp, "L2 cache entry size must be a power of two " | |
956 | "between %d and the cluster size (%d)", | |
957 | 1 << MIN_CLUSTER_BITS, s->cluster_size); | |
772c4cad | 958 | return false; |
1221fe6f | 959 | } |
772c4cad VSO |
960 | |
961 | return true; | |
6c1c8d5d HR |
962 | } |
963 | ||
ee55b173 KW |
964 | typedef struct Qcow2ReopenState { |
965 | Qcow2Cache *l2_table_cache; | |
966 | Qcow2Cache *refcount_block_cache; | |
3c2e511a | 967 | int l2_slice_size; /* Number of entries in a slice of the L2 table */ |
ee55b173 KW |
968 | bool use_lazy_refcounts; |
969 | int overlap_check; | |
970 | bool discard_passthrough[QCOW2_DISCARD_MAX]; | |
971 | uint64_t cache_clean_interval; | |
b25b387f | 972 | QCryptoBlockOpenOptions *crypto_opts; /* Disk encryption runtime options */ |
ee55b173 KW |
973 | } Qcow2ReopenState; |
974 | ||
975 | static int qcow2_update_options_prepare(BlockDriverState *bs, | |
976 | Qcow2ReopenState *r, | |
977 | QDict *options, int flags, | |
978 | Error **errp) | |
4c75d1a1 KW |
979 | { |
980 | BDRVQcow2State *s = bs->opaque; | |
94edf3fb | 981 | QemuOpts *opts = NULL; |
4c75d1a1 KW |
982 | const char *opt_overlap_check, *opt_overlap_check_template; |
983 | int overlap_check_template = 0; | |
1221fe6f | 984 | uint64_t l2_cache_size, l2_cache_entry_size, refcount_cache_size; |
4c75d1a1 | 985 | int i; |
b25b387f DB |
986 | const char *encryptfmt; |
987 | QDict *encryptopts = NULL; | |
4c75d1a1 KW |
988 | int ret; |
989 | ||
b25b387f DB |
990 | qdict_extract_subqdict(options, &encryptopts, "encrypt."); |
991 | encryptfmt = qdict_get_try_str(encryptopts, "format"); | |
992 | ||
94edf3fb | 993 | opts = qemu_opts_create(&qcow2_runtime_opts, NULL, 0, &error_abort); |
af175e85 | 994 | if (!qemu_opts_absorb_qdict(opts, options, errp)) { |
94edf3fb KW |
995 | ret = -EINVAL; |
996 | goto fail; | |
997 | } | |
998 | ||
999 | /* get L2 table/refcount block cache size from command line options */ | |
772c4cad VSO |
1000 | if (!read_cache_sizes(bs, opts, &l2_cache_size, &l2_cache_entry_size, |
1001 | &refcount_cache_size, errp)) { | |
94edf3fb KW |
1002 | ret = -EINVAL; |
1003 | goto fail; | |
1004 | } | |
1005 | ||
1221fe6f | 1006 | l2_cache_size /= l2_cache_entry_size; |
94edf3fb KW |
1007 | if (l2_cache_size < MIN_L2_CACHE_SIZE) { |
1008 | l2_cache_size = MIN_L2_CACHE_SIZE; | |
1009 | } | |
1010 | if (l2_cache_size > INT_MAX) { | |
1011 | error_setg(errp, "L2 cache size too big"); | |
1012 | ret = -EINVAL; | |
1013 | goto fail; | |
1014 | } | |
1015 | ||
1016 | refcount_cache_size /= s->cluster_size; | |
1017 | if (refcount_cache_size < MIN_REFCOUNT_CACHE_SIZE) { | |
1018 | refcount_cache_size = MIN_REFCOUNT_CACHE_SIZE; | |
1019 | } | |
1020 | if (refcount_cache_size > INT_MAX) { | |
1021 | error_setg(errp, "Refcount cache size too big"); | |
1022 | ret = -EINVAL; | |
1023 | goto fail; | |
1024 | } | |
1025 | ||
5b0959a7 KW |
1026 | /* alloc new L2 table/refcount block cache, flush old one */ |
1027 | if (s->l2_table_cache) { | |
1028 | ret = qcow2_cache_flush(bs, s->l2_table_cache); | |
1029 | if (ret) { | |
1030 | error_setg_errno(errp, -ret, "Failed to flush the L2 table cache"); | |
1031 | goto fail; | |
1032 | } | |
1033 | } | |
1034 | ||
1035 | if (s->refcount_block_cache) { | |
1036 | ret = qcow2_cache_flush(bs, s->refcount_block_cache); | |
1037 | if (ret) { | |
1038 | error_setg_errno(errp, -ret, | |
1039 | "Failed to flush the refcount block cache"); | |
1040 | goto fail; | |
1041 | } | |
1042 | } | |
1043 | ||
c8fd8554 | 1044 | r->l2_slice_size = l2_cache_entry_size / l2_entry_size(s); |
1221fe6f AG |
1045 | r->l2_table_cache = qcow2_cache_create(bs, l2_cache_size, |
1046 | l2_cache_entry_size); | |
1047 | r->refcount_block_cache = qcow2_cache_create(bs, refcount_cache_size, | |
1048 | s->cluster_size); | |
ee55b173 | 1049 | if (r->l2_table_cache == NULL || r->refcount_block_cache == NULL) { |
94edf3fb KW |
1050 | error_setg(errp, "Could not allocate metadata caches"); |
1051 | ret = -ENOMEM; | |
1052 | goto fail; | |
1053 | } | |
1054 | ||
1055 | /* New interval for cache cleanup timer */ | |
ee55b173 | 1056 | r->cache_clean_interval = |
5b0959a7 | 1057 | qemu_opt_get_number(opts, QCOW2_OPT_CACHE_CLEAN_INTERVAL, |
e957b50b | 1058 | DEFAULT_CACHE_CLEAN_INTERVAL); |
91203f08 AG |
1059 | #ifndef CONFIG_LINUX |
1060 | if (r->cache_clean_interval != 0) { | |
1061 | error_setg(errp, QCOW2_OPT_CACHE_CLEAN_INTERVAL | |
1062 | " not supported on this host"); | |
1063 | ret = -EINVAL; | |
1064 | goto fail; | |
1065 | } | |
1066 | #endif | |
ee55b173 | 1067 | if (r->cache_clean_interval > UINT_MAX) { |
94edf3fb KW |
1068 | error_setg(errp, "Cache clean interval too big"); |
1069 | ret = -EINVAL; | |
1070 | goto fail; | |
1071 | } | |
94edf3fb | 1072 | |
5b0959a7 | 1073 | /* lazy-refcounts; flush if going from enabled to disabled */ |
ee55b173 | 1074 | r->use_lazy_refcounts = qemu_opt_get_bool(opts, QCOW2_OPT_LAZY_REFCOUNTS, |
4c75d1a1 | 1075 | (s->compatible_features & QCOW2_COMPAT_LAZY_REFCOUNTS)); |
ee55b173 | 1076 | if (r->use_lazy_refcounts && s->qcow_version < 3) { |
007dbc39 KW |
1077 | error_setg(errp, "Lazy refcounts require a qcow2 image with at least " |
1078 | "qemu 1.1 compatibility level"); | |
1079 | ret = -EINVAL; | |
1080 | goto fail; | |
1081 | } | |
4c75d1a1 | 1082 | |
5b0959a7 KW |
1083 | if (s->use_lazy_refcounts && !r->use_lazy_refcounts) { |
1084 | ret = qcow2_mark_clean(bs); | |
1085 | if (ret < 0) { | |
1086 | error_setg_errno(errp, -ret, "Failed to disable lazy refcounts"); | |
1087 | goto fail; | |
1088 | } | |
1089 | } | |
1090 | ||
007dbc39 | 1091 | /* Overlap check options */ |
4c75d1a1 KW |
1092 | opt_overlap_check = qemu_opt_get(opts, QCOW2_OPT_OVERLAP); |
1093 | opt_overlap_check_template = qemu_opt_get(opts, QCOW2_OPT_OVERLAP_TEMPLATE); | |
1094 | if (opt_overlap_check_template && opt_overlap_check && | |
1095 | strcmp(opt_overlap_check_template, opt_overlap_check)) | |
1096 | { | |
1097 | error_setg(errp, "Conflicting values for qcow2 options '" | |
1098 | QCOW2_OPT_OVERLAP "' ('%s') and '" QCOW2_OPT_OVERLAP_TEMPLATE | |
1099 | "' ('%s')", opt_overlap_check, opt_overlap_check_template); | |
1100 | ret = -EINVAL; | |
1101 | goto fail; | |
1102 | } | |
1103 | if (!opt_overlap_check) { | |
1104 | opt_overlap_check = opt_overlap_check_template ?: "cached"; | |
1105 | } | |
1106 | ||
1107 | if (!strcmp(opt_overlap_check, "none")) { | |
1108 | overlap_check_template = 0; | |
1109 | } else if (!strcmp(opt_overlap_check, "constant")) { | |
1110 | overlap_check_template = QCOW2_OL_CONSTANT; | |
1111 | } else if (!strcmp(opt_overlap_check, "cached")) { | |
1112 | overlap_check_template = QCOW2_OL_CACHED; | |
1113 | } else if (!strcmp(opt_overlap_check, "all")) { | |
1114 | overlap_check_template = QCOW2_OL_ALL; | |
1115 | } else { | |
1116 | error_setg(errp, "Unsupported value '%s' for qcow2 option " | |
1117 | "'overlap-check'. Allowed are any of the following: " | |
1118 | "none, constant, cached, all", opt_overlap_check); | |
1119 | ret = -EINVAL; | |
1120 | goto fail; | |
1121 | } | |
1122 | ||
ee55b173 | 1123 | r->overlap_check = 0; |
4c75d1a1 KW |
1124 | for (i = 0; i < QCOW2_OL_MAX_BITNR; i++) { |
1125 | /* overlap-check defines a template bitmask, but every flag may be | |
1126 | * overwritten through the associated boolean option */ | |
ee55b173 | 1127 | r->overlap_check |= |
4c75d1a1 KW |
1128 | qemu_opt_get_bool(opts, overlap_bool_option_names[i], |
1129 | overlap_check_template & (1 << i)) << i; | |
1130 | } | |
1131 | ||
ee55b173 KW |
1132 | r->discard_passthrough[QCOW2_DISCARD_NEVER] = false; |
1133 | r->discard_passthrough[QCOW2_DISCARD_ALWAYS] = true; | |
1134 | r->discard_passthrough[QCOW2_DISCARD_REQUEST] = | |
007dbc39 KW |
1135 | qemu_opt_get_bool(opts, QCOW2_OPT_DISCARD_REQUEST, |
1136 | flags & BDRV_O_UNMAP); | |
ee55b173 | 1137 | r->discard_passthrough[QCOW2_DISCARD_SNAPSHOT] = |
007dbc39 | 1138 | qemu_opt_get_bool(opts, QCOW2_OPT_DISCARD_SNAPSHOT, true); |
ee55b173 | 1139 | r->discard_passthrough[QCOW2_DISCARD_OTHER] = |
007dbc39 KW |
1140 | qemu_opt_get_bool(opts, QCOW2_OPT_DISCARD_OTHER, false); |
1141 | ||
b25b387f DB |
1142 | switch (s->crypt_method_header) { |
1143 | case QCOW_CRYPT_NONE: | |
1144 | if (encryptfmt) { | |
1145 | error_setg(errp, "No encryption in image header, but options " | |
1146 | "specified format '%s'", encryptfmt); | |
1147 | ret = -EINVAL; | |
1148 | goto fail; | |
1149 | } | |
1150 | break; | |
1151 | ||
1152 | case QCOW_CRYPT_AES: | |
1153 | if (encryptfmt && !g_str_equal(encryptfmt, "aes")) { | |
1154 | error_setg(errp, | |
1155 | "Header reported 'aes' encryption format but " | |
1156 | "options specify '%s'", encryptfmt); | |
1157 | ret = -EINVAL; | |
1158 | goto fail; | |
1159 | } | |
796d3239 MA |
1160 | qdict_put_str(encryptopts, "format", "qcow"); |
1161 | r->crypto_opts = block_crypto_open_opts_init(encryptopts, errp); | |
1184b411 VSO |
1162 | if (!r->crypto_opts) { |
1163 | ret = -EINVAL; | |
1164 | goto fail; | |
1165 | } | |
b25b387f DB |
1166 | break; |
1167 | ||
4652b8f3 DB |
1168 | case QCOW_CRYPT_LUKS: |
1169 | if (encryptfmt && !g_str_equal(encryptfmt, "luks")) { | |
1170 | error_setg(errp, | |
1171 | "Header reported 'luks' encryption format but " | |
1172 | "options specify '%s'", encryptfmt); | |
1173 | ret = -EINVAL; | |
1174 | goto fail; | |
1175 | } | |
796d3239 MA |
1176 | qdict_put_str(encryptopts, "format", "luks"); |
1177 | r->crypto_opts = block_crypto_open_opts_init(encryptopts, errp); | |
1184b411 VSO |
1178 | if (!r->crypto_opts) { |
1179 | ret = -EINVAL; | |
1180 | goto fail; | |
1181 | } | |
4652b8f3 DB |
1182 | break; |
1183 | ||
b25b387f DB |
1184 | default: |
1185 | error_setg(errp, "Unsupported encryption method %d", | |
1186 | s->crypt_method_header); | |
b25b387f DB |
1187 | ret = -EINVAL; |
1188 | goto fail; | |
1189 | } | |
1190 | ||
4c75d1a1 KW |
1191 | ret = 0; |
1192 | fail: | |
cb3e7f08 | 1193 | qobject_unref(encryptopts); |
94edf3fb KW |
1194 | qemu_opts_del(opts); |
1195 | opts = NULL; | |
ee55b173 KW |
1196 | return ret; |
1197 | } | |
1198 | ||
1199 | static void qcow2_update_options_commit(BlockDriverState *bs, | |
1200 | Qcow2ReopenState *r) | |
1201 | { | |
1202 | BDRVQcow2State *s = bs->opaque; | |
1203 | int i; | |
1204 | ||
5b0959a7 | 1205 | if (s->l2_table_cache) { |
e64d4072 | 1206 | qcow2_cache_destroy(s->l2_table_cache); |
5b0959a7 KW |
1207 | } |
1208 | if (s->refcount_block_cache) { | |
e64d4072 | 1209 | qcow2_cache_destroy(s->refcount_block_cache); |
5b0959a7 | 1210 | } |
ee55b173 KW |
1211 | s->l2_table_cache = r->l2_table_cache; |
1212 | s->refcount_block_cache = r->refcount_block_cache; | |
3c2e511a | 1213 | s->l2_slice_size = r->l2_slice_size; |
ee55b173 KW |
1214 | |
1215 | s->overlap_check = r->overlap_check; | |
1216 | s->use_lazy_refcounts = r->use_lazy_refcounts; | |
1217 | ||
1218 | for (i = 0; i < QCOW2_DISCARD_MAX; i++) { | |
1219 | s->discard_passthrough[i] = r->discard_passthrough[i]; | |
1220 | } | |
1221 | ||
5b0959a7 KW |
1222 | if (s->cache_clean_interval != r->cache_clean_interval) { |
1223 | cache_clean_timer_del(bs); | |
1224 | s->cache_clean_interval = r->cache_clean_interval; | |
1225 | cache_clean_timer_init(bs, bdrv_get_aio_context(bs)); | |
1226 | } | |
b25b387f DB |
1227 | |
1228 | qapi_free_QCryptoBlockOpenOptions(s->crypto_opts); | |
1229 | s->crypto_opts = r->crypto_opts; | |
ee55b173 KW |
1230 | } |
1231 | ||
1232 | static void qcow2_update_options_abort(BlockDriverState *bs, | |
1233 | Qcow2ReopenState *r) | |
1234 | { | |
1235 | if (r->l2_table_cache) { | |
e64d4072 | 1236 | qcow2_cache_destroy(r->l2_table_cache); |
ee55b173 KW |
1237 | } |
1238 | if (r->refcount_block_cache) { | |
e64d4072 | 1239 | qcow2_cache_destroy(r->refcount_block_cache); |
ee55b173 | 1240 | } |
b25b387f | 1241 | qapi_free_QCryptoBlockOpenOptions(r->crypto_opts); |
ee55b173 KW |
1242 | } |
1243 | ||
1244 | static int qcow2_update_options(BlockDriverState *bs, QDict *options, | |
1245 | int flags, Error **errp) | |
1246 | { | |
1247 | Qcow2ReopenState r = {}; | |
1248 | int ret; | |
1249 | ||
1250 | ret = qcow2_update_options_prepare(bs, &r, options, flags, errp); | |
1251 | if (ret >= 0) { | |
1252 | qcow2_update_options_commit(bs, &r); | |
1253 | } else { | |
1254 | qcow2_update_options_abort(bs, &r); | |
1255 | } | |
94edf3fb | 1256 | |
4c75d1a1 KW |
1257 | return ret; |
1258 | } | |
1259 | ||
572ad978 DP |
1260 | static int validate_compression_type(BDRVQcow2State *s, Error **errp) |
1261 | { | |
1262 | switch (s->compression_type) { | |
1263 | case QCOW2_COMPRESSION_TYPE_ZLIB: | |
d298ac10 DP |
1264 | #ifdef CONFIG_ZSTD |
1265 | case QCOW2_COMPRESSION_TYPE_ZSTD: | |
1266 | #endif | |
572ad978 DP |
1267 | break; |
1268 | ||
1269 | default: | |
1270 | error_setg(errp, "qcow2: unknown compression type: %u", | |
1271 | s->compression_type); | |
1272 | return -ENOTSUP; | |
1273 | } | |
1274 | ||
1275 | /* | |
1276 | * if the compression type differs from QCOW2_COMPRESSION_TYPE_ZLIB | |
1277 | * the incompatible feature flag must be set | |
1278 | */ | |
1279 | if (s->compression_type == QCOW2_COMPRESSION_TYPE_ZLIB) { | |
1280 | if (s->incompatible_features & QCOW2_INCOMPAT_COMPRESSION) { | |
1281 | error_setg(errp, "qcow2: Compression type incompatible feature " | |
1282 | "bit must not be set"); | |
1283 | return -EINVAL; | |
1284 | } | |
1285 | } else { | |
1286 | if (!(s->incompatible_features & QCOW2_INCOMPAT_COMPRESSION)) { | |
1287 | error_setg(errp, "qcow2: Compression type incompatible feature " | |
1288 | "bit must be set"); | |
1289 | return -EINVAL; | |
1290 | } | |
1291 | } | |
1292 | ||
1293 | return 0; | |
1294 | } | |
1295 | ||
1fafcd93 PB |
1296 | /* Called with s->lock held. */ |
1297 | static int coroutine_fn qcow2_do_open(BlockDriverState *bs, QDict *options, | |
06e9cd19 HR |
1298 | int flags, bool open_data_file, |
1299 | Error **errp) | |
585f8587 | 1300 | { |
bc520249 | 1301 | ERRP_GUARD(); |
ff99129a | 1302 | BDRVQcow2State *s = bs->opaque; |
6d33e8e7 KW |
1303 | unsigned int len, i; |
1304 | int ret = 0; | |
585f8587 | 1305 | QCowHeader header; |
9b80ddf3 | 1306 | uint64_t ext_end; |
2cf7cfa1 | 1307 | uint64_t l1_vm_state_index; |
88ddffae | 1308 | bool update_header = false; |
585f8587 | 1309 | |
38505e2a | 1310 | ret = bdrv_co_pread(bs->file, 0, sizeof(header), &header, 0); |
6d85a57e | 1311 | if (ret < 0) { |
3ef6c40a | 1312 | error_setg_errno(errp, -ret, "Could not read qcow2 header"); |
585f8587 | 1313 | goto fail; |
6d85a57e | 1314 | } |
3b698f52 PM |
1315 | header.magic = be32_to_cpu(header.magic); |
1316 | header.version = be32_to_cpu(header.version); | |
1317 | header.backing_file_offset = be64_to_cpu(header.backing_file_offset); | |
1318 | header.backing_file_size = be32_to_cpu(header.backing_file_size); | |
1319 | header.size = be64_to_cpu(header.size); | |
1320 | header.cluster_bits = be32_to_cpu(header.cluster_bits); | |
1321 | header.crypt_method = be32_to_cpu(header.crypt_method); | |
1322 | header.l1_table_offset = be64_to_cpu(header.l1_table_offset); | |
1323 | header.l1_size = be32_to_cpu(header.l1_size); | |
1324 | header.refcount_table_offset = be64_to_cpu(header.refcount_table_offset); | |
1325 | header.refcount_table_clusters = | |
1326 | be32_to_cpu(header.refcount_table_clusters); | |
1327 | header.snapshots_offset = be64_to_cpu(header.snapshots_offset); | |
1328 | header.nb_snapshots = be32_to_cpu(header.nb_snapshots); | |
3b46e624 | 1329 | |
e8cdcec1 | 1330 | if (header.magic != QCOW_MAGIC) { |
3ef6c40a | 1331 | error_setg(errp, "Image is not in qcow2 format"); |
76abe407 | 1332 | ret = -EINVAL; |
585f8587 | 1333 | goto fail; |
6d85a57e | 1334 | } |
6744cbab | 1335 | if (header.version < 2 || header.version > 3) { |
a55448b3 | 1336 | error_setg(errp, "Unsupported qcow2 version %" PRIu32, header.version); |
6744cbab KW |
1337 | ret = -ENOTSUP; |
1338 | goto fail; | |
1339 | } | |
1340 | ||
1341 | s->qcow_version = header.version; | |
1342 | ||
24342f2c KW |
1343 | /* Initialise cluster size */ |
1344 | if (header.cluster_bits < MIN_CLUSTER_BITS || | |
1345 | header.cluster_bits > MAX_CLUSTER_BITS) { | |
521b2b5d HR |
1346 | error_setg(errp, "Unsupported cluster size: 2^%" PRIu32, |
1347 | header.cluster_bits); | |
24342f2c KW |
1348 | ret = -EINVAL; |
1349 | goto fail; | |
1350 | } | |
1351 | ||
1352 | s->cluster_bits = header.cluster_bits; | |
1353 | s->cluster_size = 1 << s->cluster_bits; | |
24342f2c | 1354 | |
6744cbab KW |
1355 | /* Initialise version 3 header fields */ |
1356 | if (header.version == 2) { | |
1357 | header.incompatible_features = 0; | |
1358 | header.compatible_features = 0; | |
1359 | header.autoclear_features = 0; | |
1360 | header.refcount_order = 4; | |
1361 | header.header_length = 72; | |
1362 | } else { | |
3b698f52 PM |
1363 | header.incompatible_features = |
1364 | be64_to_cpu(header.incompatible_features); | |
1365 | header.compatible_features = be64_to_cpu(header.compatible_features); | |
1366 | header.autoclear_features = be64_to_cpu(header.autoclear_features); | |
1367 | header.refcount_order = be32_to_cpu(header.refcount_order); | |
1368 | header.header_length = be32_to_cpu(header.header_length); | |
24342f2c KW |
1369 | |
1370 | if (header.header_length < 104) { | |
1371 | error_setg(errp, "qcow2 header too short"); | |
1372 | ret = -EINVAL; | |
1373 | goto fail; | |
1374 | } | |
1375 | } | |
1376 | ||
1377 | if (header.header_length > s->cluster_size) { | |
1378 | error_setg(errp, "qcow2 header exceeds cluster size"); | |
1379 | ret = -EINVAL; | |
1380 | goto fail; | |
6744cbab KW |
1381 | } |
1382 | ||
1383 | if (header.header_length > sizeof(header)) { | |
1384 | s->unknown_header_fields_size = header.header_length - sizeof(header); | |
1385 | s->unknown_header_fields = g_malloc(s->unknown_header_fields_size); | |
38505e2a AF |
1386 | ret = bdrv_co_pread(bs->file, sizeof(header), |
1387 | s->unknown_header_fields_size, | |
1388 | s->unknown_header_fields, 0); | |
6744cbab | 1389 | if (ret < 0) { |
3ef6c40a HR |
1390 | error_setg_errno(errp, -ret, "Could not read unknown qcow2 header " |
1391 | "fields"); | |
6744cbab KW |
1392 | goto fail; |
1393 | } | |
1394 | } | |
1395 | ||
a1b3955c KW |
1396 | if (header.backing_file_offset > s->cluster_size) { |
1397 | error_setg(errp, "Invalid backing file offset"); | |
1398 | ret = -EINVAL; | |
1399 | goto fail; | |
1400 | } | |
1401 | ||
cfcc4c62 KW |
1402 | if (header.backing_file_offset) { |
1403 | ext_end = header.backing_file_offset; | |
1404 | } else { | |
1405 | ext_end = 1 << header.cluster_bits; | |
1406 | } | |
1407 | ||
6744cbab KW |
1408 | /* Handle feature bits */ |
1409 | s->incompatible_features = header.incompatible_features; | |
1410 | s->compatible_features = header.compatible_features; | |
1411 | s->autoclear_features = header.autoclear_features; | |
1412 | ||
572ad978 DP |
1413 | /* |
1414 | * Handle compression type | |
1415 | * Older qcow2 images don't contain the compression type header. | |
1416 | * Distinguish them by the header length and use | |
1417 | * the only valid (default) compression type in that case | |
1418 | */ | |
1419 | if (header.header_length > offsetof(QCowHeader, compression_type)) { | |
1420 | s->compression_type = header.compression_type; | |
1421 | } else { | |
1422 | s->compression_type = QCOW2_COMPRESSION_TYPE_ZLIB; | |
1423 | } | |
1424 | ||
1425 | ret = validate_compression_type(s, errp); | |
1426 | if (ret) { | |
1427 | goto fail; | |
1428 | } | |
1429 | ||
c61d0004 | 1430 | if (s->incompatible_features & ~QCOW2_INCOMPAT_MASK) { |
cfcc4c62 KW |
1431 | void *feature_table = NULL; |
1432 | qcow2_read_extensions(bs, header.header_length, ext_end, | |
88ddffae | 1433 | &feature_table, flags, NULL, NULL); |
a55448b3 | 1434 | report_unsupported_feature(errp, feature_table, |
c61d0004 SH |
1435 | s->incompatible_features & |
1436 | ~QCOW2_INCOMPAT_MASK); | |
6744cbab | 1437 | ret = -ENOTSUP; |
c5a33ee9 | 1438 | g_free(feature_table); |
6744cbab KW |
1439 | goto fail; |
1440 | } | |
1441 | ||
69c98726 HR |
1442 | if (s->incompatible_features & QCOW2_INCOMPAT_CORRUPT) { |
1443 | /* Corrupt images may not be written to unless they are being repaired | |
1444 | */ | |
1445 | if ((flags & BDRV_O_RDWR) && !(flags & BDRV_O_CHECK)) { | |
3ef6c40a HR |
1446 | error_setg(errp, "qcow2: Image is corrupt; cannot be opened " |
1447 | "read/write"); | |
69c98726 HR |
1448 | ret = -EACCES; |
1449 | goto fail; | |
1450 | } | |
1451 | } | |
1452 | ||
d0346b55 AG |
1453 | s->subclusters_per_cluster = |
1454 | has_subclusters(s) ? QCOW_EXTL2_SUBCLUSTERS_PER_CLUSTER : 1; | |
1455 | s->subcluster_size = s->cluster_size / s->subclusters_per_cluster; | |
1456 | s->subcluster_bits = ctz32(s->subcluster_size); | |
1457 | ||
7be20252 AG |
1458 | if (s->subcluster_size < (1 << MIN_CLUSTER_BITS)) { |
1459 | error_setg(errp, "Unsupported subcluster size: %d", s->subcluster_size); | |
1460 | ret = -EINVAL; | |
1461 | goto fail; | |
1462 | } | |
1463 | ||
6744cbab | 1464 | /* Check support for various header values */ |
b72faf9f HR |
1465 | if (header.refcount_order > 6) { |
1466 | error_setg(errp, "Reference count entry width too large; may not " | |
1467 | "exceed 64 bits"); | |
1468 | ret = -EINVAL; | |
e8cdcec1 KW |
1469 | goto fail; |
1470 | } | |
b6481f37 | 1471 | s->refcount_order = header.refcount_order; |
346a53df HR |
1472 | s->refcount_bits = 1 << s->refcount_order; |
1473 | s->refcount_max = UINT64_C(1) << (s->refcount_bits - 1); | |
1474 | s->refcount_max += s->refcount_max - 1; | |
6744cbab | 1475 | |
585f8587 | 1476 | s->crypt_method_header = header.crypt_method; |
6d85a57e | 1477 | if (s->crypt_method_header) { |
e6ff69bf DB |
1478 | if (bdrv_uses_whitelist() && |
1479 | s->crypt_method_header == QCOW_CRYPT_AES) { | |
8c0dcbc4 DB |
1480 | error_setg(errp, |
1481 | "Use of AES-CBC encrypted qcow2 images is no longer " | |
1482 | "supported in system emulators"); | |
1483 | error_append_hint(errp, | |
1484 | "You can use 'qemu-img convert' to convert your " | |
1485 | "image to an alternative supported format, such " | |
1486 | "as unencrypted qcow2, or raw with the LUKS " | |
1487 | "format instead.\n"); | |
1488 | ret = -ENOSYS; | |
1489 | goto fail; | |
e6ff69bf DB |
1490 | } |
1491 | ||
4652b8f3 DB |
1492 | if (s->crypt_method_header == QCOW_CRYPT_AES) { |
1493 | s->crypt_physical_offset = false; | |
1494 | } else { | |
1495 | /* Assuming LUKS and any future crypt methods we | |
1496 | * add will all use physical offsets, due to the | |
1497 | * fact that the alternative is insecure... */ | |
1498 | s->crypt_physical_offset = true; | |
1499 | } | |
1500 | ||
54115412 | 1501 | bs->encrypted = true; |
6d85a57e | 1502 | } |
24342f2c | 1503 | |
c8fd8554 | 1504 | s->l2_bits = s->cluster_bits - ctz32(l2_entry_size(s)); |
585f8587 | 1505 | s->l2_size = 1 << s->l2_bits; |
1d13d654 HR |
1506 | /* 2^(s->refcount_order - 3) is the refcount width in bytes */ |
1507 | s->refcount_block_bits = s->cluster_bits - (s->refcount_order - 3); | |
1508 | s->refcount_block_size = 1 << s->refcount_block_bits; | |
bd016b91 | 1509 | bs->total_sectors = header.size / BDRV_SECTOR_SIZE; |
585f8587 FB |
1510 | s->csize_shift = (62 - (s->cluster_bits - 8)); |
1511 | s->csize_mask = (1 << (s->cluster_bits - 8)) - 1; | |
1512 | s->cluster_offset_mask = (1LL << s->csize_shift) - 1; | |
5dab2fad | 1513 | |
585f8587 | 1514 | s->refcount_table_offset = header.refcount_table_offset; |
5fafdf24 | 1515 | s->refcount_table_size = |
585f8587 FB |
1516 | header.refcount_table_clusters << (s->cluster_bits - 3); |
1517 | ||
951053a9 AG |
1518 | if (header.refcount_table_clusters == 0 && !(flags & BDRV_O_CHECK)) { |
1519 | error_setg(errp, "Image does not contain a reference count table"); | |
1520 | ret = -EINVAL; | |
1521 | goto fail; | |
1522 | } | |
1523 | ||
0cf0e598 AG |
1524 | ret = qcow2_validate_table(bs, s->refcount_table_offset, |
1525 | header.refcount_table_clusters, | |
1526 | s->cluster_size, QCOW_MAX_REFTABLE_SIZE, | |
1527 | "Reference count table", errp); | |
8c7de283 | 1528 | if (ret < 0) { |
8c7de283 KW |
1529 | goto fail; |
1530 | } | |
1531 | ||
8bc584fe HR |
1532 | if (!(flags & BDRV_O_CHECK)) { |
1533 | /* | |
1534 | * The total size in bytes of the snapshot table is checked in | |
1535 | * qcow2_read_snapshots() because the size of each snapshot is | |
1536 | * variable and we don't know it yet. | |
1537 | * Here we only check the offset and number of snapshots. | |
1538 | */ | |
1539 | ret = qcow2_validate_table(bs, header.snapshots_offset, | |
1540 | header.nb_snapshots, | |
1541 | sizeof(QCowSnapshotHeader), | |
1542 | sizeof(QCowSnapshotHeader) * | |
1543 | QCOW_MAX_SNAPSHOTS, | |
1544 | "Snapshot table", errp); | |
1545 | if (ret < 0) { | |
1546 | goto fail; | |
1547 | } | |
ce48f2f4 KW |
1548 | } |
1549 | ||
585f8587 | 1550 | /* read the level 1 table */ |
0cf0e598 | 1551 | ret = qcow2_validate_table(bs, header.l1_table_offset, |
02b1ecfa | 1552 | header.l1_size, L1E_SIZE, |
0cf0e598 AG |
1553 | QCOW_MAX_L1_SIZE, "Active L1 table", errp); |
1554 | if (ret < 0) { | |
2d51c32c KW |
1555 | goto fail; |
1556 | } | |
585f8587 | 1557 | s->l1_size = header.l1_size; |
0cf0e598 | 1558 | s->l1_table_offset = header.l1_table_offset; |
2cf7cfa1 KW |
1559 | |
1560 | l1_vm_state_index = size_to_l1(s, header.size); | |
1561 | if (l1_vm_state_index > INT_MAX) { | |
3ef6c40a | 1562 | error_setg(errp, "Image is too big"); |
2cf7cfa1 KW |
1563 | ret = -EFBIG; |
1564 | goto fail; | |
1565 | } | |
1566 | s->l1_vm_state_index = l1_vm_state_index; | |
1567 | ||
585f8587 FB |
1568 | /* the L1 table must contain at least enough entries to put |
1569 | header.size bytes */ | |
6d85a57e | 1570 | if (s->l1_size < s->l1_vm_state_index) { |
3ef6c40a | 1571 | error_setg(errp, "L1 table is too small"); |
6d85a57e | 1572 | ret = -EINVAL; |
585f8587 | 1573 | goto fail; |
6d85a57e | 1574 | } |
2d51c32c | 1575 | |
d191d12d | 1576 | if (s->l1_size > 0) { |
02b1ecfa | 1577 | s->l1_table = qemu_try_blockalign(bs->file->bs, s->l1_size * L1E_SIZE); |
de82815d KW |
1578 | if (s->l1_table == NULL) { |
1579 | error_setg(errp, "Could not allocate L1 table"); | |
1580 | ret = -ENOMEM; | |
1581 | goto fail; | |
1582 | } | |
38505e2a AF |
1583 | ret = bdrv_co_pread(bs->file, s->l1_table_offset, s->l1_size * L1E_SIZE, |
1584 | s->l1_table, 0); | |
6d85a57e | 1585 | if (ret < 0) { |
3ef6c40a | 1586 | error_setg_errno(errp, -ret, "Could not read L1 table"); |
d191d12d | 1587 | goto fail; |
6d85a57e | 1588 | } |
d191d12d | 1589 | for(i = 0;i < s->l1_size; i++) { |
3b698f52 | 1590 | s->l1_table[i] = be64_to_cpu(s->l1_table[i]); |
d191d12d | 1591 | } |
585f8587 | 1592 | } |
29c1a730 | 1593 | |
94edf3fb KW |
1594 | /* Parse driver-specific options */ |
1595 | ret = qcow2_update_options(bs, options, flags, errp); | |
90efa0ea KW |
1596 | if (ret < 0) { |
1597 | goto fail; | |
1598 | } | |
1599 | ||
06d9260f | 1600 | s->flags = flags; |
3b46e624 | 1601 | |
6d85a57e JS |
1602 | ret = qcow2_refcount_init(bs); |
1603 | if (ret != 0) { | |
3ef6c40a | 1604 | error_setg_errno(errp, -ret, "Could not initialize refcount handling"); |
585f8587 | 1605 | goto fail; |
6d85a57e | 1606 | } |
585f8587 | 1607 | |
72cf2d4f | 1608 | QLIST_INIT(&s->cluster_allocs); |
0b919fae | 1609 | QTAILQ_INIT(&s->discards); |
f214978a | 1610 | |
9b80ddf3 | 1611 | /* read qcow2 extensions */ |
3ef6c40a | 1612 | if (qcow2_read_extensions(bs, header.header_length, ext_end, NULL, |
af175e85 | 1613 | flags, &update_header, errp)) { |
6d85a57e | 1614 | ret = -EINVAL; |
9b80ddf3 | 1615 | goto fail; |
6d85a57e | 1616 | } |
9b80ddf3 | 1617 | |
06e9cd19 HR |
1618 | if (open_data_file) { |
1619 | /* Open external data file */ | |
ecbc57ca KW |
1620 | s->data_file = bdrv_co_open_child(NULL, options, "data-file", bs, |
1621 | &child_of_bds, BDRV_CHILD_DATA, | |
1622 | true, errp); | |
06e9cd19 HR |
1623 | if (*errp) { |
1624 | ret = -EINVAL; | |
1625 | goto fail; | |
1626 | } | |
0e8c08be | 1627 | |
06e9cd19 HR |
1628 | if (s->incompatible_features & QCOW2_INCOMPAT_DATA_FILE) { |
1629 | if (!s->data_file && s->image_data_file) { | |
ecbc57ca KW |
1630 | s->data_file = bdrv_co_open_child(s->image_data_file, options, |
1631 | "data-file", bs, | |
1632 | &child_of_bds, | |
1633 | BDRV_CHILD_DATA, false, errp); | |
06e9cd19 HR |
1634 | if (!s->data_file) { |
1635 | ret = -EINVAL; | |
1636 | goto fail; | |
1637 | } | |
1638 | } | |
9b890bdc | 1639 | if (!s->data_file) { |
06e9cd19 | 1640 | error_setg(errp, "'data-file' is required for this image"); |
9b890bdc KW |
1641 | ret = -EINVAL; |
1642 | goto fail; | |
1643 | } | |
8b1869da | 1644 | |
06e9cd19 HR |
1645 | /* No data here */ |
1646 | bs->file->role &= ~BDRV_CHILD_DATA; | |
8b1869da | 1647 | |
06e9cd19 HR |
1648 | /* Must succeed because we have given up permissions if anything */ |
1649 | bdrv_child_refresh_perms(bs, bs->file, &error_abort); | |
1650 | } else { | |
1651 | if (s->data_file) { | |
1652 | error_setg(errp, "'data-file' can only be set for images with " | |
1653 | "an external data file"); | |
1654 | ret = -EINVAL; | |
1655 | goto fail; | |
1656 | } | |
6c3944dc | 1657 | |
06e9cd19 | 1658 | s->data_file = bs->file; |
6c3944dc | 1659 | |
06e9cd19 HR |
1660 | if (data_file_is_raw(bs)) { |
1661 | error_setg(errp, "data-file-raw requires a data file"); | |
1662 | ret = -EINVAL; | |
1663 | goto fail; | |
1664 | } | |
0e8c08be KW |
1665 | } |
1666 | } | |
93c24936 | 1667 | |
4652b8f3 DB |
1668 | /* qcow2_read_extension may have set up the crypto context |
1669 | * if the crypt method needs a header region, some methods | |
1670 | * don't need header extensions, so must check here | |
1671 | */ | |
1672 | if (s->crypt_method_header && !s->crypto) { | |
1673 | if (s->crypt_method_header == QCOW_CRYPT_AES) { | |
1674 | unsigned int cflags = 0; | |
1675 | if (flags & BDRV_O_NO_IO) { | |
1676 | cflags |= QCRYPTO_BLOCK_OPEN_NO_IO; | |
1677 | } | |
1cd9a787 | 1678 | s->crypto = qcrypto_block_open(s->crypto_opts, "encrypt.", |
8ac0f15f VSO |
1679 | NULL, NULL, cflags, |
1680 | QCOW2_MAX_THREADS, errp); | |
4652b8f3 DB |
1681 | if (!s->crypto) { |
1682 | ret = -EINVAL; | |
1683 | goto fail; | |
1684 | } | |
1685 | } else if (!(flags & BDRV_O_NO_IO)) { | |
1686 | error_setg(errp, "Missing CRYPTO header for crypt method %d", | |
1687 | s->crypt_method_header); | |
b25b387f DB |
1688 | ret = -EINVAL; |
1689 | goto fail; | |
1690 | } | |
1691 | } | |
1692 | ||
585f8587 FB |
1693 | /* read the backing file name */ |
1694 | if (header.backing_file_offset != 0) { | |
1695 | len = header.backing_file_size; | |
9a29e18f | 1696 | if (len > MIN(1023, s->cluster_size - header.backing_file_offset) || |
e729fa6a | 1697 | len >= sizeof(bs->backing_file)) { |
6d33e8e7 KW |
1698 | error_setg(errp, "Backing file name too long"); |
1699 | ret = -EINVAL; | |
1700 | goto fail; | |
6d85a57e | 1701 | } |
ec64b1ca HR |
1702 | |
1703 | s->image_backing_file = g_malloc(len + 1); | |
38505e2a AF |
1704 | ret = bdrv_co_pread(bs->file, header.backing_file_offset, len, |
1705 | s->image_backing_file, 0); | |
6d85a57e | 1706 | if (ret < 0) { |
3ef6c40a | 1707 | error_setg_errno(errp, -ret, "Could not read backing file name"); |
585f8587 | 1708 | goto fail; |
6d85a57e | 1709 | } |
ec64b1ca HR |
1710 | s->image_backing_file[len] = '\0'; |
1711 | ||
1712 | /* | |
1713 | * Update only when something has changed. This function is called by | |
1714 | * qcow2_co_invalidate_cache(), and we do not want to reset | |
1715 | * auto_backing_file unless necessary. | |
1716 | */ | |
1717 | if (!g_str_equal(s->image_backing_file, bs->backing_file)) { | |
1718 | pstrcpy(bs->backing_file, sizeof(bs->backing_file), | |
1719 | s->image_backing_file); | |
1720 | pstrcpy(bs->auto_backing_file, sizeof(bs->auto_backing_file), | |
1721 | s->image_backing_file); | |
1722 | } | |
585f8587 | 1723 | } |
42deb29f | 1724 | |
8bc584fe HR |
1725 | /* |
1726 | * Internal snapshots; skip reading them in check mode, because | |
1727 | * we do not need them then, and we do not want to abort because | |
1728 | * of a broken table. | |
1729 | */ | |
1730 | if (!(flags & BDRV_O_CHECK)) { | |
1731 | s->snapshots_offset = header.snapshots_offset; | |
1732 | s->nb_snapshots = header.nb_snapshots; | |
11b128f4 | 1733 | |
8bc584fe HR |
1734 | ret = qcow2_read_snapshots(bs, errp); |
1735 | if (ret < 0) { | |
1736 | goto fail; | |
1737 | } | |
6d85a57e | 1738 | } |
585f8587 | 1739 | |
af7b708d | 1740 | /* Clear unknown autoclear feature bits */ |
88ddffae | 1741 | update_header |= s->autoclear_features & ~QCOW2_AUTOCLEAR_MASK; |
307261b2 | 1742 | update_header = update_header && bdrv_is_writable(bs); |
d1258dd0 | 1743 | if (update_header) { |
88ddffae | 1744 | s->autoclear_features &= QCOW2_AUTOCLEAR_MASK; |
d1258dd0 VSO |
1745 | } |
1746 | ||
9c98f145 VSO |
1747 | /* == Handle persistent dirty bitmaps == |
1748 | * | |
1749 | * We want load dirty bitmaps in three cases: | |
1750 | * | |
1751 | * 1. Normal open of the disk in active mode, not related to invalidation | |
1752 | * after migration. | |
1753 | * | |
1754 | * 2. Invalidation of the target vm after pre-copy phase of migration, if | |
1755 | * bitmaps are _not_ migrating through migration channel, i.e. | |
1756 | * 'dirty-bitmaps' capability is disabled. | |
1757 | * | |
1758 | * 3. Invalidation of source vm after failed or canceled migration. | |
1759 | * This is a very interesting case. There are two possible types of | |
1760 | * bitmaps: | |
1761 | * | |
1762 | * A. Stored on inactivation and removed. They should be loaded from the | |
1763 | * image. | |
1764 | * | |
1765 | * B. Not stored: not-persistent bitmaps and bitmaps, migrated through | |
1766 | * the migration channel (with dirty-bitmaps capability). | |
1767 | * | |
1768 | * On the other hand, there are two possible sub-cases: | |
1769 | * | |
1770 | * 3.1 disk was changed by somebody else while were inactive. In this | |
1771 | * case all in-RAM dirty bitmaps (both persistent and not) are | |
1772 | * definitely invalid. And we don't have any method to determine | |
1773 | * this. | |
1774 | * | |
1775 | * Simple and safe thing is to just drop all the bitmaps of type B on | |
1776 | * inactivation. But in this case we lose bitmaps in valid 4.2 case. | |
1777 | * | |
1778 | * On the other hand, resuming source vm, if disk was already changed | |
1779 | * is a bad thing anyway: not only bitmaps, the whole vm state is | |
1780 | * out of sync with disk. | |
1781 | * | |
1782 | * This means, that user or management tool, who for some reason | |
1783 | * decided to resume source vm, after disk was already changed by | |
1784 | * target vm, should at least drop all dirty bitmaps by hand. | |
1785 | * | |
1786 | * So, we can ignore this case for now, but TODO: "generation" | |
1787 | * extension for qcow2, to determine, that image was changed after | |
1788 | * last inactivation. And if it is changed, we will drop (or at least | |
1789 | * mark as 'invalid' all the bitmaps of type B, both persistent | |
1790 | * and not). | |
1791 | * | |
1792 | * 3.2 disk was _not_ changed while were inactive. Bitmaps may be saved | |
1793 | * to disk ('dirty-bitmaps' capability disabled), or not saved | |
1794 | * ('dirty-bitmaps' capability enabled), but we don't need to care | |
1795 | * of: let's load bitmaps as always: stored bitmaps will be loaded, | |
1796 | * and not stored has flag IN_USE=1 in the image and will be skipped | |
1797 | * on loading. | |
1798 | * | |
1799 | * One remaining possible case when we don't want load bitmaps: | |
1800 | * | |
1801 | * 4. Open disk in inactive mode in target vm (bitmaps are migrating or | |
1802 | * will be loaded on invalidation, no needs try loading them before) | |
1803 | */ | |
1804 | ||
1805 | if (!(bdrv_get_flags(bs) & BDRV_O_INACTIVE)) { | |
1806 | /* It's case 1, 2 or 3.2. Or 3.1 which is BUG in management layer. */ | |
0c1e9d2a VSO |
1807 | bool header_updated; |
1808 | if (!qcow2_load_dirty_bitmaps(bs, &header_updated, errp)) { | |
66be5c3e T |
1809 | ret = -EINVAL; |
1810 | goto fail; | |
1811 | } | |
9c98f145 VSO |
1812 | |
1813 | update_header = update_header && !header_updated; | |
d1258dd0 | 1814 | } |
d1258dd0 VSO |
1815 | |
1816 | if (update_header) { | |
af7b708d SH |
1817 | ret = qcow2_update_header(bs); |
1818 | if (ret < 0) { | |
3ef6c40a | 1819 | error_setg_errno(errp, -ret, "Could not update qcow2 header"); |
af7b708d SH |
1820 | goto fail; |
1821 | } | |
1822 | } | |
1823 | ||
3b650816 KW |
1824 | bs->supported_zero_flags = header.version >= 3 ? |
1825 | BDRV_REQ_MAY_UNMAP | BDRV_REQ_NO_FALLBACK : 0; | |
f01643fb | 1826 | bs->supported_truncate_flags = BDRV_REQ_ZERO_WRITE; |
68d100e9 | 1827 | |
c61d0004 | 1828 | /* Repair image if dirty */ |
307261b2 | 1829 | if (!(flags & BDRV_O_CHECK) && bdrv_is_writable(bs) && |
058f8f16 | 1830 | (s->incompatible_features & QCOW2_INCOMPAT_DIRTY)) { |
c61d0004 SH |
1831 | BdrvCheckResult result = {0}; |
1832 | ||
2fd61638 PB |
1833 | ret = qcow2_co_check_locked(bs, &result, |
1834 | BDRV_FIX_ERRORS | BDRV_FIX_LEAKS); | |
791fff50 HR |
1835 | if (ret < 0 || result.check_errors) { |
1836 | if (ret >= 0) { | |
1837 | ret = -EIO; | |
1838 | } | |
3ef6c40a | 1839 | error_setg_errno(errp, -ret, "Could not repair dirty image"); |
c61d0004 SH |
1840 | goto fail; |
1841 | } | |
1842 | } | |
1843 | ||
585f8587 | 1844 | #ifdef DEBUG_ALLOC |
6cbc3031 PH |
1845 | { |
1846 | BdrvCheckResult result = {0}; | |
b35278f7 | 1847 | qcow2_check_refcounts(bs, &result, 0); |
6cbc3031 | 1848 | } |
585f8587 | 1849 | #endif |
ceb029cd | 1850 | |
6f13a316 | 1851 | qemu_co_queue_init(&s->thread_task_queue); |
ceb029cd | 1852 | |
6d85a57e | 1853 | return ret; |
585f8587 FB |
1854 | |
1855 | fail: | |
9b890bdc | 1856 | g_free(s->image_data_file); |
06e9cd19 | 1857 | if (open_data_file && has_data_file(bs)) { |
0e8c08be | 1858 | bdrv_unref_child(bs, s->data_file); |
808cf3cb | 1859 | s->data_file = NULL; |
0e8c08be | 1860 | } |
6744cbab | 1861 | g_free(s->unknown_header_fields); |
75bab85c | 1862 | cleanup_unknown_header_ext(bs); |
ed6ccf0f KW |
1863 | qcow2_free_snapshots(bs); |
1864 | qcow2_refcount_close(bs); | |
de82815d | 1865 | qemu_vfree(s->l1_table); |
cf93980e HR |
1866 | /* else pre-write overlap checks in cache_destroy may crash */ |
1867 | s->l1_table = NULL; | |
279621c0 | 1868 | cache_clean_timer_del(bs); |
29c1a730 | 1869 | if (s->l2_table_cache) { |
e64d4072 | 1870 | qcow2_cache_destroy(s->l2_table_cache); |
29c1a730 | 1871 | } |
c5a33ee9 | 1872 | if (s->refcount_block_cache) { |
e64d4072 | 1873 | qcow2_cache_destroy(s->refcount_block_cache); |
c5a33ee9 | 1874 | } |
b25b387f DB |
1875 | qcrypto_block_free(s->crypto); |
1876 | qapi_free_QCryptoBlockOpenOptions(s->crypto_opts); | |
6d85a57e | 1877 | return ret; |
585f8587 FB |
1878 | } |
1879 | ||
1fafcd93 PB |
1880 | typedef struct QCow2OpenCo { |
1881 | BlockDriverState *bs; | |
1882 | QDict *options; | |
1883 | int flags; | |
1884 | Error **errp; | |
1885 | int ret; | |
1886 | } QCow2OpenCo; | |
1887 | ||
1888 | static void coroutine_fn qcow2_open_entry(void *opaque) | |
1889 | { | |
1890 | QCow2OpenCo *qoc = opaque; | |
1891 | BDRVQcow2State *s = qoc->bs->opaque; | |
1892 | ||
1893 | qemu_co_mutex_lock(&s->lock); | |
06e9cd19 HR |
1894 | qoc->ret = qcow2_do_open(qoc->bs, qoc->options, qoc->flags, true, |
1895 | qoc->errp); | |
1fafcd93 PB |
1896 | qemu_co_mutex_unlock(&s->lock); |
1897 | } | |
1898 | ||
4e4bf5c4 KW |
1899 | static int qcow2_open(BlockDriverState *bs, QDict *options, int flags, |
1900 | Error **errp) | |
1901 | { | |
1fafcd93 PB |
1902 | BDRVQcow2State *s = bs->opaque; |
1903 | QCow2OpenCo qoc = { | |
1904 | .bs = bs, | |
1905 | .options = options, | |
1906 | .flags = flags, | |
1907 | .errp = errp, | |
1908 | .ret = -EINPROGRESS | |
1909 | }; | |
83930780 | 1910 | int ret; |
1fafcd93 | 1911 | |
83930780 VSO |
1912 | ret = bdrv_open_file_child(NULL, options, "file", bs, errp); |
1913 | if (ret < 0) { | |
1914 | return ret; | |
4e4bf5c4 KW |
1915 | } |
1916 | ||
1fafcd93 PB |
1917 | /* Initialise locks */ |
1918 | qemu_co_mutex_init(&s->lock); | |
1919 | ||
1920 | if (qemu_in_coroutine()) { | |
1921 | /* From bdrv_co_create. */ | |
1922 | qcow2_open_entry(&qoc); | |
1923 | } else { | |
4720cbee | 1924 | assert(qemu_get_current_aio_context() == qemu_get_aio_context()); |
1fafcd93 PB |
1925 | qemu_coroutine_enter(qemu_coroutine_create(qcow2_open_entry, &qoc)); |
1926 | BDRV_POLL_WHILE(bs, qoc.ret == -EINPROGRESS); | |
1927 | } | |
1928 | return qoc.ret; | |
4e4bf5c4 KW |
1929 | } |
1930 | ||
3baca891 | 1931 | static void qcow2_refresh_limits(BlockDriverState *bs, Error **errp) |
d34682cd | 1932 | { |
ff99129a | 1933 | BDRVQcow2State *s = bs->opaque; |
d34682cd | 1934 | |
a84178cc EB |
1935 | if (bs->encrypted) { |
1936 | /* Encryption works on a sector granularity */ | |
6f8f015c | 1937 | bs->bl.request_alignment = qcrypto_block_get_sector_size(s->crypto); |
a84178cc | 1938 | } |
a6841a2d | 1939 | bs->bl.pwrite_zeroes_alignment = s->subcluster_size; |
ecdbead6 | 1940 | bs->bl.pdiscard_alignment = s->cluster_size; |
d34682cd KW |
1941 | } |
1942 | ||
21d82ac9 JC |
1943 | static int qcow2_reopen_prepare(BDRVReopenState *state, |
1944 | BlockReopenQueue *queue, Error **errp) | |
1945 | { | |
bcfd86d6 | 1946 | BDRVQcow2State *s = state->bs->opaque; |
5b0959a7 | 1947 | Qcow2ReopenState *r; |
4c2e5f8f KW |
1948 | int ret; |
1949 | ||
5b0959a7 KW |
1950 | r = g_new0(Qcow2ReopenState, 1); |
1951 | state->opaque = r; | |
1952 | ||
1953 | ret = qcow2_update_options_prepare(state->bs, r, state->options, | |
1954 | state->flags, errp); | |
1955 | if (ret < 0) { | |
1956 | goto fail; | |
1957 | } | |
1958 | ||
1959 | /* We need to write out any unwritten data if we reopen read-only. */ | |
4c2e5f8f | 1960 | if ((state->flags & BDRV_O_RDWR) == 0) { |
169b8793 VSO |
1961 | ret = qcow2_reopen_bitmaps_ro(state->bs, errp); |
1962 | if (ret < 0) { | |
1963 | goto fail; | |
1964 | } | |
1965 | ||
4c2e5f8f KW |
1966 | ret = bdrv_flush(state->bs); |
1967 | if (ret < 0) { | |
5b0959a7 | 1968 | goto fail; |
4c2e5f8f KW |
1969 | } |
1970 | ||
1971 | ret = qcow2_mark_clean(state->bs); | |
1972 | if (ret < 0) { | |
5b0959a7 | 1973 | goto fail; |
4c2e5f8f KW |
1974 | } |
1975 | } | |
1976 | ||
bcfd86d6 KW |
1977 | /* |
1978 | * Without an external data file, s->data_file points to the same BdrvChild | |
1979 | * as bs->file. It needs to be resynced after reopen because bs->file may | |
1980 | * be changed. We can't use it in the meantime. | |
1981 | */ | |
1982 | if (!has_data_file(state->bs)) { | |
1983 | assert(s->data_file == state->bs->file); | |
1984 | s->data_file = NULL; | |
1985 | } | |
1986 | ||
21d82ac9 | 1987 | return 0; |
5b0959a7 KW |
1988 | |
1989 | fail: | |
1990 | qcow2_update_options_abort(state->bs, r); | |
1991 | g_free(r); | |
1992 | return ret; | |
1993 | } | |
1994 | ||
1995 | static void qcow2_reopen_commit(BDRVReopenState *state) | |
1996 | { | |
bcfd86d6 KW |
1997 | BDRVQcow2State *s = state->bs->opaque; |
1998 | ||
5b0959a7 | 1999 | qcow2_update_options_commit(state->bs, state->opaque); |
bcfd86d6 KW |
2000 | if (!s->data_file) { |
2001 | /* | |
2002 | * If we don't have an external data file, s->data_file was cleared by | |
2003 | * qcow2_reopen_prepare() and needs to be updated. | |
2004 | */ | |
2005 | s->data_file = state->bs->file; | |
2006 | } | |
65eb7c85 PK |
2007 | g_free(state->opaque); |
2008 | } | |
2009 | ||
2010 | static void qcow2_reopen_commit_post(BDRVReopenState *state) | |
2011 | { | |
4dd09f62 VSO |
2012 | if (state->flags & BDRV_O_RDWR) { |
2013 | Error *local_err = NULL; | |
2014 | ||
2015 | if (qcow2_reopen_bitmaps_rw(state->bs, &local_err) < 0) { | |
2016 | /* | |
2017 | * This is not fatal, bitmaps just left read-only, so all following | |
2018 | * writes will fail. User can remove read-only bitmaps to unblock | |
2019 | * writes or retry reopen. | |
2020 | */ | |
2021 | error_reportf_err(local_err, | |
2022 | "%s: Failed to make dirty bitmaps writable: ", | |
2023 | bdrv_get_node_name(state->bs)); | |
2024 | } | |
2025 | } | |
5b0959a7 KW |
2026 | } |
2027 | ||
2028 | static void qcow2_reopen_abort(BDRVReopenState *state) | |
2029 | { | |
bcfd86d6 KW |
2030 | BDRVQcow2State *s = state->bs->opaque; |
2031 | ||
2032 | if (!s->data_file) { | |
2033 | /* | |
2034 | * If we don't have an external data file, s->data_file was cleared by | |
2035 | * qcow2_reopen_prepare() and needs to be restored. | |
2036 | */ | |
2037 | s->data_file = state->bs->file; | |
2038 | } | |
5b0959a7 KW |
2039 | qcow2_update_options_abort(state->bs, state->opaque); |
2040 | g_free(state->opaque); | |
21d82ac9 JC |
2041 | } |
2042 | ||
5365f44d KW |
2043 | static void qcow2_join_options(QDict *options, QDict *old_options) |
2044 | { | |
2045 | bool has_new_overlap_template = | |
2046 | qdict_haskey(options, QCOW2_OPT_OVERLAP) || | |
2047 | qdict_haskey(options, QCOW2_OPT_OVERLAP_TEMPLATE); | |
2048 | bool has_new_total_cache_size = | |
2049 | qdict_haskey(options, QCOW2_OPT_CACHE_SIZE); | |
2050 | bool has_all_cache_options; | |
2051 | ||
2052 | /* New overlap template overrides all old overlap options */ | |
2053 | if (has_new_overlap_template) { | |
2054 | qdict_del(old_options, QCOW2_OPT_OVERLAP); | |
2055 | qdict_del(old_options, QCOW2_OPT_OVERLAP_TEMPLATE); | |
2056 | qdict_del(old_options, QCOW2_OPT_OVERLAP_MAIN_HEADER); | |
2057 | qdict_del(old_options, QCOW2_OPT_OVERLAP_ACTIVE_L1); | |
2058 | qdict_del(old_options, QCOW2_OPT_OVERLAP_ACTIVE_L2); | |
2059 | qdict_del(old_options, QCOW2_OPT_OVERLAP_REFCOUNT_TABLE); | |
2060 | qdict_del(old_options, QCOW2_OPT_OVERLAP_REFCOUNT_BLOCK); | |
2061 | qdict_del(old_options, QCOW2_OPT_OVERLAP_SNAPSHOT_TABLE); | |
2062 | qdict_del(old_options, QCOW2_OPT_OVERLAP_INACTIVE_L1); | |
2063 | qdict_del(old_options, QCOW2_OPT_OVERLAP_INACTIVE_L2); | |
2064 | } | |
2065 | ||
2066 | /* New total cache size overrides all old options */ | |
2067 | if (qdict_haskey(options, QCOW2_OPT_CACHE_SIZE)) { | |
2068 | qdict_del(old_options, QCOW2_OPT_L2_CACHE_SIZE); | |
2069 | qdict_del(old_options, QCOW2_OPT_REFCOUNT_CACHE_SIZE); | |
2070 | } | |
2071 | ||
2072 | qdict_join(options, old_options, false); | |
2073 | ||
2074 | /* | |
2075 | * If after merging all cache size options are set, an old total size is | |
2076 | * overwritten. Do keep all options, however, if all three are new. The | |
2077 | * resulting error message is what we want to happen. | |
2078 | */ | |
2079 | has_all_cache_options = | |
2080 | qdict_haskey(options, QCOW2_OPT_CACHE_SIZE) || | |
2081 | qdict_haskey(options, QCOW2_OPT_L2_CACHE_SIZE) || | |
2082 | qdict_haskey(options, QCOW2_OPT_REFCOUNT_CACHE_SIZE); | |
2083 | ||
2084 | if (has_all_cache_options && !has_new_total_cache_size) { | |
2085 | qdict_del(options, QCOW2_OPT_CACHE_SIZE); | |
2086 | } | |
2087 | } | |
2088 | ||
a320fb04 EB |
2089 | static int coroutine_fn qcow2_co_block_status(BlockDriverState *bs, |
2090 | bool want_zero, | |
2091 | int64_t offset, int64_t count, | |
2092 | int64_t *pnum, int64_t *map, | |
2093 | BlockDriverState **file) | |
585f8587 | 2094 | { |
ff99129a | 2095 | BDRVQcow2State *s = bs->opaque; |
388e5816 | 2096 | uint64_t host_offset; |
ecfe1863 | 2097 | unsigned int bytes; |
10dabdc5 | 2098 | QCow2SubclusterType type; |
74e60fb5 | 2099 | int ret, status = 0; |
585f8587 | 2100 | |
5e978550 KW |
2101 | qemu_co_mutex_lock(&s->lock); |
2102 | ||
69f47505 VSO |
2103 | if (!s->metadata_preallocation_checked) { |
2104 | ret = qcow2_detect_metadata_preallocation(bs); | |
2105 | s->metadata_preallocation = (ret == 1); | |
2106 | s->metadata_preallocation_checked = true; | |
2107 | } | |
2108 | ||
a320fb04 | 2109 | bytes = MIN(INT_MAX, count); |
ca4a0bb8 | 2110 | ret = qcow2_get_host_offset(bs, offset, &bytes, &host_offset, &type); |
f8a2e5e3 | 2111 | qemu_co_mutex_unlock(&s->lock); |
1c46efaa | 2112 | if (ret < 0) { |
d663640c | 2113 | return ret; |
1c46efaa | 2114 | } |
095a9c58 | 2115 | |
a320fb04 | 2116 | *pnum = bytes; |
ecfe1863 | 2117 | |
10dabdc5 | 2118 | if ((type == QCOW2_SUBCLUSTER_NORMAL || |
97490a14 AG |
2119 | type == QCOW2_SUBCLUSTER_ZERO_ALLOC || |
2120 | type == QCOW2_SUBCLUSTER_UNALLOCATED_ALLOC) && !s->crypto) { | |
388e5816 | 2121 | *map = host_offset; |
37be1403 | 2122 | *file = s->data_file->bs; |
a320fb04 | 2123 | status |= BDRV_BLOCK_OFFSET_VALID; |
4bc74be9 | 2124 | } |
10dabdc5 AG |
2125 | if (type == QCOW2_SUBCLUSTER_ZERO_PLAIN || |
2126 | type == QCOW2_SUBCLUSTER_ZERO_ALLOC) { | |
4bc74be9 | 2127 | status |= BDRV_BLOCK_ZERO; |
97490a14 AG |
2128 | } else if (type != QCOW2_SUBCLUSTER_UNALLOCATED_PLAIN && |
2129 | type != QCOW2_SUBCLUSTER_UNALLOCATED_ALLOC) { | |
4bc74be9 PB |
2130 | status |= BDRV_BLOCK_DATA; |
2131 | } | |
69f47505 VSO |
2132 | if (s->metadata_preallocation && (status & BDRV_BLOCK_DATA) && |
2133 | (status & BDRV_BLOCK_OFFSET_VALID)) | |
2134 | { | |
2135 | status |= BDRV_BLOCK_RECURSE; | |
2136 | } | |
4bc74be9 | 2137 | return status; |
585f8587 FB |
2138 | } |
2139 | ||
fd9fcd37 FZ |
2140 | static coroutine_fn int qcow2_handle_l2meta(BlockDriverState *bs, |
2141 | QCowL2Meta **pl2meta, | |
2142 | bool link_l2) | |
2143 | { | |
2144 | int ret = 0; | |
2145 | QCowL2Meta *l2meta = *pl2meta; | |
2146 | ||
2147 | while (l2meta != NULL) { | |
2148 | QCowL2Meta *next; | |
2149 | ||
354d930d | 2150 | if (link_l2) { |
fd9fcd37 FZ |
2151 | ret = qcow2_alloc_cluster_link_l2(bs, l2meta); |
2152 | if (ret) { | |
2153 | goto out; | |
2154 | } | |
8b24cd14 KW |
2155 | } else { |
2156 | qcow2_alloc_cluster_abort(bs, l2meta); | |
fd9fcd37 FZ |
2157 | } |
2158 | ||
2159 | /* Take the request off the list of running requests */ | |
f7bd5bba | 2160 | QLIST_REMOVE(l2meta, next_in_flight); |
fd9fcd37 FZ |
2161 | |
2162 | qemu_co_queue_restart_all(&l2meta->dependent_requests); | |
2163 | ||
2164 | next = l2meta->next; | |
2165 | g_free(l2meta); | |
2166 | l2meta = next; | |
2167 | } | |
2168 | out: | |
2169 | *pl2meta = l2meta; | |
2170 | return ret; | |
2171 | } | |
2172 | ||
88f468e5 VSO |
2173 | static coroutine_fn int |
2174 | qcow2_co_preadv_encrypted(BlockDriverState *bs, | |
9c4269d5 | 2175 | uint64_t host_offset, |
88f468e5 VSO |
2176 | uint64_t offset, |
2177 | uint64_t bytes, | |
2178 | QEMUIOVector *qiov, | |
2179 | uint64_t qiov_offset) | |
2180 | { | |
2181 | int ret; | |
2182 | BDRVQcow2State *s = bs->opaque; | |
2183 | uint8_t *buf; | |
2184 | ||
2185 | assert(bs->encrypted && s->crypto); | |
2186 | assert(bytes <= QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size); | |
2187 | ||
2188 | /* | |
2189 | * For encrypted images, read everything into a temporary | |
2190 | * contiguous buffer on which the AES functions can work. | |
2191 | * Also, decryption in a separate buffer is better as it | |
2192 | * prevents the guest from learning information about the | |
2193 | * encrypted nature of the virtual disk. | |
2194 | */ | |
2195 | ||
2196 | buf = qemu_try_blockalign(s->data_file->bs, bytes); | |
2197 | if (buf == NULL) { | |
2198 | return -ENOMEM; | |
2199 | } | |
2200 | ||
2201 | BLKDBG_EVENT(bs->file, BLKDBG_READ_AIO); | |
9c4269d5 | 2202 | ret = bdrv_co_pread(s->data_file, host_offset, bytes, buf, 0); |
88f468e5 VSO |
2203 | if (ret < 0) { |
2204 | goto fail; | |
2205 | } | |
2206 | ||
9c4269d5 | 2207 | if (qcow2_co_decrypt(bs, host_offset, offset, buf, bytes) < 0) |
88f468e5 VSO |
2208 | { |
2209 | ret = -EIO; | |
2210 | goto fail; | |
2211 | } | |
2212 | qemu_iovec_from_buf(qiov, qiov_offset, buf, bytes); | |
2213 | ||
2214 | fail: | |
2215 | qemu_vfree(buf); | |
2216 | ||
2217 | return ret; | |
2218 | } | |
2219 | ||
d710cf57 VSO |
2220 | typedef struct Qcow2AioTask { |
2221 | AioTask task; | |
2222 | ||
2223 | BlockDriverState *bs; | |
10dabdc5 | 2224 | QCow2SubclusterType subcluster_type; /* only for read */ |
9a3978a4 | 2225 | uint64_t host_offset; /* or l2_entry for compressed read */ |
d710cf57 VSO |
2226 | uint64_t offset; |
2227 | uint64_t bytes; | |
2228 | QEMUIOVector *qiov; | |
2229 | uint64_t qiov_offset; | |
2230 | QCowL2Meta *l2meta; /* only for write */ | |
2231 | } Qcow2AioTask; | |
2232 | ||
2233 | static coroutine_fn int qcow2_co_preadv_task_entry(AioTask *task); | |
2234 | static coroutine_fn int qcow2_add_task(BlockDriverState *bs, | |
2235 | AioTaskPool *pool, | |
2236 | AioTaskFunc func, | |
10dabdc5 | 2237 | QCow2SubclusterType subcluster_type, |
9c4269d5 | 2238 | uint64_t host_offset, |
d710cf57 VSO |
2239 | uint64_t offset, |
2240 | uint64_t bytes, | |
2241 | QEMUIOVector *qiov, | |
2242 | size_t qiov_offset, | |
2243 | QCowL2Meta *l2meta) | |
2244 | { | |
2245 | Qcow2AioTask local_task; | |
2246 | Qcow2AioTask *task = pool ? g_new(Qcow2AioTask, 1) : &local_task; | |
2247 | ||
2248 | *task = (Qcow2AioTask) { | |
2249 | .task.func = func, | |
2250 | .bs = bs, | |
10dabdc5 | 2251 | .subcluster_type = subcluster_type, |
d710cf57 | 2252 | .qiov = qiov, |
9c4269d5 | 2253 | .host_offset = host_offset, |
d710cf57 VSO |
2254 | .offset = offset, |
2255 | .bytes = bytes, | |
2256 | .qiov_offset = qiov_offset, | |
2257 | .l2meta = l2meta, | |
2258 | }; | |
2259 | ||
2260 | trace_qcow2_add_task(qemu_coroutine_self(), bs, pool, | |
2261 | func == qcow2_co_preadv_task_entry ? "read" : "write", | |
10dabdc5 | 2262 | subcluster_type, host_offset, offset, bytes, |
d710cf57 VSO |
2263 | qiov, qiov_offset); |
2264 | ||
2265 | if (!pool) { | |
2266 | return func(&task->task); | |
2267 | } | |
2268 | ||
2269 | aio_task_pool_start_task(pool, &task->task); | |
2270 | ||
2271 | return 0; | |
2272 | } | |
2273 | ||
88f468e5 | 2274 | static coroutine_fn int qcow2_co_preadv_task(BlockDriverState *bs, |
10dabdc5 | 2275 | QCow2SubclusterType subc_type, |
9c4269d5 | 2276 | uint64_t host_offset, |
88f468e5 VSO |
2277 | uint64_t offset, uint64_t bytes, |
2278 | QEMUIOVector *qiov, | |
2279 | size_t qiov_offset) | |
2280 | { | |
2281 | BDRVQcow2State *s = bs->opaque; | |
88f468e5 | 2282 | |
10dabdc5 AG |
2283 | switch (subc_type) { |
2284 | case QCOW2_SUBCLUSTER_ZERO_PLAIN: | |
2285 | case QCOW2_SUBCLUSTER_ZERO_ALLOC: | |
88f468e5 VSO |
2286 | /* Both zero types are handled in qcow2_co_preadv_part */ |
2287 | g_assert_not_reached(); | |
2288 | ||
10dabdc5 | 2289 | case QCOW2_SUBCLUSTER_UNALLOCATED_PLAIN: |
97490a14 | 2290 | case QCOW2_SUBCLUSTER_UNALLOCATED_ALLOC: |
88f468e5 VSO |
2291 | assert(bs->backing); /* otherwise handled in qcow2_co_preadv_part */ |
2292 | ||
2293 | BLKDBG_EVENT(bs->file, BLKDBG_READ_BACKING_AIO); | |
2294 | return bdrv_co_preadv_part(bs->backing, offset, bytes, | |
2295 | qiov, qiov_offset, 0); | |
2296 | ||
10dabdc5 | 2297 | case QCOW2_SUBCLUSTER_COMPRESSED: |
9c4269d5 | 2298 | return qcow2_co_preadv_compressed(bs, host_offset, |
88f468e5 VSO |
2299 | offset, bytes, qiov, qiov_offset); |
2300 | ||
10dabdc5 | 2301 | case QCOW2_SUBCLUSTER_NORMAL: |
88f468e5 | 2302 | if (bs->encrypted) { |
9c4269d5 | 2303 | return qcow2_co_preadv_encrypted(bs, host_offset, |
88f468e5 VSO |
2304 | offset, bytes, qiov, qiov_offset); |
2305 | } | |
2306 | ||
2307 | BLKDBG_EVENT(bs->file, BLKDBG_READ_AIO); | |
9c4269d5 | 2308 | return bdrv_co_preadv_part(s->data_file, host_offset, |
88f468e5 VSO |
2309 | bytes, qiov, qiov_offset, 0); |
2310 | ||
2311 | default: | |
2312 | g_assert_not_reached(); | |
2313 | } | |
2314 | ||
2315 | g_assert_not_reached(); | |
2316 | } | |
2317 | ||
d710cf57 VSO |
2318 | static coroutine_fn int qcow2_co_preadv_task_entry(AioTask *task) |
2319 | { | |
2320 | Qcow2AioTask *t = container_of(task, Qcow2AioTask, task); | |
2321 | ||
2322 | assert(!t->l2meta); | |
2323 | ||
10dabdc5 AG |
2324 | return qcow2_co_preadv_task(t->bs, t->subcluster_type, |
2325 | t->host_offset, t->offset, t->bytes, | |
2326 | t->qiov, t->qiov_offset); | |
d710cf57 VSO |
2327 | } |
2328 | ||
df893d25 | 2329 | static coroutine_fn int qcow2_co_preadv_part(BlockDriverState *bs, |
f7ef38dd | 2330 | int64_t offset, int64_t bytes, |
df893d25 | 2331 | QEMUIOVector *qiov, |
f7ef38dd VSO |
2332 | size_t qiov_offset, |
2333 | BdrvRequestFlags flags) | |
585f8587 | 2334 | { |
ff99129a | 2335 | BDRVQcow2State *s = bs->opaque; |
d710cf57 | 2336 | int ret = 0; |
ecfe1863 | 2337 | unsigned int cur_bytes; /* number of bytes in current iteration */ |
388e5816 | 2338 | uint64_t host_offset = 0; |
10dabdc5 | 2339 | QCow2SubclusterType type; |
d710cf57 | 2340 | AioTaskPool *aio = NULL; |
585f8587 | 2341 | |
d710cf57 | 2342 | while (bytes != 0 && aio_task_pool_status(aio) == 0) { |
5ebaa27e | 2343 | /* prepare next request */ |
ecfe1863 | 2344 | cur_bytes = MIN(bytes, INT_MAX); |
b25b387f | 2345 | if (s->crypto) { |
ecfe1863 KW |
2346 | cur_bytes = MIN(cur_bytes, |
2347 | QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size); | |
585f8587 | 2348 | } |
5ebaa27e | 2349 | |
f24196d3 | 2350 | qemu_co_mutex_lock(&s->lock); |
ca4a0bb8 AG |
2351 | ret = qcow2_get_host_offset(bs, offset, &cur_bytes, |
2352 | &host_offset, &type); | |
f24196d3 | 2353 | qemu_co_mutex_unlock(&s->lock); |
8af36488 | 2354 | if (ret < 0) { |
d710cf57 | 2355 | goto out; |
8af36488 | 2356 | } |
bd28f835 | 2357 | |
10dabdc5 AG |
2358 | if (type == QCOW2_SUBCLUSTER_ZERO_PLAIN || |
2359 | type == QCOW2_SUBCLUSTER_ZERO_ALLOC || | |
97490a14 AG |
2360 | (type == QCOW2_SUBCLUSTER_UNALLOCATED_PLAIN && !bs->backing) || |
2361 | (type == QCOW2_SUBCLUSTER_UNALLOCATED_ALLOC && !bs->backing)) | |
88f468e5 | 2362 | { |
df893d25 | 2363 | qemu_iovec_memset(qiov, qiov_offset, 0, cur_bytes); |
88f468e5 | 2364 | } else { |
d710cf57 VSO |
2365 | if (!aio && cur_bytes != bytes) { |
2366 | aio = aio_task_pool_new(QCOW2_MAX_WORKERS); | |
2367 | } | |
ca4a0bb8 | 2368 | ret = qcow2_add_task(bs, aio, qcow2_co_preadv_task_entry, type, |
9c4269d5 | 2369 | host_offset, offset, cur_bytes, |
d710cf57 | 2370 | qiov, qiov_offset, NULL); |
5ebaa27e | 2371 | if (ret < 0) { |
d710cf57 | 2372 | goto out; |
5ebaa27e | 2373 | } |
faf575c1 | 2374 | } |
f141eafe | 2375 | |
ecfe1863 KW |
2376 | bytes -= cur_bytes; |
2377 | offset += cur_bytes; | |
df893d25 | 2378 | qiov_offset += cur_bytes; |
5ebaa27e | 2379 | } |
68d100e9 | 2380 | |
d710cf57 VSO |
2381 | out: |
2382 | if (aio) { | |
2383 | aio_task_pool_wait_all(aio); | |
2384 | if (ret == 0) { | |
2385 | ret = aio_task_pool_status(aio); | |
2386 | } | |
2387 | g_free(aio); | |
2388 | } | |
2389 | ||
2390 | return ret; | |
585f8587 FB |
2391 | } |
2392 | ||
ee22a9d8 AG |
2393 | /* Check if it's possible to merge a write request with the writing of |
2394 | * the data from the COW regions */ | |
2395 | static bool merge_cow(uint64_t offset, unsigned bytes, | |
5396234b VSO |
2396 | QEMUIOVector *qiov, size_t qiov_offset, |
2397 | QCowL2Meta *l2meta) | |
ee22a9d8 AG |
2398 | { |
2399 | QCowL2Meta *m; | |
2400 | ||
2401 | for (m = l2meta; m != NULL; m = m->next) { | |
2402 | /* If both COW regions are empty then there's nothing to merge */ | |
2403 | if (m->cow_start.nb_bytes == 0 && m->cow_end.nb_bytes == 0) { | |
2404 | continue; | |
2405 | } | |
2406 | ||
c8bb23cb AN |
2407 | /* If COW regions are handled already, skip this too */ |
2408 | if (m->skip_cow) { | |
2409 | continue; | |
2410 | } | |
2411 | ||
3441ad4b AG |
2412 | /* |
2413 | * The write request should start immediately after the first | |
2414 | * COW region. This does not always happen because the area | |
2415 | * touched by the request can be larger than the one defined | |
2416 | * by @m (a single request can span an area consisting of a | |
2417 | * mix of previously unallocated and allocated clusters, that | |
2418 | * is why @l2meta is a list). | |
2419 | */ | |
ee22a9d8 | 2420 | if (l2meta_cow_start(m) + m->cow_start.nb_bytes != offset) { |
3441ad4b AG |
2421 | /* In this case the request starts before this region */ |
2422 | assert(offset < l2meta_cow_start(m)); | |
2423 | assert(m->cow_start.nb_bytes == 0); | |
ee22a9d8 AG |
2424 | continue; |
2425 | } | |
2426 | ||
3441ad4b AG |
2427 | /* The write request should end immediately before the second |
2428 | * COW region (see above for why it does not always happen) */ | |
ee22a9d8 | 2429 | if (m->offset + m->cow_end.offset != offset + bytes) { |
3441ad4b AG |
2430 | assert(offset + bytes > m->offset + m->cow_end.offset); |
2431 | assert(m->cow_end.nb_bytes == 0); | |
ee22a9d8 AG |
2432 | continue; |
2433 | } | |
2434 | ||
2435 | /* Make sure that adding both COW regions to the QEMUIOVector | |
2436 | * does not exceed IOV_MAX */ | |
5396234b | 2437 | if (qemu_iovec_subvec_niov(qiov, qiov_offset, bytes) > IOV_MAX - 2) { |
ee22a9d8 AG |
2438 | continue; |
2439 | } | |
2440 | ||
5396234b VSO |
2441 | m->data_qiov = qiov; |
2442 | m->data_qiov_offset = qiov_offset; | |
ee22a9d8 AG |
2443 | return true; |
2444 | } | |
2445 | ||
2446 | return false; | |
2447 | } | |
2448 | ||
46cd1e8a AG |
2449 | /* |
2450 | * Return 1 if the COW regions read as zeroes, 0 if not, < 0 on error. | |
2451 | * Note that returning 0 does not guarantee non-zero data. | |
2452 | */ | |
050ed2e7 | 2453 | static int coroutine_fn is_zero_cow(BlockDriverState *bs, QCowL2Meta *m) |
c8bb23cb AN |
2454 | { |
2455 | /* | |
2456 | * This check is designed for optimization shortcut so it must be | |
2457 | * efficient. | |
46cd1e8a AG |
2458 | * Instead of is_zero(), use bdrv_co_is_zero_fast() as it is |
2459 | * faster (but not as accurate and can result in false negatives). | |
c8bb23cb | 2460 | */ |
46cd1e8a AG |
2461 | int ret = bdrv_co_is_zero_fast(bs, m->offset + m->cow_start.offset, |
2462 | m->cow_start.nb_bytes); | |
2463 | if (ret <= 0) { | |
2464 | return ret; | |
2465 | } | |
2466 | ||
2467 | return bdrv_co_is_zero_fast(bs, m->offset + m->cow_end.offset, | |
2468 | m->cow_end.nb_bytes); | |
c8bb23cb AN |
2469 | } |
2470 | ||
050ed2e7 PB |
2471 | static int coroutine_fn handle_alloc_space(BlockDriverState *bs, |
2472 | QCowL2Meta *l2meta) | |
c8bb23cb AN |
2473 | { |
2474 | BDRVQcow2State *s = bs->opaque; | |
2475 | QCowL2Meta *m; | |
2476 | ||
2477 | if (!(s->data_file->bs->supported_zero_flags & BDRV_REQ_NO_FALLBACK)) { | |
2478 | return 0; | |
2479 | } | |
2480 | ||
2481 | if (bs->encrypted) { | |
2482 | return 0; | |
2483 | } | |
2484 | ||
2485 | for (m = l2meta; m != NULL; m = m->next) { | |
2486 | int ret; | |
bf4a66ee AG |
2487 | uint64_t start_offset = m->alloc_offset + m->cow_start.offset; |
2488 | unsigned nb_bytes = m->cow_end.offset + m->cow_end.nb_bytes - | |
2489 | m->cow_start.offset; | |
c8bb23cb AN |
2490 | |
2491 | if (!m->cow_start.nb_bytes && !m->cow_end.nb_bytes) { | |
2492 | continue; | |
2493 | } | |
2494 | ||
46cd1e8a AG |
2495 | ret = is_zero_cow(bs, m); |
2496 | if (ret < 0) { | |
2497 | return ret; | |
2498 | } else if (ret == 0) { | |
c8bb23cb AN |
2499 | continue; |
2500 | } | |
2501 | ||
2502 | /* | |
2503 | * instead of writing zero COW buffers, | |
2504 | * efficiently zero out the whole clusters | |
2505 | */ | |
2506 | ||
bf4a66ee | 2507 | ret = qcow2_pre_write_overlap_check(bs, 0, start_offset, nb_bytes, |
c8bb23cb AN |
2508 | true); |
2509 | if (ret < 0) { | |
2510 | return ret; | |
2511 | } | |
2512 | ||
2513 | BLKDBG_EVENT(bs->file, BLKDBG_CLUSTER_ALLOC_SPACE); | |
bf4a66ee | 2514 | ret = bdrv_co_pwrite_zeroes(s->data_file, start_offset, nb_bytes, |
c8bb23cb AN |
2515 | BDRV_REQ_NO_FALLBACK); |
2516 | if (ret < 0) { | |
2517 | if (ret != -ENOTSUP && ret != -EAGAIN) { | |
2518 | return ret; | |
2519 | } | |
2520 | continue; | |
2521 | } | |
2522 | ||
2523 | trace_qcow2_skip_cow(qemu_coroutine_self(), m->offset, m->nb_clusters); | |
2524 | m->skip_cow = true; | |
2525 | } | |
2526 | return 0; | |
2527 | } | |
2528 | ||
6aa7a263 VSO |
2529 | /* |
2530 | * qcow2_co_pwritev_task | |
2531 | * Called with s->lock unlocked | |
2532 | * l2meta - if not NULL, qcow2_co_pwritev_task() will consume it. Caller must | |
2533 | * not use it somehow after qcow2_co_pwritev_task() call | |
2534 | */ | |
2535 | static coroutine_fn int qcow2_co_pwritev_task(BlockDriverState *bs, | |
9c4269d5 | 2536 | uint64_t host_offset, |
6aa7a263 VSO |
2537 | uint64_t offset, uint64_t bytes, |
2538 | QEMUIOVector *qiov, | |
2539 | uint64_t qiov_offset, | |
2540 | QCowL2Meta *l2meta) | |
2541 | { | |
2542 | int ret; | |
2543 | BDRVQcow2State *s = bs->opaque; | |
2544 | void *crypt_buf = NULL; | |
6aa7a263 VSO |
2545 | QEMUIOVector encrypted_qiov; |
2546 | ||
2547 | if (bs->encrypted) { | |
2548 | assert(s->crypto); | |
2549 | assert(bytes <= QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size); | |
2550 | crypt_buf = qemu_try_blockalign(bs->file->bs, bytes); | |
2551 | if (crypt_buf == NULL) { | |
2552 | ret = -ENOMEM; | |
2553 | goto out_unlocked; | |
2554 | } | |
2555 | qemu_iovec_to_buf(qiov, qiov_offset, crypt_buf, bytes); | |
2556 | ||
9c4269d5 | 2557 | if (qcow2_co_encrypt(bs, host_offset, offset, crypt_buf, bytes) < 0) { |
6aa7a263 VSO |
2558 | ret = -EIO; |
2559 | goto out_unlocked; | |
2560 | } | |
2561 | ||
2562 | qemu_iovec_init_buf(&encrypted_qiov, crypt_buf, bytes); | |
2563 | qiov = &encrypted_qiov; | |
2564 | qiov_offset = 0; | |
2565 | } | |
2566 | ||
2567 | /* Try to efficiently initialize the physical space with zeroes */ | |
2568 | ret = handle_alloc_space(bs, l2meta); | |
2569 | if (ret < 0) { | |
2570 | goto out_unlocked; | |
2571 | } | |
2572 | ||
2573 | /* | |
2574 | * If we need to do COW, check if it's possible to merge the | |
2575 | * writing of the guest data together with that of the COW regions. | |
2576 | * If it's not possible (or not necessary) then write the | |
2577 | * guest data now. | |
2578 | */ | |
2579 | if (!merge_cow(offset, bytes, qiov, qiov_offset, l2meta)) { | |
2580 | BLKDBG_EVENT(bs->file, BLKDBG_WRITE_AIO); | |
9c4269d5 AG |
2581 | trace_qcow2_writev_data(qemu_coroutine_self(), host_offset); |
2582 | ret = bdrv_co_pwritev_part(s->data_file, host_offset, | |
6aa7a263 VSO |
2583 | bytes, qiov, qiov_offset, 0); |
2584 | if (ret < 0) { | |
2585 | goto out_unlocked; | |
2586 | } | |
2587 | } | |
2588 | ||
2589 | qemu_co_mutex_lock(&s->lock); | |
2590 | ||
2591 | ret = qcow2_handle_l2meta(bs, &l2meta, true); | |
2592 | goto out_locked; | |
2593 | ||
2594 | out_unlocked: | |
2595 | qemu_co_mutex_lock(&s->lock); | |
2596 | ||
2597 | out_locked: | |
2598 | qcow2_handle_l2meta(bs, &l2meta, false); | |
2599 | qemu_co_mutex_unlock(&s->lock); | |
2600 | ||
2601 | qemu_vfree(crypt_buf); | |
2602 | ||
2603 | return ret; | |
2604 | } | |
2605 | ||
d710cf57 VSO |
2606 | static coroutine_fn int qcow2_co_pwritev_task_entry(AioTask *task) |
2607 | { | |
2608 | Qcow2AioTask *t = container_of(task, Qcow2AioTask, task); | |
2609 | ||
10dabdc5 | 2610 | assert(!t->subcluster_type); |
d710cf57 | 2611 | |
9c4269d5 | 2612 | return qcow2_co_pwritev_task(t->bs, t->host_offset, |
d710cf57 VSO |
2613 | t->offset, t->bytes, t->qiov, t->qiov_offset, |
2614 | t->l2meta); | |
2615 | } | |
2616 | ||
5396234b | 2617 | static coroutine_fn int qcow2_co_pwritev_part( |
e75abeda VSO |
2618 | BlockDriverState *bs, int64_t offset, int64_t bytes, |
2619 | QEMUIOVector *qiov, size_t qiov_offset, BdrvRequestFlags flags) | |
585f8587 | 2620 | { |
ff99129a | 2621 | BDRVQcow2State *s = bs->opaque; |
d46a0bb2 | 2622 | int offset_in_cluster; |
68d100e9 | 2623 | int ret; |
d46a0bb2 | 2624 | unsigned int cur_bytes; /* number of sectors in current iteration */ |
bfd0989a | 2625 | uint64_t host_offset; |
8d2497c3 | 2626 | QCowL2Meta *l2meta = NULL; |
d710cf57 | 2627 | AioTaskPool *aio = NULL; |
c2271403 | 2628 | |
d46a0bb2 | 2629 | trace_qcow2_writev_start_req(qemu_coroutine_self(), offset, bytes); |
3cce16f4 | 2630 | |
d710cf57 | 2631 | while (bytes != 0 && aio_task_pool_status(aio) == 0) { |
3fc48d09 | 2632 | |
f50f88b9 | 2633 | l2meta = NULL; |
cf5c1a23 | 2634 | |
3cce16f4 | 2635 | trace_qcow2_writev_start_part(qemu_coroutine_self()); |
d46a0bb2 KW |
2636 | offset_in_cluster = offset_into_cluster(s, offset); |
2637 | cur_bytes = MIN(bytes, INT_MAX); | |
2638 | if (bs->encrypted) { | |
2639 | cur_bytes = MIN(cur_bytes, | |
2640 | QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size | |
2641 | - offset_in_cluster); | |
5ebaa27e | 2642 | } |
095a9c58 | 2643 | |
6aa7a263 VSO |
2644 | qemu_co_mutex_lock(&s->lock); |
2645 | ||
bfd0989a AG |
2646 | ret = qcow2_alloc_host_offset(bs, offset, &cur_bytes, |
2647 | &host_offset, &l2meta); | |
5ebaa27e | 2648 | if (ret < 0) { |
5447c3a0 | 2649 | goto out_locked; |
5ebaa27e | 2650 | } |
148da7ea | 2651 | |
bfd0989a | 2652 | ret = qcow2_pre_write_overlap_check(bs, 0, host_offset, |
5447c3a0 VSO |
2653 | cur_bytes, true); |
2654 | if (ret < 0) { | |
2655 | goto out_locked; | |
2656 | } | |
2657 | ||
2658 | qemu_co_mutex_unlock(&s->lock); | |
2659 | ||
d710cf57 VSO |
2660 | if (!aio && cur_bytes != bytes) { |
2661 | aio = aio_task_pool_new(QCOW2_MAX_WORKERS); | |
2662 | } | |
2663 | ret = qcow2_add_task(bs, aio, qcow2_co_pwritev_task_entry, 0, | |
bfd0989a | 2664 | host_offset, offset, |
9c4269d5 | 2665 | cur_bytes, qiov, qiov_offset, l2meta); |
6aa7a263 | 2666 | l2meta = NULL; /* l2meta is consumed by qcow2_co_pwritev_task() */ |
c8bb23cb | 2667 | if (ret < 0) { |
6aa7a263 | 2668 | goto fail_nometa; |
f50f88b9 | 2669 | } |
0fa9131a | 2670 | |
d46a0bb2 KW |
2671 | bytes -= cur_bytes; |
2672 | offset += cur_bytes; | |
6aa7a263 | 2673 | qiov_offset += cur_bytes; |
d46a0bb2 | 2674 | trace_qcow2_writev_done_part(qemu_coroutine_self(), cur_bytes); |
5ebaa27e | 2675 | } |
3fc48d09 | 2676 | ret = 0; |
faf575c1 | 2677 | |
5447c3a0 VSO |
2678 | qemu_co_mutex_lock(&s->lock); |
2679 | ||
2680 | out_locked: | |
fd9fcd37 | 2681 | qcow2_handle_l2meta(bs, &l2meta, false); |
0fa9131a | 2682 | |
a8c57408 PB |
2683 | qemu_co_mutex_unlock(&s->lock); |
2684 | ||
6aa7a263 | 2685 | fail_nometa: |
d710cf57 VSO |
2686 | if (aio) { |
2687 | aio_task_pool_wait_all(aio); | |
2688 | if (ret == 0) { | |
2689 | ret = aio_task_pool_status(aio); | |
2690 | } | |
2691 | g_free(aio); | |
2692 | } | |
2693 | ||
3cce16f4 | 2694 | trace_qcow2_writev_done_req(qemu_coroutine_self(), ret); |
42496d62 | 2695 | |
68d100e9 | 2696 | return ret; |
585f8587 FB |
2697 | } |
2698 | ||
ec6d8912 KW |
2699 | static int qcow2_inactivate(BlockDriverState *bs) |
2700 | { | |
2701 | BDRVQcow2State *s = bs->opaque; | |
2702 | int ret, result = 0; | |
5f72826e | 2703 | Error *local_err = NULL; |
ec6d8912 | 2704 | |
644ddbb7 | 2705 | qcow2_store_persistent_dirty_bitmaps(bs, true, &local_err); |
83a8c775 PB |
2706 | if (local_err != NULL) { |
2707 | result = -EINVAL; | |
132adb68 VSO |
2708 | error_reportf_err(local_err, "Lost persistent bitmaps during " |
2709 | "inactivation of node '%s': ", | |
2710 | bdrv_get_device_or_node_name(bs)); | |
83a8c775 PB |
2711 | } |
2712 | ||
ec6d8912 KW |
2713 | ret = qcow2_cache_flush(bs, s->l2_table_cache); |
2714 | if (ret) { | |
2715 | result = ret; | |
2716 | error_report("Failed to flush the L2 table cache: %s", | |
2717 | strerror(-ret)); | |
2718 | } | |
2719 | ||
2720 | ret = qcow2_cache_flush(bs, s->refcount_block_cache); | |
2721 | if (ret) { | |
2722 | result = ret; | |
2723 | error_report("Failed to flush the refcount block cache: %s", | |
2724 | strerror(-ret)); | |
2725 | } | |
2726 | ||
2727 | if (result == 0) { | |
2728 | qcow2_mark_clean(bs); | |
2729 | } | |
2730 | ||
2731 | return result; | |
2732 | } | |
2733 | ||
06e9cd19 | 2734 | static void qcow2_do_close(BlockDriverState *bs, bool close_data_file) |
585f8587 | 2735 | { |
ff99129a | 2736 | BDRVQcow2State *s = bs->opaque; |
de82815d | 2737 | qemu_vfree(s->l1_table); |
cf93980e HR |
2738 | /* else pre-write overlap checks in cache_destroy may crash */ |
2739 | s->l1_table = NULL; | |
29c1a730 | 2740 | |
140fd5a6 | 2741 | if (!(s->flags & BDRV_O_INACTIVE)) { |
ec6d8912 | 2742 | qcow2_inactivate(bs); |
27eb6c09 | 2743 | } |
c61d0004 | 2744 | |
279621c0 | 2745 | cache_clean_timer_del(bs); |
e64d4072 AG |
2746 | qcow2_cache_destroy(s->l2_table_cache); |
2747 | qcow2_cache_destroy(s->refcount_block_cache); | |
29c1a730 | 2748 | |
b25b387f DB |
2749 | qcrypto_block_free(s->crypto); |
2750 | s->crypto = NULL; | |
4aebf0f0 | 2751 | qapi_free_QCryptoBlockOpenOptions(s->crypto_opts); |
f6fa64f6 | 2752 | |
6744cbab | 2753 | g_free(s->unknown_header_fields); |
75bab85c | 2754 | cleanup_unknown_header_ext(bs); |
6744cbab | 2755 | |
9b890bdc | 2756 | g_free(s->image_data_file); |
e4603fe1 KW |
2757 | g_free(s->image_backing_file); |
2758 | g_free(s->image_backing_format); | |
2759 | ||
06e9cd19 | 2760 | if (close_data_file && has_data_file(bs)) { |
0e8c08be | 2761 | bdrv_unref_child(bs, s->data_file); |
808cf3cb | 2762 | s->data_file = NULL; |
0e8c08be KW |
2763 | } |
2764 | ||
ed6ccf0f | 2765 | qcow2_refcount_close(bs); |
28c1202b | 2766 | qcow2_free_snapshots(bs); |
585f8587 FB |
2767 | } |
2768 | ||
06e9cd19 HR |
2769 | static void qcow2_close(BlockDriverState *bs) |
2770 | { | |
2771 | qcow2_do_close(bs, true); | |
2772 | } | |
2773 | ||
2b148f39 PB |
2774 | static void coroutine_fn qcow2_co_invalidate_cache(BlockDriverState *bs, |
2775 | Error **errp) | |
06d9260f | 2776 | { |
e6247c9c | 2777 | ERRP_GUARD(); |
ff99129a | 2778 | BDRVQcow2State *s = bs->opaque; |
06e9cd19 | 2779 | BdrvChild *data_file; |
06d9260f | 2780 | int flags = s->flags; |
b25b387f | 2781 | QCryptoBlock *crypto = NULL; |
acdfb480 | 2782 | QDict *options; |
5a8a30db | 2783 | int ret; |
06d9260f AL |
2784 | |
2785 | /* | |
2786 | * Backing files are read-only which makes all of their metadata immutable, | |
2787 | * that means we don't have to worry about reopening them here. | |
2788 | */ | |
2789 | ||
b25b387f DB |
2790 | crypto = s->crypto; |
2791 | s->crypto = NULL; | |
06d9260f | 2792 | |
06e9cd19 HR |
2793 | /* |
2794 | * Do not reopen s->data_file (i.e., have qcow2_do_close() not close it, | |
2795 | * and then prevent qcow2_do_open() from opening it), because this function | |
2796 | * runs in the I/O path and as such we must not invoke global-state | |
2797 | * functions like bdrv_unref_child() and bdrv_open_child(). | |
2798 | */ | |
06d9260f | 2799 | |
06e9cd19 HR |
2800 | qcow2_do_close(bs, false); |
2801 | ||
2802 | data_file = s->data_file; | |
ff99129a | 2803 | memset(s, 0, sizeof(BDRVQcow2State)); |
06e9cd19 HR |
2804 | s->data_file = data_file; |
2805 | ||
d475e5ac | 2806 | options = qdict_clone_shallow(bs->options); |
5a8a30db | 2807 | |
140fd5a6 | 2808 | flags &= ~BDRV_O_INACTIVE; |
2b148f39 | 2809 | qemu_co_mutex_lock(&s->lock); |
06e9cd19 | 2810 | ret = qcow2_do_open(bs, options, flags, false, errp); |
2b148f39 | 2811 | qemu_co_mutex_unlock(&s->lock); |
cb3e7f08 | 2812 | qobject_unref(options); |
e6247c9c VSO |
2813 | if (ret < 0) { |
2814 | error_prepend(errp, "Could not reopen qcow2 layer: "); | |
191fb11b | 2815 | bs->drv = NULL; |
5a8a30db KW |
2816 | return; |
2817 | } | |
acdfb480 | 2818 | |
b25b387f | 2819 | s->crypto = crypto; |
06d9260f AL |
2820 | } |
2821 | ||
e24e49e6 KW |
2822 | static size_t header_ext_add(char *buf, uint32_t magic, const void *s, |
2823 | size_t len, size_t buflen) | |
2824 | { | |
2825 | QCowExtension *ext_backing_fmt = (QCowExtension*) buf; | |
2826 | size_t ext_len = sizeof(QCowExtension) + ((len + 7) & ~7); | |
2827 | ||
2828 | if (buflen < ext_len) { | |
2829 | return -ENOSPC; | |
2830 | } | |
2831 | ||
2832 | *ext_backing_fmt = (QCowExtension) { | |
2833 | .magic = cpu_to_be32(magic), | |
2834 | .len = cpu_to_be32(len), | |
2835 | }; | |
0647d47c SH |
2836 | |
2837 | if (len) { | |
2838 | memcpy(buf + sizeof(QCowExtension), s, len); | |
2839 | } | |
e24e49e6 KW |
2840 | |
2841 | return ext_len; | |
2842 | } | |
2843 | ||
756e6736 | 2844 | /* |
e24e49e6 KW |
2845 | * Updates the qcow2 header, including the variable length parts of it, i.e. |
2846 | * the backing file name and all extensions. qcow2 was not designed to allow | |
2847 | * such changes, so if we run out of space (we can only use the first cluster) | |
2848 | * this function may fail. | |
756e6736 KW |
2849 | * |
2850 | * Returns 0 on success, -errno in error cases. | |
2851 | */ | |
e24e49e6 | 2852 | int qcow2_update_header(BlockDriverState *bs) |
756e6736 | 2853 | { |
ff99129a | 2854 | BDRVQcow2State *s = bs->opaque; |
e24e49e6 KW |
2855 | QCowHeader *header; |
2856 | char *buf; | |
2857 | size_t buflen = s->cluster_size; | |
756e6736 | 2858 | int ret; |
e24e49e6 KW |
2859 | uint64_t total_size; |
2860 | uint32_t refcount_table_clusters; | |
6744cbab | 2861 | size_t header_length; |
75bab85c | 2862 | Qcow2UnknownHeaderExtension *uext; |
756e6736 | 2863 | |
e24e49e6 | 2864 | buf = qemu_blockalign(bs, buflen); |
756e6736 | 2865 | |
e24e49e6 KW |
2866 | /* Header structure */ |
2867 | header = (QCowHeader*) buf; | |
756e6736 | 2868 | |
e24e49e6 KW |
2869 | if (buflen < sizeof(*header)) { |
2870 | ret = -ENOSPC; | |
2871 | goto fail; | |
756e6736 KW |
2872 | } |
2873 | ||
6744cbab | 2874 | header_length = sizeof(*header) + s->unknown_header_fields_size; |
e24e49e6 KW |
2875 | total_size = bs->total_sectors * BDRV_SECTOR_SIZE; |
2876 | refcount_table_clusters = s->refcount_table_size >> (s->cluster_bits - 3); | |
2877 | ||
572ad978 DP |
2878 | ret = validate_compression_type(s, NULL); |
2879 | if (ret) { | |
2880 | goto fail; | |
2881 | } | |
2882 | ||
e24e49e6 | 2883 | *header = (QCowHeader) { |
6744cbab | 2884 | /* Version 2 fields */ |
e24e49e6 | 2885 | .magic = cpu_to_be32(QCOW_MAGIC), |
6744cbab | 2886 | .version = cpu_to_be32(s->qcow_version), |
e24e49e6 KW |
2887 | .backing_file_offset = 0, |
2888 | .backing_file_size = 0, | |
2889 | .cluster_bits = cpu_to_be32(s->cluster_bits), | |
2890 | .size = cpu_to_be64(total_size), | |
2891 | .crypt_method = cpu_to_be32(s->crypt_method_header), | |
2892 | .l1_size = cpu_to_be32(s->l1_size), | |
2893 | .l1_table_offset = cpu_to_be64(s->l1_table_offset), | |
2894 | .refcount_table_offset = cpu_to_be64(s->refcount_table_offset), | |
2895 | .refcount_table_clusters = cpu_to_be32(refcount_table_clusters), | |
2896 | .nb_snapshots = cpu_to_be32(s->nb_snapshots), | |
2897 | .snapshots_offset = cpu_to_be64(s->snapshots_offset), | |
6744cbab KW |
2898 | |
2899 | /* Version 3 fields */ | |
2900 | .incompatible_features = cpu_to_be64(s->incompatible_features), | |
2901 | .compatible_features = cpu_to_be64(s->compatible_features), | |
2902 | .autoclear_features = cpu_to_be64(s->autoclear_features), | |
b6481f37 | 2903 | .refcount_order = cpu_to_be32(s->refcount_order), |
6744cbab | 2904 | .header_length = cpu_to_be32(header_length), |
572ad978 | 2905 | .compression_type = s->compression_type, |
e24e49e6 | 2906 | }; |
756e6736 | 2907 | |
6744cbab KW |
2908 | /* For older versions, write a shorter header */ |
2909 | switch (s->qcow_version) { | |
2910 | case 2: | |
2911 | ret = offsetof(QCowHeader, incompatible_features); | |
2912 | break; | |
2913 | case 3: | |
2914 | ret = sizeof(*header); | |
2915 | break; | |
2916 | default: | |
b6c14762 JM |
2917 | ret = -EINVAL; |
2918 | goto fail; | |
6744cbab KW |
2919 | } |
2920 | ||
2921 | buf += ret; | |
2922 | buflen -= ret; | |
2923 | memset(buf, 0, buflen); | |
2924 | ||
2925 | /* Preserve any unknown field in the header */ | |
2926 | if (s->unknown_header_fields_size) { | |
2927 | if (buflen < s->unknown_header_fields_size) { | |
2928 | ret = -ENOSPC; | |
2929 | goto fail; | |
2930 | } | |
2931 | ||
2932 | memcpy(buf, s->unknown_header_fields, s->unknown_header_fields_size); | |
2933 | buf += s->unknown_header_fields_size; | |
2934 | buflen -= s->unknown_header_fields_size; | |
2935 | } | |
756e6736 | 2936 | |
e24e49e6 | 2937 | /* Backing file format header extension */ |
e4603fe1 | 2938 | if (s->image_backing_format) { |
e24e49e6 | 2939 | ret = header_ext_add(buf, QCOW2_EXT_MAGIC_BACKING_FORMAT, |
e4603fe1 KW |
2940 | s->image_backing_format, |
2941 | strlen(s->image_backing_format), | |
e24e49e6 KW |
2942 | buflen); |
2943 | if (ret < 0) { | |
2944 | goto fail; | |
756e6736 KW |
2945 | } |
2946 | ||
e24e49e6 KW |
2947 | buf += ret; |
2948 | buflen -= ret; | |
756e6736 KW |
2949 | } |
2950 | ||
9b890bdc KW |
2951 | /* External data file header extension */ |
2952 | if (has_data_file(bs) && s->image_data_file) { | |
2953 | ret = header_ext_add(buf, QCOW2_EXT_MAGIC_DATA_FILE, | |
2954 | s->image_data_file, strlen(s->image_data_file), | |
2955 | buflen); | |
2956 | if (ret < 0) { | |
2957 | goto fail; | |
2958 | } | |
2959 | ||
2960 | buf += ret; | |
2961 | buflen -= ret; | |
2962 | } | |
2963 | ||
4652b8f3 DB |
2964 | /* Full disk encryption header pointer extension */ |
2965 | if (s->crypto_header.offset != 0) { | |
3b698f52 PM |
2966 | s->crypto_header.offset = cpu_to_be64(s->crypto_header.offset); |
2967 | s->crypto_header.length = cpu_to_be64(s->crypto_header.length); | |
4652b8f3 DB |
2968 | ret = header_ext_add(buf, QCOW2_EXT_MAGIC_CRYPTO_HEADER, |
2969 | &s->crypto_header, sizeof(s->crypto_header), | |
2970 | buflen); | |
3b698f52 PM |
2971 | s->crypto_header.offset = be64_to_cpu(s->crypto_header.offset); |
2972 | s->crypto_header.length = be64_to_cpu(s->crypto_header.length); | |
4652b8f3 DB |
2973 | if (ret < 0) { |
2974 | goto fail; | |
2975 | } | |
2976 | buf += ret; | |
2977 | buflen -= ret; | |
2978 | } | |
2979 | ||
e7be13ad EB |
2980 | /* |
2981 | * Feature table. A mere 8 feature names occupies 392 bytes, and | |
2982 | * when coupled with the v3 minimum header of 104 bytes plus the | |
2983 | * 8-byte end-of-extension marker, that would leave only 8 bytes | |
2984 | * for a backing file name in an image with 512-byte clusters. | |
2985 | * Thus, we choose to omit this header for cluster sizes 4k and | |
2986 | * smaller. | |
2987 | */ | |
2988 | if (s->qcow_version >= 3 && s->cluster_size > 4096) { | |
bb40ebce | 2989 | static const Qcow2Feature features[] = { |
1a4828c7 KW |
2990 | { |
2991 | .type = QCOW2_FEAT_TYPE_INCOMPATIBLE, | |
2992 | .bit = QCOW2_INCOMPAT_DIRTY_BITNR, | |
2993 | .name = "dirty bit", | |
2994 | }, | |
2995 | { | |
2996 | .type = QCOW2_FEAT_TYPE_INCOMPATIBLE, | |
2997 | .bit = QCOW2_INCOMPAT_CORRUPT_BITNR, | |
2998 | .name = "corrupt bit", | |
2999 | }, | |
93c24936 KW |
3000 | { |
3001 | .type = QCOW2_FEAT_TYPE_INCOMPATIBLE, | |
3002 | .bit = QCOW2_INCOMPAT_DATA_FILE_BITNR, | |
3003 | .name = "external data file", | |
3004 | }, | |
572ad978 DP |
3005 | { |
3006 | .type = QCOW2_FEAT_TYPE_INCOMPATIBLE, | |
3007 | .bit = QCOW2_INCOMPAT_COMPRESSION_BITNR, | |
3008 | .name = "compression type", | |
3009 | }, | |
7be20252 AG |
3010 | { |
3011 | .type = QCOW2_FEAT_TYPE_INCOMPATIBLE, | |
3012 | .bit = QCOW2_INCOMPAT_EXTL2_BITNR, | |
3013 | .name = "extended L2 entries", | |
3014 | }, | |
1a4828c7 KW |
3015 | { |
3016 | .type = QCOW2_FEAT_TYPE_COMPATIBLE, | |
3017 | .bit = QCOW2_COMPAT_LAZY_REFCOUNTS_BITNR, | |
3018 | .name = "lazy refcounts", | |
3019 | }, | |
bb40ebce EB |
3020 | { |
3021 | .type = QCOW2_FEAT_TYPE_AUTOCLEAR, | |
3022 | .bit = QCOW2_AUTOCLEAR_BITMAPS_BITNR, | |
3023 | .name = "bitmaps", | |
3024 | }, | |
3025 | { | |
3026 | .type = QCOW2_FEAT_TYPE_AUTOCLEAR, | |
3027 | .bit = QCOW2_AUTOCLEAR_DATA_FILE_RAW_BITNR, | |
3028 | .name = "raw external data", | |
3029 | }, | |
1a4828c7 KW |
3030 | }; |
3031 | ||
3032 | ret = header_ext_add(buf, QCOW2_EXT_MAGIC_FEATURE_TABLE, | |
3033 | features, sizeof(features), buflen); | |
3034 | if (ret < 0) { | |
3035 | goto fail; | |
3036 | } | |
3037 | buf += ret; | |
3038 | buflen -= ret; | |
cfcc4c62 | 3039 | } |
cfcc4c62 | 3040 | |
88ddffae VSO |
3041 | /* Bitmap extension */ |
3042 | if (s->nb_bitmaps > 0) { | |
3043 | Qcow2BitmapHeaderExt bitmaps_header = { | |
3044 | .nb_bitmaps = cpu_to_be32(s->nb_bitmaps), | |
3045 | .bitmap_directory_size = | |
3046 | cpu_to_be64(s->bitmap_directory_size), | |
3047 | .bitmap_directory_offset = | |
3048 | cpu_to_be64(s->bitmap_directory_offset) | |
3049 | }; | |
3050 | ret = header_ext_add(buf, QCOW2_EXT_MAGIC_BITMAPS, | |
3051 | &bitmaps_header, sizeof(bitmaps_header), | |
3052 | buflen); | |
3053 | if (ret < 0) { | |
3054 | goto fail; | |
3055 | } | |
3056 | buf += ret; | |
3057 | buflen -= ret; | |
3058 | } | |
3059 | ||
75bab85c KW |
3060 | /* Keep unknown header extensions */ |
3061 | QLIST_FOREACH(uext, &s->unknown_header_ext, next) { | |
3062 | ret = header_ext_add(buf, uext->magic, uext->data, uext->len, buflen); | |
3063 | if (ret < 0) { | |
3064 | goto fail; | |
3065 | } | |
3066 | ||
3067 | buf += ret; | |
3068 | buflen -= ret; | |
3069 | } | |
3070 | ||
e24e49e6 KW |
3071 | /* End of header extensions */ |
3072 | ret = header_ext_add(buf, QCOW2_EXT_MAGIC_END, NULL, 0, buflen); | |
756e6736 KW |
3073 | if (ret < 0) { |
3074 | goto fail; | |
3075 | } | |
3076 | ||
e24e49e6 KW |
3077 | buf += ret; |
3078 | buflen -= ret; | |
756e6736 | 3079 | |
e24e49e6 | 3080 | /* Backing file name */ |
e4603fe1 KW |
3081 | if (s->image_backing_file) { |
3082 | size_t backing_file_len = strlen(s->image_backing_file); | |
e24e49e6 KW |
3083 | |
3084 | if (buflen < backing_file_len) { | |
3085 | ret = -ENOSPC; | |
3086 | goto fail; | |
3087 | } | |
3088 | ||
00ea1881 | 3089 | /* Using strncpy is ok here, since buf is not NUL-terminated. */ |
e4603fe1 | 3090 | strncpy(buf, s->image_backing_file, buflen); |
e24e49e6 KW |
3091 | |
3092 | header->backing_file_offset = cpu_to_be64(buf - ((char*) header)); | |
3093 | header->backing_file_size = cpu_to_be32(backing_file_len); | |
756e6736 KW |
3094 | } |
3095 | ||
e24e49e6 | 3096 | /* Write the new header */ |
32cc71de | 3097 | ret = bdrv_pwrite(bs->file, 0, s->cluster_size, header, 0); |
756e6736 KW |
3098 | if (ret < 0) { |
3099 | goto fail; | |
3100 | } | |
3101 | ||
3102 | ret = 0; | |
3103 | fail: | |
e24e49e6 | 3104 | qemu_vfree(header); |
756e6736 KW |
3105 | return ret; |
3106 | } | |
3107 | ||
3108 | static int qcow2_change_backing_file(BlockDriverState *bs, | |
3109 | const char *backing_file, const char *backing_fmt) | |
3110 | { | |
ff99129a | 3111 | BDRVQcow2State *s = bs->opaque; |
e4603fe1 | 3112 | |
6c3944dc KW |
3113 | /* Adding a backing file means that the external data file alone won't be |
3114 | * enough to make sense of the content */ | |
3115 | if (backing_file && data_file_is_raw(bs)) { | |
3116 | return -EINVAL; | |
3117 | } | |
3118 | ||
4e876bcf HR |
3119 | if (backing_file && strlen(backing_file) > 1023) { |
3120 | return -EINVAL; | |
3121 | } | |
3122 | ||
998c2019 HR |
3123 | pstrcpy(bs->auto_backing_file, sizeof(bs->auto_backing_file), |
3124 | backing_file ?: ""); | |
e24e49e6 KW |
3125 | pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: ""); |
3126 | pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: ""); | |
3127 | ||
e4603fe1 KW |
3128 | g_free(s->image_backing_file); |
3129 | g_free(s->image_backing_format); | |
3130 | ||
3131 | s->image_backing_file = backing_file ? g_strdup(bs->backing_file) : NULL; | |
3132 | s->image_backing_format = backing_fmt ? g_strdup(bs->backing_format) : NULL; | |
3133 | ||
e24e49e6 | 3134 | return qcow2_update_header(bs); |
756e6736 KW |
3135 | } |
3136 | ||
60900b7b KW |
3137 | static int qcow2_set_up_encryption(BlockDriverState *bs, |
3138 | QCryptoBlockCreateOptions *cryptoopts, | |
3139 | Error **errp) | |
3140 | { | |
3141 | BDRVQcow2State *s = bs->opaque; | |
3142 | QCryptoBlock *crypto = NULL; | |
3143 | int fmt, ret; | |
3144 | ||
3145 | switch (cryptoopts->format) { | |
3146 | case Q_CRYPTO_BLOCK_FORMAT_LUKS: | |
3147 | fmt = QCOW_CRYPT_LUKS; | |
3148 | break; | |
3149 | case Q_CRYPTO_BLOCK_FORMAT_QCOW: | |
3150 | fmt = QCOW_CRYPT_AES; | |
3151 | break; | |
3152 | default: | |
3153 | error_setg(errp, "Crypto format not supported in qcow2"); | |
3154 | return -EINVAL; | |
b25b387f | 3155 | } |
60900b7b | 3156 | |
4652b8f3 | 3157 | s->crypt_method_header = fmt; |
b25b387f | 3158 | |
1cd9a787 | 3159 | crypto = qcrypto_block_create(cryptoopts, "encrypt.", |
4652b8f3 DB |
3160 | qcow2_crypto_hdr_init_func, |
3161 | qcow2_crypto_hdr_write_func, | |
b25b387f DB |
3162 | bs, errp); |
3163 | if (!crypto) { | |
60900b7b | 3164 | return -EINVAL; |
b25b387f DB |
3165 | } |
3166 | ||
3167 | ret = qcow2_update_header(bs); | |
3168 | if (ret < 0) { | |
3169 | error_setg_errno(errp, -ret, "Could not write encryption header"); | |
3170 | goto out; | |
3171 | } | |
3172 | ||
60900b7b | 3173 | ret = 0; |
b25b387f | 3174 | out: |
b25b387f | 3175 | qcrypto_block_free(crypto); |
b25b387f DB |
3176 | return ret; |
3177 | } | |
3178 | ||
7bc45dc1 HR |
3179 | /** |
3180 | * Preallocates metadata structures for data clusters between @offset (in the | |
3181 | * guest disk) and @new_length (which is thus generally the new guest disk | |
3182 | * size). | |
3183 | * | |
3184 | * Returns: 0 on success, -errno on failure. | |
3185 | */ | |
c2b8e315 KW |
3186 | static int coroutine_fn GRAPH_RDLOCK |
3187 | preallocate_co(BlockDriverState *bs, uint64_t offset, uint64_t new_length, | |
3188 | PreallocMode mode, Error **errp) | |
a35e1c17 | 3189 | { |
93e32b3e | 3190 | BDRVQcow2State *s = bs->opaque; |
d46a0bb2 | 3191 | uint64_t bytes; |
060bee89 | 3192 | uint64_t host_offset = 0; |
718c0fce | 3193 | int64_t file_length; |
d46a0bb2 | 3194 | unsigned int cur_bytes; |
148da7ea | 3195 | int ret; |
1a52b73d | 3196 | QCowL2Meta *meta = NULL, *m; |
a35e1c17 | 3197 | |
7bc45dc1 HR |
3198 | assert(offset <= new_length); |
3199 | bytes = new_length - offset; | |
a35e1c17 | 3200 | |
d46a0bb2 | 3201 | while (bytes) { |
f29fbf7c | 3202 | cur_bytes = MIN(bytes, QEMU_ALIGN_DOWN(INT_MAX, s->cluster_size)); |
bfd0989a AG |
3203 | ret = qcow2_alloc_host_offset(bs, offset, &cur_bytes, |
3204 | &host_offset, &meta); | |
148da7ea | 3205 | if (ret < 0) { |
360bd074 | 3206 | error_setg_errno(errp, -ret, "Allocating clusters failed"); |
1a52b73d | 3207 | goto out; |
a35e1c17 KW |
3208 | } |
3209 | ||
1a52b73d AG |
3210 | for (m = meta; m != NULL; m = m->next) { |
3211 | m->prealloc = true; | |
3212 | } | |
c792707f | 3213 | |
1a52b73d AG |
3214 | ret = qcow2_handle_l2meta(bs, &meta, true); |
3215 | if (ret < 0) { | |
3216 | error_setg_errno(errp, -ret, "Mapping clusters failed"); | |
3217 | goto out; | |
f50f88b9 | 3218 | } |
f214978a | 3219 | |
a35e1c17 KW |
3220 | /* TODO Preallocate data if requested */ |
3221 | ||
d46a0bb2 KW |
3222 | bytes -= cur_bytes; |
3223 | offset += cur_bytes; | |
a35e1c17 KW |
3224 | } |
3225 | ||
3226 | /* | |
3227 | * It is expected that the image file is large enough to actually contain | |
3228 | * all of the allocated clusters (otherwise we get failing reads after | |
3229 | * EOF). Extend the image to the last allocated sector. | |
3230 | */ | |
718c0fce KW |
3231 | file_length = bdrv_getlength(s->data_file->bs); |
3232 | if (file_length < 0) { | |
3233 | error_setg_errno(errp, -file_length, "Could not get file size"); | |
1a52b73d AG |
3234 | ret = file_length; |
3235 | goto out; | |
718c0fce KW |
3236 | } |
3237 | ||
3238 | if (host_offset + cur_bytes > file_length) { | |
3239 | if (mode == PREALLOC_MODE_METADATA) { | |
3240 | mode = PREALLOC_MODE_OFF; | |
3241 | } | |
c80d8b06 | 3242 | ret = bdrv_co_truncate(s->data_file, host_offset + cur_bytes, false, |
7b8e4857 | 3243 | mode, 0, errp); |
19dbcbf7 | 3244 | if (ret < 0) { |
1a52b73d | 3245 | goto out; |
19dbcbf7 | 3246 | } |
a35e1c17 KW |
3247 | } |
3248 | ||
1a52b73d AG |
3249 | ret = 0; |
3250 | ||
3251 | out: | |
3252 | qcow2_handle_l2meta(bs, &meta, false); | |
3253 | return ret; | |
a35e1c17 KW |
3254 | } |
3255 | ||
7c5bcc42 SH |
3256 | /* qcow2_refcount_metadata_size: |
3257 | * @clusters: number of clusters to refcount (including data and L1/L2 tables) | |
3258 | * @cluster_size: size of a cluster, in bytes | |
3259 | * @refcount_order: refcount bits power-of-2 exponent | |
12cc30a8 HR |
3260 | * @generous_increase: allow for the refcount table to be 1.5x as large as it |
3261 | * needs to be | |
7c5bcc42 SH |
3262 | * |
3263 | * Returns: Number of bytes required for refcount blocks and table metadata. | |
3264 | */ | |
12cc30a8 HR |
3265 | int64_t qcow2_refcount_metadata_size(int64_t clusters, size_t cluster_size, |
3266 | int refcount_order, bool generous_increase, | |
3267 | uint64_t *refblock_count) | |
7c5bcc42 SH |
3268 | { |
3269 | /* | |
3270 | * Every host cluster is reference-counted, including metadata (even | |
3271 | * refcount metadata is recursively included). | |
3272 | * | |
3273 | * An accurate formula for the size of refcount metadata size is difficult | |
3274 | * to derive. An easier method of calculation is finding the fixed point | |
3275 | * where no further refcount blocks or table clusters are required to | |
3276 | * reference count every cluster. | |
3277 | */ | |
02b1ecfa | 3278 | int64_t blocks_per_table_cluster = cluster_size / REFTABLE_ENTRY_SIZE; |
7c5bcc42 SH |
3279 | int64_t refcounts_per_block = cluster_size * 8 / (1 << refcount_order); |
3280 | int64_t table = 0; /* number of refcount table clusters */ | |
3281 | int64_t blocks = 0; /* number of refcount block clusters */ | |
3282 | int64_t last; | |
3283 | int64_t n = 0; | |
3284 | ||
3285 | do { | |
3286 | last = n; | |
3287 | blocks = DIV_ROUND_UP(clusters + table + blocks, refcounts_per_block); | |
3288 | table = DIV_ROUND_UP(blocks, blocks_per_table_cluster); | |
3289 | n = clusters + blocks + table; | |
12cc30a8 HR |
3290 | |
3291 | if (n == last && generous_increase) { | |
3292 | clusters += DIV_ROUND_UP(table, 2); | |
3293 | n = 0; /* force another loop */ | |
3294 | generous_increase = false; | |
3295 | } | |
7c5bcc42 SH |
3296 | } while (n != last); |
3297 | ||
12cc30a8 HR |
3298 | if (refblock_count) { |
3299 | *refblock_count = blocks; | |
3300 | } | |
3301 | ||
7c5bcc42 SH |
3302 | return (blocks + table) * cluster_size; |
3303 | } | |
3304 | ||
95c67e3b SH |
3305 | /** |
3306 | * qcow2_calc_prealloc_size: | |
3307 | * @total_size: virtual disk size in bytes | |
3308 | * @cluster_size: cluster size in bytes | |
3309 | * @refcount_order: refcount bits power-of-2 exponent | |
0dd07b29 | 3310 | * @extended_l2: true if the image has extended L2 entries |
95c67e3b SH |
3311 | * |
3312 | * Returns: Total number of bytes required for the fully allocated image | |
3313 | * (including metadata). | |
3314 | */ | |
3315 | static int64_t qcow2_calc_prealloc_size(int64_t total_size, | |
3316 | size_t cluster_size, | |
0dd07b29 AG |
3317 | int refcount_order, |
3318 | bool extended_l2) | |
95c67e3b | 3319 | { |
95c67e3b | 3320 | int64_t meta_size = 0; |
7c5bcc42 | 3321 | uint64_t nl1e, nl2e; |
9e029689 | 3322 | int64_t aligned_total_size = ROUND_UP(total_size, cluster_size); |
0dd07b29 | 3323 | size_t l2e_size = extended_l2 ? L2E_SIZE_EXTENDED : L2E_SIZE_NORMAL; |
95c67e3b SH |
3324 | |
3325 | /* header: 1 cluster */ | |
3326 | meta_size += cluster_size; | |
3327 | ||
3328 | /* total size of L2 tables */ | |
3329 | nl2e = aligned_total_size / cluster_size; | |
0dd07b29 AG |
3330 | nl2e = ROUND_UP(nl2e, cluster_size / l2e_size); |
3331 | meta_size += nl2e * l2e_size; | |
95c67e3b SH |
3332 | |
3333 | /* total size of L1 tables */ | |
0dd07b29 | 3334 | nl1e = nl2e * l2e_size / cluster_size; |
02b1ecfa AG |
3335 | nl1e = ROUND_UP(nl1e, cluster_size / L1E_SIZE); |
3336 | meta_size += nl1e * L1E_SIZE; | |
95c67e3b | 3337 | |
7c5bcc42 SH |
3338 | /* total size of refcount table and blocks */ |
3339 | meta_size += qcow2_refcount_metadata_size( | |
3340 | (meta_size + aligned_total_size) / cluster_size, | |
12cc30a8 | 3341 | cluster_size, refcount_order, false, NULL); |
95c67e3b SH |
3342 | |
3343 | return meta_size + aligned_total_size; | |
3344 | } | |
3345 | ||
7be20252 AG |
3346 | static bool validate_cluster_size(size_t cluster_size, bool extended_l2, |
3347 | Error **errp) | |
a9420734 | 3348 | { |
29ca9e45 | 3349 | int cluster_bits = ctz32(cluster_size); |
a9420734 KW |
3350 | if (cluster_bits < MIN_CLUSTER_BITS || cluster_bits > MAX_CLUSTER_BITS || |
3351 | (1 << cluster_bits) != cluster_size) | |
3352 | { | |
3ef6c40a HR |
3353 | error_setg(errp, "Cluster size must be a power of two between %d and " |
3354 | "%dk", 1 << MIN_CLUSTER_BITS, 1 << (MAX_CLUSTER_BITS - 10)); | |
29ca9e45 KW |
3355 | return false; |
3356 | } | |
7be20252 AG |
3357 | |
3358 | if (extended_l2) { | |
3359 | unsigned min_cluster_size = | |
3360 | (1 << MIN_CLUSTER_BITS) * QCOW_EXTL2_SUBCLUSTERS_PER_CLUSTER; | |
3361 | if (cluster_size < min_cluster_size) { | |
3362 | error_setg(errp, "Extended L2 entries are only supported with " | |
3363 | "cluster sizes of at least %u bytes", min_cluster_size); | |
3364 | return false; | |
3365 | } | |
3366 | } | |
3367 | ||
29ca9e45 KW |
3368 | return true; |
3369 | } | |
3370 | ||
7be20252 AG |
3371 | static size_t qcow2_opt_get_cluster_size_del(QemuOpts *opts, bool extended_l2, |
3372 | Error **errp) | |
29ca9e45 KW |
3373 | { |
3374 | size_t cluster_size; | |
3375 | ||
3376 | cluster_size = qemu_opt_get_size_del(opts, BLOCK_OPT_CLUSTER_SIZE, | |
3377 | DEFAULT_CLUSTER_SIZE); | |
7be20252 | 3378 | if (!validate_cluster_size(cluster_size, extended_l2, errp)) { |
0eb4a8c1 SH |
3379 | return 0; |
3380 | } | |
3381 | return cluster_size; | |
3382 | } | |
3383 | ||
3384 | static int qcow2_opt_get_version_del(QemuOpts *opts, Error **errp) | |
3385 | { | |
3386 | char *buf; | |
3387 | int ret; | |
3388 | ||
3389 | buf = qemu_opt_get_del(opts, BLOCK_OPT_COMPAT_LEVEL); | |
3390 | if (!buf) { | |
3391 | ret = 3; /* default */ | |
3392 | } else if (!strcmp(buf, "0.10")) { | |
3393 | ret = 2; | |
3394 | } else if (!strcmp(buf, "1.1")) { | |
3395 | ret = 3; | |
3396 | } else { | |
3397 | error_setg(errp, "Invalid compatibility level: '%s'", buf); | |
3398 | ret = -EINVAL; | |
3399 | } | |
3400 | g_free(buf); | |
3401 | return ret; | |
3402 | } | |
3403 | ||
3404 | static uint64_t qcow2_opt_get_refcount_bits_del(QemuOpts *opts, int version, | |
3405 | Error **errp) | |
3406 | { | |
3407 | uint64_t refcount_bits; | |
3408 | ||
3409 | refcount_bits = qemu_opt_get_number_del(opts, BLOCK_OPT_REFCOUNT_BITS, 16); | |
3410 | if (refcount_bits > 64 || !is_power_of_2(refcount_bits)) { | |
3411 | error_setg(errp, "Refcount width must be a power of two and may not " | |
3412 | "exceed 64 bits"); | |
3413 | return 0; | |
3414 | } | |
3415 | ||
3416 | if (version < 3 && refcount_bits != 16) { | |
3417 | error_setg(errp, "Different refcount widths than 16 bits require " | |
3418 | "compatibility level 1.1 or above (use compat=1.1 or " | |
3419 | "greater)"); | |
3420 | return 0; | |
a9420734 KW |
3421 | } |
3422 | ||
0eb4a8c1 SH |
3423 | return refcount_bits; |
3424 | } | |
3425 | ||
c274393a | 3426 | static int coroutine_fn |
60900b7b | 3427 | qcow2_co_create(BlockdevCreateOptions *create_options, Error **errp) |
0eb4a8c1 | 3428 | { |
29ca9e45 | 3429 | BlockdevCreateOptionsQcow2 *qcow2_opts; |
0eb4a8c1 SH |
3430 | QDict *options; |
3431 | ||
a9420734 KW |
3432 | /* |
3433 | * Open the image file and write a minimal qcow2 header. | |
3434 | * | |
3435 | * We keep things simple and start with a zero-sized image. We also | |
3436 | * do without refcount blocks or a L1 table for now. We'll fix the | |
3437 | * inconsistency later. | |
3438 | * | |
3439 | * We do need a refcount table because growing the refcount table means | |
a951a631 | 3440 | * allocating two new refcount blocks - the second of which would be at |
a9420734 KW |
3441 | * 2 GB for 64k clusters, and we don't want to have a 2 GB initial file |
3442 | * size for any qcow2 image. | |
3443 | */ | |
e1d74bc6 KW |
3444 | BlockBackend *blk = NULL; |
3445 | BlockDriverState *bs = NULL; | |
dcc98687 | 3446 | BlockDriverState *data_bs = NULL; |
f8413b3c | 3447 | QCowHeader *header; |
29ca9e45 KW |
3448 | size_t cluster_size; |
3449 | int version; | |
3450 | int refcount_order; | |
5f14f31d | 3451 | uint64_t *refcount_table; |
a9420734 | 3452 | int ret; |
572ad978 | 3453 | uint8_t compression_type = QCOW2_COMPRESSION_TYPE_ZLIB; |
a9420734 | 3454 | |
29ca9e45 KW |
3455 | assert(create_options->driver == BLOCKDEV_DRIVER_QCOW2); |
3456 | qcow2_opts = &create_options->u.qcow2; | |
3457 | ||
ecbc57ca | 3458 | bs = bdrv_co_open_blockdev_ref(qcow2_opts->file, errp); |
e1d74bc6 KW |
3459 | if (bs == NULL) { |
3460 | return -EIO; | |
3461 | } | |
3462 | ||
3463 | /* Validate options and set default values */ | |
29ca9e45 | 3464 | if (!QEMU_IS_ALIGNED(qcow2_opts->size, BDRV_SECTOR_SIZE)) { |
3afea402 AG |
3465 | error_setg(errp, "Image size must be a multiple of %u bytes", |
3466 | (unsigned) BDRV_SECTOR_SIZE); | |
29ca9e45 KW |
3467 | ret = -EINVAL; |
3468 | goto out; | |
3469 | } | |
3470 | ||
3471 | if (qcow2_opts->has_version) { | |
3472 | switch (qcow2_opts->version) { | |
3473 | case BLOCKDEV_QCOW2_VERSION_V2: | |
3474 | version = 2; | |
3475 | break; | |
3476 | case BLOCKDEV_QCOW2_VERSION_V3: | |
3477 | version = 3; | |
3478 | break; | |
3479 | default: | |
3480 | g_assert_not_reached(); | |
3481 | } | |
3482 | } else { | |
3483 | version = 3; | |
3484 | } | |
3485 | ||
3486 | if (qcow2_opts->has_cluster_size) { | |
3487 | cluster_size = qcow2_opts->cluster_size; | |
3488 | } else { | |
3489 | cluster_size = DEFAULT_CLUSTER_SIZE; | |
3490 | } | |
3491 | ||
7be20252 AG |
3492 | if (!qcow2_opts->has_extended_l2) { |
3493 | qcow2_opts->extended_l2 = false; | |
3494 | } | |
3495 | if (qcow2_opts->extended_l2) { | |
3496 | if (version < 3) { | |
3497 | error_setg(errp, "Extended L2 entries are only supported with " | |
3498 | "compatibility level 1.1 and above (use version=v3 or " | |
3499 | "greater)"); | |
3500 | ret = -EINVAL; | |
3501 | goto out; | |
3502 | } | |
3503 | } | |
3504 | ||
3505 | if (!validate_cluster_size(cluster_size, qcow2_opts->extended_l2, errp)) { | |
e1d74bc6 KW |
3506 | ret = -EINVAL; |
3507 | goto out; | |
29ca9e45 KW |
3508 | } |
3509 | ||
3510 | if (!qcow2_opts->has_preallocation) { | |
3511 | qcow2_opts->preallocation = PREALLOC_MODE_OFF; | |
3512 | } | |
54fde4ff | 3513 | if (qcow2_opts->backing_file && |
2118771d AG |
3514 | qcow2_opts->preallocation != PREALLOC_MODE_OFF && |
3515 | !qcow2_opts->extended_l2) | |
29ca9e45 | 3516 | { |
2118771d AG |
3517 | error_setg(errp, "Backing file and preallocation can only be used at " |
3518 | "the same time if extended_l2 is on"); | |
e1d74bc6 KW |
3519 | ret = -EINVAL; |
3520 | goto out; | |
29ca9e45 | 3521 | } |
54fde4ff | 3522 | if (qcow2_opts->has_backing_fmt && !qcow2_opts->backing_file) { |
29ca9e45 | 3523 | error_setg(errp, "Backing format cannot be used without backing file"); |
e1d74bc6 KW |
3524 | ret = -EINVAL; |
3525 | goto out; | |
29ca9e45 KW |
3526 | } |
3527 | ||
3528 | if (!qcow2_opts->has_lazy_refcounts) { | |
3529 | qcow2_opts->lazy_refcounts = false; | |
3530 | } | |
3531 | if (version < 3 && qcow2_opts->lazy_refcounts) { | |
3532 | error_setg(errp, "Lazy refcounts only supported with compatibility " | |
b76b4f60 | 3533 | "level 1.1 and above (use version=v3 or greater)"); |
e1d74bc6 KW |
3534 | ret = -EINVAL; |
3535 | goto out; | |
29ca9e45 KW |
3536 | } |
3537 | ||
3538 | if (!qcow2_opts->has_refcount_bits) { | |
3539 | qcow2_opts->refcount_bits = 16; | |
3540 | } | |
3541 | if (qcow2_opts->refcount_bits > 64 || | |
3542 | !is_power_of_2(qcow2_opts->refcount_bits)) | |
3543 | { | |
3544 | error_setg(errp, "Refcount width must be a power of two and may not " | |
3545 | "exceed 64 bits"); | |
e1d74bc6 KW |
3546 | ret = -EINVAL; |
3547 | goto out; | |
29ca9e45 KW |
3548 | } |
3549 | if (version < 3 && qcow2_opts->refcount_bits != 16) { | |
3550 | error_setg(errp, "Different refcount widths than 16 bits require " | |
b76b4f60 | 3551 | "compatibility level 1.1 or above (use version=v3 or " |
29ca9e45 | 3552 | "greater)"); |
e1d74bc6 KW |
3553 | ret = -EINVAL; |
3554 | goto out; | |
29ca9e45 KW |
3555 | } |
3556 | refcount_order = ctz32(qcow2_opts->refcount_bits); | |
3557 | ||
6c3944dc KW |
3558 | if (qcow2_opts->data_file_raw && !qcow2_opts->data_file) { |
3559 | error_setg(errp, "data-file-raw requires data-file"); | |
3560 | ret = -EINVAL; | |
3561 | goto out; | |
3562 | } | |
54fde4ff | 3563 | if (qcow2_opts->data_file_raw && qcow2_opts->backing_file) { |
6c3944dc KW |
3564 | error_setg(errp, "Backing file and data-file-raw cannot be used at " |
3565 | "the same time"); | |
3566 | ret = -EINVAL; | |
3567 | goto out; | |
3568 | } | |
48410829 HR |
3569 | if (qcow2_opts->data_file_raw && |
3570 | qcow2_opts->preallocation == PREALLOC_MODE_OFF) | |
3571 | { | |
3572 | /* | |
3573 | * data-file-raw means that "the external data file can be | |
3574 | * read as a consistent standalone raw image without looking | |
3575 | * at the qcow2 metadata." It does not say that the metadata | |
3576 | * must be ignored, though (and the qcow2 driver in fact does | |
3577 | * not ignore it), so the L1/L2 tables must be present and | |
3578 | * give a 1:1 mapping, so you get the same result regardless | |
3579 | * of whether you look at the metadata or whether you ignore | |
3580 | * it. | |
3581 | */ | |
3582 | qcow2_opts->preallocation = PREALLOC_MODE_METADATA; | |
3583 | ||
3584 | /* | |
3585 | * Cannot use preallocation with backing files, but giving a | |
3586 | * backing file when specifying data_file_raw is an error | |
3587 | * anyway. | |
3588 | */ | |
54fde4ff | 3589 | assert(!qcow2_opts->backing_file); |
48410829 | 3590 | } |
6c3944dc | 3591 | |
dcc98687 KW |
3592 | if (qcow2_opts->data_file) { |
3593 | if (version < 3) { | |
3594 | error_setg(errp, "External data files are only supported with " | |
3595 | "compatibility level 1.1 and above (use version=v3 or " | |
3596 | "greater)"); | |
3597 | ret = -EINVAL; | |
3598 | goto out; | |
3599 | } | |
ecbc57ca | 3600 | data_bs = bdrv_co_open_blockdev_ref(qcow2_opts->data_file, errp); |
a0cf8363 | 3601 | if (data_bs == NULL) { |
dcc98687 KW |
3602 | ret = -EIO; |
3603 | goto out; | |
3604 | } | |
3605 | } | |
29ca9e45 | 3606 | |
572ad978 DP |
3607 | if (qcow2_opts->has_compression_type && |
3608 | qcow2_opts->compression_type != QCOW2_COMPRESSION_TYPE_ZLIB) { | |
3609 | ||
3610 | ret = -EINVAL; | |
3611 | ||
3612 | if (version < 3) { | |
3613 | error_setg(errp, "Non-zlib compression type is only supported with " | |
3614 | "compatibility level 1.1 and above (use version=v3 or " | |
3615 | "greater)"); | |
3616 | goto out; | |
3617 | } | |
3618 | ||
3619 | switch (qcow2_opts->compression_type) { | |
d298ac10 DP |
3620 | #ifdef CONFIG_ZSTD |
3621 | case QCOW2_COMPRESSION_TYPE_ZSTD: | |
3622 | break; | |
3623 | #endif | |
572ad978 DP |
3624 | default: |
3625 | error_setg(errp, "Unknown compression type"); | |
3626 | goto out; | |
3627 | } | |
3628 | ||
3629 | compression_type = qcow2_opts->compression_type; | |
3630 | } | |
3631 | ||
29ca9e45 | 3632 | /* Create BlockBackend to write to the image */ |
ecbc57ca KW |
3633 | blk = blk_co_new_with_bs(bs, BLK_PERM_WRITE | BLK_PERM_RESIZE, BLK_PERM_ALL, |
3634 | errp); | |
a3aeeab5 EB |
3635 | if (!blk) { |
3636 | ret = -EPERM; | |
cbf2b7c4 | 3637 | goto out; |
a9420734 | 3638 | } |
23588797 KW |
3639 | blk_set_allow_write_beyond_eof(blk, true); |
3640 | ||
a9420734 | 3641 | /* Write the header */ |
f8413b3c KW |
3642 | QEMU_BUILD_BUG_ON((1 << MIN_CLUSTER_BITS) < sizeof(*header)); |
3643 | header = g_malloc0(cluster_size); | |
3644 | *header = (QCowHeader) { | |
3645 | .magic = cpu_to_be32(QCOW_MAGIC), | |
3646 | .version = cpu_to_be32(version), | |
0eb4a8c1 | 3647 | .cluster_bits = cpu_to_be32(ctz32(cluster_size)), |
f8413b3c KW |
3648 | .size = cpu_to_be64(0), |
3649 | .l1_table_offset = cpu_to_be64(0), | |
3650 | .l1_size = cpu_to_be32(0), | |
3651 | .refcount_table_offset = cpu_to_be64(cluster_size), | |
3652 | .refcount_table_clusters = cpu_to_be32(1), | |
bd4b167f | 3653 | .refcount_order = cpu_to_be32(refcount_order), |
572ad978 DP |
3654 | /* don't deal with endianness since compression_type is 1 byte long */ |
3655 | .compression_type = compression_type, | |
f8413b3c KW |
3656 | .header_length = cpu_to_be32(sizeof(*header)), |
3657 | }; | |
a9420734 | 3658 | |
b25b387f DB |
3659 | /* We'll update this to correct value later */ |
3660 | header->crypt_method = cpu_to_be32(QCOW_CRYPT_NONE); | |
a9420734 | 3661 | |
29ca9e45 | 3662 | if (qcow2_opts->lazy_refcounts) { |
f8413b3c | 3663 | header->compatible_features |= |
bfe8043e SH |
3664 | cpu_to_be64(QCOW2_COMPAT_LAZY_REFCOUNTS); |
3665 | } | |
dcc98687 KW |
3666 | if (data_bs) { |
3667 | header->incompatible_features |= | |
3668 | cpu_to_be64(QCOW2_INCOMPAT_DATA_FILE); | |
3669 | } | |
6c3944dc KW |
3670 | if (qcow2_opts->data_file_raw) { |
3671 | header->autoclear_features |= | |
3672 | cpu_to_be64(QCOW2_AUTOCLEAR_DATA_FILE_RAW); | |
3673 | } | |
572ad978 DP |
3674 | if (compression_type != QCOW2_COMPRESSION_TYPE_ZLIB) { |
3675 | header->incompatible_features |= | |
3676 | cpu_to_be64(QCOW2_INCOMPAT_COMPRESSION); | |
3677 | } | |
bfe8043e | 3678 | |
7be20252 AG |
3679 | if (qcow2_opts->extended_l2) { |
3680 | header->incompatible_features |= | |
3681 | cpu_to_be64(QCOW2_INCOMPAT_EXTL2); | |
3682 | } | |
3683 | ||
38505e2a | 3684 | ret = blk_co_pwrite(blk, 0, cluster_size, header, 0); |
f8413b3c | 3685 | g_free(header); |
a9420734 | 3686 | if (ret < 0) { |
3ef6c40a | 3687 | error_setg_errno(errp, -ret, "Could not write qcow2 header"); |
a9420734 KW |
3688 | goto out; |
3689 | } | |
3690 | ||
b106ad91 KW |
3691 | /* Write a refcount table with one refcount block */ |
3692 | refcount_table = g_malloc0(2 * cluster_size); | |
3693 | refcount_table[0] = cpu_to_be64(2 * cluster_size); | |
38505e2a | 3694 | ret = blk_co_pwrite(blk, cluster_size, 2 * cluster_size, refcount_table, 0); |
7267c094 | 3695 | g_free(refcount_table); |
a9420734 KW |
3696 | |
3697 | if (ret < 0) { | |
3ef6c40a | 3698 | error_setg_errno(errp, -ret, "Could not write refcount table"); |
a9420734 KW |
3699 | goto out; |
3700 | } | |
3701 | ||
23588797 KW |
3702 | blk_unref(blk); |
3703 | blk = NULL; | |
a9420734 KW |
3704 | |
3705 | /* | |
3706 | * And now open the image and make it consistent first (i.e. increase the | |
3707 | * refcount of the cluster that is occupied by the header and the refcount | |
3708 | * table) | |
3709 | */ | |
e6641719 | 3710 | options = qdict_new(); |
46f5ac20 | 3711 | qdict_put_str(options, "driver", "qcow2"); |
cbf2b7c4 | 3712 | qdict_put_str(options, "file", bs->node_name); |
dcc98687 KW |
3713 | if (data_bs) { |
3714 | qdict_put_str(options, "data-file", data_bs->node_name); | |
3715 | } | |
ecbc57ca KW |
3716 | blk = blk_co_new_open(NULL, NULL, options, |
3717 | BDRV_O_RDWR | BDRV_O_RESIZE | BDRV_O_NO_FLUSH, | |
3718 | errp); | |
23588797 | 3719 | if (blk == NULL) { |
23588797 | 3720 | ret = -EIO; |
a9420734 KW |
3721 | goto out; |
3722 | } | |
3723 | ||
23588797 | 3724 | ret = qcow2_alloc_clusters(blk_bs(blk), 3 * cluster_size); |
a9420734 | 3725 | if (ret < 0) { |
3ef6c40a HR |
3726 | error_setg_errno(errp, -ret, "Could not allocate clusters for qcow2 " |
3727 | "header and refcount table"); | |
a9420734 KW |
3728 | goto out; |
3729 | ||
3730 | } else if (ret != 0) { | |
3731 | error_report("Huh, first cluster in empty image is already in use?"); | |
3732 | abort(); | |
3733 | } | |
3734 | ||
9b890bdc KW |
3735 | /* Set the external data file if necessary */ |
3736 | if (data_bs) { | |
3737 | BDRVQcow2State *s = blk_bs(blk)->opaque; | |
3738 | s->image_data_file = g_strdup(data_bs->filename); | |
3739 | } | |
3740 | ||
b527c9b3 | 3741 | /* Create a full header (including things like feature table) */ |
23588797 | 3742 | ret = qcow2_update_header(blk_bs(blk)); |
b527c9b3 KW |
3743 | if (ret < 0) { |
3744 | error_setg_errno(errp, -ret, "Could not update qcow2 header"); | |
3745 | goto out; | |
3746 | } | |
3747 | ||
a9420734 | 3748 | /* Okay, now that we have a valid image, let's give it the right size */ |
38505e2a AF |
3749 | ret = blk_co_truncate(blk, qcow2_opts->size, false, |
3750 | qcow2_opts->preallocation, 0, errp); | |
a9420734 | 3751 | if (ret < 0) { |
ed3d2ec9 | 3752 | error_prepend(errp, "Could not resize image: "); |
a9420734 KW |
3753 | goto out; |
3754 | } | |
3755 | ||
a951a631 | 3756 | /* Want a backing file? There you go. */ |
54fde4ff | 3757 | if (qcow2_opts->backing_file) { |
29ca9e45 KW |
3758 | const char *backing_format = NULL; |
3759 | ||
3760 | if (qcow2_opts->has_backing_fmt) { | |
3761 | backing_format = BlockdevDriver_str(qcow2_opts->backing_fmt); | |
3762 | } | |
3763 | ||
3764 | ret = bdrv_change_backing_file(blk_bs(blk), qcow2_opts->backing_file, | |
e54ee1b3 | 3765 | backing_format, false); |
a9420734 | 3766 | if (ret < 0) { |
3ef6c40a | 3767 | error_setg_errno(errp, -ret, "Could not assign backing file '%s' " |
29ca9e45 KW |
3768 | "with format '%s'", qcow2_opts->backing_file, |
3769 | backing_format); | |
a9420734 KW |
3770 | goto out; |
3771 | } | |
3772 | } | |
3773 | ||
b25b387f | 3774 | /* Want encryption? There you go. */ |
54fde4ff | 3775 | if (qcow2_opts->encrypt) { |
60900b7b | 3776 | ret = qcow2_set_up_encryption(blk_bs(blk), qcow2_opts->encrypt, errp); |
b25b387f DB |
3777 | if (ret < 0) { |
3778 | goto out; | |
3779 | } | |
3780 | } | |
3781 | ||
23588797 KW |
3782 | blk_unref(blk); |
3783 | blk = NULL; | |
ba2ab2f2 | 3784 | |
b25b387f DB |
3785 | /* Reopen the image without BDRV_O_NO_FLUSH to flush it before returning. |
3786 | * Using BDRV_O_NO_IO, since encryption is now setup we don't want to | |
3787 | * have to setup decryption context. We're not doing any I/O on the top | |
3788 | * level BlockDriverState, only lower layers, where BDRV_O_NO_IO does | |
3789 | * not have effect. | |
3790 | */ | |
e6641719 | 3791 | options = qdict_new(); |
46f5ac20 | 3792 | qdict_put_str(options, "driver", "qcow2"); |
cbf2b7c4 | 3793 | qdict_put_str(options, "file", bs->node_name); |
dcc98687 KW |
3794 | if (data_bs) { |
3795 | qdict_put_str(options, "data-file", data_bs->node_name); | |
3796 | } | |
ecbc57ca KW |
3797 | blk = blk_co_new_open(NULL, NULL, options, |
3798 | BDRV_O_RDWR | BDRV_O_NO_BACKING | BDRV_O_NO_IO, | |
3799 | errp); | |
23588797 | 3800 | if (blk == NULL) { |
23588797 | 3801 | ret = -EIO; |
ba2ab2f2 HR |
3802 | goto out; |
3803 | } | |
3804 | ||
a9420734 KW |
3805 | ret = 0; |
3806 | out: | |
e1d74bc6 KW |
3807 | blk_unref(blk); |
3808 | bdrv_unref(bs); | |
dcc98687 | 3809 | bdrv_unref(data_bs); |
a9420734 KW |
3810 | return ret; |
3811 | } | |
de5f3f40 | 3812 | |
b92902df ML |
3813 | static int coroutine_fn qcow2_co_create_opts(BlockDriver *drv, |
3814 | const char *filename, | |
3815 | QemuOpts *opts, | |
efc75e2a | 3816 | Error **errp) |
de5f3f40 | 3817 | { |
b76b4f60 | 3818 | BlockdevCreateOptions *create_options = NULL; |
92adf9db | 3819 | QDict *qdict; |
b76b4f60 | 3820 | Visitor *v; |
cbf2b7c4 | 3821 | BlockDriverState *bs = NULL; |
9b890bdc | 3822 | BlockDriverState *data_bs = NULL; |
b76b4f60 | 3823 | const char *val; |
3ef6c40a | 3824 | int ret; |
de5f3f40 | 3825 | |
b76b4f60 KW |
3826 | /* Only the keyval visitor supports the dotted syntax needed for |
3827 | * encryption, so go through a QDict before getting a QAPI type. Ignore | |
3828 | * options meant for the protocol layer so that the visitor doesn't | |
3829 | * complain. */ | |
3830 | qdict = qemu_opts_to_qdict_filtered(opts, NULL, bdrv_qcow2.create_opts, | |
3831 | true); | |
3832 | ||
3833 | /* Handle encryption options */ | |
3834 | val = qdict_get_try_str(qdict, BLOCK_OPT_ENCRYPT); | |
3835 | if (val && !strcmp(val, "on")) { | |
3836 | qdict_put_str(qdict, BLOCK_OPT_ENCRYPT, "qcow"); | |
3837 | } else if (val && !strcmp(val, "off")) { | |
3838 | qdict_del(qdict, BLOCK_OPT_ENCRYPT); | |
3839 | } | |
3840 | ||
3841 | val = qdict_get_try_str(qdict, BLOCK_OPT_ENCRYPT_FORMAT); | |
3842 | if (val && !strcmp(val, "aes")) { | |
3843 | qdict_put_str(qdict, BLOCK_OPT_ENCRYPT_FORMAT, "qcow"); | |
3844 | } | |
3845 | ||
3846 | /* Convert compat=0.10/1.1 into compat=v2/v3, to be renamed into | |
3847 | * version=v2/v3 below. */ | |
3848 | val = qdict_get_try_str(qdict, BLOCK_OPT_COMPAT_LEVEL); | |
3849 | if (val && !strcmp(val, "0.10")) { | |
3850 | qdict_put_str(qdict, BLOCK_OPT_COMPAT_LEVEL, "v2"); | |
3851 | } else if (val && !strcmp(val, "1.1")) { | |
3852 | qdict_put_str(qdict, BLOCK_OPT_COMPAT_LEVEL, "v3"); | |
3853 | } | |
3854 | ||
3855 | /* Change legacy command line options into QMP ones */ | |
3856 | static const QDictRenames opt_renames[] = { | |
3857 | { BLOCK_OPT_BACKING_FILE, "backing-file" }, | |
3858 | { BLOCK_OPT_BACKING_FMT, "backing-fmt" }, | |
3859 | { BLOCK_OPT_CLUSTER_SIZE, "cluster-size" }, | |
3860 | { BLOCK_OPT_LAZY_REFCOUNTS, "lazy-refcounts" }, | |
7be20252 | 3861 | { BLOCK_OPT_EXTL2, "extended-l2" }, |
b76b4f60 KW |
3862 | { BLOCK_OPT_REFCOUNT_BITS, "refcount-bits" }, |
3863 | { BLOCK_OPT_ENCRYPT, BLOCK_OPT_ENCRYPT_FORMAT }, | |
3864 | { BLOCK_OPT_COMPAT_LEVEL, "version" }, | |
6c3944dc | 3865 | { BLOCK_OPT_DATA_FILE_RAW, "data-file-raw" }, |
572ad978 | 3866 | { BLOCK_OPT_COMPRESSION_TYPE, "compression-type" }, |
b76b4f60 KW |
3867 | { NULL, NULL }, |
3868 | }; | |
3869 | ||
3870 | if (!qdict_rename_keys(qdict, opt_renames, errp)) { | |
29ca9e45 KW |
3871 | ret = -EINVAL; |
3872 | goto finish; | |
3873 | } | |
60900b7b | 3874 | |
b76b4f60 | 3875 | /* Create and open the file (protocol layer) */ |
2475a0d0 | 3876 | ret = bdrv_co_create_file(filename, opts, errp); |
b76b4f60 | 3877 | if (ret < 0) { |
0eb4a8c1 SH |
3878 | goto finish; |
3879 | } | |
b76b4f60 | 3880 | |
ecbc57ca KW |
3881 | bs = bdrv_co_open(filename, NULL, NULL, |
3882 | BDRV_O_RDWR | BDRV_O_RESIZE | BDRV_O_PROTOCOL, errp); | |
b76b4f60 KW |
3883 | if (bs == NULL) { |
3884 | ret = -EIO; | |
1bd0e2d1 CL |
3885 | goto finish; |
3886 | } | |
0eb4a8c1 | 3887 | |
9b890bdc KW |
3888 | /* Create and open an external data file (protocol layer) */ |
3889 | val = qdict_get_try_str(qdict, BLOCK_OPT_DATA_FILE); | |
3890 | if (val) { | |
2475a0d0 | 3891 | ret = bdrv_co_create_file(val, opts, errp); |
9b890bdc KW |
3892 | if (ret < 0) { |
3893 | goto finish; | |
3894 | } | |
3895 | ||
ecbc57ca KW |
3896 | data_bs = bdrv_co_open(val, NULL, NULL, |
3897 | BDRV_O_RDWR | BDRV_O_RESIZE | BDRV_O_PROTOCOL, | |
3898 | errp); | |
9b890bdc KW |
3899 | if (data_bs == NULL) { |
3900 | ret = -EIO; | |
3901 | goto finish; | |
3902 | } | |
3903 | ||
3904 | qdict_del(qdict, BLOCK_OPT_DATA_FILE); | |
3905 | qdict_put_str(qdict, "data-file", data_bs->node_name); | |
3906 | } | |
3907 | ||
b76b4f60 KW |
3908 | /* Set 'driver' and 'node' options */ |
3909 | qdict_put_str(qdict, "driver", "qcow2"); | |
3910 | qdict_put_str(qdict, "file", bs->node_name); | |
3911 | ||
3912 | /* Now get the QAPI type BlockdevCreateOptions */ | |
af91062e MA |
3913 | v = qobject_input_visitor_new_flat_confused(qdict, errp); |
3914 | if (!v) { | |
1bd0e2d1 CL |
3915 | ret = -EINVAL; |
3916 | goto finish; | |
3917 | } | |
3918 | ||
b11a093c | 3919 | visit_type_BlockdevCreateOptions(v, NULL, &create_options, errp); |
b76b4f60 | 3920 | visit_free(v); |
b11a093c | 3921 | if (!create_options) { |
bd4b167f HR |
3922 | ret = -EINVAL; |
3923 | goto finish; | |
3924 | } | |
3925 | ||
b76b4f60 KW |
3926 | /* Silently round up size */ |
3927 | create_options->u.qcow2.size = ROUND_UP(create_options->u.qcow2.size, | |
3928 | BDRV_SECTOR_SIZE); | |
cbf2b7c4 KW |
3929 | |
3930 | /* Create the qcow2 image (format layer) */ | |
b76b4f60 | 3931 | ret = qcow2_co_create(create_options, errp); |
6094cbeb | 3932 | finish: |
cbf2b7c4 | 3933 | if (ret < 0) { |
6094cbeb ML |
3934 | bdrv_co_delete_file_noerr(bs); |
3935 | bdrv_co_delete_file_noerr(data_bs); | |
3936 | } else { | |
3937 | ret = 0; | |
cbf2b7c4 | 3938 | } |
1bd0e2d1 | 3939 | |
cb3e7f08 | 3940 | qobject_unref(qdict); |
cbf2b7c4 | 3941 | bdrv_unref(bs); |
9b890bdc | 3942 | bdrv_unref(data_bs); |
b76b4f60 | 3943 | qapi_free_BlockdevCreateOptions(create_options); |
3ef6c40a | 3944 | return ret; |
de5f3f40 KW |
3945 | } |
3946 | ||
2928abce | 3947 | |
f06f6b66 | 3948 | static bool is_zero(BlockDriverState *bs, int64_t offset, int64_t bytes) |
2928abce | 3949 | { |
31826642 EB |
3950 | int64_t nr; |
3951 | int res; | |
f06f6b66 EB |
3952 | |
3953 | /* Clamp to image length, before checking status of underlying sectors */ | |
8cbf74b2 EB |
3954 | if (offset + bytes > bs->total_sectors * BDRV_SECTOR_SIZE) { |
3955 | bytes = bs->total_sectors * BDRV_SECTOR_SIZE - offset; | |
fbaa6bb3 EB |
3956 | } |
3957 | ||
f06f6b66 | 3958 | if (!bytes) { |
ebb718a5 EB |
3959 | return true; |
3960 | } | |
67c095c8 VSO |
3961 | |
3962 | /* | |
3963 | * bdrv_block_status_above doesn't merge different types of zeros, for | |
3964 | * example, zeros which come from the region which is unallocated in | |
3965 | * the whole backing chain, and zeros which come because of a short | |
3966 | * backing file. So, we need a loop. | |
3967 | */ | |
3968 | do { | |
3969 | res = bdrv_block_status_above(bs, NULL, offset, bytes, &nr, NULL, NULL); | |
3970 | offset += nr; | |
3971 | bytes -= nr; | |
3972 | } while (res >= 0 && (res & BDRV_BLOCK_ZERO) && nr && bytes); | |
3973 | ||
3974 | return res >= 0 && (res & BDRV_BLOCK_ZERO) && bytes == 0; | |
2928abce DL |
3975 | } |
3976 | ||
5544b59f | 3977 | static coroutine_fn int qcow2_co_pwrite_zeroes(BlockDriverState *bs, |
f34b2bcf | 3978 | int64_t offset, int64_t bytes, BdrvRequestFlags flags) |
621f0589 KW |
3979 | { |
3980 | int ret; | |
ff99129a | 3981 | BDRVQcow2State *s = bs->opaque; |
621f0589 | 3982 | |
a6841a2d AG |
3983 | uint32_t head = offset_into_subcluster(s, offset); |
3984 | uint32_t tail = ROUND_UP(offset + bytes, s->subcluster_size) - | |
3985 | (offset + bytes); | |
2928abce | 3986 | |
f5a5ca79 MP |
3987 | trace_qcow2_pwrite_zeroes_start_req(qemu_coroutine_self(), offset, bytes); |
3988 | if (offset + bytes == bs->total_sectors * BDRV_SECTOR_SIZE) { | |
fbaa6bb3 EB |
3989 | tail = 0; |
3990 | } | |
5a64e942 | 3991 | |
ebb718a5 | 3992 | if (head || tail) { |
ebb718a5 | 3993 | uint64_t off; |
ecfe1863 | 3994 | unsigned int nr; |
10dabdc5 | 3995 | QCow2SubclusterType type; |
2928abce | 3996 | |
a6841a2d | 3997 | assert(head + bytes + tail <= s->subcluster_size); |
2928abce | 3998 | |
ebb718a5 | 3999 | /* check whether remainder of cluster already reads as zero */ |
f06f6b66 | 4000 | if (!(is_zero(bs, offset - head, head) && |
a6841a2d | 4001 | is_zero(bs, offset + bytes, tail))) { |
2928abce DL |
4002 | return -ENOTSUP; |
4003 | } | |
4004 | ||
2928abce DL |
4005 | qemu_co_mutex_lock(&s->lock); |
4006 | /* We can have new write after previous check */ | |
a6841a2d AG |
4007 | offset -= head; |
4008 | bytes = s->subcluster_size; | |
4009 | nr = s->subcluster_size; | |
ca4a0bb8 AG |
4010 | ret = qcow2_get_host_offset(bs, offset, &nr, &off, &type); |
4011 | if (ret < 0 || | |
10dabdc5 | 4012 | (type != QCOW2_SUBCLUSTER_UNALLOCATED_PLAIN && |
97490a14 | 4013 | type != QCOW2_SUBCLUSTER_UNALLOCATED_ALLOC && |
10dabdc5 AG |
4014 | type != QCOW2_SUBCLUSTER_ZERO_PLAIN && |
4015 | type != QCOW2_SUBCLUSTER_ZERO_ALLOC)) { | |
2928abce | 4016 | qemu_co_mutex_unlock(&s->lock); |
580384d6 | 4017 | return ret < 0 ? ret : -ENOTSUP; |
2928abce DL |
4018 | } |
4019 | } else { | |
4020 | qemu_co_mutex_lock(&s->lock); | |
621f0589 KW |
4021 | } |
4022 | ||
f5a5ca79 | 4023 | trace_qcow2_pwrite_zeroes(qemu_coroutine_self(), offset, bytes); |
5a64e942 | 4024 | |
a6841a2d AG |
4025 | /* Whatever is left can use real zero subclusters */ |
4026 | ret = qcow2_subcluster_zeroize(bs, offset, bytes, flags); | |
621f0589 KW |
4027 | qemu_co_mutex_unlock(&s->lock); |
4028 | ||
4029 | return ret; | |
4030 | } | |
4031 | ||
82e8a788 | 4032 | static coroutine_fn int qcow2_co_pdiscard(BlockDriverState *bs, |
0c802287 | 4033 | int64_t offset, int64_t bytes) |
5ea929e3 | 4034 | { |
6db39ae2 | 4035 | int ret; |
ff99129a | 4036 | BDRVQcow2State *s = bs->opaque; |
6db39ae2 | 4037 | |
80f5c011 AG |
4038 | /* If the image does not support QCOW_OFLAG_ZERO then discarding |
4039 | * clusters could expose stale data from the backing file. */ | |
4040 | if (s->qcow_version < 3 && bs->backing) { | |
4041 | return -ENOTSUP; | |
4042 | } | |
4043 | ||
f5a5ca79 MP |
4044 | if (!QEMU_IS_ALIGNED(offset | bytes, s->cluster_size)) { |
4045 | assert(bytes < s->cluster_size); | |
048c5fd1 EB |
4046 | /* Ignore partial clusters, except for the special case of the |
4047 | * complete partial cluster at the end of an unaligned file */ | |
4048 | if (!QEMU_IS_ALIGNED(offset, s->cluster_size) || | |
f5a5ca79 | 4049 | offset + bytes != bs->total_sectors * BDRV_SECTOR_SIZE) { |
048c5fd1 EB |
4050 | return -ENOTSUP; |
4051 | } | |
49228d1e EB |
4052 | } |
4053 | ||
6db39ae2 | 4054 | qemu_co_mutex_lock(&s->lock); |
f5a5ca79 | 4055 | ret = qcow2_cluster_discard(bs, offset, bytes, QCOW2_DISCARD_REQUEST, |
d2cb36af | 4056 | false); |
6db39ae2 PB |
4057 | qemu_co_mutex_unlock(&s->lock); |
4058 | return ret; | |
5ea929e3 KW |
4059 | } |
4060 | ||
fd9fcd37 FZ |
4061 | static int coroutine_fn |
4062 | qcow2_co_copy_range_from(BlockDriverState *bs, | |
48535049 VSO |
4063 | BdrvChild *src, int64_t src_offset, |
4064 | BdrvChild *dst, int64_t dst_offset, | |
4065 | int64_t bytes, BdrvRequestFlags read_flags, | |
67b51fb9 | 4066 | BdrvRequestFlags write_flags) |
fd9fcd37 FZ |
4067 | { |
4068 | BDRVQcow2State *s = bs->opaque; | |
4069 | int ret; | |
4070 | unsigned int cur_bytes; /* number of bytes in current iteration */ | |
4071 | BdrvChild *child = NULL; | |
67b51fb9 | 4072 | BdrvRequestFlags cur_write_flags; |
fd9fcd37 FZ |
4073 | |
4074 | assert(!bs->encrypted); | |
4075 | qemu_co_mutex_lock(&s->lock); | |
4076 | ||
4077 | while (bytes != 0) { | |
4078 | uint64_t copy_offset = 0; | |
10dabdc5 | 4079 | QCow2SubclusterType type; |
fd9fcd37 FZ |
4080 | /* prepare next request */ |
4081 | cur_bytes = MIN(bytes, INT_MAX); | |
67b51fb9 | 4082 | cur_write_flags = write_flags; |
fd9fcd37 | 4083 | |
ca4a0bb8 AG |
4084 | ret = qcow2_get_host_offset(bs, src_offset, &cur_bytes, |
4085 | ©_offset, &type); | |
fd9fcd37 FZ |
4086 | if (ret < 0) { |
4087 | goto out; | |
4088 | } | |
4089 | ||
ca4a0bb8 | 4090 | switch (type) { |
10dabdc5 | 4091 | case QCOW2_SUBCLUSTER_UNALLOCATED_PLAIN: |
97490a14 | 4092 | case QCOW2_SUBCLUSTER_UNALLOCATED_ALLOC: |
fd9fcd37 FZ |
4093 | if (bs->backing && bs->backing->bs) { |
4094 | int64_t backing_length = bdrv_getlength(bs->backing->bs); | |
4095 | if (src_offset >= backing_length) { | |
67b51fb9 | 4096 | cur_write_flags |= BDRV_REQ_ZERO_WRITE; |
fd9fcd37 FZ |
4097 | } else { |
4098 | child = bs->backing; | |
4099 | cur_bytes = MIN(cur_bytes, backing_length - src_offset); | |
4100 | copy_offset = src_offset; | |
4101 | } | |
4102 | } else { | |
67b51fb9 | 4103 | cur_write_flags |= BDRV_REQ_ZERO_WRITE; |
fd9fcd37 FZ |
4104 | } |
4105 | break; | |
4106 | ||
10dabdc5 AG |
4107 | case QCOW2_SUBCLUSTER_ZERO_PLAIN: |
4108 | case QCOW2_SUBCLUSTER_ZERO_ALLOC: | |
67b51fb9 | 4109 | cur_write_flags |= BDRV_REQ_ZERO_WRITE; |
fd9fcd37 FZ |
4110 | break; |
4111 | ||
10dabdc5 | 4112 | case QCOW2_SUBCLUSTER_COMPRESSED: |
fd9fcd37 FZ |
4113 | ret = -ENOTSUP; |
4114 | goto out; | |
fd9fcd37 | 4115 | |
10dabdc5 | 4116 | case QCOW2_SUBCLUSTER_NORMAL: |
966b000f | 4117 | child = s->data_file; |
fd9fcd37 FZ |
4118 | break; |
4119 | ||
4120 | default: | |
4121 | abort(); | |
4122 | } | |
4123 | qemu_co_mutex_unlock(&s->lock); | |
4124 | ret = bdrv_co_copy_range_from(child, | |
4125 | copy_offset, | |
4126 | dst, dst_offset, | |
67b51fb9 | 4127 | cur_bytes, read_flags, cur_write_flags); |
fd9fcd37 FZ |
4128 | qemu_co_mutex_lock(&s->lock); |
4129 | if (ret < 0) { | |
4130 | goto out; | |
4131 | } | |
4132 | ||
4133 | bytes -= cur_bytes; | |
4134 | src_offset += cur_bytes; | |
4135 | dst_offset += cur_bytes; | |
4136 | } | |
4137 | ret = 0; | |
4138 | ||
4139 | out: | |
4140 | qemu_co_mutex_unlock(&s->lock); | |
4141 | return ret; | |
4142 | } | |
4143 | ||
4144 | static int coroutine_fn | |
4145 | qcow2_co_copy_range_to(BlockDriverState *bs, | |
48535049 VSO |
4146 | BdrvChild *src, int64_t src_offset, |
4147 | BdrvChild *dst, int64_t dst_offset, | |
4148 | int64_t bytes, BdrvRequestFlags read_flags, | |
67b51fb9 | 4149 | BdrvRequestFlags write_flags) |
fd9fcd37 FZ |
4150 | { |
4151 | BDRVQcow2State *s = bs->opaque; | |
fd9fcd37 FZ |
4152 | int ret; |
4153 | unsigned int cur_bytes; /* number of sectors in current iteration */ | |
bfd0989a | 4154 | uint64_t host_offset; |
fd9fcd37 FZ |
4155 | QCowL2Meta *l2meta = NULL; |
4156 | ||
4157 | assert(!bs->encrypted); | |
fd9fcd37 FZ |
4158 | |
4159 | qemu_co_mutex_lock(&s->lock); | |
4160 | ||
4161 | while (bytes != 0) { | |
4162 | ||
4163 | l2meta = NULL; | |
4164 | ||
fd9fcd37 FZ |
4165 | cur_bytes = MIN(bytes, INT_MAX); |
4166 | ||
4167 | /* TODO: | |
4168 | * If src->bs == dst->bs, we could simply copy by incrementing | |
4169 | * the refcnt, without copying user data. | |
4170 | * Or if src->bs == dst->bs->backing->bs, we could copy by discarding. */ | |
bfd0989a AG |
4171 | ret = qcow2_alloc_host_offset(bs, dst_offset, &cur_bytes, |
4172 | &host_offset, &l2meta); | |
fd9fcd37 FZ |
4173 | if (ret < 0) { |
4174 | goto fail; | |
4175 | } | |
4176 | ||
bfd0989a AG |
4177 | ret = qcow2_pre_write_overlap_check(bs, 0, host_offset, cur_bytes, |
4178 | true); | |
fd9fcd37 FZ |
4179 | if (ret < 0) { |
4180 | goto fail; | |
4181 | } | |
4182 | ||
4183 | qemu_co_mutex_unlock(&s->lock); | |
bfd0989a | 4184 | ret = bdrv_co_copy_range_to(src, src_offset, s->data_file, host_offset, |
67b51fb9 | 4185 | cur_bytes, read_flags, write_flags); |
fd9fcd37 FZ |
4186 | qemu_co_mutex_lock(&s->lock); |
4187 | if (ret < 0) { | |
4188 | goto fail; | |
4189 | } | |
4190 | ||
4191 | ret = qcow2_handle_l2meta(bs, &l2meta, true); | |
4192 | if (ret) { | |
4193 | goto fail; | |
4194 | } | |
4195 | ||
4196 | bytes -= cur_bytes; | |
e06f4639 | 4197 | src_offset += cur_bytes; |
fd9fcd37 FZ |
4198 | dst_offset += cur_bytes; |
4199 | } | |
4200 | ret = 0; | |
4201 | ||
4202 | fail: | |
4203 | qcow2_handle_l2meta(bs, &l2meta, false); | |
4204 | ||
4205 | qemu_co_mutex_unlock(&s->lock); | |
4206 | ||
fd9fcd37 FZ |
4207 | trace_qcow2_writev_done_req(qemu_coroutine_self(), ret); |
4208 | ||
4209 | return ret; | |
4210 | } | |
4211 | ||
c2b8e315 KW |
4212 | static int coroutine_fn GRAPH_RDLOCK |
4213 | qcow2_co_truncate(BlockDriverState *bs, int64_t offset, bool exact, | |
4214 | PreallocMode prealloc, BdrvRequestFlags flags, Error **errp) | |
419b19d9 | 4215 | { |
ff99129a | 4216 | BDRVQcow2State *s = bs->opaque; |
95b98f34 | 4217 | uint64_t old_length; |
2cf7cfa1 KW |
4218 | int64_t new_l1_size; |
4219 | int ret; | |
45b4949c | 4220 | QDict *options; |
419b19d9 | 4221 | |
772d1f97 HR |
4222 | if (prealloc != PREALLOC_MODE_OFF && prealloc != PREALLOC_MODE_METADATA && |
4223 | prealloc != PREALLOC_MODE_FALLOC && prealloc != PREALLOC_MODE_FULL) | |
4224 | { | |
8243ccb7 | 4225 | error_setg(errp, "Unsupported preallocation mode '%s'", |
977c736f | 4226 | PreallocMode_str(prealloc)); |
8243ccb7 HR |
4227 | return -ENOTSUP; |
4228 | } | |
4229 | ||
3afea402 AG |
4230 | if (!QEMU_IS_ALIGNED(offset, BDRV_SECTOR_SIZE)) { |
4231 | error_setg(errp, "The new size must be a multiple of %u", | |
4232 | (unsigned) BDRV_SECTOR_SIZE); | |
419b19d9 SH |
4233 | return -EINVAL; |
4234 | } | |
4235 | ||
061ca8a3 KW |
4236 | qemu_co_mutex_lock(&s->lock); |
4237 | ||
7fa140ab EB |
4238 | /* |
4239 | * Even though we store snapshot size for all images, it was not | |
4240 | * required until v3, so it is not safe to proceed for v2. | |
4241 | */ | |
4242 | if (s->nb_snapshots && s->qcow_version < 3) { | |
4243 | error_setg(errp, "Can't resize a v2 image which has snapshots"); | |
061ca8a3 KW |
4244 | ret = -ENOTSUP; |
4245 | goto fail; | |
419b19d9 SH |
4246 | } |
4247 | ||
ee1244a2 | 4248 | /* See qcow2-bitmap.c for which bitmap scenarios prevent a resize. */ |
d19c6b36 | 4249 | if (qcow2_truncate_bitmaps_check(bs, errp)) { |
061ca8a3 KW |
4250 | ret = -ENOTSUP; |
4251 | goto fail; | |
88ddffae VSO |
4252 | } |
4253 | ||
bd016b91 | 4254 | old_length = bs->total_sectors * BDRV_SECTOR_SIZE; |
46b732cd | 4255 | new_l1_size = size_to_l1(s, offset); |
95b98f34 | 4256 | |
95b98f34 | 4257 | if (offset < old_length) { |
163bc39d | 4258 | int64_t last_cluster, old_file_size; |
46b732cd PB |
4259 | if (prealloc != PREALLOC_MODE_OFF) { |
4260 | error_setg(errp, | |
4261 | "Preallocation can't be used for shrinking an image"); | |
061ca8a3 KW |
4262 | ret = -EINVAL; |
4263 | goto fail; | |
46b732cd | 4264 | } |
419b19d9 | 4265 | |
46b732cd PB |
4266 | ret = qcow2_cluster_discard(bs, ROUND_UP(offset, s->cluster_size), |
4267 | old_length - ROUND_UP(offset, | |
4268 | s->cluster_size), | |
4269 | QCOW2_DISCARD_ALWAYS, true); | |
4270 | if (ret < 0) { | |
4271 | error_setg_errno(errp, -ret, "Failed to discard cropped clusters"); | |
061ca8a3 | 4272 | goto fail; |
46b732cd PB |
4273 | } |
4274 | ||
4275 | ret = qcow2_shrink_l1_table(bs, new_l1_size); | |
4276 | if (ret < 0) { | |
4277 | error_setg_errno(errp, -ret, | |
4278 | "Failed to reduce the number of L2 tables"); | |
061ca8a3 | 4279 | goto fail; |
46b732cd PB |
4280 | } |
4281 | ||
4282 | ret = qcow2_shrink_reftable(bs); | |
4283 | if (ret < 0) { | |
4284 | error_setg_errno(errp, -ret, | |
4285 | "Failed to discard unused refblocks"); | |
061ca8a3 | 4286 | goto fail; |
46b732cd | 4287 | } |
163bc39d PB |
4288 | |
4289 | old_file_size = bdrv_getlength(bs->file->bs); | |
4290 | if (old_file_size < 0) { | |
4291 | error_setg_errno(errp, -old_file_size, | |
4292 | "Failed to inquire current file length"); | |
061ca8a3 KW |
4293 | ret = old_file_size; |
4294 | goto fail; | |
163bc39d PB |
4295 | } |
4296 | last_cluster = qcow2_get_last_cluster(bs, old_file_size); | |
4297 | if (last_cluster < 0) { | |
4298 | error_setg_errno(errp, -last_cluster, | |
4299 | "Failed to find the last cluster"); | |
061ca8a3 KW |
4300 | ret = last_cluster; |
4301 | goto fail; | |
163bc39d PB |
4302 | } |
4303 | if ((last_cluster + 1) * s->cluster_size < old_file_size) { | |
233521b1 HR |
4304 | Error *local_err = NULL; |
4305 | ||
e61a28a9 HR |
4306 | /* |
4307 | * Do not pass @exact here: It will not help the user if | |
4308 | * we get an error here just because they wanted to shrink | |
4309 | * their qcow2 image (on a block device) with qemu-img. | |
4310 | * (And on the qcow2 layer, the @exact requirement is | |
4311 | * always fulfilled, so there is no need to pass it on.) | |
4312 | */ | |
061ca8a3 | 4313 | bdrv_co_truncate(bs->file, (last_cluster + 1) * s->cluster_size, |
7b8e4857 | 4314 | false, PREALLOC_MODE_OFF, 0, &local_err); |
233521b1 HR |
4315 | if (local_err) { |
4316 | warn_reportf_err(local_err, | |
4317 | "Failed to truncate the tail of the image: "); | |
163bc39d PB |
4318 | } |
4319 | } | |
46b732cd PB |
4320 | } else { |
4321 | ret = qcow2_grow_l1_table(bs, new_l1_size, true); | |
4322 | if (ret < 0) { | |
4323 | error_setg_errno(errp, -ret, "Failed to grow the L1 table"); | |
061ca8a3 | 4324 | goto fail; |
46b732cd | 4325 | } |
48410829 HR |
4326 | |
4327 | if (data_file_is_raw(bs) && prealloc == PREALLOC_MODE_OFF) { | |
4328 | /* | |
4329 | * When creating a qcow2 image with data-file-raw, we enforce | |
4330 | * at least prealloc=metadata, so that the L1/L2 tables are | |
4331 | * fully allocated and reading from the data file will return | |
4332 | * the same data as reading from the qcow2 image. When the | |
4333 | * image is grown, we must consequently preallocate the | |
4334 | * metadata structures to cover the added area. | |
4335 | */ | |
4336 | prealloc = PREALLOC_MODE_METADATA; | |
4337 | } | |
419b19d9 SH |
4338 | } |
4339 | ||
95b98f34 HR |
4340 | switch (prealloc) { |
4341 | case PREALLOC_MODE_OFF: | |
718c0fce | 4342 | if (has_data_file(bs)) { |
e61a28a9 HR |
4343 | /* |
4344 | * If the caller wants an exact resize, the external data | |
4345 | * file should be resized to the exact target size, too, | |
4346 | * so we pass @exact here. | |
4347 | */ | |
7b8e4857 KW |
4348 | ret = bdrv_co_truncate(s->data_file, offset, exact, prealloc, 0, |
4349 | errp); | |
718c0fce KW |
4350 | if (ret < 0) { |
4351 | goto fail; | |
4352 | } | |
4353 | } | |
95b98f34 HR |
4354 | break; |
4355 | ||
4356 | case PREALLOC_MODE_METADATA: | |
718c0fce | 4357 | ret = preallocate_co(bs, old_length, offset, prealloc, errp); |
95b98f34 | 4358 | if (ret < 0) { |
061ca8a3 | 4359 | goto fail; |
95b98f34 HR |
4360 | } |
4361 | break; | |
4362 | ||
772d1f97 HR |
4363 | case PREALLOC_MODE_FALLOC: |
4364 | case PREALLOC_MODE_FULL: | |
4365 | { | |
4366 | int64_t allocation_start, host_offset, guest_offset; | |
4367 | int64_t clusters_allocated; | |
4b96fa38 | 4368 | int64_t old_file_size, last_cluster, new_file_size; |
772d1f97 | 4369 | uint64_t nb_new_data_clusters, nb_new_l2_tables; |
40dee943 | 4370 | bool subclusters_need_allocation = false; |
772d1f97 | 4371 | |
966b000f KW |
4372 | /* With a data file, preallocation means just allocating the metadata |
4373 | * and forwarding the truncate request to the data file */ | |
4374 | if (has_data_file(bs)) { | |
718c0fce | 4375 | ret = preallocate_co(bs, old_length, offset, prealloc, errp); |
966b000f | 4376 | if (ret < 0) { |
966b000f KW |
4377 | goto fail; |
4378 | } | |
4379 | break; | |
4380 | } | |
4381 | ||
772d1f97 HR |
4382 | old_file_size = bdrv_getlength(bs->file->bs); |
4383 | if (old_file_size < 0) { | |
4384 | error_setg_errno(errp, -old_file_size, | |
4385 | "Failed to inquire current file length"); | |
061ca8a3 KW |
4386 | ret = old_file_size; |
4387 | goto fail; | |
772d1f97 | 4388 | } |
4b96fa38 HR |
4389 | |
4390 | last_cluster = qcow2_get_last_cluster(bs, old_file_size); | |
4391 | if (last_cluster >= 0) { | |
4392 | old_file_size = (last_cluster + 1) * s->cluster_size; | |
4393 | } else { | |
4394 | old_file_size = ROUND_UP(old_file_size, s->cluster_size); | |
4395 | } | |
772d1f97 | 4396 | |
a5675f39 AG |
4397 | nb_new_data_clusters = (ROUND_UP(offset, s->cluster_size) - |
4398 | start_of_cluster(s, old_length)) >> s->cluster_bits; | |
772d1f97 HR |
4399 | |
4400 | /* This is an overestimation; we will not actually allocate space for | |
4401 | * these in the file but just make sure the new refcount structures are | |
4402 | * able to cover them so we will not have to allocate new refblocks | |
4403 | * while entering the data blocks in the potentially new L2 tables. | |
4404 | * (We do not actually care where the L2 tables are placed. Maybe they | |
4405 | * are already allocated or they can be placed somewhere before | |
4406 | * @old_file_size. It does not matter because they will be fully | |
4407 | * allocated automatically, so they do not need to be covered by the | |
4408 | * preallocation. All that matters is that we will not have to allocate | |
4409 | * new refcount structures for them.) */ | |
4410 | nb_new_l2_tables = DIV_ROUND_UP(nb_new_data_clusters, | |
c8fd8554 | 4411 | s->cluster_size / l2_entry_size(s)); |
772d1f97 HR |
4412 | /* The cluster range may not be aligned to L2 boundaries, so add one L2 |
4413 | * table for a potential head/tail */ | |
4414 | nb_new_l2_tables++; | |
4415 | ||
4416 | allocation_start = qcow2_refcount_area(bs, old_file_size, | |
4417 | nb_new_data_clusters + | |
4418 | nb_new_l2_tables, | |
4419 | true, 0, 0); | |
4420 | if (allocation_start < 0) { | |
4421 | error_setg_errno(errp, -allocation_start, | |
4422 | "Failed to resize refcount structures"); | |
061ca8a3 KW |
4423 | ret = allocation_start; |
4424 | goto fail; | |
772d1f97 HR |
4425 | } |
4426 | ||
4427 | clusters_allocated = qcow2_alloc_clusters_at(bs, allocation_start, | |
4428 | nb_new_data_clusters); | |
4429 | if (clusters_allocated < 0) { | |
4430 | error_setg_errno(errp, -clusters_allocated, | |
4431 | "Failed to allocate data clusters"); | |
061ca8a3 KW |
4432 | ret = clusters_allocated; |
4433 | goto fail; | |
772d1f97 HR |
4434 | } |
4435 | ||
4436 | assert(clusters_allocated == nb_new_data_clusters); | |
4437 | ||
4438 | /* Allocate the data area */ | |
4439 | new_file_size = allocation_start + | |
4440 | nb_new_data_clusters * s->cluster_size; | |
eb8a0cf3 KW |
4441 | /* |
4442 | * Image file grows, so @exact does not matter. | |
4443 | * | |
4444 | * If we need to zero out the new area, try first whether the protocol | |
4445 | * driver can already take care of this. | |
4446 | */ | |
4447 | if (flags & BDRV_REQ_ZERO_WRITE) { | |
4448 | ret = bdrv_co_truncate(bs->file, new_file_size, false, prealloc, | |
4449 | BDRV_REQ_ZERO_WRITE, NULL); | |
4450 | if (ret >= 0) { | |
4451 | flags &= ~BDRV_REQ_ZERO_WRITE; | |
40dee943 AG |
4452 | /* Ensure that we read zeroes and not backing file data */ |
4453 | subclusters_need_allocation = true; | |
eb8a0cf3 KW |
4454 | } |
4455 | } else { | |
4456 | ret = -1; | |
4457 | } | |
4458 | if (ret < 0) { | |
4459 | ret = bdrv_co_truncate(bs->file, new_file_size, false, prealloc, 0, | |
4460 | errp); | |
4461 | } | |
772d1f97 HR |
4462 | if (ret < 0) { |
4463 | error_prepend(errp, "Failed to resize underlying file: "); | |
4464 | qcow2_free_clusters(bs, allocation_start, | |
4465 | nb_new_data_clusters * s->cluster_size, | |
4466 | QCOW2_DISCARD_OTHER); | |
061ca8a3 | 4467 | goto fail; |
772d1f97 HR |
4468 | } |
4469 | ||
4470 | /* Create the necessary L2 entries */ | |
4471 | host_offset = allocation_start; | |
4472 | guest_offset = old_length; | |
4473 | while (nb_new_data_clusters) { | |
13bec229 AG |
4474 | int64_t nb_clusters = MIN( |
4475 | nb_new_data_clusters, | |
4476 | s->l2_slice_size - offset_to_l2_slice_index(s, guest_offset)); | |
a5675f39 AG |
4477 | unsigned cow_start_length = offset_into_cluster(s, guest_offset); |
4478 | QCowL2Meta allocation; | |
4479 | guest_offset = start_of_cluster(s, guest_offset); | |
4480 | allocation = (QCowL2Meta) { | |
772d1f97 HR |
4481 | .offset = guest_offset, |
4482 | .alloc_offset = host_offset, | |
4483 | .nb_clusters = nb_clusters, | |
a5675f39 AG |
4484 | .cow_start = { |
4485 | .offset = 0, | |
4486 | .nb_bytes = cow_start_length, | |
4487 | }, | |
4488 | .cow_end = { | |
4489 | .offset = nb_clusters << s->cluster_bits, | |
4490 | .nb_bytes = 0, | |
4491 | }, | |
40dee943 | 4492 | .prealloc = !subclusters_need_allocation, |
772d1f97 HR |
4493 | }; |
4494 | qemu_co_queue_init(&allocation.dependent_requests); | |
4495 | ||
4496 | ret = qcow2_alloc_cluster_link_l2(bs, &allocation); | |
4497 | if (ret < 0) { | |
4498 | error_setg_errno(errp, -ret, "Failed to update L2 tables"); | |
4499 | qcow2_free_clusters(bs, host_offset, | |
4500 | nb_new_data_clusters * s->cluster_size, | |
4501 | QCOW2_DISCARD_OTHER); | |
061ca8a3 | 4502 | goto fail; |
772d1f97 HR |
4503 | } |
4504 | ||
4505 | guest_offset += nb_clusters * s->cluster_size; | |
4506 | host_offset += nb_clusters * s->cluster_size; | |
4507 | nb_new_data_clusters -= nb_clusters; | |
4508 | } | |
4509 | break; | |
4510 | } | |
4511 | ||
95b98f34 HR |
4512 | default: |
4513 | g_assert_not_reached(); | |
4514 | } | |
4515 | ||
f01643fb | 4516 | if ((flags & BDRV_REQ_ZERO_WRITE) && offset > old_length) { |
a6841a2d | 4517 | uint64_t zero_start = QEMU_ALIGN_UP(old_length, s->subcluster_size); |
f01643fb KW |
4518 | |
4519 | /* | |
a6841a2d AG |
4520 | * Use zero clusters as much as we can. qcow2_subcluster_zeroize() |
4521 | * requires a subcluster-aligned start. The end may be unaligned if | |
4522 | * it is at the end of the image (which it is here). | |
f01643fb | 4523 | */ |
e4d7019e | 4524 | if (offset > zero_start) { |
a6841a2d AG |
4525 | ret = qcow2_subcluster_zeroize(bs, zero_start, offset - zero_start, |
4526 | 0); | |
e4d7019e AG |
4527 | if (ret < 0) { |
4528 | error_setg_errno(errp, -ret, "Failed to zero out new clusters"); | |
4529 | goto fail; | |
4530 | } | |
f01643fb KW |
4531 | } |
4532 | ||
4533 | /* Write explicit zeros for the unaligned head */ | |
4534 | if (zero_start > old_length) { | |
e4d7019e | 4535 | uint64_t len = MIN(zero_start, offset) - old_length; |
f01643fb KW |
4536 | uint8_t *buf = qemu_blockalign0(bs, len); |
4537 | QEMUIOVector qiov; | |
4538 | qemu_iovec_init_buf(&qiov, buf, len); | |
4539 | ||
4540 | qemu_co_mutex_unlock(&s->lock); | |
4541 | ret = qcow2_co_pwritev_part(bs, old_length, len, &qiov, 0, 0); | |
4542 | qemu_co_mutex_lock(&s->lock); | |
4543 | ||
4544 | qemu_vfree(buf); | |
4545 | if (ret < 0) { | |
4546 | error_setg_errno(errp, -ret, "Failed to zero out the new area"); | |
4547 | goto fail; | |
4548 | } | |
4549 | } | |
4550 | } | |
4551 | ||
95b98f34 HR |
4552 | if (prealloc != PREALLOC_MODE_OFF) { |
4553 | /* Flush metadata before actually changing the image size */ | |
061ca8a3 | 4554 | ret = qcow2_write_caches(bs); |
95b98f34 HR |
4555 | if (ret < 0) { |
4556 | error_setg_errno(errp, -ret, | |
4557 | "Failed to flush the preallocated area to disk"); | |
061ca8a3 | 4558 | goto fail; |
95b98f34 HR |
4559 | } |
4560 | } | |
4561 | ||
45b4949c LB |
4562 | bs->total_sectors = offset / BDRV_SECTOR_SIZE; |
4563 | ||
419b19d9 SH |
4564 | /* write updated header.size */ |
4565 | offset = cpu_to_be64(offset); | |
a8f0e83c AF |
4566 | ret = bdrv_co_pwrite_sync(bs->file, offsetof(QCowHeader, size), |
4567 | sizeof(offset), &offset, 0); | |
419b19d9 | 4568 | if (ret < 0) { |
f59adb32 | 4569 | error_setg_errno(errp, -ret, "Failed to update the image size"); |
061ca8a3 | 4570 | goto fail; |
419b19d9 SH |
4571 | } |
4572 | ||
4573 | s->l1_vm_state_index = new_l1_size; | |
45b4949c LB |
4574 | |
4575 | /* Update cache sizes */ | |
4576 | options = qdict_clone_shallow(bs->options); | |
4577 | ret = qcow2_update_options(bs, options, s->flags, errp); | |
4578 | qobject_unref(options); | |
4579 | if (ret < 0) { | |
4580 | goto fail; | |
4581 | } | |
061ca8a3 KW |
4582 | ret = 0; |
4583 | fail: | |
4584 | qemu_co_mutex_unlock(&s->lock); | |
4585 | return ret; | |
419b19d9 SH |
4586 | } |
4587 | ||
fcccefc5 | 4588 | static coroutine_fn int |
0d483dce | 4589 | qcow2_co_pwritev_compressed_task(BlockDriverState *bs, |
5396234b VSO |
4590 | uint64_t offset, uint64_t bytes, |
4591 | QEMUIOVector *qiov, size_t qiov_offset) | |
20d97356 | 4592 | { |
ff99129a | 4593 | BDRVQcow2State *s = bs->opaque; |
2714f13d | 4594 | int ret; |
e1f4a37a | 4595 | ssize_t out_len; |
fcccefc5 | 4596 | uint8_t *buf, *out_buf; |
77e023ff | 4597 | uint64_t cluster_offset; |
20d97356 | 4598 | |
0d483dce AS |
4599 | assert(bytes == s->cluster_size || (bytes < s->cluster_size && |
4600 | (offset + bytes == bs->total_sectors << BDRV_SECTOR_BITS))); | |
3e3b838f | 4601 | |
a2c0ca6f | 4602 | buf = qemu_blockalign(bs, s->cluster_size); |
0d483dce | 4603 | if (bytes < s->cluster_size) { |
a2c0ca6f PB |
4604 | /* Zero-pad last write if image size is not cluster aligned */ |
4605 | memset(buf + bytes, 0, s->cluster_size - bytes); | |
f4d38bef | 4606 | } |
5396234b | 4607 | qemu_iovec_to_buf(qiov, qiov_offset, buf, bytes); |
20d97356 | 4608 | |
ebf7bba0 | 4609 | out_buf = g_malloc(s->cluster_size); |
20d97356 | 4610 | |
6994fd78 VSO |
4611 | out_len = qcow2_co_compress(bs, out_buf, s->cluster_size - 1, |
4612 | buf, s->cluster_size); | |
e1f4a37a | 4613 | if (out_len == -ENOMEM) { |
20d97356 | 4614 | /* could not compress: write normal cluster */ |
5396234b | 4615 | ret = qcow2_co_pwritev_part(bs, offset, bytes, qiov, qiov_offset, 0); |
8f1efd00 KW |
4616 | if (ret < 0) { |
4617 | goto fail; | |
4618 | } | |
fcccefc5 | 4619 | goto success; |
e1f4a37a AG |
4620 | } else if (out_len < 0) { |
4621 | ret = -EINVAL; | |
4622 | goto fail; | |
fcccefc5 | 4623 | } |
cf93980e | 4624 | |
fcccefc5 | 4625 | qemu_co_mutex_lock(&s->lock); |
77e023ff KW |
4626 | ret = qcow2_alloc_compressed_cluster_offset(bs, offset, out_len, |
4627 | &cluster_offset); | |
4628 | if (ret < 0) { | |
fcccefc5 | 4629 | qemu_co_mutex_unlock(&s->lock); |
fcccefc5 PB |
4630 | goto fail; |
4631 | } | |
cf93980e | 4632 | |
966b000f | 4633 | ret = qcow2_pre_write_overlap_check(bs, 0, cluster_offset, out_len, true); |
fcccefc5 PB |
4634 | qemu_co_mutex_unlock(&s->lock); |
4635 | if (ret < 0) { | |
4636 | goto fail; | |
20d97356 BS |
4637 | } |
4638 | ||
966b000f | 4639 | BLKDBG_EVENT(s->data_file, BLKDBG_WRITE_COMPRESSED); |
b00cb15b | 4640 | ret = bdrv_co_pwrite(s->data_file, cluster_offset, out_len, out_buf, 0); |
fcccefc5 PB |
4641 | if (ret < 0) { |
4642 | goto fail; | |
4643 | } | |
4644 | success: | |
8f1efd00 KW |
4645 | ret = 0; |
4646 | fail: | |
fcccefc5 | 4647 | qemu_vfree(buf); |
7267c094 | 4648 | g_free(out_buf); |
8f1efd00 | 4649 | return ret; |
20d97356 BS |
4650 | } |
4651 | ||
0d483dce AS |
4652 | static coroutine_fn int qcow2_co_pwritev_compressed_task_entry(AioTask *task) |
4653 | { | |
4654 | Qcow2AioTask *t = container_of(task, Qcow2AioTask, task); | |
4655 | ||
10dabdc5 | 4656 | assert(!t->subcluster_type && !t->l2meta); |
0d483dce AS |
4657 | |
4658 | return qcow2_co_pwritev_compressed_task(t->bs, t->offset, t->bytes, t->qiov, | |
4659 | t->qiov_offset); | |
4660 | } | |
4661 | ||
4662 | /* | |
4663 | * XXX: put compressed sectors first, then all the cluster aligned | |
4664 | * tables to avoid losing bytes in alignment | |
4665 | */ | |
4666 | static coroutine_fn int | |
4667 | qcow2_co_pwritev_compressed_part(BlockDriverState *bs, | |
e75abeda | 4668 | int64_t offset, int64_t bytes, |
0d483dce AS |
4669 | QEMUIOVector *qiov, size_t qiov_offset) |
4670 | { | |
4671 | BDRVQcow2State *s = bs->opaque; | |
4672 | AioTaskPool *aio = NULL; | |
4673 | int ret = 0; | |
4674 | ||
c2b8e315 KW |
4675 | assume_graph_lock(); /* FIXME */ |
4676 | ||
0d483dce AS |
4677 | if (has_data_file(bs)) { |
4678 | return -ENOTSUP; | |
4679 | } | |
4680 | ||
4681 | if (bytes == 0) { | |
4682 | /* | |
4683 | * align end of file to a sector boundary to ease reading with | |
4684 | * sector based I/Os | |
4685 | */ | |
4686 | int64_t len = bdrv_getlength(bs->file->bs); | |
4687 | if (len < 0) { | |
4688 | return len; | |
4689 | } | |
7b8e4857 KW |
4690 | return bdrv_co_truncate(bs->file, len, false, PREALLOC_MODE_OFF, 0, |
4691 | NULL); | |
0d483dce AS |
4692 | } |
4693 | ||
4694 | if (offset_into_cluster(s, offset)) { | |
4695 | return -EINVAL; | |
4696 | } | |
4697 | ||
fb43d2d4 AG |
4698 | if (offset_into_cluster(s, bytes) && |
4699 | (offset + bytes) != (bs->total_sectors << BDRV_SECTOR_BITS)) { | |
4700 | return -EINVAL; | |
4701 | } | |
4702 | ||
0d483dce AS |
4703 | while (bytes && aio_task_pool_status(aio) == 0) { |
4704 | uint64_t chunk_size = MIN(bytes, s->cluster_size); | |
4705 | ||
4706 | if (!aio && chunk_size != bytes) { | |
4707 | aio = aio_task_pool_new(QCOW2_MAX_WORKERS); | |
4708 | } | |
4709 | ||
4710 | ret = qcow2_add_task(bs, aio, qcow2_co_pwritev_compressed_task_entry, | |
4711 | 0, 0, offset, chunk_size, qiov, qiov_offset, NULL); | |
4712 | if (ret < 0) { | |
4713 | break; | |
4714 | } | |
4715 | qiov_offset += chunk_size; | |
4716 | offset += chunk_size; | |
4717 | bytes -= chunk_size; | |
4718 | } | |
4719 | ||
4720 | if (aio) { | |
4721 | aio_task_pool_wait_all(aio); | |
4722 | if (ret == 0) { | |
4723 | ret = aio_task_pool_status(aio); | |
4724 | } | |
4725 | g_free(aio); | |
4726 | } | |
4727 | ||
4728 | return ret; | |
4729 | } | |
4730 | ||
c3c10f72 VSO |
4731 | static int coroutine_fn |
4732 | qcow2_co_preadv_compressed(BlockDriverState *bs, | |
9a3978a4 | 4733 | uint64_t l2_entry, |
c3c10f72 VSO |
4734 | uint64_t offset, |
4735 | uint64_t bytes, | |
df893d25 VSO |
4736 | QEMUIOVector *qiov, |
4737 | size_t qiov_offset) | |
f4b3e2a9 VSO |
4738 | { |
4739 | BDRVQcow2State *s = bs->opaque; | |
a6e09846 | 4740 | int ret = 0, csize; |
f4b3e2a9 | 4741 | uint64_t coffset; |
c3c10f72 | 4742 | uint8_t *buf, *out_buf; |
c3c10f72 | 4743 | int offset_in_cluster = offset_into_cluster(s, offset); |
f4b3e2a9 | 4744 | |
a6e09846 | 4745 | qcow2_parse_compressed_l2_entry(bs, l2_entry, &coffset, &csize); |
f4b3e2a9 | 4746 | |
c3c10f72 VSO |
4747 | buf = g_try_malloc(csize); |
4748 | if (!buf) { | |
4749 | return -ENOMEM; | |
4750 | } | |
f4b3e2a9 | 4751 | |
c3c10f72 | 4752 | out_buf = qemu_blockalign(bs, s->cluster_size); |
c068a1cd | 4753 | |
c3c10f72 | 4754 | BLKDBG_EVENT(bs->file, BLKDBG_READ_COMPRESSED); |
b00cb15b | 4755 | ret = bdrv_co_pread(bs->file, coffset, csize, buf, 0); |
c3c10f72 VSO |
4756 | if (ret < 0) { |
4757 | goto fail; | |
f4b3e2a9 | 4758 | } |
c3c10f72 | 4759 | |
e23c9d7a | 4760 | if (qcow2_co_decompress(bs, out_buf, s->cluster_size, buf, csize) < 0) { |
c3c10f72 VSO |
4761 | ret = -EIO; |
4762 | goto fail; | |
4763 | } | |
4764 | ||
df893d25 | 4765 | qemu_iovec_from_buf(qiov, qiov_offset, out_buf + offset_in_cluster, bytes); |
c3c10f72 VSO |
4766 | |
4767 | fail: | |
4768 | qemu_vfree(out_buf); | |
4769 | g_free(buf); | |
4770 | ||
4771 | return ret; | |
f4b3e2a9 VSO |
4772 | } |
4773 | ||
94054183 HR |
4774 | static int make_completely_empty(BlockDriverState *bs) |
4775 | { | |
ff99129a | 4776 | BDRVQcow2State *s = bs->opaque; |
ed3d2ec9 | 4777 | Error *local_err = NULL; |
94054183 HR |
4778 | int ret, l1_clusters; |
4779 | int64_t offset; | |
4780 | uint64_t *new_reftable = NULL; | |
4781 | uint64_t rt_entry, l1_size2; | |
4782 | struct { | |
4783 | uint64_t l1_offset; | |
4784 | uint64_t reftable_offset; | |
4785 | uint32_t reftable_clusters; | |
4786 | } QEMU_PACKED l1_ofs_rt_ofs_cls; | |
4787 | ||
4788 | ret = qcow2_cache_empty(bs, s->l2_table_cache); | |
4789 | if (ret < 0) { | |
4790 | goto fail; | |
4791 | } | |
4792 | ||
4793 | ret = qcow2_cache_empty(bs, s->refcount_block_cache); | |
4794 | if (ret < 0) { | |
4795 | goto fail; | |
4796 | } | |
4797 | ||
4798 | /* Refcounts will be broken utterly */ | |
4799 | ret = qcow2_mark_dirty(bs); | |
4800 | if (ret < 0) { | |
4801 | goto fail; | |
4802 | } | |
4803 | ||
4804 | BLKDBG_EVENT(bs->file, BLKDBG_L1_UPDATE); | |
4805 | ||
02b1ecfa AG |
4806 | l1_clusters = DIV_ROUND_UP(s->l1_size, s->cluster_size / L1E_SIZE); |
4807 | l1_size2 = (uint64_t)s->l1_size * L1E_SIZE; | |
94054183 HR |
4808 | |
4809 | /* After this call, neither the in-memory nor the on-disk refcount | |
4810 | * information accurately describe the actual references */ | |
4811 | ||
720ff280 | 4812 | ret = bdrv_pwrite_zeroes(bs->file, s->l1_table_offset, |
74021bc4 | 4813 | l1_clusters * s->cluster_size, 0); |
94054183 HR |
4814 | if (ret < 0) { |
4815 | goto fail_broken_refcounts; | |
4816 | } | |
4817 | memset(s->l1_table, 0, l1_size2); | |
4818 | ||
4819 | BLKDBG_EVENT(bs->file, BLKDBG_EMPTY_IMAGE_PREPARE); | |
4820 | ||
4821 | /* Overwrite enough clusters at the beginning of the sectors to place | |
4822 | * the refcount table, a refcount block and the L1 table in; this may | |
4823 | * overwrite parts of the existing refcount and L1 table, which is not | |
4824 | * an issue because the dirty flag is set, complete data loss is in fact | |
4825 | * desired and partial data loss is consequently fine as well */ | |
720ff280 | 4826 | ret = bdrv_pwrite_zeroes(bs->file, s->cluster_size, |
74021bc4 | 4827 | (2 + l1_clusters) * s->cluster_size, 0); |
94054183 HR |
4828 | /* This call (even if it failed overall) may have overwritten on-disk |
4829 | * refcount structures; in that case, the in-memory refcount information | |
4830 | * will probably differ from the on-disk information which makes the BDS | |
4831 | * unusable */ | |
4832 | if (ret < 0) { | |
4833 | goto fail_broken_refcounts; | |
4834 | } | |
4835 | ||
4836 | BLKDBG_EVENT(bs->file, BLKDBG_L1_UPDATE); | |
4837 | BLKDBG_EVENT(bs->file, BLKDBG_REFTABLE_UPDATE); | |
4838 | ||
4839 | /* "Create" an empty reftable (one cluster) directly after the image | |
4840 | * header and an empty L1 table three clusters after the image header; | |
4841 | * the cluster between those two will be used as the first refblock */ | |
f1f7a1dd PM |
4842 | l1_ofs_rt_ofs_cls.l1_offset = cpu_to_be64(3 * s->cluster_size); |
4843 | l1_ofs_rt_ofs_cls.reftable_offset = cpu_to_be64(s->cluster_size); | |
4844 | l1_ofs_rt_ofs_cls.reftable_clusters = cpu_to_be32(1); | |
d9ca2ea2 | 4845 | ret = bdrv_pwrite_sync(bs->file, offsetof(QCowHeader, l1_table_offset), |
32cc71de | 4846 | sizeof(l1_ofs_rt_ofs_cls), &l1_ofs_rt_ofs_cls, 0); |
94054183 HR |
4847 | if (ret < 0) { |
4848 | goto fail_broken_refcounts; | |
4849 | } | |
4850 | ||
4851 | s->l1_table_offset = 3 * s->cluster_size; | |
4852 | ||
02b1ecfa | 4853 | new_reftable = g_try_new0(uint64_t, s->cluster_size / REFTABLE_ENTRY_SIZE); |
94054183 HR |
4854 | if (!new_reftable) { |
4855 | ret = -ENOMEM; | |
4856 | goto fail_broken_refcounts; | |
4857 | } | |
4858 | ||
4859 | s->refcount_table_offset = s->cluster_size; | |
02b1ecfa | 4860 | s->refcount_table_size = s->cluster_size / REFTABLE_ENTRY_SIZE; |
7061a078 | 4861 | s->max_refcount_table_index = 0; |
94054183 HR |
4862 | |
4863 | g_free(s->refcount_table); | |
4864 | s->refcount_table = new_reftable; | |
4865 | new_reftable = NULL; | |
4866 | ||
4867 | /* Now the in-memory refcount information again corresponds to the on-disk | |
4868 | * information (reftable is empty and no refblocks (the refblock cache is | |
4869 | * empty)); however, this means some clusters (e.g. the image header) are | |
4870 | * referenced, but not refcounted, but the normal qcow2 code assumes that | |
4871 | * the in-memory information is always correct */ | |
4872 | ||
4873 | BLKDBG_EVENT(bs->file, BLKDBG_REFBLOCK_ALLOC); | |
4874 | ||
4875 | /* Enter the first refblock into the reftable */ | |
4876 | rt_entry = cpu_to_be64(2 * s->cluster_size); | |
32cc71de AF |
4877 | ret = bdrv_pwrite_sync(bs->file, s->cluster_size, sizeof(rt_entry), |
4878 | &rt_entry, 0); | |
94054183 HR |
4879 | if (ret < 0) { |
4880 | goto fail_broken_refcounts; | |
4881 | } | |
4882 | s->refcount_table[0] = 2 * s->cluster_size; | |
4883 | ||
4884 | s->free_cluster_index = 0; | |
4885 | assert(3 + l1_clusters <= s->refcount_block_size); | |
4886 | offset = qcow2_alloc_clusters(bs, 3 * s->cluster_size + l1_size2); | |
4887 | if (offset < 0) { | |
4888 | ret = offset; | |
4889 | goto fail_broken_refcounts; | |
4890 | } else if (offset > 0) { | |
4891 | error_report("First cluster in emptied image is in use"); | |
4892 | abort(); | |
4893 | } | |
4894 | ||
4895 | /* Now finally the in-memory information corresponds to the on-disk | |
4896 | * structures and is correct */ | |
4897 | ret = qcow2_mark_clean(bs); | |
4898 | if (ret < 0) { | |
4899 | goto fail; | |
4900 | } | |
4901 | ||
c80d8b06 | 4902 | ret = bdrv_truncate(bs->file, (3 + l1_clusters) * s->cluster_size, false, |
7b8e4857 | 4903 | PREALLOC_MODE_OFF, 0, &local_err); |
94054183 | 4904 | if (ret < 0) { |
ed3d2ec9 | 4905 | error_report_err(local_err); |
94054183 HR |
4906 | goto fail; |
4907 | } | |
4908 | ||
4909 | return 0; | |
4910 | ||
4911 | fail_broken_refcounts: | |
4912 | /* The BDS is unusable at this point. If we wanted to make it usable, we | |
4913 | * would have to call qcow2_refcount_close(), qcow2_refcount_init(), | |
4914 | * qcow2_check_refcounts(), qcow2_refcount_close() and qcow2_refcount_init() | |
4915 | * again. However, because the functions which could have caused this error | |
4916 | * path to be taken are used by those functions as well, it's very likely | |
4917 | * that that sequence will fail as well. Therefore, just eject the BDS. */ | |
4918 | bs->drv = NULL; | |
4919 | ||
4920 | fail: | |
4921 | g_free(new_reftable); | |
4922 | return ret; | |
4923 | } | |
4924 | ||
491d27e2 HR |
4925 | static int qcow2_make_empty(BlockDriverState *bs) |
4926 | { | |
ff99129a | 4927 | BDRVQcow2State *s = bs->opaque; |
d2cb36af EB |
4928 | uint64_t offset, end_offset; |
4929 | int step = QEMU_ALIGN_DOWN(INT_MAX, s->cluster_size); | |
94054183 HR |
4930 | int l1_clusters, ret = 0; |
4931 | ||
02b1ecfa | 4932 | l1_clusters = DIV_ROUND_UP(s->l1_size, s->cluster_size / L1E_SIZE); |
94054183 | 4933 | |
4096974e | 4934 | if (s->qcow_version >= 3 && !s->snapshots && !s->nb_bitmaps && |
f0603329 | 4935 | 3 + l1_clusters <= s->refcount_block_size && |
db04524f KW |
4936 | s->crypt_method_header != QCOW_CRYPT_LUKS && |
4937 | !has_data_file(bs)) { | |
4096974e EB |
4938 | /* The following function only works for qcow2 v3 images (it |
4939 | * requires the dirty flag) and only as long as there are no | |
4940 | * features that reserve extra clusters (such as snapshots, | |
4941 | * LUKS header, or persistent bitmaps), because it completely | |
4942 | * empties the image. Furthermore, the L1 table and three | |
4943 | * additional clusters (image header, refcount table, one | |
db04524f KW |
4944 | * refcount block) have to fit inside one refcount block. It |
4945 | * only resets the image file, i.e. does not work with an | |
4946 | * external data file. */ | |
94054183 HR |
4947 | return make_completely_empty(bs); |
4948 | } | |
491d27e2 | 4949 | |
94054183 HR |
4950 | /* This fallback code simply discards every active cluster; this is slow, |
4951 | * but works in all cases */ | |
d2cb36af EB |
4952 | end_offset = bs->total_sectors * BDRV_SECTOR_SIZE; |
4953 | for (offset = 0; offset < end_offset; offset += step) { | |
491d27e2 HR |
4954 | /* As this function is generally used after committing an external |
4955 | * snapshot, QCOW2_DISCARD_SNAPSHOT seems appropriate. Also, the | |
4956 | * default action for this kind of discard is to pass the discard, | |
4957 | * which will ideally result in an actually smaller image file, as | |
4958 | * is probably desired. */ | |
d2cb36af EB |
4959 | ret = qcow2_cluster_discard(bs, offset, MIN(step, end_offset - offset), |
4960 | QCOW2_DISCARD_SNAPSHOT, true); | |
491d27e2 HR |
4961 | if (ret < 0) { |
4962 | break; | |
4963 | } | |
4964 | } | |
4965 | ||
4966 | return ret; | |
4967 | } | |
4968 | ||
a968168c | 4969 | static coroutine_fn int qcow2_co_flush_to_os(BlockDriverState *bs) |
20d97356 | 4970 | { |
ff99129a | 4971 | BDRVQcow2State *s = bs->opaque; |
29c1a730 KW |
4972 | int ret; |
4973 | ||
8b94ff85 | 4974 | qemu_co_mutex_lock(&s->lock); |
8b220eb7 | 4975 | ret = qcow2_write_caches(bs); |
8b94ff85 | 4976 | qemu_co_mutex_unlock(&s->lock); |
29c1a730 | 4977 | |
8b220eb7 | 4978 | return ret; |
eb489bb1 KW |
4979 | } |
4980 | ||
c501c352 SH |
4981 | static BlockMeasureInfo *qcow2_measure(QemuOpts *opts, BlockDriverState *in_bs, |
4982 | Error **errp) | |
4983 | { | |
4984 | Error *local_err = NULL; | |
4985 | BlockMeasureInfo *info; | |
4986 | uint64_t required = 0; /* bytes that contribute to required size */ | |
4987 | uint64_t virtual_size; /* disk size as seen by guest */ | |
4988 | uint64_t refcount_bits; | |
4989 | uint64_t l2_tables; | |
61914f89 | 4990 | uint64_t luks_payload_size = 0; |
c501c352 SH |
4991 | size_t cluster_size; |
4992 | int version; | |
4993 | char *optstr; | |
4994 | PreallocMode prealloc; | |
4995 | bool has_backing_file; | |
61914f89 | 4996 | bool has_luks; |
7be20252 | 4997 | bool extended_l2; |
0dd07b29 | 4998 | size_t l2e_size; |
c501c352 SH |
4999 | |
5000 | /* Parse image creation options */ | |
7be20252 AG |
5001 | extended_l2 = qemu_opt_get_bool_del(opts, BLOCK_OPT_EXTL2, false); |
5002 | ||
5003 | cluster_size = qcow2_opt_get_cluster_size_del(opts, extended_l2, | |
5004 | &local_err); | |
c501c352 SH |
5005 | if (local_err) { |
5006 | goto err; | |
5007 | } | |
5008 | ||
5009 | version = qcow2_opt_get_version_del(opts, &local_err); | |
5010 | if (local_err) { | |
5011 | goto err; | |
5012 | } | |
5013 | ||
5014 | refcount_bits = qcow2_opt_get_refcount_bits_del(opts, version, &local_err); | |
5015 | if (local_err) { | |
5016 | goto err; | |
5017 | } | |
5018 | ||
5019 | optstr = qemu_opt_get_del(opts, BLOCK_OPT_PREALLOC); | |
f7abe0ec | 5020 | prealloc = qapi_enum_parse(&PreallocMode_lookup, optstr, |
06c60b6c | 5021 | PREALLOC_MODE_OFF, &local_err); |
c501c352 SH |
5022 | g_free(optstr); |
5023 | if (local_err) { | |
5024 | goto err; | |
5025 | } | |
5026 | ||
5027 | optstr = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FILE); | |
5028 | has_backing_file = !!optstr; | |
5029 | g_free(optstr); | |
5030 | ||
61914f89 SH |
5031 | optstr = qemu_opt_get_del(opts, BLOCK_OPT_ENCRYPT_FORMAT); |
5032 | has_luks = optstr && strcmp(optstr, "luks") == 0; | |
5033 | g_free(optstr); | |
5034 | ||
5035 | if (has_luks) { | |
6d49d3a8 | 5036 | g_autoptr(QCryptoBlockCreateOptions) create_opts = NULL; |
90766d9d | 5037 | QDict *cryptoopts = qcow2_extract_crypto_opts(opts, "luks", errp); |
61914f89 SH |
5038 | size_t headerlen; |
5039 | ||
6d49d3a8 SH |
5040 | create_opts = block_crypto_create_opts_init(cryptoopts, errp); |
5041 | qobject_unref(cryptoopts); | |
5042 | if (!create_opts) { | |
5043 | goto err; | |
5044 | } | |
5045 | ||
5046 | if (!qcrypto_block_calculate_payload_offset(create_opts, | |
5047 | "encrypt.", | |
5048 | &headerlen, | |
5049 | &local_err)) { | |
61914f89 SH |
5050 | goto err; |
5051 | } | |
5052 | ||
5053 | luks_payload_size = ROUND_UP(headerlen, cluster_size); | |
5054 | } | |
5055 | ||
9e029689 AG |
5056 | virtual_size = qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0); |
5057 | virtual_size = ROUND_UP(virtual_size, cluster_size); | |
c501c352 SH |
5058 | |
5059 | /* Check that virtual disk size is valid */ | |
0dd07b29 | 5060 | l2e_size = extended_l2 ? L2E_SIZE_EXTENDED : L2E_SIZE_NORMAL; |
c501c352 | 5061 | l2_tables = DIV_ROUND_UP(virtual_size / cluster_size, |
0dd07b29 | 5062 | cluster_size / l2e_size); |
02b1ecfa | 5063 | if (l2_tables * L1E_SIZE > QCOW_MAX_L1_SIZE) { |
c501c352 SH |
5064 | error_setg(&local_err, "The image size is too large " |
5065 | "(try using a larger cluster size)"); | |
5066 | goto err; | |
5067 | } | |
5068 | ||
5069 | /* Account for input image */ | |
5070 | if (in_bs) { | |
5071 | int64_t ssize = bdrv_getlength(in_bs); | |
5072 | if (ssize < 0) { | |
5073 | error_setg_errno(&local_err, -ssize, | |
5074 | "Unable to get image virtual_size"); | |
5075 | goto err; | |
5076 | } | |
5077 | ||
9e029689 | 5078 | virtual_size = ROUND_UP(ssize, cluster_size); |
c501c352 SH |
5079 | |
5080 | if (has_backing_file) { | |
5081 | /* We don't how much of the backing chain is shared by the input | |
5082 | * image and the new image file. In the worst case the new image's | |
5083 | * backing file has nothing in common with the input image. Be | |
5084 | * conservative and assume all clusters need to be written. | |
5085 | */ | |
5086 | required = virtual_size; | |
5087 | } else { | |
b85ee453 | 5088 | int64_t offset; |
31826642 | 5089 | int64_t pnum = 0; |
c501c352 | 5090 | |
31826642 EB |
5091 | for (offset = 0; offset < ssize; offset += pnum) { |
5092 | int ret; | |
c501c352 | 5093 | |
31826642 EB |
5094 | ret = bdrv_block_status_above(in_bs, NULL, offset, |
5095 | ssize - offset, &pnum, NULL, | |
5096 | NULL); | |
c501c352 SH |
5097 | if (ret < 0) { |
5098 | error_setg_errno(&local_err, -ret, | |
5099 | "Unable to get block status"); | |
5100 | goto err; | |
5101 | } | |
5102 | ||
5103 | if (ret & BDRV_BLOCK_ZERO) { | |
5104 | /* Skip zero regions (safe with no backing file) */ | |
5105 | } else if ((ret & (BDRV_BLOCK_DATA | BDRV_BLOCK_ALLOCATED)) == | |
5106 | (BDRV_BLOCK_DATA | BDRV_BLOCK_ALLOCATED)) { | |
5107 | /* Extend pnum to end of cluster for next iteration */ | |
31826642 | 5108 | pnum = ROUND_UP(offset + pnum, cluster_size) - offset; |
c501c352 SH |
5109 | |
5110 | /* Count clusters we've seen */ | |
31826642 | 5111 | required += offset % cluster_size + pnum; |
c501c352 SH |
5112 | } |
5113 | } | |
5114 | } | |
5115 | } | |
5116 | ||
5117 | /* Take into account preallocation. Nothing special is needed for | |
5118 | * PREALLOC_MODE_METADATA since metadata is always counted. | |
5119 | */ | |
5120 | if (prealloc == PREALLOC_MODE_FULL || prealloc == PREALLOC_MODE_FALLOC) { | |
5121 | required = virtual_size; | |
5122 | } | |
5123 | ||
5d72c68b | 5124 | info = g_new0(BlockMeasureInfo, 1); |
0dd07b29 | 5125 | info->fully_allocated = luks_payload_size + |
c501c352 | 5126 | qcow2_calc_prealloc_size(virtual_size, cluster_size, |
0dd07b29 | 5127 | ctz32(refcount_bits), extended_l2); |
c501c352 | 5128 | |
5d72c68b EB |
5129 | /* |
5130 | * Remove data clusters that are not required. This overestimates the | |
c501c352 | 5131 | * required size because metadata needed for the fully allocated file is |
5d72c68b EB |
5132 | * still counted. Show bitmaps only if both source and destination |
5133 | * would support them. | |
c501c352 SH |
5134 | */ |
5135 | info->required = info->fully_allocated - virtual_size + required; | |
5d72c68b EB |
5136 | info->has_bitmaps = version >= 3 && in_bs && |
5137 | bdrv_supports_persistent_dirty_bitmap(in_bs); | |
5138 | if (info->has_bitmaps) { | |
5139 | info->bitmaps = qcow2_get_persistent_dirty_bitmap_size(in_bs, | |
5140 | cluster_size); | |
5141 | } | |
c501c352 SH |
5142 | return info; |
5143 | ||
5144 | err: | |
5145 | error_propagate(errp, local_err); | |
5146 | return NULL; | |
5147 | } | |
5148 | ||
3d47eb0a EGE |
5149 | static int coroutine_fn |
5150 | qcow2_co_get_info(BlockDriverState *bs, BlockDriverInfo *bdi) | |
20d97356 | 5151 | { |
ff99129a | 5152 | BDRVQcow2State *s = bs->opaque; |
20d97356 | 5153 | bdi->cluster_size = s->cluster_size; |
7c80ab3f | 5154 | bdi->vm_state_offset = qcow2_vm_state_offset(s); |
38b44096 | 5155 | bdi->is_dirty = s->incompatible_features & QCOW2_INCOMPAT_DIRTY; |
20d97356 BS |
5156 | return 0; |
5157 | } | |
5158 | ||
1bf6e9ca AS |
5159 | static ImageInfoSpecific *qcow2_get_specific_info(BlockDriverState *bs, |
5160 | Error **errp) | |
37764dfb | 5161 | { |
ff99129a | 5162 | BDRVQcow2State *s = bs->opaque; |
0a12f6f8 DB |
5163 | ImageInfoSpecific *spec_info; |
5164 | QCryptoBlockInfo *encrypt_info = NULL; | |
37764dfb | 5165 | |
0a12f6f8 | 5166 | if (s->crypto != NULL) { |
83bad8cb VSO |
5167 | encrypt_info = qcrypto_block_get_info(s->crypto, errp); |
5168 | if (!encrypt_info) { | |
1bf6e9ca AS |
5169 | return NULL; |
5170 | } | |
0a12f6f8 DB |
5171 | } |
5172 | ||
5173 | spec_info = g_new(ImageInfoSpecific, 1); | |
37764dfb | 5174 | *spec_info = (ImageInfoSpecific){ |
6a8f9661 | 5175 | .type = IMAGE_INFO_SPECIFIC_KIND_QCOW2, |
b8968c87 | 5176 | .u.qcow2.data = g_new0(ImageInfoSpecificQCow2, 1), |
37764dfb HR |
5177 | }; |
5178 | if (s->qcow_version == 2) { | |
32bafa8f | 5179 | *spec_info->u.qcow2.data = (ImageInfoSpecificQCow2){ |
0709c5a1 HR |
5180 | .compat = g_strdup("0.10"), |
5181 | .refcount_bits = s->refcount_bits, | |
37764dfb HR |
5182 | }; |
5183 | } else if (s->qcow_version == 3) { | |
b8968c87 | 5184 | Qcow2BitmapInfoList *bitmaps; |
83bad8cb | 5185 | if (!qcow2_get_bitmap_info_list(bs, &bitmaps, errp)) { |
b8968c87 | 5186 | qapi_free_ImageInfoSpecific(spec_info); |
71eaec2e | 5187 | qapi_free_QCryptoBlockInfo(encrypt_info); |
b8968c87 AS |
5188 | return NULL; |
5189 | } | |
32bafa8f | 5190 | *spec_info->u.qcow2.data = (ImageInfoSpecificQCow2){ |
37764dfb HR |
5191 | .compat = g_strdup("1.1"), |
5192 | .lazy_refcounts = s->compatible_features & | |
5193 | QCOW2_COMPAT_LAZY_REFCOUNTS, | |
5194 | .has_lazy_refcounts = true, | |
9009b196 HR |
5195 | .corrupt = s->incompatible_features & |
5196 | QCOW2_INCOMPAT_CORRUPT, | |
5197 | .has_corrupt = true, | |
7be20252 AG |
5198 | .has_extended_l2 = true, |
5199 | .extended_l2 = has_subclusters(s), | |
0709c5a1 | 5200 | .refcount_bits = s->refcount_bits, |
b8968c87 AS |
5201 | .has_bitmaps = !!bitmaps, |
5202 | .bitmaps = bitmaps, | |
9b890bdc | 5203 | .data_file = g_strdup(s->image_data_file), |
6c3944dc KW |
5204 | .has_data_file_raw = has_data_file(bs), |
5205 | .data_file_raw = data_file_is_raw(bs), | |
572ad978 | 5206 | .compression_type = s->compression_type, |
37764dfb | 5207 | }; |
b1fc8f93 DL |
5208 | } else { |
5209 | /* if this assertion fails, this probably means a new version was | |
5210 | * added without having it covered here */ | |
5211 | assert(false); | |
37764dfb HR |
5212 | } |
5213 | ||
0a12f6f8 DB |
5214 | if (encrypt_info) { |
5215 | ImageInfoSpecificQCow2Encryption *qencrypt = | |
5216 | g_new(ImageInfoSpecificQCow2Encryption, 1); | |
5217 | switch (encrypt_info->format) { | |
5218 | case Q_CRYPTO_BLOCK_FORMAT_QCOW: | |
5219 | qencrypt->format = BLOCKDEV_QCOW2_ENCRYPTION_FORMAT_AES; | |
0a12f6f8 DB |
5220 | break; |
5221 | case Q_CRYPTO_BLOCK_FORMAT_LUKS: | |
5222 | qencrypt->format = BLOCKDEV_QCOW2_ENCRYPTION_FORMAT_LUKS; | |
5223 | qencrypt->u.luks = encrypt_info->u.luks; | |
5224 | break; | |
5225 | default: | |
5226 | abort(); | |
5227 | } | |
5228 | /* Since we did shallow copy above, erase any pointers | |
5229 | * in the original info */ | |
5230 | memset(&encrypt_info->u, 0, sizeof(encrypt_info->u)); | |
5231 | qapi_free_QCryptoBlockInfo(encrypt_info); | |
5232 | ||
0a12f6f8 DB |
5233 | spec_info->u.qcow2.data->encrypt = qencrypt; |
5234 | } | |
5235 | ||
37764dfb HR |
5236 | return spec_info; |
5237 | } | |
5238 | ||
38841dcd HR |
5239 | static int qcow2_has_zero_init(BlockDriverState *bs) |
5240 | { | |
5241 | BDRVQcow2State *s = bs->opaque; | |
5242 | bool preallocated; | |
5243 | ||
5244 | if (qemu_in_coroutine()) { | |
5245 | qemu_co_mutex_lock(&s->lock); | |
5246 | } | |
5247 | /* | |
5248 | * Check preallocation status: Preallocated images have all L2 | |
5249 | * tables allocated, nonpreallocated images have none. It is | |
5250 | * therefore enough to check the first one. | |
5251 | */ | |
5252 | preallocated = s->l1_size > 0 && s->l1_table[0] != 0; | |
5253 | if (qemu_in_coroutine()) { | |
5254 | qemu_co_mutex_unlock(&s->lock); | |
5255 | } | |
5256 | ||
5257 | if (!preallocated) { | |
5258 | return 1; | |
5259 | } else if (bs->encrypted) { | |
5260 | return 0; | |
5261 | } else { | |
5262 | return bdrv_has_zero_init(s->data_file->bs); | |
5263 | } | |
5264 | } | |
5265 | ||
558902cc VSO |
5266 | /* |
5267 | * Check the request to vmstate. On success return | |
5268 | * qcow2_vm_state_offset(bs) + @pos | |
5269 | */ | |
5270 | static int64_t qcow2_check_vmstate_request(BlockDriverState *bs, | |
5271 | QEMUIOVector *qiov, int64_t pos) | |
5272 | { | |
5273 | BDRVQcow2State *s = bs->opaque; | |
5274 | int64_t vmstate_offset = qcow2_vm_state_offset(s); | |
5275 | int ret; | |
5276 | ||
5277 | /* Incoming requests must be OK */ | |
5278 | bdrv_check_qiov_request(pos, qiov->size, qiov, 0, &error_abort); | |
5279 | ||
5280 | if (INT64_MAX - pos < vmstate_offset) { | |
5281 | return -EIO; | |
5282 | } | |
5283 | ||
5284 | pos += vmstate_offset; | |
5285 | ret = bdrv_check_qiov_request(pos, qiov->size, qiov, 0, NULL); | |
5286 | if (ret < 0) { | |
5287 | return ret; | |
5288 | } | |
5289 | ||
5290 | return pos; | |
5291 | } | |
5292 | ||
ca5e2ad9 EGE |
5293 | static coroutine_fn int qcow2_co_save_vmstate(BlockDriverState *bs, |
5294 | QEMUIOVector *qiov, int64_t pos) | |
20d97356 | 5295 | { |
558902cc VSO |
5296 | int64_t offset = qcow2_check_vmstate_request(bs, qiov, pos); |
5297 | if (offset < 0) { | |
5298 | return offset; | |
5299 | } | |
20d97356 | 5300 | |
66f82cee | 5301 | BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_SAVE); |
558902cc | 5302 | return bs->drv->bdrv_co_pwritev_part(bs, offset, qiov->size, qiov, 0, 0); |
20d97356 BS |
5303 | } |
5304 | ||
ca5e2ad9 EGE |
5305 | static coroutine_fn int qcow2_co_load_vmstate(BlockDriverState *bs, |
5306 | QEMUIOVector *qiov, int64_t pos) | |
20d97356 | 5307 | { |
558902cc VSO |
5308 | int64_t offset = qcow2_check_vmstate_request(bs, qiov, pos); |
5309 | if (offset < 0) { | |
5310 | return offset; | |
5311 | } | |
20d97356 | 5312 | |
66f82cee | 5313 | BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_LOAD); |
558902cc | 5314 | return bs->drv->bdrv_co_preadv_part(bs, offset, qiov->size, qiov, 0, 0); |
20d97356 BS |
5315 | } |
5316 | ||
083c2456 VSO |
5317 | static int qcow2_has_compressed_clusters(BlockDriverState *bs) |
5318 | { | |
5319 | int64_t offset = 0; | |
5320 | int64_t bytes = bdrv_getlength(bs); | |
5321 | ||
5322 | if (bytes < 0) { | |
5323 | return bytes; | |
5324 | } | |
5325 | ||
5326 | while (bytes != 0) { | |
5327 | int ret; | |
5328 | QCow2SubclusterType type; | |
5329 | unsigned int cur_bytes = MIN(INT_MAX, bytes); | |
5330 | uint64_t host_offset; | |
5331 | ||
5332 | ret = qcow2_get_host_offset(bs, offset, &cur_bytes, &host_offset, | |
5333 | &type); | |
5334 | if (ret < 0) { | |
5335 | return ret; | |
5336 | } | |
5337 | ||
5338 | if (type == QCOW2_SUBCLUSTER_COMPRESSED) { | |
5339 | return 1; | |
5340 | } | |
5341 | ||
5342 | offset += cur_bytes; | |
5343 | bytes -= cur_bytes; | |
5344 | } | |
5345 | ||
5346 | return 0; | |
5347 | } | |
5348 | ||
9296b3ed HR |
5349 | /* |
5350 | * Downgrades an image's version. To achieve this, any incompatible features | |
5351 | * have to be removed. | |
5352 | */ | |
4057a2b2 | 5353 | static int qcow2_downgrade(BlockDriverState *bs, int target_version, |
d1402b50 HR |
5354 | BlockDriverAmendStatusCB *status_cb, void *cb_opaque, |
5355 | Error **errp) | |
9296b3ed | 5356 | { |
ff99129a | 5357 | BDRVQcow2State *s = bs->opaque; |
9296b3ed HR |
5358 | int current_version = s->qcow_version; |
5359 | int ret; | |
7fa140ab | 5360 | int i; |
9296b3ed | 5361 | |
d1402b50 HR |
5362 | /* This is qcow2_downgrade(), not qcow2_upgrade() */ |
5363 | assert(target_version < current_version); | |
5364 | ||
5365 | /* There are no other versions (now) that you can downgrade to */ | |
5366 | assert(target_version == 2); | |
9296b3ed HR |
5367 | |
5368 | if (s->refcount_order != 4) { | |
d1402b50 | 5369 | error_setg(errp, "compat=0.10 requires refcount_bits=16"); |
9296b3ed HR |
5370 | return -ENOTSUP; |
5371 | } | |
5372 | ||
966b000f KW |
5373 | if (has_data_file(bs)) { |
5374 | error_setg(errp, "Cannot downgrade an image with a data file"); | |
5375 | return -ENOTSUP; | |
5376 | } | |
5377 | ||
7fa140ab EB |
5378 | /* |
5379 | * If any internal snapshot has a different size than the current | |
5380 | * image size, or VM state size that exceeds 32 bits, downgrading | |
5381 | * is unsafe. Even though we would still use v3-compliant output | |
5382 | * to preserve that data, other v2 programs might not realize | |
5383 | * those optional fields are important. | |
5384 | */ | |
5385 | for (i = 0; i < s->nb_snapshots; i++) { | |
5386 | if (s->snapshots[i].vm_state_size > UINT32_MAX || | |
5387 | s->snapshots[i].disk_size != bs->total_sectors * BDRV_SECTOR_SIZE) { | |
5388 | error_setg(errp, "Internal snapshots prevent downgrade of image"); | |
5389 | return -ENOTSUP; | |
5390 | } | |
5391 | } | |
5392 | ||
9296b3ed HR |
5393 | /* clear incompatible features */ |
5394 | if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) { | |
5395 | ret = qcow2_mark_clean(bs); | |
5396 | if (ret < 0) { | |
d1402b50 | 5397 | error_setg_errno(errp, -ret, "Failed to make the image clean"); |
9296b3ed HR |
5398 | return ret; |
5399 | } | |
5400 | } | |
5401 | ||
5402 | /* with QCOW2_INCOMPAT_CORRUPT, it is pretty much impossible to get here in | |
5403 | * the first place; if that happens nonetheless, returning -ENOTSUP is the | |
5404 | * best thing to do anyway */ | |
5405 | ||
083c2456 | 5406 | if (s->incompatible_features & ~QCOW2_INCOMPAT_COMPRESSION) { |
d1402b50 | 5407 | error_setg(errp, "Cannot downgrade an image with incompatible features " |
083c2456 VSO |
5408 | "0x%" PRIx64 " set", |
5409 | s->incompatible_features & ~QCOW2_INCOMPAT_COMPRESSION); | |
9296b3ed HR |
5410 | return -ENOTSUP; |
5411 | } | |
5412 | ||
5413 | /* since we can ignore compatible features, we can set them to 0 as well */ | |
5414 | s->compatible_features = 0; | |
5415 | /* if lazy refcounts have been used, they have already been fixed through | |
5416 | * clearing the dirty flag */ | |
5417 | ||
5418 | /* clearing autoclear features is trivial */ | |
5419 | s->autoclear_features = 0; | |
5420 | ||
8b13976d | 5421 | ret = qcow2_expand_zero_clusters(bs, status_cb, cb_opaque); |
9296b3ed | 5422 | if (ret < 0) { |
d1402b50 | 5423 | error_setg_errno(errp, -ret, "Failed to turn zero into data clusters"); |
9296b3ed HR |
5424 | return ret; |
5425 | } | |
5426 | ||
083c2456 VSO |
5427 | if (s->incompatible_features & QCOW2_INCOMPAT_COMPRESSION) { |
5428 | ret = qcow2_has_compressed_clusters(bs); | |
5429 | if (ret < 0) { | |
5430 | error_setg(errp, "Failed to check block status"); | |
5431 | return -EINVAL; | |
5432 | } | |
5433 | if (ret) { | |
5434 | error_setg(errp, "Cannot downgrade an image with zstd compression " | |
5435 | "type and existing compressed clusters"); | |
5436 | return -ENOTSUP; | |
5437 | } | |
5438 | /* | |
5439 | * No compressed clusters for now, so just chose default zlib | |
5440 | * compression. | |
5441 | */ | |
5442 | s->incompatible_features &= ~QCOW2_INCOMPAT_COMPRESSION; | |
5443 | s->compression_type = QCOW2_COMPRESSION_TYPE_ZLIB; | |
5444 | } | |
5445 | ||
5446 | assert(s->incompatible_features == 0); | |
5447 | ||
9296b3ed HR |
5448 | s->qcow_version = target_version; |
5449 | ret = qcow2_update_header(bs); | |
5450 | if (ret < 0) { | |
5451 | s->qcow_version = current_version; | |
d1402b50 | 5452 | error_setg_errno(errp, -ret, "Failed to update the image header"); |
9296b3ed HR |
5453 | return ret; |
5454 | } | |
5455 | return 0; | |
5456 | } | |
5457 | ||
722efb0c HR |
5458 | /* |
5459 | * Upgrades an image's version. While newer versions encompass all | |
5460 | * features of older versions, some things may have to be presented | |
5461 | * differently. | |
5462 | */ | |
5463 | static int qcow2_upgrade(BlockDriverState *bs, int target_version, | |
5464 | BlockDriverAmendStatusCB *status_cb, void *cb_opaque, | |
5465 | Error **errp) | |
5466 | { | |
5467 | BDRVQcow2State *s = bs->opaque; | |
0a85af35 | 5468 | bool need_snapshot_update; |
722efb0c | 5469 | int current_version = s->qcow_version; |
0a85af35 | 5470 | int i; |
722efb0c HR |
5471 | int ret; |
5472 | ||
5473 | /* This is qcow2_upgrade(), not qcow2_downgrade() */ | |
5474 | assert(target_version > current_version); | |
5475 | ||
5476 | /* There are no other versions (yet) that you can upgrade to */ | |
5477 | assert(target_version == 3); | |
5478 | ||
0a85af35 HR |
5479 | status_cb(bs, 0, 2, cb_opaque); |
5480 | ||
5481 | /* | |
5482 | * In v2, snapshots do not need to have extra data. v3 requires | |
5483 | * the 64-bit VM state size and the virtual disk size to be | |
5484 | * present. | |
5485 | * qcow2_write_snapshots() will always write the list in the | |
5486 | * v3-compliant format. | |
5487 | */ | |
5488 | need_snapshot_update = false; | |
5489 | for (i = 0; i < s->nb_snapshots; i++) { | |
5490 | if (s->snapshots[i].extra_data_size < | |
5491 | sizeof_field(QCowSnapshotExtraData, vm_state_size_large) + | |
5492 | sizeof_field(QCowSnapshotExtraData, disk_size)) | |
5493 | { | |
5494 | need_snapshot_update = true; | |
5495 | break; | |
5496 | } | |
5497 | } | |
5498 | if (need_snapshot_update) { | |
5499 | ret = qcow2_write_snapshots(bs); | |
5500 | if (ret < 0) { | |
5501 | error_setg_errno(errp, -ret, "Failed to update the snapshot table"); | |
5502 | return ret; | |
5503 | } | |
5504 | } | |
5505 | status_cb(bs, 1, 2, cb_opaque); | |
722efb0c HR |
5506 | |
5507 | s->qcow_version = target_version; | |
5508 | ret = qcow2_update_header(bs); | |
5509 | if (ret < 0) { | |
5510 | s->qcow_version = current_version; | |
5511 | error_setg_errno(errp, -ret, "Failed to update the image header"); | |
5512 | return ret; | |
5513 | } | |
0a85af35 | 5514 | status_cb(bs, 2, 2, cb_opaque); |
722efb0c HR |
5515 | |
5516 | return 0; | |
5517 | } | |
5518 | ||
c293a809 HR |
5519 | typedef enum Qcow2AmendOperation { |
5520 | /* This is the value Qcow2AmendHelperCBInfo::last_operation will be | |
5521 | * statically initialized to so that the helper CB can discern the first | |
5522 | * invocation from an operation change */ | |
5523 | QCOW2_NO_OPERATION = 0, | |
5524 | ||
722efb0c | 5525 | QCOW2_UPGRADING, |
90766d9d | 5526 | QCOW2_UPDATING_ENCRYPTION, |
61ce55fc | 5527 | QCOW2_CHANGING_REFCOUNT_ORDER, |
c293a809 HR |
5528 | QCOW2_DOWNGRADING, |
5529 | } Qcow2AmendOperation; | |
5530 | ||
5531 | typedef struct Qcow2AmendHelperCBInfo { | |
5532 | /* The code coordinating the amend operations should only modify | |
5533 | * these four fields; the rest will be managed by the CB */ | |
5534 | BlockDriverAmendStatusCB *original_status_cb; | |
5535 | void *original_cb_opaque; | |
5536 | ||
5537 | Qcow2AmendOperation current_operation; | |
5538 | ||
5539 | /* Total number of operations to perform (only set once) */ | |
5540 | int total_operations; | |
5541 | ||
5542 | /* The following fields are managed by the CB */ | |
5543 | ||
5544 | /* Number of operations completed */ | |
5545 | int operations_completed; | |
5546 | ||
5547 | /* Cumulative offset of all completed operations */ | |
5548 | int64_t offset_completed; | |
5549 | ||
5550 | Qcow2AmendOperation last_operation; | |
5551 | int64_t last_work_size; | |
5552 | } Qcow2AmendHelperCBInfo; | |
5553 | ||
5554 | static void qcow2_amend_helper_cb(BlockDriverState *bs, | |
5555 | int64_t operation_offset, | |
5556 | int64_t operation_work_size, void *opaque) | |
5557 | { | |
5558 | Qcow2AmendHelperCBInfo *info = opaque; | |
5559 | int64_t current_work_size; | |
5560 | int64_t projected_work_size; | |
5561 | ||
5562 | if (info->current_operation != info->last_operation) { | |
5563 | if (info->last_operation != QCOW2_NO_OPERATION) { | |
5564 | info->offset_completed += info->last_work_size; | |
5565 | info->operations_completed++; | |
5566 | } | |
5567 | ||
5568 | info->last_operation = info->current_operation; | |
5569 | } | |
5570 | ||
5571 | assert(info->total_operations > 0); | |
5572 | assert(info->operations_completed < info->total_operations); | |
5573 | ||
5574 | info->last_work_size = operation_work_size; | |
5575 | ||
5576 | current_work_size = info->offset_completed + operation_work_size; | |
5577 | ||
5578 | /* current_work_size is the total work size for (operations_completed + 1) | |
5579 | * operations (which includes this one), so multiply it by the number of | |
5580 | * operations not covered and divide it by the number of operations | |
5581 | * covered to get a projection for the operations not covered */ | |
5582 | projected_work_size = current_work_size * (info->total_operations - | |
5583 | info->operations_completed - 1) | |
5584 | / (info->operations_completed + 1); | |
5585 | ||
5586 | info->original_status_cb(bs, info->offset_completed + operation_offset, | |
5587 | current_work_size + projected_work_size, | |
5588 | info->original_cb_opaque); | |
5589 | } | |
5590 | ||
77485434 | 5591 | static int qcow2_amend_options(BlockDriverState *bs, QemuOpts *opts, |
8b13976d | 5592 | BlockDriverAmendStatusCB *status_cb, |
d1402b50 | 5593 | void *cb_opaque, |
a3579bfa | 5594 | bool force, |
d1402b50 | 5595 | Error **errp) |
9296b3ed | 5596 | { |
ff99129a | 5597 | BDRVQcow2State *s = bs->opaque; |
9296b3ed HR |
5598 | int old_version = s->qcow_version, new_version = old_version; |
5599 | uint64_t new_size = 0; | |
9b890bdc | 5600 | const char *backing_file = NULL, *backing_format = NULL, *data_file = NULL; |
9296b3ed | 5601 | bool lazy_refcounts = s->use_lazy_refcounts; |
6c3944dc | 5602 | bool data_file_raw = data_file_is_raw(bs); |
1bd0e2d1 | 5603 | const char *compat = NULL; |
61ce55fc | 5604 | int refcount_bits = s->refcount_bits; |
9296b3ed | 5605 | int ret; |
1bd0e2d1 | 5606 | QemuOptDesc *desc = opts->list->desc; |
c293a809 | 5607 | Qcow2AmendHelperCBInfo helper_cb_info; |
90766d9d | 5608 | bool encryption_update = false; |
9296b3ed | 5609 | |
1bd0e2d1 CL |
5610 | while (desc && desc->name) { |
5611 | if (!qemu_opt_find(opts, desc->name)) { | |
9296b3ed | 5612 | /* only change explicitly defined options */ |
1bd0e2d1 | 5613 | desc++; |
9296b3ed HR |
5614 | continue; |
5615 | } | |
5616 | ||
8a17b83c HR |
5617 | if (!strcmp(desc->name, BLOCK_OPT_COMPAT_LEVEL)) { |
5618 | compat = qemu_opt_get(opts, BLOCK_OPT_COMPAT_LEVEL); | |
1bd0e2d1 | 5619 | if (!compat) { |
9296b3ed | 5620 | /* preserve default */ |
f7077c98 | 5621 | } else if (!strcmp(compat, "0.10") || !strcmp(compat, "v2")) { |
9296b3ed | 5622 | new_version = 2; |
f7077c98 | 5623 | } else if (!strcmp(compat, "1.1") || !strcmp(compat, "v3")) { |
9296b3ed HR |
5624 | new_version = 3; |
5625 | } else { | |
d1402b50 | 5626 | error_setg(errp, "Unknown compatibility level %s", compat); |
9296b3ed HR |
5627 | return -EINVAL; |
5628 | } | |
8a17b83c HR |
5629 | } else if (!strcmp(desc->name, BLOCK_OPT_SIZE)) { |
5630 | new_size = qemu_opt_get_size(opts, BLOCK_OPT_SIZE, 0); | |
5631 | } else if (!strcmp(desc->name, BLOCK_OPT_BACKING_FILE)) { | |
5632 | backing_file = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE); | |
5633 | } else if (!strcmp(desc->name, BLOCK_OPT_BACKING_FMT)) { | |
5634 | backing_format = qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT); | |
90766d9d ML |
5635 | } else if (g_str_has_prefix(desc->name, "encrypt.")) { |
5636 | if (!s->crypto) { | |
5637 | error_setg(errp, | |
5638 | "Can't amend encryption options - encryption not present"); | |
5639 | return -EINVAL; | |
5640 | } | |
5641 | if (s->crypt_method_header != QCOW_CRYPT_LUKS) { | |
5642 | error_setg(errp, | |
5643 | "Only LUKS encryption options can be amended"); | |
5644 | return -ENOTSUP; | |
5645 | } | |
5646 | encryption_update = true; | |
8a17b83c HR |
5647 | } else if (!strcmp(desc->name, BLOCK_OPT_LAZY_REFCOUNTS)) { |
5648 | lazy_refcounts = qemu_opt_get_bool(opts, BLOCK_OPT_LAZY_REFCOUNTS, | |
1bd0e2d1 | 5649 | lazy_refcounts); |
06d05fa7 | 5650 | } else if (!strcmp(desc->name, BLOCK_OPT_REFCOUNT_BITS)) { |
61ce55fc HR |
5651 | refcount_bits = qemu_opt_get_number(opts, BLOCK_OPT_REFCOUNT_BITS, |
5652 | refcount_bits); | |
5653 | ||
5654 | if (refcount_bits <= 0 || refcount_bits > 64 || | |
5655 | !is_power_of_2(refcount_bits)) | |
5656 | { | |
d1402b50 HR |
5657 | error_setg(errp, "Refcount width must be a power of two and " |
5658 | "may not exceed 64 bits"); | |
61ce55fc HR |
5659 | return -EINVAL; |
5660 | } | |
9b890bdc KW |
5661 | } else if (!strcmp(desc->name, BLOCK_OPT_DATA_FILE)) { |
5662 | data_file = qemu_opt_get(opts, BLOCK_OPT_DATA_FILE); | |
5663 | if (data_file && !has_data_file(bs)) { | |
5664 | error_setg(errp, "data-file can only be set for images that " | |
5665 | "use an external data file"); | |
5666 | return -EINVAL; | |
5667 | } | |
6c3944dc KW |
5668 | } else if (!strcmp(desc->name, BLOCK_OPT_DATA_FILE_RAW)) { |
5669 | data_file_raw = qemu_opt_get_bool(opts, BLOCK_OPT_DATA_FILE_RAW, | |
5670 | data_file_raw); | |
5671 | if (data_file_raw && !data_file_is_raw(bs)) { | |
5672 | error_setg(errp, "data-file-raw cannot be set on existing " | |
5673 | "images"); | |
5674 | return -EINVAL; | |
5675 | } | |
9296b3ed | 5676 | } else { |
164e0f89 | 5677 | /* if this point is reached, this probably means a new option was |
9296b3ed | 5678 | * added without having it covered here */ |
164e0f89 | 5679 | abort(); |
9296b3ed | 5680 | } |
1bd0e2d1 CL |
5681 | |
5682 | desc++; | |
9296b3ed HR |
5683 | } |
5684 | ||
c293a809 HR |
5685 | helper_cb_info = (Qcow2AmendHelperCBInfo){ |
5686 | .original_status_cb = status_cb, | |
5687 | .original_cb_opaque = cb_opaque, | |
722efb0c | 5688 | .total_operations = (new_version != old_version) |
90766d9d ML |
5689 | + (s->refcount_bits != refcount_bits) + |
5690 | (encryption_update == true) | |
c293a809 HR |
5691 | }; |
5692 | ||
1038bbb8 HR |
5693 | /* Upgrade first (some features may require compat=1.1) */ |
5694 | if (new_version > old_version) { | |
722efb0c HR |
5695 | helper_cb_info.current_operation = QCOW2_UPGRADING; |
5696 | ret = qcow2_upgrade(bs, new_version, &qcow2_amend_helper_cb, | |
5697 | &helper_cb_info, errp); | |
1038bbb8 | 5698 | if (ret < 0) { |
1038bbb8 | 5699 | return ret; |
9296b3ed HR |
5700 | } |
5701 | } | |
5702 | ||
90766d9d ML |
5703 | if (encryption_update) { |
5704 | QDict *amend_opts_dict; | |
5705 | QCryptoBlockAmendOptions *amend_opts; | |
5706 | ||
5707 | helper_cb_info.current_operation = QCOW2_UPDATING_ENCRYPTION; | |
5708 | amend_opts_dict = qcow2_extract_crypto_opts(opts, "luks", errp); | |
5709 | if (!amend_opts_dict) { | |
5710 | return -EINVAL; | |
5711 | } | |
5712 | amend_opts = block_crypto_amend_opts_init(amend_opts_dict, errp); | |
5713 | qobject_unref(amend_opts_dict); | |
5714 | if (!amend_opts) { | |
5715 | return -EINVAL; | |
5716 | } | |
5717 | ret = qcrypto_block_amend_options(s->crypto, | |
5718 | qcow2_crypto_hdr_read_func, | |
5719 | qcow2_crypto_hdr_write_func, | |
5720 | bs, | |
5721 | amend_opts, | |
5722 | force, | |
5723 | errp); | |
5724 | qapi_free_QCryptoBlockAmendOptions(amend_opts); | |
5725 | if (ret < 0) { | |
5726 | return ret; | |
5727 | } | |
5728 | } | |
5729 | ||
61ce55fc HR |
5730 | if (s->refcount_bits != refcount_bits) { |
5731 | int refcount_order = ctz32(refcount_bits); | |
61ce55fc HR |
5732 | |
5733 | if (new_version < 3 && refcount_bits != 16) { | |
d1402b50 HR |
5734 | error_setg(errp, "Refcount widths other than 16 bits require " |
5735 | "compatibility level 1.1 or above (use compat=1.1 or " | |
5736 | "greater)"); | |
61ce55fc HR |
5737 | return -EINVAL; |
5738 | } | |
5739 | ||
5740 | helper_cb_info.current_operation = QCOW2_CHANGING_REFCOUNT_ORDER; | |
5741 | ret = qcow2_change_refcount_order(bs, refcount_order, | |
5742 | &qcow2_amend_helper_cb, | |
d1402b50 | 5743 | &helper_cb_info, errp); |
61ce55fc | 5744 | if (ret < 0) { |
61ce55fc HR |
5745 | return ret; |
5746 | } | |
5747 | } | |
5748 | ||
6c3944dc KW |
5749 | /* data-file-raw blocks backing files, so clear it first if requested */ |
5750 | if (data_file_raw) { | |
5751 | s->autoclear_features |= QCOW2_AUTOCLEAR_DATA_FILE_RAW; | |
5752 | } else { | |
5753 | s->autoclear_features &= ~QCOW2_AUTOCLEAR_DATA_FILE_RAW; | |
5754 | } | |
5755 | ||
9b890bdc KW |
5756 | if (data_file) { |
5757 | g_free(s->image_data_file); | |
5758 | s->image_data_file = *data_file ? g_strdup(data_file) : NULL; | |
5759 | } | |
5760 | ||
5761 | ret = qcow2_update_header(bs); | |
5762 | if (ret < 0) { | |
5763 | error_setg_errno(errp, -ret, "Failed to update the image header"); | |
5764 | return ret; | |
5765 | } | |
5766 | ||
9296b3ed | 5767 | if (backing_file || backing_format) { |
bc5ee6da EB |
5768 | if (g_strcmp0(backing_file, s->image_backing_file) || |
5769 | g_strcmp0(backing_format, s->image_backing_format)) { | |
5a385bf5 EB |
5770 | error_setg(errp, "Cannot amend the backing file"); |
5771 | error_append_hint(errp, | |
5772 | "You can use 'qemu-img rebase' instead.\n"); | |
5773 | return -EINVAL; | |
9296b3ed HR |
5774 | } |
5775 | } | |
5776 | ||
5777 | if (s->use_lazy_refcounts != lazy_refcounts) { | |
5778 | if (lazy_refcounts) { | |
1038bbb8 | 5779 | if (new_version < 3) { |
d1402b50 HR |
5780 | error_setg(errp, "Lazy refcounts only supported with " |
5781 | "compatibility level 1.1 and above (use compat=1.1 " | |
5782 | "or greater)"); | |
9296b3ed HR |
5783 | return -EINVAL; |
5784 | } | |
5785 | s->compatible_features |= QCOW2_COMPAT_LAZY_REFCOUNTS; | |
5786 | ret = qcow2_update_header(bs); | |
5787 | if (ret < 0) { | |
5788 | s->compatible_features &= ~QCOW2_COMPAT_LAZY_REFCOUNTS; | |
d1402b50 | 5789 | error_setg_errno(errp, -ret, "Failed to update the image header"); |
9296b3ed HR |
5790 | return ret; |
5791 | } | |
5792 | s->use_lazy_refcounts = true; | |
5793 | } else { | |
5794 | /* make image clean first */ | |
5795 | ret = qcow2_mark_clean(bs); | |
5796 | if (ret < 0) { | |
d1402b50 | 5797 | error_setg_errno(errp, -ret, "Failed to make the image clean"); |
9296b3ed HR |
5798 | return ret; |
5799 | } | |
5800 | /* now disallow lazy refcounts */ | |
5801 | s->compatible_features &= ~QCOW2_COMPAT_LAZY_REFCOUNTS; | |
5802 | ret = qcow2_update_header(bs); | |
5803 | if (ret < 0) { | |
5804 | s->compatible_features |= QCOW2_COMPAT_LAZY_REFCOUNTS; | |
d1402b50 | 5805 | error_setg_errno(errp, -ret, "Failed to update the image header"); |
9296b3ed HR |
5806 | return ret; |
5807 | } | |
5808 | s->use_lazy_refcounts = false; | |
5809 | } | |
5810 | } | |
5811 | ||
5812 | if (new_size) { | |
a3aeeab5 EB |
5813 | BlockBackend *blk = blk_new_with_bs(bs, BLK_PERM_RESIZE, BLK_PERM_ALL, |
5814 | errp); | |
5815 | if (!blk) { | |
5816 | return -EPERM; | |
d7086422 KW |
5817 | } |
5818 | ||
e8d04f92 HR |
5819 | /* |
5820 | * Amending image options should ensure that the image has | |
5821 | * exactly the given new values, so pass exact=true here. | |
5822 | */ | |
8c6242b6 | 5823 | ret = blk_truncate(blk, new_size, true, PREALLOC_MODE_OFF, 0, errp); |
70b27f36 | 5824 | blk_unref(blk); |
9296b3ed HR |
5825 | if (ret < 0) { |
5826 | return ret; | |
5827 | } | |
5828 | } | |
5829 | ||
1038bbb8 HR |
5830 | /* Downgrade last (so unsupported features can be removed before) */ |
5831 | if (new_version < old_version) { | |
c293a809 HR |
5832 | helper_cb_info.current_operation = QCOW2_DOWNGRADING; |
5833 | ret = qcow2_downgrade(bs, new_version, &qcow2_amend_helper_cb, | |
d1402b50 | 5834 | &helper_cb_info, errp); |
1038bbb8 HR |
5835 | if (ret < 0) { |
5836 | return ret; | |
5837 | } | |
5838 | } | |
5839 | ||
9296b3ed HR |
5840 | return 0; |
5841 | } | |
5842 | ||
8ea1613d ML |
5843 | static int coroutine_fn qcow2_co_amend(BlockDriverState *bs, |
5844 | BlockdevAmendOptions *opts, | |
5845 | bool force, | |
5846 | Error **errp) | |
5847 | { | |
5848 | BlockdevAmendOptionsQcow2 *qopts = &opts->u.qcow2; | |
5849 | BDRVQcow2State *s = bs->opaque; | |
5850 | int ret = 0; | |
5851 | ||
54fde4ff | 5852 | if (qopts->encrypt) { |
8ea1613d ML |
5853 | if (!s->crypto) { |
5854 | error_setg(errp, "image is not encrypted, can't amend"); | |
5855 | return -EOPNOTSUPP; | |
5856 | } | |
5857 | ||
5858 | if (qopts->encrypt->format != Q_CRYPTO_BLOCK_FORMAT_LUKS) { | |
5859 | error_setg(errp, | |
5860 | "Amend can't be used to change the qcow2 encryption format"); | |
5861 | return -EOPNOTSUPP; | |
5862 | } | |
5863 | ||
5864 | if (s->crypt_method_header != QCOW_CRYPT_LUKS) { | |
5865 | error_setg(errp, | |
5866 | "Only LUKS encryption options can be amended for qcow2 with blockdev-amend"); | |
5867 | return -EOPNOTSUPP; | |
5868 | } | |
5869 | ||
5870 | ret = qcrypto_block_amend_options(s->crypto, | |
5871 | qcow2_crypto_hdr_read_func, | |
5872 | qcow2_crypto_hdr_write_func, | |
5873 | bs, | |
5874 | qopts->encrypt, | |
5875 | force, | |
5876 | errp); | |
5877 | } | |
5878 | return ret; | |
5879 | } | |
5880 | ||
85186ebd HR |
5881 | /* |
5882 | * If offset or size are negative, respectively, they will not be included in | |
5883 | * the BLOCK_IMAGE_CORRUPTED event emitted. | |
5884 | * fatal will be ignored for read-only BDS; corruptions found there will always | |
5885 | * be considered non-fatal. | |
5886 | */ | |
5887 | void qcow2_signal_corruption(BlockDriverState *bs, bool fatal, int64_t offset, | |
5888 | int64_t size, const char *message_format, ...) | |
5889 | { | |
ff99129a | 5890 | BDRVQcow2State *s = bs->opaque; |
dc881b44 | 5891 | const char *node_name; |
85186ebd HR |
5892 | char *message; |
5893 | va_list ap; | |
5894 | ||
ddf3b47e | 5895 | fatal = fatal && bdrv_is_writable(bs); |
85186ebd HR |
5896 | |
5897 | if (s->signaled_corruption && | |
5898 | (!fatal || (s->incompatible_features & QCOW2_INCOMPAT_CORRUPT))) | |
5899 | { | |
5900 | return; | |
5901 | } | |
5902 | ||
5903 | va_start(ap, message_format); | |
5904 | message = g_strdup_vprintf(message_format, ap); | |
5905 | va_end(ap); | |
5906 | ||
5907 | if (fatal) { | |
5908 | fprintf(stderr, "qcow2: Marking image as corrupt: %s; further " | |
5909 | "corruption events will be suppressed\n", message); | |
5910 | } else { | |
5911 | fprintf(stderr, "qcow2: Image is corrupt: %s; further non-fatal " | |
5912 | "corruption events will be suppressed\n", message); | |
5913 | } | |
5914 | ||
dc881b44 AG |
5915 | node_name = bdrv_get_node_name(bs); |
5916 | qapi_event_send_block_image_corrupted(bdrv_get_device_name(bs), | |
54fde4ff | 5917 | *node_name ? node_name : NULL, |
dc881b44 AG |
5918 | message, offset >= 0, offset, |
5919 | size >= 0, size, | |
3ab72385 | 5920 | fatal); |
85186ebd HR |
5921 | g_free(message); |
5922 | ||
5923 | if (fatal) { | |
5924 | qcow2_mark_corrupt(bs); | |
5925 | bs->drv = NULL; /* make BDS unusable */ | |
5926 | } | |
5927 | ||
5928 | s->signaled_corruption = true; | |
5929 | } | |
5930 | ||
df373fb0 ML |
5931 | #define QCOW_COMMON_OPTIONS \ |
5932 | { \ | |
5933 | .name = BLOCK_OPT_SIZE, \ | |
5934 | .type = QEMU_OPT_SIZE, \ | |
5935 | .help = "Virtual disk size" \ | |
5936 | }, \ | |
5937 | { \ | |
5938 | .name = BLOCK_OPT_COMPAT_LEVEL, \ | |
5939 | .type = QEMU_OPT_STRING, \ | |
5940 | .help = "Compatibility level (v2 [0.10] or v3 [1.1])" \ | |
5941 | }, \ | |
5942 | { \ | |
5943 | .name = BLOCK_OPT_BACKING_FILE, \ | |
5944 | .type = QEMU_OPT_STRING, \ | |
5945 | .help = "File name of a base image" \ | |
5946 | }, \ | |
5947 | { \ | |
5948 | .name = BLOCK_OPT_BACKING_FMT, \ | |
5949 | .type = QEMU_OPT_STRING, \ | |
5950 | .help = "Image format of the base image" \ | |
5951 | }, \ | |
5952 | { \ | |
5953 | .name = BLOCK_OPT_DATA_FILE, \ | |
5954 | .type = QEMU_OPT_STRING, \ | |
5955 | .help = "File name of an external data file" \ | |
5956 | }, \ | |
5957 | { \ | |
5958 | .name = BLOCK_OPT_DATA_FILE_RAW, \ | |
5959 | .type = QEMU_OPT_BOOL, \ | |
5960 | .help = "The external data file must stay valid " \ | |
5961 | "as a raw image" \ | |
5962 | }, \ | |
df373fb0 ML |
5963 | { \ |
5964 | .name = BLOCK_OPT_LAZY_REFCOUNTS, \ | |
5965 | .type = QEMU_OPT_BOOL, \ | |
5966 | .help = "Postpone refcount updates", \ | |
5967 | .def_value_str = "off" \ | |
5968 | }, \ | |
5969 | { \ | |
5970 | .name = BLOCK_OPT_REFCOUNT_BITS, \ | |
5971 | .type = QEMU_OPT_NUMBER, \ | |
5972 | .help = "Width of a reference count entry in bits", \ | |
5973 | .def_value_str = "16" \ | |
df373fb0 ML |
5974 | } |
5975 | ||
1bd0e2d1 CL |
5976 | static QemuOptsList qcow2_create_opts = { |
5977 | .name = "qcow2-create-opts", | |
5978 | .head = QTAILQ_HEAD_INITIALIZER(qcow2_create_opts.head), | |
5979 | .desc = { | |
0b6786a9 ML |
5980 | { \ |
5981 | .name = BLOCK_OPT_ENCRYPT, \ | |
5982 | .type = QEMU_OPT_BOOL, \ | |
5983 | .help = "Encrypt the image with format 'aes'. (Deprecated " \ | |
5984 | "in favor of " BLOCK_OPT_ENCRYPT_FORMAT "=aes)", \ | |
5985 | }, \ | |
5986 | { \ | |
5987 | .name = BLOCK_OPT_ENCRYPT_FORMAT, \ | |
5988 | .type = QEMU_OPT_STRING, \ | |
5989 | .help = "Encrypt the image, format choices: 'aes', 'luks'", \ | |
5990 | }, \ | |
5991 | BLOCK_CRYPTO_OPT_DEF_KEY_SECRET("encrypt.", \ | |
5992 | "ID of secret providing qcow AES key or LUKS passphrase"), \ | |
5993 | BLOCK_CRYPTO_OPT_DEF_LUKS_CIPHER_ALG("encrypt."), \ | |
5994 | BLOCK_CRYPTO_OPT_DEF_LUKS_CIPHER_MODE("encrypt."), \ | |
5995 | BLOCK_CRYPTO_OPT_DEF_LUKS_IVGEN_ALG("encrypt."), \ | |
5996 | BLOCK_CRYPTO_OPT_DEF_LUKS_IVGEN_HASH_ALG("encrypt."), \ | |
5997 | BLOCK_CRYPTO_OPT_DEF_LUKS_HASH_ALG("encrypt."), \ | |
5998 | BLOCK_CRYPTO_OPT_DEF_LUKS_ITER_TIME("encrypt."), \ | |
5999 | { \ | |
6000 | .name = BLOCK_OPT_CLUSTER_SIZE, \ | |
6001 | .type = QEMU_OPT_SIZE, \ | |
6002 | .help = "qcow2 cluster size", \ | |
6003 | .def_value_str = stringify(DEFAULT_CLUSTER_SIZE) \ | |
6004 | }, \ | |
7be20252 AG |
6005 | { \ |
6006 | .name = BLOCK_OPT_EXTL2, \ | |
6007 | .type = QEMU_OPT_BOOL, \ | |
6008 | .help = "Extended L2 tables", \ | |
6009 | .def_value_str = "off" \ | |
6010 | }, \ | |
0b6786a9 ML |
6011 | { \ |
6012 | .name = BLOCK_OPT_PREALLOC, \ | |
6013 | .type = QEMU_OPT_STRING, \ | |
6014 | .help = "Preallocation mode (allowed values: off, " \ | |
6015 | "metadata, falloc, full)" \ | |
6016 | }, \ | |
6017 | { \ | |
6018 | .name = BLOCK_OPT_COMPRESSION_TYPE, \ | |
6019 | .type = QEMU_OPT_STRING, \ | |
6020 | .help = "Compression method used for image cluster " \ | |
6021 | "compression", \ | |
6022 | .def_value_str = "zlib" \ | |
6023 | }, | |
df373fb0 ML |
6024 | QCOW_COMMON_OPTIONS, |
6025 | { /* end of list */ } | |
6026 | } | |
6027 | }; | |
6028 | ||
6029 | static QemuOptsList qcow2_amend_opts = { | |
6030 | .name = "qcow2-amend-opts", | |
6031 | .head = QTAILQ_HEAD_INITIALIZER(qcow2_amend_opts.head), | |
6032 | .desc = { | |
90766d9d ML |
6033 | BLOCK_CRYPTO_OPT_DEF_LUKS_STATE("encrypt."), |
6034 | BLOCK_CRYPTO_OPT_DEF_LUKS_KEYSLOT("encrypt."), | |
6035 | BLOCK_CRYPTO_OPT_DEF_LUKS_OLD_SECRET("encrypt."), | |
6036 | BLOCK_CRYPTO_OPT_DEF_LUKS_NEW_SECRET("encrypt."), | |
6037 | BLOCK_CRYPTO_OPT_DEF_LUKS_ITER_TIME("encrypt."), | |
df373fb0 | 6038 | QCOW_COMMON_OPTIONS, |
1bd0e2d1 CL |
6039 | { /* end of list */ } |
6040 | } | |
20d97356 BS |
6041 | }; |
6042 | ||
2654267c HR |
6043 | static const char *const qcow2_strong_runtime_opts[] = { |
6044 | "encrypt." BLOCK_CRYPTO_OPT_QCOW_KEY_SECRET, | |
6045 | ||
6046 | NULL | |
6047 | }; | |
6048 | ||
5f535a94 | 6049 | BlockDriver bdrv_qcow2 = { |
7c80ab3f | 6050 | .format_name = "qcow2", |
ff99129a | 6051 | .instance_size = sizeof(BDRVQcow2State), |
7c80ab3f JS |
6052 | .bdrv_probe = qcow2_probe, |
6053 | .bdrv_open = qcow2_open, | |
6054 | .bdrv_close = qcow2_close, | |
21d82ac9 | 6055 | .bdrv_reopen_prepare = qcow2_reopen_prepare, |
5b0959a7 | 6056 | .bdrv_reopen_commit = qcow2_reopen_commit, |
65eb7c85 | 6057 | .bdrv_reopen_commit_post = qcow2_reopen_commit_post, |
5b0959a7 | 6058 | .bdrv_reopen_abort = qcow2_reopen_abort, |
5365f44d | 6059 | .bdrv_join_options = qcow2_join_options, |
69dca43d | 6060 | .bdrv_child_perm = bdrv_default_perms, |
efc75e2a | 6061 | .bdrv_co_create_opts = qcow2_co_create_opts, |
b0292b85 | 6062 | .bdrv_co_create = qcow2_co_create, |
38841dcd | 6063 | .bdrv_has_zero_init = qcow2_has_zero_init, |
a320fb04 | 6064 | .bdrv_co_block_status = qcow2_co_block_status, |
7c80ab3f | 6065 | |
df893d25 | 6066 | .bdrv_co_preadv_part = qcow2_co_preadv_part, |
5396234b | 6067 | .bdrv_co_pwritev_part = qcow2_co_pwritev_part, |
eb489bb1 | 6068 | .bdrv_co_flush_to_os = qcow2_co_flush_to_os, |
419b19d9 | 6069 | |
5544b59f | 6070 | .bdrv_co_pwrite_zeroes = qcow2_co_pwrite_zeroes, |
82e8a788 | 6071 | .bdrv_co_pdiscard = qcow2_co_pdiscard, |
fd9fcd37 FZ |
6072 | .bdrv_co_copy_range_from = qcow2_co_copy_range_from, |
6073 | .bdrv_co_copy_range_to = qcow2_co_copy_range_to, | |
061ca8a3 | 6074 | .bdrv_co_truncate = qcow2_co_truncate, |
5396234b | 6075 | .bdrv_co_pwritev_compressed_part = qcow2_co_pwritev_compressed_part, |
491d27e2 | 6076 | .bdrv_make_empty = qcow2_make_empty, |
20d97356 BS |
6077 | |
6078 | .bdrv_snapshot_create = qcow2_snapshot_create, | |
6079 | .bdrv_snapshot_goto = qcow2_snapshot_goto, | |
6080 | .bdrv_snapshot_delete = qcow2_snapshot_delete, | |
6081 | .bdrv_snapshot_list = qcow2_snapshot_list, | |
1bd0e2d1 | 6082 | .bdrv_snapshot_load_tmp = qcow2_snapshot_load_tmp, |
c501c352 | 6083 | .bdrv_measure = qcow2_measure, |
3d47eb0a | 6084 | .bdrv_co_get_info = qcow2_co_get_info, |
37764dfb | 6085 | .bdrv_get_specific_info = qcow2_get_specific_info, |
20d97356 | 6086 | |
ca5e2ad9 EGE |
6087 | .bdrv_co_save_vmstate = qcow2_co_save_vmstate, |
6088 | .bdrv_co_load_vmstate = qcow2_co_load_vmstate, | |
20d97356 | 6089 | |
d67066d8 | 6090 | .is_format = true, |
8ee79e70 | 6091 | .supports_backing = true, |
20d97356 BS |
6092 | .bdrv_change_backing_file = qcow2_change_backing_file, |
6093 | ||
d34682cd | 6094 | .bdrv_refresh_limits = qcow2_refresh_limits, |
2b148f39 | 6095 | .bdrv_co_invalidate_cache = qcow2_co_invalidate_cache, |
ec6d8912 | 6096 | .bdrv_inactivate = qcow2_inactivate, |
06d9260f | 6097 | |
1bd0e2d1 | 6098 | .create_opts = &qcow2_create_opts, |
df373fb0 | 6099 | .amend_opts = &qcow2_amend_opts, |
2654267c | 6100 | .strong_runtime_opts = qcow2_strong_runtime_opts, |
8a2ce0bc | 6101 | .mutable_opts = mutable_opts, |
2fd61638 | 6102 | .bdrv_co_check = qcow2_co_check, |
c282e1fd | 6103 | .bdrv_amend_options = qcow2_amend_options, |
8ea1613d | 6104 | .bdrv_co_amend = qcow2_co_amend, |
279621c0 AG |
6105 | |
6106 | .bdrv_detach_aio_context = qcow2_detach_aio_context, | |
6107 | .bdrv_attach_aio_context = qcow2_attach_aio_context, | |
1b6b0562 | 6108 | |
ef893b5c EB |
6109 | .bdrv_supports_persistent_dirty_bitmap = |
6110 | qcow2_supports_persistent_dirty_bitmap, | |
d2c3080e VSO |
6111 | .bdrv_co_can_store_new_dirty_bitmap = qcow2_co_can_store_new_dirty_bitmap, |
6112 | .bdrv_co_remove_persistent_dirty_bitmap = | |
6113 | qcow2_co_remove_persistent_dirty_bitmap, | |
20d97356 BS |
6114 | }; |
6115 | ||
5efa9d5a AL |
6116 | static void bdrv_qcow2_init(void) |
6117 | { | |
6118 | bdrv_register(&bdrv_qcow2); | |
6119 | } | |
6120 | ||
6121 | block_init(bdrv_qcow2_init); |