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