]>
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" |
585f8587 | 25 | #include "block_int.h" |
5efa9d5a | 26 | #include "module.h" |
585f8587 FB |
27 | #include <zlib.h> |
28 | #include "aes.h" | |
f7d0fe02 | 29 | #include "block/qcow2.h" |
a9420734 | 30 | #include "qemu-error.h" |
e8cdcec1 | 31 | #include "qerror.h" |
3cce16f4 | 32 | #include "trace.h" |
585f8587 FB |
33 | |
34 | /* | |
35 | Differences with QCOW: | |
36 | ||
37 | - Support for multiple incremental snapshots. | |
38 | - Memory management by reference counts. | |
39 | - Clusters which have a reference count of one have the bit | |
40 | QCOW_OFLAG_COPIED to optimize write performance. | |
5fafdf24 | 41 | - Size of compressed clusters is stored in sectors to reduce bit usage |
585f8587 FB |
42 | in the cluster offsets. |
43 | - Support for storing additional data (such as the VM state) in the | |
3b46e624 | 44 | snapshots. |
585f8587 FB |
45 | - If a backing store is used, the cluster size is not constrained |
46 | (could be backported to QCOW). | |
47 | - L2 tables have always a size of one cluster. | |
48 | */ | |
49 | ||
9b80ddf3 AL |
50 | |
51 | typedef struct { | |
52 | uint32_t magic; | |
53 | uint32_t len; | |
54 | } QCowExtension; | |
7c80ab3f JS |
55 | #define QCOW2_EXT_MAGIC_END 0 |
56 | #define QCOW2_EXT_MAGIC_BACKING_FORMAT 0xE2792ACA | |
9b80ddf3 | 57 | |
7c80ab3f | 58 | static int qcow2_probe(const uint8_t *buf, int buf_size, const char *filename) |
585f8587 FB |
59 | { |
60 | const QCowHeader *cow_header = (const void *)buf; | |
3b46e624 | 61 | |
585f8587 FB |
62 | if (buf_size >= sizeof(QCowHeader) && |
63 | be32_to_cpu(cow_header->magic) == QCOW_MAGIC && | |
e8cdcec1 | 64 | be32_to_cpu(cow_header->version) >= QCOW_VERSION) |
585f8587 FB |
65 | return 100; |
66 | else | |
67 | return 0; | |
68 | } | |
69 | ||
9b80ddf3 AL |
70 | |
71 | /* | |
72 | * read qcow2 extension and fill bs | |
73 | * start reading from start_offset | |
74 | * finish reading upon magic of value 0 or when end_offset reached | |
75 | * unknown magic is skipped (future extension this version knows nothing about) | |
76 | * return 0 upon success, non-0 otherwise | |
77 | */ | |
7c80ab3f JS |
78 | static int qcow2_read_extensions(BlockDriverState *bs, uint64_t start_offset, |
79 | uint64_t end_offset) | |
9b80ddf3 | 80 | { |
75bab85c | 81 | BDRVQcowState *s = bs->opaque; |
9b80ddf3 AL |
82 | QCowExtension ext; |
83 | uint64_t offset; | |
75bab85c | 84 | int ret; |
9b80ddf3 AL |
85 | |
86 | #ifdef DEBUG_EXT | |
7c80ab3f | 87 | printf("qcow2_read_extensions: start=%ld end=%ld\n", start_offset, end_offset); |
9b80ddf3 AL |
88 | #endif |
89 | offset = start_offset; | |
90 | while (offset < end_offset) { | |
91 | ||
92 | #ifdef DEBUG_EXT | |
93 | /* Sanity check */ | |
94 | if (offset > s->cluster_size) | |
7c80ab3f | 95 | printf("qcow2_read_extension: suspicious offset %lu\n", offset); |
9b80ddf3 | 96 | |
9b2260cb | 97 | printf("attempting to read extended header in offset %lu\n", offset); |
9b80ddf3 AL |
98 | #endif |
99 | ||
66f82cee | 100 | if (bdrv_pread(bs->file, offset, &ext, sizeof(ext)) != sizeof(ext)) { |
7c80ab3f | 101 | fprintf(stderr, "qcow2_read_extension: ERROR: " |
0bfcd599 BS |
102 | "pread fail from offset %" PRIu64 "\n", |
103 | offset); | |
9b80ddf3 AL |
104 | return 1; |
105 | } | |
106 | be32_to_cpus(&ext.magic); | |
107 | be32_to_cpus(&ext.len); | |
108 | offset += sizeof(ext); | |
109 | #ifdef DEBUG_EXT | |
110 | printf("ext.magic = 0x%x\n", ext.magic); | |
111 | #endif | |
64ca6aee KW |
112 | if (ext.len > end_offset - offset) { |
113 | error_report("Header extension too large"); | |
114 | return -EINVAL; | |
115 | } | |
116 | ||
9b80ddf3 | 117 | switch (ext.magic) { |
7c80ab3f | 118 | case QCOW2_EXT_MAGIC_END: |
9b80ddf3 | 119 | return 0; |
f965509c | 120 | |
7c80ab3f | 121 | case QCOW2_EXT_MAGIC_BACKING_FORMAT: |
f965509c AL |
122 | if (ext.len >= sizeof(bs->backing_format)) { |
123 | fprintf(stderr, "ERROR: ext_backing_format: len=%u too large" | |
4c978075 | 124 | " (>=%zu)\n", |
f965509c AL |
125 | ext.len, sizeof(bs->backing_format)); |
126 | return 2; | |
127 | } | |
66f82cee | 128 | if (bdrv_pread(bs->file, offset , bs->backing_format, |
f965509c AL |
129 | ext.len) != ext.len) |
130 | return 3; | |
131 | bs->backing_format[ext.len] = '\0'; | |
132 | #ifdef DEBUG_EXT | |
133 | printf("Qcow2: Got format extension %s\n", bs->backing_format); | |
134 | #endif | |
f965509c AL |
135 | break; |
136 | ||
9b80ddf3 | 137 | default: |
75bab85c KW |
138 | /* unknown magic - save it in case we need to rewrite the header */ |
139 | { | |
140 | Qcow2UnknownHeaderExtension *uext; | |
141 | ||
142 | uext = g_malloc0(sizeof(*uext) + ext.len); | |
143 | uext->magic = ext.magic; | |
144 | uext->len = ext.len; | |
145 | QLIST_INSERT_HEAD(&s->unknown_header_ext, uext, next); | |
146 | ||
147 | ret = bdrv_pread(bs->file, offset , uext->data, uext->len); | |
148 | if (ret < 0) { | |
149 | return ret; | |
150 | } | |
75bab85c | 151 | } |
9b80ddf3 AL |
152 | break; |
153 | } | |
fd29b4bb KW |
154 | |
155 | offset += ((ext.len + 7) & ~7); | |
9b80ddf3 AL |
156 | } |
157 | ||
158 | return 0; | |
159 | } | |
160 | ||
75bab85c KW |
161 | static void cleanup_unknown_header_ext(BlockDriverState *bs) |
162 | { | |
163 | BDRVQcowState *s = bs->opaque; | |
164 | Qcow2UnknownHeaderExtension *uext, *next; | |
165 | ||
166 | QLIST_FOREACH_SAFE(uext, &s->unknown_header_ext, next, next) { | |
167 | QLIST_REMOVE(uext, next); | |
168 | g_free(uext); | |
169 | } | |
170 | } | |
9b80ddf3 | 171 | |
7c80ab3f | 172 | static int qcow2_open(BlockDriverState *bs, int flags) |
585f8587 FB |
173 | { |
174 | BDRVQcowState *s = bs->opaque; | |
6d85a57e | 175 | int len, i, ret = 0; |
585f8587 | 176 | QCowHeader header; |
9b80ddf3 | 177 | uint64_t ext_end; |
29c1a730 | 178 | bool writethrough; |
585f8587 | 179 | |
6d85a57e JS |
180 | ret = bdrv_pread(bs->file, 0, &header, sizeof(header)); |
181 | if (ret < 0) { | |
585f8587 | 182 | goto fail; |
6d85a57e | 183 | } |
585f8587 FB |
184 | be32_to_cpus(&header.magic); |
185 | be32_to_cpus(&header.version); | |
186 | be64_to_cpus(&header.backing_file_offset); | |
187 | be32_to_cpus(&header.backing_file_size); | |
188 | be64_to_cpus(&header.size); | |
189 | be32_to_cpus(&header.cluster_bits); | |
190 | be32_to_cpus(&header.crypt_method); | |
191 | be64_to_cpus(&header.l1_table_offset); | |
192 | be32_to_cpus(&header.l1_size); | |
193 | be64_to_cpus(&header.refcount_table_offset); | |
194 | be32_to_cpus(&header.refcount_table_clusters); | |
195 | be64_to_cpus(&header.snapshots_offset); | |
196 | be32_to_cpus(&header.nb_snapshots); | |
3b46e624 | 197 | |
e8cdcec1 | 198 | if (header.magic != QCOW_MAGIC) { |
6d85a57e | 199 | ret = -EINVAL; |
585f8587 | 200 | goto fail; |
6d85a57e | 201 | } |
e8cdcec1 KW |
202 | if (header.version != QCOW_VERSION) { |
203 | char version[64]; | |
204 | snprintf(version, sizeof(version), "QCOW version %d", header.version); | |
205 | qerror_report(QERR_UNKNOWN_BLOCK_FORMAT_FEATURE, | |
206 | bs->device_name, "qcow2", version); | |
207 | ret = -ENOTSUP; | |
208 | goto fail; | |
209 | } | |
d191d12d | 210 | if (header.cluster_bits < MIN_CLUSTER_BITS || |
6d85a57e JS |
211 | header.cluster_bits > MAX_CLUSTER_BITS) { |
212 | ret = -EINVAL; | |
585f8587 | 213 | goto fail; |
6d85a57e JS |
214 | } |
215 | if (header.crypt_method > QCOW_CRYPT_AES) { | |
216 | ret = -EINVAL; | |
585f8587 | 217 | goto fail; |
6d85a57e | 218 | } |
585f8587 | 219 | s->crypt_method_header = header.crypt_method; |
6d85a57e | 220 | if (s->crypt_method_header) { |
585f8587 | 221 | bs->encrypted = 1; |
6d85a57e | 222 | } |
585f8587 FB |
223 | s->cluster_bits = header.cluster_bits; |
224 | s->cluster_size = 1 << s->cluster_bits; | |
225 | s->cluster_sectors = 1 << (s->cluster_bits - 9); | |
226 | s->l2_bits = s->cluster_bits - 3; /* L2 is always one cluster */ | |
227 | s->l2_size = 1 << s->l2_bits; | |
228 | bs->total_sectors = header.size / 512; | |
229 | s->csize_shift = (62 - (s->cluster_bits - 8)); | |
230 | s->csize_mask = (1 << (s->cluster_bits - 8)) - 1; | |
231 | s->cluster_offset_mask = (1LL << s->csize_shift) - 1; | |
232 | s->refcount_table_offset = header.refcount_table_offset; | |
5fafdf24 | 233 | s->refcount_table_size = |
585f8587 FB |
234 | header.refcount_table_clusters << (s->cluster_bits - 3); |
235 | ||
236 | s->snapshots_offset = header.snapshots_offset; | |
237 | s->nb_snapshots = header.nb_snapshots; | |
238 | ||
239 | /* read the level 1 table */ | |
240 | s->l1_size = header.l1_size; | |
419b19d9 | 241 | s->l1_vm_state_index = size_to_l1(s, header.size); |
585f8587 FB |
242 | /* the L1 table must contain at least enough entries to put |
243 | header.size bytes */ | |
6d85a57e JS |
244 | if (s->l1_size < s->l1_vm_state_index) { |
245 | ret = -EINVAL; | |
585f8587 | 246 | goto fail; |
6d85a57e | 247 | } |
585f8587 | 248 | s->l1_table_offset = header.l1_table_offset; |
d191d12d | 249 | if (s->l1_size > 0) { |
7267c094 | 250 | s->l1_table = g_malloc0( |
d191d12d | 251 | align_offset(s->l1_size * sizeof(uint64_t), 512)); |
6d85a57e JS |
252 | ret = bdrv_pread(bs->file, s->l1_table_offset, s->l1_table, |
253 | s->l1_size * sizeof(uint64_t)); | |
254 | if (ret < 0) { | |
d191d12d | 255 | goto fail; |
6d85a57e | 256 | } |
d191d12d SW |
257 | for(i = 0;i < s->l1_size; i++) { |
258 | be64_to_cpus(&s->l1_table[i]); | |
259 | } | |
585f8587 | 260 | } |
29c1a730 KW |
261 | |
262 | /* alloc L2 table/refcount block cache */ | |
a6599793 | 263 | writethrough = ((flags & BDRV_O_CACHE_WB) == 0); |
29c1a730 KW |
264 | s->l2_table_cache = qcow2_cache_create(bs, L2_CACHE_SIZE, writethrough); |
265 | s->refcount_block_cache = qcow2_cache_create(bs, REFCOUNT_CACHE_SIZE, | |
266 | writethrough); | |
267 | ||
7267c094 | 268 | s->cluster_cache = g_malloc(s->cluster_size); |
585f8587 | 269 | /* one more sector for decompressed data alignment */ |
dea43a65 | 270 | s->cluster_data = qemu_blockalign(bs, QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size |
095a9c58 | 271 | + 512); |
585f8587 | 272 | s->cluster_cache_offset = -1; |
06d9260f | 273 | s->flags = flags; |
3b46e624 | 274 | |
6d85a57e JS |
275 | ret = qcow2_refcount_init(bs); |
276 | if (ret != 0) { | |
585f8587 | 277 | goto fail; |
6d85a57e | 278 | } |
585f8587 | 279 | |
72cf2d4f | 280 | QLIST_INIT(&s->cluster_allocs); |
f214978a | 281 | |
9b80ddf3 | 282 | /* read qcow2 extensions */ |
6d85a57e | 283 | if (header.backing_file_offset) { |
9b80ddf3 | 284 | ext_end = header.backing_file_offset; |
6d85a57e | 285 | } else { |
9b80ddf3 | 286 | ext_end = s->cluster_size; |
6d85a57e JS |
287 | } |
288 | if (qcow2_read_extensions(bs, sizeof(header), ext_end)) { | |
289 | ret = -EINVAL; | |
9b80ddf3 | 290 | goto fail; |
6d85a57e | 291 | } |
9b80ddf3 | 292 | |
585f8587 FB |
293 | /* read the backing file name */ |
294 | if (header.backing_file_offset != 0) { | |
295 | len = header.backing_file_size; | |
6d85a57e | 296 | if (len > 1023) { |
585f8587 | 297 | len = 1023; |
6d85a57e JS |
298 | } |
299 | ret = bdrv_pread(bs->file, header.backing_file_offset, | |
300 | bs->backing_file, len); | |
301 | if (ret < 0) { | |
585f8587 | 302 | goto fail; |
6d85a57e | 303 | } |
585f8587 FB |
304 | bs->backing_file[len] = '\0'; |
305 | } | |
42deb29f KW |
306 | |
307 | ret = qcow2_read_snapshots(bs); | |
308 | if (ret < 0) { | |
585f8587 | 309 | goto fail; |
6d85a57e | 310 | } |
585f8587 | 311 | |
68d100e9 KW |
312 | /* Initialise locks */ |
313 | qemu_co_mutex_init(&s->lock); | |
314 | ||
585f8587 | 315 | #ifdef DEBUG_ALLOC |
6cbc3031 PH |
316 | { |
317 | BdrvCheckResult result = {0}; | |
318 | qcow2_check_refcounts(bs, &result); | |
319 | } | |
585f8587 | 320 | #endif |
6d85a57e | 321 | return ret; |
585f8587 FB |
322 | |
323 | fail: | |
75bab85c | 324 | cleanup_unknown_header_ext(bs); |
ed6ccf0f KW |
325 | qcow2_free_snapshots(bs); |
326 | qcow2_refcount_close(bs); | |
7267c094 | 327 | g_free(s->l1_table); |
29c1a730 KW |
328 | if (s->l2_table_cache) { |
329 | qcow2_cache_destroy(bs, s->l2_table_cache); | |
330 | } | |
7267c094 | 331 | g_free(s->cluster_cache); |
dea43a65 | 332 | qemu_vfree(s->cluster_data); |
6d85a57e | 333 | return ret; |
585f8587 FB |
334 | } |
335 | ||
7c80ab3f | 336 | static int qcow2_set_key(BlockDriverState *bs, const char *key) |
585f8587 FB |
337 | { |
338 | BDRVQcowState *s = bs->opaque; | |
339 | uint8_t keybuf[16]; | |
340 | int len, i; | |
3b46e624 | 341 | |
585f8587 FB |
342 | memset(keybuf, 0, 16); |
343 | len = strlen(key); | |
344 | if (len > 16) | |
345 | len = 16; | |
346 | /* XXX: we could compress the chars to 7 bits to increase | |
347 | entropy */ | |
348 | for(i = 0;i < len;i++) { | |
349 | keybuf[i] = key[i]; | |
350 | } | |
351 | s->crypt_method = s->crypt_method_header; | |
352 | ||
353 | if (AES_set_encrypt_key(keybuf, 128, &s->aes_encrypt_key) != 0) | |
354 | return -1; | |
355 | if (AES_set_decrypt_key(keybuf, 128, &s->aes_decrypt_key) != 0) | |
356 | return -1; | |
357 | #if 0 | |
358 | /* test */ | |
359 | { | |
360 | uint8_t in[16]; | |
361 | uint8_t out[16]; | |
362 | uint8_t tmp[16]; | |
363 | for(i=0;i<16;i++) | |
364 | in[i] = i; | |
365 | AES_encrypt(in, tmp, &s->aes_encrypt_key); | |
366 | AES_decrypt(tmp, out, &s->aes_decrypt_key); | |
367 | for(i = 0; i < 16; i++) | |
368 | printf(" %02x", tmp[i]); | |
369 | printf("\n"); | |
370 | for(i = 0; i < 16; i++) | |
371 | printf(" %02x", out[i]); | |
372 | printf("\n"); | |
373 | } | |
374 | #endif | |
375 | return 0; | |
376 | } | |
377 | ||
f8a2e5e3 SH |
378 | static int coroutine_fn qcow2_co_is_allocated(BlockDriverState *bs, |
379 | int64_t sector_num, int nb_sectors, int *pnum) | |
585f8587 | 380 | { |
f8a2e5e3 | 381 | BDRVQcowState *s = bs->opaque; |
585f8587 | 382 | uint64_t cluster_offset; |
1c46efaa | 383 | int ret; |
585f8587 | 384 | |
095a9c58 | 385 | *pnum = nb_sectors; |
f8a2e5e3 SH |
386 | /* FIXME We can get errors here, but the bdrv_co_is_allocated interface |
387 | * can't pass them on today */ | |
388 | qemu_co_mutex_lock(&s->lock); | |
1c46efaa | 389 | ret = qcow2_get_cluster_offset(bs, sector_num << 9, pnum, &cluster_offset); |
f8a2e5e3 | 390 | qemu_co_mutex_unlock(&s->lock); |
1c46efaa KW |
391 | if (ret < 0) { |
392 | *pnum = 0; | |
393 | } | |
095a9c58 | 394 | |
585f8587 FB |
395 | return (cluster_offset != 0); |
396 | } | |
397 | ||
a9465922 | 398 | /* handle reading after the end of the backing file */ |
bd28f835 KW |
399 | int qcow2_backing_read1(BlockDriverState *bs, QEMUIOVector *qiov, |
400 | int64_t sector_num, int nb_sectors) | |
a9465922 FB |
401 | { |
402 | int n1; | |
403 | if ((sector_num + nb_sectors) <= bs->total_sectors) | |
404 | return nb_sectors; | |
405 | if (sector_num >= bs->total_sectors) | |
406 | n1 = 0; | |
407 | else | |
408 | n1 = bs->total_sectors - sector_num; | |
bd28f835 | 409 | |
e0d9c6f9 | 410 | qemu_iovec_memset_skip(qiov, 0, 512 * (nb_sectors - n1), 512 * n1); |
bd28f835 | 411 | |
a9465922 FB |
412 | return n1; |
413 | } | |
414 | ||
a968168c | 415 | static coroutine_fn int qcow2_co_readv(BlockDriverState *bs, int64_t sector_num, |
3fc48d09 | 416 | int remaining_sectors, QEMUIOVector *qiov) |
585f8587 | 417 | { |
585f8587 | 418 | BDRVQcowState *s = bs->opaque; |
a9465922 | 419 | int index_in_cluster, n1; |
68d100e9 | 420 | int ret; |
faf575c1 | 421 | int cur_nr_sectors; /* number of sectors in current iteration */ |
c2bdd990 | 422 | uint64_t cluster_offset = 0; |
3fc48d09 FZ |
423 | uint64_t bytes_done = 0; |
424 | QEMUIOVector hd_qiov; | |
425 | uint8_t *cluster_data = NULL; | |
585f8587 | 426 | |
3fc48d09 FZ |
427 | qemu_iovec_init(&hd_qiov, qiov->niov); |
428 | ||
429 | qemu_co_mutex_lock(&s->lock); | |
430 | ||
431 | while (remaining_sectors != 0) { | |
bd28f835 | 432 | |
5ebaa27e | 433 | /* prepare next request */ |
3fc48d09 | 434 | cur_nr_sectors = remaining_sectors; |
5ebaa27e FZ |
435 | if (s->crypt_method) { |
436 | cur_nr_sectors = MIN(cur_nr_sectors, | |
437 | QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors); | |
585f8587 | 438 | } |
5ebaa27e | 439 | |
3fc48d09 | 440 | ret = qcow2_get_cluster_offset(bs, sector_num << 9, |
5ebaa27e | 441 | &cur_nr_sectors, &cluster_offset); |
8af36488 | 442 | if (ret < 0) { |
3fc48d09 | 443 | goto fail; |
8af36488 | 444 | } |
bd28f835 | 445 | |
3fc48d09 | 446 | index_in_cluster = sector_num & (s->cluster_sectors - 1); |
c87c0672 | 447 | |
3fc48d09 FZ |
448 | qemu_iovec_reset(&hd_qiov); |
449 | qemu_iovec_copy(&hd_qiov, qiov, bytes_done, | |
5ebaa27e FZ |
450 | cur_nr_sectors * 512); |
451 | ||
452 | if (!cluster_offset) { | |
453 | ||
454 | if (bs->backing_hd) { | |
455 | /* read from the base image */ | |
3fc48d09 FZ |
456 | n1 = qcow2_backing_read1(bs->backing_hd, &hd_qiov, |
457 | sector_num, cur_nr_sectors); | |
5ebaa27e FZ |
458 | if (n1 > 0) { |
459 | BLKDBG_EVENT(bs->file, BLKDBG_READ_BACKING_AIO); | |
460 | qemu_co_mutex_unlock(&s->lock); | |
3fc48d09 FZ |
461 | ret = bdrv_co_readv(bs->backing_hd, sector_num, |
462 | n1, &hd_qiov); | |
5ebaa27e FZ |
463 | qemu_co_mutex_lock(&s->lock); |
464 | if (ret < 0) { | |
3fc48d09 | 465 | goto fail; |
5ebaa27e FZ |
466 | } |
467 | } | |
468 | } else { | |
469 | /* Note: in this case, no need to wait */ | |
3fc48d09 | 470 | qemu_iovec_memset(&hd_qiov, 0, 512 * cur_nr_sectors); |
5ebaa27e FZ |
471 | } |
472 | } else if (cluster_offset & QCOW_OFLAG_COMPRESSED) { | |
473 | /* add AIO support for compressed blocks ? */ | |
474 | ret = qcow2_decompress_cluster(bs, cluster_offset); | |
475 | if (ret < 0) { | |
3fc48d09 | 476 | goto fail; |
bd28f835 KW |
477 | } |
478 | ||
3fc48d09 | 479 | qemu_iovec_from_buffer(&hd_qiov, |
5ebaa27e | 480 | s->cluster_cache + index_in_cluster * 512, |
faf575c1 | 481 | 512 * cur_nr_sectors); |
5ebaa27e FZ |
482 | } else { |
483 | if ((cluster_offset & 511) != 0) { | |
3fc48d09 FZ |
484 | ret = -EIO; |
485 | goto fail; | |
5ebaa27e | 486 | } |
bd28f835 | 487 | |
5ebaa27e FZ |
488 | if (s->crypt_method) { |
489 | /* | |
490 | * For encrypted images, read everything into a temporary | |
491 | * contiguous buffer on which the AES functions can work. | |
492 | */ | |
3fc48d09 FZ |
493 | if (!cluster_data) { |
494 | cluster_data = | |
dea43a65 | 495 | qemu_blockalign(bs, QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size); |
5ebaa27e FZ |
496 | } |
497 | ||
498 | assert(cur_nr_sectors <= | |
499 | QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors); | |
3fc48d09 FZ |
500 | qemu_iovec_reset(&hd_qiov); |
501 | qemu_iovec_add(&hd_qiov, cluster_data, | |
5ebaa27e FZ |
502 | 512 * cur_nr_sectors); |
503 | } | |
504 | ||
505 | BLKDBG_EVENT(bs->file, BLKDBG_READ_AIO); | |
506 | qemu_co_mutex_unlock(&s->lock); | |
507 | ret = bdrv_co_readv(bs->file, | |
508 | (cluster_offset >> 9) + index_in_cluster, | |
3fc48d09 | 509 | cur_nr_sectors, &hd_qiov); |
5ebaa27e FZ |
510 | qemu_co_mutex_lock(&s->lock); |
511 | if (ret < 0) { | |
3fc48d09 | 512 | goto fail; |
5ebaa27e FZ |
513 | } |
514 | if (s->crypt_method) { | |
3fc48d09 FZ |
515 | qcow2_encrypt_sectors(s, sector_num, cluster_data, |
516 | cluster_data, cur_nr_sectors, 0, &s->aes_decrypt_key); | |
517 | qemu_iovec_reset(&hd_qiov); | |
518 | qemu_iovec_copy(&hd_qiov, qiov, bytes_done, | |
5ebaa27e | 519 | cur_nr_sectors * 512); |
3fc48d09 | 520 | qemu_iovec_from_buffer(&hd_qiov, cluster_data, |
5ebaa27e FZ |
521 | 512 * cur_nr_sectors); |
522 | } | |
faf575c1 | 523 | } |
f141eafe | 524 | |
3fc48d09 FZ |
525 | remaining_sectors -= cur_nr_sectors; |
526 | sector_num += cur_nr_sectors; | |
527 | bytes_done += cur_nr_sectors * 512; | |
5ebaa27e | 528 | } |
3fc48d09 | 529 | ret = 0; |
faf575c1 | 530 | |
3fc48d09 | 531 | fail: |
68d100e9 | 532 | qemu_co_mutex_unlock(&s->lock); |
42496d62 | 533 | |
3fc48d09 | 534 | qemu_iovec_destroy(&hd_qiov); |
dea43a65 | 535 | qemu_vfree(cluster_data); |
68d100e9 KW |
536 | |
537 | return ret; | |
585f8587 FB |
538 | } |
539 | ||
68d100e9 | 540 | static void run_dependent_requests(BDRVQcowState *s, QCowL2Meta *m) |
f214978a | 541 | { |
f214978a KW |
542 | /* Take the request off the list of running requests */ |
543 | if (m->nb_clusters != 0) { | |
72cf2d4f | 544 | QLIST_REMOVE(m, next_in_flight); |
f214978a KW |
545 | } |
546 | ||
d4c146f0 | 547 | /* Restart all dependent requests */ |
68d100e9 KW |
548 | if (!qemu_co_queue_empty(&m->dependent_requests)) { |
549 | qemu_co_mutex_unlock(&s->lock); | |
e8ee5e4c | 550 | qemu_co_queue_restart_all(&m->dependent_requests); |
68d100e9 | 551 | qemu_co_mutex_lock(&s->lock); |
f214978a | 552 | } |
f214978a KW |
553 | } |
554 | ||
a968168c | 555 | static coroutine_fn int qcow2_co_writev(BlockDriverState *bs, |
3fc48d09 FZ |
556 | int64_t sector_num, |
557 | int remaining_sectors, | |
558 | QEMUIOVector *qiov) | |
585f8587 | 559 | { |
585f8587 | 560 | BDRVQcowState *s = bs->opaque; |
585f8587 | 561 | int index_in_cluster; |
095a9c58 | 562 | int n_end; |
68d100e9 | 563 | int ret; |
faf575c1 | 564 | int cur_nr_sectors; /* number of sectors in current iteration */ |
c2bdd990 | 565 | uint64_t cluster_offset; |
3fc48d09 FZ |
566 | QEMUIOVector hd_qiov; |
567 | uint64_t bytes_done = 0; | |
568 | uint8_t *cluster_data = NULL; | |
8e217d53 KW |
569 | QCowL2Meta l2meta = { |
570 | .nb_clusters = 0, | |
571 | }; | |
c2271403 | 572 | |
3cce16f4 KW |
573 | trace_qcow2_writev_start_req(qemu_coroutine_self(), sector_num, |
574 | remaining_sectors); | |
575 | ||
c2271403 | 576 | qemu_co_queue_init(&l2meta.dependent_requests); |
585f8587 | 577 | |
3fc48d09 FZ |
578 | qemu_iovec_init(&hd_qiov, qiov->niov); |
579 | ||
580 | s->cluster_cache_offset = -1; /* disable compressed cache */ | |
3b46e624 | 581 | |
3fc48d09 FZ |
582 | qemu_co_mutex_lock(&s->lock); |
583 | ||
584 | while (remaining_sectors != 0) { | |
585 | ||
3cce16f4 | 586 | trace_qcow2_writev_start_part(qemu_coroutine_self()); |
3fc48d09 FZ |
587 | index_in_cluster = sector_num & (s->cluster_sectors - 1); |
588 | n_end = index_in_cluster + remaining_sectors; | |
5ebaa27e FZ |
589 | if (s->crypt_method && |
590 | n_end > QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors) { | |
591 | n_end = QCOW_MAX_CRYPT_CLUSTERS * s->cluster_sectors; | |
592 | } | |
095a9c58 | 593 | |
3fc48d09 | 594 | ret = qcow2_alloc_cluster_offset(bs, sector_num << 9, |
5ebaa27e FZ |
595 | index_in_cluster, n_end, &cur_nr_sectors, &l2meta); |
596 | if (ret < 0) { | |
3fc48d09 | 597 | goto fail; |
5ebaa27e | 598 | } |
148da7ea | 599 | |
5ebaa27e FZ |
600 | cluster_offset = l2meta.cluster_offset; |
601 | assert((cluster_offset & 511) == 0); | |
148da7ea | 602 | |
3fc48d09 FZ |
603 | qemu_iovec_reset(&hd_qiov); |
604 | qemu_iovec_copy(&hd_qiov, qiov, bytes_done, | |
5ebaa27e | 605 | cur_nr_sectors * 512); |
6f5f060b | 606 | |
5ebaa27e | 607 | if (s->crypt_method) { |
3fc48d09 | 608 | if (!cluster_data) { |
dea43a65 | 609 | cluster_data = qemu_blockalign(bs, QCOW_MAX_CRYPT_CLUSTERS * |
5ebaa27e FZ |
610 | s->cluster_size); |
611 | } | |
6f5f060b | 612 | |
3fc48d09 | 613 | assert(hd_qiov.size <= |
5ebaa27e | 614 | QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size); |
3fc48d09 | 615 | qemu_iovec_to_buffer(&hd_qiov, cluster_data); |
6f5f060b | 616 | |
3fc48d09 FZ |
617 | qcow2_encrypt_sectors(s, sector_num, cluster_data, |
618 | cluster_data, cur_nr_sectors, 1, &s->aes_encrypt_key); | |
6f5f060b | 619 | |
3fc48d09 FZ |
620 | qemu_iovec_reset(&hd_qiov); |
621 | qemu_iovec_add(&hd_qiov, cluster_data, | |
5ebaa27e FZ |
622 | cur_nr_sectors * 512); |
623 | } | |
6f5f060b | 624 | |
5ebaa27e FZ |
625 | BLKDBG_EVENT(bs->file, BLKDBG_WRITE_AIO); |
626 | qemu_co_mutex_unlock(&s->lock); | |
3cce16f4 KW |
627 | trace_qcow2_writev_data(qemu_coroutine_self(), |
628 | (cluster_offset >> 9) + index_in_cluster); | |
5ebaa27e FZ |
629 | ret = bdrv_co_writev(bs->file, |
630 | (cluster_offset >> 9) + index_in_cluster, | |
3fc48d09 | 631 | cur_nr_sectors, &hd_qiov); |
5ebaa27e FZ |
632 | qemu_co_mutex_lock(&s->lock); |
633 | if (ret < 0) { | |
3fc48d09 | 634 | goto fail; |
5ebaa27e | 635 | } |
f141eafe | 636 | |
5ebaa27e | 637 | ret = qcow2_alloc_cluster_link_l2(bs, &l2meta); |
5ebaa27e | 638 | if (ret < 0) { |
3fc48d09 | 639 | goto fail; |
5ebaa27e | 640 | } |
faf575c1 | 641 | |
0fa9131a KW |
642 | run_dependent_requests(s, &l2meta); |
643 | ||
3fc48d09 FZ |
644 | remaining_sectors -= cur_nr_sectors; |
645 | sector_num += cur_nr_sectors; | |
646 | bytes_done += cur_nr_sectors * 512; | |
3cce16f4 | 647 | trace_qcow2_writev_done_part(qemu_coroutine_self(), cur_nr_sectors); |
5ebaa27e | 648 | } |
3fc48d09 | 649 | ret = 0; |
faf575c1 | 650 | |
3fc48d09 | 651 | fail: |
0fa9131a KW |
652 | run_dependent_requests(s, &l2meta); |
653 | ||
68d100e9 | 654 | qemu_co_mutex_unlock(&s->lock); |
3b46e624 | 655 | |
3fc48d09 | 656 | qemu_iovec_destroy(&hd_qiov); |
dea43a65 | 657 | qemu_vfree(cluster_data); |
3cce16f4 | 658 | trace_qcow2_writev_done_req(qemu_coroutine_self(), ret); |
42496d62 | 659 | |
68d100e9 | 660 | return ret; |
585f8587 FB |
661 | } |
662 | ||
7c80ab3f | 663 | static void qcow2_close(BlockDriverState *bs) |
585f8587 FB |
664 | { |
665 | BDRVQcowState *s = bs->opaque; | |
7267c094 | 666 | g_free(s->l1_table); |
29c1a730 KW |
667 | |
668 | qcow2_cache_flush(bs, s->l2_table_cache); | |
669 | qcow2_cache_flush(bs, s->refcount_block_cache); | |
670 | ||
671 | qcow2_cache_destroy(bs, s->l2_table_cache); | |
672 | qcow2_cache_destroy(bs, s->refcount_block_cache); | |
673 | ||
75bab85c | 674 | cleanup_unknown_header_ext(bs); |
7267c094 | 675 | g_free(s->cluster_cache); |
dea43a65 | 676 | qemu_vfree(s->cluster_data); |
ed6ccf0f | 677 | qcow2_refcount_close(bs); |
28c1202b | 678 | qcow2_free_snapshots(bs); |
585f8587 FB |
679 | } |
680 | ||
06d9260f AL |
681 | static void qcow2_invalidate_cache(BlockDriverState *bs) |
682 | { | |
683 | BDRVQcowState *s = bs->opaque; | |
684 | int flags = s->flags; | |
685 | AES_KEY aes_encrypt_key; | |
686 | AES_KEY aes_decrypt_key; | |
687 | uint32_t crypt_method = 0; | |
688 | ||
689 | /* | |
690 | * Backing files are read-only which makes all of their metadata immutable, | |
691 | * that means we don't have to worry about reopening them here. | |
692 | */ | |
693 | ||
694 | if (s->crypt_method) { | |
695 | crypt_method = s->crypt_method; | |
696 | memcpy(&aes_encrypt_key, &s->aes_encrypt_key, sizeof(aes_encrypt_key)); | |
697 | memcpy(&aes_decrypt_key, &s->aes_decrypt_key, sizeof(aes_decrypt_key)); | |
698 | } | |
699 | ||
700 | qcow2_close(bs); | |
701 | ||
702 | memset(s, 0, sizeof(BDRVQcowState)); | |
703 | qcow2_open(bs, flags); | |
704 | ||
705 | if (crypt_method) { | |
706 | s->crypt_method = crypt_method; | |
707 | memcpy(&s->aes_encrypt_key, &aes_encrypt_key, sizeof(aes_encrypt_key)); | |
708 | memcpy(&s->aes_decrypt_key, &aes_decrypt_key, sizeof(aes_decrypt_key)); | |
709 | } | |
710 | } | |
711 | ||
e24e49e6 KW |
712 | static size_t header_ext_add(char *buf, uint32_t magic, const void *s, |
713 | size_t len, size_t buflen) | |
714 | { | |
715 | QCowExtension *ext_backing_fmt = (QCowExtension*) buf; | |
716 | size_t ext_len = sizeof(QCowExtension) + ((len + 7) & ~7); | |
717 | ||
718 | if (buflen < ext_len) { | |
719 | return -ENOSPC; | |
720 | } | |
721 | ||
722 | *ext_backing_fmt = (QCowExtension) { | |
723 | .magic = cpu_to_be32(magic), | |
724 | .len = cpu_to_be32(len), | |
725 | }; | |
726 | memcpy(buf + sizeof(QCowExtension), s, len); | |
727 | ||
728 | return ext_len; | |
729 | } | |
730 | ||
756e6736 | 731 | /* |
e24e49e6 KW |
732 | * Updates the qcow2 header, including the variable length parts of it, i.e. |
733 | * the backing file name and all extensions. qcow2 was not designed to allow | |
734 | * such changes, so if we run out of space (we can only use the first cluster) | |
735 | * this function may fail. | |
756e6736 KW |
736 | * |
737 | * Returns 0 on success, -errno in error cases. | |
738 | */ | |
e24e49e6 | 739 | int qcow2_update_header(BlockDriverState *bs) |
756e6736 | 740 | { |
756e6736 | 741 | BDRVQcowState *s = bs->opaque; |
e24e49e6 KW |
742 | QCowHeader *header; |
743 | char *buf; | |
744 | size_t buflen = s->cluster_size; | |
756e6736 | 745 | int ret; |
e24e49e6 KW |
746 | uint64_t total_size; |
747 | uint32_t refcount_table_clusters; | |
75bab85c | 748 | Qcow2UnknownHeaderExtension *uext; |
756e6736 | 749 | |
e24e49e6 KW |
750 | buf = qemu_blockalign(bs, buflen); |
751 | memset(buf, 0, s->cluster_size); | |
756e6736 | 752 | |
e24e49e6 KW |
753 | /* Header structure */ |
754 | header = (QCowHeader*) buf; | |
756e6736 | 755 | |
e24e49e6 KW |
756 | if (buflen < sizeof(*header)) { |
757 | ret = -ENOSPC; | |
758 | goto fail; | |
756e6736 KW |
759 | } |
760 | ||
e24e49e6 KW |
761 | total_size = bs->total_sectors * BDRV_SECTOR_SIZE; |
762 | refcount_table_clusters = s->refcount_table_size >> (s->cluster_bits - 3); | |
763 | ||
764 | *header = (QCowHeader) { | |
765 | .magic = cpu_to_be32(QCOW_MAGIC), | |
766 | .version = cpu_to_be32(QCOW_VERSION), | |
767 | .backing_file_offset = 0, | |
768 | .backing_file_size = 0, | |
769 | .cluster_bits = cpu_to_be32(s->cluster_bits), | |
770 | .size = cpu_to_be64(total_size), | |
771 | .crypt_method = cpu_to_be32(s->crypt_method_header), | |
772 | .l1_size = cpu_to_be32(s->l1_size), | |
773 | .l1_table_offset = cpu_to_be64(s->l1_table_offset), | |
774 | .refcount_table_offset = cpu_to_be64(s->refcount_table_offset), | |
775 | .refcount_table_clusters = cpu_to_be32(refcount_table_clusters), | |
776 | .nb_snapshots = cpu_to_be32(s->nb_snapshots), | |
777 | .snapshots_offset = cpu_to_be64(s->snapshots_offset), | |
778 | }; | |
756e6736 | 779 | |
e24e49e6 KW |
780 | buf += sizeof(*header); |
781 | buflen -= sizeof(*header); | |
756e6736 | 782 | |
e24e49e6 KW |
783 | /* Backing file format header extension */ |
784 | if (*bs->backing_format) { | |
785 | ret = header_ext_add(buf, QCOW2_EXT_MAGIC_BACKING_FORMAT, | |
786 | bs->backing_format, strlen(bs->backing_format), | |
787 | buflen); | |
788 | if (ret < 0) { | |
789 | goto fail; | |
756e6736 KW |
790 | } |
791 | ||
e24e49e6 KW |
792 | buf += ret; |
793 | buflen -= ret; | |
756e6736 KW |
794 | } |
795 | ||
75bab85c KW |
796 | /* Keep unknown header extensions */ |
797 | QLIST_FOREACH(uext, &s->unknown_header_ext, next) { | |
798 | ret = header_ext_add(buf, uext->magic, uext->data, uext->len, buflen); | |
799 | if (ret < 0) { | |
800 | goto fail; | |
801 | } | |
802 | ||
803 | buf += ret; | |
804 | buflen -= ret; | |
805 | } | |
806 | ||
e24e49e6 KW |
807 | /* End of header extensions */ |
808 | ret = header_ext_add(buf, QCOW2_EXT_MAGIC_END, NULL, 0, buflen); | |
756e6736 KW |
809 | if (ret < 0) { |
810 | goto fail; | |
811 | } | |
812 | ||
e24e49e6 KW |
813 | buf += ret; |
814 | buflen -= ret; | |
756e6736 | 815 | |
e24e49e6 KW |
816 | /* Backing file name */ |
817 | if (*bs->backing_file) { | |
818 | size_t backing_file_len = strlen(bs->backing_file); | |
819 | ||
820 | if (buflen < backing_file_len) { | |
821 | ret = -ENOSPC; | |
822 | goto fail; | |
823 | } | |
824 | ||
825 | strncpy(buf, bs->backing_file, buflen); | |
826 | ||
827 | header->backing_file_offset = cpu_to_be64(buf - ((char*) header)); | |
828 | header->backing_file_size = cpu_to_be32(backing_file_len); | |
756e6736 KW |
829 | } |
830 | ||
e24e49e6 KW |
831 | /* Write the new header */ |
832 | ret = bdrv_pwrite(bs->file, 0, header, s->cluster_size); | |
756e6736 KW |
833 | if (ret < 0) { |
834 | goto fail; | |
835 | } | |
836 | ||
837 | ret = 0; | |
838 | fail: | |
e24e49e6 | 839 | qemu_vfree(header); |
756e6736 KW |
840 | return ret; |
841 | } | |
842 | ||
843 | static int qcow2_change_backing_file(BlockDriverState *bs, | |
844 | const char *backing_file, const char *backing_fmt) | |
845 | { | |
e24e49e6 KW |
846 | /* Backing file format doesn't make sense without a backing file */ |
847 | if (backing_fmt && !backing_file) { | |
848 | return -EINVAL; | |
849 | } | |
850 | ||
851 | pstrcpy(bs->backing_file, sizeof(bs->backing_file), backing_file ?: ""); | |
852 | pstrcpy(bs->backing_format, sizeof(bs->backing_format), backing_fmt ?: ""); | |
853 | ||
854 | return qcow2_update_header(bs); | |
756e6736 KW |
855 | } |
856 | ||
a35e1c17 KW |
857 | static int preallocate(BlockDriverState *bs) |
858 | { | |
a35e1c17 KW |
859 | uint64_t nb_sectors; |
860 | uint64_t offset; | |
861 | int num; | |
148da7ea | 862 | int ret; |
a35e1c17 KW |
863 | QCowL2Meta meta; |
864 | ||
865 | nb_sectors = bdrv_getlength(bs) >> 9; | |
866 | offset = 0; | |
68d100e9 | 867 | qemu_co_queue_init(&meta.dependent_requests); |
148da7ea | 868 | meta.cluster_offset = 0; |
a35e1c17 KW |
869 | |
870 | while (nb_sectors) { | |
871 | num = MIN(nb_sectors, INT_MAX >> 9); | |
148da7ea | 872 | ret = qcow2_alloc_cluster_offset(bs, offset, 0, num, &num, &meta); |
148da7ea | 873 | if (ret < 0) { |
19dbcbf7 | 874 | return ret; |
a35e1c17 KW |
875 | } |
876 | ||
19dbcbf7 KW |
877 | ret = qcow2_alloc_cluster_link_l2(bs, &meta); |
878 | if (ret < 0) { | |
148da7ea | 879 | qcow2_free_any_clusters(bs, meta.cluster_offset, meta.nb_clusters); |
19dbcbf7 | 880 | return ret; |
a35e1c17 KW |
881 | } |
882 | ||
f214978a KW |
883 | /* There are no dependent requests, but we need to remove our request |
884 | * from the list of in-flight requests */ | |
68d100e9 | 885 | run_dependent_requests(bs->opaque, &meta); |
f214978a | 886 | |
a35e1c17 KW |
887 | /* TODO Preallocate data if requested */ |
888 | ||
889 | nb_sectors -= num; | |
890 | offset += num << 9; | |
891 | } | |
892 | ||
893 | /* | |
894 | * It is expected that the image file is large enough to actually contain | |
895 | * all of the allocated clusters (otherwise we get failing reads after | |
896 | * EOF). Extend the image to the last allocated sector. | |
897 | */ | |
148da7ea | 898 | if (meta.cluster_offset != 0) { |
ea80b906 KW |
899 | uint8_t buf[512]; |
900 | memset(buf, 0, 512); | |
19dbcbf7 KW |
901 | ret = bdrv_write(bs->file, (meta.cluster_offset >> 9) + num - 1, buf, 1); |
902 | if (ret < 0) { | |
903 | return ret; | |
904 | } | |
a35e1c17 KW |
905 | } |
906 | ||
907 | return 0; | |
908 | } | |
909 | ||
7c80ab3f JS |
910 | static int qcow2_create2(const char *filename, int64_t total_size, |
911 | const char *backing_file, const char *backing_format, | |
912 | int flags, size_t cluster_size, int prealloc, | |
913 | QEMUOptionParameter *options) | |
a9420734 | 914 | { |
9b2260cb | 915 | /* Calculate cluster_bits */ |
a9420734 KW |
916 | int cluster_bits; |
917 | cluster_bits = ffs(cluster_size) - 1; | |
918 | if (cluster_bits < MIN_CLUSTER_BITS || cluster_bits > MAX_CLUSTER_BITS || | |
919 | (1 << cluster_bits) != cluster_size) | |
920 | { | |
921 | error_report( | |
6daf194d | 922 | "Cluster size must be a power of two between %d and %dk", |
a9420734 KW |
923 | 1 << MIN_CLUSTER_BITS, 1 << (MAX_CLUSTER_BITS - 10)); |
924 | return -EINVAL; | |
925 | } | |
926 | ||
927 | /* | |
928 | * Open the image file and write a minimal qcow2 header. | |
929 | * | |
930 | * We keep things simple and start with a zero-sized image. We also | |
931 | * do without refcount blocks or a L1 table for now. We'll fix the | |
932 | * inconsistency later. | |
933 | * | |
934 | * We do need a refcount table because growing the refcount table means | |
935 | * allocating two new refcount blocks - the seconds of which would be at | |
936 | * 2 GB for 64k clusters, and we don't want to have a 2 GB initial file | |
937 | * size for any qcow2 image. | |
938 | */ | |
939 | BlockDriverState* bs; | |
940 | QCowHeader header; | |
941 | uint8_t* refcount_table; | |
942 | int ret; | |
943 | ||
944 | ret = bdrv_create_file(filename, options); | |
945 | if (ret < 0) { | |
946 | return ret; | |
947 | } | |
948 | ||
949 | ret = bdrv_file_open(&bs, filename, BDRV_O_RDWR); | |
950 | if (ret < 0) { | |
951 | return ret; | |
952 | } | |
953 | ||
954 | /* Write the header */ | |
955 | memset(&header, 0, sizeof(header)); | |
956 | header.magic = cpu_to_be32(QCOW_MAGIC); | |
957 | header.version = cpu_to_be32(QCOW_VERSION); | |
958 | header.cluster_bits = cpu_to_be32(cluster_bits); | |
959 | header.size = cpu_to_be64(0); | |
960 | header.l1_table_offset = cpu_to_be64(0); | |
961 | header.l1_size = cpu_to_be32(0); | |
962 | header.refcount_table_offset = cpu_to_be64(cluster_size); | |
963 | header.refcount_table_clusters = cpu_to_be32(1); | |
964 | ||
965 | if (flags & BLOCK_FLAG_ENCRYPT) { | |
966 | header.crypt_method = cpu_to_be32(QCOW_CRYPT_AES); | |
967 | } else { | |
968 | header.crypt_method = cpu_to_be32(QCOW_CRYPT_NONE); | |
969 | } | |
970 | ||
971 | ret = bdrv_pwrite(bs, 0, &header, sizeof(header)); | |
972 | if (ret < 0) { | |
973 | goto out; | |
974 | } | |
975 | ||
976 | /* Write an empty refcount table */ | |
7267c094 | 977 | refcount_table = g_malloc0(cluster_size); |
a9420734 | 978 | ret = bdrv_pwrite(bs, cluster_size, refcount_table, cluster_size); |
7267c094 | 979 | g_free(refcount_table); |
a9420734 KW |
980 | |
981 | if (ret < 0) { | |
982 | goto out; | |
983 | } | |
984 | ||
985 | bdrv_close(bs); | |
986 | ||
987 | /* | |
988 | * And now open the image and make it consistent first (i.e. increase the | |
989 | * refcount of the cluster that is occupied by the header and the refcount | |
990 | * table) | |
991 | */ | |
992 | BlockDriver* drv = bdrv_find_format("qcow2"); | |
993 | assert(drv != NULL); | |
e1a7107f KW |
994 | ret = bdrv_open(bs, filename, |
995 | BDRV_O_RDWR | BDRV_O_CACHE_WB | BDRV_O_NO_FLUSH, drv); | |
a9420734 KW |
996 | if (ret < 0) { |
997 | goto out; | |
998 | } | |
999 | ||
1000 | ret = qcow2_alloc_clusters(bs, 2 * cluster_size); | |
1001 | if (ret < 0) { | |
1002 | goto out; | |
1003 | ||
1004 | } else if (ret != 0) { | |
1005 | error_report("Huh, first cluster in empty image is already in use?"); | |
1006 | abort(); | |
1007 | } | |
1008 | ||
1009 | /* Okay, now that we have a valid image, let's give it the right size */ | |
1010 | ret = bdrv_truncate(bs, total_size * BDRV_SECTOR_SIZE); | |
1011 | if (ret < 0) { | |
1012 | goto out; | |
1013 | } | |
1014 | ||
1015 | /* Want a backing file? There you go.*/ | |
1016 | if (backing_file) { | |
1017 | ret = bdrv_change_backing_file(bs, backing_file, backing_format); | |
1018 | if (ret < 0) { | |
1019 | goto out; | |
1020 | } | |
1021 | } | |
1022 | ||
1023 | /* And if we're supposed to preallocate metadata, do that now */ | |
1024 | if (prealloc) { | |
1025 | ret = preallocate(bs); | |
1026 | if (ret < 0) { | |
1027 | goto out; | |
1028 | } | |
1029 | } | |
1030 | ||
1031 | ret = 0; | |
1032 | out: | |
1033 | bdrv_delete(bs); | |
1034 | return ret; | |
1035 | } | |
de5f3f40 | 1036 | |
7c80ab3f | 1037 | static int qcow2_create(const char *filename, QEMUOptionParameter *options) |
de5f3f40 KW |
1038 | { |
1039 | const char *backing_file = NULL; | |
1040 | const char *backing_fmt = NULL; | |
1041 | uint64_t sectors = 0; | |
1042 | int flags = 0; | |
99cce9fa | 1043 | size_t cluster_size = DEFAULT_CLUSTER_SIZE; |
de5f3f40 KW |
1044 | int prealloc = 0; |
1045 | ||
1046 | /* Read out options */ | |
1047 | while (options && options->name) { | |
1048 | if (!strcmp(options->name, BLOCK_OPT_SIZE)) { | |
1049 | sectors = options->value.n / 512; | |
1050 | } else if (!strcmp(options->name, BLOCK_OPT_BACKING_FILE)) { | |
1051 | backing_file = options->value.s; | |
1052 | } else if (!strcmp(options->name, BLOCK_OPT_BACKING_FMT)) { | |
1053 | backing_fmt = options->value.s; | |
1054 | } else if (!strcmp(options->name, BLOCK_OPT_ENCRYPT)) { | |
1055 | flags |= options->value.n ? BLOCK_FLAG_ENCRYPT : 0; | |
1056 | } else if (!strcmp(options->name, BLOCK_OPT_CLUSTER_SIZE)) { | |
1057 | if (options->value.n) { | |
1058 | cluster_size = options->value.n; | |
1059 | } | |
1060 | } else if (!strcmp(options->name, BLOCK_OPT_PREALLOC)) { | |
1061 | if (!options->value.s || !strcmp(options->value.s, "off")) { | |
1062 | prealloc = 0; | |
1063 | } else if (!strcmp(options->value.s, "metadata")) { | |
1064 | prealloc = 1; | |
1065 | } else { | |
1066 | fprintf(stderr, "Invalid preallocation mode: '%s'\n", | |
1067 | options->value.s); | |
1068 | return -EINVAL; | |
1069 | } | |
1070 | } | |
1071 | options++; | |
1072 | } | |
1073 | ||
1074 | if (backing_file && prealloc) { | |
1075 | fprintf(stderr, "Backing file and preallocation cannot be used at " | |
1076 | "the same time\n"); | |
1077 | return -EINVAL; | |
1078 | } | |
1079 | ||
7c80ab3f JS |
1080 | return qcow2_create2(filename, sectors, backing_file, backing_fmt, flags, |
1081 | cluster_size, prealloc, options); | |
de5f3f40 KW |
1082 | } |
1083 | ||
7c80ab3f | 1084 | static int qcow2_make_empty(BlockDriverState *bs) |
20d97356 BS |
1085 | { |
1086 | #if 0 | |
1087 | /* XXX: not correct */ | |
1088 | BDRVQcowState *s = bs->opaque; | |
1089 | uint32_t l1_length = s->l1_size * sizeof(uint64_t); | |
1090 | int ret; | |
1091 | ||
1092 | memset(s->l1_table, 0, l1_length); | |
66f82cee | 1093 | if (bdrv_pwrite(bs->file, s->l1_table_offset, s->l1_table, l1_length) < 0) |
20d97356 | 1094 | return -1; |
66f82cee | 1095 | ret = bdrv_truncate(bs->file, s->l1_table_offset + l1_length); |
20d97356 BS |
1096 | if (ret < 0) |
1097 | return ret; | |
1098 | ||
1099 | l2_cache_reset(bs); | |
1100 | #endif | |
1101 | return 0; | |
1102 | } | |
1103 | ||
6db39ae2 PB |
1104 | static coroutine_fn int qcow2_co_discard(BlockDriverState *bs, |
1105 | int64_t sector_num, int nb_sectors) | |
5ea929e3 | 1106 | { |
6db39ae2 PB |
1107 | int ret; |
1108 | BDRVQcowState *s = bs->opaque; | |
1109 | ||
1110 | qemu_co_mutex_lock(&s->lock); | |
1111 | ret = qcow2_discard_clusters(bs, sector_num << BDRV_SECTOR_BITS, | |
5ea929e3 | 1112 | nb_sectors); |
6db39ae2 PB |
1113 | qemu_co_mutex_unlock(&s->lock); |
1114 | return ret; | |
5ea929e3 KW |
1115 | } |
1116 | ||
419b19d9 SH |
1117 | static int qcow2_truncate(BlockDriverState *bs, int64_t offset) |
1118 | { | |
1119 | BDRVQcowState *s = bs->opaque; | |
1120 | int ret, new_l1_size; | |
1121 | ||
1122 | if (offset & 511) { | |
259b2173 | 1123 | error_report("The new size must be a multiple of 512"); |
419b19d9 SH |
1124 | return -EINVAL; |
1125 | } | |
1126 | ||
1127 | /* cannot proceed if image has snapshots */ | |
1128 | if (s->nb_snapshots) { | |
259b2173 | 1129 | error_report("Can't resize an image which has snapshots"); |
419b19d9 SH |
1130 | return -ENOTSUP; |
1131 | } | |
1132 | ||
1133 | /* shrinking is currently not supported */ | |
1134 | if (offset < bs->total_sectors * 512) { | |
259b2173 | 1135 | error_report("qcow2 doesn't support shrinking images yet"); |
419b19d9 SH |
1136 | return -ENOTSUP; |
1137 | } | |
1138 | ||
1139 | new_l1_size = size_to_l1(s, offset); | |
72893756 | 1140 | ret = qcow2_grow_l1_table(bs, new_l1_size, true); |
419b19d9 SH |
1141 | if (ret < 0) { |
1142 | return ret; | |
1143 | } | |
1144 | ||
1145 | /* write updated header.size */ | |
1146 | offset = cpu_to_be64(offset); | |
8b3b7206 KW |
1147 | ret = bdrv_pwrite_sync(bs->file, offsetof(QCowHeader, size), |
1148 | &offset, sizeof(uint64_t)); | |
419b19d9 SH |
1149 | if (ret < 0) { |
1150 | return ret; | |
1151 | } | |
1152 | ||
1153 | s->l1_vm_state_index = new_l1_size; | |
1154 | return 0; | |
1155 | } | |
1156 | ||
20d97356 BS |
1157 | /* XXX: put compressed sectors first, then all the cluster aligned |
1158 | tables to avoid losing bytes in alignment */ | |
7c80ab3f JS |
1159 | static int qcow2_write_compressed(BlockDriverState *bs, int64_t sector_num, |
1160 | const uint8_t *buf, int nb_sectors) | |
20d97356 BS |
1161 | { |
1162 | BDRVQcowState *s = bs->opaque; | |
1163 | z_stream strm; | |
1164 | int ret, out_len; | |
1165 | uint8_t *out_buf; | |
1166 | uint64_t cluster_offset; | |
1167 | ||
1168 | if (nb_sectors == 0) { | |
1169 | /* align end of file to a sector boundary to ease reading with | |
1170 | sector based I/Os */ | |
66f82cee | 1171 | cluster_offset = bdrv_getlength(bs->file); |
20d97356 | 1172 | cluster_offset = (cluster_offset + 511) & ~511; |
66f82cee | 1173 | bdrv_truncate(bs->file, cluster_offset); |
20d97356 BS |
1174 | return 0; |
1175 | } | |
1176 | ||
1177 | if (nb_sectors != s->cluster_sectors) | |
1178 | return -EINVAL; | |
1179 | ||
7267c094 | 1180 | out_buf = g_malloc(s->cluster_size + (s->cluster_size / 1000) + 128); |
20d97356 BS |
1181 | |
1182 | /* best compression, small window, no zlib header */ | |
1183 | memset(&strm, 0, sizeof(strm)); | |
1184 | ret = deflateInit2(&strm, Z_DEFAULT_COMPRESSION, | |
1185 | Z_DEFLATED, -12, | |
1186 | 9, Z_DEFAULT_STRATEGY); | |
1187 | if (ret != 0) { | |
8f1efd00 KW |
1188 | ret = -EINVAL; |
1189 | goto fail; | |
20d97356 BS |
1190 | } |
1191 | ||
1192 | strm.avail_in = s->cluster_size; | |
1193 | strm.next_in = (uint8_t *)buf; | |
1194 | strm.avail_out = s->cluster_size; | |
1195 | strm.next_out = out_buf; | |
1196 | ||
1197 | ret = deflate(&strm, Z_FINISH); | |
1198 | if (ret != Z_STREAM_END && ret != Z_OK) { | |
20d97356 | 1199 | deflateEnd(&strm); |
8f1efd00 KW |
1200 | ret = -EINVAL; |
1201 | goto fail; | |
20d97356 BS |
1202 | } |
1203 | out_len = strm.next_out - out_buf; | |
1204 | ||
1205 | deflateEnd(&strm); | |
1206 | ||
1207 | if (ret != Z_STREAM_END || out_len >= s->cluster_size) { | |
1208 | /* could not compress: write normal cluster */ | |
8f1efd00 KW |
1209 | ret = bdrv_write(bs, sector_num, buf, s->cluster_sectors); |
1210 | if (ret < 0) { | |
1211 | goto fail; | |
1212 | } | |
20d97356 BS |
1213 | } else { |
1214 | cluster_offset = qcow2_alloc_compressed_cluster_offset(bs, | |
1215 | sector_num << 9, out_len); | |
8f1efd00 KW |
1216 | if (!cluster_offset) { |
1217 | ret = -EIO; | |
1218 | goto fail; | |
1219 | } | |
20d97356 | 1220 | cluster_offset &= s->cluster_offset_mask; |
66f82cee | 1221 | BLKDBG_EVENT(bs->file, BLKDBG_WRITE_COMPRESSED); |
8f1efd00 KW |
1222 | ret = bdrv_pwrite(bs->file, cluster_offset, out_buf, out_len); |
1223 | if (ret < 0) { | |
1224 | goto fail; | |
20d97356 BS |
1225 | } |
1226 | } | |
1227 | ||
8f1efd00 KW |
1228 | ret = 0; |
1229 | fail: | |
7267c094 | 1230 | g_free(out_buf); |
8f1efd00 | 1231 | return ret; |
20d97356 BS |
1232 | } |
1233 | ||
a968168c | 1234 | static coroutine_fn int qcow2_co_flush_to_os(BlockDriverState *bs) |
20d97356 | 1235 | { |
29c1a730 KW |
1236 | BDRVQcowState *s = bs->opaque; |
1237 | int ret; | |
1238 | ||
8b94ff85 | 1239 | qemu_co_mutex_lock(&s->lock); |
29c1a730 KW |
1240 | ret = qcow2_cache_flush(bs, s->l2_table_cache); |
1241 | if (ret < 0) { | |
c95de7e2 | 1242 | qemu_co_mutex_unlock(&s->lock); |
8b94ff85 | 1243 | return ret; |
29c1a730 KW |
1244 | } |
1245 | ||
1246 | ret = qcow2_cache_flush(bs, s->refcount_block_cache); | |
1247 | if (ret < 0) { | |
c95de7e2 | 1248 | qemu_co_mutex_unlock(&s->lock); |
8b94ff85 | 1249 | return ret; |
29c1a730 | 1250 | } |
8b94ff85 | 1251 | qemu_co_mutex_unlock(&s->lock); |
29c1a730 | 1252 | |
eb489bb1 KW |
1253 | return 0; |
1254 | } | |
1255 | ||
7c80ab3f | 1256 | static int64_t qcow2_vm_state_offset(BDRVQcowState *s) |
20d97356 BS |
1257 | { |
1258 | return (int64_t)s->l1_vm_state_index << (s->cluster_bits + s->l2_bits); | |
1259 | } | |
1260 | ||
7c80ab3f | 1261 | static int qcow2_get_info(BlockDriverState *bs, BlockDriverInfo *bdi) |
20d97356 BS |
1262 | { |
1263 | BDRVQcowState *s = bs->opaque; | |
1264 | bdi->cluster_size = s->cluster_size; | |
7c80ab3f | 1265 | bdi->vm_state_offset = qcow2_vm_state_offset(s); |
20d97356 BS |
1266 | return 0; |
1267 | } | |
1268 | ||
1269 | ||
7c80ab3f | 1270 | static int qcow2_check(BlockDriverState *bs, BdrvCheckResult *result) |
20d97356 | 1271 | { |
9ac228e0 | 1272 | return qcow2_check_refcounts(bs, result); |
20d97356 BS |
1273 | } |
1274 | ||
1275 | #if 0 | |
1276 | static void dump_refcounts(BlockDriverState *bs) | |
1277 | { | |
1278 | BDRVQcowState *s = bs->opaque; | |
1279 | int64_t nb_clusters, k, k1, size; | |
1280 | int refcount; | |
1281 | ||
66f82cee | 1282 | size = bdrv_getlength(bs->file); |
20d97356 BS |
1283 | nb_clusters = size_to_clusters(s, size); |
1284 | for(k = 0; k < nb_clusters;) { | |
1285 | k1 = k; | |
1286 | refcount = get_refcount(bs, k); | |
1287 | k++; | |
1288 | while (k < nb_clusters && get_refcount(bs, k) == refcount) | |
1289 | k++; | |
0bfcd599 BS |
1290 | printf("%" PRId64 ": refcount=%d nb=%" PRId64 "\n", k, refcount, |
1291 | k - k1); | |
20d97356 BS |
1292 | } |
1293 | } | |
1294 | #endif | |
1295 | ||
7c80ab3f JS |
1296 | static int qcow2_save_vmstate(BlockDriverState *bs, const uint8_t *buf, |
1297 | int64_t pos, int size) | |
20d97356 BS |
1298 | { |
1299 | BDRVQcowState *s = bs->opaque; | |
1300 | int growable = bs->growable; | |
1301 | int ret; | |
1302 | ||
66f82cee | 1303 | BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_SAVE); |
20d97356 | 1304 | bs->growable = 1; |
7c80ab3f | 1305 | ret = bdrv_pwrite(bs, qcow2_vm_state_offset(s) + pos, buf, size); |
20d97356 BS |
1306 | bs->growable = growable; |
1307 | ||
1308 | return ret; | |
1309 | } | |
1310 | ||
7c80ab3f JS |
1311 | static int qcow2_load_vmstate(BlockDriverState *bs, uint8_t *buf, |
1312 | int64_t pos, int size) | |
20d97356 BS |
1313 | { |
1314 | BDRVQcowState *s = bs->opaque; | |
1315 | int growable = bs->growable; | |
1316 | int ret; | |
1317 | ||
66f82cee | 1318 | BLKDBG_EVENT(bs->file, BLKDBG_VMSTATE_LOAD); |
20d97356 | 1319 | bs->growable = 1; |
7c80ab3f | 1320 | ret = bdrv_pread(bs, qcow2_vm_state_offset(s) + pos, buf, size); |
20d97356 BS |
1321 | bs->growable = growable; |
1322 | ||
1323 | return ret; | |
1324 | } | |
1325 | ||
7c80ab3f | 1326 | static QEMUOptionParameter qcow2_create_options[] = { |
20d97356 BS |
1327 | { |
1328 | .name = BLOCK_OPT_SIZE, | |
1329 | .type = OPT_SIZE, | |
1330 | .help = "Virtual disk size" | |
1331 | }, | |
1332 | { | |
1333 | .name = BLOCK_OPT_BACKING_FILE, | |
1334 | .type = OPT_STRING, | |
1335 | .help = "File name of a base image" | |
1336 | }, | |
1337 | { | |
1338 | .name = BLOCK_OPT_BACKING_FMT, | |
1339 | .type = OPT_STRING, | |
1340 | .help = "Image format of the base image" | |
1341 | }, | |
1342 | { | |
1343 | .name = BLOCK_OPT_ENCRYPT, | |
1344 | .type = OPT_FLAG, | |
1345 | .help = "Encrypt the image" | |
1346 | }, | |
1347 | { | |
1348 | .name = BLOCK_OPT_CLUSTER_SIZE, | |
1349 | .type = OPT_SIZE, | |
99cce9fa KW |
1350 | .help = "qcow2 cluster size", |
1351 | .value = { .n = DEFAULT_CLUSTER_SIZE }, | |
20d97356 BS |
1352 | }, |
1353 | { | |
1354 | .name = BLOCK_OPT_PREALLOC, | |
1355 | .type = OPT_STRING, | |
1356 | .help = "Preallocation mode (allowed values: off, metadata)" | |
1357 | }, | |
1358 | { NULL } | |
1359 | }; | |
1360 | ||
1361 | static BlockDriver bdrv_qcow2 = { | |
7c80ab3f JS |
1362 | .format_name = "qcow2", |
1363 | .instance_size = sizeof(BDRVQcowState), | |
1364 | .bdrv_probe = qcow2_probe, | |
1365 | .bdrv_open = qcow2_open, | |
1366 | .bdrv_close = qcow2_close, | |
1367 | .bdrv_create = qcow2_create, | |
f8a2e5e3 | 1368 | .bdrv_co_is_allocated = qcow2_co_is_allocated, |
7c80ab3f JS |
1369 | .bdrv_set_key = qcow2_set_key, |
1370 | .bdrv_make_empty = qcow2_make_empty, | |
1371 | ||
c68b89ac KW |
1372 | .bdrv_co_readv = qcow2_co_readv, |
1373 | .bdrv_co_writev = qcow2_co_writev, | |
eb489bb1 | 1374 | .bdrv_co_flush_to_os = qcow2_co_flush_to_os, |
419b19d9 | 1375 | |
6db39ae2 | 1376 | .bdrv_co_discard = qcow2_co_discard, |
419b19d9 | 1377 | .bdrv_truncate = qcow2_truncate, |
7c80ab3f | 1378 | .bdrv_write_compressed = qcow2_write_compressed, |
20d97356 BS |
1379 | |
1380 | .bdrv_snapshot_create = qcow2_snapshot_create, | |
1381 | .bdrv_snapshot_goto = qcow2_snapshot_goto, | |
1382 | .bdrv_snapshot_delete = qcow2_snapshot_delete, | |
1383 | .bdrv_snapshot_list = qcow2_snapshot_list, | |
51ef6727 | 1384 | .bdrv_snapshot_load_tmp = qcow2_snapshot_load_tmp, |
7c80ab3f | 1385 | .bdrv_get_info = qcow2_get_info, |
20d97356 | 1386 | |
7c80ab3f JS |
1387 | .bdrv_save_vmstate = qcow2_save_vmstate, |
1388 | .bdrv_load_vmstate = qcow2_load_vmstate, | |
20d97356 BS |
1389 | |
1390 | .bdrv_change_backing_file = qcow2_change_backing_file, | |
1391 | ||
06d9260f AL |
1392 | .bdrv_invalidate_cache = qcow2_invalidate_cache, |
1393 | ||
7c80ab3f JS |
1394 | .create_options = qcow2_create_options, |
1395 | .bdrv_check = qcow2_check, | |
20d97356 BS |
1396 | }; |
1397 | ||
5efa9d5a AL |
1398 | static void bdrv_qcow2_init(void) |
1399 | { | |
1400 | bdrv_register(&bdrv_qcow2); | |
1401 | } | |
1402 | ||
1403 | block_init(bdrv_qcow2_init); |