Add qemu 2.4.0
[kvmfornfv.git] / qemu / block / vpc.c
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     uint64_t pagetable_size;
172     int disk_type = VHD_DYNAMIC;
173     int ret;
174
175     ret = bdrv_pread(bs->file, 0, s->footer_buf, HEADER_SIZE);
176     if (ret < 0) {
177         goto fail;
178     }
179
180     footer = (VHDFooter *) s->footer_buf;
181     if (strncmp(footer->creator, "conectix", 8)) {
182         int64_t offset = bdrv_getlength(bs->file);
183         if (offset < 0) {
184             ret = offset;
185             goto fail;
186         } else if (offset < HEADER_SIZE) {
187             ret = -EINVAL;
188             goto fail;
189         }
190
191         /* If a fixed disk, the footer is found only at the end of the file */
192         ret = bdrv_pread(bs->file, offset-HEADER_SIZE, s->footer_buf,
193                          HEADER_SIZE);
194         if (ret < 0) {
195             goto fail;
196         }
197         if (strncmp(footer->creator, "conectix", 8)) {
198             error_setg(errp, "invalid VPC image");
199             ret = -EINVAL;
200             goto fail;
201         }
202         disk_type = VHD_FIXED;
203     }
204
205     checksum = be32_to_cpu(footer->checksum);
206     footer->checksum = 0;
207     if (vpc_checksum(s->footer_buf, HEADER_SIZE) != checksum)
208         fprintf(stderr, "block-vpc: The header checksum of '%s' is "
209             "incorrect.\n", bs->filename);
210
211     /* Write 'checksum' back to footer, or else will leave it with zero. */
212     footer->checksum = cpu_to_be32(checksum);
213
214     // The visible size of a image in Virtual PC depends on the geometry
215     // rather than on the size stored in the footer (the size in the footer
216     // is too large usually)
217     bs->total_sectors = (int64_t)
218         be16_to_cpu(footer->cyls) * footer->heads * footer->secs_per_cyl;
219
220     /* Images that have exactly the maximum geometry are probably bigger and
221      * would be truncated if we adhered to the geometry for them. Rely on
222      * footer->current_size for them. */
223     if (bs->total_sectors == VHD_MAX_GEOMETRY) {
224         bs->total_sectors = be64_to_cpu(footer->current_size) /
225                             BDRV_SECTOR_SIZE;
226     }
227
228     /* Allow a maximum disk size of approximately 2 TB */
229     if (bs->total_sectors >= VHD_MAX_SECTORS) {
230         ret = -EFBIG;
231         goto fail;
232     }
233
234     if (disk_type == VHD_DYNAMIC) {
235         ret = bdrv_pread(bs->file, be64_to_cpu(footer->data_offset), buf,
236                          HEADER_SIZE);
237         if (ret < 0) {
238             goto fail;
239         }
240
241         dyndisk_header = (VHDDynDiskHeader *) buf;
242
243         if (strncmp(dyndisk_header->magic, "cxsparse", 8)) {
244             ret = -EINVAL;
245             goto fail;
246         }
247
248         s->block_size = be32_to_cpu(dyndisk_header->block_size);
249         if (!is_power_of_2(s->block_size) || s->block_size < BDRV_SECTOR_SIZE) {
250             error_setg(errp, "Invalid block size %" PRIu32, s->block_size);
251             ret = -EINVAL;
252             goto fail;
253         }
254         s->bitmap_size = ((s->block_size / (8 * 512)) + 511) & ~511;
255
256         s->max_table_entries = be32_to_cpu(dyndisk_header->max_table_entries);
257
258         if ((bs->total_sectors * 512) / s->block_size > 0xffffffffU) {
259             ret = -EINVAL;
260             goto fail;
261         }
262         if (s->max_table_entries > (VHD_MAX_SECTORS * 512) / s->block_size) {
263             ret = -EINVAL;
264             goto fail;
265         }
266
267         computed_size = (uint64_t) s->max_table_entries * s->block_size;
268         if (computed_size < bs->total_sectors * 512) {
269             ret = -EINVAL;
270             goto fail;
271         }
272
273         if (s->max_table_entries > SIZE_MAX / 4 ||
274             s->max_table_entries > (int) INT_MAX / 4) {
275             error_setg(errp, "Max Table Entries too large (%" PRId32 ")",
276                         s->max_table_entries);
277             ret = -EINVAL;
278             goto fail;
279         }
280
281         pagetable_size = (uint64_t) s->max_table_entries * 4;
282
283         s->pagetable = qemu_try_blockalign(bs->file, pagetable_size);
284         if (s->pagetable == NULL) {
285             ret = -ENOMEM;
286             goto fail;
287         }
288
289         s->bat_offset = be64_to_cpu(dyndisk_header->table_offset);
290
291         ret = bdrv_pread(bs->file, s->bat_offset, s->pagetable, pagetable_size);
292         if (ret < 0) {
293             goto fail;
294         }
295
296         s->free_data_block_offset =
297             ROUND_UP(s->bat_offset + pagetable_size, 512);
298
299         for (i = 0; i < s->max_table_entries; i++) {
300             be32_to_cpus(&s->pagetable[i]);
301             if (s->pagetable[i] != 0xFFFFFFFF) {
302                 int64_t next = (512 * (int64_t) s->pagetable[i]) +
303                     s->bitmap_size + s->block_size;
304
305                 if (next > s->free_data_block_offset) {
306                     s->free_data_block_offset = next;
307                 }
308             }
309         }
310
311         if (s->free_data_block_offset > bdrv_getlength(bs->file)) {
312             error_setg(errp, "block-vpc: free_data_block_offset points after "
313                              "the end of file. The image has been truncated.");
314             ret = -EINVAL;
315             goto fail;
316         }
317
318         s->last_bitmap_offset = (int64_t) -1;
319
320 #ifdef CACHE
321         s->pageentry_u8 = g_malloc(512);
322         s->pageentry_u32 = s->pageentry_u8;
323         s->pageentry_u16 = s->pageentry_u8;
324         s->last_pagetable = -1;
325 #endif
326     }
327
328     qemu_co_mutex_init(&s->lock);
329
330     /* Disable migration when VHD images are used */
331     error_setg(&s->migration_blocker, "The vpc format used by node '%s' "
332                "does not support live migration",
333                bdrv_get_device_or_node_name(bs));
334     migrate_add_blocker(s->migration_blocker);
335
336     return 0;
337
338 fail:
339     qemu_vfree(s->pagetable);
340 #ifdef CACHE
341     g_free(s->pageentry_u8);
342 #endif
343     return ret;
344 }
345
346 static int vpc_reopen_prepare(BDRVReopenState *state,
347                               BlockReopenQueue *queue, Error **errp)
348 {
349     return 0;
350 }
351
352 /*
353  * Returns the absolute byte offset of the given sector in the image file.
354  * If the sector is not allocated, -1 is returned instead.
355  *
356  * The parameter write must be 1 if the offset will be used for a write
357  * operation (the block bitmaps is updated then), 0 otherwise.
358  */
359 static inline int64_t get_sector_offset(BlockDriverState *bs,
360     int64_t sector_num, int write)
361 {
362     BDRVVPCState *s = bs->opaque;
363     uint64_t offset = sector_num * 512;
364     uint64_t bitmap_offset, block_offset;
365     uint32_t pagetable_index, pageentry_index;
366
367     pagetable_index = offset / s->block_size;
368     pageentry_index = (offset % s->block_size) / 512;
369
370     if (pagetable_index >= s->max_table_entries || s->pagetable[pagetable_index] == 0xffffffff)
371         return -1; // not allocated
372
373     bitmap_offset = 512 * (uint64_t) s->pagetable[pagetable_index];
374     block_offset = bitmap_offset + s->bitmap_size + (512 * pageentry_index);
375
376     // We must ensure that we don't write to any sectors which are marked as
377     // unused in the bitmap. We get away with setting all bits in the block
378     // bitmap each time we write to a new block. This might cause Virtual PC to
379     // miss sparse read optimization, but it's not a problem in terms of
380     // correctness.
381     if (write && (s->last_bitmap_offset != bitmap_offset)) {
382         uint8_t bitmap[s->bitmap_size];
383
384         s->last_bitmap_offset = bitmap_offset;
385         memset(bitmap, 0xff, s->bitmap_size);
386         bdrv_pwrite_sync(bs->file, bitmap_offset, bitmap, s->bitmap_size);
387     }
388
389     return block_offset;
390 }
391
392 /*
393  * Writes the footer to the end of the image file. This is needed when the
394  * file grows as it overwrites the old footer
395  *
396  * Returns 0 on success and < 0 on error
397  */
398 static int rewrite_footer(BlockDriverState* bs)
399 {
400     int ret;
401     BDRVVPCState *s = bs->opaque;
402     int64_t offset = s->free_data_block_offset;
403
404     ret = bdrv_pwrite_sync(bs->file, offset, s->footer_buf, HEADER_SIZE);
405     if (ret < 0)
406         return ret;
407
408     return 0;
409 }
410
411 /*
412  * Allocates a new block. This involves writing a new footer and updating
413  * the Block Allocation Table to use the space at the old end of the image
414  * file (overwriting the old footer)
415  *
416  * Returns the sectors' offset in the image file on success and < 0 on error
417  */
418 static int64_t alloc_block(BlockDriverState* bs, int64_t sector_num)
419 {
420     BDRVVPCState *s = bs->opaque;
421     int64_t bat_offset;
422     uint32_t index, bat_value;
423     int ret;
424     uint8_t bitmap[s->bitmap_size];
425
426     // Check if sector_num is valid
427     if ((sector_num < 0) || (sector_num > bs->total_sectors))
428         return -1;
429
430     // Write entry into in-memory BAT
431     index = (sector_num * 512) / s->block_size;
432     if (s->pagetable[index] != 0xFFFFFFFF)
433         return -1;
434
435     s->pagetable[index] = s->free_data_block_offset / 512;
436
437     // Initialize the block's bitmap
438     memset(bitmap, 0xff, s->bitmap_size);
439     ret = bdrv_pwrite_sync(bs->file, s->free_data_block_offset, bitmap,
440         s->bitmap_size);
441     if (ret < 0) {
442         return ret;
443     }
444
445     // Write new footer (the old one will be overwritten)
446     s->free_data_block_offset += s->block_size + s->bitmap_size;
447     ret = rewrite_footer(bs);
448     if (ret < 0)
449         goto fail;
450
451     // Write BAT entry to disk
452     bat_offset = s->bat_offset + (4 * index);
453     bat_value = cpu_to_be32(s->pagetable[index]);
454     ret = bdrv_pwrite_sync(bs->file, bat_offset, &bat_value, 4);
455     if (ret < 0)
456         goto fail;
457
458     return get_sector_offset(bs, sector_num, 0);
459
460 fail:
461     s->free_data_block_offset -= (s->block_size + s->bitmap_size);
462     return -1;
463 }
464
465 static int vpc_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
466 {
467     BDRVVPCState *s = (BDRVVPCState *)bs->opaque;
468     VHDFooter *footer = (VHDFooter *) s->footer_buf;
469
470     if (be32_to_cpu(footer->type) != VHD_FIXED) {
471         bdi->cluster_size = s->block_size;
472     }
473
474     bdi->unallocated_blocks_are_zero = true;
475     return 0;
476 }
477
478 static int vpc_read(BlockDriverState *bs, int64_t sector_num,
479                     uint8_t *buf, int nb_sectors)
480 {
481     BDRVVPCState *s = bs->opaque;
482     int ret;
483     int64_t offset;
484     int64_t sectors, sectors_per_block;
485     VHDFooter *footer = (VHDFooter *) s->footer_buf;
486
487     if (be32_to_cpu(footer->type) == VHD_FIXED) {
488         return bdrv_read(bs->file, sector_num, buf, nb_sectors);
489     }
490     while (nb_sectors > 0) {
491         offset = get_sector_offset(bs, sector_num, 0);
492
493         sectors_per_block = s->block_size >> BDRV_SECTOR_BITS;
494         sectors = sectors_per_block - (sector_num % sectors_per_block);
495         if (sectors > nb_sectors) {
496             sectors = nb_sectors;
497         }
498
499         if (offset == -1) {
500             memset(buf, 0, sectors * BDRV_SECTOR_SIZE);
501         } else {
502             ret = bdrv_pread(bs->file, offset, buf,
503                 sectors * BDRV_SECTOR_SIZE);
504             if (ret != sectors * BDRV_SECTOR_SIZE) {
505                 return -1;
506             }
507         }
508
509         nb_sectors -= sectors;
510         sector_num += sectors;
511         buf += sectors * BDRV_SECTOR_SIZE;
512     }
513     return 0;
514 }
515
516 static coroutine_fn int vpc_co_read(BlockDriverState *bs, int64_t sector_num,
517                                     uint8_t *buf, int nb_sectors)
518 {
519     int ret;
520     BDRVVPCState *s = bs->opaque;
521     qemu_co_mutex_lock(&s->lock);
522     ret = vpc_read(bs, sector_num, buf, nb_sectors);
523     qemu_co_mutex_unlock(&s->lock);
524     return ret;
525 }
526
527 static int vpc_write(BlockDriverState *bs, int64_t sector_num,
528     const uint8_t *buf, int nb_sectors)
529 {
530     BDRVVPCState *s = bs->opaque;
531     int64_t offset;
532     int64_t sectors, sectors_per_block;
533     int ret;
534     VHDFooter *footer =  (VHDFooter *) s->footer_buf;
535
536     if (be32_to_cpu(footer->type) == VHD_FIXED) {
537         return bdrv_write(bs->file, sector_num, buf, nb_sectors);
538     }
539     while (nb_sectors > 0) {
540         offset = get_sector_offset(bs, sector_num, 1);
541
542         sectors_per_block = s->block_size >> BDRV_SECTOR_BITS;
543         sectors = sectors_per_block - (sector_num % sectors_per_block);
544         if (sectors > nb_sectors) {
545             sectors = nb_sectors;
546         }
547
548         if (offset == -1) {
549             offset = alloc_block(bs, sector_num);
550             if (offset < 0)
551                 return -1;
552         }
553
554         ret = bdrv_pwrite(bs->file, offset, buf, sectors * BDRV_SECTOR_SIZE);
555         if (ret != sectors * BDRV_SECTOR_SIZE) {
556             return -1;
557         }
558
559         nb_sectors -= sectors;
560         sector_num += sectors;
561         buf += sectors * BDRV_SECTOR_SIZE;
562     }
563
564     return 0;
565 }
566
567 static coroutine_fn int vpc_co_write(BlockDriverState *bs, int64_t sector_num,
568                                      const uint8_t *buf, int nb_sectors)
569 {
570     int ret;
571     BDRVVPCState *s = bs->opaque;
572     qemu_co_mutex_lock(&s->lock);
573     ret = vpc_write(bs, sector_num, buf, nb_sectors);
574     qemu_co_mutex_unlock(&s->lock);
575     return ret;
576 }
577
578 static int64_t coroutine_fn vpc_co_get_block_status(BlockDriverState *bs,
579         int64_t sector_num, int nb_sectors, int *pnum)
580 {
581     BDRVVPCState *s = bs->opaque;
582     VHDFooter *footer = (VHDFooter*) s->footer_buf;
583     int64_t start, offset;
584     bool allocated;
585     int n;
586
587     if (be32_to_cpu(footer->type) == VHD_FIXED) {
588         *pnum = nb_sectors;
589         return BDRV_BLOCK_RAW | BDRV_BLOCK_OFFSET_VALID | BDRV_BLOCK_DATA |
590                (sector_num << BDRV_SECTOR_BITS);
591     }
592
593     offset = get_sector_offset(bs, sector_num, 0);
594     start = offset;
595     allocated = (offset != -1);
596     *pnum = 0;
597
598     do {
599         /* All sectors in a block are contiguous (without using the bitmap) */
600         n = ROUND_UP(sector_num + 1, s->block_size / BDRV_SECTOR_SIZE)
601           - sector_num;
602         n = MIN(n, nb_sectors);
603
604         *pnum += n;
605         sector_num += n;
606         nb_sectors -= n;
607         /* *pnum can't be greater than one block for allocated
608          * sectors since there is always a bitmap in between. */
609         if (allocated) {
610             return BDRV_BLOCK_DATA | BDRV_BLOCK_OFFSET_VALID | start;
611         }
612         if (nb_sectors == 0) {
613             break;
614         }
615         offset = get_sector_offset(bs, sector_num, 0);
616     } while (offset == -1);
617
618     return 0;
619 }
620
621 /*
622  * Calculates the number of cylinders, heads and sectors per cylinder
623  * based on a given number of sectors. This is the algorithm described
624  * in the VHD specification.
625  *
626  * Note that the geometry doesn't always exactly match total_sectors but
627  * may round it down.
628  *
629  * Returns 0 on success, -EFBIG if the size is larger than ~2 TB. Override
630  * the hardware EIDE and ATA-2 limit of 16 heads (max disk size of 127 GB)
631  * and instead allow up to 255 heads.
632  */
633 static int calculate_geometry(int64_t total_sectors, uint16_t* cyls,
634     uint8_t* heads, uint8_t* secs_per_cyl)
635 {
636     uint32_t cyls_times_heads;
637
638     total_sectors = MIN(total_sectors, VHD_MAX_GEOMETRY);
639
640     if (total_sectors >= 65535LL * 16 * 63) {
641         *secs_per_cyl = 255;
642         *heads = 16;
643         cyls_times_heads = total_sectors / *secs_per_cyl;
644     } else {
645         *secs_per_cyl = 17;
646         cyls_times_heads = total_sectors / *secs_per_cyl;
647         *heads = (cyls_times_heads + 1023) / 1024;
648
649         if (*heads < 4) {
650             *heads = 4;
651         }
652
653         if (cyls_times_heads >= (*heads * 1024) || *heads > 16) {
654             *secs_per_cyl = 31;
655             *heads = 16;
656             cyls_times_heads = total_sectors / *secs_per_cyl;
657         }
658
659         if (cyls_times_heads >= (*heads * 1024)) {
660             *secs_per_cyl = 63;
661             *heads = 16;
662             cyls_times_heads = total_sectors / *secs_per_cyl;
663         }
664     }
665
666     *cyls = cyls_times_heads / *heads;
667
668     return 0;
669 }
670
671 static int create_dynamic_disk(BlockDriverState *bs, uint8_t *buf,
672                                int64_t total_sectors)
673 {
674     VHDDynDiskHeader *dyndisk_header =
675         (VHDDynDiskHeader *) buf;
676     size_t block_size, num_bat_entries;
677     int i;
678     int ret;
679     int64_t offset = 0;
680
681     // Write the footer (twice: at the beginning and at the end)
682     block_size = 0x200000;
683     num_bat_entries = (total_sectors + block_size / 512) / (block_size / 512);
684
685     ret = bdrv_pwrite_sync(bs, offset, buf, HEADER_SIZE);
686     if (ret) {
687         goto fail;
688     }
689
690     offset = 1536 + ((num_bat_entries * 4 + 511) & ~511);
691     ret = bdrv_pwrite_sync(bs, offset, buf, HEADER_SIZE);
692     if (ret < 0) {
693         goto fail;
694     }
695
696     // Write the initial BAT
697     offset = 3 * 512;
698
699     memset(buf, 0xFF, 512);
700     for (i = 0; i < (num_bat_entries * 4 + 511) / 512; i++) {
701         ret = bdrv_pwrite_sync(bs, offset, buf, 512);
702         if (ret < 0) {
703             goto fail;
704         }
705         offset += 512;
706     }
707
708     // Prepare the Dynamic Disk Header
709     memset(buf, 0, 1024);
710
711     memcpy(dyndisk_header->magic, "cxsparse", 8);
712
713     /*
714      * Note: The spec is actually wrong here for data_offset, it says
715      * 0xFFFFFFFF, but MS tools expect all 64 bits to be set.
716      */
717     dyndisk_header->data_offset = cpu_to_be64(0xFFFFFFFFFFFFFFFFULL);
718     dyndisk_header->table_offset = cpu_to_be64(3 * 512);
719     dyndisk_header->version = cpu_to_be32(0x00010000);
720     dyndisk_header->block_size = cpu_to_be32(block_size);
721     dyndisk_header->max_table_entries = cpu_to_be32(num_bat_entries);
722
723     dyndisk_header->checksum = cpu_to_be32(vpc_checksum(buf, 1024));
724
725     // Write the header
726     offset = 512;
727
728     ret = bdrv_pwrite_sync(bs, offset, buf, 1024);
729     if (ret < 0) {
730         goto fail;
731     }
732
733  fail:
734     return ret;
735 }
736
737 static int create_fixed_disk(BlockDriverState *bs, uint8_t *buf,
738                              int64_t total_size)
739 {
740     int ret;
741
742     /* Add footer to total size */
743     total_size += HEADER_SIZE;
744
745     ret = bdrv_truncate(bs, total_size);
746     if (ret < 0) {
747         return ret;
748     }
749
750     ret = bdrv_pwrite_sync(bs, total_size - HEADER_SIZE, buf, HEADER_SIZE);
751     if (ret < 0) {
752         return ret;
753     }
754
755     return ret;
756 }
757
758 static int vpc_create(const char *filename, QemuOpts *opts, Error **errp)
759 {
760     uint8_t buf[1024];
761     VHDFooter *footer = (VHDFooter *) buf;
762     char *disk_type_param;
763     int i;
764     uint16_t cyls = 0;
765     uint8_t heads = 0;
766     uint8_t secs_per_cyl = 0;
767     int64_t total_sectors;
768     int64_t total_size;
769     int disk_type;
770     int ret = -EIO;
771     Error *local_err = NULL;
772     BlockDriverState *bs = NULL;
773
774     /* Read out options */
775     total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
776                           BDRV_SECTOR_SIZE);
777     disk_type_param = qemu_opt_get_del(opts, BLOCK_OPT_SUBFMT);
778     if (disk_type_param) {
779         if (!strcmp(disk_type_param, "dynamic")) {
780             disk_type = VHD_DYNAMIC;
781         } else if (!strcmp(disk_type_param, "fixed")) {
782             disk_type = VHD_FIXED;
783         } else {
784             ret = -EINVAL;
785             goto out;
786         }
787     } else {
788         disk_type = VHD_DYNAMIC;
789     }
790
791     ret = bdrv_create_file(filename, opts, &local_err);
792     if (ret < 0) {
793         error_propagate(errp, local_err);
794         goto out;
795     }
796     ret = bdrv_open(&bs, filename, NULL, NULL, BDRV_O_RDWR | BDRV_O_PROTOCOL,
797                     NULL, &local_err);
798     if (ret < 0) {
799         error_propagate(errp, local_err);
800         goto out;
801     }
802
803     /*
804      * Calculate matching total_size and geometry. Increase the number of
805      * sectors requested until we get enough (or fail). This ensures that
806      * qemu-img convert doesn't truncate images, but rather rounds up.
807      *
808      * If the image size can't be represented by a spec conform CHS geometry,
809      * we set the geometry to 65535 x 16 x 255 (CxHxS) sectors and use
810      * the image size from the VHD footer to calculate total_sectors.
811      */
812     total_sectors = MIN(VHD_MAX_GEOMETRY, total_size / BDRV_SECTOR_SIZE);
813     for (i = 0; total_sectors > (int64_t)cyls * heads * secs_per_cyl; i++) {
814         calculate_geometry(total_sectors + i, &cyls, &heads, &secs_per_cyl);
815     }
816
817     if ((int64_t)cyls * heads * secs_per_cyl == VHD_MAX_GEOMETRY) {
818         total_sectors = total_size / BDRV_SECTOR_SIZE;
819         /* Allow a maximum disk size of approximately 2 TB */
820         if (total_sectors > VHD_MAX_SECTORS) {
821             ret = -EFBIG;
822             goto out;
823         }
824     } else {
825         total_sectors = (int64_t)cyls * heads * secs_per_cyl;
826         total_size = total_sectors * BDRV_SECTOR_SIZE;
827     }
828
829     /* Prepare the Hard Disk Footer */
830     memset(buf, 0, 1024);
831
832     memcpy(footer->creator, "conectix", 8);
833     /* TODO Check if "qemu" creator_app is ok for VPC */
834     memcpy(footer->creator_app, "qemu", 4);
835     memcpy(footer->creator_os, "Wi2k", 4);
836
837     footer->features = cpu_to_be32(0x02);
838     footer->version = cpu_to_be32(0x00010000);
839     if (disk_type == VHD_DYNAMIC) {
840         footer->data_offset = cpu_to_be64(HEADER_SIZE);
841     } else {
842         footer->data_offset = cpu_to_be64(0xFFFFFFFFFFFFFFFFULL);
843     }
844     footer->timestamp = cpu_to_be32(time(NULL) - VHD_TIMESTAMP_BASE);
845
846     /* Version of Virtual PC 2007 */
847     footer->major = cpu_to_be16(0x0005);
848     footer->minor = cpu_to_be16(0x0003);
849     footer->orig_size = cpu_to_be64(total_size);
850     footer->current_size = cpu_to_be64(total_size);
851     footer->cyls = cpu_to_be16(cyls);
852     footer->heads = heads;
853     footer->secs_per_cyl = secs_per_cyl;
854
855     footer->type = cpu_to_be32(disk_type);
856
857 #if defined(CONFIG_UUID)
858     uuid_generate(footer->uuid);
859 #endif
860
861     footer->checksum = cpu_to_be32(vpc_checksum(buf, HEADER_SIZE));
862
863     if (disk_type == VHD_DYNAMIC) {
864         ret = create_dynamic_disk(bs, buf, total_sectors);
865     } else {
866         ret = create_fixed_disk(bs, buf, total_size);
867     }
868
869 out:
870     bdrv_unref(bs);
871     g_free(disk_type_param);
872     return ret;
873 }
874
875 static int vpc_has_zero_init(BlockDriverState *bs)
876 {
877     BDRVVPCState *s = bs->opaque;
878     VHDFooter *footer =  (VHDFooter *) s->footer_buf;
879
880     if (be32_to_cpu(footer->type) == VHD_FIXED) {
881         return bdrv_has_zero_init(bs->file);
882     } else {
883         return 1;
884     }
885 }
886
887 static void vpc_close(BlockDriverState *bs)
888 {
889     BDRVVPCState *s = bs->opaque;
890     qemu_vfree(s->pagetable);
891 #ifdef CACHE
892     g_free(s->pageentry_u8);
893 #endif
894
895     migrate_del_blocker(s->migration_blocker);
896     error_free(s->migration_blocker);
897 }
898
899 static QemuOptsList vpc_create_opts = {
900     .name = "vpc-create-opts",
901     .head = QTAILQ_HEAD_INITIALIZER(vpc_create_opts.head),
902     .desc = {
903         {
904             .name = BLOCK_OPT_SIZE,
905             .type = QEMU_OPT_SIZE,
906             .help = "Virtual disk size"
907         },
908         {
909             .name = BLOCK_OPT_SUBFMT,
910             .type = QEMU_OPT_STRING,
911             .help =
912                 "Type of virtual hard disk format. Supported formats are "
913                 "{dynamic (default) | fixed} "
914         },
915         { /* end of list */ }
916     }
917 };
918
919 static BlockDriver bdrv_vpc = {
920     .format_name    = "vpc",
921     .instance_size  = sizeof(BDRVVPCState),
922
923     .bdrv_probe             = vpc_probe,
924     .bdrv_open              = vpc_open,
925     .bdrv_close             = vpc_close,
926     .bdrv_reopen_prepare    = vpc_reopen_prepare,
927     .bdrv_create            = vpc_create,
928
929     .bdrv_read                  = vpc_co_read,
930     .bdrv_write                 = vpc_co_write,
931     .bdrv_co_get_block_status   = vpc_co_get_block_status,
932
933     .bdrv_get_info          = vpc_get_info,
934
935     .create_opts            = &vpc_create_opts,
936     .bdrv_has_zero_init     = vpc_has_zero_init,
937 };
938
939 static void bdrv_vpc_init(void)
940 {
941     bdrv_register(&bdrv_vpc);
942 }
943
944 block_init(bdrv_vpc_init);