xref: /openbmc/qemu/block/vpc.c (revision 77a8257e)
1 /*
2  * Block driver for Connectix / Microsoft Virtual PC images
3  *
4  * Copyright (c) 2005 Alex Beregszaszi
5  * Copyright (c) 2009 Kevin Wolf <kwolf@suse.de>
6  *
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  */
25 #include "qemu-common.h"
26 #include "block/block_int.h"
27 #include "qemu/module.h"
28 #include "migration/migration.h"
29 #if defined(CONFIG_UUID)
30 #include <uuid/uuid.h>
31 #endif
32 
33 /**************************************************************/
34 
35 #define HEADER_SIZE 512
36 
37 //#define CACHE
38 
39 enum vhd_type {
40     VHD_FIXED           = 2,
41     VHD_DYNAMIC         = 3,
42     VHD_DIFFERENCING    = 4,
43 };
44 
45 // Seconds since Jan 1, 2000 0:00:00 (UTC)
46 #define VHD_TIMESTAMP_BASE 946684800
47 
48 #define VHD_MAX_SECTORS       (65535LL * 255 * 255)
49 #define VHD_MAX_GEOMETRY      (65535LL *  16 * 255)
50 
51 // always big-endian
52 typedef struct vhd_footer {
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;
69     uint64_t    current_size;
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;
85 } QEMU_PACKED VHDFooter;
86 
87 typedef struct vhd_dyndisk_header {
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];
117 } QEMU_PACKED VHDDynDiskHeader;
118 
119 typedef struct BDRVVPCState {
120     CoMutex lock;
121     uint8_t footer_buf[HEADER_SIZE];
122     uint64_t free_data_block_offset;
123     int max_table_entries;
124     uint32_t *pagetable;
125     uint64_t bat_offset;
126     uint64_t last_bitmap_offset;
127 
128     uint32_t block_size;
129     uint32_t bitmap_size;
130 
131 #ifdef CACHE
132     uint8_t *pageentry_u8;
133     uint32_t *pageentry_u32;
134     uint16_t *pageentry_u16;
135 
136     uint64_t last_bitmap;
137 #endif
138 
139     Error *migration_blocker;
140 } BDRVVPCState;
141 
142 static 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 
154 static int vpc_probe(const uint8_t *buf, int buf_size, const char *filename)
155 {
156     if (buf_size >= 8 && !strncmp((char *)buf, "conectix", 8))
157 	return 100;
158     return 0;
159 }
160 
161 static int vpc_open(BlockDriverState *bs, QDict *options, int flags,
162                     Error **errp)
163 {
164     BDRVVPCState *s = bs->opaque;
165     int i;
166     VHDFooter *footer;
167     VHDDynDiskHeader *dyndisk_header;
168     uint8_t buf[HEADER_SIZE];
169     uint32_t checksum;
170     uint64_t computed_size;
171     int disk_type = VHD_DYNAMIC;
172     int ret;
173 
174     ret = bdrv_pread(bs->file, 0, s->footer_buf, HEADER_SIZE);
175     if (ret < 0) {
176         goto fail;
177     }
178 
179     footer = (VHDFooter *) s->footer_buf;
180     if (strncmp(footer->creator, "conectix", 8)) {
181         int64_t offset = bdrv_getlength(bs->file);
182         if (offset < 0) {
183             ret = offset;
184             goto fail;
185         } else if (offset < HEADER_SIZE) {
186             ret = -EINVAL;
187             goto fail;
188         }
189 
190         /* If a fixed disk, the footer is found only at the end of the file */
191         ret = bdrv_pread(bs->file, offset-HEADER_SIZE, s->footer_buf,
192                          HEADER_SIZE);
193         if (ret < 0) {
194             goto fail;
195         }
196         if (strncmp(footer->creator, "conectix", 8)) {
197             error_setg(errp, "invalid VPC image");
198             ret = -EINVAL;
199             goto fail;
200         }
201         disk_type = VHD_FIXED;
202     }
203 
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 "
208             "incorrect.\n", bs->filename);
209 
210     /* Write 'checksum' back to footer, or else will leave it with zero. */
211     footer->checksum = cpu_to_be32(checksum);
212 
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;
218 
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
221      * footer->current_size for them. */
222     if (bs->total_sectors == VHD_MAX_GEOMETRY) {
223         bs->total_sectors = be64_to_cpu(footer->current_size) /
224                             BDRV_SECTOR_SIZE;
225     }
226 
227     /* Allow a maximum disk size of approximately 2 TB */
228     if (bs->total_sectors >= VHD_MAX_SECTORS) {
229         ret = -EFBIG;
230         goto fail;
231     }
232 
233     if (disk_type == VHD_DYNAMIC) {
234         ret = bdrv_pread(bs->file, be64_to_cpu(footer->data_offset), buf,
235                          HEADER_SIZE);
236         if (ret < 0) {
237             goto fail;
238         }
239 
240         dyndisk_header = (VHDDynDiskHeader *) buf;
241 
242         if (strncmp(dyndisk_header->magic, "cxsparse", 8)) {
243             ret = -EINVAL;
244             goto fail;
245         }
246 
247         s->block_size = be32_to_cpu(dyndisk_header->block_size);
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         }
253         s->bitmap_size = ((s->block_size / (8 * 512)) + 511) & ~511;
254 
255         s->max_table_entries = be32_to_cpu(dyndisk_header->max_table_entries);
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 
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         }
277 
278         s->bat_offset = be64_to_cpu(dyndisk_header->table_offset);
279 
280         ret = bdrv_pread(bs->file, s->bat_offset, s->pagetable,
281                          s->max_table_entries * 4);
282         if (ret < 0) {
283             goto fail;
284         }
285 
286         s->free_data_block_offset =
287             (s->bat_offset + (s->max_table_entries * 4) + 511) & ~511;
288 
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;
294 
295                 if (next > s->free_data_block_offset) {
296                     s->free_data_block_offset = next;
297                 }
298             }
299         }
300 
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 
308         s->last_bitmap_offset = (int64_t) -1;
309 
310 #ifdef CACHE
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;
315 #endif
316     }
317 
318     qemu_co_mutex_init(&s->lock);
319 
320     /* Disable migration when VHD images are used */
321     error_set(&s->migration_blocker,
322               QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
323               "vpc", bdrv_get_device_name(bs), "live migration");
324     migrate_add_blocker(s->migration_blocker);
325 
326     return 0;
327 
328 fail:
329     qemu_vfree(s->pagetable);
330 #ifdef CACHE
331     g_free(s->pageentry_u8);
332 #endif
333     return ret;
334 }
335 
336 static int vpc_reopen_prepare(BDRVReopenState *state,
337                               BlockReopenQueue *queue, Error **errp)
338 {
339     return 0;
340 }
341 
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.
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.
348  */
349 static inline int64_t get_sector_offset(BlockDriverState *bs,
350     int64_t sector_num, int write)
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 
357     pagetable_index = offset / s->block_size;
358     pageentry_index = (offset % s->block_size) / 512;
359 
360     if (pagetable_index >= s->max_table_entries || s->pagetable[pagetable_index] == 0xffffffff)
361         return -1; // not allocated
362 
363     bitmap_offset = 512 * (uint64_t) s->pagetable[pagetable_index];
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);
376         bdrv_pwrite_sync(bs->file, bitmap_offset, bitmap, s->bitmap_size);
377     }
378 
379     return block_offset;
380 }
381 
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  */
388 static int rewrite_footer(BlockDriverState* bs)
389 {
390     int ret;
391     BDRVVPCState *s = bs->opaque;
392     int64_t offset = s->free_data_block_offset;
393 
394     ret = bdrv_pwrite_sync(bs->file, offset, s->footer_buf, HEADER_SIZE);
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  */
408 static 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);
429     ret = bdrv_pwrite_sync(bs->file, s->free_data_block_offset, bitmap,
430         s->bitmap_size);
431     if (ret < 0) {
432         return ret;
433     }
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);
443     bat_value = cpu_to_be32(s->pagetable[index]);
444     ret = bdrv_pwrite_sync(bs->file, bat_offset, &bat_value, 4);
445     if (ret < 0)
446         goto fail;
447 
448     return get_sector_offset(bs, sector_num, 0);
449 
450 fail:
451     s->free_data_block_offset -= (s->block_size + s->bitmap_size);
452     return -1;
453 }
454 
455 static int vpc_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
456 {
457     BDRVVPCState *s = (BDRVVPCState *)bs->opaque;
458     VHDFooter *footer = (VHDFooter *) s->footer_buf;
459 
460     if (be32_to_cpu(footer->type) != VHD_FIXED) {
461         bdi->cluster_size = s->block_size;
462     }
463 
464     bdi->unallocated_blocks_are_zero = true;
465     return 0;
466 }
467 
468 static int vpc_read(BlockDriverState *bs, int64_t sector_num,
469                     uint8_t *buf, int nb_sectors)
470 {
471     BDRVVPCState *s = bs->opaque;
472     int ret;
473     int64_t offset;
474     int64_t sectors, sectors_per_block;
475     VHDFooter *footer = (VHDFooter *) s->footer_buf;
476 
477     if (be32_to_cpu(footer->type) == VHD_FIXED) {
478         return bdrv_read(bs->file, sector_num, buf, nb_sectors);
479     }
480     while (nb_sectors > 0) {
481         offset = get_sector_offset(bs, sector_num, 0);
482 
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 
489         if (offset == -1) {
490             memset(buf, 0, sectors * BDRV_SECTOR_SIZE);
491         } else {
492             ret = bdrv_pread(bs->file, offset, buf,
493                 sectors * BDRV_SECTOR_SIZE);
494             if (ret != sectors * BDRV_SECTOR_SIZE) {
495                 return -1;
496             }
497         }
498 
499         nb_sectors -= sectors;
500         sector_num += sectors;
501         buf += sectors * BDRV_SECTOR_SIZE;
502     }
503     return 0;
504 }
505 
506 static 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 
517 static int vpc_write(BlockDriverState *bs, int64_t sector_num,
518     const uint8_t *buf, int nb_sectors)
519 {
520     BDRVVPCState *s = bs->opaque;
521     int64_t offset;
522     int64_t sectors, sectors_per_block;
523     int ret;
524     VHDFooter *footer =  (VHDFooter *) s->footer_buf;
525 
526     if (be32_to_cpu(footer->type) == VHD_FIXED) {
527         return bdrv_write(bs->file, sector_num, buf, nb_sectors);
528     }
529     while (nb_sectors > 0) {
530         offset = get_sector_offset(bs, sector_num, 1);
531 
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 
538         if (offset == -1) {
539             offset = alloc_block(bs, sector_num);
540             if (offset < 0)
541                 return -1;
542         }
543 
544         ret = bdrv_pwrite(bs->file, offset, buf, sectors * BDRV_SECTOR_SIZE);
545         if (ret != sectors * BDRV_SECTOR_SIZE) {
546             return -1;
547         }
548 
549         nb_sectors -= sectors;
550         sector_num += sectors;
551         buf += sectors * BDRV_SECTOR_SIZE;
552     }
553 
554     return 0;
555 }
556 
557 static 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 
568 static 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;
573     int64_t start, offset;
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;
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         }
602         if (nb_sectors == 0) {
603             break;
604         }
605         offset = get_sector_offset(bs, sector_num, 0);
606     } while (offset == -1);
607 
608     return 0;
609 }
610 
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.
618  *
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.
622  */
623 static int calculate_geometry(int64_t total_sectors, uint16_t* cyls,
624     uint8_t* heads, uint8_t* secs_per_cyl)
625 {
626     uint32_t cyls_times_heads;
627 
628     total_sectors = MIN(total_sectors, VHD_MAX_GEOMETRY);
629 
630     if (total_sectors >= 65535LL * 16 * 63) {
631         *secs_per_cyl = 255;
632         *heads = 16;
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 
639         if (*heads < 4) {
640             *heads = 4;
641         }
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 
656     *cyls = cyls_times_heads / *heads;
657 
658     return 0;
659 }
660 
661 static int create_dynamic_disk(BlockDriverState *bs, uint8_t *buf,
662                                int64_t total_sectors)
663 {
664     VHDDynDiskHeader *dyndisk_header =
665         (VHDDynDiskHeader *) buf;
666     size_t block_size, num_bat_entries;
667     int i;
668     int ret;
669     int64_t offset = 0;
670 
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 
675     ret = bdrv_pwrite_sync(bs, offset, buf, HEADER_SIZE);
676     if (ret) {
677         goto fail;
678     }
679 
680     offset = 1536 + ((num_bat_entries * 4 + 511) & ~511);
681     ret = bdrv_pwrite_sync(bs, offset, buf, HEADER_SIZE);
682     if (ret < 0) {
683         goto fail;
684     }
685 
686     // Write the initial BAT
687     offset = 3 * 512;
688 
689     memset(buf, 0xFF, 512);
690     for (i = 0; i < (num_bat_entries * 4 + 511) / 512; i++) {
691         ret = bdrv_pwrite_sync(bs, offset, buf, 512);
692         if (ret < 0) {
693             goto fail;
694         }
695         offset += 512;
696     }
697 
698     // Prepare the Dynamic Disk Header
699     memset(buf, 0, 1024);
700 
701     memcpy(dyndisk_header->magic, "cxsparse", 8);
702 
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      */
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);
712 
713     dyndisk_header->checksum = cpu_to_be32(vpc_checksum(buf, 1024));
714 
715     // Write the header
716     offset = 512;
717 
718     ret = bdrv_pwrite_sync(bs, offset, buf, 1024);
719     if (ret < 0) {
720         goto fail;
721     }
722 
723  fail:
724     return ret;
725 }
726 
727 static int create_fixed_disk(BlockDriverState *bs, uint8_t *buf,
728                              int64_t total_size)
729 {
730     int ret;
731 
732     /* Add footer to total size */
733     total_size += HEADER_SIZE;
734 
735     ret = bdrv_truncate(bs, total_size);
736     if (ret < 0) {
737         return ret;
738     }
739 
740     ret = bdrv_pwrite_sync(bs, total_size - HEADER_SIZE, buf, HEADER_SIZE);
741     if (ret < 0) {
742         return ret;
743     }
744 
745     return ret;
746 }
747 
748 static int vpc_create(const char *filename, QemuOpts *opts, Error **errp)
749 {
750     uint8_t buf[1024];
751     VHDFooter *footer = (VHDFooter *) buf;
752     char *disk_type_param;
753     int i;
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;
761     Error *local_err = NULL;
762     BlockDriverState *bs = NULL;
763 
764     /* Read out options */
765     total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
766                           BDRV_SECTOR_SIZE);
767     disk_type_param = qemu_opt_get_del(opts, BLOCK_OPT_SUBFMT);
768     if (disk_type_param) {
769         if (!strcmp(disk_type_param, "dynamic")) {
770             disk_type = VHD_DYNAMIC;
771         } else if (!strcmp(disk_type_param, "fixed")) {
772             disk_type = VHD_FIXED;
773         } else {
774             ret = -EINVAL;
775             goto out;
776         }
777     } else {
778         disk_type = VHD_DYNAMIC;
779     }
780 
781     ret = bdrv_create_file(filename, opts, &local_err);
782     if (ret < 0) {
783         error_propagate(errp, local_err);
784         goto out;
785     }
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;
791     }
792 
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.
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.
801      */
802     total_sectors = MIN(VHD_MAX_GEOMETRY, total_size / BDRV_SECTOR_SIZE);
803     for (i = 0; total_sectors > (int64_t)cyls * heads * secs_per_cyl; i++) {
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) {
811             ret = -EFBIG;
812             goto out;
813         }
814     } else {
815         total_sectors = (int64_t)cyls * heads * secs_per_cyl;
816         total_size = total_sectors * BDRV_SECTOR_SIZE;
817     }
818 
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 
827     footer->features = cpu_to_be32(0x02);
828     footer->version = cpu_to_be32(0x00010000);
829     if (disk_type == VHD_DYNAMIC) {
830         footer->data_offset = cpu_to_be64(HEADER_SIZE);
831     } else {
832         footer->data_offset = cpu_to_be64(0xFFFFFFFFFFFFFFFFULL);
833     }
834     footer->timestamp = cpu_to_be32(time(NULL) - VHD_TIMESTAMP_BASE);
835 
836     /* Version of Virtual PC 2007 */
837     footer->major = cpu_to_be16(0x0005);
838     footer->minor = cpu_to_be16(0x0003);
839     footer->orig_size = cpu_to_be64(total_size);
840     footer->current_size = cpu_to_be64(total_size);
841     footer->cyls = cpu_to_be16(cyls);
842     footer->heads = heads;
843     footer->secs_per_cyl = secs_per_cyl;
844 
845     footer->type = cpu_to_be32(disk_type);
846 
847 #if defined(CONFIG_UUID)
848     uuid_generate(footer->uuid);
849 #endif
850 
851     footer->checksum = cpu_to_be32(vpc_checksum(buf, HEADER_SIZE));
852 
853     if (disk_type == VHD_DYNAMIC) {
854         ret = create_dynamic_disk(bs, buf, total_sectors);
855     } else {
856         ret = create_fixed_disk(bs, buf, total_size);
857     }
858 
859 out:
860     bdrv_unref(bs);
861     g_free(disk_type_param);
862     return ret;
863 }
864 
865 static int vpc_has_zero_init(BlockDriverState *bs)
866 {
867     BDRVVPCState *s = bs->opaque;
868     VHDFooter *footer =  (VHDFooter *) s->footer_buf;
869 
870     if (be32_to_cpu(footer->type) == VHD_FIXED) {
871         return bdrv_has_zero_init(bs->file);
872     } else {
873         return 1;
874     }
875 }
876 
877 static void vpc_close(BlockDriverState *bs)
878 {
879     BDRVVPCState *s = bs->opaque;
880     qemu_vfree(s->pagetable);
881 #ifdef CACHE
882     g_free(s->pageentry_u8);
883 #endif
884 
885     migrate_del_blocker(s->migration_blocker);
886     error_free(s->migration_blocker);
887 }
888 
889 static 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     }
907 };
908 
909 static BlockDriver bdrv_vpc = {
910     .format_name    = "vpc",
911     .instance_size  = sizeof(BDRVVPCState),
912 
913     .bdrv_probe             = vpc_probe,
914     .bdrv_open              = vpc_open,
915     .bdrv_close             = vpc_close,
916     .bdrv_reopen_prepare    = vpc_reopen_prepare,
917     .bdrv_create            = vpc_create,
918 
919     .bdrv_read                  = vpc_co_read,
920     .bdrv_write                 = vpc_co_write,
921     .bdrv_co_get_block_status   = vpc_co_get_block_status,
922 
923     .bdrv_get_info          = vpc_get_info,
924 
925     .create_opts            = &vpc_create_opts,
926     .bdrv_has_zero_init     = vpc_has_zero_init,
927 };
928 
929 static void bdrv_vpc_init(void)
930 {
931     bdrv_register(&bdrv_vpc);
932 }
933 
934 block_init(bdrv_vpc_init);
935