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