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