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/osdep.h"
27 #include "qapi/error.h"
28 #include "block/block_int.h"
29 #include "sysemu/block-backend.h"
30 #include "qapi/qmp/qdict.h"
31 #include "qapi/qmp/qerror.h"
32 #include "qemu/error-report.h"
33 #include "qemu/module.h"
34 #include "qemu/option.h"
35 #include "qemu/bswap.h"
36 #include "qemu/memalign.h"
37 #include "migration/blocker.h"
38 #include "qemu/cutils.h"
41 #define VMDK3_MAGIC (('C' << 24) | ('O' << 16) | ('W' << 8) | 'D')
42 #define VMDK4_MAGIC (('K' << 24) | ('D' << 16) | ('M' << 8) | 'V')
43 #define VMDK4_COMPRESSION_DEFLATE 1
44 #define VMDK4_FLAG_NL_DETECT (1 << 0)
45 #define VMDK4_FLAG_RGD (1 << 1)
46 /* Zeroed-grain enable bit */
47 #define VMDK4_FLAG_ZERO_GRAIN (1 << 2)
48 #define VMDK4_FLAG_COMPRESS (1 << 16)
49 #define VMDK4_FLAG_MARKER (1 << 17)
50 #define VMDK4_GD_AT_END 0xffffffffffffffffULL
52 #define VMDK_EXTENT_MAX_SECTORS (1ULL << 32)
54 #define VMDK_GTE_ZEROED 0x1
56 /* VMDK internal error codes */
58 #define VMDK_ERROR (-1)
59 /* Cluster not allocated */
60 #define VMDK_UNALLOC (-2)
61 #define VMDK_ZEROED (-3)
63 #define BLOCK_OPT_ZEROED_GRAIN "zeroed_grain"
64 #define BLOCK_OPT_TOOLSVERSION "toolsversion"
69 uint32_t disk_sectors;
71 uint32_t l1dir_offset;
73 uint32_t file_sectors;
76 uint32_t sectors_per_track;
77 } QEMU_PACKED VMDK3Header;
86 /* Number of GrainTableEntries per GrainTable */
87 uint32_t num_gtes_per_gt;
90 uint64_t grain_offset;
93 uint16_t compressAlgorithm;
94 } QEMU_PACKED VMDK4Header;
96 typedef struct VMDKSESparseConstHeader {
101 uint64_t grain_table_size;
107 uint64_t volatile_header_offset;
108 uint64_t volatile_header_size;
109 uint64_t journal_header_offset;
110 uint64_t journal_header_size;
111 uint64_t journal_offset;
112 uint64_t journal_size;
113 uint64_t grain_dir_offset;
114 uint64_t grain_dir_size;
115 uint64_t grain_tables_offset;
116 uint64_t grain_tables_size;
117 uint64_t free_bitmap_offset;
118 uint64_t free_bitmap_size;
119 uint64_t backmap_offset;
120 uint64_t backmap_size;
121 uint64_t grains_offset;
122 uint64_t grains_size;
124 } QEMU_PACKED VMDKSESparseConstHeader;
126 typedef struct VMDKSESparseVolatileHeader {
128 uint64_t free_gt_number;
129 uint64_t next_txn_seq_number;
130 uint64_t replay_journal;
132 } QEMU_PACKED VMDKSESparseVolatileHeader;
134 #define L2_CACHE_SIZE 16
136 typedef struct VmdkExtent {
143 uint64_t sesparse_l2_tables_offset;
144 uint64_t sesparse_clusters_offset;
149 int64_t flat_start_offset;
150 int64_t l1_table_offset;
151 int64_t l1_backup_table_offset;
153 uint32_t *l1_backup_table;
154 unsigned int l1_size;
155 uint32_t l1_entry_sectors;
157 unsigned int l2_size;
159 uint32_t l2_cache_offsets[L2_CACHE_SIZE];
160 uint32_t l2_cache_counts[L2_CACHE_SIZE];
162 int64_t cluster_sectors;
163 int64_t next_cluster_sector;
167 typedef struct BDRVVmdkState {
169 uint64_t desc_offset;
175 /* Extent array with num_extents entries, ascend ordered by address */
177 Error *migration_blocker;
181 typedef struct BDRVVmdkReopenState {
182 bool *extents_using_bs_file;
183 } BDRVVmdkReopenState;
185 typedef struct VmdkMetaData {
186 unsigned int l1_index;
187 unsigned int l2_index;
188 unsigned int l2_offset;
190 uint32_t *l2_cache_entry;
193 typedef struct VmdkGrainMarker {
197 } QEMU_PACKED VmdkGrainMarker;
200 MARKER_END_OF_STREAM = 0,
201 MARKER_GRAIN_TABLE = 1,
202 MARKER_GRAIN_DIRECTORY = 2,
206 static int vmdk_probe(const uint8_t *buf, int buf_size, const char *filename)
213 magic = be32_to_cpu(*(uint32_t *)buf);
214 if (magic == VMDK3_MAGIC ||
215 magic == VMDK4_MAGIC) {
218 const char *p = (const char *)buf;
219 const char *end = p + buf_size;
222 /* skip comment line */
223 while (p < end && *p != '\n') {
230 while (p < end && *p == ' ') {
233 /* skip '\r' if windows line endings used. */
234 if (p < end && *p == '\r') {
237 /* only accept blank lines before 'version=' line */
238 if (p == end || *p != '\n') {
244 if (end - p >= strlen("version=X\n")) {
245 if (strncmp("version=1\n", p, strlen("version=1\n")) == 0 ||
246 strncmp("version=2\n", p, strlen("version=2\n")) == 0 ||
247 strncmp("version=3\n", p, strlen("version=3\n")) == 0) {
251 if (end - p >= strlen("version=X\r\n")) {
252 if (strncmp("version=1\r\n", p, strlen("version=1\r\n")) == 0 ||
253 strncmp("version=2\r\n", p, strlen("version=2\r\n")) == 0 ||
254 strncmp("version=3\r\n", p, strlen("version=3\r\n")) == 0) {
264 #define SECTOR_SIZE 512
265 #define DESC_SIZE (20 * SECTOR_SIZE) /* 20 sectors of 512 bytes each */
266 #define BUF_SIZE 4096
267 #define HEADER_SIZE 512 /* first sector of 512 bytes */
269 static void vmdk_free_extents(BlockDriverState *bs)
272 BDRVVmdkState *s = bs->opaque;
275 for (i = 0; i < s->num_extents; i++) {
279 g_free(e->l1_backup_table);
281 if (e->file != bs->file) {
282 bdrv_unref_child(bs, e->file);
288 static void vmdk_free_last_extent(BlockDriverState *bs)
290 BDRVVmdkState *s = bs->opaque;
292 if (s->num_extents == 0) {
296 s->extents = g_renew(VmdkExtent, s->extents, s->num_extents);
299 /* Return -ve errno, or 0 on success and write CID into *pcid. */
300 static int vmdk_read_cid(BlockDriverState *bs, int parent, uint32_t *pcid)
304 const char *p_name, *cid_str;
306 BDRVVmdkState *s = bs->opaque;
309 desc = g_malloc0(DESC_SIZE);
310 ret = bdrv_pread(bs->file, s->desc_offset, DESC_SIZE, desc, 0);
316 cid_str = "parentCID";
317 cid_str_size = sizeof("parentCID");
320 cid_str_size = sizeof("CID");
323 desc[DESC_SIZE - 1] = '\0';
324 p_name = strstr(desc, cid_str);
325 if (p_name == NULL) {
329 p_name += cid_str_size;
330 if (sscanf(p_name, "%" SCNx32, &cid) != 1) {
342 static int coroutine_fn GRAPH_RDLOCK
343 vmdk_write_cid(BlockDriverState *bs, uint32_t cid)
345 char *desc, *tmp_desc;
346 char *p_name, *tmp_str;
347 BDRVVmdkState *s = bs->opaque;
350 desc = g_malloc0(DESC_SIZE);
351 tmp_desc = g_malloc0(DESC_SIZE);
352 ret = bdrv_co_pread(bs->file, s->desc_offset, DESC_SIZE, desc, 0);
357 desc[DESC_SIZE - 1] = '\0';
358 tmp_str = strstr(desc, "parentCID");
359 if (tmp_str == NULL) {
364 pstrcpy(tmp_desc, DESC_SIZE, tmp_str);
365 p_name = strstr(desc, "CID");
366 if (p_name != NULL) {
367 p_name += sizeof("CID");
368 snprintf(p_name, DESC_SIZE - (p_name - desc), "%" PRIx32 "\n", cid);
369 pstrcat(desc, DESC_SIZE, tmp_desc);
372 ret = bdrv_co_pwrite_sync(bs->file, s->desc_offset, DESC_SIZE, desc, 0);
380 static int coroutine_fn vmdk_is_cid_valid(BlockDriverState *bs)
382 BDRVVmdkState *s = bs->opaque;
385 if (!s->cid_checked && bs->backing) {
386 BlockDriverState *p_bs = bs->backing->bs;
388 if (strcmp(p_bs->drv->format_name, "vmdk")) {
389 /* Backing file is not in vmdk format, so it does not have
390 * a CID, which makes the overlay's parent CID invalid */
394 if (vmdk_read_cid(p_bs, 0, &cur_pcid) != 0) {
395 /* read failure: report as not valid */
398 if (s->parent_cid != cur_pcid) {
403 s->cid_checked = true;
408 static int vmdk_reopen_prepare(BDRVReopenState *state,
409 BlockReopenQueue *queue, Error **errp)
412 BDRVVmdkReopenState *rs;
415 assert(state != NULL);
416 assert(state->bs != NULL);
417 assert(state->opaque == NULL);
419 s = state->bs->opaque;
421 rs = g_new0(BDRVVmdkReopenState, 1);
425 * Check whether there are any extents stored in bs->file; if bs->file
426 * changes, we will need to update their .file pointers to follow suit
428 rs->extents_using_bs_file = g_new(bool, s->num_extents);
429 for (i = 0; i < s->num_extents; i++) {
430 rs->extents_using_bs_file[i] = s->extents[i].file == state->bs->file;
436 static void vmdk_reopen_clean(BDRVReopenState *state)
438 BDRVVmdkReopenState *rs = state->opaque;
440 g_free(rs->extents_using_bs_file);
442 state->opaque = NULL;
445 static void vmdk_reopen_commit(BDRVReopenState *state)
447 BDRVVmdkState *s = state->bs->opaque;
448 BDRVVmdkReopenState *rs = state->opaque;
451 for (i = 0; i < s->num_extents; i++) {
452 if (rs->extents_using_bs_file[i]) {
453 s->extents[i].file = state->bs->file;
457 vmdk_reopen_clean(state);
460 static void vmdk_reopen_abort(BDRVReopenState *state)
462 vmdk_reopen_clean(state);
465 static int vmdk_parent_open(BlockDriverState *bs)
469 BDRVVmdkState *s = bs->opaque;
472 desc = g_malloc0(DESC_SIZE + 1);
473 ret = bdrv_pread(bs->file, s->desc_offset, DESC_SIZE, desc, 0);
478 p_name = strstr(desc, "parentFileNameHint");
479 if (p_name != NULL) {
482 p_name += sizeof("parentFileNameHint") + 1;
483 end_name = strchr(p_name, '\"');
484 if (end_name == NULL) {
488 if ((end_name - p_name) > sizeof(bs->auto_backing_file) - 1) {
493 pstrcpy(bs->auto_backing_file, end_name - p_name + 1, p_name);
494 pstrcpy(bs->backing_file, sizeof(bs->backing_file),
495 bs->auto_backing_file);
496 pstrcpy(bs->backing_format, sizeof(bs->backing_format),
505 /* Create and append extent to the extent array. Return the added VmdkExtent
506 * address. return NULL if allocation failed. */
507 static int vmdk_add_extent(BlockDriverState *bs,
508 BdrvChild *file, bool flat, int64_t sectors,
509 int64_t l1_offset, int64_t l1_backup_offset,
511 int l2_size, uint64_t cluster_sectors,
512 VmdkExtent **new_extent,
516 BDRVVmdkState *s = bs->opaque;
519 if (cluster_sectors > 0x200000) {
520 /* 0x200000 * 512Bytes = 1GB for one cluster is unrealistic */
521 error_setg(errp, "Invalid granularity, image may be corrupt");
524 if (l1_size > 32 * 1024 * 1024) {
526 * Although with big capacity and small l1_entry_sectors, we can get a
527 * big l1_size, we don't want unbounded value to allocate the table.
528 * Limit it to 32M, which is enough to store:
529 * 8TB - for both VMDK3 & VMDK4 with
530 * minimal cluster size: 512B
531 * minimal L2 table size: 512 entries
532 * 8 TB is still more than the maximal value supported for
533 * VMDK3 & VMDK4 which is 2TB.
534 * 64TB - for "ESXi seSparse Extent"
535 * minimal cluster size: 512B (default is 4KB)
536 * L2 table size: 4096 entries (const).
537 * 64TB is more than the maximal value supported for
538 * seSparse VMDKs (which is slightly less than 64TB)
540 error_setg(errp, "L1 size too big");
544 nb_sectors = bdrv_nb_sectors(file->bs);
545 if (nb_sectors < 0) {
549 s->extents = g_renew(VmdkExtent, s->extents, s->num_extents + 1);
550 extent = &s->extents[s->num_extents];
553 memset(extent, 0, sizeof(VmdkExtent));
556 extent->sectors = sectors;
557 extent->l1_table_offset = l1_offset;
558 extent->l1_backup_table_offset = l1_backup_offset;
559 extent->l1_size = l1_size;
560 extent->l1_entry_sectors = l2_size * cluster_sectors;
561 extent->l2_size = l2_size;
562 extent->cluster_sectors = flat ? sectors : cluster_sectors;
563 extent->next_cluster_sector = ROUND_UP(nb_sectors, cluster_sectors);
564 extent->entry_size = sizeof(uint32_t);
566 if (s->num_extents > 1) {
567 extent->end_sector = (*(extent - 1)).end_sector + extent->sectors;
569 extent->end_sector = extent->sectors;
571 bs->total_sectors = extent->end_sector;
573 *new_extent = extent;
578 static int vmdk_init_tables(BlockDriverState *bs, VmdkExtent *extent,
585 /* read the L1 table */
586 l1_size = extent->l1_size * extent->entry_size;
587 extent->l1_table = g_try_malloc(l1_size);
588 if (l1_size && extent->l1_table == NULL) {
592 ret = bdrv_pread(extent->file, extent->l1_table_offset, l1_size,
593 extent->l1_table, 0);
595 bdrv_refresh_filename(extent->file->bs);
596 error_setg_errno(errp, -ret,
597 "Could not read l1 table from extent '%s'",
598 extent->file->bs->filename);
601 for (i = 0; i < extent->l1_size; i++) {
602 if (extent->entry_size == sizeof(uint64_t)) {
603 le64_to_cpus((uint64_t *)extent->l1_table + i);
605 assert(extent->entry_size == sizeof(uint32_t));
606 le32_to_cpus((uint32_t *)extent->l1_table + i);
610 if (extent->l1_backup_table_offset) {
611 assert(!extent->sesparse);
612 extent->l1_backup_table = g_try_malloc(l1_size);
613 if (l1_size && extent->l1_backup_table == NULL) {
617 ret = bdrv_pread(extent->file, extent->l1_backup_table_offset,
618 l1_size, extent->l1_backup_table, 0);
620 bdrv_refresh_filename(extent->file->bs);
621 error_setg_errno(errp, -ret,
622 "Could not read l1 backup table from extent '%s'",
623 extent->file->bs->filename);
626 for (i = 0; i < extent->l1_size; i++) {
627 le32_to_cpus(&extent->l1_backup_table[i]);
632 g_malloc(extent->entry_size * extent->l2_size * L2_CACHE_SIZE);
635 g_free(extent->l1_backup_table);
637 g_free(extent->l1_table);
641 static int vmdk_open_vmfs_sparse(BlockDriverState *bs,
643 int flags, Error **errp)
648 VmdkExtent *extent = NULL;
650 ret = bdrv_pread(file, sizeof(magic), sizeof(header), &header, 0);
652 bdrv_refresh_filename(file->bs);
653 error_setg_errno(errp, -ret,
654 "Could not read header from file '%s'",
658 ret = vmdk_add_extent(bs, file, false,
659 le32_to_cpu(header.disk_sectors),
660 (int64_t)le32_to_cpu(header.l1dir_offset) << 9,
662 le32_to_cpu(header.l1dir_size),
664 le32_to_cpu(header.granularity),
670 ret = vmdk_init_tables(bs, extent, errp);
672 /* free extent allocated by vmdk_add_extent */
673 vmdk_free_last_extent(bs);
678 #define SESPARSE_CONST_HEADER_MAGIC UINT64_C(0x00000000cafebabe)
679 #define SESPARSE_VOLATILE_HEADER_MAGIC UINT64_C(0x00000000cafecafe)
681 /* Strict checks - format not officially documented */
682 static int check_se_sparse_const_header(VMDKSESparseConstHeader *header,
685 header->magic = le64_to_cpu(header->magic);
686 header->version = le64_to_cpu(header->version);
687 header->grain_size = le64_to_cpu(header->grain_size);
688 header->grain_table_size = le64_to_cpu(header->grain_table_size);
689 header->flags = le64_to_cpu(header->flags);
690 header->reserved1 = le64_to_cpu(header->reserved1);
691 header->reserved2 = le64_to_cpu(header->reserved2);
692 header->reserved3 = le64_to_cpu(header->reserved3);
693 header->reserved4 = le64_to_cpu(header->reserved4);
695 header->volatile_header_offset =
696 le64_to_cpu(header->volatile_header_offset);
697 header->volatile_header_size = le64_to_cpu(header->volatile_header_size);
699 header->journal_header_offset = le64_to_cpu(header->journal_header_offset);
700 header->journal_header_size = le64_to_cpu(header->journal_header_size);
702 header->journal_offset = le64_to_cpu(header->journal_offset);
703 header->journal_size = le64_to_cpu(header->journal_size);
705 header->grain_dir_offset = le64_to_cpu(header->grain_dir_offset);
706 header->grain_dir_size = le64_to_cpu(header->grain_dir_size);
708 header->grain_tables_offset = le64_to_cpu(header->grain_tables_offset);
709 header->grain_tables_size = le64_to_cpu(header->grain_tables_size);
711 header->free_bitmap_offset = le64_to_cpu(header->free_bitmap_offset);
712 header->free_bitmap_size = le64_to_cpu(header->free_bitmap_size);
714 header->backmap_offset = le64_to_cpu(header->backmap_offset);
715 header->backmap_size = le64_to_cpu(header->backmap_size);
717 header->grains_offset = le64_to_cpu(header->grains_offset);
718 header->grains_size = le64_to_cpu(header->grains_size);
720 if (header->magic != SESPARSE_CONST_HEADER_MAGIC) {
721 error_setg(errp, "Bad const header magic: 0x%016" PRIx64,
726 if (header->version != 0x0000000200000001) {
727 error_setg(errp, "Unsupported version: 0x%016" PRIx64,
732 if (header->grain_size != 8) {
733 error_setg(errp, "Unsupported grain size: %" PRIu64,
738 if (header->grain_table_size != 64) {
739 error_setg(errp, "Unsupported grain table size: %" PRIu64,
740 header->grain_table_size);
744 if (header->flags != 0) {
745 error_setg(errp, "Unsupported flags: 0x%016" PRIx64,
750 if (header->reserved1 != 0 || header->reserved2 != 0 ||
751 header->reserved3 != 0 || header->reserved4 != 0) {
752 error_setg(errp, "Unsupported reserved bits:"
753 " 0x%016" PRIx64 " 0x%016" PRIx64
754 " 0x%016" PRIx64 " 0x%016" PRIx64,
755 header->reserved1, header->reserved2,
756 header->reserved3, header->reserved4);
760 /* check that padding is 0 */
761 if (!buffer_is_zero(header->pad, sizeof(header->pad))) {
762 error_setg(errp, "Unsupported non-zero const header padding");
769 static int check_se_sparse_volatile_header(VMDKSESparseVolatileHeader *header,
772 header->magic = le64_to_cpu(header->magic);
773 header->free_gt_number = le64_to_cpu(header->free_gt_number);
774 header->next_txn_seq_number = le64_to_cpu(header->next_txn_seq_number);
775 header->replay_journal = le64_to_cpu(header->replay_journal);
777 if (header->magic != SESPARSE_VOLATILE_HEADER_MAGIC) {
778 error_setg(errp, "Bad volatile header magic: 0x%016" PRIx64,
783 if (header->replay_journal) {
784 error_setg(errp, "Image is dirty, Replaying journal not supported");
788 /* check that padding is 0 */
789 if (!buffer_is_zero(header->pad, sizeof(header->pad))) {
790 error_setg(errp, "Unsupported non-zero volatile header padding");
797 static int vmdk_open_se_sparse(BlockDriverState *bs,
799 int flags, Error **errp)
802 VMDKSESparseConstHeader const_header;
803 VMDKSESparseVolatileHeader volatile_header;
804 VmdkExtent *extent = NULL;
806 ret = bdrv_apply_auto_read_only(bs,
807 "No write support for seSparse images available", errp);
812 assert(sizeof(const_header) == SECTOR_SIZE);
814 ret = bdrv_pread(file, 0, sizeof(const_header), &const_header, 0);
816 bdrv_refresh_filename(file->bs);
817 error_setg_errno(errp, -ret,
818 "Could not read const header from file '%s'",
823 /* check const header */
824 ret = check_se_sparse_const_header(&const_header, errp);
829 assert(sizeof(volatile_header) == SECTOR_SIZE);
831 ret = bdrv_pread(file, const_header.volatile_header_offset * SECTOR_SIZE,
832 sizeof(volatile_header), &volatile_header, 0);
834 bdrv_refresh_filename(file->bs);
835 error_setg_errno(errp, -ret,
836 "Could not read volatile header from file '%s'",
841 /* check volatile header */
842 ret = check_se_sparse_volatile_header(&volatile_header, errp);
847 ret = vmdk_add_extent(bs, file, false,
848 const_header.capacity,
849 const_header.grain_dir_offset * SECTOR_SIZE,
851 const_header.grain_dir_size *
852 SECTOR_SIZE / sizeof(uint64_t),
853 const_header.grain_table_size *
854 SECTOR_SIZE / sizeof(uint64_t),
855 const_header.grain_size,
862 extent->sesparse = true;
863 extent->sesparse_l2_tables_offset = const_header.grain_tables_offset;
864 extent->sesparse_clusters_offset = const_header.grains_offset;
865 extent->entry_size = sizeof(uint64_t);
867 ret = vmdk_init_tables(bs, extent, errp);
869 /* free extent allocated by vmdk_add_extent */
870 vmdk_free_last_extent(bs);
876 static int vmdk_open_desc_file(BlockDriverState *bs, int flags, char *buf,
877 QDict *options, Error **errp);
879 static char *vmdk_read_desc(BdrvChild *file, uint64_t desc_offset, Error **errp)
885 size = bdrv_getlength(file->bs);
887 error_setg_errno(errp, -size, "Could not access file");
892 /* Both descriptor file and sparse image must be much larger than 4
893 * bytes, also callers of vmdk_read_desc want to compare the first 4
894 * bytes with VMDK4_MAGIC, let's error out if less is read. */
895 error_setg(errp, "File is too small, not a valid image");
899 size = MIN(size, (1 << 20) - 1); /* avoid unbounded allocation */
900 buf = g_malloc(size + 1);
902 ret = bdrv_pread(file, desc_offset, size, buf, 0);
904 error_setg_errno(errp, -ret, "Could not read from file");
913 static int vmdk_open_vmdk4(BlockDriverState *bs,
915 int flags, QDict *options, Error **errp)
919 uint32_t l1_size, l1_entry_sectors;
921 VmdkExtent *extent = NULL;
922 BDRVVmdkState *s = bs->opaque;
923 int64_t l1_backup_offset = 0;
926 ret = bdrv_pread(file, sizeof(magic), sizeof(header), &header, 0);
928 bdrv_refresh_filename(file->bs);
929 error_setg_errno(errp, -ret,
930 "Could not read header from file '%s'",
934 if (header.capacity == 0) {
935 uint64_t desc_offset = le64_to_cpu(header.desc_offset);
937 char *buf = vmdk_read_desc(file, desc_offset << 9, errp);
941 ret = vmdk_open_desc_file(bs, flags, buf, options, errp);
947 if (!s->create_type) {
948 s->create_type = g_strdup("monolithicSparse");
951 if (le64_to_cpu(header.gd_offset) == VMDK4_GD_AT_END) {
953 * The footer takes precedence over the header, so read it in. The
954 * footer starts at offset -1024 from the end: One sector for the
955 * footer, and another one for the end-of-stream marker.
962 uint8_t pad[512 - 16];
963 } QEMU_PACKED footer_marker;
967 uint8_t pad[512 - 4 - sizeof(VMDK4Header)];
973 uint8_t pad[512 - 16];
974 } QEMU_PACKED eos_marker;
975 } QEMU_PACKED footer;
977 ret = bdrv_pread(file, bs->file->bs->total_sectors * 512 - 1536,
978 sizeof(footer), &footer, 0);
980 error_setg_errno(errp, -ret, "Failed to read footer");
984 /* Some sanity checks for the footer */
985 if (be32_to_cpu(footer.magic) != VMDK4_MAGIC ||
986 le32_to_cpu(footer.footer_marker.size) != 0 ||
987 le32_to_cpu(footer.footer_marker.type) != MARKER_FOOTER ||
988 le64_to_cpu(footer.eos_marker.val) != 0 ||
989 le32_to_cpu(footer.eos_marker.size) != 0 ||
990 le32_to_cpu(footer.eos_marker.type) != MARKER_END_OF_STREAM)
992 error_setg(errp, "Invalid footer");
996 header = footer.header;
1000 le16_to_cpu(header.compressAlgorithm) == VMDK4_COMPRESSION_DEFLATE;
1001 if (le32_to_cpu(header.version) > 3) {
1002 error_setg(errp, "Unsupported VMDK version %" PRIu32,
1003 le32_to_cpu(header.version));
1005 } else if (le32_to_cpu(header.version) == 3 && (flags & BDRV_O_RDWR) &&
1007 /* VMware KB 2064959 explains that version 3 added support for
1008 * persistent changed block tracking (CBT), and backup software can
1009 * read it as version=1 if it doesn't care about the changed area
1010 * information. So we are safe to enable read only. */
1011 error_setg(errp, "VMDK version 3 must be read only");
1015 if (le32_to_cpu(header.num_gtes_per_gt) > 512) {
1016 error_setg(errp, "L2 table size too big");
1020 l1_entry_sectors = le32_to_cpu(header.num_gtes_per_gt)
1021 * le64_to_cpu(header.granularity);
1022 if (l1_entry_sectors == 0) {
1023 error_setg(errp, "L1 entry size is invalid");
1026 l1_size = (le64_to_cpu(header.capacity) + l1_entry_sectors - 1)
1028 if (le32_to_cpu(header.flags) & VMDK4_FLAG_RGD) {
1029 l1_backup_offset = le64_to_cpu(header.rgd_offset) << 9;
1031 if (bdrv_nb_sectors(file->bs) < le64_to_cpu(header.grain_offset)) {
1032 error_setg(errp, "File truncated, expecting at least %" PRId64 " bytes",
1033 (int64_t)(le64_to_cpu(header.grain_offset)
1034 * BDRV_SECTOR_SIZE));
1038 ret = vmdk_add_extent(bs, file, false,
1039 le64_to_cpu(header.capacity),
1040 le64_to_cpu(header.gd_offset) << 9,
1043 le32_to_cpu(header.num_gtes_per_gt),
1044 le64_to_cpu(header.granularity),
1050 extent->compressed =
1051 le16_to_cpu(header.compressAlgorithm) == VMDK4_COMPRESSION_DEFLATE;
1052 if (extent->compressed) {
1053 g_free(s->create_type);
1054 s->create_type = g_strdup("streamOptimized");
1056 extent->has_marker = le32_to_cpu(header.flags) & VMDK4_FLAG_MARKER;
1057 extent->version = le32_to_cpu(header.version);
1058 extent->has_zero_grain = le32_to_cpu(header.flags) & VMDK4_FLAG_ZERO_GRAIN;
1059 ret = vmdk_init_tables(bs, extent, errp);
1061 /* free extent allocated by vmdk_add_extent */
1062 vmdk_free_last_extent(bs);
1067 /* find an option value out of descriptor file */
1068 static int vmdk_parse_description(const char *desc, const char *opt_name,
1069 char *buf, int buf_size)
1071 char *opt_pos, *opt_end;
1072 const char *end = desc + strlen(desc);
1074 opt_pos = strstr(desc, opt_name);
1078 /* Skip "=\"" following opt_name */
1079 opt_pos += strlen(opt_name) + 2;
1080 if (opt_pos >= end) {
1084 while (opt_end < end && *opt_end != '"') {
1087 if (opt_end == end || buf_size < opt_end - opt_pos + 1) {
1090 pstrcpy(buf, opt_end - opt_pos + 1, opt_pos);
1094 /* Open an extent file and append to bs array */
1095 static int vmdk_open_sparse(BlockDriverState *bs, BdrvChild *file, int flags,
1096 char *buf, QDict *options, Error **errp)
1100 magic = ldl_be_p(buf);
1103 return vmdk_open_vmfs_sparse(bs, file, flags, errp);
1105 return vmdk_open_vmdk4(bs, file, flags, options, errp);
1107 error_setg(errp, "Image not in VMDK format");
1112 static const char *next_line(const char *s)
1123 static int vmdk_parse_extents(const char *desc, BlockDriverState *bs,
1124 QDict *options, Error **errp)
1132 int64_t sectors = 0;
1133 int64_t flat_offset;
1134 char *desc_file_dir = NULL;
1136 BdrvChild *extent_file;
1137 BdrvChildRole extent_role;
1138 BDRVVmdkState *s = bs->opaque;
1139 VmdkExtent *extent = NULL;
1140 char extent_opt_prefix[32];
1141 Error *local_err = NULL;
1143 for (p = desc; *p; p = next_line(p)) {
1144 /* parse extent line in one of below formats:
1146 * RW [size in sectors] FLAT "file-name.vmdk" OFFSET
1147 * RW [size in sectors] SPARSE "file-name.vmdk"
1148 * RW [size in sectors] VMFS "file-name.vmdk"
1149 * RW [size in sectors] VMFSSPARSE "file-name.vmdk"
1150 * RW [size in sectors] SESPARSE "file-name.vmdk"
1153 matches = sscanf(p, "%10s %" SCNd64 " %10s \"%511[^\n\r\"]\" %" SCNd64,
1154 access, §ors, type, fname, &flat_offset);
1155 if (matches < 4 || strcmp(access, "RW")) {
1157 } else if (!strcmp(type, "FLAT")) {
1158 if (matches != 5 || flat_offset < 0) {
1161 } else if (!strcmp(type, "VMFS")) {
1167 } else if (matches != 4) {
1172 (strcmp(type, "FLAT") && strcmp(type, "SPARSE") &&
1173 strcmp(type, "VMFS") && strcmp(type, "VMFSSPARSE") &&
1174 strcmp(type, "SESPARSE")) ||
1175 (strcmp(access, "RW"))) {
1179 if (path_is_absolute(fname)) {
1180 extent_path = g_strdup(fname);
1182 if (!desc_file_dir) {
1183 desc_file_dir = bdrv_dirname(bs->file->bs, errp);
1184 if (!desc_file_dir) {
1185 bdrv_refresh_filename(bs->file->bs);
1186 error_prepend(errp, "Cannot use relative paths with VMDK "
1187 "descriptor file '%s': ",
1188 bs->file->bs->filename);
1194 extent_path = g_strconcat(desc_file_dir, fname, NULL);
1197 ret = snprintf(extent_opt_prefix, 32, "extents.%d", s->num_extents);
1200 extent_role = BDRV_CHILD_DATA;
1201 if (strcmp(type, "FLAT") != 0 && strcmp(type, "VMFS") != 0) {
1202 /* non-flat extents have metadata */
1203 extent_role |= BDRV_CHILD_METADATA;
1206 extent_file = bdrv_open_child(extent_path, options, extent_opt_prefix,
1207 bs, &child_of_bds, extent_role, false,
1209 g_free(extent_path);
1211 error_propagate(errp, local_err);
1216 /* save to extents array */
1217 if (!strcmp(type, "FLAT") || !strcmp(type, "VMFS")) {
1220 ret = vmdk_add_extent(bs, extent_file, true, sectors,
1221 0, 0, 0, 0, 0, &extent, errp);
1223 bdrv_unref_child(bs, extent_file);
1226 extent->flat_start_offset = flat_offset << 9;
1227 } else if (!strcmp(type, "SPARSE") || !strcmp(type, "VMFSSPARSE")) {
1228 /* SPARSE extent and VMFSSPARSE extent are both "COWD" sparse file*/
1229 char *buf = vmdk_read_desc(extent_file, 0, errp);
1233 ret = vmdk_open_sparse(bs, extent_file, bs->open_flags, buf,
1238 bdrv_unref_child(bs, extent_file);
1241 extent = &s->extents[s->num_extents - 1];
1242 } else if (!strcmp(type, "SESPARSE")) {
1243 ret = vmdk_open_se_sparse(bs, extent_file, bs->open_flags, errp);
1245 bdrv_unref_child(bs, extent_file);
1248 extent = &s->extents[s->num_extents - 1];
1250 error_setg(errp, "Unsupported extent type '%s'", type);
1251 bdrv_unref_child(bs, extent_file);
1255 extent->type = g_strdup(type);
1264 if (np[-1] == '\n') {
1267 error_setg(errp, "Invalid extent line: %.*s", (int)(np - p), p);
1271 g_free(desc_file_dir);
1275 static int vmdk_open_desc_file(BlockDriverState *bs, int flags, char *buf,
1276 QDict *options, Error **errp)
1280 BDRVVmdkState *s = bs->opaque;
1282 if (vmdk_parse_description(buf, "createType", ct, sizeof(ct))) {
1283 error_setg(errp, "invalid VMDK image descriptor");
1287 if (strcmp(ct, "monolithicFlat") &&
1288 strcmp(ct, "vmfs") &&
1289 strcmp(ct, "vmfsSparse") &&
1290 strcmp(ct, "seSparse") &&
1291 strcmp(ct, "twoGbMaxExtentSparse") &&
1292 strcmp(ct, "twoGbMaxExtentFlat")) {
1293 error_setg(errp, "Unsupported image type '%s'", ct);
1297 s->create_type = g_strdup(ct);
1299 ret = vmdk_parse_extents(buf, bs, options, errp);
1304 static int vmdk_open(BlockDriverState *bs, QDict *options, int flags,
1309 BDRVVmdkState *s = bs->opaque;
1312 ret = bdrv_open_file_child(NULL, options, "file", bs, errp);
1317 buf = vmdk_read_desc(bs->file, 0, errp);
1322 magic = ldl_be_p(buf);
1326 ret = vmdk_open_sparse(bs, bs->file, flags, buf, options,
1328 s->desc_offset = 0x200;
1331 /* No data in the descriptor file */
1332 bs->file->role &= ~BDRV_CHILD_DATA;
1334 /* Must succeed because we have given up permissions if anything */
1335 bdrv_child_refresh_perms(bs, bs->file, &error_abort);
1337 ret = vmdk_open_desc_file(bs, flags, buf, options, errp);
1344 /* try to open parent images, if exist */
1345 ret = vmdk_parent_open(bs);
1349 ret = vmdk_read_cid(bs, 0, &s->cid);
1353 ret = vmdk_read_cid(bs, 1, &s->parent_cid);
1357 qemu_co_mutex_init(&s->lock);
1359 /* Disable migration when VMDK images are used */
1360 error_setg(&s->migration_blocker, "The vmdk format used by node '%s' "
1361 "does not support live migration",
1362 bdrv_get_device_or_node_name(bs));
1363 ret = migrate_add_blocker(s->migration_blocker, errp);
1365 error_free(s->migration_blocker);
1374 g_free(s->create_type);
1375 s->create_type = NULL;
1376 vmdk_free_extents(bs);
1381 static void vmdk_refresh_limits(BlockDriverState *bs, Error **errp)
1383 BDRVVmdkState *s = bs->opaque;
1386 for (i = 0; i < s->num_extents; i++) {
1387 if (!s->extents[i].flat) {
1388 bs->bl.pwrite_zeroes_alignment =
1389 MAX(bs->bl.pwrite_zeroes_alignment,
1390 s->extents[i].cluster_sectors << BDRV_SECTOR_BITS);
1398 * Copy backing file's cluster that covers @sector_num, otherwise write zero,
1399 * to the cluster at @cluster_sector_num. If @zeroed is true, we're overwriting
1400 * a zeroed cluster in the current layer and must not copy data from the
1403 * If @skip_start_sector < @skip_end_sector, the relative range
1404 * [@skip_start_sector, @skip_end_sector) is not copied or written, and leave
1405 * it for call to write user data in the request.
1407 static int coroutine_fn GRAPH_RDLOCK
1408 get_whole_cluster(BlockDriverState *bs, VmdkExtent *extent,
1409 uint64_t cluster_offset, uint64_t offset,
1410 uint64_t skip_start_bytes, uint64_t skip_end_bytes,
1414 int64_t cluster_bytes;
1415 uint8_t *whole_grain;
1416 bool copy_from_backing;
1418 /* For COW, align request sector_num to cluster start */
1419 cluster_bytes = extent->cluster_sectors << BDRV_SECTOR_BITS;
1420 offset = QEMU_ALIGN_DOWN(offset, cluster_bytes);
1421 whole_grain = qemu_blockalign(bs, cluster_bytes);
1422 copy_from_backing = bs->backing && !zeroed;
1424 if (!copy_from_backing) {
1425 memset(whole_grain, 0, skip_start_bytes);
1426 memset(whole_grain + skip_end_bytes, 0, cluster_bytes - skip_end_bytes);
1429 assert(skip_end_bytes <= cluster_bytes);
1430 /* we will be here if it's first write on non-exist grain(cluster).
1431 * try to read from parent image, if exist */
1432 if (bs->backing && !vmdk_is_cid_valid(bs)) {
1437 /* Read backing data before skip range */
1438 if (skip_start_bytes > 0) {
1439 if (copy_from_backing) {
1440 /* qcow2 emits this on bs->file instead of bs->backing */
1441 BLKDBG_CO_EVENT(extent->file, BLKDBG_COW_READ);
1442 ret = bdrv_co_pread(bs->backing, offset, skip_start_bytes,
1449 BLKDBG_CO_EVENT(extent->file, BLKDBG_COW_WRITE);
1450 ret = bdrv_co_pwrite(extent->file, cluster_offset, skip_start_bytes,
1457 /* Read backing data after skip range */
1458 if (skip_end_bytes < cluster_bytes) {
1459 if (copy_from_backing) {
1460 /* qcow2 emits this on bs->file instead of bs->backing */
1461 BLKDBG_CO_EVENT(extent->file, BLKDBG_COW_READ);
1462 ret = bdrv_co_pread(bs->backing, offset + skip_end_bytes,
1463 cluster_bytes - skip_end_bytes,
1464 whole_grain + skip_end_bytes, 0);
1470 BLKDBG_CO_EVENT(extent->file, BLKDBG_COW_WRITE);
1471 ret = bdrv_co_pwrite(extent->file, cluster_offset + skip_end_bytes,
1472 cluster_bytes - skip_end_bytes,
1473 whole_grain + skip_end_bytes, 0);
1482 qemu_vfree(whole_grain);
1486 static int coroutine_fn GRAPH_RDLOCK
1487 vmdk_L2update(VmdkExtent *extent, VmdkMetaData *m_data, uint32_t offset)
1489 offset = cpu_to_le32(offset);
1490 /* update L2 table */
1491 BLKDBG_CO_EVENT(extent->file, BLKDBG_L2_UPDATE);
1492 if (bdrv_co_pwrite(extent->file,
1493 ((int64_t)m_data->l2_offset * 512)
1494 + (m_data->l2_index * sizeof(offset)),
1495 sizeof(offset), &offset, 0) < 0) {
1498 /* update backup L2 table */
1499 if (extent->l1_backup_table_offset != 0) {
1500 m_data->l2_offset = extent->l1_backup_table[m_data->l1_index];
1501 if (bdrv_co_pwrite(extent->file,
1502 ((int64_t)m_data->l2_offset * 512)
1503 + (m_data->l2_index * sizeof(offset)),
1504 sizeof(offset), &offset, 0) < 0) {
1508 if (bdrv_co_flush(extent->file->bs) < 0) {
1511 if (m_data->l2_cache_entry) {
1512 *m_data->l2_cache_entry = offset;
1519 * get_cluster_offset
1521 * Look up cluster offset in extent file by sector number, and store in
1524 * For flat extents, the start offset as parsed from the description file is
1527 * For sparse extents, look up in L1, L2 table. If allocate is true, return an
1528 * offset for a new cluster and update L2 cache. If there is a backing file,
1529 * COW is done before returning; otherwise, zeroes are written to the allocated
1530 * cluster. Both COW and zero writing skips the sector range
1531 * [@skip_start_sector, @skip_end_sector) passed in by caller, because caller
1532 * has new data to write there.
1534 * Returns: VMDK_OK if cluster exists and mapped in the image.
1535 * VMDK_UNALLOC if cluster is not mapped and @allocate is false.
1536 * VMDK_ERROR if failed.
1538 static int coroutine_fn GRAPH_RDLOCK
1539 get_cluster_offset(BlockDriverState *bs, VmdkExtent *extent,
1540 VmdkMetaData *m_data, uint64_t offset, bool allocate,
1541 uint64_t *cluster_offset, uint64_t skip_start_bytes,
1542 uint64_t skip_end_bytes)
1544 unsigned int l1_index, l2_offset, l2_index;
1545 int min_index, i, j;
1548 bool zeroed = false;
1550 int64_t cluster_sector;
1551 unsigned int l2_size_bytes = extent->l2_size * extent->entry_size;
1554 m_data->new_allocation = false;
1557 *cluster_offset = extent->flat_start_offset;
1561 offset -= (extent->end_sector - extent->sectors) * SECTOR_SIZE;
1562 l1_index = (offset >> 9) / extent->l1_entry_sectors;
1563 if (l1_index >= extent->l1_size) {
1566 if (extent->sesparse) {
1567 uint64_t l2_offset_u64;
1569 assert(extent->entry_size == sizeof(uint64_t));
1571 l2_offset_u64 = ((uint64_t *)extent->l1_table)[l1_index];
1572 if (l2_offset_u64 == 0) {
1574 } else if ((l2_offset_u64 & 0xffffffff00000000) != 0x1000000000000000) {
1576 * Top most nibble is 0x1 if grain table is allocated.
1577 * strict check - top most 4 bytes must be 0x10000000 since max
1578 * supported size is 64TB for disk - so no more than 64TB / 16MB
1579 * grain directories which is smaller than uint32,
1580 * where 16MB is the only supported default grain table coverage.
1584 l2_offset_u64 = l2_offset_u64 & 0x00000000ffffffff;
1585 l2_offset_u64 = extent->sesparse_l2_tables_offset +
1586 l2_offset_u64 * l2_size_bytes / SECTOR_SIZE;
1587 if (l2_offset_u64 > 0x00000000ffffffff) {
1590 l2_offset = (unsigned int)(l2_offset_u64);
1593 assert(extent->entry_size == sizeof(uint32_t));
1594 l2_offset = ((uint32_t *)extent->l1_table)[l1_index];
1597 return VMDK_UNALLOC;
1599 for (i = 0; i < L2_CACHE_SIZE; i++) {
1600 if (l2_offset == extent->l2_cache_offsets[i]) {
1601 /* increment the hit count */
1602 if (++extent->l2_cache_counts[i] == 0xffffffff) {
1603 for (j = 0; j < L2_CACHE_SIZE; j++) {
1604 extent->l2_cache_counts[j] >>= 1;
1607 l2_table = (char *)extent->l2_cache + (i * l2_size_bytes);
1611 /* not found: load a new entry in the least used one */
1613 min_count = 0xffffffff;
1614 for (i = 0; i < L2_CACHE_SIZE; i++) {
1615 if (extent->l2_cache_counts[i] < min_count) {
1616 min_count = extent->l2_cache_counts[i];
1620 l2_table = (char *)extent->l2_cache + (min_index * l2_size_bytes);
1621 BLKDBG_CO_EVENT(extent->file, BLKDBG_L2_LOAD);
1622 if (bdrv_co_pread(extent->file,
1623 (int64_t)l2_offset * 512,
1630 extent->l2_cache_offsets[min_index] = l2_offset;
1631 extent->l2_cache_counts[min_index] = 1;
1633 l2_index = ((offset >> 9) / extent->cluster_sectors) % extent->l2_size;
1635 m_data->l1_index = l1_index;
1636 m_data->l2_index = l2_index;
1637 m_data->l2_offset = l2_offset;
1638 m_data->l2_cache_entry = ((uint32_t *)l2_table) + l2_index;
1641 if (extent->sesparse) {
1642 cluster_sector = le64_to_cpu(((uint64_t *)l2_table)[l2_index]);
1643 switch (cluster_sector & 0xf000000000000000) {
1644 case 0x0000000000000000:
1645 /* unallocated grain */
1646 if (cluster_sector != 0) {
1650 case 0x1000000000000000:
1651 /* scsi-unmapped grain - fallthrough */
1652 case 0x2000000000000000:
1656 case 0x3000000000000000:
1657 /* allocated grain */
1658 cluster_sector = (((cluster_sector & 0x0fff000000000000) >> 48) |
1659 ((cluster_sector & 0x0000ffffffffffff) << 12));
1660 cluster_sector = extent->sesparse_clusters_offset +
1661 cluster_sector * extent->cluster_sectors;
1667 cluster_sector = le32_to_cpu(((uint32_t *)l2_table)[l2_index]);
1669 if (extent->has_zero_grain && cluster_sector == VMDK_GTE_ZEROED) {
1674 if (!cluster_sector || zeroed) {
1676 return zeroed ? VMDK_ZEROED : VMDK_UNALLOC;
1678 assert(!extent->sesparse);
1680 if (extent->next_cluster_sector >= VMDK_EXTENT_MAX_SECTORS) {
1684 cluster_sector = extent->next_cluster_sector;
1685 extent->next_cluster_sector += extent->cluster_sectors;
1687 /* First of all we write grain itself, to avoid race condition
1688 * that may to corrupt the image.
1689 * This problem may occur because of insufficient space on host disk
1690 * or inappropriate VM shutdown.
1692 ret = get_whole_cluster(bs, extent, cluster_sector * BDRV_SECTOR_SIZE,
1693 offset, skip_start_bytes, skip_end_bytes,
1699 m_data->new_allocation = true;
1702 *cluster_offset = cluster_sector << BDRV_SECTOR_BITS;
1706 static VmdkExtent *find_extent(BDRVVmdkState *s,
1707 int64_t sector_num, VmdkExtent *start_hint)
1709 VmdkExtent *extent = start_hint;
1712 extent = &s->extents[0];
1714 while (extent < &s->extents[s->num_extents]) {
1715 if (sector_num < extent->end_sector) {
1723 static inline uint64_t vmdk_find_offset_in_cluster(VmdkExtent *extent,
1726 uint64_t extent_begin_offset, extent_relative_offset;
1727 uint64_t cluster_size = extent->cluster_sectors * BDRV_SECTOR_SIZE;
1729 extent_begin_offset =
1730 (extent->end_sector - extent->sectors) * BDRV_SECTOR_SIZE;
1731 extent_relative_offset = offset - extent_begin_offset;
1732 return extent_relative_offset % cluster_size;
1735 static int coroutine_fn GRAPH_RDLOCK
1736 vmdk_co_block_status(BlockDriverState *bs, bool want_zero,
1737 int64_t offset, int64_t bytes, int64_t *pnum,
1738 int64_t *map, BlockDriverState **file)
1740 BDRVVmdkState *s = bs->opaque;
1741 int64_t index_in_cluster, n, ret;
1742 uint64_t cluster_offset;
1745 extent = find_extent(s, offset >> BDRV_SECTOR_BITS, NULL);
1749 qemu_co_mutex_lock(&s->lock);
1750 ret = get_cluster_offset(bs, extent, NULL, offset, false, &cluster_offset,
1752 qemu_co_mutex_unlock(&s->lock);
1754 index_in_cluster = vmdk_find_offset_in_cluster(extent, offset);
1763 ret = BDRV_BLOCK_ZERO;
1766 ret = BDRV_BLOCK_DATA;
1767 if (!extent->compressed) {
1768 ret |= BDRV_BLOCK_OFFSET_VALID;
1769 *map = cluster_offset + index_in_cluster;
1771 ret |= BDRV_BLOCK_RECURSE;
1774 *file = extent->file->bs;
1778 n = extent->cluster_sectors * BDRV_SECTOR_SIZE - index_in_cluster;
1779 *pnum = MIN(n, bytes);
1783 static int coroutine_fn GRAPH_RDLOCK
1784 vmdk_write_extent(VmdkExtent *extent, int64_t cluster_offset,
1785 int64_t offset_in_cluster, QEMUIOVector *qiov,
1786 uint64_t qiov_offset, uint64_t n_bytes,
1790 VmdkGrainMarker *data = NULL;
1792 QEMUIOVector local_qiov;
1793 int64_t write_offset;
1794 int64_t write_end_sector;
1796 if (extent->compressed) {
1797 void *compressed_data;
1799 /* Only whole clusters */
1800 if (offset_in_cluster ||
1801 n_bytes > (extent->cluster_sectors * SECTOR_SIZE) ||
1802 (n_bytes < (extent->cluster_sectors * SECTOR_SIZE) &&
1803 offset + n_bytes != extent->end_sector * SECTOR_SIZE))
1809 if (!extent->has_marker) {
1813 buf_len = (extent->cluster_sectors << 9) * 2;
1814 data = g_malloc(buf_len + sizeof(VmdkGrainMarker));
1816 compressed_data = g_malloc(n_bytes);
1817 qemu_iovec_to_buf(qiov, qiov_offset, compressed_data, n_bytes);
1818 ret = compress(data->data, &buf_len, compressed_data, n_bytes);
1819 g_free(compressed_data);
1821 if (ret != Z_OK || buf_len == 0) {
1826 data->lba = cpu_to_le64(offset >> BDRV_SECTOR_BITS);
1827 data->size = cpu_to_le32(buf_len);
1829 n_bytes = buf_len + sizeof(VmdkGrainMarker);
1830 qemu_iovec_init_buf(&local_qiov, data, n_bytes);
1832 BLKDBG_CO_EVENT(extent->file, BLKDBG_WRITE_COMPRESSED);
1834 qemu_iovec_init(&local_qiov, qiov->niov);
1835 qemu_iovec_concat(&local_qiov, qiov, qiov_offset, n_bytes);
1837 BLKDBG_CO_EVENT(extent->file, BLKDBG_WRITE_AIO);
1840 write_offset = cluster_offset + offset_in_cluster;
1841 ret = bdrv_co_pwritev(extent->file, write_offset, n_bytes,
1844 write_end_sector = DIV_ROUND_UP(write_offset + n_bytes, BDRV_SECTOR_SIZE);
1846 if (extent->compressed) {
1847 extent->next_cluster_sector = write_end_sector;
1849 extent->next_cluster_sector = MAX(extent->next_cluster_sector,
1859 if (!extent->compressed) {
1860 qemu_iovec_destroy(&local_qiov);
1865 static int coroutine_fn GRAPH_RDLOCK
1866 vmdk_read_extent(VmdkExtent *extent, int64_t cluster_offset,
1867 int64_t offset_in_cluster, QEMUIOVector *qiov, int bytes)
1870 int cluster_bytes, buf_bytes;
1871 uint8_t *cluster_buf, *compressed_data;
1872 uint8_t *uncomp_buf;
1874 VmdkGrainMarker *marker;
1878 if (!extent->compressed) {
1879 BLKDBG_CO_EVENT(extent->file, BLKDBG_READ_AIO);
1880 ret = bdrv_co_preadv(extent->file,
1881 cluster_offset + offset_in_cluster, bytes,
1888 cluster_bytes = extent->cluster_sectors * 512;
1889 /* Read two clusters in case GrainMarker + compressed data > one cluster */
1890 buf_bytes = cluster_bytes * 2;
1891 cluster_buf = g_malloc(buf_bytes);
1892 uncomp_buf = g_malloc(cluster_bytes);
1893 BLKDBG_CO_EVENT(extent->file, BLKDBG_READ_COMPRESSED);
1894 ret = bdrv_co_pread(extent->file, cluster_offset, buf_bytes, cluster_buf,
1899 compressed_data = cluster_buf;
1900 buf_len = cluster_bytes;
1901 data_len = cluster_bytes;
1902 if (extent->has_marker) {
1903 marker = (VmdkGrainMarker *)cluster_buf;
1904 compressed_data = marker->data;
1905 data_len = le32_to_cpu(marker->size);
1907 if (!data_len || data_len > buf_bytes) {
1911 ret = uncompress(uncomp_buf, &buf_len, compressed_data, data_len);
1917 if (offset_in_cluster < 0 ||
1918 offset_in_cluster + bytes > buf_len) {
1922 qemu_iovec_from_buf(qiov, 0, uncomp_buf + offset_in_cluster, bytes);
1927 g_free(cluster_buf);
1931 static int coroutine_fn GRAPH_RDLOCK
1932 vmdk_co_preadv(BlockDriverState *bs, int64_t offset, int64_t bytes,
1933 QEMUIOVector *qiov, BdrvRequestFlags flags)
1935 BDRVVmdkState *s = bs->opaque;
1937 uint64_t n_bytes, offset_in_cluster;
1938 VmdkExtent *extent = NULL;
1939 QEMUIOVector local_qiov;
1940 uint64_t cluster_offset;
1941 uint64_t bytes_done = 0;
1943 qemu_iovec_init(&local_qiov, qiov->niov);
1944 qemu_co_mutex_lock(&s->lock);
1947 extent = find_extent(s, offset >> BDRV_SECTOR_BITS, extent);
1952 ret = get_cluster_offset(bs, extent, NULL,
1953 offset, false, &cluster_offset, 0, 0);
1954 offset_in_cluster = vmdk_find_offset_in_cluster(extent, offset);
1956 n_bytes = MIN(bytes, extent->cluster_sectors * BDRV_SECTOR_SIZE
1957 - offset_in_cluster);
1959 if (ret != VMDK_OK) {
1960 /* if not allocated, try to read from parent image, if exist */
1961 if (bs->backing && ret != VMDK_ZEROED) {
1962 if (!vmdk_is_cid_valid(bs)) {
1967 qemu_iovec_reset(&local_qiov);
1968 qemu_iovec_concat(&local_qiov, qiov, bytes_done, n_bytes);
1970 /* qcow2 emits this on bs->file instead of bs->backing */
1971 BLKDBG_CO_EVENT(bs->file, BLKDBG_READ_BACKING_AIO);
1972 ret = bdrv_co_preadv(bs->backing, offset, n_bytes,
1978 qemu_iovec_memset(qiov, bytes_done, 0, n_bytes);
1981 qemu_iovec_reset(&local_qiov);
1982 qemu_iovec_concat(&local_qiov, qiov, bytes_done, n_bytes);
1984 ret = vmdk_read_extent(extent, cluster_offset, offset_in_cluster,
1985 &local_qiov, n_bytes);
1992 bytes_done += n_bytes;
1997 qemu_co_mutex_unlock(&s->lock);
1998 qemu_iovec_destroy(&local_qiov);
2005 * @zeroed: buf is ignored (data is zero), use zeroed_grain GTE feature
2006 * if possible, otherwise return -ENOTSUP.
2007 * @zero_dry_run: used for zeroed == true only, don't update L2 table, just try
2008 * with each cluster. By dry run we can find if the zero write
2009 * is possible without modifying image data.
2011 * Returns: error code with 0 for success.
2013 static int coroutine_fn GRAPH_RDLOCK
2014 vmdk_pwritev(BlockDriverState *bs, uint64_t offset, uint64_t bytes,
2015 QEMUIOVector *qiov, bool zeroed, bool zero_dry_run)
2017 BDRVVmdkState *s = bs->opaque;
2018 VmdkExtent *extent = NULL;
2020 int64_t offset_in_cluster, n_bytes;
2021 uint64_t cluster_offset;
2022 uint64_t bytes_done = 0;
2023 VmdkMetaData m_data;
2025 if (DIV_ROUND_UP(offset, BDRV_SECTOR_SIZE) > bs->total_sectors) {
2026 error_report("Wrong offset: offset=0x%" PRIx64
2027 " total_sectors=0x%" PRIx64,
2028 offset, bs->total_sectors);
2033 extent = find_extent(s, offset >> BDRV_SECTOR_BITS, extent);
2037 if (extent->sesparse) {
2040 offset_in_cluster = vmdk_find_offset_in_cluster(extent, offset);
2041 n_bytes = MIN(bytes, extent->cluster_sectors * BDRV_SECTOR_SIZE
2042 - offset_in_cluster);
2044 ret = get_cluster_offset(bs, extent, &m_data, offset,
2045 !(extent->compressed || zeroed),
2046 &cluster_offset, offset_in_cluster,
2047 offset_in_cluster + n_bytes);
2048 if (extent->compressed) {
2049 if (ret == VMDK_OK) {
2050 /* Refuse write to allocated cluster for streamOptimized */
2051 error_report("Could not write to allocated cluster"
2052 " for streamOptimized");
2054 } else if (!zeroed) {
2056 ret = get_cluster_offset(bs, extent, &m_data, offset,
2057 true, &cluster_offset, 0, 0);
2060 if (ret == VMDK_ERROR) {
2064 /* Do zeroed write, buf is ignored */
2065 if (extent->has_zero_grain &&
2066 offset_in_cluster == 0 &&
2067 n_bytes >= extent->cluster_sectors * BDRV_SECTOR_SIZE) {
2068 n_bytes = extent->cluster_sectors * BDRV_SECTOR_SIZE;
2069 if (!zero_dry_run && ret != VMDK_ZEROED) {
2070 /* update L2 tables */
2071 if (vmdk_L2update(extent, &m_data, VMDK_GTE_ZEROED)
2080 ret = vmdk_write_extent(extent, cluster_offset, offset_in_cluster,
2081 qiov, bytes_done, n_bytes, offset);
2085 if (m_data.new_allocation) {
2086 /* update L2 tables */
2087 if (vmdk_L2update(extent, &m_data,
2088 cluster_offset >> BDRV_SECTOR_BITS)
2096 bytes_done += n_bytes;
2098 /* update CID on the first write every time the virtual disk is
2100 if (!s->cid_updated) {
2101 ret = vmdk_write_cid(bs, g_random_int());
2105 s->cid_updated = true;
2111 static int coroutine_fn GRAPH_RDLOCK
2112 vmdk_co_pwritev(BlockDriverState *bs, int64_t offset, int64_t bytes,
2113 QEMUIOVector *qiov, BdrvRequestFlags flags)
2116 BDRVVmdkState *s = bs->opaque;
2117 qemu_co_mutex_lock(&s->lock);
2118 ret = vmdk_pwritev(bs, offset, bytes, qiov, false, false);
2119 qemu_co_mutex_unlock(&s->lock);
2123 static int coroutine_fn GRAPH_RDLOCK
2124 vmdk_co_pwritev_compressed(BlockDriverState *bs, int64_t offset, int64_t bytes,
2128 /* The caller will write bytes 0 to signal EOF.
2129 * When receive it, we align EOF to a sector boundary. */
2130 BDRVVmdkState *s = bs->opaque;
2134 for (i = 0; i < s->num_extents; i++) {
2135 length = bdrv_co_getlength(s->extents[i].file->bs);
2139 length = QEMU_ALIGN_UP(length, BDRV_SECTOR_SIZE);
2140 ret = bdrv_co_truncate(s->extents[i].file, length, false,
2141 PREALLOC_MODE_OFF, 0, NULL);
2148 return vmdk_co_pwritev(bs, offset, bytes, qiov, 0);
2151 static int coroutine_fn GRAPH_RDLOCK
2152 vmdk_co_pwrite_zeroes(BlockDriverState *bs, int64_t offset, int64_t bytes,
2153 BdrvRequestFlags flags)
2156 BDRVVmdkState *s = bs->opaque;
2158 qemu_co_mutex_lock(&s->lock);
2159 /* write zeroes could fail if sectors not aligned to cluster, test it with
2160 * dry_run == true before really updating image */
2161 ret = vmdk_pwritev(bs, offset, bytes, NULL, true, true);
2163 ret = vmdk_pwritev(bs, offset, bytes, NULL, true, false);
2165 qemu_co_mutex_unlock(&s->lock);
2169 static int coroutine_fn GRAPH_UNLOCKED
2170 vmdk_init_extent(BlockBackend *blk, int64_t filesize, bool flat, bool compress,
2171 bool zeroed_grain, Error **errp)
2175 uint32_t tmp, magic, grains, gd_sectors, gt_size, gt_count;
2176 uint32_t *gd_buf = NULL;
2180 ret = blk_co_truncate(blk, filesize, false, PREALLOC_MODE_OFF, 0, errp);
2183 magic = cpu_to_be32(VMDK4_MAGIC);
2184 memset(&header, 0, sizeof(header));
2187 } else if (zeroed_grain) {
2192 header.flags = VMDK4_FLAG_RGD | VMDK4_FLAG_NL_DETECT
2193 | (compress ? VMDK4_FLAG_COMPRESS | VMDK4_FLAG_MARKER : 0)
2194 | (zeroed_grain ? VMDK4_FLAG_ZERO_GRAIN : 0);
2195 header.compressAlgorithm = compress ? VMDK4_COMPRESSION_DEFLATE : 0;
2196 header.capacity = filesize / BDRV_SECTOR_SIZE;
2197 header.granularity = 128;
2198 header.num_gtes_per_gt = BDRV_SECTOR_SIZE;
2200 grains = DIV_ROUND_UP(filesize / BDRV_SECTOR_SIZE, header.granularity);
2201 gt_size = DIV_ROUND_UP(header.num_gtes_per_gt * sizeof(uint32_t),
2203 gt_count = DIV_ROUND_UP(grains, header.num_gtes_per_gt);
2204 gd_sectors = DIV_ROUND_UP(gt_count * sizeof(uint32_t), BDRV_SECTOR_SIZE);
2206 header.desc_offset = 1;
2207 header.desc_size = 20;
2208 header.rgd_offset = header.desc_offset + header.desc_size;
2209 header.gd_offset = header.rgd_offset + gd_sectors + (gt_size * gt_count);
2210 header.grain_offset =
2211 ROUND_UP(header.gd_offset + gd_sectors + (gt_size * gt_count),
2212 header.granularity);
2213 /* swap endianness for all header fields */
2214 header.version = cpu_to_le32(header.version);
2215 header.flags = cpu_to_le32(header.flags);
2216 header.capacity = cpu_to_le64(header.capacity);
2217 header.granularity = cpu_to_le64(header.granularity);
2218 header.num_gtes_per_gt = cpu_to_le32(header.num_gtes_per_gt);
2219 header.desc_offset = cpu_to_le64(header.desc_offset);
2220 header.desc_size = cpu_to_le64(header.desc_size);
2221 header.rgd_offset = cpu_to_le64(header.rgd_offset);
2222 header.gd_offset = cpu_to_le64(header.gd_offset);
2223 header.grain_offset = cpu_to_le64(header.grain_offset);
2224 header.compressAlgorithm = cpu_to_le16(header.compressAlgorithm);
2226 header.check_bytes[0] = 0xa;
2227 header.check_bytes[1] = 0x20;
2228 header.check_bytes[2] = 0xd;
2229 header.check_bytes[3] = 0xa;
2231 /* write all the data */
2232 ret = blk_co_pwrite(blk, 0, sizeof(magic), &magic, 0);
2234 error_setg(errp, QERR_IO_ERROR);
2237 ret = blk_co_pwrite(blk, sizeof(magic), sizeof(header), &header, 0);
2239 error_setg(errp, QERR_IO_ERROR);
2243 ret = blk_co_truncate(blk, le64_to_cpu(header.grain_offset) << 9, false,
2244 PREALLOC_MODE_OFF, 0, errp);
2249 /* write grain directory */
2250 gd_buf_size = gd_sectors * BDRV_SECTOR_SIZE;
2251 gd_buf = g_malloc0(gd_buf_size);
2252 for (i = 0, tmp = le64_to_cpu(header.rgd_offset) + gd_sectors;
2253 i < gt_count; i++, tmp += gt_size) {
2254 gd_buf[i] = cpu_to_le32(tmp);
2256 ret = blk_co_pwrite(blk, le64_to_cpu(header.rgd_offset) * BDRV_SECTOR_SIZE,
2257 gd_buf_size, gd_buf, 0);
2259 error_setg(errp, QERR_IO_ERROR);
2263 /* write backup grain directory */
2264 for (i = 0, tmp = le64_to_cpu(header.gd_offset) + gd_sectors;
2265 i < gt_count; i++, tmp += gt_size) {
2266 gd_buf[i] = cpu_to_le32(tmp);
2268 ret = blk_co_pwrite(blk, le64_to_cpu(header.gd_offset) * BDRV_SECTOR_SIZE,
2269 gd_buf_size, gd_buf, 0);
2271 error_setg(errp, QERR_IO_ERROR);
2280 static int coroutine_fn GRAPH_UNLOCKED
2281 vmdk_create_extent(const char *filename, int64_t filesize, bool flat,
2282 bool compress, bool zeroed_grain, BlockBackend **pbb,
2283 QemuOpts *opts, Error **errp)
2286 BlockBackend *blk = NULL;
2288 ret = bdrv_co_create_file(filename, opts, errp);
2293 blk = blk_co_new_open(filename, NULL, NULL,
2294 BDRV_O_RDWR | BDRV_O_RESIZE | BDRV_O_PROTOCOL,
2301 blk_set_allow_write_beyond_eof(blk, true);
2303 ret = vmdk_init_extent(blk, filesize, flat, compress, zeroed_grain, errp);
2316 static int filename_decompose(const char *filename, char *path, char *prefix,
2317 char *postfix, size_t buf_len, Error **errp)
2321 if (filename == NULL || !strlen(filename)) {
2322 error_setg(errp, "No filename provided");
2325 p = strrchr(filename, '/');
2327 p = strrchr(filename, '\\');
2330 p = strrchr(filename, ':');
2334 if (p - filename >= buf_len) {
2337 pstrcpy(path, p - filename + 1, filename);
2342 q = strrchr(p, '.');
2344 pstrcpy(prefix, buf_len, p);
2347 if (q - p >= buf_len) {
2350 pstrcpy(prefix, q - p + 1, p);
2351 pstrcpy(postfix, buf_len, q);
2357 * idx == 0: get or create the descriptor file (also the image file if in a
2359 * idx >= 1: get the n-th extent if in a split subformat
2361 typedef BlockBackend * coroutine_fn GRAPH_UNLOCKED_PTR
2362 (*vmdk_create_extent_fn)(int64_t size, int idx, bool flat, bool split,
2363 bool compress, bool zeroed_grain, void *opaque,
2366 static void vmdk_desc_add_extent(GString *desc,
2367 const char *extent_line_fmt,
2368 int64_t size, const char *filename)
2370 char *basename = g_path_get_basename(filename);
2372 g_string_append_printf(desc, extent_line_fmt,
2373 DIV_ROUND_UP(size, BDRV_SECTOR_SIZE), basename);
2377 static int coroutine_fn GRAPH_UNLOCKED
2378 vmdk_co_do_create(int64_t size,
2379 BlockdevVmdkSubformat subformat,
2380 BlockdevVmdkAdapterType adapter_type,
2381 const char *backing_file,
2382 const char *hw_version,
2383 const char *toolsversion,
2386 vmdk_create_extent_fn extent_fn,
2391 BlockBackend *blk = NULL;
2392 BlockBackend *extent_blk;
2393 Error *local_err = NULL;
2396 bool flat, split, compress;
2397 GString *ext_desc_lines;
2398 const int64_t split_size = 0x80000000; /* VMDK has constant split size */
2399 int64_t extent_size;
2400 int64_t created_size = 0;
2401 const char *extent_line_fmt;
2402 char *parent_desc_line = g_malloc0(BUF_SIZE);
2403 uint32_t parent_cid = 0xffffffff;
2404 uint32_t number_heads = 16;
2405 uint32_t desc_offset = 0, desc_len;
2406 const char desc_template[] =
2407 "# Disk DescriptorFile\n"
2410 "parentCID=%" PRIx32 "\n"
2411 "createType=\"%s\"\n"
2414 "# Extent description\n"
2417 "# The Disk Data Base\n"
2420 "ddb.virtualHWVersion = \"%s\"\n"
2421 "ddb.geometry.cylinders = \"%" PRId64 "\"\n"
2422 "ddb.geometry.heads = \"%" PRIu32 "\"\n"
2423 "ddb.geometry.sectors = \"63\"\n"
2424 "ddb.adapterType = \"%s\"\n"
2425 "ddb.toolsVersion = \"%s\"\n";
2427 ext_desc_lines = g_string_new(NULL);
2429 /* Read out options */
2433 "compat6 cannot be enabled with hwversion set");
2442 if (!toolsversion) {
2443 toolsversion = "2147483647";
2446 if (adapter_type != BLOCKDEV_VMDK_ADAPTER_TYPE_IDE) {
2447 /* that's the number of heads with which vmware operates when
2448 creating, exporting, etc. vmdk files with a non-ide adapter type */
2451 split = (subformat == BLOCKDEV_VMDK_SUBFORMAT_TWOGBMAXEXTENTFLAT) ||
2452 (subformat == BLOCKDEV_VMDK_SUBFORMAT_TWOGBMAXEXTENTSPARSE);
2453 flat = (subformat == BLOCKDEV_VMDK_SUBFORMAT_MONOLITHICFLAT) ||
2454 (subformat == BLOCKDEV_VMDK_SUBFORMAT_TWOGBMAXEXTENTFLAT);
2455 compress = subformat == BLOCKDEV_VMDK_SUBFORMAT_STREAMOPTIMIZED;
2458 extent_line_fmt = "RW %" PRId64 " FLAT \"%s\" 0\n";
2460 extent_line_fmt = "RW %" PRId64 " SPARSE \"%s\"\n";
2462 if (flat && backing_file) {
2463 error_setg(errp, "Flat image can't have backing file");
2467 if (flat && zeroed_grain) {
2468 error_setg(errp, "Flat image can't enable zeroed grain");
2473 /* Create extents */
2475 extent_size = split_size;
2479 if (!split && !flat) {
2480 created_size = extent_size;
2484 /* Get the descriptor file BDS */
2485 blk = extent_fn(created_size, 0, flat, split, compress, zeroed_grain,
2491 if (!split && !flat) {
2492 vmdk_desc_add_extent(ext_desc_lines, extent_line_fmt, created_size,
2493 blk_bs(blk)->filename);
2497 BlockBackend *backing;
2498 char *full_backing =
2499 bdrv_get_full_backing_filename_from_filename(blk_bs(blk)->filename,
2503 error_propagate(errp, local_err);
2507 assert(full_backing);
2509 backing = blk_co_new_open(full_backing, NULL, NULL,
2510 BDRV_O_NO_BACKING, errp);
2511 g_free(full_backing);
2512 if (backing == NULL) {
2516 if (strcmp(blk_bs(backing)->drv->format_name, "vmdk")) {
2517 error_setg(errp, "Invalid backing file format: %s. Must be vmdk",
2518 blk_bs(backing)->drv->format_name);
2519 blk_co_unref(backing);
2523 ret = vmdk_read_cid(blk_bs(backing), 0, &parent_cid);
2524 blk_co_unref(backing);
2526 error_setg(errp, "Failed to read parent CID");
2529 snprintf(parent_desc_line, BUF_SIZE,
2530 "parentFileNameHint=\"%s\"", backing_file);
2533 while (created_size < size) {
2534 int64_t cur_size = MIN(size - created_size, extent_size);
2535 extent_blk = extent_fn(cur_size, extent_idx, flat, split, compress,
2536 zeroed_grain, opaque, errp);
2541 vmdk_desc_add_extent(ext_desc_lines, extent_line_fmt, cur_size,
2542 blk_bs(extent_blk)->filename);
2543 created_size += cur_size;
2545 blk_co_unref(extent_blk);
2548 /* Check whether we got excess extents */
2549 extent_blk = extent_fn(-1, extent_idx, flat, split, compress, zeroed_grain,
2552 blk_co_unref(extent_blk);
2553 error_setg(errp, "List of extents contains unused extents");
2558 /* generate descriptor file */
2559 desc = g_strdup_printf(desc_template,
2562 BlockdevVmdkSubformat_str(subformat),
2564 ext_desc_lines->str,
2567 (int64_t)(63 * number_heads * BDRV_SECTOR_SIZE),
2569 BlockdevVmdkAdapterType_str(adapter_type),
2571 desc_len = strlen(desc);
2572 /* the descriptor offset = 0x200 */
2573 if (!split && !flat) {
2574 desc_offset = 0x200;
2577 ret = blk_co_pwrite(blk, desc_offset, desc_len, desc, 0);
2579 error_setg_errno(errp, -ret, "Could not write description");
2582 /* bdrv_pwrite write padding zeros to align to sector, we don't need that
2583 * for description file */
2584 if (desc_offset == 0) {
2585 ret = blk_co_truncate(blk, desc_len, false, PREALLOC_MODE_OFF, 0, errp);
2596 g_free(parent_desc_line);
2597 g_string_free(ext_desc_lines, true);
2606 } VMDKCreateOptsData;
2608 static BlockBackend * coroutine_fn GRAPH_UNLOCKED
2609 vmdk_co_create_opts_cb(int64_t size, int idx, bool flat, bool split,
2610 bool compress, bool zeroed_grain, void *opaque,
2613 BlockBackend *blk = NULL;
2614 BlockDriverState *bs = NULL;
2615 VMDKCreateOptsData *data = opaque;
2616 char *ext_filename = NULL;
2617 char *rel_filename = NULL;
2619 /* We're done, don't create excess extents. */
2621 assert(errp == NULL);
2626 rel_filename = g_strdup_printf("%s%s", data->prefix, data->postfix);
2628 rel_filename = g_strdup_printf("%s-%c%03d%s",
2630 flat ? 'f' : 's', idx, data->postfix);
2633 rel_filename = g_strdup_printf("%s-flat%s", data->prefix, data->postfix);
2636 ext_filename = g_strdup_printf("%s%s", data->path, rel_filename);
2637 g_free(rel_filename);
2639 if (vmdk_create_extent(ext_filename, size,
2640 flat, compress, zeroed_grain, &blk, data->opts,
2646 g_free(ext_filename);
2650 static int coroutine_fn GRAPH_UNLOCKED
2651 vmdk_co_create_opts(BlockDriver *drv, const char *filename,
2652 QemuOpts *opts, Error **errp)
2654 Error *local_err = NULL;
2656 int64_t total_size = 0;
2657 char *adapter_type = NULL;
2658 BlockdevVmdkAdapterType adapter_type_enum;
2659 char *backing_file = NULL;
2660 char *hw_version = NULL;
2661 char *toolsversion = NULL;
2663 BlockdevVmdkSubformat subformat;
2665 char *path = g_malloc0(PATH_MAX);
2666 char *prefix = g_malloc0(PATH_MAX);
2667 char *postfix = g_malloc0(PATH_MAX);
2668 char *desc_line = g_malloc0(BUF_SIZE);
2669 char *ext_filename = g_malloc0(PATH_MAX);
2670 char *desc_filename = g_malloc0(PATH_MAX);
2671 char *parent_desc_line = g_malloc0(BUF_SIZE);
2674 VMDKCreateOptsData data;
2675 char *backing_fmt = NULL;
2677 backing_fmt = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FMT);
2678 if (backing_fmt && strcmp(backing_fmt, "vmdk") != 0) {
2679 error_setg(errp, "backing_file must be a vmdk image");
2684 if (filename_decompose(filename, path, prefix, postfix, PATH_MAX, errp)) {
2688 /* Read out options */
2689 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
2691 adapter_type = qemu_opt_get_del(opts, BLOCK_OPT_ADAPTER_TYPE);
2692 backing_file = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FILE);
2693 hw_version = qemu_opt_get_del(opts, BLOCK_OPT_HWVERSION);
2694 toolsversion = qemu_opt_get_del(opts, BLOCK_OPT_TOOLSVERSION);
2695 compat6 = qemu_opt_get_bool_del(opts, BLOCK_OPT_COMPAT6, false);
2696 if (strcmp(hw_version, "undefined") == 0) {
2700 fmt = qemu_opt_get_del(opts, BLOCK_OPT_SUBFMT);
2701 zeroed_grain = qemu_opt_get_bool_del(opts, BLOCK_OPT_ZEROED_GRAIN, false);
2704 adapter_type_enum = qapi_enum_parse(&BlockdevVmdkAdapterType_lookup,
2706 BLOCKDEV_VMDK_ADAPTER_TYPE_IDE,
2709 error_propagate(errp, local_err);
2714 adapter_type_enum = BLOCKDEV_VMDK_ADAPTER_TYPE_IDE;
2718 /* Default format to monolithicSparse */
2719 subformat = BLOCKDEV_VMDK_SUBFORMAT_MONOLITHICSPARSE;
2721 subformat = qapi_enum_parse(&BlockdevVmdkSubformat_lookup,
2723 BLOCKDEV_VMDK_SUBFORMAT_MONOLITHICSPARSE,
2726 error_propagate(errp, local_err);
2731 data = (VMDKCreateOptsData){
2737 ret = vmdk_co_do_create(total_size, subformat, adapter_type_enum,
2738 backing_file, hw_version, toolsversion, compat6,
2739 zeroed_grain, vmdk_co_create_opts_cb, &data, errp);
2742 g_free(backing_fmt);
2743 g_free(adapter_type);
2744 g_free(backing_file);
2746 g_free(toolsversion);
2753 g_free(ext_filename);
2754 g_free(desc_filename);
2755 g_free(parent_desc_line);
2759 static BlockBackend * coroutine_fn GRAPH_UNLOCKED
2760 vmdk_co_create_cb(int64_t size, int idx, bool flat, bool split, bool compress,
2761 bool zeroed_grain, void *opaque, Error **errp)
2764 BlockDriverState *bs;
2766 BlockdevCreateOptionsVmdk *opts = opaque;
2769 bs = bdrv_co_open_blockdev_ref(opts->file, errp);
2772 BlockdevRefList *list = opts->extents;
2773 for (i = 1; i < idx; i++) {
2774 if (!list || !list->next) {
2775 error_setg(errp, "Extent [%d] not specified", i);
2781 error_setg(errp, "Extent [%d] not specified", idx - 1);
2784 bs = bdrv_co_open_blockdev_ref(list->value, errp);
2789 blk = blk_co_new_with_bs(bs,
2790 BLK_PERM_CONSISTENT_READ | BLK_PERM_WRITE |
2797 blk_set_allow_write_beyond_eof(blk, true);
2801 ret = vmdk_init_extent(blk, size, flat, compress, zeroed_grain, errp);
2810 static int coroutine_fn GRAPH_UNLOCKED
2811 vmdk_co_create(BlockdevCreateOptions *create_options, Error **errp)
2813 BlockdevCreateOptionsVmdk *opts;
2815 opts = &create_options->u.vmdk;
2817 /* Validate options */
2818 if (!QEMU_IS_ALIGNED(opts->size, BDRV_SECTOR_SIZE)) {
2819 error_setg(errp, "Image size must be a multiple of 512 bytes");
2823 return vmdk_co_do_create(opts->size,
2835 static void vmdk_close(BlockDriverState *bs)
2837 BDRVVmdkState *s = bs->opaque;
2839 vmdk_free_extents(bs);
2840 g_free(s->create_type);
2842 migrate_del_blocker(s->migration_blocker);
2843 error_free(s->migration_blocker);
2846 static int64_t coroutine_fn GRAPH_RDLOCK
2847 vmdk_co_get_allocated_file_size(BlockDriverState *bs)
2852 BDRVVmdkState *s = bs->opaque;
2854 ret = bdrv_co_get_allocated_file_size(bs->file->bs);
2858 for (i = 0; i < s->num_extents; i++) {
2859 if (s->extents[i].file == bs->file) {
2862 r = bdrv_co_get_allocated_file_size(s->extents[i].file->bs);
2871 static int vmdk_has_zero_init(BlockDriverState *bs)
2874 BDRVVmdkState *s = bs->opaque;
2876 /* If has a flat extent and its underlying storage doesn't have zero init,
2878 for (i = 0; i < s->num_extents; i++) {
2879 if (s->extents[i].flat) {
2880 if (!bdrv_has_zero_init(s->extents[i].file->bs)) {
2888 static VmdkExtentInfo *vmdk_get_extent_info(VmdkExtent *extent)
2890 VmdkExtentInfo *info = g_new0(VmdkExtentInfo, 1);
2892 bdrv_refresh_filename(extent->file->bs);
2893 *info = (VmdkExtentInfo){
2894 .filename = g_strdup(extent->file->bs->filename),
2895 .format = g_strdup(extent->type),
2896 .virtual_size = extent->sectors * BDRV_SECTOR_SIZE,
2897 .compressed = extent->compressed,
2898 .has_compressed = extent->compressed,
2899 .cluster_size = extent->cluster_sectors * BDRV_SECTOR_SIZE,
2900 .has_cluster_size = !extent->flat,
2906 static int coroutine_fn GRAPH_RDLOCK
2907 vmdk_co_check(BlockDriverState *bs, BdrvCheckResult *result, BdrvCheckMode fix)
2909 BDRVVmdkState *s = bs->opaque;
2910 VmdkExtent *extent = NULL;
2911 int64_t sector_num = 0;
2912 int64_t total_sectors = bdrv_co_nb_sectors(bs);
2914 uint64_t cluster_offset;
2921 if (sector_num >= total_sectors) {
2924 extent = find_extent(s, sector_num, extent);
2927 "ERROR: could not find extent for sector %" PRId64 "\n",
2932 ret = get_cluster_offset(bs, extent, NULL,
2933 sector_num << BDRV_SECTOR_BITS,
2934 false, &cluster_offset, 0, 0);
2935 if (ret == VMDK_ERROR) {
2937 "ERROR: could not get cluster_offset for sector %"
2938 PRId64 "\n", sector_num);
2941 if (ret == VMDK_OK) {
2942 int64_t extent_len = bdrv_co_getlength(extent->file->bs);
2943 if (extent_len < 0) {
2945 "ERROR: could not get extent file length for sector %"
2946 PRId64 "\n", sector_num);
2950 if (cluster_offset >= extent_len) {
2952 "ERROR: cluster offset for sector %"
2953 PRId64 " points after EOF\n", sector_num);
2958 sector_num += extent->cluster_sectors;
2961 result->corruptions++;
2965 static ImageInfoSpecific *vmdk_get_specific_info(BlockDriverState *bs,
2969 BDRVVmdkState *s = bs->opaque;
2970 ImageInfoSpecific *spec_info = g_new0(ImageInfoSpecific, 1);
2971 VmdkExtentInfoList **tail;
2973 *spec_info = (ImageInfoSpecific){
2974 .type = IMAGE_INFO_SPECIFIC_KIND_VMDK,
2976 .vmdk.data = g_new0(ImageInfoSpecificVmdk, 1),
2980 *spec_info->u.vmdk.data = (ImageInfoSpecificVmdk) {
2981 .create_type = g_strdup(s->create_type),
2983 .parent_cid = s->parent_cid,
2986 tail = &spec_info->u.vmdk.data->extents;
2987 for (i = 0; i < s->num_extents; i++) {
2988 QAPI_LIST_APPEND(tail, vmdk_get_extent_info(&s->extents[i]));
2994 static bool vmdk_extents_type_eq(const VmdkExtent *a, const VmdkExtent *b)
2996 return a->flat == b->flat &&
2997 a->compressed == b->compressed &&
2998 (a->flat || a->cluster_sectors == b->cluster_sectors);
3001 static int coroutine_fn
3002 vmdk_co_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
3005 BDRVVmdkState *s = bs->opaque;
3006 assert(s->num_extents);
3008 /* See if we have multiple extents but they have different cases */
3009 for (i = 1; i < s->num_extents; i++) {
3010 if (!vmdk_extents_type_eq(&s->extents[0], &s->extents[i])) {
3014 bdi->needs_compressed_writes = s->extents[0].compressed;
3015 if (!s->extents[0].flat) {
3016 bdi->cluster_size = s->extents[0].cluster_sectors << BDRV_SECTOR_BITS;
3021 static void vmdk_gather_child_options(BlockDriverState *bs, QDict *target,
3022 bool backing_overridden)
3024 /* No children but file and backing can be explicitly specified (TODO) */
3025 qdict_put(target, "file",
3026 qobject_ref(bs->file->bs->full_open_options));
3028 if (backing_overridden) {
3030 qdict_put(target, "backing",
3031 qobject_ref(bs->backing->bs->full_open_options));
3033 qdict_put_null(target, "backing");
3038 static QemuOptsList vmdk_create_opts = {
3039 .name = "vmdk-create-opts",
3040 .head = QTAILQ_HEAD_INITIALIZER(vmdk_create_opts.head),
3043 .name = BLOCK_OPT_SIZE,
3044 .type = QEMU_OPT_SIZE,
3045 .help = "Virtual disk size"
3048 .name = BLOCK_OPT_ADAPTER_TYPE,
3049 .type = QEMU_OPT_STRING,
3050 .help = "Virtual adapter type, can be one of "
3051 "ide (default), lsilogic, buslogic or legacyESX"
3054 .name = BLOCK_OPT_BACKING_FILE,
3055 .type = QEMU_OPT_STRING,
3056 .help = "File name of a base image"
3059 .name = BLOCK_OPT_BACKING_FMT,
3060 .type = QEMU_OPT_STRING,
3061 .help = "Must be 'vmdk' if present",
3064 .name = BLOCK_OPT_COMPAT6,
3065 .type = QEMU_OPT_BOOL,
3066 .help = "VMDK version 6 image",
3067 .def_value_str = "off"
3070 .name = BLOCK_OPT_HWVERSION,
3071 .type = QEMU_OPT_STRING,
3072 .help = "VMDK hardware version",
3073 .def_value_str = "undefined"
3076 .name = BLOCK_OPT_TOOLSVERSION,
3077 .type = QEMU_OPT_STRING,
3078 .help = "VMware guest tools version",
3081 .name = BLOCK_OPT_SUBFMT,
3082 .type = QEMU_OPT_STRING,
3084 "VMDK flat extent format, can be one of "
3085 "{monolithicSparse (default) | monolithicFlat | twoGbMaxExtentSparse | twoGbMaxExtentFlat | streamOptimized} "
3088 .name = BLOCK_OPT_ZEROED_GRAIN,
3089 .type = QEMU_OPT_BOOL,
3090 .help = "Enable efficient zero writes "
3091 "using the zeroed-grain GTE feature"
3093 { /* end of list */ }
3097 static BlockDriver bdrv_vmdk = {
3098 .format_name = "vmdk",
3099 .instance_size = sizeof(BDRVVmdkState),
3100 .bdrv_probe = vmdk_probe,
3101 .bdrv_open = vmdk_open,
3102 .bdrv_co_check = vmdk_co_check,
3103 .bdrv_reopen_prepare = vmdk_reopen_prepare,
3104 .bdrv_reopen_commit = vmdk_reopen_commit,
3105 .bdrv_reopen_abort = vmdk_reopen_abort,
3106 .bdrv_child_perm = bdrv_default_perms,
3107 .bdrv_co_preadv = vmdk_co_preadv,
3108 .bdrv_co_pwritev = vmdk_co_pwritev,
3109 .bdrv_co_pwritev_compressed = vmdk_co_pwritev_compressed,
3110 .bdrv_co_pwrite_zeroes = vmdk_co_pwrite_zeroes,
3111 .bdrv_close = vmdk_close,
3112 .bdrv_co_create_opts = vmdk_co_create_opts,
3113 .bdrv_co_create = vmdk_co_create,
3114 .bdrv_co_block_status = vmdk_co_block_status,
3115 .bdrv_co_get_allocated_file_size = vmdk_co_get_allocated_file_size,
3116 .bdrv_has_zero_init = vmdk_has_zero_init,
3117 .bdrv_get_specific_info = vmdk_get_specific_info,
3118 .bdrv_refresh_limits = vmdk_refresh_limits,
3119 .bdrv_co_get_info = vmdk_co_get_info,
3120 .bdrv_gather_child_options = vmdk_gather_child_options,
3123 .supports_backing = true,
3124 .create_opts = &vmdk_create_opts,
3127 static void bdrv_vmdk_init(void)
3129 bdrv_register(&bdrv_vmdk);
3132 block_init(bdrv_vmdk_init);