]> git.proxmox.com Git - mirror_qemu.git/blame - block/vpc.c
Merge remote-tracking branch 'remotes/stefanha/tags/net-pull-request' into staging
[mirror_qemu.git] / block / vpc.c
CommitLineData
6a0f9e82 1/*
cc2040f8 2 * Block driver for Connectix / Microsoft Virtual PC images
5fafdf24 3 *
6a0f9e82 4 * Copyright (c) 2005 Alex Beregszaszi
15d35bc5 5 * Copyright (c) 2009 Kevin Wolf <kwolf@suse.de>
5fafdf24 6 *
6a0f9e82
FB
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
24 */
faf07963 25#include "qemu-common.h"
737e150e 26#include "block/block_int.h"
1de7afc9 27#include "qemu/module.h"
caf71f86 28#include "migration/migration.h"
1fe1fa51
CA
29#if defined(CONFIG_UUID)
30#include <uuid/uuid.h>
31#endif
6a0f9e82
FB
32
33/**************************************************************/
34
35#define HEADER_SIZE 512
36
37//#define CACHE
38
2cfacb62
AL
39enum vhd_type {
40 VHD_FIXED = 2,
41 VHD_DYNAMIC = 3,
42 VHD_DIFFERENCING = 4,
43};
44
57c7d9e5
AL
45// Seconds since Jan 1, 2000 0:00:00 (UTC)
46#define VHD_TIMESTAMP_BASE 946684800
47
97f1c45c 48#define VHD_MAX_SECTORS (65535LL * 255 * 255)
690cbb09 49#define VHD_MAX_GEOMETRY (65535LL * 16 * 255)
97f1c45c 50
6a0f9e82 51// always big-endian
e54835c0 52typedef struct vhd_footer {
2cfacb62
AL
53 char creator[8]; // "conectix"
54 uint32_t features;
55 uint32_t version;
56
57 // Offset of next header structure, 0xFFFFFFFF if none
58 uint64_t data_offset;
59
60 // Seconds since Jan 1, 2000 0:00:00 (UTC)
61 uint32_t timestamp;
62
63 char creator_app[4]; // "vpc "
64 uint16_t major;
65 uint16_t minor;
66 char creator_os[4]; // "Wi2k"
67
68 uint64_t orig_size;
03671ded 69 uint64_t current_size;
2cfacb62
AL
70
71 uint16_t cyls;
72 uint8_t heads;
73 uint8_t secs_per_cyl;
74
75 uint32_t type;
76
77 // Checksum of the Hard Disk Footer ("one's complement of the sum of all
78 // the bytes in the footer without the checksum field")
79 uint32_t checksum;
80
81 // UUID used to identify a parent hard disk (backing file)
82 uint8_t uuid[16];
83
84 uint8_t in_saved_state;
e54835c0 85} QEMU_PACKED VHDFooter;
b9fa33a6 86
e54835c0 87typedef struct vhd_dyndisk_header {
2cfacb62
AL
88 char magic[8]; // "cxsparse"
89
90 // Offset of next header structure, 0xFFFFFFFF if none
91 uint64_t data_offset;
92
93 // Offset of the Block Allocation Table (BAT)
94 uint64_t table_offset;
95
96 uint32_t version;
97 uint32_t max_table_entries; // 32bit/entry
98
99 // 2 MB by default, must be a power of two
100 uint32_t block_size;
101
102 uint32_t checksum;
103 uint8_t parent_uuid[16];
104 uint32_t parent_timestamp;
105 uint32_t reserved;
106
107 // Backing file name (in UTF-16)
108 uint8_t parent_name[512];
109
110 struct {
111 uint32_t platform;
112 uint32_t data_space;
113 uint32_t data_length;
114 uint32_t reserved;
115 uint64_t data_offset;
116 } parent_locator[8];
e54835c0 117} QEMU_PACKED VHDDynDiskHeader;
6a0f9e82
FB
118
119typedef struct BDRVVPCState {
848c66e8 120 CoMutex lock;
15d35bc5
AL
121 uint8_t footer_buf[HEADER_SIZE];
122 uint64_t free_data_block_offset;
2cfacb62 123 int max_table_entries;
6a0f9e82 124 uint32_t *pagetable;
15d35bc5
AL
125 uint64_t bat_offset;
126 uint64_t last_bitmap_offset;
6a0f9e82 127
2cfacb62 128 uint32_t block_size;
15d35bc5
AL
129 uint32_t bitmap_size;
130
6a0f9e82
FB
131#ifdef CACHE
132 uint8_t *pageentry_u8;
133 uint32_t *pageentry_u32;
134 uint16_t *pageentry_u16;
3b46e624 135
6a0f9e82
FB
136 uint64_t last_bitmap;
137#endif
612ff3d8
KW
138
139 Error *migration_blocker;
6a0f9e82
FB
140} BDRVVPCState;
141
57c7d9e5
AL
142static uint32_t vpc_checksum(uint8_t* buf, size_t size)
143{
144 uint32_t res = 0;
145 int i;
146
147 for (i = 0; i < size; i++)
148 res += buf[i];
149
150 return ~res;
151}
152
153
6a0f9e82
FB
154static int vpc_probe(const uint8_t *buf, int buf_size, const char *filename)
155{
ffe8ab83 156 if (buf_size >= 8 && !strncmp((char *)buf, "conectix", 8))
6a0f9e82 157 return 100;
6a0f9e82
FB
158 return 0;
159}
160
015a1036
HR
161static int vpc_open(BlockDriverState *bs, QDict *options, int flags,
162 Error **errp)
6a0f9e82
FB
163{
164 BDRVVPCState *s = bs->opaque;
66f82cee 165 int i;
e54835c0
JC
166 VHDFooter *footer;
167 VHDDynDiskHeader *dyndisk_header;
b9fa33a6 168 uint8_t buf[HEADER_SIZE];
57c7d9e5 169 uint32_t checksum;
97f1c45c 170 uint64_t computed_size;
24da78db 171 int disk_type = VHD_DYNAMIC;
59294e46 172 int ret;
6a0f9e82 173
59294e46
KW
174 ret = bdrv_pread(bs->file, 0, s->footer_buf, HEADER_SIZE);
175 if (ret < 0) {
6a0f9e82 176 goto fail;
59294e46 177 }
6a0f9e82 178
e54835c0 179 footer = (VHDFooter *) s->footer_buf;
24da78db
CA
180 if (strncmp(footer->creator, "conectix", 8)) {
181 int64_t offset = bdrv_getlength(bs->file);
59294e46
KW
182 if (offset < 0) {
183 ret = offset;
184 goto fail;
185 } else if (offset < HEADER_SIZE) {
186 ret = -EINVAL;
24da78db
CA
187 goto fail;
188 }
59294e46 189
24da78db 190 /* If a fixed disk, the footer is found only at the end of the file */
59294e46
KW
191 ret = bdrv_pread(bs->file, offset-HEADER_SIZE, s->footer_buf,
192 HEADER_SIZE);
193 if (ret < 0) {
24da78db
CA
194 goto fail;
195 }
196 if (strncmp(footer->creator, "conectix", 8)) {
76abe407
PB
197 error_setg(errp, "invalid VPC image");
198 ret = -EINVAL;
24da78db
CA
199 goto fail;
200 }
201 disk_type = VHD_FIXED;
202 }
6a0f9e82 203
57c7d9e5
AL
204 checksum = be32_to_cpu(footer->checksum);
205 footer->checksum = 0;
206 if (vpc_checksum(s->footer_buf, HEADER_SIZE) != checksum)
207 fprintf(stderr, "block-vpc: The header checksum of '%s' is "
66f82cee 208 "incorrect.\n", bs->filename);
57c7d9e5 209
c088b691 210 /* Write 'checksum' back to footer, or else will leave it with zero. */
a4127c42 211 footer->checksum = cpu_to_be32(checksum);
c088b691 212
33ccf667
SH
213 // The visible size of a image in Virtual PC depends on the geometry
214 // rather than on the size stored in the footer (the size in the footer
215 // is too large usually)
216 bs->total_sectors = (int64_t)
217 be16_to_cpu(footer->cyls) * footer->heads * footer->secs_per_cyl;
1fa79228 218
0444dcee
KW
219 /* Images that have exactly the maximum geometry are probably bigger and
220 * would be truncated if we adhered to the geometry for them. Rely on
03671ded 221 * footer->current_size for them. */
690cbb09 222 if (bs->total_sectors == VHD_MAX_GEOMETRY) {
03671ded
PL
223 bs->total_sectors = be64_to_cpu(footer->current_size) /
224 BDRV_SECTOR_SIZE;
0173e7bb
PL
225 }
226
258d2edb 227 /* Allow a maximum disk size of approximately 2 TB */
97f1c45c 228 if (bs->total_sectors >= VHD_MAX_SECTORS) {
59294e46 229 ret = -EFBIG;
efc8243d
SH
230 goto fail;
231 }
232
24da78db 233 if (disk_type == VHD_DYNAMIC) {
59294e46
KW
234 ret = bdrv_pread(bs->file, be64_to_cpu(footer->data_offset), buf,
235 HEADER_SIZE);
236 if (ret < 0) {
24da78db
CA
237 goto fail;
238 }
b9fa33a6 239
e54835c0 240 dyndisk_header = (VHDDynDiskHeader *) buf;
6a0f9e82 241
24da78db 242 if (strncmp(dyndisk_header->magic, "cxsparse", 8)) {
59294e46 243 ret = -EINVAL;
24da78db
CA
244 goto fail;
245 }
6a0f9e82 246
24da78db 247 s->block_size = be32_to_cpu(dyndisk_header->block_size);
5e71dfad
KW
248 if (!is_power_of_2(s->block_size) || s->block_size < BDRV_SECTOR_SIZE) {
249 error_setg(errp, "Invalid block size %" PRIu32, s->block_size);
250 ret = -EINVAL;
251 goto fail;
252 }
24da78db 253 s->bitmap_size = ((s->block_size / (8 * 512)) + 511) & ~511;
15d35bc5 254
24da78db 255 s->max_table_entries = be32_to_cpu(dyndisk_header->max_table_entries);
97f1c45c
JC
256
257 if ((bs->total_sectors * 512) / s->block_size > 0xffffffffU) {
258 ret = -EINVAL;
259 goto fail;
260 }
261 if (s->max_table_entries > (VHD_MAX_SECTORS * 512) / s->block_size) {
262 ret = -EINVAL;
263 goto fail;
264 }
265
266 computed_size = (uint64_t) s->max_table_entries * s->block_size;
267 if (computed_size < bs->total_sectors * 512) {
268 ret = -EINVAL;
269 goto fail;
270 }
271
5fb09cd5
KW
272 s->pagetable = qemu_try_blockalign(bs->file, s->max_table_entries * 4);
273 if (s->pagetable == NULL) {
274 ret = -ENOMEM;
275 goto fail;
276 }
b71d1c2e 277
24da78db 278 s->bat_offset = be64_to_cpu(dyndisk_header->table_offset);
59294e46
KW
279
280 ret = bdrv_pread(bs->file, s->bat_offset, s->pagetable,
281 s->max_table_entries * 4);
282 if (ret < 0) {
24da78db
CA
283 goto fail;
284 }
b71d1c2e 285
24da78db
CA
286 s->free_data_block_offset =
287 (s->bat_offset + (s->max_table_entries * 4) + 511) & ~511;
15d35bc5 288
24da78db
CA
289 for (i = 0; i < s->max_table_entries; i++) {
290 be32_to_cpus(&s->pagetable[i]);
291 if (s->pagetable[i] != 0xFFFFFFFF) {
292 int64_t next = (512 * (int64_t) s->pagetable[i]) +
293 s->bitmap_size + s->block_size;
15d35bc5 294
24da78db
CA
295 if (next > s->free_data_block_offset) {
296 s->free_data_block_offset = next;
297 }
298 }
15d35bc5 299 }
15d35bc5 300
fb8fe35f
PL
301 if (s->free_data_block_offset > bdrv_getlength(bs->file)) {
302 error_setg(errp, "block-vpc: free_data_block_offset points after "
303 "the end of file. The image has been truncated.");
304 ret = -EINVAL;
305 goto fail;
306 }
307
24da78db 308 s->last_bitmap_offset = (int64_t) -1;
6a0f9e82 309
6a0f9e82 310#ifdef CACHE
24da78db
CA
311 s->pageentry_u8 = g_malloc(512);
312 s->pageentry_u32 = s->pageentry_u8;
313 s->pageentry_u16 = s->pageentry_u8;
314 s->last_pagetable = -1;
6a0f9e82 315#endif
24da78db 316 }
6a0f9e82 317
848c66e8 318 qemu_co_mutex_init(&s->lock);
612ff3d8
KW
319
320 /* Disable migration when VHD images are used */
81e5f78a
AG
321 error_setg(&s->migration_blocker, "The vpc format used by node '%s' "
322 "does not support live migration",
323 bdrv_get_device_or_node_name(bs));
612ff3d8
KW
324 migrate_add_blocker(s->migration_blocker);
325
6a0f9e82 326 return 0;
59294e46
KW
327
328fail:
97f1c45c 329 qemu_vfree(s->pagetable);
59294e46
KW
330#ifdef CACHE
331 g_free(s->pageentry_u8);
332#endif
333 return ret;
6a0f9e82
FB
334}
335
3fe4b700
JC
336static int vpc_reopen_prepare(BDRVReopenState *state,
337 BlockReopenQueue *queue, Error **errp)
338{
339 return 0;
340}
341
b71d1c2e
AL
342/*
343 * Returns the absolute byte offset of the given sector in the image file.
344 * If the sector is not allocated, -1 is returned instead.
15d35bc5
AL
345 *
346 * The parameter write must be 1 if the offset will be used for a write
347 * operation (the block bitmaps is updated then), 0 otherwise.
b71d1c2e 348 */
15d35bc5
AL
349static inline int64_t get_sector_offset(BlockDriverState *bs,
350 int64_t sector_num, int write)
6a0f9e82
FB
351{
352 BDRVVPCState *s = bs->opaque;
353 uint64_t offset = sector_num * 512;
354 uint64_t bitmap_offset, block_offset;
355 uint32_t pagetable_index, pageentry_index;
356
2cfacb62
AL
357 pagetable_index = offset / s->block_size;
358 pageentry_index = (offset % s->block_size) / 512;
3b46e624 359
15d35bc5
AL
360 if (pagetable_index >= s->max_table_entries || s->pagetable[pagetable_index] == 0xffffffff)
361 return -1; // not allocated
6a0f9e82 362
378e2aea 363 bitmap_offset = 512 * (uint64_t) s->pagetable[pagetable_index];
15d35bc5
AL
364 block_offset = bitmap_offset + s->bitmap_size + (512 * pageentry_index);
365
366 // We must ensure that we don't write to any sectors which are marked as
367 // unused in the bitmap. We get away with setting all bits in the block
368 // bitmap each time we write to a new block. This might cause Virtual PC to
369 // miss sparse read optimization, but it's not a problem in terms of
370 // correctness.
371 if (write && (s->last_bitmap_offset != bitmap_offset)) {
372 uint8_t bitmap[s->bitmap_size];
373
374 s->last_bitmap_offset = bitmap_offset;
375 memset(bitmap, 0xff, s->bitmap_size);
078a458e 376 bdrv_pwrite_sync(bs->file, bitmap_offset, bitmap, s->bitmap_size);
15d35bc5 377 }
3b46e624 378
b71d1c2e 379 return block_offset;
6a0f9e82
FB
380}
381
15d35bc5
AL
382/*
383 * Writes the footer to the end of the image file. This is needed when the
384 * file grows as it overwrites the old footer
385 *
386 * Returns 0 on success and < 0 on error
387 */
388static int rewrite_footer(BlockDriverState* bs)
389{
390 int ret;
391 BDRVVPCState *s = bs->opaque;
392 int64_t offset = s->free_data_block_offset;
393
078a458e 394 ret = bdrv_pwrite_sync(bs->file, offset, s->footer_buf, HEADER_SIZE);
15d35bc5
AL
395 if (ret < 0)
396 return ret;
397
398 return 0;
399}
400
401/*
402 * Allocates a new block. This involves writing a new footer and updating
403 * the Block Allocation Table to use the space at the old end of the image
404 * file (overwriting the old footer)
405 *
406 * Returns the sectors' offset in the image file on success and < 0 on error
407 */
408static int64_t alloc_block(BlockDriverState* bs, int64_t sector_num)
409{
410 BDRVVPCState *s = bs->opaque;
411 int64_t bat_offset;
412 uint32_t index, bat_value;
413 int ret;
414 uint8_t bitmap[s->bitmap_size];
415
416 // Check if sector_num is valid
417 if ((sector_num < 0) || (sector_num > bs->total_sectors))
418 return -1;
419
420 // Write entry into in-memory BAT
421 index = (sector_num * 512) / s->block_size;
422 if (s->pagetable[index] != 0xFFFFFFFF)
423 return -1;
424
425 s->pagetable[index] = s->free_data_block_offset / 512;
426
427 // Initialize the block's bitmap
428 memset(bitmap, 0xff, s->bitmap_size);
5bb1cbac 429 ret = bdrv_pwrite_sync(bs->file, s->free_data_block_offset, bitmap,
078a458e 430 s->bitmap_size);
5bb1cbac
KW
431 if (ret < 0) {
432 return ret;
433 }
15d35bc5
AL
434
435 // Write new footer (the old one will be overwritten)
436 s->free_data_block_offset += s->block_size + s->bitmap_size;
437 ret = rewrite_footer(bs);
438 if (ret < 0)
439 goto fail;
440
441 // Write BAT entry to disk
442 bat_offset = s->bat_offset + (4 * index);
a4127c42 443 bat_value = cpu_to_be32(s->pagetable[index]);
078a458e 444 ret = bdrv_pwrite_sync(bs->file, bat_offset, &bat_value, 4);
15d35bc5
AL
445 if (ret < 0)
446 goto fail;
447
448 return get_sector_offset(bs, sector_num, 0);
449
450fail:
451 s->free_data_block_offset -= (s->block_size + s->bitmap_size);
452 return -1;
453}
454
97b00e28
PB
455static int vpc_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
456{
457 BDRVVPCState *s = (BDRVVPCState *)bs->opaque;
458 VHDFooter *footer = (VHDFooter *) s->footer_buf;
459
0d4cc3e7 460 if (be32_to_cpu(footer->type) != VHD_FIXED) {
97b00e28
PB
461 bdi->cluster_size = s->block_size;
462 }
463
95de6d70 464 bdi->unallocated_blocks_are_zero = true;
97b00e28
PB
465 return 0;
466}
467
5fafdf24 468static int vpc_read(BlockDriverState *bs, int64_t sector_num,
6a0f9e82
FB
469 uint8_t *buf, int nb_sectors)
470{
6c6ea921 471 BDRVVPCState *s = bs->opaque;
6a0f9e82 472 int ret;
b71d1c2e 473 int64_t offset;
6c6ea921 474 int64_t sectors, sectors_per_block;
e54835c0 475 VHDFooter *footer = (VHDFooter *) s->footer_buf;
6a0f9e82 476
0d4cc3e7 477 if (be32_to_cpu(footer->type) == VHD_FIXED) {
24da78db
CA
478 return bdrv_read(bs->file, sector_num, buf, nb_sectors);
479 }
6a0f9e82 480 while (nb_sectors > 0) {
15d35bc5 481 offset = get_sector_offset(bs, sector_num, 0);
b71d1c2e 482
6c6ea921
KW
483 sectors_per_block = s->block_size >> BDRV_SECTOR_BITS;
484 sectors = sectors_per_block - (sector_num % sectors_per_block);
485 if (sectors > nb_sectors) {
486 sectors = nb_sectors;
487 }
488
b71d1c2e 489 if (offset == -1) {
6c6ea921 490 memset(buf, 0, sectors * BDRV_SECTOR_SIZE);
b71d1c2e 491 } else {
6c6ea921
KW
492 ret = bdrv_pread(bs->file, offset, buf,
493 sectors * BDRV_SECTOR_SIZE);
494 if (ret != sectors * BDRV_SECTOR_SIZE) {
b71d1c2e 495 return -1;
6c6ea921 496 }
b71d1c2e
AL
497 }
498
6c6ea921
KW
499 nb_sectors -= sectors;
500 sector_num += sectors;
501 buf += sectors * BDRV_SECTOR_SIZE;
6a0f9e82
FB
502 }
503 return 0;
504}
505
2914caa0
PB
506static coroutine_fn int vpc_co_read(BlockDriverState *bs, int64_t sector_num,
507 uint8_t *buf, int nb_sectors)
508{
509 int ret;
510 BDRVVPCState *s = bs->opaque;
511 qemu_co_mutex_lock(&s->lock);
512 ret = vpc_read(bs, sector_num, buf, nb_sectors);
513 qemu_co_mutex_unlock(&s->lock);
514 return ret;
515}
516
15d35bc5
AL
517static int vpc_write(BlockDriverState *bs, int64_t sector_num,
518 const uint8_t *buf, int nb_sectors)
519{
6c6ea921 520 BDRVVPCState *s = bs->opaque;
15d35bc5 521 int64_t offset;
6c6ea921 522 int64_t sectors, sectors_per_block;
15d35bc5 523 int ret;
e54835c0 524 VHDFooter *footer = (VHDFooter *) s->footer_buf;
15d35bc5 525
0d4cc3e7 526 if (be32_to_cpu(footer->type) == VHD_FIXED) {
24da78db
CA
527 return bdrv_write(bs->file, sector_num, buf, nb_sectors);
528 }
15d35bc5
AL
529 while (nb_sectors > 0) {
530 offset = get_sector_offset(bs, sector_num, 1);
531
6c6ea921
KW
532 sectors_per_block = s->block_size >> BDRV_SECTOR_BITS;
533 sectors = sectors_per_block - (sector_num % sectors_per_block);
534 if (sectors > nb_sectors) {
535 sectors = nb_sectors;
536 }
537
15d35bc5
AL
538 if (offset == -1) {
539 offset = alloc_block(bs, sector_num);
540 if (offset < 0)
541 return -1;
542 }
543
6c6ea921
KW
544 ret = bdrv_pwrite(bs->file, offset, buf, sectors * BDRV_SECTOR_SIZE);
545 if (ret != sectors * BDRV_SECTOR_SIZE) {
15d35bc5 546 return -1;
6c6ea921 547 }
15d35bc5 548
6c6ea921
KW
549 nb_sectors -= sectors;
550 sector_num += sectors;
551 buf += sectors * BDRV_SECTOR_SIZE;
15d35bc5
AL
552 }
553
554 return 0;
555}
556
e183ef75
PB
557static coroutine_fn int vpc_co_write(BlockDriverState *bs, int64_t sector_num,
558 const uint8_t *buf, int nb_sectors)
559{
560 int ret;
561 BDRVVPCState *s = bs->opaque;
562 qemu_co_mutex_lock(&s->lock);
563 ret = vpc_write(bs, sector_num, buf, nb_sectors);
564 qemu_co_mutex_unlock(&s->lock);
565 return ret;
566}
567
0cc84887
KW
568static int64_t coroutine_fn vpc_co_get_block_status(BlockDriverState *bs,
569 int64_t sector_num, int nb_sectors, int *pnum)
570{
571 BDRVVPCState *s = bs->opaque;
572 VHDFooter *footer = (VHDFooter*) s->footer_buf;
2ec711dc 573 int64_t start, offset;
0cc84887
KW
574 bool allocated;
575 int n;
576
577 if (be32_to_cpu(footer->type) == VHD_FIXED) {
578 *pnum = nb_sectors;
579 return BDRV_BLOCK_RAW | BDRV_BLOCK_OFFSET_VALID | BDRV_BLOCK_DATA |
580 (sector_num << BDRV_SECTOR_BITS);
581 }
582
583 offset = get_sector_offset(bs, sector_num, 0);
584 start = offset;
585 allocated = (offset != -1);
586 *pnum = 0;
587
588 do {
589 /* All sectors in a block are contiguous (without using the bitmap) */
590 n = ROUND_UP(sector_num + 1, s->block_size / BDRV_SECTOR_SIZE)
591 - sector_num;
592 n = MIN(n, nb_sectors);
593
594 *pnum += n;
595 sector_num += n;
596 nb_sectors -= n;
2ec711dc
PL
597 /* *pnum can't be greater than one block for allocated
598 * sectors since there is always a bitmap in between. */
599 if (allocated) {
600 return BDRV_BLOCK_DATA | BDRV_BLOCK_OFFSET_VALID | start;
601 }
0cc84887
KW
602 if (nb_sectors == 0) {
603 break;
604 }
0cc84887 605 offset = get_sector_offset(bs, sector_num, 0);
2ec711dc 606 } while (offset == -1);
0cc84887 607
2ec711dc 608 return 0;
0cc84887
KW
609}
610
57c7d9e5
AL
611/*
612 * Calculates the number of cylinders, heads and sectors per cylinder
613 * based on a given number of sectors. This is the algorithm described
614 * in the VHD specification.
615 *
616 * Note that the geometry doesn't always exactly match total_sectors but
617 * may round it down.
6e9ea0c0 618 *
258d2edb
CA
619 * Returns 0 on success, -EFBIG if the size is larger than ~2 TB. Override
620 * the hardware EIDE and ATA-2 limit of 16 heads (max disk size of 127 GB)
621 * and instead allow up to 255 heads.
57c7d9e5 622 */
6e9ea0c0 623static int calculate_geometry(int64_t total_sectors, uint16_t* cyls,
57c7d9e5
AL
624 uint8_t* heads, uint8_t* secs_per_cyl)
625{
626 uint32_t cyls_times_heads;
627
690cbb09 628 total_sectors = MIN(total_sectors, VHD_MAX_GEOMETRY);
57c7d9e5 629
690cbb09 630 if (total_sectors >= 65535LL * 16 * 63) {
57c7d9e5 631 *secs_per_cyl = 255;
690cbb09 632 *heads = 16;
57c7d9e5
AL
633 cyls_times_heads = total_sectors / *secs_per_cyl;
634 } else {
635 *secs_per_cyl = 17;
636 cyls_times_heads = total_sectors / *secs_per_cyl;
637 *heads = (cyls_times_heads + 1023) / 1024;
638
690cbb09 639 if (*heads < 4) {
57c7d9e5 640 *heads = 4;
690cbb09 641 }
57c7d9e5
AL
642
643 if (cyls_times_heads >= (*heads * 1024) || *heads > 16) {
644 *secs_per_cyl = 31;
645 *heads = 16;
646 cyls_times_heads = total_sectors / *secs_per_cyl;
647 }
648
649 if (cyls_times_heads >= (*heads * 1024)) {
650 *secs_per_cyl = 63;
651 *heads = 16;
652 cyls_times_heads = total_sectors / *secs_per_cyl;
653 }
654 }
655
dede4188 656 *cyls = cyls_times_heads / *heads;
6e9ea0c0
AJ
657
658 return 0;
57c7d9e5
AL
659}
660
fef6070e
JC
661static int create_dynamic_disk(BlockDriverState *bs, uint8_t *buf,
662 int64_t total_sectors)
57c7d9e5 663{
e54835c0
JC
664 VHDDynDiskHeader *dyndisk_header =
665 (VHDDynDiskHeader *) buf;
57c7d9e5 666 size_t block_size, num_bat_entries;
24da78db 667 int i;
fef6070e
JC
668 int ret;
669 int64_t offset = 0;
57c7d9e5 670
57c7d9e5
AL
671 // Write the footer (twice: at the beginning and at the end)
672 block_size = 0x200000;
673 num_bat_entries = (total_sectors + block_size / 512) / (block_size / 512);
674
fef6070e
JC
675 ret = bdrv_pwrite_sync(bs, offset, buf, HEADER_SIZE);
676 if (ret) {
f0ff243a
BS
677 goto fail;
678 }
57c7d9e5 679
fef6070e
JC
680 offset = 1536 + ((num_bat_entries * 4 + 511) & ~511);
681 ret = bdrv_pwrite_sync(bs, offset, buf, HEADER_SIZE);
682 if (ret < 0) {
f0ff243a
BS
683 goto fail;
684 }
57c7d9e5
AL
685
686 // Write the initial BAT
fef6070e 687 offset = 3 * 512;
57c7d9e5
AL
688
689 memset(buf, 0xFF, 512);
f0ff243a 690 for (i = 0; i < (num_bat_entries * 4 + 511) / 512; i++) {
fef6070e
JC
691 ret = bdrv_pwrite_sync(bs, offset, buf, 512);
692 if (ret < 0) {
f0ff243a
BS
693 goto fail;
694 }
fef6070e 695 offset += 512;
f0ff243a 696 }
57c7d9e5 697
57c7d9e5
AL
698 // Prepare the Dynamic Disk Header
699 memset(buf, 0, 1024);
700
5ec4d682 701 memcpy(dyndisk_header->magic, "cxsparse", 8);
57c7d9e5 702
78439f6a
CA
703 /*
704 * Note: The spec is actually wrong here for data_offset, it says
705 * 0xFFFFFFFF, but MS tools expect all 64 bits to be set.
706 */
a4127c42
SH
707 dyndisk_header->data_offset = cpu_to_be64(0xFFFFFFFFFFFFFFFFULL);
708 dyndisk_header->table_offset = cpu_to_be64(3 * 512);
709 dyndisk_header->version = cpu_to_be32(0x00010000);
710 dyndisk_header->block_size = cpu_to_be32(block_size);
711 dyndisk_header->max_table_entries = cpu_to_be32(num_bat_entries);
57c7d9e5 712
a4127c42 713 dyndisk_header->checksum = cpu_to_be32(vpc_checksum(buf, 1024));
57c7d9e5
AL
714
715 // Write the header
fef6070e 716 offset = 512;
57c7d9e5 717
fef6070e
JC
718 ret = bdrv_pwrite_sync(bs, offset, buf, 1024);
719 if (ret < 0) {
f0ff243a
BS
720 goto fail;
721 }
f0ff243a 722
24da78db
CA
723 fail:
724 return ret;
725}
726
fef6070e
JC
727static int create_fixed_disk(BlockDriverState *bs, uint8_t *buf,
728 int64_t total_size)
24da78db 729{
fef6070e 730 int ret;
24da78db
CA
731
732 /* Add footer to total size */
fef6070e
JC
733 total_size += HEADER_SIZE;
734
735 ret = bdrv_truncate(bs, total_size);
736 if (ret < 0) {
737 return ret;
24da78db
CA
738 }
739
fef6070e
JC
740 ret = bdrv_pwrite_sync(bs, total_size - HEADER_SIZE, buf, HEADER_SIZE);
741 if (ret < 0) {
742 return ret;
743 }
24da78db 744
24da78db
CA
745 return ret;
746}
747
fec9921f 748static int vpc_create(const char *filename, QemuOpts *opts, Error **errp)
24da78db
CA
749{
750 uint8_t buf[1024];
e54835c0 751 VHDFooter *footer = (VHDFooter *) buf;
fec9921f 752 char *disk_type_param;
fef6070e 753 int i;
24da78db
CA
754 uint16_t cyls = 0;
755 uint8_t heads = 0;
756 uint8_t secs_per_cyl = 0;
757 int64_t total_sectors;
758 int64_t total_size;
759 int disk_type;
760 int ret = -EIO;
fef6070e
JC
761 Error *local_err = NULL;
762 BlockDriverState *bs = NULL;
24da78db
CA
763
764 /* Read out options */
c2eb918e
HT
765 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
766 BDRV_SECTOR_SIZE);
fec9921f
CL
767 disk_type_param = qemu_opt_get_del(opts, BLOCK_OPT_SUBFMT);
768 if (disk_type_param) {
769 if (!strcmp(disk_type_param, "dynamic")) {
24da78db 770 disk_type = VHD_DYNAMIC;
fec9921f 771 } else if (!strcmp(disk_type_param, "fixed")) {
24da78db
CA
772 disk_type = VHD_FIXED;
773 } else {
fec9921f
CL
774 ret = -EINVAL;
775 goto out;
24da78db
CA
776 }
777 } else {
778 disk_type = VHD_DYNAMIC;
779 }
780
fef6070e
JC
781 ret = bdrv_create_file(filename, opts, &local_err);
782 if (ret < 0) {
783 error_propagate(errp, local_err);
fec9921f 784 goto out;
24da78db 785 }
fef6070e
JC
786 ret = bdrv_open(&bs, filename, NULL, NULL, BDRV_O_RDWR | BDRV_O_PROTOCOL,
787 NULL, &local_err);
788 if (ret < 0) {
789 error_propagate(errp, local_err);
790 goto out;
4ab15590
CL
791 }
792
ecd880d9
KW
793 /*
794 * Calculate matching total_size and geometry. Increase the number of
795 * sectors requested until we get enough (or fail). This ensures that
796 * qemu-img convert doesn't truncate images, but rather rounds up.
690cbb09
PL
797 *
798 * If the image size can't be represented by a spec conform CHS geometry,
799 * we set the geometry to 65535 x 16 x 255 (CxHxS) sectors and use
800 * the image size from the VHD footer to calculate total_sectors.
ecd880d9 801 */
690cbb09 802 total_sectors = MIN(VHD_MAX_GEOMETRY, total_size / BDRV_SECTOR_SIZE);
ecd880d9 803 for (i = 0; total_sectors > (int64_t)cyls * heads * secs_per_cyl; i++) {
690cbb09
PL
804 calculate_geometry(total_sectors + i, &cyls, &heads, &secs_per_cyl);
805 }
806
807 if ((int64_t)cyls * heads * secs_per_cyl == VHD_MAX_GEOMETRY) {
808 total_sectors = total_size / BDRV_SECTOR_SIZE;
809 /* Allow a maximum disk size of approximately 2 TB */
810 if (total_sectors > VHD_MAX_SECTORS) {
24da78db 811 ret = -EFBIG;
fef6070e 812 goto out;
24da78db 813 }
690cbb09
PL
814 } else {
815 total_sectors = (int64_t)cyls * heads * secs_per_cyl;
816 total_size = total_sectors * BDRV_SECTOR_SIZE;
24da78db 817 }
ecd880d9 818
24da78db
CA
819 /* Prepare the Hard Disk Footer */
820 memset(buf, 0, 1024);
821
822 memcpy(footer->creator, "conectix", 8);
823 /* TODO Check if "qemu" creator_app is ok for VPC */
824 memcpy(footer->creator_app, "qemu", 4);
825 memcpy(footer->creator_os, "Wi2k", 4);
826
a4127c42
SH
827 footer->features = cpu_to_be32(0x02);
828 footer->version = cpu_to_be32(0x00010000);
24da78db 829 if (disk_type == VHD_DYNAMIC) {
a4127c42 830 footer->data_offset = cpu_to_be64(HEADER_SIZE);
24da78db 831 } else {
a4127c42 832 footer->data_offset = cpu_to_be64(0xFFFFFFFFFFFFFFFFULL);
24da78db 833 }
a4127c42 834 footer->timestamp = cpu_to_be32(time(NULL) - VHD_TIMESTAMP_BASE);
24da78db
CA
835
836 /* Version of Virtual PC 2007 */
a4127c42
SH
837 footer->major = cpu_to_be16(0x0005);
838 footer->minor = cpu_to_be16(0x0003);
3f3f20dc 839 footer->orig_size = cpu_to_be64(total_size);
03671ded 840 footer->current_size = cpu_to_be64(total_size);
a4127c42 841 footer->cyls = cpu_to_be16(cyls);
24da78db
CA
842 footer->heads = heads;
843 footer->secs_per_cyl = secs_per_cyl;
844
a4127c42 845 footer->type = cpu_to_be32(disk_type);
24da78db 846
1fe1fa51
CA
847#if defined(CONFIG_UUID)
848 uuid_generate(footer->uuid);
849#endif
24da78db 850
a4127c42 851 footer->checksum = cpu_to_be32(vpc_checksum(buf, HEADER_SIZE));
24da78db
CA
852
853 if (disk_type == VHD_DYNAMIC) {
fef6070e 854 ret = create_dynamic_disk(bs, buf, total_sectors);
24da78db 855 } else {
fef6070e 856 ret = create_fixed_disk(bs, buf, total_size);
24da78db
CA
857 }
858
fec9921f 859out:
fef6070e 860 bdrv_unref(bs);
fec9921f 861 g_free(disk_type_param);
f0ff243a 862 return ret;
57c7d9e5
AL
863}
864
72c6cc94
KW
865static int vpc_has_zero_init(BlockDriverState *bs)
866{
867 BDRVVPCState *s = bs->opaque;
e54835c0 868 VHDFooter *footer = (VHDFooter *) s->footer_buf;
72c6cc94 869
0d4cc3e7 870 if (be32_to_cpu(footer->type) == VHD_FIXED) {
72c6cc94
KW
871 return bdrv_has_zero_init(bs->file);
872 } else {
873 return 1;
874 }
875}
876
6a0f9e82
FB
877static void vpc_close(BlockDriverState *bs)
878{
879 BDRVVPCState *s = bs->opaque;
97f1c45c 880 qemu_vfree(s->pagetable);
6a0f9e82 881#ifdef CACHE
7267c094 882 g_free(s->pageentry_u8);
6a0f9e82 883#endif
612ff3d8
KW
884
885 migrate_del_blocker(s->migration_blocker);
886 error_free(s->migration_blocker);
6a0f9e82
FB
887}
888
fec9921f
CL
889static QemuOptsList vpc_create_opts = {
890 .name = "vpc-create-opts",
891 .head = QTAILQ_HEAD_INITIALIZER(vpc_create_opts.head),
892 .desc = {
893 {
894 .name = BLOCK_OPT_SIZE,
895 .type = QEMU_OPT_SIZE,
896 .help = "Virtual disk size"
897 },
898 {
899 .name = BLOCK_OPT_SUBFMT,
900 .type = QEMU_OPT_STRING,
901 .help =
902 "Type of virtual hard disk format. Supported formats are "
903 "{dynamic (default) | fixed} "
904 },
905 { /* end of list */ }
906 }
0e7e1989
KW
907};
908
5efa9d5a 909static BlockDriver bdrv_vpc = {
4a411185
KW
910 .format_name = "vpc",
911 .instance_size = sizeof(BDRVVPCState),
c68b89ac 912
72c6cc94
KW
913 .bdrv_probe = vpc_probe,
914 .bdrv_open = vpc_open,
915 .bdrv_close = vpc_close,
916 .bdrv_reopen_prepare = vpc_reopen_prepare,
c282e1fd 917 .bdrv_create = vpc_create,
0e7e1989 918
0cc84887
KW
919 .bdrv_read = vpc_co_read,
920 .bdrv_write = vpc_co_write,
921 .bdrv_co_get_block_status = vpc_co_get_block_status,
c68b89ac 922
97b00e28
PB
923 .bdrv_get_info = vpc_get_info,
924
fec9921f 925 .create_opts = &vpc_create_opts,
72c6cc94 926 .bdrv_has_zero_init = vpc_has_zero_init,
6a0f9e82 927};
5efa9d5a
AL
928
929static void bdrv_vpc_init(void)
930{
931 bdrv_register(&bdrv_vpc);
932}
933
934block_init(bdrv_vpc_init);