2 * Block driver for the VMDK format
4 * Copyright (c) 2004 Fabrice Bellard
5 * Copyright (c) 2005 Filip Navara
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:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
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
26 #include "qemu-common.h"
27 #include "block/block_int.h"
28 #include "qemu/module.h"
29 #include "migration/migration.h"
32 #define VMDK3_MAGIC (('C' << 24) | ('O' << 16) | ('W' << 8) | 'D')
33 #define VMDK4_MAGIC (('K' << 24) | ('D' << 16) | ('M' << 8) | 'V')
34 #define VMDK4_COMPRESSION_DEFLATE 1
35 #define VMDK4_FLAG_NL_DETECT (1 << 0)
36 #define VMDK4_FLAG_RGD (1 << 1)
37 /* Zeroed-grain enable bit */
38 #define VMDK4_FLAG_ZERO_GRAIN (1 << 2)
39 #define VMDK4_FLAG_COMPRESS (1 << 16)
40 #define VMDK4_FLAG_MARKER (1 << 17)
41 #define VMDK4_GD_AT_END 0xffffffffffffffffULL
43 #define VMDK_GTE_ZEROED 0x1
45 /* VMDK internal error codes */
47 #define VMDK_ERROR (-1)
48 /* Cluster not allocated */
49 #define VMDK_UNALLOC (-2)
50 #define VMDK_ZEROED (-3)
52 #define BLOCK_OPT_ZEROED_GRAIN "zeroed_grain"
57 uint32_t disk_sectors;
59 uint32_t l1dir_offset;
61 uint32_t file_sectors;
64 uint32_t sectors_per_track;
65 } QEMU_PACKED VMDK3Header;
74 /* Number of GrainTableEntries per GrainTable */
75 uint32_t num_gtes_per_gt;
78 uint64_t grain_offset;
81 uint16_t compressAlgorithm;
82 } QEMU_PACKED VMDK4Header;
84 #define L2_CACHE_SIZE 16
86 typedef struct VmdkExtent {
87 BlockDriverState *file;
95 int64_t flat_start_offset;
96 int64_t l1_table_offset;
97 int64_t l1_backup_table_offset;
99 uint32_t *l1_backup_table;
100 unsigned int l1_size;
101 uint32_t l1_entry_sectors;
103 unsigned int l2_size;
105 uint32_t l2_cache_offsets[L2_CACHE_SIZE];
106 uint32_t l2_cache_counts[L2_CACHE_SIZE];
108 int64_t cluster_sectors;
112 typedef struct BDRVVmdkState {
114 uint64_t desc_offset;
120 /* Extent array with num_extents entries, ascend ordered by address */
122 Error *migration_blocker;
126 typedef struct VmdkMetaData {
128 unsigned int l1_index;
129 unsigned int l2_index;
130 unsigned int l2_offset;
132 uint32_t *l2_cache_entry;
135 typedef struct VmdkGrainMarker {
139 } QEMU_PACKED VmdkGrainMarker;
142 MARKER_END_OF_STREAM = 0,
143 MARKER_GRAIN_TABLE = 1,
144 MARKER_GRAIN_DIRECTORY = 2,
148 static int vmdk_probe(const uint8_t *buf, int buf_size, const char *filename)
155 magic = be32_to_cpu(*(uint32_t *)buf);
156 if (magic == VMDK3_MAGIC ||
157 magic == VMDK4_MAGIC) {
160 const char *p = (const char *)buf;
161 const char *end = p + buf_size;
164 /* skip comment line */
165 while (p < end && *p != '\n') {
172 while (p < end && *p == ' ') {
175 /* skip '\r' if windows line endings used. */
176 if (p < end && *p == '\r') {
179 /* only accept blank lines before 'version=' line */
180 if (p == end || *p != '\n') {
186 if (end - p >= strlen("version=X\n")) {
187 if (strncmp("version=1\n", p, strlen("version=1\n")) == 0 ||
188 strncmp("version=2\n", p, strlen("version=2\n")) == 0) {
192 if (end - p >= strlen("version=X\r\n")) {
193 if (strncmp("version=1\r\n", p, strlen("version=1\r\n")) == 0 ||
194 strncmp("version=2\r\n", p, strlen("version=2\r\n")) == 0) {
204 #define SECTOR_SIZE 512
205 #define DESC_SIZE (20 * SECTOR_SIZE) /* 20 sectors of 512 bytes each */
206 #define BUF_SIZE 4096
207 #define HEADER_SIZE 512 /* first sector of 512 bytes */
209 static void vmdk_free_extents(BlockDriverState *bs)
212 BDRVVmdkState *s = bs->opaque;
215 for (i = 0; i < s->num_extents; i++) {
219 g_free(e->l1_backup_table);
221 if (e->file != bs->file) {
228 static void vmdk_free_last_extent(BlockDriverState *bs)
230 BDRVVmdkState *s = bs->opaque;
232 if (s->num_extents == 0) {
236 s->extents = g_realloc(s->extents, s->num_extents * sizeof(VmdkExtent));
239 static uint32_t vmdk_read_cid(BlockDriverState *bs, int parent)
241 char desc[DESC_SIZE];
242 uint32_t cid = 0xffffffff;
243 const char *p_name, *cid_str;
245 BDRVVmdkState *s = bs->opaque;
248 ret = bdrv_pread(bs->file, s->desc_offset, desc, DESC_SIZE);
254 cid_str = "parentCID";
255 cid_str_size = sizeof("parentCID");
258 cid_str_size = sizeof("CID");
261 desc[DESC_SIZE - 1] = '\0';
262 p_name = strstr(desc, cid_str);
263 if (p_name != NULL) {
264 p_name += cid_str_size;
265 sscanf(p_name, "%x", &cid);
271 static int vmdk_write_cid(BlockDriverState *bs, uint32_t cid)
273 char desc[DESC_SIZE], tmp_desc[DESC_SIZE];
274 char *p_name, *tmp_str;
275 BDRVVmdkState *s = bs->opaque;
278 ret = bdrv_pread(bs->file, s->desc_offset, desc, DESC_SIZE);
283 desc[DESC_SIZE - 1] = '\0';
284 tmp_str = strstr(desc, "parentCID");
285 if (tmp_str == NULL) {
289 pstrcpy(tmp_desc, sizeof(tmp_desc), tmp_str);
290 p_name = strstr(desc, "CID");
291 if (p_name != NULL) {
292 p_name += sizeof("CID");
293 snprintf(p_name, sizeof(desc) - (p_name - desc), "%x\n", cid);
294 pstrcat(desc, sizeof(desc), tmp_desc);
297 ret = bdrv_pwrite_sync(bs->file, s->desc_offset, desc, DESC_SIZE);
305 static int vmdk_is_cid_valid(BlockDriverState *bs)
307 BDRVVmdkState *s = bs->opaque;
308 BlockDriverState *p_bs = bs->backing_hd;
311 if (!s->cid_checked && p_bs) {
312 cur_pcid = vmdk_read_cid(p_bs, 0);
313 if (s->parent_cid != cur_pcid) {
318 s->cid_checked = true;
323 /* Queue extents, if any, for reopen() */
324 static int vmdk_reopen_prepare(BDRVReopenState *state,
325 BlockReopenQueue *queue, Error **errp)
332 assert(state != NULL);
333 assert(state->bs != NULL);
336 error_setg(errp, "No reopen queue for VMDK extents");
340 s = state->bs->opaque;
344 for (i = 0; i < s->num_extents; i++) {
346 if (e->file != state->bs->file) {
347 bdrv_reopen_queue(queue, e->file, state->flags);
356 static int vmdk_parent_open(BlockDriverState *bs)
359 char desc[DESC_SIZE + 1];
360 BDRVVmdkState *s = bs->opaque;
363 desc[DESC_SIZE] = '\0';
364 ret = bdrv_pread(bs->file, s->desc_offset, desc, DESC_SIZE);
369 p_name = strstr(desc, "parentFileNameHint");
370 if (p_name != NULL) {
373 p_name += sizeof("parentFileNameHint") + 1;
374 end_name = strchr(p_name, '\"');
375 if (end_name == NULL) {
378 if ((end_name - p_name) > sizeof(bs->backing_file) - 1) {
382 pstrcpy(bs->backing_file, end_name - p_name + 1, p_name);
388 /* Create and append extent to the extent array. Return the added VmdkExtent
389 * address. return NULL if allocation failed. */
390 static int vmdk_add_extent(BlockDriverState *bs,
391 BlockDriverState *file, bool flat, int64_t sectors,
392 int64_t l1_offset, int64_t l1_backup_offset,
394 int l2_size, uint64_t cluster_sectors,
395 VmdkExtent **new_extent,
399 BDRVVmdkState *s = bs->opaque;
401 if (cluster_sectors > 0x200000) {
402 /* 0x200000 * 512Bytes = 1GB for one cluster is unrealistic */
403 error_setg(errp, "Invalid granularity, image may be corrupt");
406 if (l1_size > 512 * 1024 * 1024) {
407 /* Although with big capacity and small l1_entry_sectors, we can get a
408 * big l1_size, we don't want unbounded value to allocate the table.
409 * Limit it to 512M, which is 16PB for default cluster and L2 table
411 error_setg(errp, "L1 size too big");
415 s->extents = g_realloc(s->extents,
416 (s->num_extents + 1) * sizeof(VmdkExtent));
417 extent = &s->extents[s->num_extents];
420 memset(extent, 0, sizeof(VmdkExtent));
423 extent->sectors = sectors;
424 extent->l1_table_offset = l1_offset;
425 extent->l1_backup_table_offset = l1_backup_offset;
426 extent->l1_size = l1_size;
427 extent->l1_entry_sectors = l2_size * cluster_sectors;
428 extent->l2_size = l2_size;
429 extent->cluster_sectors = flat ? sectors : cluster_sectors;
432 bs->bl.write_zeroes_alignment =
433 MAX(bs->bl.write_zeroes_alignment, cluster_sectors);
435 if (s->num_extents > 1) {
436 extent->end_sector = (*(extent - 1)).end_sector + extent->sectors;
438 extent->end_sector = extent->sectors;
440 bs->total_sectors = extent->end_sector;
442 *new_extent = extent;
447 static int vmdk_init_tables(BlockDriverState *bs, VmdkExtent *extent,
453 /* read the L1 table */
454 l1_size = extent->l1_size * sizeof(uint32_t);
455 extent->l1_table = g_malloc(l1_size);
456 ret = bdrv_pread(extent->file,
457 extent->l1_table_offset,
461 error_setg_errno(errp, -ret,
462 "Could not read l1 table from extent '%s'",
463 extent->file->filename);
466 for (i = 0; i < extent->l1_size; i++) {
467 le32_to_cpus(&extent->l1_table[i]);
470 if (extent->l1_backup_table_offset) {
471 extent->l1_backup_table = g_malloc(l1_size);
472 ret = bdrv_pread(extent->file,
473 extent->l1_backup_table_offset,
474 extent->l1_backup_table,
477 error_setg_errno(errp, -ret,
478 "Could not read l1 backup table from extent '%s'",
479 extent->file->filename);
482 for (i = 0; i < extent->l1_size; i++) {
483 le32_to_cpus(&extent->l1_backup_table[i]);
488 g_malloc(extent->l2_size * L2_CACHE_SIZE * sizeof(uint32_t));
491 g_free(extent->l1_backup_table);
493 g_free(extent->l1_table);
497 static int vmdk_open_vmfs_sparse(BlockDriverState *bs,
498 BlockDriverState *file,
499 int flags, Error **errp)
506 ret = bdrv_pread(file, sizeof(magic), &header, sizeof(header));
508 error_setg_errno(errp, -ret,
509 "Could not read header from file '%s'",
513 ret = vmdk_add_extent(bs, file, false,
514 le32_to_cpu(header.disk_sectors),
515 le32_to_cpu(header.l1dir_offset) << 9,
517 le32_to_cpu(header.l1dir_size),
519 le32_to_cpu(header.granularity),
525 ret = vmdk_init_tables(bs, extent, errp);
527 /* free extent allocated by vmdk_add_extent */
528 vmdk_free_last_extent(bs);
533 static int vmdk_open_desc_file(BlockDriverState *bs, int flags,
534 uint64_t desc_offset, Error **errp);
536 static int vmdk_open_vmdk4(BlockDriverState *bs,
537 BlockDriverState *file,
538 int flags, Error **errp)
542 uint32_t l1_size, l1_entry_sectors;
545 BDRVVmdkState *s = bs->opaque;
546 int64_t l1_backup_offset = 0;
548 ret = bdrv_pread(file, sizeof(magic), &header, sizeof(header));
550 error_setg_errno(errp, -ret,
551 "Could not read header from file '%s'",
554 if (header.capacity == 0) {
555 uint64_t desc_offset = le64_to_cpu(header.desc_offset);
557 return vmdk_open_desc_file(bs, flags, desc_offset << 9, errp);
561 if (!s->create_type) {
562 s->create_type = g_strdup("monolithicSparse");
565 if (le64_to_cpu(header.gd_offset) == VMDK4_GD_AT_END) {
567 * The footer takes precedence over the header, so read it in. The
568 * footer starts at offset -1024 from the end: One sector for the
569 * footer, and another one for the end-of-stream marker.
576 uint8_t pad[512 - 16];
577 } QEMU_PACKED footer_marker;
581 uint8_t pad[512 - 4 - sizeof(VMDK4Header)];
587 uint8_t pad[512 - 16];
588 } QEMU_PACKED eos_marker;
589 } QEMU_PACKED footer;
591 ret = bdrv_pread(file,
592 bs->file->total_sectors * 512 - 1536,
593 &footer, sizeof(footer));
598 /* Some sanity checks for the footer */
599 if (be32_to_cpu(footer.magic) != VMDK4_MAGIC ||
600 le32_to_cpu(footer.footer_marker.size) != 0 ||
601 le32_to_cpu(footer.footer_marker.type) != MARKER_FOOTER ||
602 le64_to_cpu(footer.eos_marker.val) != 0 ||
603 le32_to_cpu(footer.eos_marker.size) != 0 ||
604 le32_to_cpu(footer.eos_marker.type) != MARKER_END_OF_STREAM)
609 header = footer.header;
612 if (le32_to_cpu(header.version) > 3) {
614 snprintf(buf, sizeof(buf), "VMDK version %d",
615 le32_to_cpu(header.version));
616 qerror_report(QERR_UNKNOWN_BLOCK_FORMAT_FEATURE,
617 bs->device_name, "vmdk", buf);
619 } else if (le32_to_cpu(header.version) == 3 && (flags & BDRV_O_RDWR)) {
620 /* VMware KB 2064959 explains that version 3 added support for
621 * persistent changed block tracking (CBT), and backup software can
622 * read it as version=1 if it doesn't care about the changed area
623 * information. So we are safe to enable read only. */
624 error_setg(errp, "VMDK version 3 must be read only");
628 if (le32_to_cpu(header.num_gtes_per_gt) > 512) {
629 error_report("L2 table size too big");
633 l1_entry_sectors = le32_to_cpu(header.num_gtes_per_gt)
634 * le64_to_cpu(header.granularity);
635 if (l1_entry_sectors == 0) {
638 l1_size = (le64_to_cpu(header.capacity) + l1_entry_sectors - 1)
640 if (le32_to_cpu(header.flags) & VMDK4_FLAG_RGD) {
641 l1_backup_offset = le64_to_cpu(header.rgd_offset) << 9;
643 if (bdrv_getlength(file) <
644 le64_to_cpu(header.grain_offset) * BDRV_SECTOR_SIZE) {
645 error_report("File truncated, expecting at least %lld bytes",
646 le64_to_cpu(header.grain_offset) * BDRV_SECTOR_SIZE);
650 ret = vmdk_add_extent(bs, file, false,
651 le64_to_cpu(header.capacity),
652 le64_to_cpu(header.gd_offset) << 9,
655 le32_to_cpu(header.num_gtes_per_gt),
656 le64_to_cpu(header.granularity),
663 le16_to_cpu(header.compressAlgorithm) == VMDK4_COMPRESSION_DEFLATE;
664 extent->has_marker = le32_to_cpu(header.flags) & VMDK4_FLAG_MARKER;
665 extent->version = le32_to_cpu(header.version);
666 extent->has_zero_grain = le32_to_cpu(header.flags) & VMDK4_FLAG_ZERO_GRAIN;
667 ret = vmdk_init_tables(bs, extent, errp);
669 /* free extent allocated by vmdk_add_extent */
670 vmdk_free_last_extent(bs);
675 /* find an option value out of descriptor file */
676 static int vmdk_parse_description(const char *desc, const char *opt_name,
677 char *buf, int buf_size)
679 char *opt_pos, *opt_end;
680 const char *end = desc + strlen(desc);
682 opt_pos = strstr(desc, opt_name);
686 /* Skip "=\"" following opt_name */
687 opt_pos += strlen(opt_name) + 2;
688 if (opt_pos >= end) {
692 while (opt_end < end && *opt_end != '"') {
695 if (opt_end == end || buf_size < opt_end - opt_pos + 1) {
698 pstrcpy(buf, opt_end - opt_pos + 1, opt_pos);
702 /* Open an extent file and append to bs array */
703 static int vmdk_open_sparse(BlockDriverState *bs,
704 BlockDriverState *file,
705 int flags, Error **errp)
709 if (bdrv_pread(file, 0, &magic, sizeof(magic)) != sizeof(magic)) {
713 magic = be32_to_cpu(magic);
716 return vmdk_open_vmfs_sparse(bs, file, flags, errp);
719 return vmdk_open_vmdk4(bs, file, flags, errp);
727 static int vmdk_parse_extents(const char *desc, BlockDriverState *bs,
728 const char *desc_file_path, Error **errp)
734 const char *p = desc;
737 char extent_path[PATH_MAX];
738 BlockDriverState *extent_file;
739 BDRVVmdkState *s = bs->opaque;
743 /* parse extent line:
744 * RW [size in sectors] FLAT "file-name.vmdk" OFFSET
746 * RW [size in sectors] SPARSE "file-name.vmdk"
749 ret = sscanf(p, "%10s %" SCNd64 " %10s \"%511[^\n\r\"]\" %" SCNd64,
750 access, §ors, type, fname, &flat_offset);
751 if (ret < 4 || strcmp(access, "RW")) {
753 } else if (!strcmp(type, "FLAT")) {
754 if (ret != 5 || flat_offset < 0) {
755 error_setg(errp, "Invalid extent lines: \n%s", p);
758 } else if (!strcmp(type, "VMFS")) {
762 error_setg(errp, "Invalid extent lines:\n%s", p);
765 } else if (ret != 4) {
766 error_setg(errp, "Invalid extent lines:\n%s", p);
771 (strcmp(type, "FLAT") && strcmp(type, "SPARSE") &&
772 strcmp(type, "VMFS") && strcmp(type, "VMFSSPARSE")) ||
773 (strcmp(access, "RW"))) {
777 path_combine(extent_path, sizeof(extent_path),
778 desc_file_path, fname);
779 ret = bdrv_file_open(&extent_file, extent_path, NULL, NULL,
780 bs->open_flags, errp);
785 /* save to extents array */
786 if (!strcmp(type, "FLAT") || !strcmp(type, "VMFS")) {
789 ret = vmdk_add_extent(bs, extent_file, true, sectors,
790 0, 0, 0, 0, 0, &extent, errp);
794 extent->flat_start_offset = flat_offset << 9;
795 } else if (!strcmp(type, "SPARSE") || !strcmp(type, "VMFSSPARSE")) {
796 /* SPARSE extent and VMFSSPARSE extent are both "COWD" sparse file*/
797 ret = vmdk_open_sparse(bs, extent_file, bs->open_flags, errp);
799 bdrv_unref(extent_file);
802 extent = &s->extents[s->num_extents - 1];
804 error_setg(errp, "Unsupported extent type '%s'", type);
807 extent->type = g_strdup(type);
809 /* move to next line */
821 static int vmdk_open_desc_file(BlockDriverState *bs, int flags,
822 uint64_t desc_offset, Error **errp)
827 BDRVVmdkState *s = bs->opaque;
830 size = bdrv_getlength(bs->file);
835 size = MIN(size, 1 << 20); /* avoid unbounded allocation */
836 buf = g_malloc0(size + 1);
838 ret = bdrv_pread(bs->file, desc_offset, buf, size);
842 if (vmdk_parse_description(buf, "createType", ct, sizeof(ct))) {
846 if (strcmp(ct, "monolithicFlat") &&
847 strcmp(ct, "vmfs") &&
848 strcmp(ct, "vmfsSparse") &&
849 strcmp(ct, "twoGbMaxExtentSparse") &&
850 strcmp(ct, "twoGbMaxExtentFlat")) {
851 error_setg(errp, "Unsupported image type '%s'", ct);
855 s->create_type = g_strdup(ct);
857 ret = vmdk_parse_extents(buf, bs, bs->file->filename, errp);
863 static int vmdk_open(BlockDriverState *bs, QDict *options, int flags,
867 BDRVVmdkState *s = bs->opaque;
869 if (vmdk_open_sparse(bs, bs->file, flags, errp) == 0) {
870 s->desc_offset = 0x200;
872 ret = vmdk_open_desc_file(bs, flags, 0, errp);
877 /* try to open parent images, if exist */
878 ret = vmdk_parent_open(bs);
882 s->cid = vmdk_read_cid(bs, 0);
883 s->parent_cid = vmdk_read_cid(bs, 1);
884 qemu_co_mutex_init(&s->lock);
886 /* Disable migration when VMDK images are used */
887 error_set(&s->migration_blocker,
888 QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
889 "vmdk", bs->device_name, "live migration");
890 migrate_add_blocker(s->migration_blocker);
895 g_free(s->create_type);
896 s->create_type = NULL;
897 vmdk_free_extents(bs);
901 static int get_whole_cluster(BlockDriverState *bs,
903 uint64_t cluster_offset,
908 uint8_t *whole_grain = NULL;
910 /* we will be here if it's first write on non-exist grain(cluster).
911 * try to read from parent image, if exist */
912 if (bs->backing_hd) {
914 qemu_blockalign(bs, extent->cluster_sectors << BDRV_SECTOR_BITS);
915 if (!vmdk_is_cid_valid(bs)) {
920 /* floor offset to cluster */
921 offset -= offset % (extent->cluster_sectors * 512);
922 ret = bdrv_read(bs->backing_hd, offset >> 9, whole_grain,
923 extent->cluster_sectors);
929 /* Write grain only into the active image */
930 ret = bdrv_write(extent->file, cluster_offset, whole_grain,
931 extent->cluster_sectors);
938 qemu_vfree(whole_grain);
942 static int vmdk_L2update(VmdkExtent *extent, VmdkMetaData *m_data)
945 QEMU_BUILD_BUG_ON(sizeof(offset) != sizeof(m_data->offset));
946 offset = cpu_to_le32(m_data->offset);
947 /* update L2 table */
948 if (bdrv_pwrite_sync(
950 ((int64_t)m_data->l2_offset * 512)
951 + (m_data->l2_index * sizeof(m_data->offset)),
952 &offset, sizeof(offset)) < 0) {
955 /* update backup L2 table */
956 if (extent->l1_backup_table_offset != 0) {
957 m_data->l2_offset = extent->l1_backup_table[m_data->l1_index];
958 if (bdrv_pwrite_sync(
960 ((int64_t)m_data->l2_offset * 512)
961 + (m_data->l2_index * sizeof(m_data->offset)),
962 &offset, sizeof(offset)) < 0) {
966 if (m_data->l2_cache_entry) {
967 *m_data->l2_cache_entry = offset;
973 static int get_cluster_offset(BlockDriverState *bs,
975 VmdkMetaData *m_data,
978 uint64_t *cluster_offset)
980 unsigned int l1_index, l2_offset, l2_index;
982 uint32_t min_count, *l2_table;
989 *cluster_offset = extent->flat_start_offset;
993 offset -= (extent->end_sector - extent->sectors) * SECTOR_SIZE;
994 l1_index = (offset >> 9) / extent->l1_entry_sectors;
995 if (l1_index >= extent->l1_size) {
998 l2_offset = extent->l1_table[l1_index];
1000 return VMDK_UNALLOC;
1002 for (i = 0; i < L2_CACHE_SIZE; i++) {
1003 if (l2_offset == extent->l2_cache_offsets[i]) {
1004 /* increment the hit count */
1005 if (++extent->l2_cache_counts[i] == 0xffffffff) {
1006 for (j = 0; j < L2_CACHE_SIZE; j++) {
1007 extent->l2_cache_counts[j] >>= 1;
1010 l2_table = extent->l2_cache + (i * extent->l2_size);
1014 /* not found: load a new entry in the least used one */
1016 min_count = 0xffffffff;
1017 for (i = 0; i < L2_CACHE_SIZE; i++) {
1018 if (extent->l2_cache_counts[i] < min_count) {
1019 min_count = extent->l2_cache_counts[i];
1023 l2_table = extent->l2_cache + (min_index * extent->l2_size);
1026 (int64_t)l2_offset * 512,
1028 extent->l2_size * sizeof(uint32_t)
1029 ) != extent->l2_size * sizeof(uint32_t)) {
1033 extent->l2_cache_offsets[min_index] = l2_offset;
1034 extent->l2_cache_counts[min_index] = 1;
1036 l2_index = ((offset >> 9) / extent->cluster_sectors) % extent->l2_size;
1037 *cluster_offset = le32_to_cpu(l2_table[l2_index]);
1041 m_data->l1_index = l1_index;
1042 m_data->l2_index = l2_index;
1043 m_data->offset = *cluster_offset;
1044 m_data->l2_offset = l2_offset;
1045 m_data->l2_cache_entry = &l2_table[l2_index];
1047 if (extent->has_zero_grain && *cluster_offset == VMDK_GTE_ZEROED) {
1051 if (!*cluster_offset || zeroed) {
1053 return zeroed ? VMDK_ZEROED : VMDK_UNALLOC;
1056 /* Avoid the L2 tables update for the images that have snapshots. */
1057 *cluster_offset = bdrv_getlength(extent->file);
1058 if (!extent->compressed) {
1061 *cluster_offset + (extent->cluster_sectors << 9)
1065 *cluster_offset >>= 9;
1066 l2_table[l2_index] = cpu_to_le32(*cluster_offset);
1068 /* First of all we write grain itself, to avoid race condition
1069 * that may to corrupt the image.
1070 * This problem may occur because of insufficient space on host disk
1071 * or inappropriate VM shutdown.
1073 if (get_whole_cluster(
1074 bs, extent, *cluster_offset, offset, allocate) == -1) {
1079 m_data->offset = *cluster_offset;
1082 *cluster_offset <<= 9;
1086 static VmdkExtent *find_extent(BDRVVmdkState *s,
1087 int64_t sector_num, VmdkExtent *start_hint)
1089 VmdkExtent *extent = start_hint;
1092 extent = &s->extents[0];
1094 while (extent < &s->extents[s->num_extents]) {
1095 if (sector_num < extent->end_sector) {
1103 static int64_t coroutine_fn vmdk_co_get_block_status(BlockDriverState *bs,
1104 int64_t sector_num, int nb_sectors, int *pnum)
1106 BDRVVmdkState *s = bs->opaque;
1107 int64_t index_in_cluster, n, ret;
1111 extent = find_extent(s, sector_num, NULL);
1115 qemu_co_mutex_lock(&s->lock);
1116 ret = get_cluster_offset(bs, extent, NULL,
1117 sector_num * 512, 0, &offset);
1118 qemu_co_mutex_unlock(&s->lock);
1128 ret = BDRV_BLOCK_ZERO;
1131 ret = BDRV_BLOCK_DATA;
1132 if (extent->file == bs->file) {
1133 ret |= BDRV_BLOCK_OFFSET_VALID | offset;
1139 index_in_cluster = sector_num % extent->cluster_sectors;
1140 n = extent->cluster_sectors - index_in_cluster;
1141 if (n > nb_sectors) {
1148 static int vmdk_write_extent(VmdkExtent *extent, int64_t cluster_offset,
1149 int64_t offset_in_cluster, const uint8_t *buf,
1150 int nb_sectors, int64_t sector_num)
1153 VmdkGrainMarker *data = NULL;
1155 const uint8_t *write_buf = buf;
1156 int write_len = nb_sectors * 512;
1158 if (extent->compressed) {
1159 if (!extent->has_marker) {
1163 buf_len = (extent->cluster_sectors << 9) * 2;
1164 data = g_malloc(buf_len + sizeof(VmdkGrainMarker));
1165 if (compress(data->data, &buf_len, buf, nb_sectors << 9) != Z_OK ||
1170 data->lba = sector_num;
1171 data->size = buf_len;
1172 write_buf = (uint8_t *)data;
1173 write_len = buf_len + sizeof(VmdkGrainMarker);
1175 ret = bdrv_pwrite(extent->file,
1176 cluster_offset + offset_in_cluster,
1179 if (ret != write_len) {
1180 ret = ret < 0 ? ret : -EIO;
1189 static int vmdk_read_extent(VmdkExtent *extent, int64_t cluster_offset,
1190 int64_t offset_in_cluster, uint8_t *buf,
1194 int cluster_bytes, buf_bytes;
1195 uint8_t *cluster_buf, *compressed_data;
1196 uint8_t *uncomp_buf;
1198 VmdkGrainMarker *marker;
1202 if (!extent->compressed) {
1203 ret = bdrv_pread(extent->file,
1204 cluster_offset + offset_in_cluster,
1205 buf, nb_sectors * 512);
1206 if (ret == nb_sectors * 512) {
1212 cluster_bytes = extent->cluster_sectors * 512;
1213 /* Read two clusters in case GrainMarker + compressed data > one cluster */
1214 buf_bytes = cluster_bytes * 2;
1215 cluster_buf = g_malloc(buf_bytes);
1216 uncomp_buf = g_malloc(cluster_bytes);
1217 ret = bdrv_pread(extent->file,
1219 cluster_buf, buf_bytes);
1223 compressed_data = cluster_buf;
1224 buf_len = cluster_bytes;
1225 data_len = cluster_bytes;
1226 if (extent->has_marker) {
1227 marker = (VmdkGrainMarker *)cluster_buf;
1228 compressed_data = marker->data;
1229 data_len = le32_to_cpu(marker->size);
1231 if (!data_len || data_len > buf_bytes) {
1235 ret = uncompress(uncomp_buf, &buf_len, compressed_data, data_len);
1241 if (offset_in_cluster < 0 ||
1242 offset_in_cluster + nb_sectors * 512 > buf_len) {
1246 memcpy(buf, uncomp_buf + offset_in_cluster, nb_sectors * 512);
1251 g_free(cluster_buf);
1255 static int vmdk_read(BlockDriverState *bs, int64_t sector_num,
1256 uint8_t *buf, int nb_sectors)
1258 BDRVVmdkState *s = bs->opaque;
1260 uint64_t n, index_in_cluster;
1261 uint64_t extent_begin_sector, extent_relative_sector_num;
1262 VmdkExtent *extent = NULL;
1263 uint64_t cluster_offset;
1265 while (nb_sectors > 0) {
1266 extent = find_extent(s, sector_num, extent);
1270 ret = get_cluster_offset(
1272 sector_num << 9, 0, &cluster_offset);
1273 extent_begin_sector = extent->end_sector - extent->sectors;
1274 extent_relative_sector_num = sector_num - extent_begin_sector;
1275 index_in_cluster = extent_relative_sector_num % extent->cluster_sectors;
1276 n = extent->cluster_sectors - index_in_cluster;
1277 if (n > nb_sectors) {
1280 if (ret != VMDK_OK) {
1281 /* if not allocated, try to read from parent image, if exist */
1282 if (bs->backing_hd && ret != VMDK_ZEROED) {
1283 if (!vmdk_is_cid_valid(bs)) {
1286 ret = bdrv_read(bs->backing_hd, sector_num, buf, n);
1291 memset(buf, 0, 512 * n);
1294 ret = vmdk_read_extent(extent,
1295 cluster_offset, index_in_cluster * 512,
1308 static coroutine_fn int vmdk_co_read(BlockDriverState *bs, int64_t sector_num,
1309 uint8_t *buf, int nb_sectors)
1312 BDRVVmdkState *s = bs->opaque;
1313 qemu_co_mutex_lock(&s->lock);
1314 ret = vmdk_read(bs, sector_num, buf, nb_sectors);
1315 qemu_co_mutex_unlock(&s->lock);
1321 * @zeroed: buf is ignored (data is zero), use zeroed_grain GTE feature
1322 * if possible, otherwise return -ENOTSUP.
1323 * @zero_dry_run: used for zeroed == true only, don't update L2 table, just try
1324 * with each cluster. By dry run we can find if the zero write
1325 * is possible without modifying image data.
1327 * Returns: error code with 0 for success.
1329 static int vmdk_write(BlockDriverState *bs, int64_t sector_num,
1330 const uint8_t *buf, int nb_sectors,
1331 bool zeroed, bool zero_dry_run)
1333 BDRVVmdkState *s = bs->opaque;
1334 VmdkExtent *extent = NULL;
1336 int64_t index_in_cluster, n;
1337 uint64_t extent_begin_sector, extent_relative_sector_num;
1338 uint64_t cluster_offset;
1339 VmdkMetaData m_data;
1341 if (sector_num > bs->total_sectors) {
1342 error_report("Wrong offset: sector_num=0x%" PRIx64
1343 " total_sectors=0x%" PRIx64 "\n",
1344 sector_num, bs->total_sectors);
1348 while (nb_sectors > 0) {
1349 extent = find_extent(s, sector_num, extent);
1353 ret = get_cluster_offset(
1357 sector_num << 9, !extent->compressed,
1359 if (extent->compressed) {
1360 if (ret == VMDK_OK) {
1361 /* Refuse write to allocated cluster for streamOptimized */
1362 error_report("Could not write to allocated cluster"
1363 " for streamOptimized");
1367 ret = get_cluster_offset(
1375 if (ret == VMDK_ERROR) {
1378 extent_begin_sector = extent->end_sector - extent->sectors;
1379 extent_relative_sector_num = sector_num - extent_begin_sector;
1380 index_in_cluster = extent_relative_sector_num % extent->cluster_sectors;
1381 n = extent->cluster_sectors - index_in_cluster;
1382 if (n > nb_sectors) {
1386 /* Do zeroed write, buf is ignored */
1387 if (extent->has_zero_grain &&
1388 index_in_cluster == 0 &&
1389 n >= extent->cluster_sectors) {
1390 n = extent->cluster_sectors;
1391 if (!zero_dry_run) {
1392 m_data.offset = VMDK_GTE_ZEROED;
1393 /* update L2 tables */
1394 if (vmdk_L2update(extent, &m_data) != VMDK_OK) {
1402 ret = vmdk_write_extent(extent,
1403 cluster_offset, index_in_cluster * 512,
1404 buf, n, sector_num);
1409 /* update L2 tables */
1410 if (vmdk_L2update(extent, &m_data) != VMDK_OK) {
1419 /* update CID on the first write every time the virtual disk is
1421 if (!s->cid_updated) {
1422 ret = vmdk_write_cid(bs, time(NULL));
1426 s->cid_updated = true;
1432 static coroutine_fn int vmdk_co_write(BlockDriverState *bs, int64_t sector_num,
1433 const uint8_t *buf, int nb_sectors)
1436 BDRVVmdkState *s = bs->opaque;
1437 qemu_co_mutex_lock(&s->lock);
1438 ret = vmdk_write(bs, sector_num, buf, nb_sectors, false, false);
1439 qemu_co_mutex_unlock(&s->lock);
1443 static int coroutine_fn vmdk_co_write_zeroes(BlockDriverState *bs,
1446 BdrvRequestFlags flags)
1449 BDRVVmdkState *s = bs->opaque;
1450 qemu_co_mutex_lock(&s->lock);
1451 /* write zeroes could fail if sectors not aligned to cluster, test it with
1452 * dry_run == true before really updating image */
1453 ret = vmdk_write(bs, sector_num, NULL, nb_sectors, true, true);
1455 ret = vmdk_write(bs, sector_num, NULL, nb_sectors, true, false);
1457 qemu_co_mutex_unlock(&s->lock);
1461 static int vmdk_create_extent(const char *filename, int64_t filesize,
1462 bool flat, bool compress, bool zeroed_grain,
1466 BlockDriverState *bs = NULL;
1469 uint32_t tmp, magic, grains, gd_sectors, gt_size, gt_count;
1470 uint32_t *gd_buf = NULL;
1473 ret = bdrv_create_file(filename, NULL, &local_err);
1475 error_propagate(errp, local_err);
1479 ret = bdrv_file_open(&bs, filename, NULL, NULL, BDRV_O_RDWR, &local_err);
1481 error_propagate(errp, local_err);
1486 ret = bdrv_truncate(bs, filesize);
1488 error_setg(errp, "Could not truncate file");
1492 magic = cpu_to_be32(VMDK4_MAGIC);
1493 memset(&header, 0, sizeof(header));
1494 header.version = zeroed_grain ? 2 : 1;
1495 header.flags = VMDK4_FLAG_RGD | VMDK4_FLAG_NL_DETECT
1496 | (compress ? VMDK4_FLAG_COMPRESS | VMDK4_FLAG_MARKER : 0)
1497 | (zeroed_grain ? VMDK4_FLAG_ZERO_GRAIN : 0);
1498 header.compressAlgorithm = compress ? VMDK4_COMPRESSION_DEFLATE : 0;
1499 header.capacity = filesize / BDRV_SECTOR_SIZE;
1500 header.granularity = 128;
1501 header.num_gtes_per_gt = BDRV_SECTOR_SIZE;
1503 grains = DIV_ROUND_UP(filesize / BDRV_SECTOR_SIZE, header.granularity);
1504 gt_size = DIV_ROUND_UP(header.num_gtes_per_gt * sizeof(uint32_t),
1506 gt_count = DIV_ROUND_UP(grains, header.num_gtes_per_gt);
1507 gd_sectors = DIV_ROUND_UP(gt_count * sizeof(uint32_t), BDRV_SECTOR_SIZE);
1509 header.desc_offset = 1;
1510 header.desc_size = 20;
1511 header.rgd_offset = header.desc_offset + header.desc_size;
1512 header.gd_offset = header.rgd_offset + gd_sectors + (gt_size * gt_count);
1513 header.grain_offset =
1514 ROUND_UP(header.gd_offset + gd_sectors + (gt_size * gt_count),
1515 header.granularity);
1516 /* swap endianness for all header fields */
1517 header.version = cpu_to_le32(header.version);
1518 header.flags = cpu_to_le32(header.flags);
1519 header.capacity = cpu_to_le64(header.capacity);
1520 header.granularity = cpu_to_le64(header.granularity);
1521 header.num_gtes_per_gt = cpu_to_le32(header.num_gtes_per_gt);
1522 header.desc_offset = cpu_to_le64(header.desc_offset);
1523 header.desc_size = cpu_to_le64(header.desc_size);
1524 header.rgd_offset = cpu_to_le64(header.rgd_offset);
1525 header.gd_offset = cpu_to_le64(header.gd_offset);
1526 header.grain_offset = cpu_to_le64(header.grain_offset);
1527 header.compressAlgorithm = cpu_to_le16(header.compressAlgorithm);
1529 header.check_bytes[0] = 0xa;
1530 header.check_bytes[1] = 0x20;
1531 header.check_bytes[2] = 0xd;
1532 header.check_bytes[3] = 0xa;
1534 /* write all the data */
1535 ret = bdrv_pwrite(bs, 0, &magic, sizeof(magic));
1537 error_set(errp, QERR_IO_ERROR);
1540 ret = bdrv_pwrite(bs, sizeof(magic), &header, sizeof(header));
1542 error_set(errp, QERR_IO_ERROR);
1546 ret = bdrv_truncate(bs, le64_to_cpu(header.grain_offset) << 9);
1548 error_setg(errp, "Could not truncate file");
1552 /* write grain directory */
1553 gd_buf_size = gd_sectors * BDRV_SECTOR_SIZE;
1554 gd_buf = g_malloc0(gd_buf_size);
1555 for (i = 0, tmp = le64_to_cpu(header.rgd_offset) + gd_sectors;
1556 i < gt_count; i++, tmp += gt_size) {
1557 gd_buf[i] = cpu_to_le32(tmp);
1559 ret = bdrv_pwrite(bs, le64_to_cpu(header.rgd_offset) * BDRV_SECTOR_SIZE,
1560 gd_buf, gd_buf_size);
1562 error_set(errp, QERR_IO_ERROR);
1566 /* write backup grain directory */
1567 for (i = 0, tmp = le64_to_cpu(header.gd_offset) + gd_sectors;
1568 i < gt_count; i++, tmp += gt_size) {
1569 gd_buf[i] = cpu_to_le32(tmp);
1571 ret = bdrv_pwrite(bs, le64_to_cpu(header.gd_offset) * BDRV_SECTOR_SIZE,
1572 gd_buf, gd_buf_size);
1574 error_set(errp, QERR_IO_ERROR);
1587 static int filename_decompose(const char *filename, char *path, char *prefix,
1588 char *postfix, size_t buf_len, Error **errp)
1592 if (filename == NULL || !strlen(filename)) {
1593 error_setg(errp, "No filename provided");
1596 p = strrchr(filename, '/');
1598 p = strrchr(filename, '\\');
1601 p = strrchr(filename, ':');
1605 if (p - filename >= buf_len) {
1608 pstrcpy(path, p - filename + 1, filename);
1613 q = strrchr(p, '.');
1615 pstrcpy(prefix, buf_len, p);
1618 if (q - p >= buf_len) {
1621 pstrcpy(prefix, q - p + 1, p);
1622 pstrcpy(postfix, buf_len, q);
1627 static int vmdk_create(const char *filename, QEMUOptionParameter *options,
1631 BlockDriverState *new_bs = NULL;
1634 int64_t total_size = 0, filesize;
1635 const char *adapter_type = NULL;
1636 const char *backing_file = NULL;
1637 const char *fmt = NULL;
1640 bool flat, split, compress;
1641 GString *ext_desc_lines;
1642 char path[PATH_MAX], prefix[PATH_MAX], postfix[PATH_MAX];
1643 const int64_t split_size = 0x80000000; /* VMDK has constant split size */
1644 const char *desc_extent_line;
1645 char parent_desc_line[BUF_SIZE] = "";
1646 uint32_t parent_cid = 0xffffffff;
1647 uint32_t number_heads = 16;
1648 bool zeroed_grain = false;
1649 uint32_t desc_offset = 0, desc_len;
1650 const char desc_template[] =
1651 "# Disk DescriptorFile\n"
1655 "createType=\"%s\"\n"
1658 "# Extent description\n"
1661 "# The Disk Data Base\n"
1664 "ddb.virtualHWVersion = \"%d\"\n"
1665 "ddb.geometry.cylinders = \"%" PRId64 "\"\n"
1666 "ddb.geometry.heads = \"%d\"\n"
1667 "ddb.geometry.sectors = \"63\"\n"
1668 "ddb.adapterType = \"%s\"\n";
1670 ext_desc_lines = g_string_new(NULL);
1672 if (filename_decompose(filename, path, prefix, postfix, PATH_MAX, errp)) {
1676 /* Read out options */
1677 while (options && options->name) {
1678 if (!strcmp(options->name, BLOCK_OPT_SIZE)) {
1679 total_size = options->value.n;
1680 } else if (!strcmp(options->name, BLOCK_OPT_ADAPTER_TYPE)) {
1681 adapter_type = options->value.s;
1682 } else if (!strcmp(options->name, BLOCK_OPT_BACKING_FILE)) {
1683 backing_file = options->value.s;
1684 } else if (!strcmp(options->name, BLOCK_OPT_COMPAT6)) {
1685 flags |= options->value.n ? BLOCK_FLAG_COMPAT6 : 0;
1686 } else if (!strcmp(options->name, BLOCK_OPT_SUBFMT)) {
1687 fmt = options->value.s;
1688 } else if (!strcmp(options->name, BLOCK_OPT_ZEROED_GRAIN)) {
1689 zeroed_grain |= options->value.n;
1693 if (!adapter_type) {
1694 adapter_type = "ide";
1695 } else if (strcmp(adapter_type, "ide") &&
1696 strcmp(adapter_type, "buslogic") &&
1697 strcmp(adapter_type, "lsilogic") &&
1698 strcmp(adapter_type, "legacyESX")) {
1699 error_setg(errp, "Unknown adapter type: '%s'", adapter_type);
1703 if (strcmp(adapter_type, "ide") != 0) {
1704 /* that's the number of heads with which vmware operates when
1705 creating, exporting, etc. vmdk files with a non-ide adapter type */
1709 /* Default format to monolithicSparse */
1710 fmt = "monolithicSparse";
1711 } else if (strcmp(fmt, "monolithicFlat") &&
1712 strcmp(fmt, "monolithicSparse") &&
1713 strcmp(fmt, "twoGbMaxExtentSparse") &&
1714 strcmp(fmt, "twoGbMaxExtentFlat") &&
1715 strcmp(fmt, "streamOptimized")) {
1716 error_setg(errp, "Unknown subformat: '%s'", fmt);
1720 split = !(strcmp(fmt, "twoGbMaxExtentFlat") &&
1721 strcmp(fmt, "twoGbMaxExtentSparse"));
1722 flat = !(strcmp(fmt, "monolithicFlat") &&
1723 strcmp(fmt, "twoGbMaxExtentFlat"));
1724 compress = !strcmp(fmt, "streamOptimized");
1726 desc_extent_line = "RW %lld FLAT \"%s\" 0\n";
1728 desc_extent_line = "RW %lld SPARSE \"%s\"\n";
1730 if (flat && backing_file) {
1731 error_setg(errp, "Flat image can't have backing file");
1735 if (flat && zeroed_grain) {
1736 error_setg(errp, "Flat image can't enable zeroed grain");
1741 BlockDriverState *bs = bdrv_new("");
1742 ret = bdrv_open(bs, backing_file, NULL, BDRV_O_NO_BACKING, NULL, errp);
1747 if (strcmp(bs->drv->format_name, "vmdk")) {
1752 parent_cid = vmdk_read_cid(bs, 0);
1754 snprintf(parent_desc_line, sizeof(parent_desc_line),
1755 "parentFileNameHint=\"%s\"", backing_file);
1758 /* Create extents */
1759 filesize = total_size;
1760 while (filesize > 0) {
1761 char desc_line[BUF_SIZE];
1762 char ext_filename[PATH_MAX];
1763 char desc_filename[PATH_MAX];
1764 int64_t size = filesize;
1766 if (split && size > split_size) {
1770 snprintf(desc_filename, sizeof(desc_filename), "%s-%c%03d%s",
1771 prefix, flat ? 'f' : 's', ++idx, postfix);
1773 snprintf(desc_filename, sizeof(desc_filename), "%s-flat%s",
1776 snprintf(desc_filename, sizeof(desc_filename), "%s%s",
1779 snprintf(ext_filename, sizeof(ext_filename), "%s%s",
1780 path, desc_filename);
1782 if (vmdk_create_extent(ext_filename, size,
1783 flat, compress, zeroed_grain, errp)) {
1789 /* Format description line */
1790 snprintf(desc_line, sizeof(desc_line),
1791 desc_extent_line, size / BDRV_SECTOR_SIZE, desc_filename);
1792 g_string_append(ext_desc_lines, desc_line);
1794 /* generate descriptor file */
1795 desc = g_strdup_printf(desc_template,
1796 (unsigned int)time(NULL),
1800 ext_desc_lines->str,
1801 (flags & BLOCK_FLAG_COMPAT6 ? 6 : 4),
1803 (int64_t)(63 * number_heads * BDRV_SECTOR_SIZE),
1806 desc_len = strlen(desc);
1807 /* the descriptor offset = 0x200 */
1808 if (!split && !flat) {
1809 desc_offset = 0x200;
1811 ret = bdrv_create_file(filename, options, &local_err);
1813 error_setg_errno(errp, -ret, "Could not create image file");
1817 ret = bdrv_file_open(&new_bs, filename, NULL, NULL, BDRV_O_RDWR, &local_err);
1819 error_setg_errno(errp, -ret, "Could not write description");
1822 ret = bdrv_pwrite(new_bs, desc_offset, desc, desc_len);
1824 error_setg_errno(errp, -ret, "Could not write description");
1827 /* bdrv_pwrite write padding zeros to align to sector, we don't need that
1828 * for description file */
1829 if (desc_offset == 0) {
1830 ret = bdrv_truncate(new_bs, desc_len);
1832 error_setg(errp, "Could not truncate file");
1840 g_string_free(ext_desc_lines, true);
1844 static void vmdk_close(BlockDriverState *bs)
1846 BDRVVmdkState *s = bs->opaque;
1848 vmdk_free_extents(bs);
1849 g_free(s->create_type);
1851 migrate_del_blocker(s->migration_blocker);
1852 error_free(s->migration_blocker);
1855 static coroutine_fn int vmdk_co_flush(BlockDriverState *bs)
1857 BDRVVmdkState *s = bs->opaque;
1861 for (i = 0; i < s->num_extents; i++) {
1862 err = bdrv_co_flush(s->extents[i].file);
1870 static int64_t vmdk_get_allocated_file_size(BlockDriverState *bs)
1875 BDRVVmdkState *s = bs->opaque;
1877 ret = bdrv_get_allocated_file_size(bs->file);
1881 for (i = 0; i < s->num_extents; i++) {
1882 if (s->extents[i].file == bs->file) {
1885 r = bdrv_get_allocated_file_size(s->extents[i].file);
1894 static int vmdk_has_zero_init(BlockDriverState *bs)
1897 BDRVVmdkState *s = bs->opaque;
1899 /* If has a flat extent and its underlying storage doesn't have zero init,
1901 for (i = 0; i < s->num_extents; i++) {
1902 if (s->extents[i].flat) {
1903 if (!bdrv_has_zero_init(s->extents[i].file)) {
1911 static ImageInfo *vmdk_get_extent_info(VmdkExtent *extent)
1913 ImageInfo *info = g_new0(ImageInfo, 1);
1915 *info = (ImageInfo){
1916 .filename = g_strdup(extent->file->filename),
1917 .format = g_strdup(extent->type),
1918 .virtual_size = extent->sectors * BDRV_SECTOR_SIZE,
1919 .compressed = extent->compressed,
1920 .has_compressed = extent->compressed,
1921 .cluster_size = extent->cluster_sectors * BDRV_SECTOR_SIZE,
1922 .has_cluster_size = !extent->flat,
1928 static ImageInfoSpecific *vmdk_get_specific_info(BlockDriverState *bs)
1931 BDRVVmdkState *s = bs->opaque;
1932 ImageInfoSpecific *spec_info = g_new0(ImageInfoSpecific, 1);
1933 ImageInfoList **next;
1935 *spec_info = (ImageInfoSpecific){
1936 .kind = IMAGE_INFO_SPECIFIC_KIND_VMDK,
1938 .vmdk = g_new0(ImageInfoSpecificVmdk, 1),
1942 *spec_info->vmdk = (ImageInfoSpecificVmdk) {
1943 .create_type = g_strdup(s->create_type),
1945 .parent_cid = s->parent_cid,
1948 next = &spec_info->vmdk->extents;
1949 for (i = 0; i < s->num_extents; i++) {
1950 *next = g_new0(ImageInfoList, 1);
1951 (*next)->value = vmdk_get_extent_info(&s->extents[i]);
1952 (*next)->next = NULL;
1953 next = &(*next)->next;
1959 static QEMUOptionParameter vmdk_create_options[] = {
1961 .name = BLOCK_OPT_SIZE,
1963 .help = "Virtual disk size"
1966 .name = BLOCK_OPT_ADAPTER_TYPE,
1968 .help = "Virtual adapter type, can be one of "
1969 "ide (default), lsilogic, buslogic or legacyESX"
1972 .name = BLOCK_OPT_BACKING_FILE,
1974 .help = "File name of a base image"
1977 .name = BLOCK_OPT_COMPAT6,
1979 .help = "VMDK version 6 image"
1982 .name = BLOCK_OPT_SUBFMT,
1985 "VMDK flat extent format, can be one of "
1986 "{monolithicSparse (default) | monolithicFlat | twoGbMaxExtentSparse | twoGbMaxExtentFlat | streamOptimized} "
1989 .name = BLOCK_OPT_ZEROED_GRAIN,
1991 .help = "Enable efficient zero writes using the zeroed-grain GTE feature"
1996 static BlockDriver bdrv_vmdk = {
1997 .format_name = "vmdk",
1998 .instance_size = sizeof(BDRVVmdkState),
1999 .bdrv_probe = vmdk_probe,
2000 .bdrv_open = vmdk_open,
2001 .bdrv_reopen_prepare = vmdk_reopen_prepare,
2002 .bdrv_read = vmdk_co_read,
2003 .bdrv_write = vmdk_co_write,
2004 .bdrv_co_write_zeroes = vmdk_co_write_zeroes,
2005 .bdrv_close = vmdk_close,
2006 .bdrv_create = vmdk_create,
2007 .bdrv_co_flush_to_disk = vmdk_co_flush,
2008 .bdrv_co_get_block_status = vmdk_co_get_block_status,
2009 .bdrv_get_allocated_file_size = vmdk_get_allocated_file_size,
2010 .bdrv_has_zero_init = vmdk_has_zero_init,
2011 .bdrv_get_specific_info = vmdk_get_specific_info,
2013 .create_options = vmdk_create_options,
2016 static void bdrv_vmdk_init(void)
2018 bdrv_register(&bdrv_vmdk);
2021 block_init(bdrv_vmdk_init);