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