qemu/block/vhdx.c

   1 /*
   2  * Block driver for Hyper-V VHDX Images
   3  *
   4  * Copyright (c) 2013 Red Hat, Inc.,
   5  *
   6  * Authors:
   7  *  Jeff Cody <jcody@redhat.com>
   8  *
   9  *  This is based on the "VHDX Format Specification v1.00", published 8/25/2012
  10  *  by Microsoft:
  11  *      https://www.microsoft.com/en-us/download/details.aspx?id=34750
  12  *
  13  * This work is licensed under the terms of the GNU LGPL, version 2 or later.
  14  * See the COPYING.LIB file in the top-level directory.
  15  *
  16  */
  17
  18 #include "qemu-common.h"
  19 #include "block/block_int.h"
  20 #include "qemu/module.h"
  21 #include "qemu/crc32c.h"
  22 #include "block/vhdx.h"
  23 #include "migration/migration.h"
  24
  25 #include <uuid/uuid.h>
  26 #include <glib.h>
  27
  28 /* Options for VHDX creation */
  29
  30 #define VHDX_BLOCK_OPT_LOG_SIZE   "log_size"
  31 #define VHDX_BLOCK_OPT_BLOCK_SIZE "block_size"
  32 #define VHDX_BLOCK_OPT_ZERO "block_state_zero"
  33
  34 typedef enum VHDXImageType {
  35     VHDX_TYPE_DYNAMIC = 0,
  36     VHDX_TYPE_FIXED,
  37     VHDX_TYPE_DIFFERENCING,   /* Currently unsupported */
  38 } VHDXImageType;
  39
  40 /* Several metadata and region table data entries are identified by
  41  * guids in  a MS-specific GUID format. */
  42
  43
  44 /* ------- Known Region Table GUIDs ---------------------- */
  45 static const MSGUID bat_guid =      { .data1 = 0x2dc27766,
  46                                       .data2 = 0xf623,
  47                                       .data3 = 0x4200,
  48                                       .data4 = { 0x9d, 0x64, 0x11, 0x5e,
  49                                                  0x9b, 0xfd, 0x4a, 0x08} };
  50
  51 static const MSGUID metadata_guid = { .data1 = 0x8b7ca206,
  52                                       .data2 = 0x4790,
  53                                       .data3 = 0x4b9a,
  54                                       .data4 = { 0xb8, 0xfe, 0x57, 0x5f,
  55                                                  0x05, 0x0f, 0x88, 0x6e} };
  56
  57
  58
  59 /* ------- Known Metadata Entry GUIDs ---------------------- */
  60 static const MSGUID file_param_guid =   { .data1 = 0xcaa16737,
  61                                           .data2 = 0xfa36,
  62                                           .data3 = 0x4d43,
  63                                           .data4 = { 0xb3, 0xb6, 0x33, 0xf0,
  64                                                      0xaa, 0x44, 0xe7, 0x6b} };
  65
  66 static const MSGUID virtual_size_guid = { .data1 = 0x2FA54224,
  67                                           .data2 = 0xcd1b,
  68                                           .data3 = 0x4876,
  69                                           .data4 = { 0xb2, 0x11, 0x5d, 0xbe,
  70                                                      0xd8, 0x3b, 0xf4, 0xb8} };
  71
  72 static const MSGUID page83_guid =       { .data1 = 0xbeca12ab,
  73                                           .data2 = 0xb2e6,
  74                                           .data3 = 0x4523,
  75                                           .data4 = { 0x93, 0xef, 0xc3, 0x09,
  76                                                      0xe0, 0x00, 0xc7, 0x46} };
  77
  78
  79 static const MSGUID phys_sector_guid =  { .data1 = 0xcda348c7,
  80                                           .data2 = 0x445d,
  81                                           .data3 = 0x4471,
  82                                           .data4 = { 0x9c, 0xc9, 0xe9, 0x88,
  83                                                      0x52, 0x51, 0xc5, 0x56} };
  84
  85 static const MSGUID parent_locator_guid = { .data1 = 0xa8d35f2d,
  86                                             .data2 = 0xb30b,
  87                                             .data3 = 0x454d,
  88                                             .data4 = { 0xab, 0xf7, 0xd3,
  89                                                        0xd8, 0x48, 0x34,
  90                                                        0xab, 0x0c} };
  91
  92 static const MSGUID logical_sector_guid = { .data1 = 0x8141bf1d,
  93                                             .data2 = 0xa96f,
  94                                             .data3 = 0x4709,
  95                                             .data4 = { 0xba, 0x47, 0xf2,
  96                                                        0x33, 0xa8, 0xfa,
  97                                                        0xab, 0x5f} };
  98
  99 /* Each parent type must have a valid GUID; this is for parent images
 100  * of type 'VHDX'.  If we were to allow e.g. a QCOW2 parent, we would
 101  * need to make up our own QCOW2 GUID type */
 102 static const MSGUID parent_vhdx_guid __attribute__((unused))
 103                                      = { .data1 = 0xb04aefb7,
 104                                          .data2 = 0xd19e,
 105                                          .data3 = 0x4a81,
 106                                          .data4 = { 0xb7, 0x89, 0x25, 0xb8,
 107                                                     0xe9, 0x44, 0x59, 0x13} };
 108
 109
 110 #define META_FILE_PARAMETER_PRESENT      0x01
 111 #define META_VIRTUAL_DISK_SIZE_PRESENT   0x02
 112 #define META_PAGE_83_PRESENT             0x04
 113 #define META_LOGICAL_SECTOR_SIZE_PRESENT 0x08
 114 #define META_PHYS_SECTOR_SIZE_PRESENT    0x10
 115 #define META_PARENT_LOCATOR_PRESENT      0x20
 116
 117 #define META_ALL_PRESENT    \
 118     (META_FILE_PARAMETER_PRESENT | META_VIRTUAL_DISK_SIZE_PRESENT | \
 119      META_PAGE_83_PRESENT | META_LOGICAL_SECTOR_SIZE_PRESENT | \
 120      META_PHYS_SECTOR_SIZE_PRESENT)
 121
 122
 123 typedef struct VHDXSectorInfo {
 124     uint32_t bat_idx;       /* BAT entry index */
 125     uint32_t sectors_avail; /* sectors available in payload block */
 126     uint32_t bytes_left;    /* bytes left in the block after data to r/w */
 127     uint32_t bytes_avail;   /* bytes available in payload block */
 128     uint64_t file_offset;   /* absolute offset in bytes, in file */
 129     uint64_t block_offset;  /* block offset, in bytes */
 130 } VHDXSectorInfo;
 131
 132 /* Calculates new checksum.
 133  *
 134  * Zero is substituted during crc calculation for the original crc field
 135  * crc_offset: byte offset in buf of the buffer crc
 136  * buf: buffer pointer
 137  * size: size of buffer (must be > crc_offset+4)
 138  *
 139  * Note: The buffer should have all multi-byte data in little-endian format,
 140  *       and the resulting checksum is in little endian format.
 141  */
 142 uint32_t vhdx_update_checksum(uint8_t *buf, size_t size, int crc_offset)
 143 {
 144     uint32_t crc;
 145
 146     assert(buf != NULL);
 147     assert(size > (crc_offset + sizeof(crc)));
 148
 149     memset(buf + crc_offset, 0, sizeof(crc));
 150     crc =  crc32c(0xffffffff, buf, size);
 151     cpu_to_le32s(&crc);
 152     memcpy(buf + crc_offset, &crc, sizeof(crc));
 153
 154     return crc;
 155 }
 156
 157 uint32_t vhdx_checksum_calc(uint32_t crc, uint8_t *buf, size_t size,
 158                             int crc_offset)
 159 {
 160     uint32_t crc_new;
 161     uint32_t crc_orig;
 162     assert(buf != NULL);
 163
 164     if (crc_offset > 0) {
 165         memcpy(&crc_orig, buf + crc_offset, sizeof(crc_orig));
 166         memset(buf + crc_offset, 0, sizeof(crc_orig));
 167     }
 168
 169     crc_new = crc32c(crc, buf, size);
 170     if (crc_offset > 0) {
 171         memcpy(buf + crc_offset, &crc_orig, sizeof(crc_orig));
 172     }
 173
 174     return crc_new;
 175 }
 176
 177 /* Validates the checksum of the buffer, with an in-place CRC.
 178  *
 179  * Zero is substituted during crc calculation for the original crc field,
 180  * and the crc field is restored afterwards.  But the buffer will be modifed
 181  * during the calculation, so this may not be not suitable for multi-threaded
 182  * use.
 183  *
 184  * crc_offset: byte offset in buf of the buffer crc
 185  * buf: buffer pointer
 186  * size: size of buffer (must be > crc_offset+4)
 187  *
 188  * returns true if checksum is valid, false otherwise
 189  */
 190 bool vhdx_checksum_is_valid(uint8_t *buf, size_t size, int crc_offset)
 191 {
 192     uint32_t crc_orig;
 193     uint32_t crc;
 194
 195     assert(buf != NULL);
 196     assert(size > (crc_offset + 4));
 197
 198     memcpy(&crc_orig, buf + crc_offset, sizeof(crc_orig));
 199     crc_orig = le32_to_cpu(crc_orig);
 200
 201     crc = vhdx_checksum_calc(0xffffffff, buf, size, crc_offset);
 202
 203     return crc == crc_orig;
 204 }
 205
 206
 207 /*
 208  * This generates a UUID that is compliant with the MS GUIDs used
 209  * in the VHDX spec (and elsewhere).
 210  */
 211 void vhdx_guid_generate(MSGUID *guid)
 212 {
 213     uuid_t uuid;
 214     assert(guid != NULL);
 215
 216     uuid_generate(uuid);
 217     memcpy(guid, uuid, sizeof(MSGUID));
 218 }
 219
 220 /* Check for region overlaps inside the VHDX image */
 221 static int vhdx_region_check(BDRVVHDXState *s, uint64_t start, uint64_t length)
 222 {
 223     int ret = 0;
 224     uint64_t end;
 225     VHDXRegionEntry *r;
 226
 227     end = start + length;
 228     QLIST_FOREACH(r, &s->regions, entries) {
 229         if (!((start >= r->end) || (end <= r->start))) {
 230             ret = -EINVAL;
 231             goto exit;
 232         }
 233     }
 234
 235 exit:
 236     return ret;
 237 }
 238
 239 /* Register a region for future checks */
 240 static void vhdx_region_register(BDRVVHDXState *s,
 241                                  uint64_t start, uint64_t length)
 242 {
 243     VHDXRegionEntry *r;
 244
 245     r = g_malloc0(sizeof(*r));
 246
 247     r->start = start;
 248     r->end = start + length;
 249
 250     QLIST_INSERT_HEAD(&s->regions, r, entries);
 251 }
 252
 253 /* Free all registered regions */
 254 static void vhdx_region_unregister_all(BDRVVHDXState *s)
 255 {
 256     VHDXRegionEntry *r, *r_next;
 257
 258     QLIST_FOREACH_SAFE(r, &s->regions, entries, r_next) {
 259         QLIST_REMOVE(r, entries);
 260         g_free(r);
 261     }
 262 }
 263
 264 static void vhdx_set_shift_bits(BDRVVHDXState *s)
 265 {
 266     s->logical_sector_size_bits = 31 - clz32(s->logical_sector_size);
 267     s->sectors_per_block_bits =   31 - clz32(s->sectors_per_block);
 268     s->chunk_ratio_bits =         63 - clz64(s->chunk_ratio);
 269     s->block_size_bits =          31 - clz32(s->block_size);
 270 }
 271
 272 /*
 273  * Per the MS VHDX Specification, for every VHDX file:
 274  *      - The header section is fixed size - 1 MB
 275  *      - The header section is always the first "object"
 276  *      - The first 64KB of the header is the File Identifier
 277  *      - The first uint64 (8 bytes) is the VHDX Signature ("vhdxfile")
 278  *      - The following 512 bytes constitute a UTF-16 string identifiying the
 279  *        software that created the file, and is optional and diagnostic only.
 280  *
 281  *  Therefore, we probe by looking for the vhdxfile signature "vhdxfile"
 282  */
 283 static int vhdx_probe(const uint8_t *buf, int buf_size, const char *filename)
 284 {
 285     if (buf_size >= 8 && !memcmp(buf, "vhdxfile", 8)) {
 286         return 100;
 287     }
 288     return 0;
 289 }
 290
 291 /*
 292  * Writes the header to the specified offset.
 293  *
 294  * This will optionally read in buffer data from disk (otherwise zero-fill),
 295  * and then update the header checksum.  Header is converted to proper
 296  * endianness before being written to the specified file offset
 297  */
 298 static int vhdx_write_header(BlockDriverState *bs_file, VHDXHeader *hdr,
 299                              uint64_t offset, bool read)
 300 {
 301     uint8_t *buffer = NULL;
 302     int ret;
 303     VHDXHeader *header_le;
 304
 305     assert(bs_file != NULL);
 306     assert(hdr != NULL);
 307
 308     /* the header checksum is not over just the packed size of VHDXHeader,
 309      * but rather over the entire 'reserved' range for the header, which is
 310      * 4KB (VHDX_HEADER_SIZE). */
 311
 312     buffer = qemu_blockalign(bs_file, VHDX_HEADER_SIZE);
 313     if (read) {
 314         /* if true, we can't assume the extra reserved bytes are 0 */
 315         ret = bdrv_pread(bs_file, offset, buffer, VHDX_HEADER_SIZE);
 316         if (ret < 0) {
 317             goto exit;
 318         }
 319     } else {
 320         memset(buffer, 0, VHDX_HEADER_SIZE);
 321     }
 322
 323     /* overwrite the actual VHDXHeader portion */
 324     header_le = (VHDXHeader *)buffer;
 325     memcpy(header_le, hdr, sizeof(VHDXHeader));
 326     vhdx_header_le_export(hdr, header_le);
 327     vhdx_update_checksum(buffer, VHDX_HEADER_SIZE,
 328                          offsetof(VHDXHeader, checksum));
 329     ret = bdrv_pwrite_sync(bs_file, offset, header_le, sizeof(VHDXHeader));
 330
 331 exit:
 332     qemu_vfree(buffer);
 333     return ret;
 334 }
 335
 336 /* Update the VHDX headers
 337  *
 338  * This follows the VHDX spec procedures for header updates.
 339  *
 340  *  - non-current header is updated with largest sequence number
 341  */
 342 static int vhdx_update_header(BlockDriverState *bs, BDRVVHDXState *s,
 343                               bool generate_data_write_guid, MSGUID *log_guid)
 344 {
 345     int ret = 0;
 346     int hdr_idx = 0;
 347     uint64_t header_offset = VHDX_HEADER1_OFFSET;
 348
 349     VHDXHeader *active_header;
 350     VHDXHeader *inactive_header;
 351
 352     /* operate on the non-current header */
 353     if (s->curr_header == 0) {
 354         hdr_idx = 1;
 355         header_offset = VHDX_HEADER2_OFFSET;
 356     }
 357
 358     active_header   = s->headers[s->curr_header];
 359     inactive_header = s->headers[hdr_idx];
 360
 361     inactive_header->sequence_number = active_header->sequence_number + 1;
 362
 363     /* a new file guid must be generated before any file write, including
 364      * headers */
 365     inactive_header->file_write_guid = s->session_guid;
 366
 367     /* a new data guid only needs to be generated before any guest-visible
 368      * writes (i.e. something observable via virtual disk read) */
 369     if (generate_data_write_guid) {
 370         vhdx_guid_generate(&inactive_header->data_write_guid);
 371     }
 372
 373     /* update the log guid if present */
 374     if (log_guid) {
 375         inactive_header->log_guid = *log_guid;
 376     }
 377
 378     ret = vhdx_write_header(bs->file, inactive_header, header_offset, true);
 379     if (ret < 0) {
 380         goto exit;
 381     }
 382     s->curr_header = hdr_idx;
 383
 384 exit:
 385     return ret;
 386 }
 387
 388 /*
 389  * The VHDX spec calls for header updates to be performed twice, so that both
 390  * the current and non-current header have valid info
 391  */
 392 int vhdx_update_headers(BlockDriverState *bs, BDRVVHDXState *s,
 393                         bool generate_data_write_guid, MSGUID *log_guid)
 394 {
 395     int ret;
 396
 397     ret = vhdx_update_header(bs, s, generate_data_write_guid, log_guid);
 398     if (ret < 0) {
 399         return ret;
 400     }
 401     ret = vhdx_update_header(bs, s, generate_data_write_guid, log_guid);
 402     return ret;
 403 }
 404
 405 /* opens the specified header block from the VHDX file header section */
 406 static void vhdx_parse_header(BlockDriverState *bs, BDRVVHDXState *s,
 407                               Error **errp)
 408 {
 409     int ret;
 410     VHDXHeader *header1;
 411     VHDXHeader *header2;
 412     bool h1_valid = false;
 413     bool h2_valid = false;
 414     uint64_t h1_seq = 0;
 415     uint64_t h2_seq = 0;
 416     uint8_t *buffer;
 417
 418     /* header1 & header2 are freed in vhdx_close() */
 419     header1 = qemu_blockalign(bs, sizeof(VHDXHeader));
 420     header2 = qemu_blockalign(bs, sizeof(VHDXHeader));
 421
 422     buffer = qemu_blockalign(bs, VHDX_HEADER_SIZE);
 423
 424     s->headers[0] = header1;
 425     s->headers[1] = header2;
 426
 427     /* We have to read the whole VHDX_HEADER_SIZE instead of
 428      * sizeof(VHDXHeader), because the checksum is over the whole
 429      * region */
 430     ret = bdrv_pread(bs->file, VHDX_HEADER1_OFFSET, buffer, VHDX_HEADER_SIZE);
 431     if (ret < 0) {
 432         goto fail;
 433     }
 434     /* copy over just the relevant portion that we need */
 435     memcpy(header1, buffer, sizeof(VHDXHeader));
 436
 437     if (vhdx_checksum_is_valid(buffer, VHDX_HEADER_SIZE, 4)) {
 438         vhdx_header_le_import(header1);
 439         if (header1->signature == VHDX_HEADER_SIGNATURE &&
 440             header1->version == 1) {
 441             h1_seq = header1->sequence_number;
 442             h1_valid = true;
 443         }
 444     }
 445
 446     ret = bdrv_pread(bs->file, VHDX_HEADER2_OFFSET, buffer, VHDX_HEADER_SIZE);
 447     if (ret < 0) {
 448         goto fail;
 449     }
 450     /* copy over just the relevant portion that we need */
 451     memcpy(header2, buffer, sizeof(VHDXHeader));
 452
 453     if (vhdx_checksum_is_valid(buffer, VHDX_HEADER_SIZE, 4)) {
 454         vhdx_header_le_import(header2);
 455         if (header2->signature == VHDX_HEADER_SIGNATURE &&
 456             header2->version == 1) {
 457             h2_seq = header2->sequence_number;
 458             h2_valid = true;
 459         }
 460     }
 461
 462     /* If there is only 1 valid header (or no valid headers), we
 463      * don't care what the sequence numbers are */
 464     if (h1_valid && !h2_valid) {
 465         s->curr_header = 0;
 466     } else if (!h1_valid && h2_valid) {
 467         s->curr_header = 1;
 468     } else if (!h1_valid && !h2_valid) {
 469         goto fail;
 470     } else {
 471         /* If both headers are valid, then we choose the active one by the
 472          * highest sequence number.  If the sequence numbers are equal, that is
 473          * invalid */
 474         if (h1_seq > h2_seq) {
 475             s->curr_header = 0;
 476         } else if (h2_seq > h1_seq) {
 477             s->curr_header = 1;
 478         } else {
 479             /* The Microsoft Disk2VHD tool will create 2 identical
 480              * headers, with identical sequence numbers.  If the headers are
 481              * identical, don't consider the file corrupt */
 482             if (!memcmp(header1, header2, sizeof(VHDXHeader))) {
 483                 s->curr_header = 0;
 484             } else {
 485                 goto fail;
 486             }
 487         }
 488     }
 489
 490     vhdx_region_register(s, s->headers[s->curr_header]->log_offset,
 491                             s->headers[s->curr_header]->log_length);
 492     goto exit;
 493
 494 fail:
 495     error_setg_errno(errp, -ret, "No valid VHDX header found");
 496     qemu_vfree(header1);
 497     qemu_vfree(header2);
 498     s->headers[0] = NULL;
 499     s->headers[1] = NULL;
 500 exit:
 501     qemu_vfree(buffer);
 502 }
 503
 504
 505 static int vhdx_open_region_tables(BlockDriverState *bs, BDRVVHDXState *s)
 506 {
 507     int ret = 0;
 508     uint8_t *buffer;
 509     int offset = 0;
 510     VHDXRegionTableEntry rt_entry;
 511     uint32_t i;
 512     bool bat_rt_found = false;
 513     bool metadata_rt_found = false;
 514
 515     /* We have to read the whole 64KB block, because the crc32 is over the
 516      * whole block */
 517     buffer = qemu_blockalign(bs, VHDX_HEADER_BLOCK_SIZE);
 518
 519     ret = bdrv_pread(bs->file, VHDX_REGION_TABLE_OFFSET, buffer,
 520                      VHDX_HEADER_BLOCK_SIZE);
 521     if (ret < 0) {
 522         goto fail;
 523     }
 524     memcpy(&s->rt, buffer, sizeof(s->rt));
 525     offset += sizeof(s->rt);
 526
 527     if (!vhdx_checksum_is_valid(buffer, VHDX_HEADER_BLOCK_SIZE, 4)) {
 528         ret = -EINVAL;
 529         goto fail;
 530     }
 531
 532     vhdx_region_header_le_import(&s->rt);
 533
 534     if (s->rt.signature != VHDX_REGION_SIGNATURE) {
 535         ret = -EINVAL;
 536         goto fail;
 537     }
 538
 539
 540     /* Per spec, maximum region table entry count is 2047 */
 541     if (s->rt.entry_count > 2047) {
 542         ret = -EINVAL;
 543         goto fail;
 544     }
 545
 546     for (i = 0; i < s->rt.entry_count; i++) {
 547         memcpy(&rt_entry, buffer + offset, sizeof(rt_entry));
 548         offset += sizeof(rt_entry);
 549
 550         vhdx_region_entry_le_import(&rt_entry);
 551
 552         /* check for region overlap between these entries, and any
 553          * other memory regions in the file */
 554         ret = vhdx_region_check(s, rt_entry.file_offset, rt_entry.length);
 555         if (ret < 0) {
 556             goto fail;
 557         }
 558
 559         vhdx_region_register(s, rt_entry.file_offset, rt_entry.length);
 560
 561         /* see if we recognize the entry */
 562         if (guid_eq(rt_entry.guid, bat_guid)) {
 563             /* must be unique; if we have already found it this is invalid */
 564             if (bat_rt_found) {
 565                 ret = -EINVAL;
 566                 goto fail;
 567             }
 568             bat_rt_found = true;
 569             s->bat_rt = rt_entry;
 570             continue;
 571         }
 572
 573         if (guid_eq(rt_entry.guid, metadata_guid)) {
 574             /* must be unique; if we have already found it this is invalid */
 575             if (metadata_rt_found) {
 576                 ret = -EINVAL;
 577                 goto fail;
 578             }
 579             metadata_rt_found = true;
 580             s->metadata_rt = rt_entry;
 581             continue;
 582         }
 583
 584         if (rt_entry.data_bits & VHDX_REGION_ENTRY_REQUIRED) {
 585             /* cannot read vhdx file - required region table entry that
 586              * we do not understand.  per spec, we must fail to open */
 587             ret = -ENOTSUP;
 588             goto fail;
 589         }
 590     }
 591
 592     if (!bat_rt_found || !metadata_rt_found) {
 593         ret = -EINVAL;
 594         goto fail;
 595     }
 596
 597     ret = 0;
 598
 599 fail:
 600     qemu_vfree(buffer);
 601     return ret;
 602 }
 603
 604
 605
 606 /* Metadata initial parser
 607  *
 608  * This loads all the metadata entry fields.  This may cause additional
 609  * fields to be processed (e.g. parent locator, etc..).
 610  *
 611  * There are 5 Metadata items that are always required:
 612  *      - File Parameters (block size, has a parent)
 613  *      - Virtual Disk Size (size, in bytes, of the virtual drive)
 614  *      - Page 83 Data (scsi page 83 guid)
 615  *      - Logical Sector Size (logical sector size in bytes, either 512 or
 616  *                             4096.  We only support 512 currently)
 617  *      - Physical Sector Size (512 or 4096)
 618  *
 619  * Also, if the File Parameters indicate this is a differencing file,
 620  * we must also look for the Parent Locator metadata item.
 621  */
 622 static int vhdx_parse_metadata(BlockDriverState *bs, BDRVVHDXState *s)
 623 {
 624     int ret = 0;
 625     uint8_t *buffer;
 626     int offset = 0;
 627     uint32_t i = 0;
 628     VHDXMetadataTableEntry md_entry;
 629
 630     buffer = qemu_blockalign(bs, VHDX_METADATA_TABLE_MAX_SIZE);
 631
 632     ret = bdrv_pread(bs->file, s->metadata_rt.file_offset, buffer,
 633                      VHDX_METADATA_TABLE_MAX_SIZE);
 634     if (ret < 0) {
 635         goto exit;
 636     }
 637     memcpy(&s->metadata_hdr, buffer, sizeof(s->metadata_hdr));
 638     offset += sizeof(s->metadata_hdr);
 639
 640     vhdx_metadata_header_le_import(&s->metadata_hdr);
 641
 642     if (s->metadata_hdr.signature != VHDX_METADATA_SIGNATURE) {
 643         ret = -EINVAL;
 644         goto exit;
 645     }
 646
 647     s->metadata_entries.present = 0;
 648
 649     if ((s->metadata_hdr.entry_count * sizeof(md_entry)) >
 650         (VHDX_METADATA_TABLE_MAX_SIZE - offset)) {
 651         ret = -EINVAL;
 652         goto exit;
 653     }
 654
 655     for (i = 0; i < s->metadata_hdr.entry_count; i++) {
 656         memcpy(&md_entry, buffer + offset, sizeof(md_entry));
 657         offset += sizeof(md_entry);
 658
 659         vhdx_metadata_entry_le_import(&md_entry);
 660
 661         if (guid_eq(md_entry.item_id, file_param_guid)) {
 662             if (s->metadata_entries.present & META_FILE_PARAMETER_PRESENT) {
 663                 ret = -EINVAL;
 664                 goto exit;
 665             }
 666             s->metadata_entries.file_parameters_entry = md_entry;
 667             s->metadata_entries.present |= META_FILE_PARAMETER_PRESENT;
 668             continue;
 669         }
 670
 671         if (guid_eq(md_entry.item_id, virtual_size_guid)) {
 672             if (s->metadata_entries.present & META_VIRTUAL_DISK_SIZE_PRESENT) {
 673                 ret = -EINVAL;
 674                 goto exit;
 675             }
 676             s->metadata_entries.virtual_disk_size_entry = md_entry;
 677             s->metadata_entries.present |= META_VIRTUAL_DISK_SIZE_PRESENT;
 678             continue;
 679         }
 680
 681         if (guid_eq(md_entry.item_id, page83_guid)) {
 682             if (s->metadata_entries.present & META_PAGE_83_PRESENT) {
 683                 ret = -EINVAL;
 684                 goto exit;
 685             }
 686             s->metadata_entries.page83_data_entry = md_entry;
 687             s->metadata_entries.present |= META_PAGE_83_PRESENT;
 688             continue;
 689         }
 690
 691         if (guid_eq(md_entry.item_id, logical_sector_guid)) {
 692             if (s->metadata_entries.present &
 693                 META_LOGICAL_SECTOR_SIZE_PRESENT) {
 694                 ret = -EINVAL;
 695                 goto exit;
 696             }
 697             s->metadata_entries.logical_sector_size_entry = md_entry;
 698             s->metadata_entries.present |= META_LOGICAL_SECTOR_SIZE_PRESENT;
 699             continue;
 700         }
 701
 702         if (guid_eq(md_entry.item_id, phys_sector_guid)) {
 703             if (s->metadata_entries.present & META_PHYS_SECTOR_SIZE_PRESENT) {
 704                 ret = -EINVAL;
 705                 goto exit;
 706             }
 707             s->metadata_entries.phys_sector_size_entry = md_entry;
 708             s->metadata_entries.present |= META_PHYS_SECTOR_SIZE_PRESENT;
 709             continue;
 710         }
 711
 712         if (guid_eq(md_entry.item_id, parent_locator_guid)) {
 713             if (s->metadata_entries.present & META_PARENT_LOCATOR_PRESENT) {
 714                 ret = -EINVAL;
 715                 goto exit;
 716             }
 717             s->metadata_entries.parent_locator_entry = md_entry;
 718             s->metadata_entries.present |= META_PARENT_LOCATOR_PRESENT;
 719             continue;
 720         }
 721
 722         if (md_entry.data_bits & VHDX_META_FLAGS_IS_REQUIRED) {
 723             /* cannot read vhdx file - required region table entry that
 724              * we do not understand.  per spec, we must fail to open */
 725             ret = -ENOTSUP;
 726             goto exit;
 727         }
 728     }
 729
 730     if (s->metadata_entries.present != META_ALL_PRESENT) {
 731         ret = -ENOTSUP;
 732         goto exit;
 733     }
 734
 735     ret = bdrv_pread(bs->file,
 736                      s->metadata_entries.file_parameters_entry.offset
 737                                          + s->metadata_rt.file_offset,
 738                      &s->params,
 739                      sizeof(s->params));
 740
 741     if (ret < 0) {
 742         goto exit;
 743     }
 744
 745     le32_to_cpus(&s->params.block_size);
 746     le32_to_cpus(&s->params.data_bits);
 747
 748
 749     /* We now have the file parameters, so we can tell if this is a
 750      * differencing file (i.e.. has_parent), is dynamic or fixed
 751      * sized (leave_blocks_allocated), and the block size */
 752
 753     /* The parent locator required iff the file parameters has_parent set */
 754     if (s->params.data_bits & VHDX_PARAMS_HAS_PARENT) {
 755         if (s->metadata_entries.present & META_PARENT_LOCATOR_PRESENT) {
 756             /* TODO: parse  parent locator fields */
 757             ret = -ENOTSUP; /* temp, until differencing files are supported */
 758             goto exit;
 759         } else {
 760             /* if has_parent is set, but there is not parent locator present,
 761              * then that is an invalid combination */
 762             ret = -EINVAL;
 763             goto exit;
 764         }
 765     }
 766
 767     /* determine virtual disk size, logical sector size,
 768      * and phys sector size */
 769
 770     ret = bdrv_pread(bs->file,
 771                      s->metadata_entries.virtual_disk_size_entry.offset
 772                                            + s->metadata_rt.file_offset,
 773                      &s->virtual_disk_size,
 774                      sizeof(uint64_t));
 775     if (ret < 0) {
 776         goto exit;
 777     }
 778     ret = bdrv_pread(bs->file,
 779                      s->metadata_entries.logical_sector_size_entry.offset
 780                                              + s->metadata_rt.file_offset,
 781                      &s->logical_sector_size,
 782                      sizeof(uint32_t));
 783     if (ret < 0) {
 784         goto exit;
 785     }
 786     ret = bdrv_pread(bs->file,
 787                      s->metadata_entries.phys_sector_size_entry.offset
 788                                           + s->metadata_rt.file_offset,
 789                      &s->physical_sector_size,
 790                      sizeof(uint32_t));
 791     if (ret < 0) {
 792         goto exit;
 793     }
 794
 795     le64_to_cpus(&s->virtual_disk_size);
 796     le32_to_cpus(&s->logical_sector_size);
 797     le32_to_cpus(&s->physical_sector_size);
 798
 799     if (s->params.block_size < VHDX_BLOCK_SIZE_MIN ||
 800         s->params.block_size > VHDX_BLOCK_SIZE_MAX) {
 801         ret = -EINVAL;
 802         goto exit;
 803     }
 804
 805     /* only 2 supported sector sizes */
 806     if (s->logical_sector_size != 512 && s->logical_sector_size != 4096) {
 807         ret = -EINVAL;
 808         goto exit;
 809     }
 810
 811     /* Both block_size and sector_size are guaranteed powers of 2, below.
 812        Due to range checks above, s->sectors_per_block can never be < 256 */
 813     s->sectors_per_block = s->params.block_size / s->logical_sector_size;
 814     s->chunk_ratio = (VHDX_MAX_SECTORS_PER_BLOCK) *
 815                      (uint64_t)s->logical_sector_size /
 816                      (uint64_t)s->params.block_size;
 817
 818     /* These values are ones we will want to use for division / multiplication
 819      * later on, and they are all guaranteed (per the spec) to be powers of 2,
 820      * so we can take advantage of that for shift operations during
 821      * reads/writes */
 822     if (s->logical_sector_size & (s->logical_sector_size - 1)) {
 823         ret = -EINVAL;
 824         goto exit;
 825     }
 826     if (s->sectors_per_block & (s->sectors_per_block - 1)) {
 827         ret = -EINVAL;
 828         goto exit;
 829     }
 830     if (s->chunk_ratio & (s->chunk_ratio - 1)) {
 831         ret = -EINVAL;
 832         goto exit;
 833     }
 834     s->block_size = s->params.block_size;
 835     if (s->block_size & (s->block_size - 1)) {
 836         ret = -EINVAL;
 837         goto exit;
 838     }
 839
 840     vhdx_set_shift_bits(s);
 841
 842     ret = 0;
 843
 844 exit:
 845     qemu_vfree(buffer);
 846     return ret;
 847 }
 848
 849 /*
 850  * Calculate the number of BAT entries, including sector
 851  * bitmap entries.
 852  */
 853 static void vhdx_calc_bat_entries(BDRVVHDXState *s)
 854 {
 855     uint32_t data_blocks_cnt, bitmap_blocks_cnt;
 856
 857     data_blocks_cnt = s->virtual_disk_size >> s->block_size_bits;
 858     if (s->virtual_disk_size - (data_blocks_cnt << s->block_size_bits)) {
 859         data_blocks_cnt++;
 860     }
 861     bitmap_blocks_cnt = data_blocks_cnt >> s->chunk_ratio_bits;
 862     if (data_blocks_cnt - (bitmap_blocks_cnt << s->chunk_ratio_bits)) {
 863         bitmap_blocks_cnt++;
 864     }
 865
 866     if (s->parent_entries) {
 867         s->bat_entries = bitmap_blocks_cnt * (s->chunk_ratio + 1);
 868     } else {
 869         s->bat_entries = data_blocks_cnt +
 870                          ((data_blocks_cnt - 1) >> s->chunk_ratio_bits);
 871     }
 872
 873 }
 874
 875 static void vhdx_close(BlockDriverState *bs)
 876 {
 877     BDRVVHDXState *s = bs->opaque;
 878     qemu_vfree(s->headers[0]);
 879     s->headers[0] = NULL;
 880     qemu_vfree(s->headers[1]);
 881     s->headers[1] = NULL;
 882     qemu_vfree(s->bat);
 883     s->bat = NULL;
 884     qemu_vfree(s->parent_entries);
 885     s->parent_entries = NULL;
 886     migrate_del_blocker(s->migration_blocker);
 887     error_free(s->migration_blocker);
 888     qemu_vfree(s->log.hdr);
 889     s->log.hdr = NULL;
 890     vhdx_region_unregister_all(s);
 891 }
 892
 893 static int vhdx_open(BlockDriverState *bs, QDict *options, int flags,
 894                      Error **errp)
 895 {
 896     BDRVVHDXState *s = bs->opaque;
 897     int ret = 0;
 898     uint32_t i;
 899     uint64_t signature;
 900     Error *local_err = NULL;
 901
 902     s->bat = NULL;
 903     s->first_visible_write = true;
 904
 905     qemu_co_mutex_init(&s->lock);
 906     QLIST_INIT(&s->regions);
 907
 908     /* validate the file signature */
 909     ret = bdrv_pread(bs->file, 0, &signature, sizeof(uint64_t));
 910     if (ret < 0) {
 911         goto fail;
 912     }
 913     if (memcmp(&signature, "vhdxfile", 8)) {
 914         ret = -EINVAL;
 915         goto fail;
 916     }
 917
 918     /* This is used for any header updates, for the file_write_guid.
 919      * The spec dictates that a new value should be used for the first
 920      * header update */
 921     vhdx_guid_generate(&s->session_guid);
 922
 923     vhdx_parse_header(bs, s, &local_err);
 924     if (local_err != NULL) {
 925         error_propagate(errp, local_err);
 926         ret = -EINVAL;
 927         goto fail;
 928     }
 929
 930     ret = vhdx_parse_log(bs, s, &s->log_replayed_on_open, errp);
 931     if (ret < 0) {
 932         goto fail;
 933     }
 934
 935     ret = vhdx_open_region_tables(bs, s);
 936     if (ret < 0) {
 937         goto fail;
 938     }
 939
 940     ret = vhdx_parse_metadata(bs, s);
 941     if (ret < 0) {
 942         goto fail;
 943     }
 944
 945     s->block_size = s->params.block_size;
 946
 947     /* the VHDX spec dictates that virtual_disk_size is always a multiple of
 948      * logical_sector_size */
 949     bs->total_sectors = s->virtual_disk_size >> s->logical_sector_size_bits;
 950
 951     vhdx_calc_bat_entries(s);
 952
 953     s->bat_offset = s->bat_rt.file_offset;
 954
 955     if (s->bat_entries > s->bat_rt.length / sizeof(VHDXBatEntry)) {
 956         /* BAT allocation is not large enough for all entries */
 957         ret = -EINVAL;
 958         goto fail;
 959     }
 960
 961     /* s->bat is freed in vhdx_close() */
 962     s->bat = qemu_try_blockalign(bs->file, s->bat_rt.length);
 963     if (s->bat == NULL) {
 964         ret = -ENOMEM;
 965         goto fail;
 966     }
 967
 968     ret = bdrv_pread(bs->file, s->bat_offset, s->bat, s->bat_rt.length);
 969     if (ret < 0) {
 970         goto fail;
 971     }
 972
 973     uint64_t payblocks = s->chunk_ratio;
 974     /* endian convert, and verify populated BAT field file offsets against
 975      * region table and log entries */
 976     for (i = 0; i < s->bat_entries; i++) {
 977         le64_to_cpus(&s->bat[i]);
 978         if (payblocks--) {
 979             /* payload bat entries */
 980             if ((s->bat[i] & VHDX_BAT_STATE_BIT_MASK) ==
 981                     PAYLOAD_BLOCK_FULLY_PRESENT) {
 982                 ret = vhdx_region_check(s, s->bat[i] & VHDX_BAT_FILE_OFF_MASK,
 983                                         s->block_size);
 984                 if (ret < 0) {
 985                     goto fail;
 986                 }
 987             }
 988         } else {
 989             payblocks = s->chunk_ratio;
 990             /* Once differencing files are supported, verify sector bitmap
 991              * blocks here */
 992         }
 993     }
 994
 995     if (flags & BDRV_O_RDWR) {
 996         ret = vhdx_update_headers(bs, s, false, NULL);
 997         if (ret < 0) {
 998             goto fail;
 999         }
1000     }
1001
1002     /* TODO: differencing files */
1003
1004     /* Disable migration when VHDX images are used */
1005     error_setg(&s->migration_blocker, "The vhdx format used by node '%s' "
1006                "does not support live migration",
1007                bdrv_get_device_or_node_name(bs));
1008     migrate_add_blocker(s->migration_blocker);
1009
1010     return 0;
1011 fail:
1012     vhdx_close(bs);
1013     return ret;
1014 }
1015
1016 static int vhdx_reopen_prepare(BDRVReopenState *state,
1017                                BlockReopenQueue *queue, Error **errp)
1018 {
1019     return 0;
1020 }
1021
1022
1023 /*
1024  * Perform sector to block offset translations, to get various
1025  * sector and file offsets into the image.  See VHDXSectorInfo
1026  */
1027 static void vhdx_block_translate(BDRVVHDXState *s, int64_t sector_num,
1028                                  int nb_sectors, VHDXSectorInfo *sinfo)
1029 {
1030     uint32_t block_offset;
1031
1032     sinfo->bat_idx = sector_num >> s->sectors_per_block_bits;
1033     /* effectively a modulo - this gives us the offset into the block
1034      * (in sector sizes) for our sector number */
1035     block_offset = sector_num - (sinfo->bat_idx << s->sectors_per_block_bits);
1036     /* the chunk ratio gives us the interleaving of the sector
1037      * bitmaps, so we need to advance our page block index by the
1038      * sector bitmaps entry number */
1039     sinfo->bat_idx += sinfo->bat_idx >> s->chunk_ratio_bits;
1040
1041     /* the number of sectors we can read/write in this cycle */
1042     sinfo->sectors_avail = s->sectors_per_block - block_offset;
1043
1044     sinfo->bytes_left = sinfo->sectors_avail << s->logical_sector_size_bits;
1045
1046     if (sinfo->sectors_avail > nb_sectors) {
1047         sinfo->sectors_avail = nb_sectors;
1048     }
1049
1050     sinfo->bytes_avail = sinfo->sectors_avail << s->logical_sector_size_bits;
1051
1052     sinfo->file_offset = s->bat[sinfo->bat_idx] & VHDX_BAT_FILE_OFF_MASK;
1053
1054     sinfo->block_offset = block_offset << s->logical_sector_size_bits;
1055
1056     /* The file offset must be past the header section, so must be > 0 */
1057     if (sinfo->file_offset == 0) {
1058         return;
1059     }
1060
1061     /* block offset is the offset in vhdx logical sectors, in
1062      * the payload data block. Convert that to a byte offset
1063      * in the block, and add in the payload data block offset
1064      * in the file, in bytes, to get the final read address */
1065
1066     sinfo->file_offset += sinfo->block_offset;
1067 }
1068
1069
1070 static int vhdx_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
1071 {
1072     BDRVVHDXState *s = bs->opaque;
1073
1074     bdi->cluster_size = s->block_size;
1075
1076     bdi->unallocated_blocks_are_zero =
1077         (s->params.data_bits & VHDX_PARAMS_HAS_PARENT) == 0;
1078
1079     return 0;
1080 }
1081
1082
1083 static coroutine_fn int vhdx_co_readv(BlockDriverState *bs, int64_t sector_num,
1084                                       int nb_sectors, QEMUIOVector *qiov)
1085 {
1086     BDRVVHDXState *s = bs->opaque;
1087     int ret = 0;
1088     VHDXSectorInfo sinfo;
1089     uint64_t bytes_done = 0;
1090     QEMUIOVector hd_qiov;
1091
1092     qemu_iovec_init(&hd_qiov, qiov->niov);
1093
1094     qemu_co_mutex_lock(&s->lock);
1095
1096     while (nb_sectors > 0) {
1097         /* We are a differencing file, so we need to inspect the sector bitmap
1098          * to see if we have the data or not */
1099         if (s->params.data_bits & VHDX_PARAMS_HAS_PARENT) {
1100             /* not supported yet */
1101             ret = -ENOTSUP;
1102             goto exit;
1103         } else {
1104             vhdx_block_translate(s, sector_num, nb_sectors, &sinfo);
1105
1106             qemu_iovec_reset(&hd_qiov);
1107             qemu_iovec_concat(&hd_qiov, qiov,  bytes_done, sinfo.bytes_avail);
1108
1109             /* check the payload block state */
1110             switch (s->bat[sinfo.bat_idx] & VHDX_BAT_STATE_BIT_MASK) {
1111             case PAYLOAD_BLOCK_NOT_PRESENT: /* fall through */
1112             case PAYLOAD_BLOCK_UNDEFINED:
1113             case PAYLOAD_BLOCK_UNMAPPED:
1114             case PAYLOAD_BLOCK_UNMAPPED_v095:
1115             case PAYLOAD_BLOCK_ZERO:
1116                 /* return zero */
1117                 qemu_iovec_memset(&hd_qiov, 0, 0, sinfo.bytes_avail);
1118                 break;
1119             case PAYLOAD_BLOCK_FULLY_PRESENT:
1120                 qemu_co_mutex_unlock(&s->lock);
1121                 ret = bdrv_co_readv(bs->file,
1122                                     sinfo.file_offset >> BDRV_SECTOR_BITS,
1123                                     sinfo.sectors_avail, &hd_qiov);
1124                 qemu_co_mutex_lock(&s->lock);
1125                 if (ret < 0) {
1126                     goto exit;
1127                 }
1128                 break;
1129             case PAYLOAD_BLOCK_PARTIALLY_PRESENT:
1130                 /* we don't yet support difference files, fall through
1131                  * to error */
1132             default:
1133                 ret = -EIO;
1134                 goto exit;
1135                 break;
1136             }
1137             nb_sectors -= sinfo.sectors_avail;
1138             sector_num += sinfo.sectors_avail;
1139             bytes_done += sinfo.bytes_avail;
1140         }
1141     }
1142     ret = 0;
1143 exit:
1144     qemu_co_mutex_unlock(&s->lock);
1145     qemu_iovec_destroy(&hd_qiov);
1146     return ret;
1147 }
1148
1149 /*
1150  * Allocate a new payload block at the end of the file.
1151  *
1152  * Allocation will happen at 1MB alignment inside the file
1153  *
1154  * Returns the file offset start of the new payload block
1155  */
1156 static int vhdx_allocate_block(BlockDriverState *bs, BDRVVHDXState *s,
1157                                     uint64_t *new_offset)
1158 {
1159     *new_offset = bdrv_getlength(bs->file);
1160
1161     /* per the spec, the address for a block is in units of 1MB */
1162     *new_offset = ROUND_UP(*new_offset, 1024 * 1024);
1163
1164     return bdrv_truncate(bs->file, *new_offset + s->block_size);
1165 }
1166
1167 /*
1168  * Update the BAT table entry with the new file offset, and the new entry
1169  * state */
1170 static void vhdx_update_bat_table_entry(BlockDriverState *bs, BDRVVHDXState *s,
1171                                        VHDXSectorInfo *sinfo,
1172                                        uint64_t *bat_entry_le,
1173                                        uint64_t *bat_offset, int state)
1174 {
1175     /* The BAT entry is a uint64, with 44 bits for the file offset in units of
1176      * 1MB, and 3 bits for the block state. */
1177     if ((state == PAYLOAD_BLOCK_ZERO)        ||
1178         (state == PAYLOAD_BLOCK_UNDEFINED)   ||
1179         (state == PAYLOAD_BLOCK_NOT_PRESENT) ||
1180         (state == PAYLOAD_BLOCK_UNMAPPED)) {
1181         s->bat[sinfo->bat_idx]  = 0;  /* For PAYLOAD_BLOCK_ZERO, the
1182                                          FileOffsetMB field is denoted as
1183                                          'reserved' in the v1.0 spec.  If it is
1184                                          non-zero, MS Hyper-V will fail to read
1185                                          the disk image */
1186     } else {
1187         s->bat[sinfo->bat_idx]  = sinfo->file_offset;
1188     }
1189
1190     s->bat[sinfo->bat_idx] |= state & VHDX_BAT_STATE_BIT_MASK;
1191
1192     *bat_entry_le = cpu_to_le64(s->bat[sinfo->bat_idx]);
1193     *bat_offset = s->bat_offset + sinfo->bat_idx * sizeof(VHDXBatEntry);
1194
1195 }
1196
1197 /* Per the spec, on the first write of guest-visible data to the file the
1198  * data write guid must be updated in the header */
1199 int vhdx_user_visible_write(BlockDriverState *bs, BDRVVHDXState *s)
1200 {
1201     int ret = 0;
1202     if (s->first_visible_write) {
1203         s->first_visible_write = false;
1204         ret = vhdx_update_headers(bs, s, true, NULL);
1205     }
1206     return ret;
1207 }
1208
1209 static coroutine_fn int vhdx_co_writev(BlockDriverState *bs, int64_t sector_num,
1210                                       int nb_sectors, QEMUIOVector *qiov)
1211 {
1212     int ret = -ENOTSUP;
1213     BDRVVHDXState *s = bs->opaque;
1214     VHDXSectorInfo sinfo;
1215     uint64_t bytes_done = 0;
1216     uint64_t bat_entry = 0;
1217     uint64_t bat_entry_offset = 0;
1218     QEMUIOVector hd_qiov;
1219     struct iovec iov1 = { 0 };
1220     struct iovec iov2 = { 0 };
1221     int sectors_to_write;
1222     int bat_state;
1223     uint64_t bat_prior_offset = 0;
1224     bool bat_update = false;
1225
1226     qemu_iovec_init(&hd_qiov, qiov->niov);
1227
1228     qemu_co_mutex_lock(&s->lock);
1229
1230     ret = vhdx_user_visible_write(bs, s);
1231     if (ret < 0) {
1232         goto exit;
1233     }
1234
1235     while (nb_sectors > 0) {
1236         bool use_zero_buffers = false;
1237         bat_update = false;
1238         if (s->params.data_bits & VHDX_PARAMS_HAS_PARENT) {
1239             /* not supported yet */
1240             ret = -ENOTSUP;
1241             goto exit;
1242         } else {
1243             vhdx_block_translate(s, sector_num, nb_sectors, &sinfo);
1244             sectors_to_write = sinfo.sectors_avail;
1245
1246             qemu_iovec_reset(&hd_qiov);
1247             /* check the payload block state */
1248             bat_state = s->bat[sinfo.bat_idx] & VHDX_BAT_STATE_BIT_MASK;
1249             switch (bat_state) {
1250             case PAYLOAD_BLOCK_ZERO:
1251                 /* in this case, we need to preserve zero writes for
1252                  * data that is not part of this write, so we must pad
1253                  * the rest of the buffer to zeroes */
1254
1255                 /* if we are on a posix system with ftruncate() that extends
1256                  * a file, then it is zero-filled for us.  On Win32, the raw
1257                  * layer uses SetFilePointer and SetFileEnd, which does not
1258                  * zero fill AFAIK */
1259
1260                 /* Queue another write of zero buffers if the underlying file
1261                  * does not zero-fill on file extension */
1262
1263                 if (bdrv_has_zero_init(bs->file) == 0) {
1264                     use_zero_buffers = true;
1265
1266                     /* zero fill the front, if any */
1267                     if (sinfo.block_offset) {
1268                         iov1.iov_len = sinfo.block_offset;
1269                         iov1.iov_base = qemu_blockalign(bs, iov1.iov_len);
1270                         memset(iov1.iov_base, 0, iov1.iov_len);
1271                         qemu_iovec_concat_iov(&hd_qiov, &iov1, 1, 0,
1272                                               iov1.iov_len);
1273                         sectors_to_write += iov1.iov_len >> BDRV_SECTOR_BITS;
1274                     }
1275
1276                     /* our actual data */
1277                     qemu_iovec_concat(&hd_qiov, qiov,  bytes_done,
1278                                       sinfo.bytes_avail);
1279
1280                     /* zero fill the back, if any */
1281                     if ((sinfo.bytes_avail - sinfo.block_offset) <
1282                          s->block_size) {
1283                         iov2.iov_len = s->block_size -
1284                                       (sinfo.bytes_avail + sinfo.block_offset);
1285                         iov2.iov_base = qemu_blockalign(bs, iov2.iov_len);
1286                         memset(iov2.iov_base, 0, iov2.iov_len);
1287                         qemu_iovec_concat_iov(&hd_qiov, &iov2, 1, 0,
1288                                               iov2.iov_len);
1289                         sectors_to_write += iov2.iov_len >> BDRV_SECTOR_BITS;
1290                     }
1291                 }
1292                 /* fall through */
1293             case PAYLOAD_BLOCK_NOT_PRESENT: /* fall through */
1294             case PAYLOAD_BLOCK_UNMAPPED:
1295             case PAYLOAD_BLOCK_UNMAPPED_v095:
1296             case PAYLOAD_BLOCK_UNDEFINED:
1297                 bat_prior_offset = sinfo.file_offset;
1298                 ret = vhdx_allocate_block(bs, s, &sinfo.file_offset);
1299                 if (ret < 0) {
1300                     goto exit;
1301                 }
1302                 /* once we support differencing files, this may also be
1303                  * partially present */
1304                 /* update block state to the newly specified state */
1305                 vhdx_update_bat_table_entry(bs, s, &sinfo, &bat_entry,
1306                                             &bat_entry_offset,
1307                                             PAYLOAD_BLOCK_FULLY_PRESENT);
1308                 bat_update = true;
1309                 /* since we just allocated a block, file_offset is the
1310                  * beginning of the payload block. It needs to be the
1311                  * write address, which includes the offset into the block */
1312                 if (!use_zero_buffers) {
1313                     sinfo.file_offset += sinfo.block_offset;
1314                 }
1315                 /* fall through */
1316             case PAYLOAD_BLOCK_FULLY_PRESENT:
1317                 /* if the file offset address is in the header zone,
1318                  * there is a problem */
1319                 if (sinfo.file_offset < (1024 * 1024)) {
1320                     ret = -EFAULT;
1321                     goto error_bat_restore;
1322                 }
1323
1324                 if (!use_zero_buffers) {
1325                     qemu_iovec_concat(&hd_qiov, qiov,  bytes_done,
1326                                       sinfo.bytes_avail);
1327                 }
1328                 /* block exists, so we can just overwrite it */
1329                 qemu_co_mutex_unlock(&s->lock);
1330                 ret = bdrv_co_writev(bs->file,
1331                                     sinfo.file_offset >> BDRV_SECTOR_BITS,
1332                                     sectors_to_write, &hd_qiov);
1333                 qemu_co_mutex_lock(&s->lock);
1334                 if (ret < 0) {
1335                     goto error_bat_restore;
1336                 }
1337                 break;
1338             case PAYLOAD_BLOCK_PARTIALLY_PRESENT:
1339                 /* we don't yet support difference files, fall through
1340                  * to error */
1341             default:
1342                 ret = -EIO;
1343                 goto exit;
1344                 break;
1345             }
1346
1347             if (bat_update) {
1348                 /* this will update the BAT entry into the log journal, and
1349                  * then flush the log journal out to disk */
1350                 ret =  vhdx_log_write_and_flush(bs, s, &bat_entry,
1351                                                 sizeof(VHDXBatEntry),
1352                                                 bat_entry_offset);
1353                 if (ret < 0) {
1354                     goto exit;
1355                 }
1356             }
1357
1358             nb_sectors -= sinfo.sectors_avail;
1359             sector_num += sinfo.sectors_avail;
1360             bytes_done += sinfo.bytes_avail;
1361
1362         }
1363     }
1364
1365     goto exit;
1366
1367 error_bat_restore:
1368     if (bat_update) {
1369         /* keep metadata in sync, and restore the bat entry state
1370          * if error. */
1371         sinfo.file_offset = bat_prior_offset;
1372         vhdx_update_bat_table_entry(bs, s, &sinfo, &bat_entry,
1373                                     &bat_entry_offset, bat_state);
1374     }
1375 exit:
1376     qemu_vfree(iov1.iov_base);
1377     qemu_vfree(iov2.iov_base);
1378     qemu_co_mutex_unlock(&s->lock);
1379     qemu_iovec_destroy(&hd_qiov);
1380     return ret;
1381 }
1382
1383
1384
1385 /*
1386  * Create VHDX Headers
1387  *
1388  * There are 2 headers, and the highest sequence number will represent
1389  * the active header
1390  */
1391 static int vhdx_create_new_headers(BlockDriverState *bs, uint64_t image_size,
1392                                    uint32_t log_size)
1393 {
1394     int ret = 0;
1395     VHDXHeader *hdr = NULL;
1396
1397     hdr = g_new0(VHDXHeader, 1);
1398
1399     hdr->signature       = VHDX_HEADER_SIGNATURE;
1400     hdr->sequence_number = g_random_int();
1401     hdr->log_version     = 0;
1402     hdr->version         = 1;
1403     hdr->log_length      = log_size;
1404     hdr->log_offset      = VHDX_HEADER_SECTION_END;
1405     vhdx_guid_generate(&hdr->file_write_guid);
1406     vhdx_guid_generate(&hdr->data_write_guid);
1407
1408     ret = vhdx_write_header(bs, hdr, VHDX_HEADER1_OFFSET, false);
1409     if (ret < 0) {
1410         goto exit;
1411     }
1412     hdr->sequence_number++;
1413     ret = vhdx_write_header(bs, hdr, VHDX_HEADER2_OFFSET, false);
1414     if (ret < 0) {
1415         goto exit;
1416     }
1417
1418 exit:
1419     g_free(hdr);
1420     return ret;
1421 }
1422
1423 #define VHDX_METADATA_ENTRY_BUFFER_SIZE \
1424                                     (sizeof(VHDXFileParameters)               +\
1425                                      sizeof(VHDXVirtualDiskSize)              +\
1426                                      sizeof(VHDXPage83Data)                   +\
1427                                      sizeof(VHDXVirtualDiskLogicalSectorSize) +\
1428                                      sizeof(VHDXVirtualDiskPhysicalSectorSize))
1429
1430 /*
1431  * Create the Metadata entries.
1432  *
1433  * For more details on the entries, see section 3.5 (pg 29) in the
1434  * VHDX 1.00 specification.
1435  *
1436  * We support 5 metadata entries (all required by spec):
1437  *          File Parameters,
1438  *          Virtual Disk Size,
1439  *          Page 83 Data,
1440  *          Logical Sector Size,
1441  *          Physical Sector Size
1442  *
1443  * The first 64KB of the Metadata section is reserved for the metadata
1444  * header and entries; beyond that, the metadata items themselves reside.
1445  */
1446 static int vhdx_create_new_metadata(BlockDriverState *bs,
1447                                     uint64_t image_size,
1448                                     uint32_t block_size,
1449                                     uint32_t sector_size,
1450                                     uint64_t metadata_offset,
1451                                     VHDXImageType type)
1452 {
1453     int ret = 0;
1454     uint32_t offset = 0;
1455     void *buffer = NULL;
1456     void *entry_buffer;
1457     VHDXMetadataTableHeader *md_table;;
1458     VHDXMetadataTableEntry  *md_table_entry;
1459
1460     /* Metadata entries */
1461     VHDXFileParameters     *mt_file_params;
1462     VHDXVirtualDiskSize    *mt_virtual_size;
1463     VHDXPage83Data         *mt_page83;
1464     VHDXVirtualDiskLogicalSectorSize  *mt_log_sector_size;
1465     VHDXVirtualDiskPhysicalSectorSize *mt_phys_sector_size;
1466
1467     entry_buffer = g_malloc0(VHDX_METADATA_ENTRY_BUFFER_SIZE);
1468
1469     mt_file_params = entry_buffer;
1470     offset += sizeof(VHDXFileParameters);
1471     mt_virtual_size = entry_buffer + offset;
1472     offset += sizeof(VHDXVirtualDiskSize);
1473     mt_page83 = entry_buffer + offset;
1474     offset += sizeof(VHDXPage83Data);
1475     mt_log_sector_size = entry_buffer + offset;
1476     offset += sizeof(VHDXVirtualDiskLogicalSectorSize);
1477     mt_phys_sector_size = entry_buffer + offset;
1478
1479     mt_file_params->block_size = cpu_to_le32(block_size);
1480     if (type == VHDX_TYPE_FIXED) {
1481         mt_file_params->data_bits |= VHDX_PARAMS_LEAVE_BLOCKS_ALLOCED;
1482         cpu_to_le32s(&mt_file_params->data_bits);
1483     }
1484
1485     vhdx_guid_generate(&mt_page83->page_83_data);
1486     cpu_to_leguids(&mt_page83->page_83_data);
1487     mt_virtual_size->virtual_disk_size        = cpu_to_le64(image_size);
1488     mt_log_sector_size->logical_sector_size   = cpu_to_le32(sector_size);
1489     mt_phys_sector_size->physical_sector_size = cpu_to_le32(sector_size);
1490
1491     buffer = g_malloc0(VHDX_HEADER_BLOCK_SIZE);
1492     md_table = buffer;
1493
1494     md_table->signature   = VHDX_METADATA_SIGNATURE;
1495     md_table->entry_count = 5;
1496     vhdx_metadata_header_le_export(md_table);
1497
1498
1499     /* This will reference beyond the reserved table portion */
1500     offset = 64 * KiB;
1501
1502     md_table_entry = buffer + sizeof(VHDXMetadataTableHeader);
1503
1504     md_table_entry[0].item_id = file_param_guid;
1505     md_table_entry[0].offset  = offset;
1506     md_table_entry[0].length  = sizeof(VHDXFileParameters);
1507     md_table_entry[0].data_bits |= VHDX_META_FLAGS_IS_REQUIRED;
1508     offset += md_table_entry[0].length;
1509     vhdx_metadata_entry_le_export(&md_table_entry[0]);
1510
1511     md_table_entry[1].item_id = virtual_size_guid;
1512     md_table_entry[1].offset  = offset;
1513     md_table_entry[1].length  = sizeof(VHDXVirtualDiskSize);
1514     md_table_entry[1].data_bits |= VHDX_META_FLAGS_IS_REQUIRED |
1515                                    VHDX_META_FLAGS_IS_VIRTUAL_DISK;
1516     offset += md_table_entry[1].length;
1517     vhdx_metadata_entry_le_export(&md_table_entry[1]);
1518
1519     md_table_entry[2].item_id = page83_guid;
1520     md_table_entry[2].offset  = offset;
1521     md_table_entry[2].length  = sizeof(VHDXPage83Data);
1522     md_table_entry[2].data_bits |= VHDX_META_FLAGS_IS_REQUIRED |
1523                                    VHDX_META_FLAGS_IS_VIRTUAL_DISK;
1524     offset += md_table_entry[2].length;
1525     vhdx_metadata_entry_le_export(&md_table_entry[2]);
1526
1527     md_table_entry[3].item_id = logical_sector_guid;
1528     md_table_entry[3].offset  = offset;
1529     md_table_entry[3].length  = sizeof(VHDXVirtualDiskLogicalSectorSize);
1530     md_table_entry[3].data_bits |= VHDX_META_FLAGS_IS_REQUIRED |
1531                                    VHDX_META_FLAGS_IS_VIRTUAL_DISK;
1532     offset += md_table_entry[3].length;
1533     vhdx_metadata_entry_le_export(&md_table_entry[3]);
1534
1535     md_table_entry[4].item_id = phys_sector_guid;
1536     md_table_entry[4].offset  = offset;
1537     md_table_entry[4].length  = sizeof(VHDXVirtualDiskPhysicalSectorSize);
1538     md_table_entry[4].data_bits |= VHDX_META_FLAGS_IS_REQUIRED |
1539                                    VHDX_META_FLAGS_IS_VIRTUAL_DISK;
1540     vhdx_metadata_entry_le_export(&md_table_entry[4]);
1541
1542     ret = bdrv_pwrite(bs, metadata_offset, buffer, VHDX_HEADER_BLOCK_SIZE);
1543     if (ret < 0) {
1544         goto exit;
1545     }
1546
1547     ret = bdrv_pwrite(bs, metadata_offset + (64 * KiB), entry_buffer,
1548                       VHDX_METADATA_ENTRY_BUFFER_SIZE);
1549     if (ret < 0) {
1550         goto exit;
1551     }
1552
1553
1554 exit:
1555     g_free(buffer);
1556     g_free(entry_buffer);
1557     return ret;
1558 }
1559
1560 /* This create the actual BAT itself.  We currently only support
1561  * 'Dynamic' and 'Fixed' image types.
1562  *
1563  *  Dynamic images: default state of the BAT is all zeroes.
1564  *
1565  *  Fixed images: default state of the BAT is fully populated, with
1566  *                file offsets and state PAYLOAD_BLOCK_FULLY_PRESENT.
1567  */
1568 static int vhdx_create_bat(BlockDriverState *bs, BDRVVHDXState *s,
1569                            uint64_t image_size, VHDXImageType type,
1570                            bool use_zero_blocks, uint64_t file_offset,
1571                            uint32_t length)
1572 {
1573     int ret = 0;
1574     uint64_t data_file_offset;
1575     uint64_t total_sectors = 0;
1576     uint64_t sector_num = 0;
1577     uint64_t unused;
1578     int block_state;
1579     VHDXSectorInfo sinfo;
1580
1581     assert(s->bat == NULL);
1582
1583     /* this gives a data start after BAT/bitmap entries, and well
1584      * past any metadata entries (with a 4 MB buffer for future
1585      * expansion */
1586     data_file_offset = file_offset + length + 5 * MiB;
1587     total_sectors = image_size >> s->logical_sector_size_bits;
1588
1589     if (type == VHDX_TYPE_DYNAMIC) {
1590         /* All zeroes, so we can just extend the file - the end of the BAT
1591          * is the furthest thing we have written yet */
1592         ret = bdrv_truncate(bs, data_file_offset);
1593         if (ret < 0) {
1594             goto exit;
1595         }
1596     } else if (type == VHDX_TYPE_FIXED) {
1597         ret = bdrv_truncate(bs, data_file_offset + image_size);
1598         if (ret < 0) {
1599             goto exit;
1600         }
1601     } else {
1602         ret = -ENOTSUP;
1603         goto exit;
1604     }
1605
1606     if (type == VHDX_TYPE_FIXED ||
1607                 use_zero_blocks ||
1608                 bdrv_has_zero_init(bs) == 0) {
1609         /* for a fixed file, the default BAT entry is not zero */
1610         s->bat = g_try_malloc0(length);
1611         if (length && s->bat == NULL) {
1612             ret = -ENOMEM;
1613             goto exit;
1614         }
1615         block_state = type == VHDX_TYPE_FIXED ? PAYLOAD_BLOCK_FULLY_PRESENT :
1616                                                 PAYLOAD_BLOCK_NOT_PRESENT;
1617         block_state = use_zero_blocks ? PAYLOAD_BLOCK_ZERO : block_state;
1618         /* fill the BAT by emulating sector writes of sectors_per_block size */
1619         while (sector_num < total_sectors) {
1620             vhdx_block_translate(s, sector_num, s->sectors_per_block, &sinfo);
1621             sinfo.file_offset = data_file_offset +
1622                                 (sector_num << s->logical_sector_size_bits);
1623             sinfo.file_offset = ROUND_UP(sinfo.file_offset, MiB);
1624             vhdx_update_bat_table_entry(bs, s, &sinfo, &unused, &unused,
1625                                         block_state);
1626             cpu_to_le64s(&s->bat[sinfo.bat_idx]);
1627             sector_num += s->sectors_per_block;
1628         }
1629         ret = bdrv_pwrite(bs, file_offset, s->bat, length);
1630         if (ret < 0) {
1631             goto exit;
1632         }
1633     }
1634
1635
1636
1637 exit:
1638     g_free(s->bat);
1639     return ret;
1640 }
1641
1642 /* Creates the region table header, and region table entries.
1643  * There are 2 supported region table entries: BAT, and Metadata/
1644  *
1645  * As the calculations for the BAT region table are also needed
1646  * to create the BAT itself, we will also cause the BAT to be
1647  * created.
1648  */
1649 static int vhdx_create_new_region_table(BlockDriverState *bs,
1650                                         uint64_t image_size,
1651                                         uint32_t block_size,
1652                                         uint32_t sector_size,
1653                                         uint32_t log_size,
1654                                         bool use_zero_blocks,
1655                                         VHDXImageType type,
1656                                         uint64_t *metadata_offset)
1657 {
1658     int ret = 0;
1659     uint32_t offset = 0;
1660     void *buffer = NULL;
1661     uint64_t bat_file_offset;
1662     uint32_t bat_length;
1663     BDRVVHDXState *s = NULL;
1664     VHDXRegionTableHeader *region_table;
1665     VHDXRegionTableEntry *rt_bat;
1666     VHDXRegionTableEntry *rt_metadata;
1667
1668     assert(metadata_offset != NULL);
1669
1670     /* Populate enough of the BDRVVHDXState to be able to use the
1671      * pre-existing BAT calculation, translation, and update functions */
1672     s = g_new0(BDRVVHDXState, 1);
1673
1674     s->chunk_ratio = (VHDX_MAX_SECTORS_PER_BLOCK) *
1675                      (uint64_t) sector_size / (uint64_t) block_size;
1676
1677     s->sectors_per_block = block_size / sector_size;
1678     s->virtual_disk_size = image_size;
1679     s->block_size = block_size;
1680     s->logical_sector_size = sector_size;
1681
1682     vhdx_set_shift_bits(s);
1683
1684     vhdx_calc_bat_entries(s);
1685
1686     /* At this point the VHDX state is populated enough for creation */
1687
1688     /* a single buffer is used so we can calculate the checksum over the
1689      * entire 64KB block */
1690     buffer = g_malloc0(VHDX_HEADER_BLOCK_SIZE);
1691     region_table = buffer;
1692     offset += sizeof(VHDXRegionTableHeader);
1693     rt_bat = buffer + offset;
1694     offset += sizeof(VHDXRegionTableEntry);
1695     rt_metadata  = buffer + offset;
1696
1697     region_table->signature = VHDX_REGION_SIGNATURE;
1698     region_table->entry_count = 2;   /* BAT and Metadata */
1699
1700     rt_bat->guid        = bat_guid;
1701     rt_bat->length      = ROUND_UP(s->bat_entries * sizeof(VHDXBatEntry), MiB);
1702     rt_bat->file_offset = ROUND_UP(VHDX_HEADER_SECTION_END + log_size, MiB);
1703     s->bat_offset = rt_bat->file_offset;
1704
1705     rt_metadata->guid        = metadata_guid;
1706     rt_metadata->file_offset = ROUND_UP(rt_bat->file_offset + rt_bat->length,
1707                                         MiB);
1708     rt_metadata->length      = 1 * MiB; /* min size, and more than enough */
1709     *metadata_offset = rt_metadata->file_offset;
1710
1711     bat_file_offset = rt_bat->file_offset;
1712     bat_length = rt_bat->length;
1713
1714     vhdx_region_header_le_export(region_table);
1715     vhdx_region_entry_le_export(rt_bat);
1716     vhdx_region_entry_le_export(rt_metadata);
1717
1718     vhdx_update_checksum(buffer, VHDX_HEADER_BLOCK_SIZE,
1719                          offsetof(VHDXRegionTableHeader, checksum));
1720
1721
1722     /* The region table gives us the data we need to create the BAT,
1723      * so do that now */
1724     ret = vhdx_create_bat(bs, s, image_size, type, use_zero_blocks,
1725                           bat_file_offset, bat_length);
1726     if (ret < 0) {
1727         goto exit;
1728     }
1729
1730     /* Now write out the region headers to disk */
1731     ret = bdrv_pwrite(bs, VHDX_REGION_TABLE_OFFSET, buffer,
1732                       VHDX_HEADER_BLOCK_SIZE);
1733     if (ret < 0) {
1734         goto exit;
1735     }
1736
1737     ret = bdrv_pwrite(bs, VHDX_REGION_TABLE2_OFFSET, buffer,
1738                       VHDX_HEADER_BLOCK_SIZE);
1739     if (ret < 0) {
1740         goto exit;
1741     }
1742
1743 exit:
1744     g_free(s);
1745     g_free(buffer);
1746     return ret;
1747 }
1748
1749 /* We need to create the following elements:
1750  *
1751  *    .-----------------------------------------------------------------.
1752  *    |   (A)    |   (B)    |    (C)    |     (D)       |     (E)       |
1753  *    |  File ID |  Header1 |  Header 2 |  Region Tbl 1 |  Region Tbl 2 |
1754  *    |          |          |           |               |               |
1755  *    .-----------------------------------------------------------------.
1756  *    0         64KB      128KB       192KB           256KB           320KB
1757  *
1758  *
1759  *    .---- ~ ----------- ~ ------------ ~ ---------------- ~ -----------.
1760  *    |     (F)     |     (G)       |    (H)    |                        |
1761  *    | Journal Log |  BAT / Bitmap |  Metadata |  .... data ......      |
1762  *    |             |               |           |                        |
1763  *    .---- ~ ----------- ~ ------------ ~ ---------------- ~ -----------.
1764  *   1MB
1765  */
1766 static int vhdx_create(const char *filename, QemuOpts *opts, Error **errp)
1767 {
1768     int ret = 0;
1769     uint64_t image_size = (uint64_t) 2 * GiB;
1770     uint32_t log_size   = 1 * MiB;
1771     uint32_t block_size = 0;
1772     uint64_t signature;
1773     uint64_t metadata_offset;
1774     bool use_zero_blocks = false;
1775
1776     gunichar2 *creator = NULL;
1777     glong creator_items;
1778     BlockDriverState *bs;
1779     char *type = NULL;
1780     VHDXImageType image_type;
1781     Error *local_err = NULL;
1782
1783     image_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
1784                           BDRV_SECTOR_SIZE);
1785     log_size = qemu_opt_get_size_del(opts, VHDX_BLOCK_OPT_LOG_SIZE, 0);
1786     block_size = qemu_opt_get_size_del(opts, VHDX_BLOCK_OPT_BLOCK_SIZE, 0);
1787     type = qemu_opt_get_del(opts, BLOCK_OPT_SUBFMT);
1788     use_zero_blocks = qemu_opt_get_bool_del(opts, VHDX_BLOCK_OPT_ZERO, true);
1789
1790     if (image_size > VHDX_MAX_IMAGE_SIZE) {
1791         error_setg_errno(errp, EINVAL, "Image size too large; max of 64TB");
1792         ret = -EINVAL;
1793         goto exit;
1794     }
1795
1796     if (type == NULL) {
1797         type = g_strdup("dynamic");
1798     }
1799
1800     if (!strcmp(type, "dynamic")) {
1801         image_type = VHDX_TYPE_DYNAMIC;
1802     } else if (!strcmp(type, "fixed")) {
1803         image_type = VHDX_TYPE_FIXED;
1804     } else if (!strcmp(type, "differencing")) {
1805         error_setg_errno(errp, ENOTSUP,
1806                          "Differencing files not yet supported");
1807         ret = -ENOTSUP;
1808         goto exit;
1809     } else {
1810         ret = -EINVAL;
1811         goto exit;
1812     }
1813
1814     /* These are pretty arbitrary, and mainly designed to keep the BAT
1815      * size reasonable to load into RAM */
1816     if (block_size == 0) {
1817         if (image_size > 32 * TiB) {
1818             block_size = 64 * MiB;
1819         } else if (image_size > (uint64_t) 100 * GiB) {
1820             block_size = 32 * MiB;
1821         } else if (image_size > 1 * GiB) {
1822             block_size = 16 * MiB;
1823         } else {
1824             block_size = 8 * MiB;
1825         }
1826     }
1827
1828
1829     /* make the log size close to what was specified, but must be
1830      * min 1MB, and multiple of 1MB */
1831     log_size = ROUND_UP(log_size, MiB);
1832
1833     block_size = ROUND_UP(block_size, MiB);
1834     block_size = block_size > VHDX_BLOCK_SIZE_MAX ? VHDX_BLOCK_SIZE_MAX :
1835                                                     block_size;
1836
1837     ret = bdrv_create_file(filename, opts, &local_err);
1838     if (ret < 0) {
1839         error_propagate(errp, local_err);
1840         goto exit;
1841     }
1842
1843     bs = NULL;
1844     ret = bdrv_open(&bs, filename, NULL, NULL, BDRV_O_RDWR | BDRV_O_PROTOCOL,
1845                     NULL, &local_err);
1846     if (ret < 0) {
1847         error_propagate(errp, local_err);
1848         goto exit;
1849     }
1850
1851     /* Create (A) */
1852
1853     /* The creator field is optional, but may be useful for
1854      * debugging / diagnostics */
1855     creator = g_utf8_to_utf16("QEMU v" QEMU_VERSION, -1, NULL,
1856                               &creator_items, NULL);
1857     signature = cpu_to_le64(VHDX_FILE_SIGNATURE);
1858     ret = bdrv_pwrite(bs, VHDX_FILE_ID_OFFSET, &signature, sizeof(signature));
1859     if (ret < 0) {
1860         goto delete_and_exit;
1861     }
1862     if (creator) {
1863         ret = bdrv_pwrite(bs, VHDX_FILE_ID_OFFSET + sizeof(signature),
1864                           creator, creator_items * sizeof(gunichar2));
1865         if (ret < 0) {
1866             goto delete_and_exit;
1867         }
1868     }
1869
1870
1871     /* Creates (B),(C) */
1872     ret = vhdx_create_new_headers(bs, image_size, log_size);
1873     if (ret < 0) {
1874         goto delete_and_exit;
1875     }
1876
1877     /* Creates (D),(E),(G) explicitly. (F) created as by-product */
1878     ret = vhdx_create_new_region_table(bs, image_size, block_size, 512,
1879                                        log_size, use_zero_blocks, image_type,
1880                                        &metadata_offset);
1881     if (ret < 0) {
1882         goto delete_and_exit;
1883     }
1884
1885     /* Creates (H) */
1886     ret = vhdx_create_new_metadata(bs, image_size, block_size, 512,
1887                                    metadata_offset, image_type);
1888     if (ret < 0) {
1889         goto delete_and_exit;
1890     }
1891
1892
1893 delete_and_exit:
1894     bdrv_unref(bs);
1895 exit:
1896     g_free(type);
1897     g_free(creator);
1898     return ret;
1899 }
1900
1901 /* If opened r/w, the VHDX driver will automatically replay the log,
1902  * if one is present, inside the vhdx_open() call.
1903  *
1904  * If qemu-img check -r all is called, the image is automatically opened
1905  * r/w and any log has already been replayed, so there is nothing (currently)
1906  * for us to do here
1907  */
1908 static int vhdx_check(BlockDriverState *bs, BdrvCheckResult *result,
1909                        BdrvCheckMode fix)
1910 {
1911     BDRVVHDXState *s = bs->opaque;
1912
1913     if (s->log_replayed_on_open) {
1914         result->corruptions_fixed++;
1915     }
1916     return 0;
1917 }
1918
1919 static QemuOptsList vhdx_create_opts = {
1920     .name = "vhdx-create-opts",
1921     .head = QTAILQ_HEAD_INITIALIZER(vhdx_create_opts.head),
1922     .desc = {
1923         {
1924            .name = BLOCK_OPT_SIZE,
1925            .type = QEMU_OPT_SIZE,
1926            .help = "Virtual disk size; max of 64TB."
1927        },
1928        {
1929            .name = VHDX_BLOCK_OPT_LOG_SIZE,
1930            .type = QEMU_OPT_SIZE,
1931            .def_value_str = stringify(DEFAULT_LOG_SIZE),
1932            .help = "Log size; min 1MB."
1933        },
1934        {
1935            .name = VHDX_BLOCK_OPT_BLOCK_SIZE,
1936            .type = QEMU_OPT_SIZE,
1937            .def_value_str = stringify(0),
1938            .help = "Block Size; min 1MB, max 256MB. " \
1939                    "0 means auto-calculate based on image size."
1940        },
1941        {
1942            .name = BLOCK_OPT_SUBFMT,
1943            .type = QEMU_OPT_STRING,
1944            .help = "VHDX format type, can be either 'dynamic' or 'fixed'. "\
1945                    "Default is 'dynamic'."
1946        },
1947        {
1948            .name = VHDX_BLOCK_OPT_ZERO,
1949            .type = QEMU_OPT_BOOL,
1950            .help = "Force use of payload blocks of type 'ZERO'. "\
1951                    "Non-standard, but default.  Do not set to 'off' when "\
1952                    "using 'qemu-img convert' with subformat=dynamic."
1953        },
1954        { NULL }
1955     }
1956 };
1957
1958 static BlockDriver bdrv_vhdx = {
1959     .format_name            = "vhdx",
1960     .instance_size          = sizeof(BDRVVHDXState),
1961     .bdrv_probe             = vhdx_probe,
1962     .bdrv_open              = vhdx_open,
1963     .bdrv_close             = vhdx_close,
1964     .bdrv_reopen_prepare    = vhdx_reopen_prepare,
1965     .bdrv_co_readv          = vhdx_co_readv,
1966     .bdrv_co_writev         = vhdx_co_writev,
1967     .bdrv_create            = vhdx_create,
1968     .bdrv_get_info          = vhdx_get_info,
1969     .bdrv_check             = vhdx_check,
1970     .bdrv_has_zero_init     = bdrv_has_zero_init_1,
1971
1972     .create_opts            = &vhdx_create_opts,
1973 };
1974
1975 static void bdrv_vhdx_init(void)
1976 {
1977     bdrv_register(&bdrv_vhdx);
1978 }
1979
1980 block_init(bdrv_vhdx_init);