2 * Block driver for Connectix / Microsoft Virtual PC images
4 * Copyright (c) 2005 Alex Beregszaszi
5 * Copyright (c) 2009 Kevin Wolf <kwolf@suse.de>
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:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
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
25 #include "qemu-common.h"
26 #include "block_int.h"
28 #include "migration.h"
30 /**************************************************************/
32 #define HEADER_SIZE 512
42 // Seconds since Jan 1, 2000 0:00:00 (UTC)
43 #define VHD_TIMESTAMP_BASE 946684800
47 char creator
[8]; // "conectix"
51 // Offset of next header structure, 0xFFFFFFFF if none
54 // Seconds since Jan 1, 2000 0:00:00 (UTC)
57 char creator_app
[4]; // "vpc "
60 char creator_os
[4]; // "Wi2k"
71 // Checksum of the Hard Disk Footer ("one's complement of the sum of all
72 // the bytes in the footer without the checksum field")
75 // UUID used to identify a parent hard disk (backing file)
78 uint8_t in_saved_state
;
81 struct vhd_dyndisk_header
{
82 char magic
[8]; // "cxsparse"
84 // Offset of next header structure, 0xFFFFFFFF if none
87 // Offset of the Block Allocation Table (BAT)
88 uint64_t table_offset
;
91 uint32_t max_table_entries
; // 32bit/entry
93 // 2 MB by default, must be a power of two
97 uint8_t parent_uuid
[16];
98 uint32_t parent_timestamp
;
101 // Backing file name (in UTF-16)
102 uint8_t parent_name
[512];
107 uint32_t data_length
;
109 uint64_t data_offset
;
113 typedef struct BDRVVPCState
{
115 uint8_t footer_buf
[HEADER_SIZE
];
116 uint64_t free_data_block_offset
;
117 int max_table_entries
;
120 uint64_t last_bitmap_offset
;
123 uint32_t bitmap_size
;
126 uint8_t *pageentry_u8
;
127 uint32_t *pageentry_u32
;
128 uint16_t *pageentry_u16
;
130 uint64_t last_bitmap
;
133 Error
*migration_blocker
;
136 static uint32_t vpc_checksum(uint8_t* buf
, size_t size
)
141 for (i
= 0; i
< size
; i
++)
148 static int vpc_probe(const uint8_t *buf
, int buf_size
, const char *filename
)
150 if (buf_size
>= 8 && !strncmp((char *)buf
, "conectix", 8))
155 static int vpc_open(BlockDriverState
*bs
, int flags
)
157 BDRVVPCState
*s
= bs
->opaque
;
159 struct vhd_footer
* footer
;
160 struct vhd_dyndisk_header
* dyndisk_header
;
161 uint8_t buf
[HEADER_SIZE
];
164 int disk_type
= VHD_DYNAMIC
;
166 if (bdrv_pread(bs
->file
, 0, s
->footer_buf
, HEADER_SIZE
) != HEADER_SIZE
)
169 footer
= (struct vhd_footer
*) s
->footer_buf
;
170 if (strncmp(footer
->creator
, "conectix", 8)) {
171 int64_t offset
= bdrv_getlength(bs
->file
);
172 if (offset
< HEADER_SIZE
) {
175 /* If a fixed disk, the footer is found only at the end of the file */
176 if (bdrv_pread(bs
->file
, offset
-HEADER_SIZE
, s
->footer_buf
, HEADER_SIZE
)
180 if (strncmp(footer
->creator
, "conectix", 8)) {
183 disk_type
= VHD_FIXED
;
186 checksum
= be32_to_cpu(footer
->checksum
);
187 footer
->checksum
= 0;
188 if (vpc_checksum(s
->footer_buf
, HEADER_SIZE
) != checksum
)
189 fprintf(stderr
, "block-vpc: The header checksum of '%s' is "
190 "incorrect.\n", bs
->filename
);
192 // The visible size of a image in Virtual PC depends on the geometry
193 // rather than on the size stored in the footer (the size in the footer
194 // is too large usually)
195 bs
->total_sectors
= (int64_t)
196 be16_to_cpu(footer
->cyls
) * footer
->heads
* footer
->secs_per_cyl
;
198 if (bs
->total_sectors
>= 65535 * 16 * 255) {
203 if (disk_type
== VHD_DYNAMIC
) {
204 if (bdrv_pread(bs
->file
, be64_to_cpu(footer
->data_offset
), buf
,
205 HEADER_SIZE
) != HEADER_SIZE
) {
209 dyndisk_header
= (struct vhd_dyndisk_header
*) buf
;
211 if (strncmp(dyndisk_header
->magic
, "cxsparse", 8)) {
215 s
->block_size
= be32_to_cpu(dyndisk_header
->block_size
);
216 s
->bitmap_size
= ((s
->block_size
/ (8 * 512)) + 511) & ~511;
218 s
->max_table_entries
= be32_to_cpu(dyndisk_header
->max_table_entries
);
219 s
->pagetable
= g_malloc(s
->max_table_entries
* 4);
221 s
->bat_offset
= be64_to_cpu(dyndisk_header
->table_offset
);
222 if (bdrv_pread(bs
->file
, s
->bat_offset
, s
->pagetable
,
223 s
->max_table_entries
* 4) != s
->max_table_entries
* 4) {
227 s
->free_data_block_offset
=
228 (s
->bat_offset
+ (s
->max_table_entries
* 4) + 511) & ~511;
230 for (i
= 0; i
< s
->max_table_entries
; i
++) {
231 be32_to_cpus(&s
->pagetable
[i
]);
232 if (s
->pagetable
[i
] != 0xFFFFFFFF) {
233 int64_t next
= (512 * (int64_t) s
->pagetable
[i
]) +
234 s
->bitmap_size
+ s
->block_size
;
236 if (next
> s
->free_data_block_offset
) {
237 s
->free_data_block_offset
= next
;
242 s
->last_bitmap_offset
= (int64_t) -1;
245 s
->pageentry_u8
= g_malloc(512);
246 s
->pageentry_u32
= s
->pageentry_u8
;
247 s
->pageentry_u16
= s
->pageentry_u8
;
248 s
->last_pagetable
= -1;
252 qemu_co_mutex_init(&s
->lock
);
254 /* Disable migration when VHD images are used */
255 error_set(&s
->migration_blocker
,
256 QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED
,
257 "vpc", bs
->device_name
, "live migration");
258 migrate_add_blocker(s
->migration_blocker
);
266 * Returns the absolute byte offset of the given sector in the image file.
267 * If the sector is not allocated, -1 is returned instead.
269 * The parameter write must be 1 if the offset will be used for a write
270 * operation (the block bitmaps is updated then), 0 otherwise.
272 static inline int64_t get_sector_offset(BlockDriverState
*bs
,
273 int64_t sector_num
, int write
)
275 BDRVVPCState
*s
= bs
->opaque
;
276 uint64_t offset
= sector_num
* 512;
277 uint64_t bitmap_offset
, block_offset
;
278 uint32_t pagetable_index
, pageentry_index
;
280 pagetable_index
= offset
/ s
->block_size
;
281 pageentry_index
= (offset
% s
->block_size
) / 512;
283 if (pagetable_index
>= s
->max_table_entries
|| s
->pagetable
[pagetable_index
] == 0xffffffff)
284 return -1; // not allocated
286 bitmap_offset
= 512 * (uint64_t) s
->pagetable
[pagetable_index
];
287 block_offset
= bitmap_offset
+ s
->bitmap_size
+ (512 * pageentry_index
);
289 // We must ensure that we don't write to any sectors which are marked as
290 // unused in the bitmap. We get away with setting all bits in the block
291 // bitmap each time we write to a new block. This might cause Virtual PC to
292 // miss sparse read optimization, but it's not a problem in terms of
294 if (write
&& (s
->last_bitmap_offset
!= bitmap_offset
)) {
295 uint8_t bitmap
[s
->bitmap_size
];
297 s
->last_bitmap_offset
= bitmap_offset
;
298 memset(bitmap
, 0xff, s
->bitmap_size
);
299 bdrv_pwrite_sync(bs
->file
, bitmap_offset
, bitmap
, s
->bitmap_size
);
302 // printf("sector: %" PRIx64 ", index: %x, offset: %x, bioff: %" PRIx64 ", bloff: %" PRIx64 "\n",
303 // sector_num, pagetable_index, pageentry_index,
304 // bitmap_offset, block_offset);
306 // disabled by reason
309 if (bitmap_offset
!= s
->last_bitmap
)
311 lseek(s
->fd
, bitmap_offset
, SEEK_SET
);
313 s
->last_bitmap
= bitmap_offset
;
315 // Scary! Bitmap is stored as big endian 32bit entries,
316 // while we used to look it up byte by byte
317 read(s
->fd
, s
->pageentry_u8
, 512);
318 for (i
= 0; i
< 128; i
++)
319 be32_to_cpus(&s
->pageentry_u32
[i
]);
322 if ((s
->pageentry_u8
[pageentry_index
/ 8] >> (pageentry_index
% 8)) & 1)
325 lseek(s
->fd
, bitmap_offset
+ (pageentry_index
/ 8), SEEK_SET
);
327 read(s
->fd
, &bitmap_entry
, 1);
329 if ((bitmap_entry
>> (pageentry_index
% 8)) & 1)
330 return -1; // not allocated
338 * Writes the footer to the end of the image file. This is needed when the
339 * file grows as it overwrites the old footer
341 * Returns 0 on success and < 0 on error
343 static int rewrite_footer(BlockDriverState
* bs
)
346 BDRVVPCState
*s
= bs
->opaque
;
347 int64_t offset
= s
->free_data_block_offset
;
349 ret
= bdrv_pwrite_sync(bs
->file
, offset
, s
->footer_buf
, HEADER_SIZE
);
357 * Allocates a new block. This involves writing a new footer and updating
358 * the Block Allocation Table to use the space at the old end of the image
359 * file (overwriting the old footer)
361 * Returns the sectors' offset in the image file on success and < 0 on error
363 static int64_t alloc_block(BlockDriverState
* bs
, int64_t sector_num
)
365 BDRVVPCState
*s
= bs
->opaque
;
367 uint32_t index
, bat_value
;
369 uint8_t bitmap
[s
->bitmap_size
];
371 // Check if sector_num is valid
372 if ((sector_num
< 0) || (sector_num
> bs
->total_sectors
))
375 // Write entry into in-memory BAT
376 index
= (sector_num
* 512) / s
->block_size
;
377 if (s
->pagetable
[index
] != 0xFFFFFFFF)
380 s
->pagetable
[index
] = s
->free_data_block_offset
/ 512;
382 // Initialize the block's bitmap
383 memset(bitmap
, 0xff, s
->bitmap_size
);
384 ret
= bdrv_pwrite_sync(bs
->file
, s
->free_data_block_offset
, bitmap
,
390 // Write new footer (the old one will be overwritten)
391 s
->free_data_block_offset
+= s
->block_size
+ s
->bitmap_size
;
392 ret
= rewrite_footer(bs
);
396 // Write BAT entry to disk
397 bat_offset
= s
->bat_offset
+ (4 * index
);
398 bat_value
= be32_to_cpu(s
->pagetable
[index
]);
399 ret
= bdrv_pwrite_sync(bs
->file
, bat_offset
, &bat_value
, 4);
403 return get_sector_offset(bs
, sector_num
, 0);
406 s
->free_data_block_offset
-= (s
->block_size
+ s
->bitmap_size
);
410 static int vpc_read(BlockDriverState
*bs
, int64_t sector_num
,
411 uint8_t *buf
, int nb_sectors
)
413 BDRVVPCState
*s
= bs
->opaque
;
416 int64_t sectors
, sectors_per_block
;
417 struct vhd_footer
*footer
= (struct vhd_footer
*) s
->footer_buf
;
419 if (cpu_to_be32(footer
->type
) == VHD_FIXED
) {
420 return bdrv_read(bs
->file
, sector_num
, buf
, nb_sectors
);
422 while (nb_sectors
> 0) {
423 offset
= get_sector_offset(bs
, sector_num
, 0);
425 sectors_per_block
= s
->block_size
>> BDRV_SECTOR_BITS
;
426 sectors
= sectors_per_block
- (sector_num
% sectors_per_block
);
427 if (sectors
> nb_sectors
) {
428 sectors
= nb_sectors
;
432 memset(buf
, 0, sectors
* BDRV_SECTOR_SIZE
);
434 ret
= bdrv_pread(bs
->file
, offset
, buf
,
435 sectors
* BDRV_SECTOR_SIZE
);
436 if (ret
!= sectors
* BDRV_SECTOR_SIZE
) {
441 nb_sectors
-= sectors
;
442 sector_num
+= sectors
;
443 buf
+= sectors
* BDRV_SECTOR_SIZE
;
448 static coroutine_fn
int vpc_co_read(BlockDriverState
*bs
, int64_t sector_num
,
449 uint8_t *buf
, int nb_sectors
)
452 BDRVVPCState
*s
= bs
->opaque
;
453 qemu_co_mutex_lock(&s
->lock
);
454 ret
= vpc_read(bs
, sector_num
, buf
, nb_sectors
);
455 qemu_co_mutex_unlock(&s
->lock
);
459 static int vpc_write(BlockDriverState
*bs
, int64_t sector_num
,
460 const uint8_t *buf
, int nb_sectors
)
462 BDRVVPCState
*s
= bs
->opaque
;
464 int64_t sectors
, sectors_per_block
;
466 struct vhd_footer
*footer
= (struct vhd_footer
*) s
->footer_buf
;
468 if (cpu_to_be32(footer
->type
) == VHD_FIXED
) {
469 return bdrv_write(bs
->file
, sector_num
, buf
, nb_sectors
);
471 while (nb_sectors
> 0) {
472 offset
= get_sector_offset(bs
, sector_num
, 1);
474 sectors_per_block
= s
->block_size
>> BDRV_SECTOR_BITS
;
475 sectors
= sectors_per_block
- (sector_num
% sectors_per_block
);
476 if (sectors
> nb_sectors
) {
477 sectors
= nb_sectors
;
481 offset
= alloc_block(bs
, sector_num
);
486 ret
= bdrv_pwrite(bs
->file
, offset
, buf
, sectors
* BDRV_SECTOR_SIZE
);
487 if (ret
!= sectors
* BDRV_SECTOR_SIZE
) {
491 nb_sectors
-= sectors
;
492 sector_num
+= sectors
;
493 buf
+= sectors
* BDRV_SECTOR_SIZE
;
499 static coroutine_fn
int vpc_co_write(BlockDriverState
*bs
, int64_t sector_num
,
500 const uint8_t *buf
, int nb_sectors
)
503 BDRVVPCState
*s
= bs
->opaque
;
504 qemu_co_mutex_lock(&s
->lock
);
505 ret
= vpc_write(bs
, sector_num
, buf
, nb_sectors
);
506 qemu_co_mutex_unlock(&s
->lock
);
510 static coroutine_fn
int vpc_co_flush(BlockDriverState
*bs
)
512 return bdrv_co_flush(bs
->file
);
516 * Calculates the number of cylinders, heads and sectors per cylinder
517 * based on a given number of sectors. This is the algorithm described
518 * in the VHD specification.
520 * Note that the geometry doesn't always exactly match total_sectors but
523 * Returns 0 on success, -EFBIG if the size is larger than 127 GB
525 static int calculate_geometry(int64_t total_sectors
, uint16_t* cyls
,
526 uint8_t* heads
, uint8_t* secs_per_cyl
)
528 uint32_t cyls_times_heads
;
530 if (total_sectors
> 65535 * 16 * 255)
533 if (total_sectors
> 65535 * 16 * 63) {
536 cyls_times_heads
= total_sectors
/ *secs_per_cyl
;
539 cyls_times_heads
= total_sectors
/ *secs_per_cyl
;
540 *heads
= (cyls_times_heads
+ 1023) / 1024;
545 if (cyls_times_heads
>= (*heads
* 1024) || *heads
> 16) {
548 cyls_times_heads
= total_sectors
/ *secs_per_cyl
;
551 if (cyls_times_heads
>= (*heads
* 1024)) {
554 cyls_times_heads
= total_sectors
/ *secs_per_cyl
;
558 *cyls
= cyls_times_heads
/ *heads
;
563 static int create_dynamic_disk(int fd
, uint8_t *buf
, int64_t total_sectors
)
565 struct vhd_dyndisk_header
* dyndisk_header
=
566 (struct vhd_dyndisk_header
*) buf
;
567 size_t block_size
, num_bat_entries
;
571 // Write the footer (twice: at the beginning and at the end)
572 block_size
= 0x200000;
573 num_bat_entries
= (total_sectors
+ block_size
/ 512) / (block_size
/ 512);
575 if (write(fd
, buf
, HEADER_SIZE
) != HEADER_SIZE
) {
579 if (lseek(fd
, 1536 + ((num_bat_entries
* 4 + 511) & ~511), SEEK_SET
) < 0) {
582 if (write(fd
, buf
, HEADER_SIZE
) != HEADER_SIZE
) {
586 // Write the initial BAT
587 if (lseek(fd
, 3 * 512, SEEK_SET
) < 0) {
591 memset(buf
, 0xFF, 512);
592 for (i
= 0; i
< (num_bat_entries
* 4 + 511) / 512; i
++) {
593 if (write(fd
, buf
, 512) != 512) {
598 // Prepare the Dynamic Disk Header
599 memset(buf
, 0, 1024);
601 memcpy(dyndisk_header
->magic
, "cxsparse", 8);
604 * Note: The spec is actually wrong here for data_offset, it says
605 * 0xFFFFFFFF, but MS tools expect all 64 bits to be set.
607 dyndisk_header
->data_offset
= be64_to_cpu(0xFFFFFFFFFFFFFFFFULL
);
608 dyndisk_header
->table_offset
= be64_to_cpu(3 * 512);
609 dyndisk_header
->version
= be32_to_cpu(0x00010000);
610 dyndisk_header
->block_size
= be32_to_cpu(block_size
);
611 dyndisk_header
->max_table_entries
= be32_to_cpu(num_bat_entries
);
613 dyndisk_header
->checksum
= be32_to_cpu(vpc_checksum(buf
, 1024));
616 if (lseek(fd
, 512, SEEK_SET
) < 0) {
620 if (write(fd
, buf
, 1024) != 1024) {
629 static int create_fixed_disk(int fd
, uint8_t *buf
, int64_t total_size
)
633 /* Add footer to total size */
635 if (ftruncate(fd
, total_size
) != 0) {
639 if (lseek(fd
, -512, SEEK_END
) < 0) {
642 if (write(fd
, buf
, HEADER_SIZE
) != HEADER_SIZE
) {
652 static int vpc_create(const char *filename
, QEMUOptionParameter
*options
)
655 struct vhd_footer
*footer
= (struct vhd_footer
*) buf
;
656 QEMUOptionParameter
*disk_type_param
;
660 uint8_t secs_per_cyl
= 0;
661 int64_t total_sectors
;
666 /* Read out options */
667 total_size
= get_option_parameter(options
, BLOCK_OPT_SIZE
)->value
.n
;
669 disk_type_param
= get_option_parameter(options
, BLOCK_OPT_SUBFMT
);
670 if (disk_type_param
&& disk_type_param
->value
.s
) {
671 if (!strcmp(disk_type_param
->value
.s
, "dynamic")) {
672 disk_type
= VHD_DYNAMIC
;
673 } else if (!strcmp(disk_type_param
->value
.s
, "fixed")) {
674 disk_type
= VHD_FIXED
;
679 disk_type
= VHD_DYNAMIC
;
682 /* Create the file */
683 fd
= open(filename
, O_WRONLY
| O_CREAT
| O_TRUNC
| O_BINARY
, 0644);
689 * Calculate matching total_size and geometry. Increase the number of
690 * sectors requested until we get enough (or fail). This ensures that
691 * qemu-img convert doesn't truncate images, but rather rounds up.
693 total_sectors
= total_size
/ BDRV_SECTOR_SIZE
;
694 for (i
= 0; total_sectors
> (int64_t)cyls
* heads
* secs_per_cyl
; i
++) {
695 if (calculate_geometry(total_sectors
+ i
, &cyls
, &heads
,
703 total_sectors
= (int64_t) cyls
* heads
* secs_per_cyl
;
705 /* Prepare the Hard Disk Footer */
706 memset(buf
, 0, 1024);
708 memcpy(footer
->creator
, "conectix", 8);
709 /* TODO Check if "qemu" creator_app is ok for VPC */
710 memcpy(footer
->creator_app
, "qemu", 4);
711 memcpy(footer
->creator_os
, "Wi2k", 4);
713 footer
->features
= be32_to_cpu(0x02);
714 footer
->version
= be32_to_cpu(0x00010000);
715 if (disk_type
== VHD_DYNAMIC
) {
716 footer
->data_offset
= be64_to_cpu(HEADER_SIZE
);
718 footer
->data_offset
= be64_to_cpu(0xFFFFFFFFFFFFFFFFULL
);
720 footer
->timestamp
= be32_to_cpu(time(NULL
) - VHD_TIMESTAMP_BASE
);
722 /* Version of Virtual PC 2007 */
723 footer
->major
= be16_to_cpu(0x0005);
724 footer
->minor
= be16_to_cpu(0x0003);
725 if (disk_type
== VHD_DYNAMIC
) {
726 footer
->orig_size
= be64_to_cpu(total_sectors
* 512);
727 footer
->size
= be64_to_cpu(total_sectors
* 512);
729 footer
->orig_size
= be64_to_cpu(total_size
);
730 footer
->size
= be64_to_cpu(total_size
);
732 footer
->cyls
= be16_to_cpu(cyls
);
733 footer
->heads
= heads
;
734 footer
->secs_per_cyl
= secs_per_cyl
;
736 footer
->type
= be32_to_cpu(disk_type
);
738 /* TODO uuid is missing */
740 footer
->checksum
= be32_to_cpu(vpc_checksum(buf
, HEADER_SIZE
));
742 if (disk_type
== VHD_DYNAMIC
) {
743 ret
= create_dynamic_disk(fd
, buf
, total_sectors
);
745 ret
= create_fixed_disk(fd
, buf
, total_size
);
753 static void vpc_close(BlockDriverState
*bs
)
755 BDRVVPCState
*s
= bs
->opaque
;
756 g_free(s
->pagetable
);
758 g_free(s
->pageentry_u8
);
761 migrate_del_blocker(s
->migration_blocker
);
762 error_free(s
->migration_blocker
);
765 static QEMUOptionParameter vpc_create_options
[] = {
767 .name
= BLOCK_OPT_SIZE
,
769 .help
= "Virtual disk size"
772 .name
= BLOCK_OPT_SUBFMT
,
775 "Type of virtual hard disk format. Supported formats are "
776 "{dynamic (default) | fixed} "
781 static BlockDriver bdrv_vpc
= {
782 .format_name
= "vpc",
783 .instance_size
= sizeof(BDRVVPCState
),
785 .bdrv_probe
= vpc_probe
,
786 .bdrv_open
= vpc_open
,
787 .bdrv_close
= vpc_close
,
788 .bdrv_create
= vpc_create
,
790 .bdrv_read
= vpc_co_read
,
791 .bdrv_write
= vpc_co_write
,
792 .bdrv_co_flush_to_disk
= vpc_co_flush
,
794 .create_options
= vpc_create_options
,
797 static void bdrv_vpc_init(void)
799 bdrv_register(&bdrv_vpc
);
802 block_init(bdrv_vpc_init
);