1 /* 2 * Block driver for the VMDK format 3 * 4 * Copyright (c) 2004 Fabrice Bellard 5 * Copyright (c) 2005 Filip Navara 6 * 7 * Permission is hereby granted, free of charge, to any person obtaining a copy 8 * of this software and associated documentation files (the "Software"), to deal 9 * in the Software without restriction, including without limitation the rights 10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 11 * copies of the Software, and to permit persons to whom the Software is 12 * furnished to do so, subject to the following conditions: 13 * 14 * The above copyright notice and this permission notice shall be included in 15 * all copies or substantial portions of the Software. 16 * 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 23 * THE SOFTWARE. 24 */ 25 26 #include "qemu/osdep.h" 27 #include "qapi/error.h" 28 #include "block/block_int.h" 29 #include "sysemu/block-backend.h" 30 #include "qapi/qmp/qerror.h" 31 #include "qemu/error-report.h" 32 #include "qemu/module.h" 33 #include "qemu/option.h" 34 #include "qemu/bswap.h" 35 #include "migration/blocker.h" 36 #include "qemu/cutils.h" 37 #include <zlib.h> 38 39 #define VMDK3_MAGIC (('C' << 24) | ('O' << 16) | ('W' << 8) | 'D') 40 #define VMDK4_MAGIC (('K' << 24) | ('D' << 16) | ('M' << 8) | 'V') 41 #define VMDK4_COMPRESSION_DEFLATE 1 42 #define VMDK4_FLAG_NL_DETECT (1 << 0) 43 #define VMDK4_FLAG_RGD (1 << 1) 44 /* Zeroed-grain enable bit */ 45 #define VMDK4_FLAG_ZERO_GRAIN (1 << 2) 46 #define VMDK4_FLAG_COMPRESS (1 << 16) 47 #define VMDK4_FLAG_MARKER (1 << 17) 48 #define VMDK4_GD_AT_END 0xffffffffffffffffULL 49 50 #define VMDK_GTE_ZEROED 0x1 51 52 /* VMDK internal error codes */ 53 #define VMDK_OK 0 54 #define VMDK_ERROR (-1) 55 /* Cluster not allocated */ 56 #define VMDK_UNALLOC (-2) 57 #define VMDK_ZEROED (-3) 58 59 #define BLOCK_OPT_ZEROED_GRAIN "zeroed_grain" 60 61 typedef struct { 62 uint32_t version; 63 uint32_t flags; 64 uint32_t disk_sectors; 65 uint32_t granularity; 66 uint32_t l1dir_offset; 67 uint32_t l1dir_size; 68 uint32_t file_sectors; 69 uint32_t cylinders; 70 uint32_t heads; 71 uint32_t sectors_per_track; 72 } QEMU_PACKED VMDK3Header; 73 74 typedef struct { 75 uint32_t version; 76 uint32_t flags; 77 uint64_t capacity; 78 uint64_t granularity; 79 uint64_t desc_offset; 80 uint64_t desc_size; 81 /* Number of GrainTableEntries per GrainTable */ 82 uint32_t num_gtes_per_gt; 83 uint64_t rgd_offset; 84 uint64_t gd_offset; 85 uint64_t grain_offset; 86 char filler[1]; 87 char check_bytes[4]; 88 uint16_t compressAlgorithm; 89 } QEMU_PACKED VMDK4Header; 90 91 #define L2_CACHE_SIZE 16 92 93 typedef struct VmdkExtent { 94 BdrvChild *file; 95 bool flat; 96 bool compressed; 97 bool has_marker; 98 bool has_zero_grain; 99 int version; 100 int64_t sectors; 101 int64_t end_sector; 102 int64_t flat_start_offset; 103 int64_t l1_table_offset; 104 int64_t l1_backup_table_offset; 105 uint32_t *l1_table; 106 uint32_t *l1_backup_table; 107 unsigned int l1_size; 108 uint32_t l1_entry_sectors; 109 110 unsigned int l2_size; 111 uint32_t *l2_cache; 112 uint32_t l2_cache_offsets[L2_CACHE_SIZE]; 113 uint32_t l2_cache_counts[L2_CACHE_SIZE]; 114 115 int64_t cluster_sectors; 116 int64_t next_cluster_sector; 117 char *type; 118 } VmdkExtent; 119 120 typedef struct BDRVVmdkState { 121 CoMutex lock; 122 uint64_t desc_offset; 123 bool cid_updated; 124 bool cid_checked; 125 uint32_t cid; 126 uint32_t parent_cid; 127 int num_extents; 128 /* Extent array with num_extents entries, ascend ordered by address */ 129 VmdkExtent *extents; 130 Error *migration_blocker; 131 char *create_type; 132 } BDRVVmdkState; 133 134 typedef struct VmdkMetaData { 135 unsigned int l1_index; 136 unsigned int l2_index; 137 unsigned int l2_offset; 138 int valid; 139 uint32_t *l2_cache_entry; 140 } VmdkMetaData; 141 142 typedef struct VmdkGrainMarker { 143 uint64_t lba; 144 uint32_t size; 145 uint8_t data[0]; 146 } QEMU_PACKED VmdkGrainMarker; 147 148 enum { 149 MARKER_END_OF_STREAM = 0, 150 MARKER_GRAIN_TABLE = 1, 151 MARKER_GRAIN_DIRECTORY = 2, 152 MARKER_FOOTER = 3, 153 }; 154 155 static int vmdk_probe(const uint8_t *buf, int buf_size, const char *filename) 156 { 157 uint32_t magic; 158 159 if (buf_size < 4) { 160 return 0; 161 } 162 magic = be32_to_cpu(*(uint32_t *)buf); 163 if (magic == VMDK3_MAGIC || 164 magic == VMDK4_MAGIC) { 165 return 100; 166 } else { 167 const char *p = (const char *)buf; 168 const char *end = p + buf_size; 169 while (p < end) { 170 if (*p == '#') { 171 /* skip comment line */ 172 while (p < end && *p != '\n') { 173 p++; 174 } 175 p++; 176 continue; 177 } 178 if (*p == ' ') { 179 while (p < end && *p == ' ') { 180 p++; 181 } 182 /* skip '\r' if windows line endings used. */ 183 if (p < end && *p == '\r') { 184 p++; 185 } 186 /* only accept blank lines before 'version=' line */ 187 if (p == end || *p != '\n') { 188 return 0; 189 } 190 p++; 191 continue; 192 } 193 if (end - p >= strlen("version=X\n")) { 194 if (strncmp("version=1\n", p, strlen("version=1\n")) == 0 || 195 strncmp("version=2\n", p, strlen("version=2\n")) == 0) { 196 return 100; 197 } 198 } 199 if (end - p >= strlen("version=X\r\n")) { 200 if (strncmp("version=1\r\n", p, strlen("version=1\r\n")) == 0 || 201 strncmp("version=2\r\n", p, strlen("version=2\r\n")) == 0) { 202 return 100; 203 } 204 } 205 return 0; 206 } 207 return 0; 208 } 209 } 210 211 #define SECTOR_SIZE 512 212 #define DESC_SIZE (20 * SECTOR_SIZE) /* 20 sectors of 512 bytes each */ 213 #define BUF_SIZE 4096 214 #define HEADER_SIZE 512 /* first sector of 512 bytes */ 215 216 static void vmdk_free_extents(BlockDriverState *bs) 217 { 218 int i; 219 BDRVVmdkState *s = bs->opaque; 220 VmdkExtent *e; 221 222 for (i = 0; i < s->num_extents; i++) { 223 e = &s->extents[i]; 224 g_free(e->l1_table); 225 g_free(e->l2_cache); 226 g_free(e->l1_backup_table); 227 g_free(e->type); 228 if (e->file != bs->file) { 229 bdrv_unref_child(bs, e->file); 230 } 231 } 232 g_free(s->extents); 233 } 234 235 static void vmdk_free_last_extent(BlockDriverState *bs) 236 { 237 BDRVVmdkState *s = bs->opaque; 238 239 if (s->num_extents == 0) { 240 return; 241 } 242 s->num_extents--; 243 s->extents = g_renew(VmdkExtent, s->extents, s->num_extents); 244 } 245 246 /* Return -ve errno, or 0 on success and write CID into *pcid. */ 247 static int vmdk_read_cid(BlockDriverState *bs, int parent, uint32_t *pcid) 248 { 249 char *desc; 250 uint32_t cid; 251 const char *p_name, *cid_str; 252 size_t cid_str_size; 253 BDRVVmdkState *s = bs->opaque; 254 int ret; 255 256 desc = g_malloc0(DESC_SIZE); 257 ret = bdrv_pread(bs->file, s->desc_offset, desc, DESC_SIZE); 258 if (ret < 0) { 259 goto out; 260 } 261 262 if (parent) { 263 cid_str = "parentCID"; 264 cid_str_size = sizeof("parentCID"); 265 } else { 266 cid_str = "CID"; 267 cid_str_size = sizeof("CID"); 268 } 269 270 desc[DESC_SIZE - 1] = '\0'; 271 p_name = strstr(desc, cid_str); 272 if (p_name == NULL) { 273 ret = -EINVAL; 274 goto out; 275 } 276 p_name += cid_str_size; 277 if (sscanf(p_name, "%" SCNx32, &cid) != 1) { 278 ret = -EINVAL; 279 goto out; 280 } 281 *pcid = cid; 282 ret = 0; 283 284 out: 285 g_free(desc); 286 return ret; 287 } 288 289 static int vmdk_write_cid(BlockDriverState *bs, uint32_t cid) 290 { 291 char *desc, *tmp_desc; 292 char *p_name, *tmp_str; 293 BDRVVmdkState *s = bs->opaque; 294 int ret = 0; 295 296 desc = g_malloc0(DESC_SIZE); 297 tmp_desc = g_malloc0(DESC_SIZE); 298 ret = bdrv_pread(bs->file, s->desc_offset, desc, DESC_SIZE); 299 if (ret < 0) { 300 goto out; 301 } 302 303 desc[DESC_SIZE - 1] = '\0'; 304 tmp_str = strstr(desc, "parentCID"); 305 if (tmp_str == NULL) { 306 ret = -EINVAL; 307 goto out; 308 } 309 310 pstrcpy(tmp_desc, DESC_SIZE, tmp_str); 311 p_name = strstr(desc, "CID"); 312 if (p_name != NULL) { 313 p_name += sizeof("CID"); 314 snprintf(p_name, DESC_SIZE - (p_name - desc), "%" PRIx32 "\n", cid); 315 pstrcat(desc, DESC_SIZE, tmp_desc); 316 } 317 318 ret = bdrv_pwrite_sync(bs->file, s->desc_offset, desc, DESC_SIZE); 319 320 out: 321 g_free(desc); 322 g_free(tmp_desc); 323 return ret; 324 } 325 326 static int vmdk_is_cid_valid(BlockDriverState *bs) 327 { 328 BDRVVmdkState *s = bs->opaque; 329 uint32_t cur_pcid; 330 331 if (!s->cid_checked && bs->backing) { 332 BlockDriverState *p_bs = bs->backing->bs; 333 334 if (vmdk_read_cid(p_bs, 0, &cur_pcid) != 0) { 335 /* read failure: report as not valid */ 336 return 0; 337 } 338 if (s->parent_cid != cur_pcid) { 339 /* CID not valid */ 340 return 0; 341 } 342 } 343 s->cid_checked = true; 344 /* CID valid */ 345 return 1; 346 } 347 348 /* We have nothing to do for VMDK reopen, stubs just return success */ 349 static int vmdk_reopen_prepare(BDRVReopenState *state, 350 BlockReopenQueue *queue, Error **errp) 351 { 352 assert(state != NULL); 353 assert(state->bs != NULL); 354 return 0; 355 } 356 357 static int vmdk_parent_open(BlockDriverState *bs) 358 { 359 char *p_name; 360 char *desc; 361 BDRVVmdkState *s = bs->opaque; 362 int ret; 363 364 desc = g_malloc0(DESC_SIZE + 1); 365 ret = bdrv_pread(bs->file, s->desc_offset, desc, DESC_SIZE); 366 if (ret < 0) { 367 goto out; 368 } 369 ret = 0; 370 371 p_name = strstr(desc, "parentFileNameHint"); 372 if (p_name != NULL) { 373 char *end_name; 374 375 p_name += sizeof("parentFileNameHint") + 1; 376 end_name = strchr(p_name, '\"'); 377 if (end_name == NULL) { 378 ret = -EINVAL; 379 goto out; 380 } 381 if ((end_name - p_name) > sizeof(bs->backing_file) - 1) { 382 ret = -EINVAL; 383 goto out; 384 } 385 386 pstrcpy(bs->backing_file, end_name - p_name + 1, p_name); 387 } 388 389 out: 390 g_free(desc); 391 return ret; 392 } 393 394 /* Create and append extent to the extent array. Return the added VmdkExtent 395 * address. return NULL if allocation failed. */ 396 static int vmdk_add_extent(BlockDriverState *bs, 397 BdrvChild *file, bool flat, int64_t sectors, 398 int64_t l1_offset, int64_t l1_backup_offset, 399 uint32_t l1_size, 400 int l2_size, uint64_t cluster_sectors, 401 VmdkExtent **new_extent, 402 Error **errp) 403 { 404 VmdkExtent *extent; 405 BDRVVmdkState *s = bs->opaque; 406 int64_t nb_sectors; 407 408 if (cluster_sectors > 0x200000) { 409 /* 0x200000 * 512Bytes = 1GB for one cluster is unrealistic */ 410 error_setg(errp, "Invalid granularity, image may be corrupt"); 411 return -EFBIG; 412 } 413 if (l1_size > 512 * 1024 * 1024) { 414 /* Although with big capacity and small l1_entry_sectors, we can get a 415 * big l1_size, we don't want unbounded value to allocate the table. 416 * Limit it to 512M, which is 16PB for default cluster and L2 table 417 * size */ 418 error_setg(errp, "L1 size too big"); 419 return -EFBIG; 420 } 421 422 nb_sectors = bdrv_nb_sectors(file->bs); 423 if (nb_sectors < 0) { 424 return nb_sectors; 425 } 426 427 s->extents = g_renew(VmdkExtent, s->extents, s->num_extents + 1); 428 extent = &s->extents[s->num_extents]; 429 s->num_extents++; 430 431 memset(extent, 0, sizeof(VmdkExtent)); 432 extent->file = file; 433 extent->flat = flat; 434 extent->sectors = sectors; 435 extent->l1_table_offset = l1_offset; 436 extent->l1_backup_table_offset = l1_backup_offset; 437 extent->l1_size = l1_size; 438 extent->l1_entry_sectors = l2_size * cluster_sectors; 439 extent->l2_size = l2_size; 440 extent->cluster_sectors = flat ? sectors : cluster_sectors; 441 extent->next_cluster_sector = ROUND_UP(nb_sectors, cluster_sectors); 442 443 if (s->num_extents > 1) { 444 extent->end_sector = (*(extent - 1)).end_sector + extent->sectors; 445 } else { 446 extent->end_sector = extent->sectors; 447 } 448 bs->total_sectors = extent->end_sector; 449 if (new_extent) { 450 *new_extent = extent; 451 } 452 return 0; 453 } 454 455 static int vmdk_init_tables(BlockDriverState *bs, VmdkExtent *extent, 456 Error **errp) 457 { 458 int ret; 459 size_t l1_size; 460 int i; 461 462 /* read the L1 table */ 463 l1_size = extent->l1_size * sizeof(uint32_t); 464 extent->l1_table = g_try_malloc(l1_size); 465 if (l1_size && extent->l1_table == NULL) { 466 return -ENOMEM; 467 } 468 469 ret = bdrv_pread(extent->file, 470 extent->l1_table_offset, 471 extent->l1_table, 472 l1_size); 473 if (ret < 0) { 474 error_setg_errno(errp, -ret, 475 "Could not read l1 table from extent '%s'", 476 extent->file->bs->filename); 477 goto fail_l1; 478 } 479 for (i = 0; i < extent->l1_size; i++) { 480 le32_to_cpus(&extent->l1_table[i]); 481 } 482 483 if (extent->l1_backup_table_offset) { 484 extent->l1_backup_table = g_try_malloc(l1_size); 485 if (l1_size && extent->l1_backup_table == NULL) { 486 ret = -ENOMEM; 487 goto fail_l1; 488 } 489 ret = bdrv_pread(extent->file, 490 extent->l1_backup_table_offset, 491 extent->l1_backup_table, 492 l1_size); 493 if (ret < 0) { 494 error_setg_errno(errp, -ret, 495 "Could not read l1 backup table from extent '%s'", 496 extent->file->bs->filename); 497 goto fail_l1b; 498 } 499 for (i = 0; i < extent->l1_size; i++) { 500 le32_to_cpus(&extent->l1_backup_table[i]); 501 } 502 } 503 504 extent->l2_cache = 505 g_new(uint32_t, extent->l2_size * L2_CACHE_SIZE); 506 return 0; 507 fail_l1b: 508 g_free(extent->l1_backup_table); 509 fail_l1: 510 g_free(extent->l1_table); 511 return ret; 512 } 513 514 static int vmdk_open_vmfs_sparse(BlockDriverState *bs, 515 BdrvChild *file, 516 int flags, Error **errp) 517 { 518 int ret; 519 uint32_t magic; 520 VMDK3Header header; 521 VmdkExtent *extent; 522 523 ret = bdrv_pread(file, sizeof(magic), &header, sizeof(header)); 524 if (ret < 0) { 525 error_setg_errno(errp, -ret, 526 "Could not read header from file '%s'", 527 file->bs->filename); 528 return ret; 529 } 530 ret = vmdk_add_extent(bs, file, false, 531 le32_to_cpu(header.disk_sectors), 532 (int64_t)le32_to_cpu(header.l1dir_offset) << 9, 533 0, 534 le32_to_cpu(header.l1dir_size), 535 4096, 536 le32_to_cpu(header.granularity), 537 &extent, 538 errp); 539 if (ret < 0) { 540 return ret; 541 } 542 ret = vmdk_init_tables(bs, extent, errp); 543 if (ret) { 544 /* free extent allocated by vmdk_add_extent */ 545 vmdk_free_last_extent(bs); 546 } 547 return ret; 548 } 549 550 static int vmdk_open_desc_file(BlockDriverState *bs, int flags, char *buf, 551 QDict *options, Error **errp); 552 553 static char *vmdk_read_desc(BdrvChild *file, uint64_t desc_offset, Error **errp) 554 { 555 int64_t size; 556 char *buf; 557 int ret; 558 559 size = bdrv_getlength(file->bs); 560 if (size < 0) { 561 error_setg_errno(errp, -size, "Could not access file"); 562 return NULL; 563 } 564 565 if (size < 4) { 566 /* Both descriptor file and sparse image must be much larger than 4 567 * bytes, also callers of vmdk_read_desc want to compare the first 4 568 * bytes with VMDK4_MAGIC, let's error out if less is read. */ 569 error_setg(errp, "File is too small, not a valid image"); 570 return NULL; 571 } 572 573 size = MIN(size, (1 << 20) - 1); /* avoid unbounded allocation */ 574 buf = g_malloc(size + 1); 575 576 ret = bdrv_pread(file, desc_offset, buf, size); 577 if (ret < 0) { 578 error_setg_errno(errp, -ret, "Could not read from file"); 579 g_free(buf); 580 return NULL; 581 } 582 buf[ret] = 0; 583 584 return buf; 585 } 586 587 static int vmdk_open_vmdk4(BlockDriverState *bs, 588 BdrvChild *file, 589 int flags, QDict *options, Error **errp) 590 { 591 int ret; 592 uint32_t magic; 593 uint32_t l1_size, l1_entry_sectors; 594 VMDK4Header header; 595 VmdkExtent *extent; 596 BDRVVmdkState *s = bs->opaque; 597 int64_t l1_backup_offset = 0; 598 bool compressed; 599 600 ret = bdrv_pread(file, sizeof(magic), &header, sizeof(header)); 601 if (ret < 0) { 602 error_setg_errno(errp, -ret, 603 "Could not read header from file '%s'", 604 file->bs->filename); 605 return -EINVAL; 606 } 607 if (header.capacity == 0) { 608 uint64_t desc_offset = le64_to_cpu(header.desc_offset); 609 if (desc_offset) { 610 char *buf = vmdk_read_desc(file, desc_offset << 9, errp); 611 if (!buf) { 612 return -EINVAL; 613 } 614 ret = vmdk_open_desc_file(bs, flags, buf, options, errp); 615 g_free(buf); 616 return ret; 617 } 618 } 619 620 if (!s->create_type) { 621 s->create_type = g_strdup("monolithicSparse"); 622 } 623 624 if (le64_to_cpu(header.gd_offset) == VMDK4_GD_AT_END) { 625 /* 626 * The footer takes precedence over the header, so read it in. The 627 * footer starts at offset -1024 from the end: One sector for the 628 * footer, and another one for the end-of-stream marker. 629 */ 630 struct { 631 struct { 632 uint64_t val; 633 uint32_t size; 634 uint32_t type; 635 uint8_t pad[512 - 16]; 636 } QEMU_PACKED footer_marker; 637 638 uint32_t magic; 639 VMDK4Header header; 640 uint8_t pad[512 - 4 - sizeof(VMDK4Header)]; 641 642 struct { 643 uint64_t val; 644 uint32_t size; 645 uint32_t type; 646 uint8_t pad[512 - 16]; 647 } QEMU_PACKED eos_marker; 648 } QEMU_PACKED footer; 649 650 ret = bdrv_pread(file, 651 bs->file->bs->total_sectors * 512 - 1536, 652 &footer, sizeof(footer)); 653 if (ret < 0) { 654 error_setg_errno(errp, -ret, "Failed to read footer"); 655 return ret; 656 } 657 658 /* Some sanity checks for the footer */ 659 if (be32_to_cpu(footer.magic) != VMDK4_MAGIC || 660 le32_to_cpu(footer.footer_marker.size) != 0 || 661 le32_to_cpu(footer.footer_marker.type) != MARKER_FOOTER || 662 le64_to_cpu(footer.eos_marker.val) != 0 || 663 le32_to_cpu(footer.eos_marker.size) != 0 || 664 le32_to_cpu(footer.eos_marker.type) != MARKER_END_OF_STREAM) 665 { 666 error_setg(errp, "Invalid footer"); 667 return -EINVAL; 668 } 669 670 header = footer.header; 671 } 672 673 compressed = 674 le16_to_cpu(header.compressAlgorithm) == VMDK4_COMPRESSION_DEFLATE; 675 if (le32_to_cpu(header.version) > 3) { 676 error_setg(errp, "Unsupported VMDK version %" PRIu32, 677 le32_to_cpu(header.version)); 678 return -ENOTSUP; 679 } else if (le32_to_cpu(header.version) == 3 && (flags & BDRV_O_RDWR) && 680 !compressed) { 681 /* VMware KB 2064959 explains that version 3 added support for 682 * persistent changed block tracking (CBT), and backup software can 683 * read it as version=1 if it doesn't care about the changed area 684 * information. So we are safe to enable read only. */ 685 error_setg(errp, "VMDK version 3 must be read only"); 686 return -EINVAL; 687 } 688 689 if (le32_to_cpu(header.num_gtes_per_gt) > 512) { 690 error_setg(errp, "L2 table size too big"); 691 return -EINVAL; 692 } 693 694 l1_entry_sectors = le32_to_cpu(header.num_gtes_per_gt) 695 * le64_to_cpu(header.granularity); 696 if (l1_entry_sectors == 0) { 697 error_setg(errp, "L1 entry size is invalid"); 698 return -EINVAL; 699 } 700 l1_size = (le64_to_cpu(header.capacity) + l1_entry_sectors - 1) 701 / l1_entry_sectors; 702 if (le32_to_cpu(header.flags) & VMDK4_FLAG_RGD) { 703 l1_backup_offset = le64_to_cpu(header.rgd_offset) << 9; 704 } 705 if (bdrv_nb_sectors(file->bs) < le64_to_cpu(header.grain_offset)) { 706 error_setg(errp, "File truncated, expecting at least %" PRId64 " bytes", 707 (int64_t)(le64_to_cpu(header.grain_offset) 708 * BDRV_SECTOR_SIZE)); 709 return -EINVAL; 710 } 711 712 ret = vmdk_add_extent(bs, file, false, 713 le64_to_cpu(header.capacity), 714 le64_to_cpu(header.gd_offset) << 9, 715 l1_backup_offset, 716 l1_size, 717 le32_to_cpu(header.num_gtes_per_gt), 718 le64_to_cpu(header.granularity), 719 &extent, 720 errp); 721 if (ret < 0) { 722 return ret; 723 } 724 extent->compressed = 725 le16_to_cpu(header.compressAlgorithm) == VMDK4_COMPRESSION_DEFLATE; 726 if (extent->compressed) { 727 g_free(s->create_type); 728 s->create_type = g_strdup("streamOptimized"); 729 } 730 extent->has_marker = le32_to_cpu(header.flags) & VMDK4_FLAG_MARKER; 731 extent->version = le32_to_cpu(header.version); 732 extent->has_zero_grain = le32_to_cpu(header.flags) & VMDK4_FLAG_ZERO_GRAIN; 733 ret = vmdk_init_tables(bs, extent, errp); 734 if (ret) { 735 /* free extent allocated by vmdk_add_extent */ 736 vmdk_free_last_extent(bs); 737 } 738 return ret; 739 } 740 741 /* find an option value out of descriptor file */ 742 static int vmdk_parse_description(const char *desc, const char *opt_name, 743 char *buf, int buf_size) 744 { 745 char *opt_pos, *opt_end; 746 const char *end = desc + strlen(desc); 747 748 opt_pos = strstr(desc, opt_name); 749 if (!opt_pos) { 750 return VMDK_ERROR; 751 } 752 /* Skip "=\"" following opt_name */ 753 opt_pos += strlen(opt_name) + 2; 754 if (opt_pos >= end) { 755 return VMDK_ERROR; 756 } 757 opt_end = opt_pos; 758 while (opt_end < end && *opt_end != '"') { 759 opt_end++; 760 } 761 if (opt_end == end || buf_size < opt_end - opt_pos + 1) { 762 return VMDK_ERROR; 763 } 764 pstrcpy(buf, opt_end - opt_pos + 1, opt_pos); 765 return VMDK_OK; 766 } 767 768 /* Open an extent file and append to bs array */ 769 static int vmdk_open_sparse(BlockDriverState *bs, BdrvChild *file, int flags, 770 char *buf, QDict *options, Error **errp) 771 { 772 uint32_t magic; 773 774 magic = ldl_be_p(buf); 775 switch (magic) { 776 case VMDK3_MAGIC: 777 return vmdk_open_vmfs_sparse(bs, file, flags, errp); 778 break; 779 case VMDK4_MAGIC: 780 return vmdk_open_vmdk4(bs, file, flags, options, errp); 781 break; 782 default: 783 error_setg(errp, "Image not in VMDK format"); 784 return -EINVAL; 785 break; 786 } 787 } 788 789 static const char *next_line(const char *s) 790 { 791 while (*s) { 792 if (*s == '\n') { 793 return s + 1; 794 } 795 s++; 796 } 797 return s; 798 } 799 800 static int vmdk_parse_extents(const char *desc, BlockDriverState *bs, 801 const char *desc_file_path, QDict *options, 802 Error **errp) 803 { 804 int ret; 805 int matches; 806 char access[11]; 807 char type[11]; 808 char fname[512]; 809 const char *p, *np; 810 int64_t sectors = 0; 811 int64_t flat_offset; 812 char *extent_path; 813 BdrvChild *extent_file; 814 BDRVVmdkState *s = bs->opaque; 815 VmdkExtent *extent; 816 char extent_opt_prefix[32]; 817 Error *local_err = NULL; 818 819 for (p = desc; *p; p = next_line(p)) { 820 /* parse extent line in one of below formats: 821 * 822 * RW [size in sectors] FLAT "file-name.vmdk" OFFSET 823 * RW [size in sectors] SPARSE "file-name.vmdk" 824 * RW [size in sectors] VMFS "file-name.vmdk" 825 * RW [size in sectors] VMFSSPARSE "file-name.vmdk" 826 */ 827 flat_offset = -1; 828 matches = sscanf(p, "%10s %" SCNd64 " %10s \"%511[^\n\r\"]\" %" SCNd64, 829 access, §ors, type, fname, &flat_offset); 830 if (matches < 4 || strcmp(access, "RW")) { 831 continue; 832 } else if (!strcmp(type, "FLAT")) { 833 if (matches != 5 || flat_offset < 0) { 834 goto invalid; 835 } 836 } else if (!strcmp(type, "VMFS")) { 837 if (matches == 4) { 838 flat_offset = 0; 839 } else { 840 goto invalid; 841 } 842 } else if (matches != 4) { 843 goto invalid; 844 } 845 846 if (sectors <= 0 || 847 (strcmp(type, "FLAT") && strcmp(type, "SPARSE") && 848 strcmp(type, "VMFS") && strcmp(type, "VMFSSPARSE")) || 849 (strcmp(access, "RW"))) { 850 continue; 851 } 852 853 if (!path_is_absolute(fname) && !path_has_protocol(fname) && 854 !desc_file_path[0]) 855 { 856 error_setg(errp, "Cannot use relative extent paths with VMDK " 857 "descriptor file '%s'", bs->file->bs->filename); 858 return -EINVAL; 859 } 860 861 extent_path = g_malloc0(PATH_MAX); 862 path_combine(extent_path, PATH_MAX, desc_file_path, fname); 863 864 ret = snprintf(extent_opt_prefix, 32, "extents.%d", s->num_extents); 865 assert(ret < 32); 866 867 extent_file = bdrv_open_child(extent_path, options, extent_opt_prefix, 868 bs, &child_file, false, &local_err); 869 g_free(extent_path); 870 if (local_err) { 871 error_propagate(errp, local_err); 872 return -EINVAL; 873 } 874 875 /* save to extents array */ 876 if (!strcmp(type, "FLAT") || !strcmp(type, "VMFS")) { 877 /* FLAT extent */ 878 879 ret = vmdk_add_extent(bs, extent_file, true, sectors, 880 0, 0, 0, 0, 0, &extent, errp); 881 if (ret < 0) { 882 bdrv_unref_child(bs, extent_file); 883 return ret; 884 } 885 extent->flat_start_offset = flat_offset << 9; 886 } else if (!strcmp(type, "SPARSE") || !strcmp(type, "VMFSSPARSE")) { 887 /* SPARSE extent and VMFSSPARSE extent are both "COWD" sparse file*/ 888 char *buf = vmdk_read_desc(extent_file, 0, errp); 889 if (!buf) { 890 ret = -EINVAL; 891 } else { 892 ret = vmdk_open_sparse(bs, extent_file, bs->open_flags, buf, 893 options, errp); 894 } 895 g_free(buf); 896 if (ret) { 897 bdrv_unref_child(bs, extent_file); 898 return ret; 899 } 900 extent = &s->extents[s->num_extents - 1]; 901 } else { 902 error_setg(errp, "Unsupported extent type '%s'", type); 903 bdrv_unref_child(bs, extent_file); 904 return -ENOTSUP; 905 } 906 extent->type = g_strdup(type); 907 } 908 return 0; 909 910 invalid: 911 np = next_line(p); 912 assert(np != p); 913 if (np[-1] == '\n') { 914 np--; 915 } 916 error_setg(errp, "Invalid extent line: %.*s", (int)(np - p), p); 917 return -EINVAL; 918 } 919 920 static int vmdk_open_desc_file(BlockDriverState *bs, int flags, char *buf, 921 QDict *options, Error **errp) 922 { 923 int ret; 924 char ct[128]; 925 BDRVVmdkState *s = bs->opaque; 926 927 if (vmdk_parse_description(buf, "createType", ct, sizeof(ct))) { 928 error_setg(errp, "invalid VMDK image descriptor"); 929 ret = -EINVAL; 930 goto exit; 931 } 932 if (strcmp(ct, "monolithicFlat") && 933 strcmp(ct, "vmfs") && 934 strcmp(ct, "vmfsSparse") && 935 strcmp(ct, "twoGbMaxExtentSparse") && 936 strcmp(ct, "twoGbMaxExtentFlat")) { 937 error_setg(errp, "Unsupported image type '%s'", ct); 938 ret = -ENOTSUP; 939 goto exit; 940 } 941 s->create_type = g_strdup(ct); 942 s->desc_offset = 0; 943 ret = vmdk_parse_extents(buf, bs, bs->file->bs->exact_filename, options, 944 errp); 945 exit: 946 return ret; 947 } 948 949 static int vmdk_open(BlockDriverState *bs, QDict *options, int flags, 950 Error **errp) 951 { 952 char *buf; 953 int ret; 954 BDRVVmdkState *s = bs->opaque; 955 uint32_t magic; 956 Error *local_err = NULL; 957 958 bs->file = bdrv_open_child(NULL, options, "file", bs, &child_file, 959 false, errp); 960 if (!bs->file) { 961 return -EINVAL; 962 } 963 964 buf = vmdk_read_desc(bs->file, 0, errp); 965 if (!buf) { 966 return -EINVAL; 967 } 968 969 magic = ldl_be_p(buf); 970 switch (magic) { 971 case VMDK3_MAGIC: 972 case VMDK4_MAGIC: 973 ret = vmdk_open_sparse(bs, bs->file, flags, buf, options, 974 errp); 975 s->desc_offset = 0x200; 976 break; 977 default: 978 ret = vmdk_open_desc_file(bs, flags, buf, options, errp); 979 break; 980 } 981 if (ret) { 982 goto fail; 983 } 984 985 /* try to open parent images, if exist */ 986 ret = vmdk_parent_open(bs); 987 if (ret) { 988 goto fail; 989 } 990 ret = vmdk_read_cid(bs, 0, &s->cid); 991 if (ret) { 992 goto fail; 993 } 994 ret = vmdk_read_cid(bs, 1, &s->parent_cid); 995 if (ret) { 996 goto fail; 997 } 998 qemu_co_mutex_init(&s->lock); 999 1000 /* Disable migration when VMDK images are used */ 1001 error_setg(&s->migration_blocker, "The vmdk format used by node '%s' " 1002 "does not support live migration", 1003 bdrv_get_device_or_node_name(bs)); 1004 ret = migrate_add_blocker(s->migration_blocker, &local_err); 1005 if (local_err) { 1006 error_propagate(errp, local_err); 1007 error_free(s->migration_blocker); 1008 goto fail; 1009 } 1010 1011 g_free(buf); 1012 return 0; 1013 1014 fail: 1015 g_free(buf); 1016 g_free(s->create_type); 1017 s->create_type = NULL; 1018 vmdk_free_extents(bs); 1019 return ret; 1020 } 1021 1022 1023 static void vmdk_refresh_limits(BlockDriverState *bs, Error **errp) 1024 { 1025 BDRVVmdkState *s = bs->opaque; 1026 int i; 1027 1028 for (i = 0; i < s->num_extents; i++) { 1029 if (!s->extents[i].flat) { 1030 bs->bl.pwrite_zeroes_alignment = 1031 MAX(bs->bl.pwrite_zeroes_alignment, 1032 s->extents[i].cluster_sectors << BDRV_SECTOR_BITS); 1033 } 1034 } 1035 } 1036 1037 /** 1038 * get_whole_cluster 1039 * 1040 * Copy backing file's cluster that covers @sector_num, otherwise write zero, 1041 * to the cluster at @cluster_sector_num. 1042 * 1043 * If @skip_start_sector < @skip_end_sector, the relative range 1044 * [@skip_start_sector, @skip_end_sector) is not copied or written, and leave 1045 * it for call to write user data in the request. 1046 */ 1047 static int get_whole_cluster(BlockDriverState *bs, 1048 VmdkExtent *extent, 1049 uint64_t cluster_offset, 1050 uint64_t offset, 1051 uint64_t skip_start_bytes, 1052 uint64_t skip_end_bytes) 1053 { 1054 int ret = VMDK_OK; 1055 int64_t cluster_bytes; 1056 uint8_t *whole_grain; 1057 1058 /* For COW, align request sector_num to cluster start */ 1059 cluster_bytes = extent->cluster_sectors << BDRV_SECTOR_BITS; 1060 offset = QEMU_ALIGN_DOWN(offset, cluster_bytes); 1061 whole_grain = qemu_blockalign(bs, cluster_bytes); 1062 1063 if (!bs->backing) { 1064 memset(whole_grain, 0, skip_start_bytes); 1065 memset(whole_grain + skip_end_bytes, 0, cluster_bytes - skip_end_bytes); 1066 } 1067 1068 assert(skip_end_bytes <= cluster_bytes); 1069 /* we will be here if it's first write on non-exist grain(cluster). 1070 * try to read from parent image, if exist */ 1071 if (bs->backing && !vmdk_is_cid_valid(bs)) { 1072 ret = VMDK_ERROR; 1073 goto exit; 1074 } 1075 1076 /* Read backing data before skip range */ 1077 if (skip_start_bytes > 0) { 1078 if (bs->backing) { 1079 /* qcow2 emits this on bs->file instead of bs->backing */ 1080 BLKDBG_EVENT(extent->file, BLKDBG_COW_READ); 1081 ret = bdrv_pread(bs->backing, offset, whole_grain, 1082 skip_start_bytes); 1083 if (ret < 0) { 1084 ret = VMDK_ERROR; 1085 goto exit; 1086 } 1087 } 1088 BLKDBG_EVENT(extent->file, BLKDBG_COW_WRITE); 1089 ret = bdrv_pwrite(extent->file, cluster_offset, whole_grain, 1090 skip_start_bytes); 1091 if (ret < 0) { 1092 ret = VMDK_ERROR; 1093 goto exit; 1094 } 1095 } 1096 /* Read backing data after skip range */ 1097 if (skip_end_bytes < cluster_bytes) { 1098 if (bs->backing) { 1099 /* qcow2 emits this on bs->file instead of bs->backing */ 1100 BLKDBG_EVENT(extent->file, BLKDBG_COW_READ); 1101 ret = bdrv_pread(bs->backing, offset + skip_end_bytes, 1102 whole_grain + skip_end_bytes, 1103 cluster_bytes - skip_end_bytes); 1104 if (ret < 0) { 1105 ret = VMDK_ERROR; 1106 goto exit; 1107 } 1108 } 1109 BLKDBG_EVENT(extent->file, BLKDBG_COW_WRITE); 1110 ret = bdrv_pwrite(extent->file, cluster_offset + skip_end_bytes, 1111 whole_grain + skip_end_bytes, 1112 cluster_bytes - skip_end_bytes); 1113 if (ret < 0) { 1114 ret = VMDK_ERROR; 1115 goto exit; 1116 } 1117 } 1118 1119 ret = VMDK_OK; 1120 exit: 1121 qemu_vfree(whole_grain); 1122 return ret; 1123 } 1124 1125 static int vmdk_L2update(VmdkExtent *extent, VmdkMetaData *m_data, 1126 uint32_t offset) 1127 { 1128 offset = cpu_to_le32(offset); 1129 /* update L2 table */ 1130 BLKDBG_EVENT(extent->file, BLKDBG_L2_UPDATE); 1131 if (bdrv_pwrite_sync(extent->file, 1132 ((int64_t)m_data->l2_offset * 512) 1133 + (m_data->l2_index * sizeof(offset)), 1134 &offset, sizeof(offset)) < 0) { 1135 return VMDK_ERROR; 1136 } 1137 /* update backup L2 table */ 1138 if (extent->l1_backup_table_offset != 0) { 1139 m_data->l2_offset = extent->l1_backup_table[m_data->l1_index]; 1140 if (bdrv_pwrite_sync(extent->file, 1141 ((int64_t)m_data->l2_offset * 512) 1142 + (m_data->l2_index * sizeof(offset)), 1143 &offset, sizeof(offset)) < 0) { 1144 return VMDK_ERROR; 1145 } 1146 } 1147 if (m_data->l2_cache_entry) { 1148 *m_data->l2_cache_entry = offset; 1149 } 1150 1151 return VMDK_OK; 1152 } 1153 1154 /** 1155 * get_cluster_offset 1156 * 1157 * Look up cluster offset in extent file by sector number, and store in 1158 * @cluster_offset. 1159 * 1160 * For flat extents, the start offset as parsed from the description file is 1161 * returned. 1162 * 1163 * For sparse extents, look up in L1, L2 table. If allocate is true, return an 1164 * offset for a new cluster and update L2 cache. If there is a backing file, 1165 * COW is done before returning; otherwise, zeroes are written to the allocated 1166 * cluster. Both COW and zero writing skips the sector range 1167 * [@skip_start_sector, @skip_end_sector) passed in by caller, because caller 1168 * has new data to write there. 1169 * 1170 * Returns: VMDK_OK if cluster exists and mapped in the image. 1171 * VMDK_UNALLOC if cluster is not mapped and @allocate is false. 1172 * VMDK_ERROR if failed. 1173 */ 1174 static int get_cluster_offset(BlockDriverState *bs, 1175 VmdkExtent *extent, 1176 VmdkMetaData *m_data, 1177 uint64_t offset, 1178 bool allocate, 1179 uint64_t *cluster_offset, 1180 uint64_t skip_start_bytes, 1181 uint64_t skip_end_bytes) 1182 { 1183 unsigned int l1_index, l2_offset, l2_index; 1184 int min_index, i, j; 1185 uint32_t min_count, *l2_table; 1186 bool zeroed = false; 1187 int64_t ret; 1188 int64_t cluster_sector; 1189 1190 if (m_data) { 1191 m_data->valid = 0; 1192 } 1193 if (extent->flat) { 1194 *cluster_offset = extent->flat_start_offset; 1195 return VMDK_OK; 1196 } 1197 1198 offset -= (extent->end_sector - extent->sectors) * SECTOR_SIZE; 1199 l1_index = (offset >> 9) / extent->l1_entry_sectors; 1200 if (l1_index >= extent->l1_size) { 1201 return VMDK_ERROR; 1202 } 1203 l2_offset = extent->l1_table[l1_index]; 1204 if (!l2_offset) { 1205 return VMDK_UNALLOC; 1206 } 1207 for (i = 0; i < L2_CACHE_SIZE; i++) { 1208 if (l2_offset == extent->l2_cache_offsets[i]) { 1209 /* increment the hit count */ 1210 if (++extent->l2_cache_counts[i] == 0xffffffff) { 1211 for (j = 0; j < L2_CACHE_SIZE; j++) { 1212 extent->l2_cache_counts[j] >>= 1; 1213 } 1214 } 1215 l2_table = extent->l2_cache + (i * extent->l2_size); 1216 goto found; 1217 } 1218 } 1219 /* not found: load a new entry in the least used one */ 1220 min_index = 0; 1221 min_count = 0xffffffff; 1222 for (i = 0; i < L2_CACHE_SIZE; i++) { 1223 if (extent->l2_cache_counts[i] < min_count) { 1224 min_count = extent->l2_cache_counts[i]; 1225 min_index = i; 1226 } 1227 } 1228 l2_table = extent->l2_cache + (min_index * extent->l2_size); 1229 BLKDBG_EVENT(extent->file, BLKDBG_L2_LOAD); 1230 if (bdrv_pread(extent->file, 1231 (int64_t)l2_offset * 512, 1232 l2_table, 1233 extent->l2_size * sizeof(uint32_t) 1234 ) != extent->l2_size * sizeof(uint32_t)) { 1235 return VMDK_ERROR; 1236 } 1237 1238 extent->l2_cache_offsets[min_index] = l2_offset; 1239 extent->l2_cache_counts[min_index] = 1; 1240 found: 1241 l2_index = ((offset >> 9) / extent->cluster_sectors) % extent->l2_size; 1242 cluster_sector = le32_to_cpu(l2_table[l2_index]); 1243 1244 if (extent->has_zero_grain && cluster_sector == VMDK_GTE_ZEROED) { 1245 zeroed = true; 1246 } 1247 1248 if (!cluster_sector || zeroed) { 1249 if (!allocate) { 1250 return zeroed ? VMDK_ZEROED : VMDK_UNALLOC; 1251 } 1252 1253 cluster_sector = extent->next_cluster_sector; 1254 extent->next_cluster_sector += extent->cluster_sectors; 1255 1256 /* First of all we write grain itself, to avoid race condition 1257 * that may to corrupt the image. 1258 * This problem may occur because of insufficient space on host disk 1259 * or inappropriate VM shutdown. 1260 */ 1261 ret = get_whole_cluster(bs, extent, cluster_sector * BDRV_SECTOR_SIZE, 1262 offset, skip_start_bytes, skip_end_bytes); 1263 if (ret) { 1264 return ret; 1265 } 1266 if (m_data) { 1267 m_data->valid = 1; 1268 m_data->l1_index = l1_index; 1269 m_data->l2_index = l2_index; 1270 m_data->l2_offset = l2_offset; 1271 m_data->l2_cache_entry = &l2_table[l2_index]; 1272 } 1273 } 1274 *cluster_offset = cluster_sector << BDRV_SECTOR_BITS; 1275 return VMDK_OK; 1276 } 1277 1278 static VmdkExtent *find_extent(BDRVVmdkState *s, 1279 int64_t sector_num, VmdkExtent *start_hint) 1280 { 1281 VmdkExtent *extent = start_hint; 1282 1283 if (!extent) { 1284 extent = &s->extents[0]; 1285 } 1286 while (extent < &s->extents[s->num_extents]) { 1287 if (sector_num < extent->end_sector) { 1288 return extent; 1289 } 1290 extent++; 1291 } 1292 return NULL; 1293 } 1294 1295 static inline uint64_t vmdk_find_offset_in_cluster(VmdkExtent *extent, 1296 int64_t offset) 1297 { 1298 uint64_t extent_begin_offset, extent_relative_offset; 1299 uint64_t cluster_size = extent->cluster_sectors * BDRV_SECTOR_SIZE; 1300 1301 extent_begin_offset = 1302 (extent->end_sector - extent->sectors) * BDRV_SECTOR_SIZE; 1303 extent_relative_offset = offset - extent_begin_offset; 1304 return extent_relative_offset % cluster_size; 1305 } 1306 1307 static int coroutine_fn vmdk_co_block_status(BlockDriverState *bs, 1308 bool want_zero, 1309 int64_t offset, int64_t bytes, 1310 int64_t *pnum, int64_t *map, 1311 BlockDriverState **file) 1312 { 1313 BDRVVmdkState *s = bs->opaque; 1314 int64_t index_in_cluster, n, ret; 1315 uint64_t cluster_offset; 1316 VmdkExtent *extent; 1317 1318 extent = find_extent(s, offset >> BDRV_SECTOR_BITS, NULL); 1319 if (!extent) { 1320 return -EIO; 1321 } 1322 qemu_co_mutex_lock(&s->lock); 1323 ret = get_cluster_offset(bs, extent, NULL, offset, false, &cluster_offset, 1324 0, 0); 1325 qemu_co_mutex_unlock(&s->lock); 1326 1327 index_in_cluster = vmdk_find_offset_in_cluster(extent, offset); 1328 switch (ret) { 1329 case VMDK_ERROR: 1330 ret = -EIO; 1331 break; 1332 case VMDK_UNALLOC: 1333 ret = 0; 1334 break; 1335 case VMDK_ZEROED: 1336 ret = BDRV_BLOCK_ZERO; 1337 break; 1338 case VMDK_OK: 1339 ret = BDRV_BLOCK_DATA; 1340 if (!extent->compressed) { 1341 ret |= BDRV_BLOCK_OFFSET_VALID; 1342 *map = cluster_offset + index_in_cluster; 1343 } 1344 *file = extent->file->bs; 1345 break; 1346 } 1347 1348 n = extent->cluster_sectors * BDRV_SECTOR_SIZE - index_in_cluster; 1349 *pnum = MIN(n, bytes); 1350 return ret; 1351 } 1352 1353 static int vmdk_write_extent(VmdkExtent *extent, int64_t cluster_offset, 1354 int64_t offset_in_cluster, QEMUIOVector *qiov, 1355 uint64_t qiov_offset, uint64_t n_bytes, 1356 uint64_t offset) 1357 { 1358 int ret; 1359 VmdkGrainMarker *data = NULL; 1360 uLongf buf_len; 1361 QEMUIOVector local_qiov; 1362 struct iovec iov; 1363 int64_t write_offset; 1364 int64_t write_end_sector; 1365 1366 if (extent->compressed) { 1367 void *compressed_data; 1368 1369 if (!extent->has_marker) { 1370 ret = -EINVAL; 1371 goto out; 1372 } 1373 buf_len = (extent->cluster_sectors << 9) * 2; 1374 data = g_malloc(buf_len + sizeof(VmdkGrainMarker)); 1375 1376 compressed_data = g_malloc(n_bytes); 1377 qemu_iovec_to_buf(qiov, qiov_offset, compressed_data, n_bytes); 1378 ret = compress(data->data, &buf_len, compressed_data, n_bytes); 1379 g_free(compressed_data); 1380 1381 if (ret != Z_OK || buf_len == 0) { 1382 ret = -EINVAL; 1383 goto out; 1384 } 1385 1386 data->lba = cpu_to_le64(offset >> BDRV_SECTOR_BITS); 1387 data->size = cpu_to_le32(buf_len); 1388 1389 n_bytes = buf_len + sizeof(VmdkGrainMarker); 1390 iov = (struct iovec) { 1391 .iov_base = data, 1392 .iov_len = n_bytes, 1393 }; 1394 qemu_iovec_init_external(&local_qiov, &iov, 1); 1395 1396 BLKDBG_EVENT(extent->file, BLKDBG_WRITE_COMPRESSED); 1397 } else { 1398 qemu_iovec_init(&local_qiov, qiov->niov); 1399 qemu_iovec_concat(&local_qiov, qiov, qiov_offset, n_bytes); 1400 1401 BLKDBG_EVENT(extent->file, BLKDBG_WRITE_AIO); 1402 } 1403 1404 write_offset = cluster_offset + offset_in_cluster; 1405 ret = bdrv_co_pwritev(extent->file, write_offset, n_bytes, 1406 &local_qiov, 0); 1407 1408 write_end_sector = DIV_ROUND_UP(write_offset + n_bytes, BDRV_SECTOR_SIZE); 1409 1410 if (extent->compressed) { 1411 extent->next_cluster_sector = write_end_sector; 1412 } else { 1413 extent->next_cluster_sector = MAX(extent->next_cluster_sector, 1414 write_end_sector); 1415 } 1416 1417 if (ret < 0) { 1418 goto out; 1419 } 1420 ret = 0; 1421 out: 1422 g_free(data); 1423 if (!extent->compressed) { 1424 qemu_iovec_destroy(&local_qiov); 1425 } 1426 return ret; 1427 } 1428 1429 static int vmdk_read_extent(VmdkExtent *extent, int64_t cluster_offset, 1430 int64_t offset_in_cluster, QEMUIOVector *qiov, 1431 int bytes) 1432 { 1433 int ret; 1434 int cluster_bytes, buf_bytes; 1435 uint8_t *cluster_buf, *compressed_data; 1436 uint8_t *uncomp_buf; 1437 uint32_t data_len; 1438 VmdkGrainMarker *marker; 1439 uLongf buf_len; 1440 1441 1442 if (!extent->compressed) { 1443 BLKDBG_EVENT(extent->file, BLKDBG_READ_AIO); 1444 ret = bdrv_co_preadv(extent->file, 1445 cluster_offset + offset_in_cluster, bytes, 1446 qiov, 0); 1447 if (ret < 0) { 1448 return ret; 1449 } 1450 return 0; 1451 } 1452 cluster_bytes = extent->cluster_sectors * 512; 1453 /* Read two clusters in case GrainMarker + compressed data > one cluster */ 1454 buf_bytes = cluster_bytes * 2; 1455 cluster_buf = g_malloc(buf_bytes); 1456 uncomp_buf = g_malloc(cluster_bytes); 1457 BLKDBG_EVENT(extent->file, BLKDBG_READ_COMPRESSED); 1458 ret = bdrv_pread(extent->file, 1459 cluster_offset, 1460 cluster_buf, buf_bytes); 1461 if (ret < 0) { 1462 goto out; 1463 } 1464 compressed_data = cluster_buf; 1465 buf_len = cluster_bytes; 1466 data_len = cluster_bytes; 1467 if (extent->has_marker) { 1468 marker = (VmdkGrainMarker *)cluster_buf; 1469 compressed_data = marker->data; 1470 data_len = le32_to_cpu(marker->size); 1471 } 1472 if (!data_len || data_len > buf_bytes) { 1473 ret = -EINVAL; 1474 goto out; 1475 } 1476 ret = uncompress(uncomp_buf, &buf_len, compressed_data, data_len); 1477 if (ret != Z_OK) { 1478 ret = -EINVAL; 1479 goto out; 1480 1481 } 1482 if (offset_in_cluster < 0 || 1483 offset_in_cluster + bytes > buf_len) { 1484 ret = -EINVAL; 1485 goto out; 1486 } 1487 qemu_iovec_from_buf(qiov, 0, uncomp_buf + offset_in_cluster, bytes); 1488 ret = 0; 1489 1490 out: 1491 g_free(uncomp_buf); 1492 g_free(cluster_buf); 1493 return ret; 1494 } 1495 1496 static int coroutine_fn 1497 vmdk_co_preadv(BlockDriverState *bs, uint64_t offset, uint64_t bytes, 1498 QEMUIOVector *qiov, int flags) 1499 { 1500 BDRVVmdkState *s = bs->opaque; 1501 int ret; 1502 uint64_t n_bytes, offset_in_cluster; 1503 VmdkExtent *extent = NULL; 1504 QEMUIOVector local_qiov; 1505 uint64_t cluster_offset; 1506 uint64_t bytes_done = 0; 1507 1508 qemu_iovec_init(&local_qiov, qiov->niov); 1509 qemu_co_mutex_lock(&s->lock); 1510 1511 while (bytes > 0) { 1512 extent = find_extent(s, offset >> BDRV_SECTOR_BITS, extent); 1513 if (!extent) { 1514 ret = -EIO; 1515 goto fail; 1516 } 1517 ret = get_cluster_offset(bs, extent, NULL, 1518 offset, false, &cluster_offset, 0, 0); 1519 offset_in_cluster = vmdk_find_offset_in_cluster(extent, offset); 1520 1521 n_bytes = MIN(bytes, extent->cluster_sectors * BDRV_SECTOR_SIZE 1522 - offset_in_cluster); 1523 1524 if (ret != VMDK_OK) { 1525 /* if not allocated, try to read from parent image, if exist */ 1526 if (bs->backing && ret != VMDK_ZEROED) { 1527 if (!vmdk_is_cid_valid(bs)) { 1528 ret = -EINVAL; 1529 goto fail; 1530 } 1531 1532 qemu_iovec_reset(&local_qiov); 1533 qemu_iovec_concat(&local_qiov, qiov, bytes_done, n_bytes); 1534 1535 /* qcow2 emits this on bs->file instead of bs->backing */ 1536 BLKDBG_EVENT(bs->file, BLKDBG_READ_BACKING_AIO); 1537 ret = bdrv_co_preadv(bs->backing, offset, n_bytes, 1538 &local_qiov, 0); 1539 if (ret < 0) { 1540 goto fail; 1541 } 1542 } else { 1543 qemu_iovec_memset(qiov, bytes_done, 0, n_bytes); 1544 } 1545 } else { 1546 qemu_iovec_reset(&local_qiov); 1547 qemu_iovec_concat(&local_qiov, qiov, bytes_done, n_bytes); 1548 1549 ret = vmdk_read_extent(extent, cluster_offset, offset_in_cluster, 1550 &local_qiov, n_bytes); 1551 if (ret) { 1552 goto fail; 1553 } 1554 } 1555 bytes -= n_bytes; 1556 offset += n_bytes; 1557 bytes_done += n_bytes; 1558 } 1559 1560 ret = 0; 1561 fail: 1562 qemu_co_mutex_unlock(&s->lock); 1563 qemu_iovec_destroy(&local_qiov); 1564 1565 return ret; 1566 } 1567 1568 /** 1569 * vmdk_write: 1570 * @zeroed: buf is ignored (data is zero), use zeroed_grain GTE feature 1571 * if possible, otherwise return -ENOTSUP. 1572 * @zero_dry_run: used for zeroed == true only, don't update L2 table, just try 1573 * with each cluster. By dry run we can find if the zero write 1574 * is possible without modifying image data. 1575 * 1576 * Returns: error code with 0 for success. 1577 */ 1578 static int vmdk_pwritev(BlockDriverState *bs, uint64_t offset, 1579 uint64_t bytes, QEMUIOVector *qiov, 1580 bool zeroed, bool zero_dry_run) 1581 { 1582 BDRVVmdkState *s = bs->opaque; 1583 VmdkExtent *extent = NULL; 1584 int ret; 1585 int64_t offset_in_cluster, n_bytes; 1586 uint64_t cluster_offset; 1587 uint64_t bytes_done = 0; 1588 VmdkMetaData m_data; 1589 1590 if (DIV_ROUND_UP(offset, BDRV_SECTOR_SIZE) > bs->total_sectors) { 1591 error_report("Wrong offset: offset=0x%" PRIx64 1592 " total_sectors=0x%" PRIx64, 1593 offset, bs->total_sectors); 1594 return -EIO; 1595 } 1596 1597 while (bytes > 0) { 1598 extent = find_extent(s, offset >> BDRV_SECTOR_BITS, extent); 1599 if (!extent) { 1600 return -EIO; 1601 } 1602 offset_in_cluster = vmdk_find_offset_in_cluster(extent, offset); 1603 n_bytes = MIN(bytes, extent->cluster_sectors * BDRV_SECTOR_SIZE 1604 - offset_in_cluster); 1605 1606 ret = get_cluster_offset(bs, extent, &m_data, offset, 1607 !(extent->compressed || zeroed), 1608 &cluster_offset, offset_in_cluster, 1609 offset_in_cluster + n_bytes); 1610 if (extent->compressed) { 1611 if (ret == VMDK_OK) { 1612 /* Refuse write to allocated cluster for streamOptimized */ 1613 error_report("Could not write to allocated cluster" 1614 " for streamOptimized"); 1615 return -EIO; 1616 } else { 1617 /* allocate */ 1618 ret = get_cluster_offset(bs, extent, &m_data, offset, 1619 true, &cluster_offset, 0, 0); 1620 } 1621 } 1622 if (ret == VMDK_ERROR) { 1623 return -EINVAL; 1624 } 1625 if (zeroed) { 1626 /* Do zeroed write, buf is ignored */ 1627 if (extent->has_zero_grain && 1628 offset_in_cluster == 0 && 1629 n_bytes >= extent->cluster_sectors * BDRV_SECTOR_SIZE) { 1630 n_bytes = extent->cluster_sectors * BDRV_SECTOR_SIZE; 1631 if (!zero_dry_run) { 1632 /* update L2 tables */ 1633 if (vmdk_L2update(extent, &m_data, VMDK_GTE_ZEROED) 1634 != VMDK_OK) { 1635 return -EIO; 1636 } 1637 } 1638 } else { 1639 return -ENOTSUP; 1640 } 1641 } else { 1642 ret = vmdk_write_extent(extent, cluster_offset, offset_in_cluster, 1643 qiov, bytes_done, n_bytes, offset); 1644 if (ret) { 1645 return ret; 1646 } 1647 if (m_data.valid) { 1648 /* update L2 tables */ 1649 if (vmdk_L2update(extent, &m_data, 1650 cluster_offset >> BDRV_SECTOR_BITS) 1651 != VMDK_OK) { 1652 return -EIO; 1653 } 1654 } 1655 } 1656 bytes -= n_bytes; 1657 offset += n_bytes; 1658 bytes_done += n_bytes; 1659 1660 /* update CID on the first write every time the virtual disk is 1661 * opened */ 1662 if (!s->cid_updated) { 1663 ret = vmdk_write_cid(bs, g_random_int()); 1664 if (ret < 0) { 1665 return ret; 1666 } 1667 s->cid_updated = true; 1668 } 1669 } 1670 return 0; 1671 } 1672 1673 static int coroutine_fn 1674 vmdk_co_pwritev(BlockDriverState *bs, uint64_t offset, uint64_t bytes, 1675 QEMUIOVector *qiov, int flags) 1676 { 1677 int ret; 1678 BDRVVmdkState *s = bs->opaque; 1679 qemu_co_mutex_lock(&s->lock); 1680 ret = vmdk_pwritev(bs, offset, bytes, qiov, false, false); 1681 qemu_co_mutex_unlock(&s->lock); 1682 return ret; 1683 } 1684 1685 static int coroutine_fn 1686 vmdk_co_pwritev_compressed(BlockDriverState *bs, uint64_t offset, 1687 uint64_t bytes, QEMUIOVector *qiov) 1688 { 1689 return vmdk_co_pwritev(bs, offset, bytes, qiov, 0); 1690 } 1691 1692 static int coroutine_fn vmdk_co_pwrite_zeroes(BlockDriverState *bs, 1693 int64_t offset, 1694 int bytes, 1695 BdrvRequestFlags flags) 1696 { 1697 int ret; 1698 BDRVVmdkState *s = bs->opaque; 1699 1700 qemu_co_mutex_lock(&s->lock); 1701 /* write zeroes could fail if sectors not aligned to cluster, test it with 1702 * dry_run == true before really updating image */ 1703 ret = vmdk_pwritev(bs, offset, bytes, NULL, true, true); 1704 if (!ret) { 1705 ret = vmdk_pwritev(bs, offset, bytes, NULL, true, false); 1706 } 1707 qemu_co_mutex_unlock(&s->lock); 1708 return ret; 1709 } 1710 1711 static int vmdk_create_extent(const char *filename, int64_t filesize, 1712 bool flat, bool compress, bool zeroed_grain, 1713 QemuOpts *opts, Error **errp) 1714 { 1715 int ret, i; 1716 BlockBackend *blk = NULL; 1717 VMDK4Header header; 1718 Error *local_err = NULL; 1719 uint32_t tmp, magic, grains, gd_sectors, gt_size, gt_count; 1720 uint32_t *gd_buf = NULL; 1721 int gd_buf_size; 1722 1723 ret = bdrv_create_file(filename, opts, &local_err); 1724 if (ret < 0) { 1725 error_propagate(errp, local_err); 1726 goto exit; 1727 } 1728 1729 blk = blk_new_open(filename, NULL, NULL, 1730 BDRV_O_RDWR | BDRV_O_RESIZE | BDRV_O_PROTOCOL, 1731 &local_err); 1732 if (blk == NULL) { 1733 error_propagate(errp, local_err); 1734 ret = -EIO; 1735 goto exit; 1736 } 1737 1738 blk_set_allow_write_beyond_eof(blk, true); 1739 1740 if (flat) { 1741 ret = blk_truncate(blk, filesize, PREALLOC_MODE_OFF, errp); 1742 goto exit; 1743 } 1744 magic = cpu_to_be32(VMDK4_MAGIC); 1745 memset(&header, 0, sizeof(header)); 1746 if (compress) { 1747 header.version = 3; 1748 } else if (zeroed_grain) { 1749 header.version = 2; 1750 } else { 1751 header.version = 1; 1752 } 1753 header.flags = VMDK4_FLAG_RGD | VMDK4_FLAG_NL_DETECT 1754 | (compress ? VMDK4_FLAG_COMPRESS | VMDK4_FLAG_MARKER : 0) 1755 | (zeroed_grain ? VMDK4_FLAG_ZERO_GRAIN : 0); 1756 header.compressAlgorithm = compress ? VMDK4_COMPRESSION_DEFLATE : 0; 1757 header.capacity = filesize / BDRV_SECTOR_SIZE; 1758 header.granularity = 128; 1759 header.num_gtes_per_gt = BDRV_SECTOR_SIZE; 1760 1761 grains = DIV_ROUND_UP(filesize / BDRV_SECTOR_SIZE, header.granularity); 1762 gt_size = DIV_ROUND_UP(header.num_gtes_per_gt * sizeof(uint32_t), 1763 BDRV_SECTOR_SIZE); 1764 gt_count = DIV_ROUND_UP(grains, header.num_gtes_per_gt); 1765 gd_sectors = DIV_ROUND_UP(gt_count * sizeof(uint32_t), BDRV_SECTOR_SIZE); 1766 1767 header.desc_offset = 1; 1768 header.desc_size = 20; 1769 header.rgd_offset = header.desc_offset + header.desc_size; 1770 header.gd_offset = header.rgd_offset + gd_sectors + (gt_size * gt_count); 1771 header.grain_offset = 1772 ROUND_UP(header.gd_offset + gd_sectors + (gt_size * gt_count), 1773 header.granularity); 1774 /* swap endianness for all header fields */ 1775 header.version = cpu_to_le32(header.version); 1776 header.flags = cpu_to_le32(header.flags); 1777 header.capacity = cpu_to_le64(header.capacity); 1778 header.granularity = cpu_to_le64(header.granularity); 1779 header.num_gtes_per_gt = cpu_to_le32(header.num_gtes_per_gt); 1780 header.desc_offset = cpu_to_le64(header.desc_offset); 1781 header.desc_size = cpu_to_le64(header.desc_size); 1782 header.rgd_offset = cpu_to_le64(header.rgd_offset); 1783 header.gd_offset = cpu_to_le64(header.gd_offset); 1784 header.grain_offset = cpu_to_le64(header.grain_offset); 1785 header.compressAlgorithm = cpu_to_le16(header.compressAlgorithm); 1786 1787 header.check_bytes[0] = 0xa; 1788 header.check_bytes[1] = 0x20; 1789 header.check_bytes[2] = 0xd; 1790 header.check_bytes[3] = 0xa; 1791 1792 /* write all the data */ 1793 ret = blk_pwrite(blk, 0, &magic, sizeof(magic), 0); 1794 if (ret < 0) { 1795 error_setg(errp, QERR_IO_ERROR); 1796 goto exit; 1797 } 1798 ret = blk_pwrite(blk, sizeof(magic), &header, sizeof(header), 0); 1799 if (ret < 0) { 1800 error_setg(errp, QERR_IO_ERROR); 1801 goto exit; 1802 } 1803 1804 ret = blk_truncate(blk, le64_to_cpu(header.grain_offset) << 9, 1805 PREALLOC_MODE_OFF, errp); 1806 if (ret < 0) { 1807 goto exit; 1808 } 1809 1810 /* write grain directory */ 1811 gd_buf_size = gd_sectors * BDRV_SECTOR_SIZE; 1812 gd_buf = g_malloc0(gd_buf_size); 1813 for (i = 0, tmp = le64_to_cpu(header.rgd_offset) + gd_sectors; 1814 i < gt_count; i++, tmp += gt_size) { 1815 gd_buf[i] = cpu_to_le32(tmp); 1816 } 1817 ret = blk_pwrite(blk, le64_to_cpu(header.rgd_offset) * BDRV_SECTOR_SIZE, 1818 gd_buf, gd_buf_size, 0); 1819 if (ret < 0) { 1820 error_setg(errp, QERR_IO_ERROR); 1821 goto exit; 1822 } 1823 1824 /* write backup grain directory */ 1825 for (i = 0, tmp = le64_to_cpu(header.gd_offset) + gd_sectors; 1826 i < gt_count; i++, tmp += gt_size) { 1827 gd_buf[i] = cpu_to_le32(tmp); 1828 } 1829 ret = blk_pwrite(blk, le64_to_cpu(header.gd_offset) * BDRV_SECTOR_SIZE, 1830 gd_buf, gd_buf_size, 0); 1831 if (ret < 0) { 1832 error_setg(errp, QERR_IO_ERROR); 1833 goto exit; 1834 } 1835 1836 ret = 0; 1837 exit: 1838 if (blk) { 1839 blk_unref(blk); 1840 } 1841 g_free(gd_buf); 1842 return ret; 1843 } 1844 1845 static int filename_decompose(const char *filename, char *path, char *prefix, 1846 char *postfix, size_t buf_len, Error **errp) 1847 { 1848 const char *p, *q; 1849 1850 if (filename == NULL || !strlen(filename)) { 1851 error_setg(errp, "No filename provided"); 1852 return VMDK_ERROR; 1853 } 1854 p = strrchr(filename, '/'); 1855 if (p == NULL) { 1856 p = strrchr(filename, '\\'); 1857 } 1858 if (p == NULL) { 1859 p = strrchr(filename, ':'); 1860 } 1861 if (p != NULL) { 1862 p++; 1863 if (p - filename >= buf_len) { 1864 return VMDK_ERROR; 1865 } 1866 pstrcpy(path, p - filename + 1, filename); 1867 } else { 1868 p = filename; 1869 path[0] = '\0'; 1870 } 1871 q = strrchr(p, '.'); 1872 if (q == NULL) { 1873 pstrcpy(prefix, buf_len, p); 1874 postfix[0] = '\0'; 1875 } else { 1876 if (q - p >= buf_len) { 1877 return VMDK_ERROR; 1878 } 1879 pstrcpy(prefix, q - p + 1, p); 1880 pstrcpy(postfix, buf_len, q); 1881 } 1882 return VMDK_OK; 1883 } 1884 1885 static int coroutine_fn vmdk_co_create_opts(const char *filename, QemuOpts *opts, 1886 Error **errp) 1887 { 1888 int idx = 0; 1889 BlockBackend *new_blk = NULL; 1890 Error *local_err = NULL; 1891 char *desc = NULL; 1892 int64_t total_size = 0, filesize; 1893 char *adapter_type = NULL; 1894 char *backing_file = NULL; 1895 char *hw_version = NULL; 1896 char *fmt = NULL; 1897 int ret = 0; 1898 bool flat, split, compress; 1899 GString *ext_desc_lines; 1900 char *path = g_malloc0(PATH_MAX); 1901 char *prefix = g_malloc0(PATH_MAX); 1902 char *postfix = g_malloc0(PATH_MAX); 1903 char *desc_line = g_malloc0(BUF_SIZE); 1904 char *ext_filename = g_malloc0(PATH_MAX); 1905 char *desc_filename = g_malloc0(PATH_MAX); 1906 const int64_t split_size = 0x80000000; /* VMDK has constant split size */ 1907 const char *desc_extent_line; 1908 char *parent_desc_line = g_malloc0(BUF_SIZE); 1909 uint32_t parent_cid = 0xffffffff; 1910 uint32_t number_heads = 16; 1911 bool zeroed_grain = false; 1912 uint32_t desc_offset = 0, desc_len; 1913 const char desc_template[] = 1914 "# Disk DescriptorFile\n" 1915 "version=1\n" 1916 "CID=%" PRIx32 "\n" 1917 "parentCID=%" PRIx32 "\n" 1918 "createType=\"%s\"\n" 1919 "%s" 1920 "\n" 1921 "# Extent description\n" 1922 "%s" 1923 "\n" 1924 "# The Disk Data Base\n" 1925 "#DDB\n" 1926 "\n" 1927 "ddb.virtualHWVersion = \"%s\"\n" 1928 "ddb.geometry.cylinders = \"%" PRId64 "\"\n" 1929 "ddb.geometry.heads = \"%" PRIu32 "\"\n" 1930 "ddb.geometry.sectors = \"63\"\n" 1931 "ddb.adapterType = \"%s\"\n"; 1932 1933 ext_desc_lines = g_string_new(NULL); 1934 1935 if (filename_decompose(filename, path, prefix, postfix, PATH_MAX, errp)) { 1936 ret = -EINVAL; 1937 goto exit; 1938 } 1939 /* Read out options */ 1940 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0), 1941 BDRV_SECTOR_SIZE); 1942 adapter_type = qemu_opt_get_del(opts, BLOCK_OPT_ADAPTER_TYPE); 1943 backing_file = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FILE); 1944 hw_version = qemu_opt_get_del(opts, BLOCK_OPT_HWVERSION); 1945 if (qemu_opt_get_bool_del(opts, BLOCK_OPT_COMPAT6, false)) { 1946 if (strcmp(hw_version, "undefined")) { 1947 error_setg(errp, 1948 "compat6 cannot be enabled with hwversion set"); 1949 ret = -EINVAL; 1950 goto exit; 1951 } 1952 g_free(hw_version); 1953 hw_version = g_strdup("6"); 1954 } 1955 if (strcmp(hw_version, "undefined") == 0) { 1956 g_free(hw_version); 1957 hw_version = g_strdup("4"); 1958 } 1959 fmt = qemu_opt_get_del(opts, BLOCK_OPT_SUBFMT); 1960 if (qemu_opt_get_bool_del(opts, BLOCK_OPT_ZEROED_GRAIN, false)) { 1961 zeroed_grain = true; 1962 } 1963 1964 if (!adapter_type) { 1965 adapter_type = g_strdup("ide"); 1966 } else if (strcmp(adapter_type, "ide") && 1967 strcmp(adapter_type, "buslogic") && 1968 strcmp(adapter_type, "lsilogic") && 1969 strcmp(adapter_type, "legacyESX")) { 1970 error_setg(errp, "Unknown adapter type: '%s'", adapter_type); 1971 ret = -EINVAL; 1972 goto exit; 1973 } 1974 if (strcmp(adapter_type, "ide") != 0) { 1975 /* that's the number of heads with which vmware operates when 1976 creating, exporting, etc. vmdk files with a non-ide adapter type */ 1977 number_heads = 255; 1978 } 1979 if (!fmt) { 1980 /* Default format to monolithicSparse */ 1981 fmt = g_strdup("monolithicSparse"); 1982 } else if (strcmp(fmt, "monolithicFlat") && 1983 strcmp(fmt, "monolithicSparse") && 1984 strcmp(fmt, "twoGbMaxExtentSparse") && 1985 strcmp(fmt, "twoGbMaxExtentFlat") && 1986 strcmp(fmt, "streamOptimized")) { 1987 error_setg(errp, "Unknown subformat: '%s'", fmt); 1988 ret = -EINVAL; 1989 goto exit; 1990 } 1991 split = !(strcmp(fmt, "twoGbMaxExtentFlat") && 1992 strcmp(fmt, "twoGbMaxExtentSparse")); 1993 flat = !(strcmp(fmt, "monolithicFlat") && 1994 strcmp(fmt, "twoGbMaxExtentFlat")); 1995 compress = !strcmp(fmt, "streamOptimized"); 1996 if (flat) { 1997 desc_extent_line = "RW %" PRId64 " FLAT \"%s\" 0\n"; 1998 } else { 1999 desc_extent_line = "RW %" PRId64 " SPARSE \"%s\"\n"; 2000 } 2001 if (flat && backing_file) { 2002 error_setg(errp, "Flat image can't have backing file"); 2003 ret = -ENOTSUP; 2004 goto exit; 2005 } 2006 if (flat && zeroed_grain) { 2007 error_setg(errp, "Flat image can't enable zeroed grain"); 2008 ret = -ENOTSUP; 2009 goto exit; 2010 } 2011 if (backing_file) { 2012 BlockBackend *blk; 2013 char *full_backing = g_new0(char, PATH_MAX); 2014 bdrv_get_full_backing_filename_from_filename(filename, backing_file, 2015 full_backing, PATH_MAX, 2016 &local_err); 2017 if (local_err) { 2018 g_free(full_backing); 2019 error_propagate(errp, local_err); 2020 ret = -ENOENT; 2021 goto exit; 2022 } 2023 2024 blk = blk_new_open(full_backing, NULL, NULL, 2025 BDRV_O_NO_BACKING, errp); 2026 g_free(full_backing); 2027 if (blk == NULL) { 2028 ret = -EIO; 2029 goto exit; 2030 } 2031 if (strcmp(blk_bs(blk)->drv->format_name, "vmdk")) { 2032 blk_unref(blk); 2033 ret = -EINVAL; 2034 goto exit; 2035 } 2036 ret = vmdk_read_cid(blk_bs(blk), 0, &parent_cid); 2037 blk_unref(blk); 2038 if (ret) { 2039 goto exit; 2040 } 2041 snprintf(parent_desc_line, BUF_SIZE, 2042 "parentFileNameHint=\"%s\"", backing_file); 2043 } 2044 2045 /* Create extents */ 2046 filesize = total_size; 2047 while (filesize > 0) { 2048 int64_t size = filesize; 2049 2050 if (split && size > split_size) { 2051 size = split_size; 2052 } 2053 if (split) { 2054 snprintf(desc_filename, PATH_MAX, "%s-%c%03d%s", 2055 prefix, flat ? 'f' : 's', ++idx, postfix); 2056 } else if (flat) { 2057 snprintf(desc_filename, PATH_MAX, "%s-flat%s", prefix, postfix); 2058 } else { 2059 snprintf(desc_filename, PATH_MAX, "%s%s", prefix, postfix); 2060 } 2061 snprintf(ext_filename, PATH_MAX, "%s%s", path, desc_filename); 2062 2063 if (vmdk_create_extent(ext_filename, size, 2064 flat, compress, zeroed_grain, opts, errp)) { 2065 ret = -EINVAL; 2066 goto exit; 2067 } 2068 filesize -= size; 2069 2070 /* Format description line */ 2071 snprintf(desc_line, BUF_SIZE, 2072 desc_extent_line, size / BDRV_SECTOR_SIZE, desc_filename); 2073 g_string_append(ext_desc_lines, desc_line); 2074 } 2075 /* generate descriptor file */ 2076 desc = g_strdup_printf(desc_template, 2077 g_random_int(), 2078 parent_cid, 2079 fmt, 2080 parent_desc_line, 2081 ext_desc_lines->str, 2082 hw_version, 2083 total_size / 2084 (int64_t)(63 * number_heads * BDRV_SECTOR_SIZE), 2085 number_heads, 2086 adapter_type); 2087 desc_len = strlen(desc); 2088 /* the descriptor offset = 0x200 */ 2089 if (!split && !flat) { 2090 desc_offset = 0x200; 2091 } else { 2092 ret = bdrv_create_file(filename, opts, &local_err); 2093 if (ret < 0) { 2094 error_propagate(errp, local_err); 2095 goto exit; 2096 } 2097 } 2098 2099 new_blk = blk_new_open(filename, NULL, NULL, 2100 BDRV_O_RDWR | BDRV_O_RESIZE | BDRV_O_PROTOCOL, 2101 &local_err); 2102 if (new_blk == NULL) { 2103 error_propagate(errp, local_err); 2104 ret = -EIO; 2105 goto exit; 2106 } 2107 2108 blk_set_allow_write_beyond_eof(new_blk, true); 2109 2110 ret = blk_pwrite(new_blk, desc_offset, desc, desc_len, 0); 2111 if (ret < 0) { 2112 error_setg_errno(errp, -ret, "Could not write description"); 2113 goto exit; 2114 } 2115 /* bdrv_pwrite write padding zeros to align to sector, we don't need that 2116 * for description file */ 2117 if (desc_offset == 0) { 2118 ret = blk_truncate(new_blk, desc_len, PREALLOC_MODE_OFF, errp); 2119 } 2120 exit: 2121 if (new_blk) { 2122 blk_unref(new_blk); 2123 } 2124 g_free(adapter_type); 2125 g_free(backing_file); 2126 g_free(hw_version); 2127 g_free(fmt); 2128 g_free(desc); 2129 g_free(path); 2130 g_free(prefix); 2131 g_free(postfix); 2132 g_free(desc_line); 2133 g_free(ext_filename); 2134 g_free(desc_filename); 2135 g_free(parent_desc_line); 2136 g_string_free(ext_desc_lines, true); 2137 return ret; 2138 } 2139 2140 static void vmdk_close(BlockDriverState *bs) 2141 { 2142 BDRVVmdkState *s = bs->opaque; 2143 2144 vmdk_free_extents(bs); 2145 g_free(s->create_type); 2146 2147 migrate_del_blocker(s->migration_blocker); 2148 error_free(s->migration_blocker); 2149 } 2150 2151 static coroutine_fn int vmdk_co_flush(BlockDriverState *bs) 2152 { 2153 BDRVVmdkState *s = bs->opaque; 2154 int i, err; 2155 int ret = 0; 2156 2157 for (i = 0; i < s->num_extents; i++) { 2158 err = bdrv_co_flush(s->extents[i].file->bs); 2159 if (err < 0) { 2160 ret = err; 2161 } 2162 } 2163 return ret; 2164 } 2165 2166 static int64_t vmdk_get_allocated_file_size(BlockDriverState *bs) 2167 { 2168 int i; 2169 int64_t ret = 0; 2170 int64_t r; 2171 BDRVVmdkState *s = bs->opaque; 2172 2173 ret = bdrv_get_allocated_file_size(bs->file->bs); 2174 if (ret < 0) { 2175 return ret; 2176 } 2177 for (i = 0; i < s->num_extents; i++) { 2178 if (s->extents[i].file == bs->file) { 2179 continue; 2180 } 2181 r = bdrv_get_allocated_file_size(s->extents[i].file->bs); 2182 if (r < 0) { 2183 return r; 2184 } 2185 ret += r; 2186 } 2187 return ret; 2188 } 2189 2190 static int vmdk_has_zero_init(BlockDriverState *bs) 2191 { 2192 int i; 2193 BDRVVmdkState *s = bs->opaque; 2194 2195 /* If has a flat extent and its underlying storage doesn't have zero init, 2196 * return 0. */ 2197 for (i = 0; i < s->num_extents; i++) { 2198 if (s->extents[i].flat) { 2199 if (!bdrv_has_zero_init(s->extents[i].file->bs)) { 2200 return 0; 2201 } 2202 } 2203 } 2204 return 1; 2205 } 2206 2207 static ImageInfo *vmdk_get_extent_info(VmdkExtent *extent) 2208 { 2209 ImageInfo *info = g_new0(ImageInfo, 1); 2210 2211 *info = (ImageInfo){ 2212 .filename = g_strdup(extent->file->bs->filename), 2213 .format = g_strdup(extent->type), 2214 .virtual_size = extent->sectors * BDRV_SECTOR_SIZE, 2215 .compressed = extent->compressed, 2216 .has_compressed = extent->compressed, 2217 .cluster_size = extent->cluster_sectors * BDRV_SECTOR_SIZE, 2218 .has_cluster_size = !extent->flat, 2219 }; 2220 2221 return info; 2222 } 2223 2224 static int vmdk_check(BlockDriverState *bs, BdrvCheckResult *result, 2225 BdrvCheckMode fix) 2226 { 2227 BDRVVmdkState *s = bs->opaque; 2228 VmdkExtent *extent = NULL; 2229 int64_t sector_num = 0; 2230 int64_t total_sectors = bdrv_nb_sectors(bs); 2231 int ret; 2232 uint64_t cluster_offset; 2233 2234 if (fix) { 2235 return -ENOTSUP; 2236 } 2237 2238 for (;;) { 2239 if (sector_num >= total_sectors) { 2240 return 0; 2241 } 2242 extent = find_extent(s, sector_num, extent); 2243 if (!extent) { 2244 fprintf(stderr, 2245 "ERROR: could not find extent for sector %" PRId64 "\n", 2246 sector_num); 2247 ret = -EINVAL; 2248 break; 2249 } 2250 ret = get_cluster_offset(bs, extent, NULL, 2251 sector_num << BDRV_SECTOR_BITS, 2252 false, &cluster_offset, 0, 0); 2253 if (ret == VMDK_ERROR) { 2254 fprintf(stderr, 2255 "ERROR: could not get cluster_offset for sector %" 2256 PRId64 "\n", sector_num); 2257 break; 2258 } 2259 if (ret == VMDK_OK) { 2260 int64_t extent_len = bdrv_getlength(extent->file->bs); 2261 if (extent_len < 0) { 2262 fprintf(stderr, 2263 "ERROR: could not get extent file length for sector %" 2264 PRId64 "\n", sector_num); 2265 ret = extent_len; 2266 break; 2267 } 2268 if (cluster_offset >= extent_len) { 2269 fprintf(stderr, 2270 "ERROR: cluster offset for sector %" 2271 PRId64 " points after EOF\n", sector_num); 2272 ret = -EINVAL; 2273 break; 2274 } 2275 } 2276 sector_num += extent->cluster_sectors; 2277 } 2278 2279 result->corruptions++; 2280 return ret; 2281 } 2282 2283 static ImageInfoSpecific *vmdk_get_specific_info(BlockDriverState *bs) 2284 { 2285 int i; 2286 BDRVVmdkState *s = bs->opaque; 2287 ImageInfoSpecific *spec_info = g_new0(ImageInfoSpecific, 1); 2288 ImageInfoList **next; 2289 2290 *spec_info = (ImageInfoSpecific){ 2291 .type = IMAGE_INFO_SPECIFIC_KIND_VMDK, 2292 .u = { 2293 .vmdk.data = g_new0(ImageInfoSpecificVmdk, 1), 2294 }, 2295 }; 2296 2297 *spec_info->u.vmdk.data = (ImageInfoSpecificVmdk) { 2298 .create_type = g_strdup(s->create_type), 2299 .cid = s->cid, 2300 .parent_cid = s->parent_cid, 2301 }; 2302 2303 next = &spec_info->u.vmdk.data->extents; 2304 for (i = 0; i < s->num_extents; i++) { 2305 *next = g_new0(ImageInfoList, 1); 2306 (*next)->value = vmdk_get_extent_info(&s->extents[i]); 2307 (*next)->next = NULL; 2308 next = &(*next)->next; 2309 } 2310 2311 return spec_info; 2312 } 2313 2314 static bool vmdk_extents_type_eq(const VmdkExtent *a, const VmdkExtent *b) 2315 { 2316 return a->flat == b->flat && 2317 a->compressed == b->compressed && 2318 (a->flat || a->cluster_sectors == b->cluster_sectors); 2319 } 2320 2321 static int vmdk_get_info(BlockDriverState *bs, BlockDriverInfo *bdi) 2322 { 2323 int i; 2324 BDRVVmdkState *s = bs->opaque; 2325 assert(s->num_extents); 2326 2327 /* See if we have multiple extents but they have different cases */ 2328 for (i = 1; i < s->num_extents; i++) { 2329 if (!vmdk_extents_type_eq(&s->extents[0], &s->extents[i])) { 2330 return -ENOTSUP; 2331 } 2332 } 2333 bdi->needs_compressed_writes = s->extents[0].compressed; 2334 if (!s->extents[0].flat) { 2335 bdi->cluster_size = s->extents[0].cluster_sectors << BDRV_SECTOR_BITS; 2336 } 2337 return 0; 2338 } 2339 2340 static QemuOptsList vmdk_create_opts = { 2341 .name = "vmdk-create-opts", 2342 .head = QTAILQ_HEAD_INITIALIZER(vmdk_create_opts.head), 2343 .desc = { 2344 { 2345 .name = BLOCK_OPT_SIZE, 2346 .type = QEMU_OPT_SIZE, 2347 .help = "Virtual disk size" 2348 }, 2349 { 2350 .name = BLOCK_OPT_ADAPTER_TYPE, 2351 .type = QEMU_OPT_STRING, 2352 .help = "Virtual adapter type, can be one of " 2353 "ide (default), lsilogic, buslogic or legacyESX" 2354 }, 2355 { 2356 .name = BLOCK_OPT_BACKING_FILE, 2357 .type = QEMU_OPT_STRING, 2358 .help = "File name of a base image" 2359 }, 2360 { 2361 .name = BLOCK_OPT_COMPAT6, 2362 .type = QEMU_OPT_BOOL, 2363 .help = "VMDK version 6 image", 2364 .def_value_str = "off" 2365 }, 2366 { 2367 .name = BLOCK_OPT_HWVERSION, 2368 .type = QEMU_OPT_STRING, 2369 .help = "VMDK hardware version", 2370 .def_value_str = "undefined" 2371 }, 2372 { 2373 .name = BLOCK_OPT_SUBFMT, 2374 .type = QEMU_OPT_STRING, 2375 .help = 2376 "VMDK flat extent format, can be one of " 2377 "{monolithicSparse (default) | monolithicFlat | twoGbMaxExtentSparse | twoGbMaxExtentFlat | streamOptimized} " 2378 }, 2379 { 2380 .name = BLOCK_OPT_ZEROED_GRAIN, 2381 .type = QEMU_OPT_BOOL, 2382 .help = "Enable efficient zero writes " 2383 "using the zeroed-grain GTE feature" 2384 }, 2385 { /* end of list */ } 2386 } 2387 }; 2388 2389 static BlockDriver bdrv_vmdk = { 2390 .format_name = "vmdk", 2391 .instance_size = sizeof(BDRVVmdkState), 2392 .bdrv_probe = vmdk_probe, 2393 .bdrv_open = vmdk_open, 2394 .bdrv_check = vmdk_check, 2395 .bdrv_reopen_prepare = vmdk_reopen_prepare, 2396 .bdrv_child_perm = bdrv_format_default_perms, 2397 .bdrv_co_preadv = vmdk_co_preadv, 2398 .bdrv_co_pwritev = vmdk_co_pwritev, 2399 .bdrv_co_pwritev_compressed = vmdk_co_pwritev_compressed, 2400 .bdrv_co_pwrite_zeroes = vmdk_co_pwrite_zeroes, 2401 .bdrv_close = vmdk_close, 2402 .bdrv_co_create_opts = vmdk_co_create_opts, 2403 .bdrv_co_flush_to_disk = vmdk_co_flush, 2404 .bdrv_co_block_status = vmdk_co_block_status, 2405 .bdrv_get_allocated_file_size = vmdk_get_allocated_file_size, 2406 .bdrv_has_zero_init = vmdk_has_zero_init, 2407 .bdrv_get_specific_info = vmdk_get_specific_info, 2408 .bdrv_refresh_limits = vmdk_refresh_limits, 2409 .bdrv_get_info = vmdk_get_info, 2410 2411 .supports_backing = true, 2412 .create_opts = &vmdk_create_opts, 2413 }; 2414 2415 static void bdrv_vmdk_init(void) 2416 { 2417 bdrv_register(&bdrv_vmdk); 2418 } 2419 2420 block_init(bdrv_vmdk_init); 2421