xref: /openbmc/qemu/block/vpc.c (revision a9dd38db)
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 #ifdef __linux__
33 #include <linux/fs.h>
34 #include <sys/ioctl.h>
35 #ifndef FS_NOCOW_FL
36 #define FS_NOCOW_FL                     0x00800000 /* Do not cow file */
37 #endif
38 #endif
39 
40 /**************************************************************/
41 
42 #define HEADER_SIZE 512
43 
44 //#define CACHE
45 
46 enum vhd_type {
47     VHD_FIXED           = 2,
48     VHD_DYNAMIC         = 3,
49     VHD_DIFFERENCING    = 4,
50 };
51 
52 // Seconds since Jan 1, 2000 0:00:00 (UTC)
53 #define VHD_TIMESTAMP_BASE 946684800
54 
55 #define VHD_MAX_SECTORS       (65535LL * 255 * 255)
56 
57 // always big-endian
58 typedef struct vhd_footer {
59     char        creator[8]; // "conectix"
60     uint32_t    features;
61     uint32_t    version;
62 
63     // Offset of next header structure, 0xFFFFFFFF if none
64     uint64_t    data_offset;
65 
66     // Seconds since Jan 1, 2000 0:00:00 (UTC)
67     uint32_t    timestamp;
68 
69     char        creator_app[4]; // "vpc "
70     uint16_t    major;
71     uint16_t    minor;
72     char        creator_os[4]; // "Wi2k"
73 
74     uint64_t    orig_size;
75     uint64_t    size;
76 
77     uint16_t    cyls;
78     uint8_t     heads;
79     uint8_t     secs_per_cyl;
80 
81     uint32_t    type;
82 
83     // Checksum of the Hard Disk Footer ("one's complement of the sum of all
84     // the bytes in the footer without the checksum field")
85     uint32_t    checksum;
86 
87     // UUID used to identify a parent hard disk (backing file)
88     uint8_t     uuid[16];
89 
90     uint8_t     in_saved_state;
91 } QEMU_PACKED VHDFooter;
92 
93 typedef struct vhd_dyndisk_header {
94     char        magic[8]; // "cxsparse"
95 
96     // Offset of next header structure, 0xFFFFFFFF if none
97     uint64_t    data_offset;
98 
99     // Offset of the Block Allocation Table (BAT)
100     uint64_t    table_offset;
101 
102     uint32_t    version;
103     uint32_t    max_table_entries; // 32bit/entry
104 
105     // 2 MB by default, must be a power of two
106     uint32_t    block_size;
107 
108     uint32_t    checksum;
109     uint8_t     parent_uuid[16];
110     uint32_t    parent_timestamp;
111     uint32_t    reserved;
112 
113     // Backing file name (in UTF-16)
114     uint8_t     parent_name[512];
115 
116     struct {
117         uint32_t    platform;
118         uint32_t    data_space;
119         uint32_t    data_length;
120         uint32_t    reserved;
121         uint64_t    data_offset;
122     } parent_locator[8];
123 } QEMU_PACKED VHDDynDiskHeader;
124 
125 typedef struct BDRVVPCState {
126     CoMutex lock;
127     uint8_t footer_buf[HEADER_SIZE];
128     uint64_t free_data_block_offset;
129     int max_table_entries;
130     uint32_t *pagetable;
131     uint64_t bat_offset;
132     uint64_t last_bitmap_offset;
133 
134     uint32_t block_size;
135     uint32_t bitmap_size;
136 
137 #ifdef CACHE
138     uint8_t *pageentry_u8;
139     uint32_t *pageentry_u32;
140     uint16_t *pageentry_u16;
141 
142     uint64_t last_bitmap;
143 #endif
144 
145     Error *migration_blocker;
146 } BDRVVPCState;
147 
148 static uint32_t vpc_checksum(uint8_t* buf, size_t size)
149 {
150     uint32_t res = 0;
151     int i;
152 
153     for (i = 0; i < size; i++)
154         res += buf[i];
155 
156     return ~res;
157 }
158 
159 
160 static int vpc_probe(const uint8_t *buf, int buf_size, const char *filename)
161 {
162     if (buf_size >= 8 && !strncmp((char *)buf, "conectix", 8))
163 	return 100;
164     return 0;
165 }
166 
167 static int vpc_open(BlockDriverState *bs, QDict *options, int flags,
168                     Error **errp)
169 {
170     BDRVVPCState *s = bs->opaque;
171     int i;
172     VHDFooter *footer;
173     VHDDynDiskHeader *dyndisk_header;
174     uint8_t buf[HEADER_SIZE];
175     uint32_t checksum;
176     uint64_t computed_size;
177     int disk_type = VHD_DYNAMIC;
178     int ret;
179 
180     ret = bdrv_pread(bs->file, 0, s->footer_buf, HEADER_SIZE);
181     if (ret < 0) {
182         goto fail;
183     }
184 
185     footer = (VHDFooter *) s->footer_buf;
186     if (strncmp(footer->creator, "conectix", 8)) {
187         int64_t offset = bdrv_getlength(bs->file);
188         if (offset < 0) {
189             ret = offset;
190             goto fail;
191         } else if (offset < HEADER_SIZE) {
192             ret = -EINVAL;
193             goto fail;
194         }
195 
196         /* If a fixed disk, the footer is found only at the end of the file */
197         ret = bdrv_pread(bs->file, offset-HEADER_SIZE, s->footer_buf,
198                          HEADER_SIZE);
199         if (ret < 0) {
200             goto fail;
201         }
202         if (strncmp(footer->creator, "conectix", 8)) {
203             error_setg(errp, "invalid VPC image");
204             ret = -EINVAL;
205             goto fail;
206         }
207         disk_type = VHD_FIXED;
208     }
209 
210     checksum = be32_to_cpu(footer->checksum);
211     footer->checksum = 0;
212     if (vpc_checksum(s->footer_buf, HEADER_SIZE) != checksum)
213         fprintf(stderr, "block-vpc: The header checksum of '%s' is "
214             "incorrect.\n", bs->filename);
215 
216     /* Write 'checksum' back to footer, or else will leave it with zero. */
217     footer->checksum = be32_to_cpu(checksum);
218 
219     // The visible size of a image in Virtual PC depends on the geometry
220     // rather than on the size stored in the footer (the size in the footer
221     // is too large usually)
222     bs->total_sectors = (int64_t)
223         be16_to_cpu(footer->cyls) * footer->heads * footer->secs_per_cyl;
224 
225     /* images created with disk2vhd report a far higher virtual size
226      * than expected with the cyls * heads * sectors_per_cyl formula.
227      * use the footer->size instead if the image was created with
228      * disk2vhd.
229      */
230     if (!strncmp(footer->creator_app, "d2v", 4)) {
231         bs->total_sectors = be64_to_cpu(footer->size) / BDRV_SECTOR_SIZE;
232     }
233 
234     /* Allow a maximum disk size of approximately 2 TB */
235     if (bs->total_sectors >= VHD_MAX_SECTORS) {
236         ret = -EFBIG;
237         goto fail;
238     }
239 
240     if (disk_type == VHD_DYNAMIC) {
241         ret = bdrv_pread(bs->file, be64_to_cpu(footer->data_offset), buf,
242                          HEADER_SIZE);
243         if (ret < 0) {
244             goto fail;
245         }
246 
247         dyndisk_header = (VHDDynDiskHeader *) buf;
248 
249         if (strncmp(dyndisk_header->magic, "cxsparse", 8)) {
250             ret = -EINVAL;
251             goto fail;
252         }
253 
254         s->block_size = be32_to_cpu(dyndisk_header->block_size);
255         if (!is_power_of_2(s->block_size) || s->block_size < BDRV_SECTOR_SIZE) {
256             error_setg(errp, "Invalid block size %" PRIu32, s->block_size);
257             ret = -EINVAL;
258             goto fail;
259         }
260         s->bitmap_size = ((s->block_size / (8 * 512)) + 511) & ~511;
261 
262         s->max_table_entries = be32_to_cpu(dyndisk_header->max_table_entries);
263 
264         if ((bs->total_sectors * 512) / s->block_size > 0xffffffffU) {
265             ret = -EINVAL;
266             goto fail;
267         }
268         if (s->max_table_entries > (VHD_MAX_SECTORS * 512) / s->block_size) {
269             ret = -EINVAL;
270             goto fail;
271         }
272 
273         computed_size = (uint64_t) s->max_table_entries * s->block_size;
274         if (computed_size < bs->total_sectors * 512) {
275             ret = -EINVAL;
276             goto fail;
277         }
278 
279         s->pagetable = qemu_blockalign(bs, s->max_table_entries * 4);
280 
281         s->bat_offset = be64_to_cpu(dyndisk_header->table_offset);
282 
283         ret = bdrv_pread(bs->file, s->bat_offset, s->pagetable,
284                          s->max_table_entries * 4);
285         if (ret < 0) {
286             goto fail;
287         }
288 
289         s->free_data_block_offset =
290             (s->bat_offset + (s->max_table_entries * 4) + 511) & ~511;
291 
292         for (i = 0; i < s->max_table_entries; i++) {
293             be32_to_cpus(&s->pagetable[i]);
294             if (s->pagetable[i] != 0xFFFFFFFF) {
295                 int64_t next = (512 * (int64_t) s->pagetable[i]) +
296                     s->bitmap_size + s->block_size;
297 
298                 if (next > s->free_data_block_offset) {
299                     s->free_data_block_offset = next;
300                 }
301             }
302         }
303 
304         if (s->free_data_block_offset > bdrv_getlength(bs->file)) {
305             error_setg(errp, "block-vpc: free_data_block_offset points after "
306                              "the end of file. The image has been truncated.");
307             ret = -EINVAL;
308             goto fail;
309         }
310 
311         s->last_bitmap_offset = (int64_t) -1;
312 
313 #ifdef CACHE
314         s->pageentry_u8 = g_malloc(512);
315         s->pageentry_u32 = s->pageentry_u8;
316         s->pageentry_u16 = s->pageentry_u8;
317         s->last_pagetable = -1;
318 #endif
319     }
320 
321     qemu_co_mutex_init(&s->lock);
322 
323     /* Disable migration when VHD images are used */
324     error_set(&s->migration_blocker,
325               QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
326               "vpc", bs->device_name, "live migration");
327     migrate_add_blocker(s->migration_blocker);
328 
329     return 0;
330 
331 fail:
332     qemu_vfree(s->pagetable);
333 #ifdef CACHE
334     g_free(s->pageentry_u8);
335 #endif
336     return ret;
337 }
338 
339 static int vpc_reopen_prepare(BDRVReopenState *state,
340                               BlockReopenQueue *queue, Error **errp)
341 {
342     return 0;
343 }
344 
345 /*
346  * Returns the absolute byte offset of the given sector in the image file.
347  * If the sector is not allocated, -1 is returned instead.
348  *
349  * The parameter write must be 1 if the offset will be used for a write
350  * operation (the block bitmaps is updated then), 0 otherwise.
351  */
352 static inline int64_t get_sector_offset(BlockDriverState *bs,
353     int64_t sector_num, int write)
354 {
355     BDRVVPCState *s = bs->opaque;
356     uint64_t offset = sector_num * 512;
357     uint64_t bitmap_offset, block_offset;
358     uint32_t pagetable_index, pageentry_index;
359 
360     pagetable_index = offset / s->block_size;
361     pageentry_index = (offset % s->block_size) / 512;
362 
363     if (pagetable_index >= s->max_table_entries || s->pagetable[pagetable_index] == 0xffffffff)
364         return -1; // not allocated
365 
366     bitmap_offset = 512 * (uint64_t) s->pagetable[pagetable_index];
367     block_offset = bitmap_offset + s->bitmap_size + (512 * pageentry_index);
368 
369     // We must ensure that we don't write to any sectors which are marked as
370     // unused in the bitmap. We get away with setting all bits in the block
371     // bitmap each time we write to a new block. This might cause Virtual PC to
372     // miss sparse read optimization, but it's not a problem in terms of
373     // correctness.
374     if (write && (s->last_bitmap_offset != bitmap_offset)) {
375         uint8_t bitmap[s->bitmap_size];
376 
377         s->last_bitmap_offset = bitmap_offset;
378         memset(bitmap, 0xff, s->bitmap_size);
379         bdrv_pwrite_sync(bs->file, bitmap_offset, bitmap, s->bitmap_size);
380     }
381 
382 //    printf("sector: %" PRIx64 ", index: %x, offset: %x, bioff: %" PRIx64 ", bloff: %" PRIx64 "\n",
383 //	sector_num, pagetable_index, pageentry_index,
384 //	bitmap_offset, block_offset);
385 
386 // disabled by reason
387 #if 0
388 #ifdef CACHE
389     if (bitmap_offset != s->last_bitmap)
390     {
391 	lseek(s->fd, bitmap_offset, SEEK_SET);
392 
393 	s->last_bitmap = bitmap_offset;
394 
395 	// Scary! Bitmap is stored as big endian 32bit entries,
396 	// while we used to look it up byte by byte
397 	read(s->fd, s->pageentry_u8, 512);
398 	for (i = 0; i < 128; i++)
399 	    be32_to_cpus(&s->pageentry_u32[i]);
400     }
401 
402     if ((s->pageentry_u8[pageentry_index / 8] >> (pageentry_index % 8)) & 1)
403 	return -1;
404 #else
405     lseek(s->fd, bitmap_offset + (pageentry_index / 8), SEEK_SET);
406 
407     read(s->fd, &bitmap_entry, 1);
408 
409     if ((bitmap_entry >> (pageentry_index % 8)) & 1)
410 	return -1; // not allocated
411 #endif
412 #endif
413 
414     return block_offset;
415 }
416 
417 /*
418  * Writes the footer to the end of the image file. This is needed when the
419  * file grows as it overwrites the old footer
420  *
421  * Returns 0 on success and < 0 on error
422  */
423 static int rewrite_footer(BlockDriverState* bs)
424 {
425     int ret;
426     BDRVVPCState *s = bs->opaque;
427     int64_t offset = s->free_data_block_offset;
428 
429     ret = bdrv_pwrite_sync(bs->file, offset, s->footer_buf, HEADER_SIZE);
430     if (ret < 0)
431         return ret;
432 
433     return 0;
434 }
435 
436 /*
437  * Allocates a new block. This involves writing a new footer and updating
438  * the Block Allocation Table to use the space at the old end of the image
439  * file (overwriting the old footer)
440  *
441  * Returns the sectors' offset in the image file on success and < 0 on error
442  */
443 static int64_t alloc_block(BlockDriverState* bs, int64_t sector_num)
444 {
445     BDRVVPCState *s = bs->opaque;
446     int64_t bat_offset;
447     uint32_t index, bat_value;
448     int ret;
449     uint8_t bitmap[s->bitmap_size];
450 
451     // Check if sector_num is valid
452     if ((sector_num < 0) || (sector_num > bs->total_sectors))
453         return -1;
454 
455     // Write entry into in-memory BAT
456     index = (sector_num * 512) / s->block_size;
457     if (s->pagetable[index] != 0xFFFFFFFF)
458         return -1;
459 
460     s->pagetable[index] = s->free_data_block_offset / 512;
461 
462     // Initialize the block's bitmap
463     memset(bitmap, 0xff, s->bitmap_size);
464     ret = bdrv_pwrite_sync(bs->file, s->free_data_block_offset, bitmap,
465         s->bitmap_size);
466     if (ret < 0) {
467         return ret;
468     }
469 
470     // Write new footer (the old one will be overwritten)
471     s->free_data_block_offset += s->block_size + s->bitmap_size;
472     ret = rewrite_footer(bs);
473     if (ret < 0)
474         goto fail;
475 
476     // Write BAT entry to disk
477     bat_offset = s->bat_offset + (4 * index);
478     bat_value = be32_to_cpu(s->pagetable[index]);
479     ret = bdrv_pwrite_sync(bs->file, bat_offset, &bat_value, 4);
480     if (ret < 0)
481         goto fail;
482 
483     return get_sector_offset(bs, sector_num, 0);
484 
485 fail:
486     s->free_data_block_offset -= (s->block_size + s->bitmap_size);
487     return -1;
488 }
489 
490 static int vpc_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
491 {
492     BDRVVPCState *s = (BDRVVPCState *)bs->opaque;
493     VHDFooter *footer = (VHDFooter *) s->footer_buf;
494 
495     if (cpu_to_be32(footer->type) != VHD_FIXED) {
496         bdi->cluster_size = s->block_size;
497     }
498 
499     bdi->unallocated_blocks_are_zero = true;
500     return 0;
501 }
502 
503 static int vpc_read(BlockDriverState *bs, int64_t sector_num,
504                     uint8_t *buf, int nb_sectors)
505 {
506     BDRVVPCState *s = bs->opaque;
507     int ret;
508     int64_t offset;
509     int64_t sectors, sectors_per_block;
510     VHDFooter *footer = (VHDFooter *) s->footer_buf;
511 
512     if (cpu_to_be32(footer->type) == VHD_FIXED) {
513         return bdrv_read(bs->file, sector_num, buf, nb_sectors);
514     }
515     while (nb_sectors > 0) {
516         offset = get_sector_offset(bs, sector_num, 0);
517 
518         sectors_per_block = s->block_size >> BDRV_SECTOR_BITS;
519         sectors = sectors_per_block - (sector_num % sectors_per_block);
520         if (sectors > nb_sectors) {
521             sectors = nb_sectors;
522         }
523 
524         if (offset == -1) {
525             memset(buf, 0, sectors * BDRV_SECTOR_SIZE);
526         } else {
527             ret = bdrv_pread(bs->file, offset, buf,
528                 sectors * BDRV_SECTOR_SIZE);
529             if (ret != sectors * BDRV_SECTOR_SIZE) {
530                 return -1;
531             }
532         }
533 
534         nb_sectors -= sectors;
535         sector_num += sectors;
536         buf += sectors * BDRV_SECTOR_SIZE;
537     }
538     return 0;
539 }
540 
541 static coroutine_fn int vpc_co_read(BlockDriverState *bs, int64_t sector_num,
542                                     uint8_t *buf, int nb_sectors)
543 {
544     int ret;
545     BDRVVPCState *s = bs->opaque;
546     qemu_co_mutex_lock(&s->lock);
547     ret = vpc_read(bs, sector_num, buf, nb_sectors);
548     qemu_co_mutex_unlock(&s->lock);
549     return ret;
550 }
551 
552 static int vpc_write(BlockDriverState *bs, int64_t sector_num,
553     const uint8_t *buf, int nb_sectors)
554 {
555     BDRVVPCState *s = bs->opaque;
556     int64_t offset;
557     int64_t sectors, sectors_per_block;
558     int ret;
559     VHDFooter *footer =  (VHDFooter *) s->footer_buf;
560 
561     if (cpu_to_be32(footer->type) == VHD_FIXED) {
562         return bdrv_write(bs->file, sector_num, buf, nb_sectors);
563     }
564     while (nb_sectors > 0) {
565         offset = get_sector_offset(bs, sector_num, 1);
566 
567         sectors_per_block = s->block_size >> BDRV_SECTOR_BITS;
568         sectors = sectors_per_block - (sector_num % sectors_per_block);
569         if (sectors > nb_sectors) {
570             sectors = nb_sectors;
571         }
572 
573         if (offset == -1) {
574             offset = alloc_block(bs, sector_num);
575             if (offset < 0)
576                 return -1;
577         }
578 
579         ret = bdrv_pwrite(bs->file, offset, buf, sectors * BDRV_SECTOR_SIZE);
580         if (ret != sectors * BDRV_SECTOR_SIZE) {
581             return -1;
582         }
583 
584         nb_sectors -= sectors;
585         sector_num += sectors;
586         buf += sectors * BDRV_SECTOR_SIZE;
587     }
588 
589     return 0;
590 }
591 
592 static coroutine_fn int vpc_co_write(BlockDriverState *bs, int64_t sector_num,
593                                      const uint8_t *buf, int nb_sectors)
594 {
595     int ret;
596     BDRVVPCState *s = bs->opaque;
597     qemu_co_mutex_lock(&s->lock);
598     ret = vpc_write(bs, sector_num, buf, nb_sectors);
599     qemu_co_mutex_unlock(&s->lock);
600     return ret;
601 }
602 
603 /*
604  * Calculates the number of cylinders, heads and sectors per cylinder
605  * based on a given number of sectors. This is the algorithm described
606  * in the VHD specification.
607  *
608  * Note that the geometry doesn't always exactly match total_sectors but
609  * may round it down.
610  *
611  * Returns 0 on success, -EFBIG if the size is larger than ~2 TB. Override
612  * the hardware EIDE and ATA-2 limit of 16 heads (max disk size of 127 GB)
613  * and instead allow up to 255 heads.
614  */
615 static int calculate_geometry(int64_t total_sectors, uint16_t* cyls,
616     uint8_t* heads, uint8_t* secs_per_cyl)
617 {
618     uint32_t cyls_times_heads;
619 
620     /* Allow a maximum disk size of approximately 2 TB */
621     if (total_sectors > 65535LL * 255 * 255) {
622         return -EFBIG;
623     }
624 
625     if (total_sectors > 65535 * 16 * 63) {
626         *secs_per_cyl = 255;
627         if (total_sectors > 65535 * 16 * 255) {
628             *heads = 255;
629         } else {
630             *heads = 16;
631         }
632         cyls_times_heads = total_sectors / *secs_per_cyl;
633     } else {
634         *secs_per_cyl = 17;
635         cyls_times_heads = total_sectors / *secs_per_cyl;
636         *heads = (cyls_times_heads + 1023) / 1024;
637 
638         if (*heads < 4)
639             *heads = 4;
640 
641         if (cyls_times_heads >= (*heads * 1024) || *heads > 16) {
642             *secs_per_cyl = 31;
643             *heads = 16;
644             cyls_times_heads = total_sectors / *secs_per_cyl;
645         }
646 
647         if (cyls_times_heads >= (*heads * 1024)) {
648             *secs_per_cyl = 63;
649             *heads = 16;
650             cyls_times_heads = total_sectors / *secs_per_cyl;
651         }
652     }
653 
654     *cyls = cyls_times_heads / *heads;
655 
656     return 0;
657 }
658 
659 static int create_dynamic_disk(int fd, uint8_t *buf, int64_t total_sectors)
660 {
661     VHDDynDiskHeader *dyndisk_header =
662         (VHDDynDiskHeader *) buf;
663     size_t block_size, num_bat_entries;
664     int i;
665     int ret = -EIO;
666 
667     // Write the footer (twice: at the beginning and at the end)
668     block_size = 0x200000;
669     num_bat_entries = (total_sectors + block_size / 512) / (block_size / 512);
670 
671     if (write(fd, buf, HEADER_SIZE) != HEADER_SIZE) {
672         goto fail;
673     }
674 
675     if (lseek(fd, 1536 + ((num_bat_entries * 4 + 511) & ~511), SEEK_SET) < 0) {
676         goto fail;
677     }
678     if (write(fd, buf, HEADER_SIZE) != HEADER_SIZE) {
679         goto fail;
680     }
681 
682     // Write the initial BAT
683     if (lseek(fd, 3 * 512, SEEK_SET) < 0) {
684         goto fail;
685     }
686 
687     memset(buf, 0xFF, 512);
688     for (i = 0; i < (num_bat_entries * 4 + 511) / 512; i++) {
689         if (write(fd, buf, 512) != 512) {
690             goto fail;
691         }
692     }
693 
694     // Prepare the Dynamic Disk Header
695     memset(buf, 0, 1024);
696 
697     memcpy(dyndisk_header->magic, "cxsparse", 8);
698 
699     /*
700      * Note: The spec is actually wrong here for data_offset, it says
701      * 0xFFFFFFFF, but MS tools expect all 64 bits to be set.
702      */
703     dyndisk_header->data_offset = be64_to_cpu(0xFFFFFFFFFFFFFFFFULL);
704     dyndisk_header->table_offset = be64_to_cpu(3 * 512);
705     dyndisk_header->version = be32_to_cpu(0x00010000);
706     dyndisk_header->block_size = be32_to_cpu(block_size);
707     dyndisk_header->max_table_entries = be32_to_cpu(num_bat_entries);
708 
709     dyndisk_header->checksum = be32_to_cpu(vpc_checksum(buf, 1024));
710 
711     // Write the header
712     if (lseek(fd, 512, SEEK_SET) < 0) {
713         goto fail;
714     }
715 
716     if (write(fd, buf, 1024) != 1024) {
717         goto fail;
718     }
719     ret = 0;
720 
721  fail:
722     return ret;
723 }
724 
725 static int create_fixed_disk(int fd, uint8_t *buf, int64_t total_size)
726 {
727     int ret = -EIO;
728 
729     /* Add footer to total size */
730     total_size += 512;
731     if (ftruncate(fd, total_size) != 0) {
732         ret = -errno;
733         goto fail;
734     }
735     if (lseek(fd, -512, SEEK_END) < 0) {
736         goto fail;
737     }
738     if (write(fd, buf, HEADER_SIZE) != HEADER_SIZE) {
739         goto fail;
740     }
741 
742     ret = 0;
743 
744  fail:
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 fd, 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     bool nocow = false;
762 
763     /* Read out options */
764     total_size = qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0);
765     disk_type_param = qemu_opt_get_del(opts, BLOCK_OPT_SUBFMT);
766     if (disk_type_param) {
767         if (!strcmp(disk_type_param, "dynamic")) {
768             disk_type = VHD_DYNAMIC;
769         } else if (!strcmp(disk_type_param, "fixed")) {
770             disk_type = VHD_FIXED;
771         } else {
772             ret = -EINVAL;
773             goto out;
774         }
775     } else {
776         disk_type = VHD_DYNAMIC;
777     }
778     nocow = qemu_opt_get_bool_del(opts, BLOCK_OPT_NOCOW, false);
779 
780     /* Create the file */
781     fd = qemu_open(filename, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY, 0644);
782     if (fd < 0) {
783         ret = -EIO;
784         goto out;
785     }
786 
787     if (nocow) {
788 #ifdef __linux__
789         /* Set NOCOW flag to solve performance issue on fs like btrfs.
790          * This is an optimisation. The FS_IOC_SETFLAGS ioctl return value will
791          * be ignored since any failure of this operation should not block the
792          * left work.
793          */
794         int attr;
795         if (ioctl(fd, FS_IOC_GETFLAGS, &attr) == 0) {
796             attr |= FS_NOCOW_FL;
797             ioctl(fd, FS_IOC_SETFLAGS, &attr);
798         }
799 #endif
800     }
801 
802     /*
803      * Calculate matching total_size and geometry. Increase the number of
804      * sectors requested until we get enough (or fail). This ensures that
805      * qemu-img convert doesn't truncate images, but rather rounds up.
806      */
807     total_sectors = total_size / BDRV_SECTOR_SIZE;
808     for (i = 0; total_sectors > (int64_t)cyls * heads * secs_per_cyl; i++) {
809         if (calculate_geometry(total_sectors + i, &cyls, &heads,
810                                &secs_per_cyl))
811         {
812             ret = -EFBIG;
813             goto fail;
814         }
815     }
816 
817     total_sectors = (int64_t) cyls * heads * secs_per_cyl;
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 = be32_to_cpu(0x02);
828     footer->version = be32_to_cpu(0x00010000);
829     if (disk_type == VHD_DYNAMIC) {
830         footer->data_offset = be64_to_cpu(HEADER_SIZE);
831     } else {
832         footer->data_offset = be64_to_cpu(0xFFFFFFFFFFFFFFFFULL);
833     }
834     footer->timestamp = be32_to_cpu(time(NULL) - VHD_TIMESTAMP_BASE);
835 
836     /* Version of Virtual PC 2007 */
837     footer->major = be16_to_cpu(0x0005);
838     footer->minor = be16_to_cpu(0x0003);
839     if (disk_type == VHD_DYNAMIC) {
840         footer->orig_size = be64_to_cpu(total_sectors * 512);
841         footer->size = be64_to_cpu(total_sectors * 512);
842     } else {
843         footer->orig_size = be64_to_cpu(total_size);
844         footer->size = be64_to_cpu(total_size);
845     }
846     footer->cyls = be16_to_cpu(cyls);
847     footer->heads = heads;
848     footer->secs_per_cyl = secs_per_cyl;
849 
850     footer->type = be32_to_cpu(disk_type);
851 
852 #if defined(CONFIG_UUID)
853     uuid_generate(footer->uuid);
854 #endif
855 
856     footer->checksum = be32_to_cpu(vpc_checksum(buf, HEADER_SIZE));
857 
858     if (disk_type == VHD_DYNAMIC) {
859         ret = create_dynamic_disk(fd, buf, total_sectors);
860     } else {
861         ret = create_fixed_disk(fd, buf, total_size);
862     }
863 
864 fail:
865     qemu_close(fd);
866 out:
867     g_free(disk_type_param);
868     return ret;
869 }
870 
871 static int vpc_has_zero_init(BlockDriverState *bs)
872 {
873     BDRVVPCState *s = bs->opaque;
874     VHDFooter *footer =  (VHDFooter *) s->footer_buf;
875 
876     if (cpu_to_be32(footer->type) == VHD_FIXED) {
877         return bdrv_has_zero_init(bs->file);
878     } else {
879         return 1;
880     }
881 }
882 
883 static void vpc_close(BlockDriverState *bs)
884 {
885     BDRVVPCState *s = bs->opaque;
886     qemu_vfree(s->pagetable);
887 #ifdef CACHE
888     g_free(s->pageentry_u8);
889 #endif
890 
891     migrate_del_blocker(s->migration_blocker);
892     error_free(s->migration_blocker);
893 }
894 
895 static QemuOptsList vpc_create_opts = {
896     .name = "vpc-create-opts",
897     .head = QTAILQ_HEAD_INITIALIZER(vpc_create_opts.head),
898     .desc = {
899         {
900             .name = BLOCK_OPT_SIZE,
901             .type = QEMU_OPT_SIZE,
902             .help = "Virtual disk size"
903         },
904         {
905             .name = BLOCK_OPT_SUBFMT,
906             .type = QEMU_OPT_STRING,
907             .help =
908                 "Type of virtual hard disk format. Supported formats are "
909                 "{dynamic (default) | fixed} "
910         },
911         {
912             .name = BLOCK_OPT_NOCOW,
913             .type = QEMU_OPT_BOOL,
914             .help = "Turn off copy-on-write (valid only on btrfs)"
915         },
916         { /* end of list */ }
917     }
918 };
919 
920 static BlockDriver bdrv_vpc = {
921     .format_name    = "vpc",
922     .instance_size  = sizeof(BDRVVPCState),
923 
924     .bdrv_probe             = vpc_probe,
925     .bdrv_open              = vpc_open,
926     .bdrv_close             = vpc_close,
927     .bdrv_reopen_prepare    = vpc_reopen_prepare,
928     .bdrv_create            = vpc_create,
929 
930     .bdrv_read              = vpc_co_read,
931     .bdrv_write             = vpc_co_write,
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);
945