]>
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 | */ | |
faf07963 | 24 | #include "qemu-common.h" |
737e150e | 25 | #include "block/block_int.h" |
1de7afc9 | 26 | #include "qemu/module.h" |
585f8587 | 27 | #include <zlib.h> |
753d9b82 | 28 | #include "qemu/aes.h" |
f7d0fe02 | 29 | #include "block/qcow2.h" |
1de7afc9 | 30 | #include "qemu/error-report.h" |
7b1b5d19 | 31 | #include "qapi/qmp/qerror.h" |
acdfb480 | 32 | #include "qapi/qmp/qbool.h" |
3cce16f4 | 33 | #include "trace.h" |
585f8587 FB |
34 | |
35 | /* | |
36 | Differences with QCOW: | |
37 | ||
38 | - Support for multiple incremental snapshots. | |
39 | - Memory management by reference counts. | |
40 | - Clusters which have a reference count of one have the bit | |
41 | QCOW_OFLAG_COPIED to optimize write performance. | |
5fafdf24 | 42 | - Size of compressed clusters is stored in sectors to reduce bit usage |
585f8587 FB |
43 | in the cluster offsets. |
44 | - Support for storing additional data (such as the VM state) in the | |
3b46e624 | 45 | snapshots. |
585f8587 FB |
46 | - If a backing store is used, the cluster size is not constrained |
47 | (could be backported to QCOW). | |
48 | - L2 tables have always a size of one cluster. | |
49 | */ | |
50 | ||
9b80ddf3 AL |
51 | |
52 | typedef struct { | |
53 | uint32_t magic; | |
54 | uint32_t len; | |
c4217f64 | 55 | } QEMU_PACKED QCowExtension; |
21d82ac9 | 56 | |
7c80ab3f JS |
57 | #define QCOW2_EXT_MAGIC_END 0 |
58 | #define QCOW2_EXT_MAGIC_BACKING_FORMAT 0xE2792ACA | |
cfcc4c62 | 59 | #define QCOW2_EXT_MAGIC_FEATURE_TABLE 0x6803f857 |
9b80ddf3 | 60 | |
7c80ab3f | 61 | static int qcow2_probe(const uint8_t *buf, int buf_size, const char *filename) |
585f8587 FB |
62 | { |
63 | const QCowHeader *cow_header = (const void *)buf; | |
3b46e624 | 64 | |
585f8587 FB |
65 | if (buf_size >= sizeof(QCowHeader) && |
66 | be32_to_cpu(cow_header->magic) == QCOW_MAGIC && | |
6744cbab | 67 | be32_to_cpu(cow_header->version) >= 2) |
585f8587 FB |
68 | return 100; |
69 | else | |
70 | return 0; | |
71 | } | |
72 | ||
9b80ddf3 AL |
73 | |
74 | /* | |
75 | * read qcow2 extension and fill bs | |
76 | * start reading from start_offset | |
77 | * finish reading upon magic of value 0 or when end_offset reached | |
78 | * unknown magic is skipped (future extension this version knows nothing about) | |
79 | * return 0 upon success, non-0 otherwise | |
80 | */ | |
7c80ab3f | 81 | static int qcow2_read_extensions(BlockDriverState *bs, uint64_t start_offset, |
3ef6c40a MR |
82 | uint64_t end_offset, void **p_feature_table, |
83 | Error **errp) | |
9b80ddf3 | 84 | { |
75bab85c | 85 | BDRVQcowState *s = bs->opaque; |
9b80ddf3 AL |
86 | QCowExtension ext; |
87 | uint64_t offset; | |
75bab85c | 88 | int ret; |
9b80ddf3 AL |
89 | |
90 | #ifdef DEBUG_EXT | |
7c80ab3f | 91 | printf("qcow2_read_extensions: start=%ld end=%ld\n", start_offset, end_offset); |
9b80ddf3 AL |
92 | #endif |
93 | offset = start_offset; | |
94 | while (offset < end_offset) { | |
95 | ||
96 | #ifdef DEBUG_EXT | |
97 | /* Sanity check */ | |
98 | if (offset > s->cluster_size) | |
7c80ab3f | 99 | printf("qcow2_read_extension: suspicious offset %lu\n", offset); |
9b80ddf3 | 100 | |
9b2260cb | 101 | printf("attempting to read extended header in offset %lu\n", offset); |
9b80ddf3 AL |
102 | #endif |
103 | ||
3ef6c40a MR |
104 | ret = bdrv_pread(bs->file, offset, &ext, sizeof(ext)); |
105 | if (ret < 0) { | |
106 | error_setg_errno(errp, -ret, "qcow2_read_extension: ERROR: " | |
107 | "pread fail from offset %" PRIu64, offset); | |
9b80ddf3 AL |
108 | return 1; |
109 | } | |
110 | be32_to_cpus(&ext.magic); | |
111 | be32_to_cpus(&ext.len); | |
112 | offset += sizeof(ext); | |
113 | #ifdef DEBUG_EXT | |
114 | printf("ext.magic = 0x%x\n", ext.magic); | |
115 | #endif | |
64ca6aee | 116 | if (ext.len > end_offset - offset) { |
3ef6c40a | 117 | error_setg(errp, "Header extension too large"); |
64ca6aee KW |
118 | return -EINVAL; |
119 | } | |
120 | ||
9b80ddf3 | 121 | switch (ext.magic) { |
7c80ab3f | 122 | case QCOW2_EXT_MAGIC_END: |
9b80ddf3 | 123 | return 0; |
f965509c | 124 | |
7c80ab3f | 125 | case QCOW2_EXT_MAGIC_BACKING_FORMAT: |
f965509c | 126 | if (ext.len >= sizeof(bs->backing_format)) { |
3ef6c40a MR |
127 | error_setg(errp, "ERROR: ext_backing_format: len=%u too large" |
128 | " (>=%zu)", ext.len, sizeof(bs->backing_format)); | |
f965509c AL |
129 | return 2; |
130 | } | |
3ef6c40a MR |
131 | ret = bdrv_pread(bs->file, offset, bs->backing_format, ext.len); |
132 | if (ret < 0) { | |
133 | error_setg_errno(errp, -ret, "ERROR: ext_backing_format: " | |
134 | "Could not read format name"); | |
f965509c | 135 | return 3; |
3ef6c40a | 136 | } |
f965509c AL |
137 | bs->backing_format[ext.len] = '\0'; |
138 | #ifdef DEBUG_EXT | |
139 | printf("Qcow2: Got format extension %s\n", bs->backing_format); | |
140 | #endif | |
f965509c AL |
141 | break; |
142 | ||
cfcc4c62 KW |
143 | case QCOW2_EXT_MAGIC_FEATURE_TABLE: |
144 | if (p_feature_table != NULL) { | |
145 | void* feature_table = g_malloc0(ext.len + 2 * sizeof(Qcow2Feature)); | |
146 | ret = bdrv_pread(bs->file, offset , feature_table, ext.len); | |
147 | if (ret < 0) { | |
3ef6c40a MR |
148 | error_setg_errno(errp, -ret, "ERROR: ext_feature_table: " |
149 | "Could not read table"); | |
cfcc4c62 KW |
150 | return ret; |
151 | } | |
152 | ||
153 | *p_feature_table = feature_table; | |
154 | } | |
155 | break; | |
156 | ||
9b80ddf3 | 157 | default: |
75bab85c KW |
158 | /* unknown magic - save it in case we need to rewrite the header */ |
159 | { | |
160 | Qcow2UnknownHeaderExtension *uext; | |
161 | ||
162 | uext = g_malloc0(sizeof(*uext) + ext.len); | |
163 | uext->magic = ext.magic; | |
164 | uext->len = ext.len; | |
165 | QLIST_INSERT_HEAD(&s->unknown_header_ext, uext, next); | |
166 | ||
167 | ret = bdrv_pread(bs->file, offset , uext->data, uext->len); | |
168 | if (ret < 0) { | |
3ef6c40a MR |
169 | error_setg_errno(errp, -ret, "ERROR: unknown extension: " |
170 | "Could not read data"); | |
75bab85c KW |
171 | return ret; |
172 | } | |
75bab85c | 173 | } |
9b80ddf3 AL |
174 | break; |
175 | } | |
fd29b4bb KW |
176 | |
177 | offset += ((ext.len + 7) & ~7); | |
9b80ddf3 AL |
178 | } |
179 | ||
180 | return 0; | |
181 | } | |
182 | ||
75bab85c KW |
183 | static void cleanup_unknown_header_ext(BlockDriverState *bs) |
184 | { | |
185 | BDRVQcowState *s = bs->opaque; | |
186 | Qcow2UnknownHeaderExtension *uext, *next; | |
187 | ||
188 | QLIST_FOREACH_SAFE(uext, &s->unknown_header_ext, next, next) { | |
189 | QLIST_REMOVE(uext, next); | |
190 | g_free(uext); | |
191 | } | |
192 | } | |
9b80ddf3 | 193 | |
3ef6c40a MR |
194 | static void GCC_FMT_ATTR(3, 4) report_unsupported(BlockDriverState *bs, |
195 | Error **errp, const char *fmt, ...) | |
6744cbab KW |
196 | { |
197 | char msg[64]; | |
198 | va_list ap; | |
199 | ||
200 | va_start(ap, fmt); | |
201 | vsnprintf(msg, sizeof(msg), fmt, ap); | |
202 | va_end(ap); | |
203 | ||
3ef6c40a MR |
204 | error_set(errp, QERR_UNKNOWN_BLOCK_FORMAT_FEATURE, bs->device_name, "qcow2", |
205 | msg); | |
6744cbab KW |
206 | } |
207 | ||
cfcc4c62 | 208 | static void report_unsupported_feature(BlockDriverState *bs, |
3ef6c40a | 209 | Error **errp, Qcow2Feature *table, uint64_t mask) |
cfcc4c62 KW |
210 | { |
211 | while (table && table->name[0] != '\0') { | |
212 | if (table->type == QCOW2_FEAT_TYPE_INCOMPATIBLE) { | |
213 | if (mask & (1 << table->bit)) { | |
3ef6c40a | 214 | report_unsupported(bs, errp, "%.46s", table->name); |
cfcc4c62 KW |
215 | mask &= ~(1 << table->bit); |
216 | } | |
217 | } | |
218 | table++; | |
219 | } | |
220 | ||
221 | if (mask) { | |
3ef6c40a MR |
222 | report_unsupported(bs, errp, "Unknown incompatible feature: %" PRIx64, |
223 | mask); | |
cfcc4c62 KW |
224 | } |
225 | } | |
226 | ||
bfe8043e SH |
227 | /* |
228 | * Sets the dirty bit and flushes afterwards if necessary. | |
229 | * | |
230 | * The incompatible_features bit is only set if the image file header was | |
231 | * updated successfully. Therefore it is not required to check the return | |
232 | * value of this function. | |
233 | */ | |
280d3735 | 234 | int qcow2_mark_dirty(BlockDriverState *bs) |
bfe8043e SH |
235 | { |
236 | BDRVQcowState *s = bs->opaque; | |
237 | uint64_t val; | |
238 | int ret; | |
239 | ||
240 | assert(s->qcow_version >= 3); | |
241 | ||
242 | if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) { | |
243 | return 0; /* already dirty */ | |
244 | } | |
245 | ||
246 | val = cpu_to_be64(s->incompatible_features | QCOW2_INCOMPAT_DIRTY); | |
247 | ret = bdrv_pwrite(bs->file, offsetof(QCowHeader, incompatible_features), | |
248 | &val, sizeof(val)); | |
249 | if (ret < 0) { | |
250 | return ret; | |
251 | } | |
252 | ret = bdrv_flush(bs->file); | |
253 | if (ret < 0) { | |
254 | return ret; | |
255 | } | |
256 | ||
257 | /* Only treat image as dirty if the header was updated successfully */ | |
258 | s->incompatible_features |= QCOW2_INCOMPAT_DIRTY; | |
259 | return 0; | |
260 | } | |
261 | ||
c61d0004 SH |
262 | /* |
263 | * Clears the dirty bit and flushes before if necessary. Only call this | |
264 | * function when there are no pending requests, it does not guard against | |
265 | * concurrent requests dirtying the image. | |
266 | */ | |
267 | static int qcow2_mark_clean(BlockDriverState *bs) | |
268 | { | |
269 | BDRVQcowState *s = bs->opaque; | |
270 | ||
271 | if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) { | |
272 | int ret = bdrv_flush(bs); | |
273 | if (ret < 0) { | |
274 | return ret; | |
275 | } | |
276 | ||
277 | s->incompatible_features &= ~QCOW2_INCOMPAT_DIRTY; | |
278 | return qcow2_update_header(bs); | |
279 | } | |
280 | return 0; | |
281 | } | |
282 | ||
69c98726 MR |
283 | /* |
284 | * Marks the image as corrupt. | |
285 | */ | |
286 | int qcow2_mark_corrupt(BlockDriverState *bs) | |
287 | { | |
288 | BDRVQcowState *s = bs->opaque; | |
289 | ||
290 | s->incompatible_features |= QCOW2_INCOMPAT_CORRUPT; | |
291 | return qcow2_update_header(bs); | |
292 | } | |
293 | ||
294 | /* | |
295 | * Marks the image as consistent, i.e., unsets the corrupt bit, and flushes | |
296 | * before if necessary. | |
297 | */ | |
298 | int qcow2_mark_consistent(BlockDriverState *bs) | |
299 | { | |
300 | BDRVQcowState *s = bs->opaque; | |
301 | ||
302 | if (s->incompatible_features & QCOW2_INCOMPAT_CORRUPT) { | |
303 | int ret = bdrv_flush(bs); | |
304 | if (ret < 0) { | |
305 | return ret; | |
306 | } | |
307 | ||
308 | s->incompatible_features &= ~QCOW2_INCOMPAT_CORRUPT; | |
309 | return qcow2_update_header(bs); | |
310 | } | |
311 | return 0; | |
312 | } | |
313 | ||
acbe5982 SH |
314 | static int qcow2_check(BlockDriverState *bs, BdrvCheckResult *result, |
315 | BdrvCheckMode fix) | |
316 | { | |
317 | int ret = qcow2_check_refcounts(bs, result, fix); | |
318 | if (ret < 0) { | |
319 | return ret; | |
320 | } | |
321 | ||
322 | if (fix && result->check_errors == 0 && result->corruptions == 0) { | |
24530f3e MR |
323 | ret = qcow2_mark_clean(bs); |
324 | if (ret < 0) { | |
325 | return ret; | |
326 | } | |
327 | return qcow2_mark_consistent(bs); | |
acbe5982 SH |
328 | } |
329 | return ret; | |
330 | } | |
331 | ||
74c4510a KW |
332 | static QemuOptsList qcow2_runtime_opts = { |
333 | .name = "qcow2", | |
334 | .head = QTAILQ_HEAD_INITIALIZER(qcow2_runtime_opts.head), | |
335 | .desc = { | |
336 | { | |
64aa99d3 | 337 | .name = QCOW2_OPT_LAZY_REFCOUNTS, |
74c4510a KW |
338 | .type = QEMU_OPT_BOOL, |
339 | .help = "Postpone refcount updates", | |
340 | }, | |
67af674e KW |
341 | { |
342 | .name = QCOW2_OPT_DISCARD_REQUEST, | |
343 | .type = QEMU_OPT_BOOL, | |
344 | .help = "Pass guest discard requests to the layer below", | |
345 | }, | |
346 | { | |
347 | .name = QCOW2_OPT_DISCARD_SNAPSHOT, | |
348 | .type = QEMU_OPT_BOOL, | |
349 | .help = "Generate discard requests when snapshot related space " | |
350 | "is freed", | |
351 | }, | |
352 | { | |
353 | .name = QCOW2_OPT_DISCARD_OTHER, | |
354 | .type = QEMU_OPT_BOOL, | |
355 | .help = "Generate discard requests when other clusters are freed", | |
356 | }, | |
74c4510a KW |
357 | { /* end of list */ } |
358 | }, | |
359 | }; | |
360 | ||
015a1036 MR |
361 | static int qcow2_open(BlockDriverState *bs, QDict *options, int flags, |
362 | Error **errp) | |
585f8587 FB |
363 | { |
364 | BDRVQcowState *s = bs->opaque; | |
6d85a57e | 365 | int len, i, ret = 0; |
585f8587 | 366 | QCowHeader header; |
74c4510a KW |
367 | QemuOpts *opts; |
368 | Error *local_err = NULL; | |
9b80ddf3 | 369 | uint64_t ext_end; |
2cf7cfa1 | 370 | uint64_t l1_vm_state_index; |
585f8587 | 371 | |
6d85a57e JS |
372 | ret = bdrv_pread(bs->file, 0, &header, sizeof(header)); |
373 | if (ret < 0) { | |
3ef6c40a | 374 | error_setg_errno(errp, -ret, "Could not read qcow2 header"); |
585f8587 | 375 | goto fail; |
6d85a57e | 376 | } |
585f8587 FB |
377 | be32_to_cpus(&header.magic); |
378 | be32_to_cpus(&header.version); | |
379 | be64_to_cpus(&header.backing_file_offset); | |
380 | be32_to_cpus(&header.backing_file_size); | |
381 | be64_to_cpus(&header.size); | |
382 | be32_to_cpus(&header.cluster_bits); | |
383 | be32_to_cpus(&header.crypt_method); | |
384 | be64_to_cpus(&header.l1_table_offset); | |
385 | be32_to_cpus(&header.l1_size); | |
386 | be64_to_cpus(&header.refcount_table_offset); | |
387 | be32_to_cpus(&header.refcount_table_clusters); | |
388 | be64_to_cpus(&header.snapshots_offset); | |
389 | be32_to_cpus(&header.nb_snapshots); | |
3b46e624 | 390 | |
e8cdcec1 | 391 | if (header.magic != QCOW_MAGIC) { |
3ef6c40a | 392 | error_setg(errp, "Image is not in qcow2 format"); |
15bac0d5 | 393 | ret = -EMEDIUMTYPE; |
585f8587 | 394 | goto fail; |
6d85a57e | 395 | } |
6744cbab | 396 | if (header.version < 2 || header.version > 3) { |
3ef6c40a | 397 | report_unsupported(bs, errp, "QCOW version %d", header.version); |
6744cbab KW |
398 | ret = -ENOTSUP; |
399 | goto fail; | |
400 | } | |
401 | ||
402 | s->qcow_version = header.version; | |
403 | ||
404 | /* Initialise version 3 header fields */ | |
405 | if (header.version == 2) { | |
406 | header.incompatible_features = 0; | |
407 | header.compatible_features = 0; | |
408 | header.autoclear_features = 0; | |
409 | header.refcount_order = 4; | |
410 | header.header_length = 72; | |
411 | } else { | |
412 | be64_to_cpus(&header.incompatible_features); | |
413 | be64_to_cpus(&header.compatible_features); | |
414 | be64_to_cpus(&header.autoclear_features); | |
415 | be32_to_cpus(&header.refcount_order); | |
416 | be32_to_cpus(&header.header_length); | |
417 | } | |
418 | ||
419 | if (header.header_length > sizeof(header)) { | |
420 | s->unknown_header_fields_size = header.header_length - sizeof(header); | |
421 | s->unknown_header_fields = g_malloc(s->unknown_header_fields_size); | |
422 | ret = bdrv_pread(bs->file, sizeof(header), s->unknown_header_fields, | |
423 | s->unknown_header_fields_size); | |
424 | if (ret < 0) { | |
3ef6c40a MR |
425 | error_setg_errno(errp, -ret, "Could not read unknown qcow2 header " |
426 | "fields"); | |
6744cbab KW |
427 | goto fail; |
428 | } | |
429 | } | |
430 | ||
cfcc4c62 KW |
431 | if (header.backing_file_offset) { |
432 | ext_end = header.backing_file_offset; | |
433 | } else { | |
434 | ext_end = 1 << header.cluster_bits; | |
435 | } | |
436 | ||
6744cbab KW |
437 | /* Handle feature bits */ |
438 | s->incompatible_features = header.incompatible_features; | |
439 | s->compatible_features = header.compatible_features; | |
440 | s->autoclear_features = header.autoclear_features; | |
441 | ||
c61d0004 | 442 | if (s->incompatible_features & ~QCOW2_INCOMPAT_MASK) { |
cfcc4c62 KW |
443 | void *feature_table = NULL; |
444 | qcow2_read_extensions(bs, header.header_length, ext_end, | |
3ef6c40a MR |
445 | &feature_table, NULL); |
446 | report_unsupported_feature(bs, errp, feature_table, | |
c61d0004 SH |
447 | s->incompatible_features & |
448 | ~QCOW2_INCOMPAT_MASK); | |
6744cbab KW |
449 | ret = -ENOTSUP; |
450 | goto fail; | |
451 | } | |
452 | ||
69c98726 MR |
453 | if (s->incompatible_features & QCOW2_INCOMPAT_CORRUPT) { |
454 | /* Corrupt images may not be written to unless they are being repaired | |
455 | */ | |
456 | if ((flags & BDRV_O_RDWR) && !(flags & BDRV_O_CHECK)) { | |
3ef6c40a MR |
457 | error_setg(errp, "qcow2: Image is corrupt; cannot be opened " |
458 | "read/write"); | |
69c98726 MR |
459 | ret = -EACCES; |
460 | goto fail; | |
461 | } | |
462 | } | |
463 | ||
6744cbab KW |
464 | /* Check support for various header values */ |
465 | if (header.refcount_order != 4) { | |
3ef6c40a | 466 | report_unsupported(bs, errp, "%d bit reference counts", |
6744cbab | 467 | 1 << header.refcount_order); |
e8cdcec1 KW |
468 | ret = -ENOTSUP; |
469 | goto fail; | |
470 | } | |
b6481f37 | 471 | s->refcount_order = header.refcount_order; |
6744cbab | 472 | |
d191d12d | 473 | if (header.cluster_bits < MIN_CLUSTER_BITS || |
6d85a57e | 474 | header.cluster_bits > MAX_CLUSTER_BITS) { |
3ef6c40a | 475 | error_setg(errp, "Unsupported cluster size: 2^%i", header.cluster_bits); |
6d85a57e | 476 | ret = -EINVAL; |
585f8587 | 477 | goto fail; |
6d85a57e JS |
478 | } |
479 | if (header.crypt_method > QCOW_CRYPT_AES) { | |
3ef6c40a MR |
480 | error_setg(errp, "Unsupported encryption method: %i", |
481 | header.crypt_method); | |
6d85a57e | 482 | ret = -EINVAL; |
585f8587 | 483 | goto fail; |
6d85a57e | 484 | } |
585f8587 | 485 | s->crypt_method_header = header.crypt_method; |
6d85a57e | 486 | if (s->crypt_method_header) { |
585f8587 | 487 | bs->encrypted = 1; |
6d85a57e | 488 | } |
585f8587 FB |
489 | s->cluster_bits = header.cluster_bits; |
490 | s->cluster_size = 1 << s->cluster_bits; | |
491 | s->cluster_sectors = 1 << (s->cluster_bits - 9); | |
492 | s->l2_bits = s->cluster_bits - 3; /* L2 is always one cluster */ | |
493 | s->l2_size = 1 << s->l2_bits; | |
494 | bs->total_sectors = header.size / 512; | |
495 | s->csize_shift = (62 - (s->cluster_bits - 8)); | |
496 | s->csize_mask = (1 << (s->cluster_bits - 8)) - 1; | |
497 | s->cluster_offset_mask = (1LL << s->csize_shift) - 1; | |
498 | s->refcount_table_offset = header.refcount_table_offset; | |
5fafdf24 | 499 | s->refcount_table_size = |
585f8587 FB |
500 | header.refcount_table_clusters << (s->cluster_bits - 3); |
501 | ||
502 | s->snapshots_offset = header.snapshots_offset; | |
503 | s->nb_snapshots = header.nb_snapshots; | |
504 | ||
505 | /* read the level 1 table */ | |
506 | s->l1_size = header.l1_size; | |
2cf7cfa1 KW |
507 | |
508 | l1_vm_state_index = size_to_l1(s, header.size); | |
509 | if (l1_vm_state_index > INT_MAX) { | |
3ef6c40a | 510 | error_setg(errp, "Image is too big"); |
2cf7cfa1 KW |
511 | ret = -EFBIG; |
512 | goto fail; | |
513 | } | |
514 | s->l1_vm_state_index = l1_vm_state_index; | |
515 | ||
585f8587 FB |
516 | /* the L1 table must contain at least enough entries to put |
517 | header.size bytes */ | |
6d85a57e | 518 | if (s->l1_size < s->l1_vm_state_index) { |
3ef6c40a | 519 | error_setg(errp, "L1 table is too small"); |
6d85a57e | 520 | ret = -EINVAL; |
585f8587 | 521 | goto fail; |
6d85a57e | 522 | } |
585f8587 | 523 | s->l1_table_offset = header.l1_table_offset; |
d191d12d | 524 | if (s->l1_size > 0) { |
7267c094 | 525 | s->l1_table = g_malloc0( |
d191d12d | 526 | align_offset(s->l1_size * sizeof(uint64_t), 512)); |
6d85a57e JS |
527 | ret = bdrv_pread(bs->file, s->l1_table_offset, s->l1_table, |
528 | s->l1_size * sizeof(uint64_t)); | |
529 | if (ret < 0) { | |
3ef6c40a | 530 | error_setg_errno(errp, -ret, "Could not read L1 table"); |
d191d12d | 531 | goto fail; |
6d85a57e | 532 | } |
d191d12d SW |
533 | for(i = 0;i < s->l1_size; i++) { |
534 | be64_to_cpus(&s->l1_table[i]); | |
535 | } | |
585f8587 | 536 | } |
29c1a730 KW |
537 | |
538 | /* alloc L2 table/refcount block cache */ | |
6af4e9ea PB |
539 | s->l2_table_cache = qcow2_cache_create(bs, L2_CACHE_SIZE); |
540 | s->refcount_block_cache = qcow2_cache_create(bs, REFCOUNT_CACHE_SIZE); | |
29c1a730 | 541 | |
7267c094 | 542 | s->cluster_cache = g_malloc(s->cluster_size); |
585f8587 | 543 | /* one more sector for decompressed data alignment */ |
dea43a65 | 544 | s->cluster_data = qemu_blockalign(bs, QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size |
095a9c58 | 545 | + 512); |
585f8587 | 546 | s->cluster_cache_offset = -1; |
06d9260f | 547 | s->flags = flags; |
3b46e624 | 548 | |
6d85a57e JS |
549 | ret = qcow2_refcount_init(bs); |
550 | if (ret != 0) { | |
3ef6c40a | 551 | error_setg_errno(errp, -ret, "Could not initialize refcount handling"); |
585f8587 | 552 | goto fail; |
6d85a57e | 553 | } |
585f8587 | 554 | |
72cf2d4f | 555 | QLIST_INIT(&s->cluster_allocs); |
0b919fae | 556 | QTAILQ_INIT(&s->discards); |
f214978a | 557 | |
9b80ddf3 | 558 | /* read qcow2 extensions */ |
3ef6c40a MR |
559 | if (qcow2_read_extensions(bs, header.header_length, ext_end, NULL, |
560 | &local_err)) { | |
561 | error_propagate(errp, local_err); | |
6d85a57e | 562 | ret = -EINVAL; |
9b80ddf3 | 563 | goto fail; |
6d85a57e | 564 | } |
9b80ddf3 | 565 | |
585f8587 FB |
566 | /* read the backing file name */ |
567 | if (header.backing_file_offset != 0) { | |
568 | len = header.backing_file_size; | |
6d85a57e | 569 | if (len > 1023) { |
585f8587 | 570 | len = 1023; |
6d85a57e JS |
571 | } |
572 | ret = bdrv_pread(bs->file, header.backing_file_offset, | |
573 | bs->backing_file, len); | |
574 | if (ret < 0) { | |
3ef6c40a | 575 | error_setg_errno(errp, -ret, "Could not read backing file name"); |
585f8587 | 576 | goto fail; |
6d85a57e | 577 | } |
585f8587 FB |
578 | bs->backing_file[len] = '\0'; |
579 | } | |
42deb29f KW |
580 | |
581 | ret = qcow2_read_snapshots(bs); | |
582 | if (ret < 0) { | |
3ef6c40a | 583 | error_setg_errno(errp, -ret, "Could not read snapshots"); |
585f8587 | 584 | goto fail; |
6d85a57e | 585 | } |
585f8587 | 586 | |
af7b708d SH |
587 | /* Clear unknown autoclear feature bits */ |
588 | if (!bs->read_only && s->autoclear_features != 0) { | |
589 | s->autoclear_features = 0; | |
590 | ret = qcow2_update_header(bs); | |
591 | if (ret < 0) { | |
3ef6c40a | 592 | error_setg_errno(errp, -ret, "Could not update qcow2 header"); |
af7b708d SH |
593 | goto fail; |
594 | } | |
595 | } | |
596 | ||
68d100e9 KW |
597 | /* Initialise locks */ |
598 | qemu_co_mutex_init(&s->lock); | |
599 | ||
c61d0004 | 600 | /* Repair image if dirty */ |
058f8f16 SH |
601 | if (!(flags & BDRV_O_CHECK) && !bs->read_only && |
602 | (s->incompatible_features & QCOW2_INCOMPAT_DIRTY)) { | |
c61d0004 SH |
603 | BdrvCheckResult result = {0}; |
604 | ||
acbe5982 | 605 | ret = qcow2_check(bs, &result, BDRV_FIX_ERRORS); |
c61d0004 | 606 | if (ret < 0) { |
3ef6c40a | 607 | error_setg_errno(errp, -ret, "Could not repair dirty image"); |
c61d0004 SH |
608 | goto fail; |
609 | } | |
610 | } | |
611 | ||
74c4510a KW |
612 | /* Enable lazy_refcounts according to image and command line options */ |
613 | opts = qemu_opts_create_nofail(&qcow2_runtime_opts); | |
614 | qemu_opts_absorb_qdict(opts, options, &local_err); | |
615 | if (error_is_set(&local_err)) { | |
3ef6c40a | 616 | error_propagate(errp, local_err); |
74c4510a KW |
617 | ret = -EINVAL; |
618 | goto fail; | |
619 | } | |
620 | ||
acdfb480 | 621 | s->use_lazy_refcounts = qemu_opt_get_bool(opts, QCOW2_OPT_LAZY_REFCOUNTS, |
74c4510a KW |
622 | (s->compatible_features & QCOW2_COMPAT_LAZY_REFCOUNTS)); |
623 | ||
67af674e KW |
624 | s->discard_passthrough[QCOW2_DISCARD_NEVER] = false; |
625 | s->discard_passthrough[QCOW2_DISCARD_ALWAYS] = true; | |
626 | s->discard_passthrough[QCOW2_DISCARD_REQUEST] = | |
627 | qemu_opt_get_bool(opts, QCOW2_OPT_DISCARD_REQUEST, | |
628 | flags & BDRV_O_UNMAP); | |
629 | s->discard_passthrough[QCOW2_DISCARD_SNAPSHOT] = | |
630 | qemu_opt_get_bool(opts, QCOW2_OPT_DISCARD_SNAPSHOT, true); | |
631 | s->discard_passthrough[QCOW2_DISCARD_OTHER] = | |
632 | qemu_opt_get_bool(opts, QCOW2_OPT_DISCARD_OTHER, false); | |
633 | ||
74c4510a KW |
634 | qemu_opts_del(opts); |
635 | ||
636 | if (s->use_lazy_refcounts && s->qcow_version < 3) { | |
3ef6c40a MR |
637 | error_setg(errp, "Lazy refcounts require a qcow2 image with at least " |
638 | "qemu 1.1 compatibility level"); | |
74c4510a KW |
639 | ret = -EINVAL; |
640 | goto fail; | |
641 | } | |
642 | ||
585f8587 | 643 | #ifdef DEBUG_ALLOC |
6cbc3031 PH |
644 | { |
645 | BdrvCheckResult result = {0}; | |
b35278f7 | 646 | qcow2_check_refcounts(bs, &result, 0); |
6cbc3031 | 647 | } |
585f8587 | 648 | #endif |
6d85a57e | 649 | return ret; |
585f8587 FB |
650 | |
651 | fail: | |
6744cbab | 652 | g_free(s->unknown_header_fields); |
75bab85c | 653 | cleanup_unknown_header_ext(bs); |
ed6ccf0f KW |
654 | qcow2_free_snapshots(bs); |
655 | qcow2_refcount_close(bs); | |
7267c094 | 656 | g_free(s->l1_table); |
cf93980e MR |
657 | /* else pre-write overlap checks in cache_destroy may crash */ |
658 | s->l1_table = NULL; | |
29c1a730 KW |
659 | if (s->l2_table_cache) { |
660 | qcow2_cache_destroy(bs, s->l2_table_cache); | |
661 | } | |
7267c094 | 662 | g_free(s->cluster_cache); |
dea43a65 | 663 | qemu_vfree(s->cluster_data); |
6d85a57e | 664 | return ret; |
585f8587 FB |
665 | } |
666 | ||
7c80ab3f | 667 | static int qcow2_set_key(BlockDriverState *bs, const char *key) |
585f8587 FB |
668 | { |
669 | BDRVQcowState *s = bs->opaque; | |
670 | uint8_t keybuf[16]; | |
671 | int len, i; | |
3b46e624 | 672 | |
585f8587 FB |
673 | memset(keybuf, 0, 16); |
674 | len = strlen(key); | |
675 | if (len > 16) | |
676 | len = 16; | |
677 | /* XXX: we could compress the chars to 7 bits to increase | |
678 | entropy */ | |
679 | for(i = 0;i < len;i++) { | |
680 | keybuf[i] = key[i]; | |
681 | } | |
682 | s->crypt_method = s->crypt_method_header; | |
683 | ||
684 | if (AES_set_encrypt_key(keybuf, 128, &s->aes_encrypt_key) != 0) | |
685 | return -1; | |
686 | if (AES_set_decrypt_key(keybuf, 128, &s->aes_decrypt_key) != 0) | |
687 | return -1; | |
688 | #if 0 | |
689 | /* test */ | |
690 | { | |
691 | uint8_t in[16]; | |
692 | uint8_t out[16]; | |
693 | uint8_t tmp[16]; | |
694 | for(i=0;i<16;i++) | |
695 | in[i] = i; | |
696 | AES_encrypt(in, tmp, &s->aes_encrypt_key); | |
697 | AES_decrypt(tmp, out, &s->aes_decrypt_key); | |
698 | for(i = 0; i < 16; i++) | |
699 | printf(" %02x", tmp[i]); | |
700 | printf("\n"); | |
701 | for(i = 0; i < 16; i++) | |
702 | printf(" %02x", out[i]); | |
703 | printf("\n"); | |
704 | } | |
705 | #endif | |
706 | return 0; | |
707 | } | |
708 | ||
21d82ac9 JC |
709 | /* We have nothing to do for QCOW2 reopen, stubs just return |
710 | * success */ | |
711 | static int qcow2_reopen_prepare(BDRVReopenState *state, | |
712 | BlockReopenQueue *queue, Error **errp) | |
713 | { | |
714 | return 0; | |
715 | } | |
716 | ||
b6b8a333 | 717 | static int64_t coroutine_fn qcow2_co_get_block_status(BlockDriverState *bs, |
f8a2e5e3 | 718 | int64_t sector_num, int nb_sectors, int *pnum) |
585f8587 | 719 | { |
f8a2e5e3 | 720 | BDRVQcowState *s = bs->opaque; |
585f8587 | 721 | uint64_t cluster_offset; |
4bc74be9 PB |
722 | int index_in_cluster, ret; |
723 | int64_t status = 0; | |
585f8587 | 724 | |
095a9c58 | 725 | *pnum = nb_sectors; |
f8a2e5e3 | 726 | qemu_co_mutex_lock(&s->lock); |
1c46efaa | 727 | ret = qcow2_get_cluster_offset(bs, sector_num << 9, pnum, &cluster_offset); |
f8a2e5e3 | 728 | qemu_co_mutex_unlock(&s->lock); |
1c46efaa | 729 | if (ret < 0) { |
d663640c | 730 | return ret; |
1c46efaa | 731 | } |
095a9c58 | 732 | |
4bc74be9 PB |
733 | if (cluster_offset != 0 && ret != QCOW2_CLUSTER_COMPRESSED && |
734 | !s->crypt_method) { | |
735 | index_in_cluster = sector_num & (s->cluster_sectors - 1); | |
736 | cluster_offset |= (index_in_cluster << BDRV_SECTOR_BITS); | |
737 | status |= BDRV_BLOCK_OFFSET_VALID | cluster_offset; | |
738 | } | |
739 | if (ret == QCOW2_CLUSTER_ZERO) { | |
740 | status |= BDRV_BLOCK_ZERO; | |
741 | } else if (ret != QCOW2_CLUSTER_UNALLOCATED) { | |
742 | status |= BDRV_BLOCK_DATA; | |
743 | } | |
744 | return status; | |
585f8587 FB |
745 | } |
746 | ||
a9465922 | 747 | /* handle reading after the end of the backing file */ |
bd28f835 KW |
748 | int qcow2_backing_read1(BlockDriverState *bs, QEMUIOVector *qiov, |
749 | int64_t sector_num, int nb_sectors) | |
a9465922 FB |
750 | { |
751 | int n1; | |
752 | if ((sector_num + nb_sectors) <= bs->total_sectors) | |
753 | return nb_sectors; | |
754 | if (sector_num >= bs->total_sectors) | |
755 | n1 = 0; | |
756 | else | |
757 | n1 = bs->total_sectors - sector_num; | |
bd28f835 | 758 | |
3d9b4925 | 759 | qemu_iovec_memset(qiov, 512 * n1, 0, 512 * (nb_sectors - n1)); |
bd28f835 | 760 | |
a9465922 FB |
761 | return n1; |
762 | } | |
763 | ||
a968168c | 764 | static coroutine_fn int qcow2_co_readv(BlockDriverState *bs, int64_t sector_num, |
3fc48d09 | 765 | int remaining_sectors, QEMUIOVector *qiov) |
585f8587 | 766 | { |
585f8587 | 767 | BDRVQcowState *s = bs->opaque; |
a9465922 | 768 | int index_in_cluster, n1; |
68d100e9 | 769 | int ret; |
faf575c1 | 770 | int cur_nr_sectors; /* number of sectors in current iteration */ |
c2bdd990 | 771 | uint64_t cluster_offset = 0; |
3fc48d09 FZ |
772 | uint64_t bytes_done = 0; |
773 | QEMUIOVector hd_qiov; | |
774 | uint8_t *cluster_data = NULL; | |
585f8587 | 775 | |
3fc48d09 FZ |
776 | qemu_iovec_init(&hd_qiov, qiov->niov); |
777 | ||
778 | qemu_co_mutex_lock(&s->lock); | |
779 | ||
780 | while (remaining_sectors != 0) { | |
bd28f835 | 781 | |
5ebaa27e | 782 | /* prepare next request */ |
3fc48d09 | 783 | cur_nr_sectors = remaining_sectors; |
5ebaa27e FZ |
784 | if (s->crypt_method) { |
785 | cur_nr_sectors = MIN(cur_nr_sectors, | |
786 | QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors); | |
585f8587 | 787 | } |
5ebaa27e | 788 | |
3fc48d09 | 789 | ret = qcow2_get_cluster_offset(bs, sector_num << 9, |
5ebaa27e | 790 | &cur_nr_sectors, &cluster_offset); |
8af36488 | 791 | if (ret < 0) { |
3fc48d09 | 792 | goto fail; |
8af36488 | 793 | } |
bd28f835 | 794 | |
3fc48d09 | 795 | index_in_cluster = sector_num & (s->cluster_sectors - 1); |
c87c0672 | 796 | |
3fc48d09 | 797 | qemu_iovec_reset(&hd_qiov); |
1b093c48 | 798 | qemu_iovec_concat(&hd_qiov, qiov, bytes_done, |
5ebaa27e FZ |
799 | cur_nr_sectors * 512); |
800 | ||
68d000a3 KW |
801 | switch (ret) { |
802 | case QCOW2_CLUSTER_UNALLOCATED: | |
5ebaa27e FZ |
803 | |
804 | if (bs->backing_hd) { | |
805 | /* read from the base image */ | |
3fc48d09 FZ |
806 | n1 = qcow2_backing_read1(bs->backing_hd, &hd_qiov, |
807 | sector_num, cur_nr_sectors); | |
5ebaa27e FZ |
808 | if (n1 > 0) { |
809 | BLKDBG_EVENT(bs->file, BLKDBG_READ_BACKING_AIO); | |
810 | qemu_co_mutex_unlock(&s->lock); | |
3fc48d09 FZ |
811 | ret = bdrv_co_readv(bs->backing_hd, sector_num, |
812 | n1, &hd_qiov); | |
5ebaa27e FZ |
813 | qemu_co_mutex_lock(&s->lock); |
814 | if (ret < 0) { | |
3fc48d09 | 815 | goto fail; |
5ebaa27e FZ |
816 | } |
817 | } | |
818 | } else { | |
819 | /* Note: in this case, no need to wait */ | |
3d9b4925 | 820 | qemu_iovec_memset(&hd_qiov, 0, 0, 512 * cur_nr_sectors); |
5ebaa27e | 821 | } |
68d000a3 KW |
822 | break; |
823 | ||
6377af48 | 824 | case QCOW2_CLUSTER_ZERO: |
3d9b4925 | 825 | qemu_iovec_memset(&hd_qiov, 0, 0, 512 * cur_nr_sectors); |
6377af48 KW |
826 | break; |
827 | ||
68d000a3 | 828 | case QCOW2_CLUSTER_COMPRESSED: |
5ebaa27e FZ |
829 | /* add AIO support for compressed blocks ? */ |
830 | ret = qcow2_decompress_cluster(bs, cluster_offset); | |
831 | if (ret < 0) { | |
3fc48d09 | 832 | goto fail; |
bd28f835 KW |
833 | } |
834 | ||
03396148 | 835 | qemu_iovec_from_buf(&hd_qiov, 0, |
5ebaa27e | 836 | s->cluster_cache + index_in_cluster * 512, |
faf575c1 | 837 | 512 * cur_nr_sectors); |
68d000a3 KW |
838 | break; |
839 | ||
840 | case QCOW2_CLUSTER_NORMAL: | |
5ebaa27e | 841 | if ((cluster_offset & 511) != 0) { |
3fc48d09 FZ |
842 | ret = -EIO; |
843 | goto fail; | |
5ebaa27e | 844 | } |
bd28f835 | 845 | |
5ebaa27e FZ |
846 | if (s->crypt_method) { |
847 | /* | |
848 | * For encrypted images, read everything into a temporary | |
849 | * contiguous buffer on which the AES functions can work. | |
850 | */ | |
3fc48d09 FZ |
851 | if (!cluster_data) { |
852 | cluster_data = | |
dea43a65 | 853 | qemu_blockalign(bs, QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size); |
5ebaa27e FZ |
854 | } |
855 | ||
856 | assert(cur_nr_sectors <= | |
857 | QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors); | |
3fc48d09 FZ |
858 | qemu_iovec_reset(&hd_qiov); |
859 | qemu_iovec_add(&hd_qiov, cluster_data, | |
5ebaa27e FZ |
860 | 512 * cur_nr_sectors); |
861 | } | |
862 | ||
863 | BLKDBG_EVENT(bs->file, BLKDBG_READ_AIO); | |
864 | qemu_co_mutex_unlock(&s->lock); | |
865 | ret = bdrv_co_readv(bs->file, | |
866 | (cluster_offset >> 9) + index_in_cluster, | |
3fc48d09 | 867 | cur_nr_sectors, &hd_qiov); |
5ebaa27e FZ |
868 | qemu_co_mutex_lock(&s->lock); |
869 | if (ret < 0) { | |
3fc48d09 | 870 | goto fail; |
5ebaa27e FZ |
871 | } |
872 | if (s->crypt_method) { | |
3fc48d09 FZ |
873 | qcow2_encrypt_sectors(s, sector_num, cluster_data, |
874 | cluster_data, cur_nr_sectors, 0, &s->aes_decrypt_key); | |
03396148 MT |
875 | qemu_iovec_from_buf(qiov, bytes_done, |
876 | cluster_data, 512 * cur_nr_sectors); | |
5ebaa27e | 877 | } |
68d000a3 KW |
878 | break; |
879 | ||
880 | default: | |
881 | g_assert_not_reached(); | |
882 | ret = -EIO; | |
883 | goto fail; | |
faf575c1 | 884 | } |
f141eafe | 885 | |
3fc48d09 FZ |
886 | remaining_sectors -= cur_nr_sectors; |
887 | sector_num += cur_nr_sectors; | |
888 | bytes_done += cur_nr_sectors * 512; | |
5ebaa27e | 889 | } |
3fc48d09 | 890 | ret = 0; |
faf575c1 | 891 | |
3fc48d09 | 892 | fail: |
68d100e9 | 893 | qemu_co_mutex_unlock(&s->lock); |
42496d62 | 894 | |
3fc48d09 | 895 | qemu_iovec_destroy(&hd_qiov); |
dea43a65 | 896 | qemu_vfree(cluster_data); |
68d100e9 KW |
897 | |
898 | return ret; | |
585f8587 FB |
899 | } |
900 | ||
a968168c | 901 | static coroutine_fn int qcow2_co_writev(BlockDriverState *bs, |
3fc48d09 FZ |
902 | int64_t sector_num, |
903 | int remaining_sectors, | |
904 | QEMUIOVector *qiov) | |
585f8587 | 905 | { |
585f8587 | 906 | BDRVQcowState *s = bs->opaque; |
585f8587 | 907 | int index_in_cluster; |
095a9c58 | 908 | int n_end; |
68d100e9 | 909 | int ret; |
faf575c1 | 910 | int cur_nr_sectors; /* number of sectors in current iteration */ |
c2bdd990 | 911 | uint64_t cluster_offset; |
3fc48d09 FZ |
912 | QEMUIOVector hd_qiov; |
913 | uint64_t bytes_done = 0; | |
914 | uint8_t *cluster_data = NULL; | |
8d2497c3 | 915 | QCowL2Meta *l2meta = NULL; |
c2271403 | 916 | |
3cce16f4 KW |
917 | trace_qcow2_writev_start_req(qemu_coroutine_self(), sector_num, |
918 | remaining_sectors); | |
919 | ||
3fc48d09 FZ |
920 | qemu_iovec_init(&hd_qiov, qiov->niov); |
921 | ||
922 | s->cluster_cache_offset = -1; /* disable compressed cache */ | |
3b46e624 | 923 | |
3fc48d09 FZ |
924 | qemu_co_mutex_lock(&s->lock); |
925 | ||
926 | while (remaining_sectors != 0) { | |
927 | ||
f50f88b9 | 928 | l2meta = NULL; |
cf5c1a23 | 929 | |
3cce16f4 | 930 | trace_qcow2_writev_start_part(qemu_coroutine_self()); |
3fc48d09 FZ |
931 | index_in_cluster = sector_num & (s->cluster_sectors - 1); |
932 | n_end = index_in_cluster + remaining_sectors; | |
5ebaa27e FZ |
933 | if (s->crypt_method && |
934 | n_end > QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors) { | |
935 | n_end = QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors; | |
936 | } | |
095a9c58 | 937 | |
3fc48d09 | 938 | ret = qcow2_alloc_cluster_offset(bs, sector_num << 9, |
f50f88b9 | 939 | index_in_cluster, n_end, &cur_nr_sectors, &cluster_offset, &l2meta); |
5ebaa27e | 940 | if (ret < 0) { |
3fc48d09 | 941 | goto fail; |
5ebaa27e | 942 | } |
148da7ea | 943 | |
5ebaa27e | 944 | assert((cluster_offset & 511) == 0); |
148da7ea | 945 | |
3fc48d09 | 946 | qemu_iovec_reset(&hd_qiov); |
1b093c48 | 947 | qemu_iovec_concat(&hd_qiov, qiov, bytes_done, |
5ebaa27e | 948 | cur_nr_sectors * 512); |
6f5f060b | 949 | |
5ebaa27e | 950 | if (s->crypt_method) { |
3fc48d09 | 951 | if (!cluster_data) { |
dea43a65 | 952 | cluster_data = qemu_blockalign(bs, QCOW_MAX_CRYPT_CLUSTERS * |
5ebaa27e FZ |
953 | s->cluster_size); |
954 | } | |
6f5f060b | 955 | |
3fc48d09 | 956 | assert(hd_qiov.size <= |
5ebaa27e | 957 | QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size); |
d5e6b161 | 958 | qemu_iovec_to_buf(&hd_qiov, 0, cluster_data, hd_qiov.size); |
6f5f060b | 959 | |
3fc48d09 FZ |
960 | qcow2_encrypt_sectors(s, sector_num, cluster_data, |
961 | cluster_data, cur_nr_sectors, 1, &s->aes_encrypt_key); | |
6f5f060b | 962 | |
3fc48d09 FZ |
963 | qemu_iovec_reset(&hd_qiov); |
964 | qemu_iovec_add(&hd_qiov, cluster_data, | |
5ebaa27e FZ |
965 | cur_nr_sectors * 512); |
966 | } | |
6f5f060b | 967 | |
cf93980e MR |
968 | ret = qcow2_pre_write_overlap_check(bs, QCOW2_OL_DEFAULT, |
969 | cluster_offset + index_in_cluster * BDRV_SECTOR_SIZE, | |
970 | cur_nr_sectors * BDRV_SECTOR_SIZE); | |
971 | if (ret < 0) { | |
972 | goto fail; | |
973 | } | |
974 | ||
5ebaa27e | 975 | qemu_co_mutex_unlock(&s->lock); |
67a7a0eb | 976 | BLKDBG_EVENT(bs->file, BLKDBG_WRITE_AIO); |
3cce16f4 KW |
977 | trace_qcow2_writev_data(qemu_coroutine_self(), |
978 | (cluster_offset >> 9) + index_in_cluster); | |
5ebaa27e FZ |
979 | ret = bdrv_co_writev(bs->file, |
980 | (cluster_offset >> 9) + index_in_cluster, | |
3fc48d09 | 981 | cur_nr_sectors, &hd_qiov); |
5ebaa27e FZ |
982 | qemu_co_mutex_lock(&s->lock); |
983 | if (ret < 0) { | |
3fc48d09 | 984 | goto fail; |
5ebaa27e | 985 | } |
f141eafe | 986 | |
88c6588c KW |
987 | while (l2meta != NULL) { |
988 | QCowL2Meta *next; | |
989 | ||
f50f88b9 KW |
990 | ret = qcow2_alloc_cluster_link_l2(bs, l2meta); |
991 | if (ret < 0) { | |
992 | goto fail; | |
993 | } | |
faf575c1 | 994 | |
4e95314e KW |
995 | /* Take the request off the list of running requests */ |
996 | if (l2meta->nb_clusters != 0) { | |
997 | QLIST_REMOVE(l2meta, next_in_flight); | |
998 | } | |
999 | ||
4e95314e | 1000 | qemu_co_queue_restart_all(&l2meta->dependent_requests); |
4e95314e | 1001 | |
88c6588c | 1002 | next = l2meta->next; |
f50f88b9 | 1003 | g_free(l2meta); |
88c6588c | 1004 | l2meta = next; |
f50f88b9 | 1005 | } |
0fa9131a | 1006 | |
3fc48d09 FZ |
1007 | remaining_sectors -= cur_nr_sectors; |
1008 | sector_num += cur_nr_sectors; | |
1009 | bytes_done += cur_nr_sectors * 512; | |
3cce16f4 | 1010 | trace_qcow2_writev_done_part(qemu_coroutine_self(), cur_nr_sectors); |
5ebaa27e | 1011 | } |
3fc48d09 | 1012 | ret = 0; |
faf575c1 | 1013 | |
3fc48d09 | 1014 | fail: |
4e95314e KW |
1015 | qemu_co_mutex_unlock(&s->lock); |
1016 | ||
88c6588c KW |
1017 | while (l2meta != NULL) { |
1018 | QCowL2Meta *next; | |
1019 | ||
4e95314e KW |
1020 | if (l2meta->nb_clusters != 0) { |
1021 | QLIST_REMOVE(l2meta, next_in_flight); | |
1022 | } | |
1023 | qemu_co_queue_restart_all(&l2meta->dependent_requests); | |
88c6588c KW |
1024 | |
1025 | next = l2meta->next; | |
cf5c1a23 | 1026 | g_free(l2meta); |
88c6588c | 1027 | l2meta = next; |
cf5c1a23 | 1028 | } |
0fa9131a | 1029 | |
3fc48d09 | 1030 | qemu_iovec_destroy(&hd_qiov); |
dea43a65 | 1031 | qemu_vfree(cluster_data); |
3cce16f4 | 1032 | trace_qcow2_writev_done_req(qemu_coroutine_self(), ret); |
42496d62 | 1033 | |
68d100e9 | 1034 | return ret; |
585f8587 FB |
1035 | } |
1036 | ||
7c80ab3f | 1037 | static void qcow2_close(BlockDriverState *bs) |
585f8587 FB |
1038 | { |
1039 | BDRVQcowState *s = bs->opaque; | |
7267c094 | 1040 | g_free(s->l1_table); |
cf93980e MR |
1041 | /* else pre-write overlap checks in cache_destroy may crash */ |
1042 | s->l1_table = NULL; | |
29c1a730 KW |
1043 | |
1044 | qcow2_cache_flush(bs, s->l2_table_cache); | |
1045 | qcow2_cache_flush(bs, s->refcount_block_cache); | |
1046 | ||
c61d0004 SH |
1047 | qcow2_mark_clean(bs); |
1048 | ||
29c1a730 KW |
1049 | qcow2_cache_destroy(bs, s->l2_table_cache); |
1050 | qcow2_cache_destroy(bs, s->refcount_block_cache); | |
1051 | ||
6744cbab | 1052 | g_free(s->unknown_header_fields); |
75bab85c | 1053 | cleanup_unknown_header_ext(bs); |
6744cbab | 1054 | |
7267c094 | 1055 | g_free(s->cluster_cache); |
dea43a65 | 1056 | qemu_vfree(s->cluster_data); |
ed6ccf0f | 1057 | qcow2_refcount_close(bs); |
28c1202b | 1058 | qcow2_free_snapshots(bs); |
585f8587 FB |
1059 | } |
1060 | ||
06d9260f AL |
1061 | static void qcow2_invalidate_cache(BlockDriverState *bs) |
1062 | { | |
1063 | BDRVQcowState *s = bs->opaque; | |
1064 | int flags = s->flags; | |
1065 | AES_KEY aes_encrypt_key; | |
1066 | AES_KEY aes_decrypt_key; | |
1067 | uint32_t crypt_method = 0; | |
acdfb480 | 1068 | QDict *options; |
06d9260f AL |
1069 | |
1070 | /* | |
1071 | * Backing files are read-only which makes all of their metadata immutable, | |
1072 | * that means we don't have to worry about reopening them here. | |
1073 | */ | |
1074 | ||
1075 | if (s->crypt_method) { | |
1076 | crypt_method = s->crypt_method; | |
1077 | memcpy(&aes_encrypt_key, &s->aes_encrypt_key, sizeof(aes_encrypt_key)); | |
1078 | memcpy(&aes_decrypt_key, &s->aes_decrypt_key, sizeof(aes_decrypt_key)); | |
1079 | } | |
1080 | ||
1081 | qcow2_close(bs); | |
1082 | ||
acdfb480 KW |
1083 | options = qdict_new(); |
1084 | qdict_put(options, QCOW2_OPT_LAZY_REFCOUNTS, | |
1085 | qbool_from_int(s->use_lazy_refcounts)); | |
1086 | ||
06d9260f | 1087 | memset(s, 0, sizeof(BDRVQcowState)); |
015a1036 | 1088 | qcow2_open(bs, options, flags, NULL); |
acdfb480 KW |
1089 | |
1090 | QDECREF(options); | |
06d9260f AL |
1091 | |
1092 | if (crypt_method) { | |
1093 | s->crypt_method = crypt_method; | |
1094 | memcpy(&s->aes_encrypt_key, &aes_encrypt_key, sizeof(aes_encrypt_key)); | |
1095 | memcpy(&s->aes_decrypt_key, &aes_decrypt_key, sizeof(aes_decrypt_key)); | |
1096 | } | |
1097 | } | |
1098 | ||
e24e49e6 KW |
1099 | static size_t header_ext_add(char *buf, uint32_t magic, const void *s, |
1100 | size_t len, size_t buflen) | |
1101 | { | |
1102 | QCowExtension *ext_backing_fmt = (QCowExtension*) buf; | |
1103 | size_t ext_len = sizeof(QCowExtension) + ((len + 7) & ~7); | |
1104 | ||
1105 | if (buflen < ext_len) { | |
1106 | return -ENOSPC; | |
1107 | } | |
1108 | ||
1109 | *ext_backing_fmt = (QCowExtension) { | |
1110 | .magic = cpu_to_be32(magic), | |
1111 | .len = cpu_to_be32(len), | |
1112 | }; | |
1113 | memcpy(buf + sizeof(QCowExtension), s, len); | |
1114 | ||
1115 | return ext_len; | |
1116 | } | |
1117 | ||
756e6736 | 1118 | /* |
e24e49e6 KW |
1119 | * Updates the qcow2 header, including the variable length parts of it, i.e. |
1120 | * the backing file name and all extensions. qcow2 was not designed to allow | |
1121 | * such changes, so if we run out of space (we can only use the first cluster) | |
1122 | * this function may fail. | |
756e6736 KW |
1123 | * |
1124 | * Returns 0 on success, -errno in error cases. | |
1125 | */ | |
e24e49e6 | 1126 | int qcow2_update_header(BlockDriverState *bs) |
756e6736 | 1127 | { |
756e6736 | 1128 | BDRVQcowState *s = bs->opaque; |
e24e49e6 KW |
1129 | QCowHeader *header; |
1130 | char *buf; | |
1131 | size_t buflen = s->cluster_size; | |
756e6736 | 1132 | int ret; |
e24e49e6 KW |
1133 | uint64_t total_size; |
1134 | uint32_t refcount_table_clusters; | |
6744cbab | 1135 | size_t header_length; |
75bab85c | 1136 | Qcow2UnknownHeaderExtension *uext; |
756e6736 | 1137 | |
e24e49e6 | 1138 | buf = qemu_blockalign(bs, buflen); |
756e6736 | 1139 | |
e24e49e6 KW |
1140 | /* Header structure */ |
1141 | header = (QCowHeader*) buf; | |
756e6736 | 1142 | |
e24e49e6 KW |
1143 | if (buflen < sizeof(*header)) { |
1144 | ret = -ENOSPC; | |
1145 | goto fail; | |
756e6736 KW |
1146 | } |
1147 | ||
6744cbab | 1148 | header_length = sizeof(*header) + s->unknown_header_fields_size; |
e24e49e6 KW |
1149 | total_size = bs->total_sectors * BDRV_SECTOR_SIZE; |
1150 | refcount_table_clusters = s->refcount_table_size >> (s->cluster_bits - 3); | |
1151 | ||
1152 | *header = (QCowHeader) { | |
6744cbab | 1153 | /* Version 2 fields */ |
e24e49e6 | 1154 | .magic = cpu_to_be32(QCOW_MAGIC), |
6744cbab | 1155 | .version = cpu_to_be32(s->qcow_version), |
e24e49e6 KW |
1156 | .backing_file_offset = 0, |
1157 | .backing_file_size = 0, | |
1158 | .cluster_bits = cpu_to_be32(s->cluster_bits), | |
1159 | .size = cpu_to_be64(total_size), | |
1160 | .crypt_method = cpu_to_be32(s->crypt_method_header), | |
1161 | .l1_size = cpu_to_be32(s->l1_size), | |
1162 | .l1_table_offset = cpu_to_be64(s->l1_table_offset), | |
1163 | .refcount_table_offset = cpu_to_be64(s->refcount_table_offset), | |
1164 | .refcount_table_clusters = cpu_to_be32(refcount_table_clusters), | |
1165 | .nb_snapshots = cpu_to_be32(s->nb_snapshots), | |
1166 | .snapshots_offset = cpu_to_be64(s->snapshots_offset), | |
6744cbab KW |
1167 | |
1168 | /* Version 3 fields */ | |
1169 | .incompatible_features = cpu_to_be64(s->incompatible_features), | |
1170 | .compatible_features = cpu_to_be64(s->compatible_features), | |
1171 | .autoclear_features = cpu_to_be64(s->autoclear_features), | |
b6481f37 | 1172 | .refcount_order = cpu_to_be32(s->refcount_order), |
6744cbab | 1173 | .header_length = cpu_to_be32(header_length), |
e24e49e6 | 1174 | }; |
756e6736 | 1175 | |
6744cbab KW |
1176 | /* For older versions, write a shorter header */ |
1177 | switch (s->qcow_version) { | |
1178 | case 2: | |
1179 | ret = offsetof(QCowHeader, incompatible_features); | |
1180 | break; | |
1181 | case 3: | |
1182 | ret = sizeof(*header); | |
1183 | break; | |
1184 | default: | |
b6c14762 JM |
1185 | ret = -EINVAL; |
1186 | goto fail; | |
6744cbab KW |
1187 | } |
1188 | ||
1189 | buf += ret; | |
1190 | buflen -= ret; | |
1191 | memset(buf, 0, buflen); | |
1192 | ||
1193 | /* Preserve any unknown field in the header */ | |
1194 | if (s->unknown_header_fields_size) { | |
1195 | if (buflen < s->unknown_header_fields_size) { | |
1196 | ret = -ENOSPC; | |
1197 | goto fail; | |
1198 | } | |
1199 | ||
1200 | memcpy(buf, s->unknown_header_fields, s->unknown_header_fields_size); | |
1201 | buf += s->unknown_header_fields_size; | |
1202 | buflen -= s->unknown_header_fields_size; | |
1203 | } | |
756e6736 | 1204 | |
e24e49e6 KW |
1205 | /* Backing file format header extension */ |
1206 | if (*bs->backing_format) { | |
1207 | ret = header_ext_add(buf, QCOW2_EXT_MAGIC_BACKING_FORMAT, | |
1208 | bs->backing_format, strlen(bs->backing_format), | |
1209 | buflen); | |
1210 | if (ret < 0) { | |
1211 | goto fail; | |
756e6736 KW |
1212 | } |
1213 | ||
e24e49e6 KW |
1214 | buf += ret; |
1215 | buflen -= ret; | |
756e6736 KW |
1216 | } |
1217 | ||
cfcc4c62 KW |
1218 | /* Feature table */ |
1219 | Qcow2Feature features[] = { | |
c61d0004 SH |
1220 | { |
1221 | .type = QCOW2_FEAT_TYPE_INCOMPATIBLE, | |
1222 | .bit = QCOW2_INCOMPAT_DIRTY_BITNR, | |
1223 | .name = "dirty bit", | |
1224 | }, | |
69c98726 MR |
1225 | { |
1226 | .type = QCOW2_FEAT_TYPE_INCOMPATIBLE, | |
1227 | .bit = QCOW2_INCOMPAT_CORRUPT_BITNR, | |
1228 | .name = "corrupt bit", | |
1229 | }, | |
bfe8043e SH |
1230 | { |
1231 | .type = QCOW2_FEAT_TYPE_COMPATIBLE, | |
1232 | .bit = QCOW2_COMPAT_LAZY_REFCOUNTS_BITNR, | |
1233 | .name = "lazy refcounts", | |
1234 | }, | |
cfcc4c62 KW |
1235 | }; |
1236 | ||
1237 | ret = header_ext_add(buf, QCOW2_EXT_MAGIC_FEATURE_TABLE, | |
1238 | features, sizeof(features), buflen); | |
1239 | if (ret < 0) { | |
1240 | goto fail; | |
1241 | } | |
1242 | buf += ret; | |
1243 | buflen -= ret; | |
1244 | ||
75bab85c KW |
1245 | /* Keep unknown header extensions */ |
1246 | QLIST_FOREACH(uext, &s->unknown_header_ext, next) { | |
1247 | ret = header_ext_add(buf, uext->magic, uext->data, uext->len, buflen); | |
1248 | if (ret < 0) { | |
1249 | goto fail; | |
1250 | } | |
1251 | ||
1252 | buf += ret; | |
1253 | buflen -= ret; | |
1254 | } | |
1255 | ||
e24e49e6 KW |
1256 | /* End of header extensions */ |
1257 | ret = header_ext_add(buf, QCOW2_EXT_MAGIC_END, NULL, 0, buflen); | |
756e6736 KW |
1258 | if (ret < 0) { |
1259 | goto fail; | |
1260 | } | |
1261 | ||
e24e49e6 KW |
1262 | buf += ret; |
1263 | buflen -= ret; | |
756e6736 | 1264 | |
e24e49e6 KW |
1265 | /* Backing file name */ |
1266 | if (*bs->backing_file) { | |
1267 | size_t backing_file_len = strlen(bs->backing_file); | |
1268 | ||
1269 | if (buflen < backing_file_len) { | |
1270 | ret = -ENOSPC; | |
1271 | goto fail; | |
1272 | } | |
1273 | ||
00ea1881 | 1274 | /* Using strncpy is ok here, since buf is not NUL-terminated. */ |
e24e49e6 KW |
1275 | strncpy(buf, bs->backing_file, buflen); |
1276 | ||
1277 | header->backing_file_offset = cpu_to_be64(buf - ((char*) header)); | |
1278 | header->backing_file_size = cpu_to_be32(backing_file_len); | |
756e6736 KW |
1279 | } |
1280 | ||
e24e49e6 KW |
1281 | /* Write the new header */ |
1282 | ret = bdrv_pwrite(bs->file, 0, header, s->cluster_size); | |
756e6736 KW |
1283 | if (ret < 0) { |
1284 | goto fail; | |
1285 | } | |
1286 | ||
1287 | ret = 0; | |
1288 | fail: | |
e24e49e6 | 1289 | qemu_vfree(header); |
756e6736 KW |
1290 | return ret; |
1291 | } | |
1292 | ||
1293 | static int qcow2_change_backing_file(BlockDriverState *bs, | |
1294 | const char *backing_file, const char *backing_fmt) | |
1295 | { | |
e24e49e6 KW |
1296 | pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: ""); |
1297 | pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: ""); | |
1298 | ||
1299 | return qcow2_update_header(bs); | |
756e6736 KW |
1300 | } |
1301 | ||
a35e1c17 KW |
1302 | static int preallocate(BlockDriverState *bs) |
1303 | { | |
a35e1c17 KW |
1304 | uint64_t nb_sectors; |
1305 | uint64_t offset; | |
060bee89 | 1306 | uint64_t host_offset = 0; |
a35e1c17 | 1307 | int num; |
148da7ea | 1308 | int ret; |
f50f88b9 | 1309 | QCowL2Meta *meta; |
a35e1c17 KW |
1310 | |
1311 | nb_sectors = bdrv_getlength(bs) >> 9; | |
1312 | offset = 0; | |
1313 | ||
1314 | while (nb_sectors) { | |
1315 | num = MIN(nb_sectors, INT_MAX >> 9); | |
060bee89 KW |
1316 | ret = qcow2_alloc_cluster_offset(bs, offset, 0, num, &num, |
1317 | &host_offset, &meta); | |
148da7ea | 1318 | if (ret < 0) { |
19dbcbf7 | 1319 | return ret; |
a35e1c17 KW |
1320 | } |
1321 | ||
f50f88b9 | 1322 | ret = qcow2_alloc_cluster_link_l2(bs, meta); |
19dbcbf7 | 1323 | if (ret < 0) { |
6cfcb9b8 KW |
1324 | qcow2_free_any_clusters(bs, meta->alloc_offset, meta->nb_clusters, |
1325 | QCOW2_DISCARD_NEVER); | |
19dbcbf7 | 1326 | return ret; |
a35e1c17 KW |
1327 | } |
1328 | ||
f214978a KW |
1329 | /* There are no dependent requests, but we need to remove our request |
1330 | * from the list of in-flight requests */ | |
f50f88b9 | 1331 | if (meta != NULL) { |
4e95314e | 1332 | QLIST_REMOVE(meta, next_in_flight); |
f50f88b9 | 1333 | } |
f214978a | 1334 | |
a35e1c17 KW |
1335 | /* TODO Preallocate data if requested */ |
1336 | ||
1337 | nb_sectors -= num; | |
1338 | offset += num << 9; | |
1339 | } | |
1340 | ||
1341 | /* | |
1342 | * It is expected that the image file is large enough to actually contain | |
1343 | * all of the allocated clusters (otherwise we get failing reads after | |
1344 | * EOF). Extend the image to the last allocated sector. | |
1345 | */ | |
060bee89 | 1346 | if (host_offset != 0) { |
ea80b906 KW |
1347 | uint8_t buf[512]; |
1348 | memset(buf, 0, 512); | |
060bee89 | 1349 | ret = bdrv_write(bs->file, (host_offset >> 9) + num - 1, buf, 1); |
19dbcbf7 KW |
1350 | if (ret < 0) { |
1351 | return ret; | |
1352 | } | |
a35e1c17 KW |
1353 | } |
1354 | ||
1355 | return 0; | |
1356 | } | |
1357 | ||
7c80ab3f JS |
1358 | static int qcow2_create2(const char *filename, int64_t total_size, |
1359 | const char *backing_file, const char *backing_format, | |
1360 | int flags, size_t cluster_size, int prealloc, | |
3ef6c40a MR |
1361 | QEMUOptionParameter *options, int version, |
1362 | Error **errp) | |
a9420734 | 1363 | { |
9b2260cb | 1364 | /* Calculate cluster_bits */ |
a9420734 KW |
1365 | int cluster_bits; |
1366 | cluster_bits = ffs(cluster_size) - 1; | |
1367 | if (cluster_bits < MIN_CLUSTER_BITS || cluster_bits > MAX_CLUSTER_BITS || | |
1368 | (1 << cluster_bits) != cluster_size) | |
1369 | { | |
3ef6c40a MR |
1370 | error_setg(errp, "Cluster size must be a power of two between %d and " |
1371 | "%dk", 1 << MIN_CLUSTER_BITS, 1 << (MAX_CLUSTER_BITS - 10)); | |
a9420734 KW |
1372 | return -EINVAL; |
1373 | } | |
1374 | ||
1375 | /* | |
1376 | * Open the image file and write a minimal qcow2 header. | |
1377 | * | |
1378 | * We keep things simple and start with a zero-sized image. We also | |
1379 | * do without refcount blocks or a L1 table for now. We'll fix the | |
1380 | * inconsistency later. | |
1381 | * | |
1382 | * We do need a refcount table because growing the refcount table means | |
1383 | * allocating two new refcount blocks - the seconds of which would be at | |
1384 | * 2 GB for 64k clusters, and we don't want to have a 2 GB initial file | |
1385 | * size for any qcow2 image. | |
1386 | */ | |
1387 | BlockDriverState* bs; | |
1388 | QCowHeader header; | |
1389 | uint8_t* refcount_table; | |
3ef6c40a | 1390 | Error *local_err = NULL; |
a9420734 KW |
1391 | int ret; |
1392 | ||
3ef6c40a | 1393 | ret = bdrv_create_file(filename, options, &local_err); |
a9420734 | 1394 | if (ret < 0) { |
3ef6c40a | 1395 | error_propagate(errp, local_err); |
a9420734 KW |
1396 | return ret; |
1397 | } | |
1398 | ||
3ef6c40a | 1399 | ret = bdrv_file_open(&bs, filename, NULL, BDRV_O_RDWR, &local_err); |
a9420734 | 1400 | if (ret < 0) { |
3ef6c40a | 1401 | error_propagate(errp, local_err); |
a9420734 KW |
1402 | return ret; |
1403 | } | |
1404 | ||
1405 | /* Write the header */ | |
1406 | memset(&header, 0, sizeof(header)); | |
1407 | header.magic = cpu_to_be32(QCOW_MAGIC); | |
6744cbab | 1408 | header.version = cpu_to_be32(version); |
a9420734 KW |
1409 | header.cluster_bits = cpu_to_be32(cluster_bits); |
1410 | header.size = cpu_to_be64(0); | |
1411 | header.l1_table_offset = cpu_to_be64(0); | |
1412 | header.l1_size = cpu_to_be32(0); | |
1413 | header.refcount_table_offset = cpu_to_be64(cluster_size); | |
1414 | header.refcount_table_clusters = cpu_to_be32(1); | |
6744cbab KW |
1415 | header.refcount_order = cpu_to_be32(3 + REFCOUNT_SHIFT); |
1416 | header.header_length = cpu_to_be32(sizeof(header)); | |
a9420734 KW |
1417 | |
1418 | if (flags & BLOCK_FLAG_ENCRYPT) { | |
1419 | header.crypt_method = cpu_to_be32(QCOW_CRYPT_AES); | |
1420 | } else { | |
1421 | header.crypt_method = cpu_to_be32(QCOW_CRYPT_NONE); | |
1422 | } | |
1423 | ||
bfe8043e SH |
1424 | if (flags & BLOCK_FLAG_LAZY_REFCOUNTS) { |
1425 | header.compatible_features |= | |
1426 | cpu_to_be64(QCOW2_COMPAT_LAZY_REFCOUNTS); | |
1427 | } | |
1428 | ||
a9420734 KW |
1429 | ret = bdrv_pwrite(bs, 0, &header, sizeof(header)); |
1430 | if (ret < 0) { | |
3ef6c40a | 1431 | error_setg_errno(errp, -ret, "Could not write qcow2 header"); |
a9420734 KW |
1432 | goto out; |
1433 | } | |
1434 | ||
1435 | /* Write an empty refcount table */ | |
7267c094 | 1436 | refcount_table = g_malloc0(cluster_size); |
a9420734 | 1437 | ret = bdrv_pwrite(bs, cluster_size, refcount_table, cluster_size); |
7267c094 | 1438 | g_free(refcount_table); |
a9420734 KW |
1439 | |
1440 | if (ret < 0) { | |
3ef6c40a | 1441 | error_setg_errno(errp, -ret, "Could not write refcount table"); |
a9420734 KW |
1442 | goto out; |
1443 | } | |
1444 | ||
1445 | bdrv_close(bs); | |
1446 | ||
1447 | /* | |
1448 | * And now open the image and make it consistent first (i.e. increase the | |
1449 | * refcount of the cluster that is occupied by the header and the refcount | |
1450 | * table) | |
1451 | */ | |
1452 | BlockDriver* drv = bdrv_find_format("qcow2"); | |
1453 | assert(drv != NULL); | |
de9c0cec | 1454 | ret = bdrv_open(bs, filename, NULL, |
3ef6c40a | 1455 | BDRV_O_RDWR | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH, drv, &local_err); |
a9420734 | 1456 | if (ret < 0) { |
3ef6c40a | 1457 | error_propagate(errp, local_err); |
a9420734 KW |
1458 | goto out; |
1459 | } | |
1460 | ||
1461 | ret = qcow2_alloc_clusters(bs, 2 * cluster_size); | |
1462 | if (ret < 0) { | |
3ef6c40a MR |
1463 | error_setg_errno(errp, -ret, "Could not allocate clusters for qcow2 " |
1464 | "header and refcount table"); | |
a9420734 KW |
1465 | goto out; |
1466 | ||
1467 | } else if (ret != 0) { | |
1468 | error_report("Huh, first cluster in empty image is already in use?"); | |
1469 | abort(); | |
1470 | } | |
1471 | ||
1472 | /* Okay, now that we have a valid image, let's give it the right size */ | |
1473 | ret = bdrv_truncate(bs, total_size * BDRV_SECTOR_SIZE); | |
1474 | if (ret < 0) { | |
3ef6c40a | 1475 | error_setg_errno(errp, -ret, "Could not resize image"); |
a9420734 KW |
1476 | goto out; |
1477 | } | |
1478 | ||
1479 | /* Want a backing file? There you go.*/ | |
1480 | if (backing_file) { | |
1481 | ret = bdrv_change_backing_file(bs, backing_file, backing_format); | |
1482 | if (ret < 0) { | |
3ef6c40a MR |
1483 | error_setg_errno(errp, -ret, "Could not assign backing file '%s' " |
1484 | "with format '%s'", backing_file, backing_format); | |
a9420734 KW |
1485 | goto out; |
1486 | } | |
1487 | } | |
1488 | ||
1489 | /* And if we're supposed to preallocate metadata, do that now */ | |
1490 | if (prealloc) { | |
15552c4a ZYW |
1491 | BDRVQcowState *s = bs->opaque; |
1492 | qemu_co_mutex_lock(&s->lock); | |
a9420734 | 1493 | ret = preallocate(bs); |
15552c4a | 1494 | qemu_co_mutex_unlock(&s->lock); |
a9420734 | 1495 | if (ret < 0) { |
3ef6c40a | 1496 | error_setg_errno(errp, -ret, "Could not preallocate metadata"); |
a9420734 KW |
1497 | goto out; |
1498 | } | |
1499 | } | |
1500 | ||
1501 | ret = 0; | |
1502 | out: | |
4f6fd349 | 1503 | bdrv_unref(bs); |
a9420734 KW |
1504 | return ret; |
1505 | } | |
de5f3f40 | 1506 | |
d5124c00 MR |
1507 | static int qcow2_create(const char *filename, QEMUOptionParameter *options, |
1508 | Error **errp) | |
de5f3f40 KW |
1509 | { |
1510 | const char *backing_file = NULL; | |
1511 | const char *backing_fmt = NULL; | |
1512 | uint64_t sectors = 0; | |
1513 | int flags = 0; | |
99cce9fa | 1514 | size_t cluster_size = DEFAULT_CLUSTER_SIZE; |
de5f3f40 | 1515 | int prealloc = 0; |
8ad1898c | 1516 | int version = 3; |
3ef6c40a MR |
1517 | Error *local_err = NULL; |
1518 | int ret; | |
de5f3f40 KW |
1519 | |
1520 | /* Read out options */ | |
1521 | while (options && options->name) { | |
1522 | if (!strcmp(options->name, BLOCK_OPT_SIZE)) { | |
1523 | sectors = options->value.n / 512; | |
1524 | } else if (!strcmp(options->name, BLOCK_OPT_BACKING_FILE)) { | |
1525 | backing_file = options->value.s; | |
1526 | } else if (!strcmp(options->name, BLOCK_OPT_BACKING_FMT)) { | |
1527 | backing_fmt = options->value.s; | |
1528 | } else if (!strcmp(options->name, BLOCK_OPT_ENCRYPT)) { | |
1529 | flags |= options->value.n ? BLOCK_FLAG_ENCRYPT : 0; | |
1530 | } else if (!strcmp(options->name, BLOCK_OPT_CLUSTER_SIZE)) { | |
1531 | if (options->value.n) { | |
1532 | cluster_size = options->value.n; | |
1533 | } | |
1534 | } else if (!strcmp(options->name, BLOCK_OPT_PREALLOC)) { | |
1535 | if (!options->value.s || !strcmp(options->value.s, "off")) { | |
1536 | prealloc = 0; | |
1537 | } else if (!strcmp(options->value.s, "metadata")) { | |
1538 | prealloc = 1; | |
1539 | } else { | |
3ef6c40a MR |
1540 | error_setg(errp, "Invalid preallocation mode: '%s'", |
1541 | options->value.s); | |
de5f3f40 KW |
1542 | return -EINVAL; |
1543 | } | |
6744cbab | 1544 | } else if (!strcmp(options->name, BLOCK_OPT_COMPAT_LEVEL)) { |
9117b477 KW |
1545 | if (!options->value.s) { |
1546 | /* keep the default */ | |
1547 | } else if (!strcmp(options->value.s, "0.10")) { | |
6744cbab KW |
1548 | version = 2; |
1549 | } else if (!strcmp(options->value.s, "1.1")) { | |
1550 | version = 3; | |
1551 | } else { | |
3ef6c40a MR |
1552 | error_setg(errp, "Invalid compatibility level: '%s'", |
1553 | options->value.s); | |
6744cbab KW |
1554 | return -EINVAL; |
1555 | } | |
bfe8043e SH |
1556 | } else if (!strcmp(options->name, BLOCK_OPT_LAZY_REFCOUNTS)) { |
1557 | flags |= options->value.n ? BLOCK_FLAG_LAZY_REFCOUNTS : 0; | |
de5f3f40 KW |
1558 | } |
1559 | options++; | |
1560 | } | |
1561 | ||
1562 | if (backing_file && prealloc) { | |
3ef6c40a MR |
1563 | error_setg(errp, "Backing file and preallocation cannot be used at " |
1564 | "the same time"); | |
de5f3f40 KW |
1565 | return -EINVAL; |
1566 | } | |
1567 | ||
bfe8043e | 1568 | if (version < 3 && (flags & BLOCK_FLAG_LAZY_REFCOUNTS)) { |
3ef6c40a MR |
1569 | error_setg(errp, "Lazy refcounts only supported with compatibility " |
1570 | "level 1.1 and above (use compat=1.1 or greater)"); | |
bfe8043e SH |
1571 | return -EINVAL; |
1572 | } | |
1573 | ||
3ef6c40a MR |
1574 | ret = qcow2_create2(filename, sectors, backing_file, backing_fmt, flags, |
1575 | cluster_size, prealloc, options, version, &local_err); | |
1576 | if (error_is_set(&local_err)) { | |
1577 | error_propagate(errp, local_err); | |
1578 | } | |
1579 | return ret; | |
de5f3f40 KW |
1580 | } |
1581 | ||
7c80ab3f | 1582 | static int qcow2_make_empty(BlockDriverState *bs) |
20d97356 BS |
1583 | { |
1584 | #if 0 | |
1585 | /* XXX: not correct */ | |
1586 | BDRVQcowState *s = bs->opaque; | |
1587 | uint32_t l1_length = s->l1_size * sizeof(uint64_t); | |
1588 | int ret; | |
1589 | ||
1590 | memset(s->l1_table, 0, l1_length); | |
66f82cee | 1591 | if (bdrv_pwrite(bs->file, s->l1_table_offset, s->l1_table, l1_length) < 0) |
20d97356 | 1592 | return -1; |
66f82cee | 1593 | ret = bdrv_truncate(bs->file, s->l1_table_offset + l1_length); |
20d97356 BS |
1594 | if (ret < 0) |
1595 | return ret; | |
1596 | ||
1597 | l2_cache_reset(bs); | |
1598 | #endif | |
1599 | return 0; | |
1600 | } | |
1601 | ||
621f0589 KW |
1602 | static coroutine_fn int qcow2_co_write_zeroes(BlockDriverState *bs, |
1603 | int64_t sector_num, int nb_sectors) | |
1604 | { | |
1605 | int ret; | |
1606 | BDRVQcowState *s = bs->opaque; | |
1607 | ||
1608 | /* Emulate misaligned zero writes */ | |
1609 | if (sector_num % s->cluster_sectors || nb_sectors % s->cluster_sectors) { | |
1610 | return -ENOTSUP; | |
1611 | } | |
1612 | ||
1613 | /* Whatever is left can use real zero clusters */ | |
1614 | qemu_co_mutex_lock(&s->lock); | |
1615 | ret = qcow2_zero_clusters(bs, sector_num << BDRV_SECTOR_BITS, | |
1616 | nb_sectors); | |
1617 | qemu_co_mutex_unlock(&s->lock); | |
1618 | ||
1619 | return ret; | |
1620 | } | |
1621 | ||
6db39ae2 PB |
1622 | static coroutine_fn int qcow2_co_discard(BlockDriverState *bs, |
1623 | int64_t sector_num, int nb_sectors) | |
5ea929e3 | 1624 | { |
6db39ae2 PB |
1625 | int ret; |
1626 | BDRVQcowState *s = bs->opaque; | |
1627 | ||
1628 | qemu_co_mutex_lock(&s->lock); | |
1629 | ret = qcow2_discard_clusters(bs, sector_num << BDRV_SECTOR_BITS, | |
670df5e3 | 1630 | nb_sectors, QCOW2_DISCARD_REQUEST); |
6db39ae2 PB |
1631 | qemu_co_mutex_unlock(&s->lock); |
1632 | return ret; | |
5ea929e3 KW |
1633 | } |
1634 | ||
419b19d9 SH |
1635 | static int qcow2_truncate(BlockDriverState *bs, int64_t offset) |
1636 | { | |
1637 | BDRVQcowState *s = bs->opaque; | |
2cf7cfa1 KW |
1638 | int64_t new_l1_size; |
1639 | int ret; | |
419b19d9 SH |
1640 | |
1641 | if (offset & 511) { | |
259b2173 | 1642 | error_report("The new size must be a multiple of 512"); |
419b19d9 SH |
1643 | return -EINVAL; |
1644 | } | |
1645 | ||
1646 | /* cannot proceed if image has snapshots */ | |
1647 | if (s->nb_snapshots) { | |
259b2173 | 1648 | error_report("Can't resize an image which has snapshots"); |
419b19d9 SH |
1649 | return -ENOTSUP; |
1650 | } | |
1651 | ||
1652 | /* shrinking is currently not supported */ | |
1653 | if (offset < bs->total_sectors * 512) { | |
259b2173 | 1654 | error_report("qcow2 doesn't support shrinking images yet"); |
419b19d9 SH |
1655 | return -ENOTSUP; |
1656 | } | |
1657 | ||
1658 | new_l1_size = size_to_l1(s, offset); | |
72893756 | 1659 | ret = qcow2_grow_l1_table(bs, new_l1_size, true); |
419b19d9 SH |
1660 | if (ret < 0) { |
1661 | return ret; | |
1662 | } | |
1663 | ||
1664 | /* write updated header.size */ | |
1665 | offset = cpu_to_be64(offset); | |
8b3b7206 KW |
1666 | ret = bdrv_pwrite_sync(bs->file, offsetof(QCowHeader, size), |
1667 | &offset, sizeof(uint64_t)); | |
419b19d9 SH |
1668 | if (ret < 0) { |
1669 | return ret; | |
1670 | } | |
1671 | ||
1672 | s->l1_vm_state_index = new_l1_size; | |
1673 | return 0; | |
1674 | } | |
1675 | ||
20d97356 BS |
1676 | /* XXX: put compressed sectors first, then all the cluster aligned |
1677 | tables to avoid losing bytes in alignment */ | |
7c80ab3f JS |
1678 | static int qcow2_write_compressed(BlockDriverState *bs, int64_t sector_num, |
1679 | const uint8_t *buf, int nb_sectors) | |
20d97356 BS |
1680 | { |
1681 | BDRVQcowState *s = bs->opaque; | |
1682 | z_stream strm; | |
1683 | int ret, out_len; | |
1684 | uint8_t *out_buf; | |
1685 | uint64_t cluster_offset; | |
1686 | ||
1687 | if (nb_sectors == 0) { | |
1688 | /* align end of file to a sector boundary to ease reading with | |
1689 | sector based I/Os */ | |
66f82cee | 1690 | cluster_offset = bdrv_getlength(bs->file); |
20d97356 | 1691 | cluster_offset = (cluster_offset + 511) & ~511; |
66f82cee | 1692 | bdrv_truncate(bs->file, cluster_offset); |
20d97356 BS |
1693 | return 0; |
1694 | } | |
1695 | ||
f4d38bef SH |
1696 | if (nb_sectors != s->cluster_sectors) { |
1697 | ret = -EINVAL; | |
1698 | ||
1699 | /* Zero-pad last write if image size is not cluster aligned */ | |
1700 | if (sector_num + nb_sectors == bs->total_sectors && | |
1701 | nb_sectors < s->cluster_sectors) { | |
1702 | uint8_t *pad_buf = qemu_blockalign(bs, s->cluster_size); | |
1703 | memset(pad_buf, 0, s->cluster_size); | |
1704 | memcpy(pad_buf, buf, nb_sectors * BDRV_SECTOR_SIZE); | |
1705 | ret = qcow2_write_compressed(bs, sector_num, | |
1706 | pad_buf, s->cluster_sectors); | |
1707 | qemu_vfree(pad_buf); | |
1708 | } | |
1709 | return ret; | |
1710 | } | |
20d97356 | 1711 | |
7267c094 | 1712 | out_buf = g_malloc(s->cluster_size + (s->cluster_size / 1000) + 128); |
20d97356 BS |
1713 | |
1714 | /* best compression, small window, no zlib header */ | |
1715 | memset(&strm, 0, sizeof(strm)); | |
1716 | ret = deflateInit2(&strm, Z_DEFAULT_COMPRESSION, | |
1717 | Z_DEFLATED, -12, | |
1718 | 9, Z_DEFAULT_STRATEGY); | |
1719 | if (ret != 0) { | |
8f1efd00 KW |
1720 | ret = -EINVAL; |
1721 | goto fail; | |
20d97356 BS |
1722 | } |
1723 | ||
1724 | strm.avail_in = s->cluster_size; | |
1725 | strm.next_in = (uint8_t *)buf; | |
1726 | strm.avail_out = s->cluster_size; | |
1727 | strm.next_out = out_buf; | |
1728 | ||
1729 | ret = deflate(&strm, Z_FINISH); | |
1730 | if (ret != Z_STREAM_END && ret != Z_OK) { | |
20d97356 | 1731 | deflateEnd(&strm); |
8f1efd00 KW |
1732 | ret = -EINVAL; |
1733 | goto fail; | |
20d97356 BS |
1734 | } |
1735 | out_len = strm.next_out - out_buf; | |
1736 | ||
1737 | deflateEnd(&strm); | |
1738 | ||
1739 | if (ret != Z_STREAM_END || out_len >= s->cluster_size) { | |
1740 | /* could not compress: write normal cluster */ | |
cf93980e MR |
1741 | |
1742 | ret = qcow2_pre_write_overlap_check(bs, QCOW2_OL_DEFAULT, | |
1743 | sector_num * BDRV_SECTOR_SIZE, | |
1744 | s->cluster_sectors * BDRV_SECTOR_SIZE); | |
1745 | if (ret < 0) { | |
1746 | goto fail; | |
1747 | } | |
1748 | ||
8f1efd00 KW |
1749 | ret = bdrv_write(bs, sector_num, buf, s->cluster_sectors); |
1750 | if (ret < 0) { | |
1751 | goto fail; | |
1752 | } | |
20d97356 BS |
1753 | } else { |
1754 | cluster_offset = qcow2_alloc_compressed_cluster_offset(bs, | |
1755 | sector_num << 9, out_len); | |
8f1efd00 KW |
1756 | if (!cluster_offset) { |
1757 | ret = -EIO; | |
1758 | goto fail; | |
1759 | } | |
20d97356 | 1760 | cluster_offset &= s->cluster_offset_mask; |
cf93980e MR |
1761 | |
1762 | ret = qcow2_pre_write_overlap_check(bs, QCOW2_OL_DEFAULT, | |
1763 | cluster_offset, out_len); | |
1764 | if (ret < 0) { | |
1765 | goto fail; | |
1766 | } | |
1767 | ||
66f82cee | 1768 | BLKDBG_EVENT(bs->file, BLKDBG_WRITE_COMPRESSED); |
8f1efd00 KW |
1769 | ret = bdrv_pwrite(bs->file, cluster_offset, out_buf, out_len); |
1770 | if (ret < 0) { | |
1771 | goto fail; | |
20d97356 BS |
1772 | } |
1773 | } | |
1774 | ||
8f1efd00 KW |
1775 | ret = 0; |
1776 | fail: | |
7267c094 | 1777 | g_free(out_buf); |
8f1efd00 | 1778 | return ret; |
20d97356 BS |
1779 | } |
1780 | ||
a968168c | 1781 | static coroutine_fn int qcow2_co_flush_to_os(BlockDriverState *bs) |
20d97356 | 1782 | { |
29c1a730 KW |
1783 | BDRVQcowState *s = bs->opaque; |
1784 | int ret; | |
1785 | ||
8b94ff85 | 1786 | qemu_co_mutex_lock(&s->lock); |
29c1a730 KW |
1787 | ret = qcow2_cache_flush(bs, s->l2_table_cache); |
1788 | if (ret < 0) { | |
c95de7e2 | 1789 | qemu_co_mutex_unlock(&s->lock); |
8b94ff85 | 1790 | return ret; |
29c1a730 KW |
1791 | } |
1792 | ||
bfe8043e SH |
1793 | if (qcow2_need_accurate_refcounts(s)) { |
1794 | ret = qcow2_cache_flush(bs, s->refcount_block_cache); | |
1795 | if (ret < 0) { | |
1796 | qemu_co_mutex_unlock(&s->lock); | |
1797 | return ret; | |
1798 | } | |
29c1a730 | 1799 | } |
8b94ff85 | 1800 | qemu_co_mutex_unlock(&s->lock); |
29c1a730 | 1801 | |
eb489bb1 KW |
1802 | return 0; |
1803 | } | |
1804 | ||
7c80ab3f | 1805 | static int qcow2_get_info(BlockDriverState *bs, BlockDriverInfo *bdi) |
20d97356 BS |
1806 | { |
1807 | BDRVQcowState *s = bs->opaque; | |
1808 | bdi->cluster_size = s->cluster_size; | |
7c80ab3f | 1809 | bdi->vm_state_offset = qcow2_vm_state_offset(s); |
20d97356 BS |
1810 | return 0; |
1811 | } | |
1812 | ||
20d97356 BS |
1813 | #if 0 |
1814 | static void dump_refcounts(BlockDriverState *bs) | |
1815 | { | |
1816 | BDRVQcowState *s = bs->opaque; | |
1817 | int64_t nb_clusters, k, k1, size; | |
1818 | int refcount; | |
1819 | ||
66f82cee | 1820 | size = bdrv_getlength(bs->file); |
20d97356 BS |
1821 | nb_clusters = size_to_clusters(s, size); |
1822 | for(k = 0; k < nb_clusters;) { | |
1823 | k1 = k; | |
1824 | refcount = get_refcount(bs, k); | |
1825 | k++; | |
1826 | while (k < nb_clusters && get_refcount(bs, k) == refcount) | |
1827 | k++; | |
0bfcd599 BS |
1828 | printf("%" PRId64 ": refcount=%d nb=%" PRId64 "\n", k, refcount, |
1829 | k - k1); | |
20d97356 BS |
1830 | } |
1831 | } | |
1832 | #endif | |
1833 | ||
cf8074b3 KW |
1834 | static int qcow2_save_vmstate(BlockDriverState *bs, QEMUIOVector *qiov, |
1835 | int64_t pos) | |
20d97356 BS |
1836 | { |
1837 | BDRVQcowState *s = bs->opaque; | |
1838 | int growable = bs->growable; | |
1839 | int ret; | |
1840 | ||
66f82cee | 1841 | BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_SAVE); |
20d97356 | 1842 | bs->growable = 1; |
8d3b1a2d | 1843 | ret = bdrv_pwritev(bs, qcow2_vm_state_offset(s) + pos, qiov); |
20d97356 BS |
1844 | bs->growable = growable; |
1845 | ||
1846 | return ret; | |
1847 | } | |
1848 | ||
7c80ab3f JS |
1849 | static int qcow2_load_vmstate(BlockDriverState *bs, uint8_t *buf, |
1850 | int64_t pos, int size) | |
20d97356 BS |
1851 | { |
1852 | BDRVQcowState *s = bs->opaque; | |
1853 | int growable = bs->growable; | |
0d51b4de | 1854 | bool zero_beyond_eof = bs->zero_beyond_eof; |
20d97356 BS |
1855 | int ret; |
1856 | ||
66f82cee | 1857 | BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_LOAD); |
20d97356 | 1858 | bs->growable = 1; |
0d51b4de | 1859 | bs->zero_beyond_eof = false; |
7c80ab3f | 1860 | ret = bdrv_pread(bs, qcow2_vm_state_offset(s) + pos, buf, size); |
20d97356 | 1861 | bs->growable = growable; |
0d51b4de | 1862 | bs->zero_beyond_eof = zero_beyond_eof; |
20d97356 BS |
1863 | |
1864 | return ret; | |
1865 | } | |
1866 | ||
9296b3ed MR |
1867 | /* |
1868 | * Downgrades an image's version. To achieve this, any incompatible features | |
1869 | * have to be removed. | |
1870 | */ | |
1871 | static int qcow2_downgrade(BlockDriverState *bs, int target_version) | |
1872 | { | |
1873 | BDRVQcowState *s = bs->opaque; | |
1874 | int current_version = s->qcow_version; | |
1875 | int ret; | |
1876 | ||
1877 | if (target_version == current_version) { | |
1878 | return 0; | |
1879 | } else if (target_version > current_version) { | |
1880 | return -EINVAL; | |
1881 | } else if (target_version != 2) { | |
1882 | return -EINVAL; | |
1883 | } | |
1884 | ||
1885 | if (s->refcount_order != 4) { | |
1886 | /* we would have to convert the image to a refcount_order == 4 image | |
1887 | * here; however, since qemu (at the time of writing this) does not | |
1888 | * support anything different than 4 anyway, there is no point in doing | |
1889 | * so right now; however, we should error out (if qemu supports this in | |
1890 | * the future and this code has not been adapted) */ | |
1891 | error_report("qcow2_downgrade: Image refcount orders other than 4 are" | |
1892 | "currently not supported."); | |
1893 | return -ENOTSUP; | |
1894 | } | |
1895 | ||
1896 | /* clear incompatible features */ | |
1897 | if (s->incompatible_features & QCOW2_INCOMPAT_DIRTY) { | |
1898 | ret = qcow2_mark_clean(bs); | |
1899 | if (ret < 0) { | |
1900 | return ret; | |
1901 | } | |
1902 | } | |
1903 | ||
1904 | /* with QCOW2_INCOMPAT_CORRUPT, it is pretty much impossible to get here in | |
1905 | * the first place; if that happens nonetheless, returning -ENOTSUP is the | |
1906 | * best thing to do anyway */ | |
1907 | ||
1908 | if (s->incompatible_features) { | |
1909 | return -ENOTSUP; | |
1910 | } | |
1911 | ||
1912 | /* since we can ignore compatible features, we can set them to 0 as well */ | |
1913 | s->compatible_features = 0; | |
1914 | /* if lazy refcounts have been used, they have already been fixed through | |
1915 | * clearing the dirty flag */ | |
1916 | ||
1917 | /* clearing autoclear features is trivial */ | |
1918 | s->autoclear_features = 0; | |
1919 | ||
1920 | ret = qcow2_expand_zero_clusters(bs); | |
1921 | if (ret < 0) { | |
1922 | return ret; | |
1923 | } | |
1924 | ||
1925 | s->qcow_version = target_version; | |
1926 | ret = qcow2_update_header(bs); | |
1927 | if (ret < 0) { | |
1928 | s->qcow_version = current_version; | |
1929 | return ret; | |
1930 | } | |
1931 | return 0; | |
1932 | } | |
1933 | ||
1934 | static int qcow2_amend_options(BlockDriverState *bs, | |
1935 | QEMUOptionParameter *options) | |
1936 | { | |
1937 | BDRVQcowState *s = bs->opaque; | |
1938 | int old_version = s->qcow_version, new_version = old_version; | |
1939 | uint64_t new_size = 0; | |
1940 | const char *backing_file = NULL, *backing_format = NULL; | |
1941 | bool lazy_refcounts = s->use_lazy_refcounts; | |
1942 | int ret; | |
1943 | int i; | |
1944 | ||
1945 | for (i = 0; options[i].name; i++) | |
1946 | { | |
1947 | if (!options[i].assigned) { | |
1948 | /* only change explicitly defined options */ | |
1949 | continue; | |
1950 | } | |
1951 | ||
1952 | if (!strcmp(options[i].name, "compat")) { | |
1953 | if (!options[i].value.s) { | |
1954 | /* preserve default */ | |
1955 | } else if (!strcmp(options[i].value.s, "0.10")) { | |
1956 | new_version = 2; | |
1957 | } else if (!strcmp(options[i].value.s, "1.1")) { | |
1958 | new_version = 3; | |
1959 | } else { | |
1960 | fprintf(stderr, "Unknown compatibility level %s.\n", | |
1961 | options[i].value.s); | |
1962 | return -EINVAL; | |
1963 | } | |
1964 | } else if (!strcmp(options[i].name, "preallocation")) { | |
1965 | fprintf(stderr, "Cannot change preallocation mode.\n"); | |
1966 | return -ENOTSUP; | |
1967 | } else if (!strcmp(options[i].name, "size")) { | |
1968 | new_size = options[i].value.n; | |
1969 | } else if (!strcmp(options[i].name, "backing_file")) { | |
1970 | backing_file = options[i].value.s; | |
1971 | } else if (!strcmp(options[i].name, "backing_fmt")) { | |
1972 | backing_format = options[i].value.s; | |
1973 | } else if (!strcmp(options[i].name, "encryption")) { | |
1974 | if ((options[i].value.n != !!s->crypt_method)) { | |
1975 | fprintf(stderr, "Changing the encryption flag is not " | |
1976 | "supported.\n"); | |
1977 | return -ENOTSUP; | |
1978 | } | |
1979 | } else if (!strcmp(options[i].name, "cluster_size")) { | |
1980 | if (options[i].value.n != s->cluster_size) { | |
1981 | fprintf(stderr, "Changing the cluster size is not " | |
1982 | "supported.\n"); | |
1983 | return -ENOTSUP; | |
1984 | } | |
1985 | } else if (!strcmp(options[i].name, "lazy_refcounts")) { | |
1986 | lazy_refcounts = options[i].value.n; | |
1987 | } else { | |
1988 | /* if this assertion fails, this probably means a new option was | |
1989 | * added without having it covered here */ | |
1990 | assert(false); | |
1991 | } | |
1992 | } | |
1993 | ||
1994 | if (new_version != old_version) { | |
1995 | if (new_version > old_version) { | |
1996 | /* Upgrade */ | |
1997 | s->qcow_version = new_version; | |
1998 | ret = qcow2_update_header(bs); | |
1999 | if (ret < 0) { | |
2000 | s->qcow_version = old_version; | |
2001 | return ret; | |
2002 | } | |
2003 | } else { | |
2004 | ret = qcow2_downgrade(bs, new_version); | |
2005 | if (ret < 0) { | |
2006 | return ret; | |
2007 | } | |
2008 | } | |
2009 | } | |
2010 | ||
2011 | if (backing_file || backing_format) { | |
2012 | ret = qcow2_change_backing_file(bs, backing_file ?: bs->backing_file, | |
2013 | backing_format ?: bs->backing_format); | |
2014 | if (ret < 0) { | |
2015 | return ret; | |
2016 | } | |
2017 | } | |
2018 | ||
2019 | if (s->use_lazy_refcounts != lazy_refcounts) { | |
2020 | if (lazy_refcounts) { | |
2021 | if (s->qcow_version < 3) { | |
2022 | fprintf(stderr, "Lazy refcounts only supported with compatibility " | |
2023 | "level 1.1 and above (use compat=1.1 or greater)\n"); | |
2024 | return -EINVAL; | |
2025 | } | |
2026 | s->compatible_features |= QCOW2_COMPAT_LAZY_REFCOUNTS; | |
2027 | ret = qcow2_update_header(bs); | |
2028 | if (ret < 0) { | |
2029 | s->compatible_features &= ~QCOW2_COMPAT_LAZY_REFCOUNTS; | |
2030 | return ret; | |
2031 | } | |
2032 | s->use_lazy_refcounts = true; | |
2033 | } else { | |
2034 | /* make image clean first */ | |
2035 | ret = qcow2_mark_clean(bs); | |
2036 | if (ret < 0) { | |
2037 | return ret; | |
2038 | } | |
2039 | /* now disallow lazy refcounts */ | |
2040 | s->compatible_features &= ~QCOW2_COMPAT_LAZY_REFCOUNTS; | |
2041 | ret = qcow2_update_header(bs); | |
2042 | if (ret < 0) { | |
2043 | s->compatible_features |= QCOW2_COMPAT_LAZY_REFCOUNTS; | |
2044 | return ret; | |
2045 | } | |
2046 | s->use_lazy_refcounts = false; | |
2047 | } | |
2048 | } | |
2049 | ||
2050 | if (new_size) { | |
2051 | ret = bdrv_truncate(bs, new_size); | |
2052 | if (ret < 0) { | |
2053 | return ret; | |
2054 | } | |
2055 | } | |
2056 | ||
2057 | return 0; | |
2058 | } | |
2059 | ||
7c80ab3f | 2060 | static QEMUOptionParameter qcow2_create_options[] = { |
20d97356 BS |
2061 | { |
2062 | .name = BLOCK_OPT_SIZE, | |
2063 | .type = OPT_SIZE, | |
2064 | .help = "Virtual disk size" | |
2065 | }, | |
6744cbab KW |
2066 | { |
2067 | .name = BLOCK_OPT_COMPAT_LEVEL, | |
2068 | .type = OPT_STRING, | |
2069 | .help = "Compatibility level (0.10 or 1.1)" | |
2070 | }, | |
20d97356 BS |
2071 | { |
2072 | .name = BLOCK_OPT_BACKING_FILE, | |
2073 | .type = OPT_STRING, | |
2074 | .help = "File name of a base image" | |
2075 | }, | |
2076 | { | |
2077 | .name = BLOCK_OPT_BACKING_FMT, | |
2078 | .type = OPT_STRING, | |
2079 | .help = "Image format of the base image" | |
2080 | }, | |
2081 | { | |
2082 | .name = BLOCK_OPT_ENCRYPT, | |
2083 | .type = OPT_FLAG, | |
2084 | .help = "Encrypt the image" | |
2085 | }, | |
2086 | { | |
2087 | .name = BLOCK_OPT_CLUSTER_SIZE, | |
2088 | .type = OPT_SIZE, | |
99cce9fa KW |
2089 | .help = "qcow2 cluster size", |
2090 | .value = { .n = DEFAULT_CLUSTER_SIZE }, | |
20d97356 BS |
2091 | }, |
2092 | { | |
2093 | .name = BLOCK_OPT_PREALLOC, | |
2094 | .type = OPT_STRING, | |
2095 | .help = "Preallocation mode (allowed values: off, metadata)" | |
2096 | }, | |
bfe8043e SH |
2097 | { |
2098 | .name = BLOCK_OPT_LAZY_REFCOUNTS, | |
2099 | .type = OPT_FLAG, | |
2100 | .help = "Postpone refcount updates", | |
2101 | }, | |
20d97356 BS |
2102 | { NULL } |
2103 | }; | |
2104 | ||
2105 | static BlockDriver bdrv_qcow2 = { | |
7c80ab3f JS |
2106 | .format_name = "qcow2", |
2107 | .instance_size = sizeof(BDRVQcowState), | |
2108 | .bdrv_probe = qcow2_probe, | |
2109 | .bdrv_open = qcow2_open, | |
2110 | .bdrv_close = qcow2_close, | |
21d82ac9 | 2111 | .bdrv_reopen_prepare = qcow2_reopen_prepare, |
7c80ab3f | 2112 | .bdrv_create = qcow2_create, |
3ac21627 | 2113 | .bdrv_has_zero_init = bdrv_has_zero_init_1, |
b6b8a333 | 2114 | .bdrv_co_get_block_status = qcow2_co_get_block_status, |
7c80ab3f JS |
2115 | .bdrv_set_key = qcow2_set_key, |
2116 | .bdrv_make_empty = qcow2_make_empty, | |
2117 | ||
c68b89ac KW |
2118 | .bdrv_co_readv = qcow2_co_readv, |
2119 | .bdrv_co_writev = qcow2_co_writev, | |
eb489bb1 | 2120 | .bdrv_co_flush_to_os = qcow2_co_flush_to_os, |
419b19d9 | 2121 | |
621f0589 | 2122 | .bdrv_co_write_zeroes = qcow2_co_write_zeroes, |
6db39ae2 | 2123 | .bdrv_co_discard = qcow2_co_discard, |
419b19d9 | 2124 | .bdrv_truncate = qcow2_truncate, |
7c80ab3f | 2125 | .bdrv_write_compressed = qcow2_write_compressed, |
20d97356 BS |
2126 | |
2127 | .bdrv_snapshot_create = qcow2_snapshot_create, | |
2128 | .bdrv_snapshot_goto = qcow2_snapshot_goto, | |
2129 | .bdrv_snapshot_delete = qcow2_snapshot_delete, | |
2130 | .bdrv_snapshot_list = qcow2_snapshot_list, | |
51ef6727 | 2131 | .bdrv_snapshot_load_tmp = qcow2_snapshot_load_tmp, |
7c80ab3f | 2132 | .bdrv_get_info = qcow2_get_info, |
20d97356 | 2133 | |
7c80ab3f JS |
2134 | .bdrv_save_vmstate = qcow2_save_vmstate, |
2135 | .bdrv_load_vmstate = qcow2_load_vmstate, | |
20d97356 BS |
2136 | |
2137 | .bdrv_change_backing_file = qcow2_change_backing_file, | |
2138 | ||
06d9260f AL |
2139 | .bdrv_invalidate_cache = qcow2_invalidate_cache, |
2140 | ||
7c80ab3f JS |
2141 | .create_options = qcow2_create_options, |
2142 | .bdrv_check = qcow2_check, | |
9296b3ed | 2143 | .bdrv_amend_options = qcow2_amend_options, |
20d97356 BS |
2144 | }; |
2145 | ||
5efa9d5a AL |
2146 | static void bdrv_qcow2_init(void) |
2147 | { | |
2148 | bdrv_register(&bdrv_qcow2); | |
2149 | } | |
2150 | ||
2151 | block_init(bdrv_qcow2_init); |