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"
33 #define VMDK3_MAGIC (('C' << 24) | ('O' << 16) | ('W' << 8) | 'D')
34 #define VMDK4_MAGIC (('K' << 24) | ('D' << 16) | ('M' << 8) | 'V')
35 #define VMDK4_COMPRESSION_DEFLATE 1
36 #define VMDK4_FLAG_NL_DETECT (1 << 0)
37 #define VMDK4_FLAG_RGD (1 << 1)
38 /* Zeroed-grain enable bit */
39 #define VMDK4_FLAG_ZERO_GRAIN (1 << 2)
40 #define VMDK4_FLAG_COMPRESS (1 << 16)
41 #define VMDK4_FLAG_MARKER (1 << 17)
42 #define VMDK4_GD_AT_END 0xffffffffffffffffULL
44 #define VMDK_GTE_ZEROED 0x1
46 /* VMDK internal error codes */
48 #define VMDK_ERROR (-1)
49 /* Cluster not allocated */
50 #define VMDK_UNALLOC (-2)
51 #define VMDK_ZEROED (-3)
53 #define BLOCK_OPT_ZEROED_GRAIN "zeroed_grain"
58 uint32_t disk_sectors
;
60 uint32_t l1dir_offset
;
62 uint32_t file_sectors
;
65 uint32_t sectors_per_track
;
66 } QEMU_PACKED VMDK3Header
;
75 /* Number of GrainTableEntries per GrainTable */
76 uint32_t num_gtes_per_gt
;
79 uint64_t grain_offset
;
82 uint16_t compressAlgorithm
;
83 } QEMU_PACKED VMDK4Header
;
85 #define L2_CACHE_SIZE 16
87 typedef struct VmdkExtent
{
88 BlockDriverState
*file
;
96 int64_t flat_start_offset
;
97 int64_t l1_table_offset
;
98 int64_t l1_backup_table_offset
;
100 uint32_t *l1_backup_table
;
101 unsigned int l1_size
;
102 uint32_t l1_entry_sectors
;
104 unsigned int l2_size
;
106 uint32_t l2_cache_offsets
[L2_CACHE_SIZE
];
107 uint32_t l2_cache_counts
[L2_CACHE_SIZE
];
109 int64_t cluster_sectors
;
110 int64_t next_cluster_sector
;
114 typedef struct BDRVVmdkState
{
116 uint64_t desc_offset
;
122 /* Extent array with num_extents entries, ascend ordered by address */
124 Error
*migration_blocker
;
128 typedef struct VmdkMetaData
{
129 unsigned int l1_index
;
130 unsigned int l2_index
;
131 unsigned int l2_offset
;
133 uint32_t *l2_cache_entry
;
136 typedef struct VmdkGrainMarker
{
140 } QEMU_PACKED VmdkGrainMarker
;
143 MARKER_END_OF_STREAM
= 0,
144 MARKER_GRAIN_TABLE
= 1,
145 MARKER_GRAIN_DIRECTORY
= 2,
149 static int vmdk_probe(const uint8_t *buf
, int buf_size
, const char *filename
)
156 magic
= be32_to_cpu(*(uint32_t *)buf
);
157 if (magic
== VMDK3_MAGIC
||
158 magic
== VMDK4_MAGIC
) {
161 const char *p
= (const char *)buf
;
162 const char *end
= p
+ buf_size
;
165 /* skip comment line */
166 while (p
< end
&& *p
!= '\n') {
173 while (p
< end
&& *p
== ' ') {
176 /* skip '\r' if windows line endings used. */
177 if (p
< end
&& *p
== '\r') {
180 /* only accept blank lines before 'version=' line */
181 if (p
== end
|| *p
!= '\n') {
187 if (end
- p
>= strlen("version=X\n")) {
188 if (strncmp("version=1\n", p
, strlen("version=1\n")) == 0 ||
189 strncmp("version=2\n", p
, strlen("version=2\n")) == 0) {
193 if (end
- p
>= strlen("version=X\r\n")) {
194 if (strncmp("version=1\r\n", p
, strlen("version=1\r\n")) == 0 ||
195 strncmp("version=2\r\n", p
, strlen("version=2\r\n")) == 0) {
205 #define SECTOR_SIZE 512
206 #define DESC_SIZE (20 * SECTOR_SIZE) /* 20 sectors of 512 bytes each */
207 #define BUF_SIZE 4096
208 #define HEADER_SIZE 512 /* first sector of 512 bytes */
210 static void vmdk_free_extents(BlockDriverState
*bs
)
213 BDRVVmdkState
*s
= bs
->opaque
;
216 for (i
= 0; i
< s
->num_extents
; i
++) {
220 g_free(e
->l1_backup_table
);
222 if (e
->file
!= bs
->file
) {
229 static void vmdk_free_last_extent(BlockDriverState
*bs
)
231 BDRVVmdkState
*s
= bs
->opaque
;
233 if (s
->num_extents
== 0) {
237 s
->extents
= g_renew(VmdkExtent
, s
->extents
, s
->num_extents
);
240 static uint32_t vmdk_read_cid(BlockDriverState
*bs
, int parent
)
242 char desc
[DESC_SIZE
];
243 uint32_t cid
= 0xffffffff;
244 const char *p_name
, *cid_str
;
246 BDRVVmdkState
*s
= bs
->opaque
;
249 ret
= bdrv_pread(bs
->file
, s
->desc_offset
, desc
, DESC_SIZE
);
255 cid_str
= "parentCID";
256 cid_str_size
= sizeof("parentCID");
259 cid_str_size
= sizeof("CID");
262 desc
[DESC_SIZE
- 1] = '\0';
263 p_name
= strstr(desc
, cid_str
);
264 if (p_name
!= NULL
) {
265 p_name
+= cid_str_size
;
266 sscanf(p_name
, "%" SCNx32
, &cid
);
272 static int vmdk_write_cid(BlockDriverState
*bs
, uint32_t cid
)
274 char desc
[DESC_SIZE
], tmp_desc
[DESC_SIZE
];
275 char *p_name
, *tmp_str
;
276 BDRVVmdkState
*s
= bs
->opaque
;
279 ret
= bdrv_pread(bs
->file
, s
->desc_offset
, desc
, DESC_SIZE
);
284 desc
[DESC_SIZE
- 1] = '\0';
285 tmp_str
= strstr(desc
, "parentCID");
286 if (tmp_str
== NULL
) {
290 pstrcpy(tmp_desc
, sizeof(tmp_desc
), tmp_str
);
291 p_name
= strstr(desc
, "CID");
292 if (p_name
!= NULL
) {
293 p_name
+= sizeof("CID");
294 snprintf(p_name
, sizeof(desc
) - (p_name
- desc
), "%" PRIx32
"\n", cid
);
295 pstrcat(desc
, sizeof(desc
), tmp_desc
);
298 ret
= bdrv_pwrite_sync(bs
->file
, s
->desc_offset
, desc
, DESC_SIZE
);
306 static int vmdk_is_cid_valid(BlockDriverState
*bs
)
308 BDRVVmdkState
*s
= bs
->opaque
;
309 BlockDriverState
*p_bs
= bs
->backing_hd
;
312 if (!s
->cid_checked
&& p_bs
) {
313 cur_pcid
= vmdk_read_cid(p_bs
, 0);
314 if (s
->parent_cid
!= cur_pcid
) {
319 s
->cid_checked
= true;
324 /* Queue extents, if any, for reopen() */
325 static int vmdk_reopen_prepare(BDRVReopenState
*state
,
326 BlockReopenQueue
*queue
, Error
**errp
)
333 assert(state
!= NULL
);
334 assert(state
->bs
!= NULL
);
337 error_setg(errp
, "No reopen queue for VMDK extents");
341 s
= state
->bs
->opaque
;
345 for (i
= 0; i
< s
->num_extents
; i
++) {
347 if (e
->file
!= state
->bs
->file
) {
348 bdrv_reopen_queue(queue
, e
->file
, state
->flags
);
357 static int vmdk_parent_open(BlockDriverState
*bs
)
360 char desc
[DESC_SIZE
+ 1];
361 BDRVVmdkState
*s
= bs
->opaque
;
364 desc
[DESC_SIZE
] = '\0';
365 ret
= bdrv_pread(bs
->file
, s
->desc_offset
, desc
, DESC_SIZE
);
370 p_name
= strstr(desc
, "parentFileNameHint");
371 if (p_name
!= NULL
) {
374 p_name
+= sizeof("parentFileNameHint") + 1;
375 end_name
= strchr(p_name
, '\"');
376 if (end_name
== NULL
) {
379 if ((end_name
- p_name
) > sizeof(bs
->backing_file
) - 1) {
383 pstrcpy(bs
->backing_file
, end_name
- p_name
+ 1, p_name
);
389 /* Create and append extent to the extent array. Return the added VmdkExtent
390 * address. return NULL if allocation failed. */
391 static int vmdk_add_extent(BlockDriverState
*bs
,
392 BlockDriverState
*file
, bool flat
, int64_t sectors
,
393 int64_t l1_offset
, int64_t l1_backup_offset
,
395 int l2_size
, uint64_t cluster_sectors
,
396 VmdkExtent
**new_extent
,
400 BDRVVmdkState
*s
= bs
->opaque
;
403 if (cluster_sectors
> 0x200000) {
404 /* 0x200000 * 512Bytes = 1GB for one cluster is unrealistic */
405 error_setg(errp
, "Invalid granularity, image may be corrupt");
408 if (l1_size
> 512 * 1024 * 1024) {
409 /* Although with big capacity and small l1_entry_sectors, we can get a
410 * big l1_size, we don't want unbounded value to allocate the table.
411 * Limit it to 512M, which is 16PB for default cluster and L2 table
413 error_setg(errp
, "L1 size too big");
417 nb_sectors
= bdrv_nb_sectors(file
);
418 if (nb_sectors
< 0) {
422 s
->extents
= g_renew(VmdkExtent
, s
->extents
, s
->num_extents
+ 1);
423 extent
= &s
->extents
[s
->num_extents
];
426 memset(extent
, 0, sizeof(VmdkExtent
));
429 extent
->sectors
= sectors
;
430 extent
->l1_table_offset
= l1_offset
;
431 extent
->l1_backup_table_offset
= l1_backup_offset
;
432 extent
->l1_size
= l1_size
;
433 extent
->l1_entry_sectors
= l2_size
* cluster_sectors
;
434 extent
->l2_size
= l2_size
;
435 extent
->cluster_sectors
= flat
? sectors
: cluster_sectors
;
436 extent
->next_cluster_sector
= ROUND_UP(nb_sectors
, cluster_sectors
);
438 if (s
->num_extents
> 1) {
439 extent
->end_sector
= (*(extent
- 1)).end_sector
+ extent
->sectors
;
441 extent
->end_sector
= extent
->sectors
;
443 bs
->total_sectors
= extent
->end_sector
;
445 *new_extent
= extent
;
450 static int vmdk_init_tables(BlockDriverState
*bs
, VmdkExtent
*extent
,
456 /* read the L1 table */
457 l1_size
= extent
->l1_size
* sizeof(uint32_t);
458 extent
->l1_table
= g_try_malloc(l1_size
);
459 if (l1_size
&& extent
->l1_table
== NULL
) {
463 ret
= bdrv_pread(extent
->file
,
464 extent
->l1_table_offset
,
468 error_setg_errno(errp
, -ret
,
469 "Could not read l1 table from extent '%s'",
470 extent
->file
->filename
);
473 for (i
= 0; i
< extent
->l1_size
; i
++) {
474 le32_to_cpus(&extent
->l1_table
[i
]);
477 if (extent
->l1_backup_table_offset
) {
478 extent
->l1_backup_table
= g_try_malloc(l1_size
);
479 if (l1_size
&& extent
->l1_backup_table
== NULL
) {
483 ret
= bdrv_pread(extent
->file
,
484 extent
->l1_backup_table_offset
,
485 extent
->l1_backup_table
,
488 error_setg_errno(errp
, -ret
,
489 "Could not read l1 backup table from extent '%s'",
490 extent
->file
->filename
);
493 for (i
= 0; i
< extent
->l1_size
; i
++) {
494 le32_to_cpus(&extent
->l1_backup_table
[i
]);
499 g_new(uint32_t, extent
->l2_size
* L2_CACHE_SIZE
);
502 g_free(extent
->l1_backup_table
);
504 g_free(extent
->l1_table
);
508 static int vmdk_open_vmfs_sparse(BlockDriverState
*bs
,
509 BlockDriverState
*file
,
510 int flags
, Error
**errp
)
517 ret
= bdrv_pread(file
, sizeof(magic
), &header
, sizeof(header
));
519 error_setg_errno(errp
, -ret
,
520 "Could not read header from file '%s'",
524 ret
= vmdk_add_extent(bs
, file
, false,
525 le32_to_cpu(header
.disk_sectors
),
526 le32_to_cpu(header
.l1dir_offset
) << 9,
528 le32_to_cpu(header
.l1dir_size
),
530 le32_to_cpu(header
.granularity
),
536 ret
= vmdk_init_tables(bs
, extent
, errp
);
538 /* free extent allocated by vmdk_add_extent */
539 vmdk_free_last_extent(bs
);
544 static int vmdk_open_desc_file(BlockDriverState
*bs
, int flags
, char *buf
,
547 static char *vmdk_read_desc(BlockDriverState
*file
, uint64_t desc_offset
,
554 size
= bdrv_getlength(file
);
556 error_setg_errno(errp
, -size
, "Could not access file");
561 /* Both descriptor file and sparse image must be much larger than 4
562 * bytes, also callers of vmdk_read_desc want to compare the first 4
563 * bytes with VMDK4_MAGIC, let's error out if less is read. */
564 error_setg(errp
, "File is too small, not a valid image");
568 size
= MIN(size
, (1 << 20) - 1); /* avoid unbounded allocation */
569 buf
= g_malloc(size
+ 1);
571 ret
= bdrv_pread(file
, desc_offset
, buf
, size
);
573 error_setg_errno(errp
, -ret
, "Could not read from file");
582 static int vmdk_open_vmdk4(BlockDriverState
*bs
,
583 BlockDriverState
*file
,
584 int flags
, Error
**errp
)
588 uint32_t l1_size
, l1_entry_sectors
;
591 BDRVVmdkState
*s
= bs
->opaque
;
592 int64_t l1_backup_offset
= 0;
594 ret
= bdrv_pread(file
, sizeof(magic
), &header
, sizeof(header
));
596 error_setg_errno(errp
, -ret
,
597 "Could not read header from file '%s'",
601 if (header
.capacity
== 0) {
602 uint64_t desc_offset
= le64_to_cpu(header
.desc_offset
);
604 char *buf
= vmdk_read_desc(file
, desc_offset
<< 9, errp
);
608 ret
= vmdk_open_desc_file(bs
, flags
, buf
, errp
);
614 if (!s
->create_type
) {
615 s
->create_type
= g_strdup("monolithicSparse");
618 if (le64_to_cpu(header
.gd_offset
) == VMDK4_GD_AT_END
) {
620 * The footer takes precedence over the header, so read it in. The
621 * footer starts at offset -1024 from the end: One sector for the
622 * footer, and another one for the end-of-stream marker.
629 uint8_t pad
[512 - 16];
630 } QEMU_PACKED footer_marker
;
634 uint8_t pad
[512 - 4 - sizeof(VMDK4Header
)];
640 uint8_t pad
[512 - 16];
641 } QEMU_PACKED eos_marker
;
642 } QEMU_PACKED footer
;
644 ret
= bdrv_pread(file
,
645 bs
->file
->total_sectors
* 512 - 1536,
646 &footer
, sizeof(footer
));
648 error_setg_errno(errp
, -ret
, "Failed to read footer");
652 /* Some sanity checks for the footer */
653 if (be32_to_cpu(footer
.magic
) != VMDK4_MAGIC
||
654 le32_to_cpu(footer
.footer_marker
.size
) != 0 ||
655 le32_to_cpu(footer
.footer_marker
.type
) != MARKER_FOOTER
||
656 le64_to_cpu(footer
.eos_marker
.val
) != 0 ||
657 le32_to_cpu(footer
.eos_marker
.size
) != 0 ||
658 le32_to_cpu(footer
.eos_marker
.type
) != MARKER_END_OF_STREAM
)
660 error_setg(errp
, "Invalid footer");
664 header
= footer
.header
;
667 if (le32_to_cpu(header
.version
) > 3) {
669 snprintf(buf
, sizeof(buf
), "VMDK version %" PRId32
,
670 le32_to_cpu(header
.version
));
671 error_set(errp
, QERR_UNKNOWN_BLOCK_FORMAT_FEATURE
,
672 bdrv_get_device_name(bs
), "vmdk", buf
);
674 } else if (le32_to_cpu(header
.version
) == 3 && (flags
& BDRV_O_RDWR
)) {
675 /* VMware KB 2064959 explains that version 3 added support for
676 * persistent changed block tracking (CBT), and backup software can
677 * read it as version=1 if it doesn't care about the changed area
678 * information. So we are safe to enable read only. */
679 error_setg(errp
, "VMDK version 3 must be read only");
683 if (le32_to_cpu(header
.num_gtes_per_gt
) > 512) {
684 error_setg(errp
, "L2 table size too big");
688 l1_entry_sectors
= le32_to_cpu(header
.num_gtes_per_gt
)
689 * le64_to_cpu(header
.granularity
);
690 if (l1_entry_sectors
== 0) {
691 error_setg(errp
, "L1 entry size is invalid");
694 l1_size
= (le64_to_cpu(header
.capacity
) + l1_entry_sectors
- 1)
696 if (le32_to_cpu(header
.flags
) & VMDK4_FLAG_RGD
) {
697 l1_backup_offset
= le64_to_cpu(header
.rgd_offset
) << 9;
699 if (bdrv_nb_sectors(file
) < le64_to_cpu(header
.grain_offset
)) {
700 error_setg(errp
, "File truncated, expecting at least %" PRId64
" bytes",
701 (int64_t)(le64_to_cpu(header
.grain_offset
)
702 * BDRV_SECTOR_SIZE
));
706 ret
= vmdk_add_extent(bs
, file
, false,
707 le64_to_cpu(header
.capacity
),
708 le64_to_cpu(header
.gd_offset
) << 9,
711 le32_to_cpu(header
.num_gtes_per_gt
),
712 le64_to_cpu(header
.granularity
),
719 le16_to_cpu(header
.compressAlgorithm
) == VMDK4_COMPRESSION_DEFLATE
;
720 if (extent
->compressed
) {
721 g_free(s
->create_type
);
722 s
->create_type
= g_strdup("streamOptimized");
724 extent
->has_marker
= le32_to_cpu(header
.flags
) & VMDK4_FLAG_MARKER
;
725 extent
->version
= le32_to_cpu(header
.version
);
726 extent
->has_zero_grain
= le32_to_cpu(header
.flags
) & VMDK4_FLAG_ZERO_GRAIN
;
727 ret
= vmdk_init_tables(bs
, extent
, errp
);
729 /* free extent allocated by vmdk_add_extent */
730 vmdk_free_last_extent(bs
);
735 /* find an option value out of descriptor file */
736 static int vmdk_parse_description(const char *desc
, const char *opt_name
,
737 char *buf
, int buf_size
)
739 char *opt_pos
, *opt_end
;
740 const char *end
= desc
+ strlen(desc
);
742 opt_pos
= strstr(desc
, opt_name
);
746 /* Skip "=\"" following opt_name */
747 opt_pos
+= strlen(opt_name
) + 2;
748 if (opt_pos
>= end
) {
752 while (opt_end
< end
&& *opt_end
!= '"') {
755 if (opt_end
== end
|| buf_size
< opt_end
- opt_pos
+ 1) {
758 pstrcpy(buf
, opt_end
- opt_pos
+ 1, opt_pos
);
762 /* Open an extent file and append to bs array */
763 static int vmdk_open_sparse(BlockDriverState
*bs
,
764 BlockDriverState
*file
, int flags
,
765 char *buf
, Error
**errp
)
769 magic
= ldl_be_p(buf
);
772 return vmdk_open_vmfs_sparse(bs
, file
, flags
, errp
);
775 return vmdk_open_vmdk4(bs
, file
, flags
, errp
);
778 error_setg(errp
, "Image not in VMDK format");
784 static int vmdk_parse_extents(const char *desc
, BlockDriverState
*bs
,
785 const char *desc_file_path
, Error
**errp
)
792 const char *p
= desc
;
796 BlockDriverState
*extent_file
;
797 BDRVVmdkState
*s
= bs
->opaque
;
801 /* parse extent line in one of below formats:
803 * RW [size in sectors] FLAT "file-name.vmdk" OFFSET
804 * RW [size in sectors] SPARSE "file-name.vmdk"
805 * RW [size in sectors] VMFS "file-name.vmdk"
806 * RW [size in sectors] VMFSSPARSE "file-name.vmdk"
809 matches
= sscanf(p
, "%10s %" SCNd64
" %10s \"%511[^\n\r\"]\" %" SCNd64
,
810 access
, §ors
, type
, fname
, &flat_offset
);
811 if (matches
< 4 || strcmp(access
, "RW")) {
813 } else if (!strcmp(type
, "FLAT")) {
814 if (matches
!= 5 || flat_offset
< 0) {
815 error_setg(errp
, "Invalid extent lines: \n%s", p
);
818 } else if (!strcmp(type
, "VMFS")) {
822 error_setg(errp
, "Invalid extent lines:\n%s", p
);
825 } else if (matches
!= 4) {
826 error_setg(errp
, "Invalid extent lines:\n%s", p
);
831 (strcmp(type
, "FLAT") && strcmp(type
, "SPARSE") &&
832 strcmp(type
, "VMFS") && strcmp(type
, "VMFSSPARSE")) ||
833 (strcmp(access
, "RW"))) {
837 if (!path_is_absolute(fname
) && !path_has_protocol(fname
) &&
840 error_setg(errp
, "Cannot use relative extent paths with VMDK "
841 "descriptor file '%s'", bs
->file
->filename
);
845 extent_path
= g_malloc0(PATH_MAX
);
846 path_combine(extent_path
, PATH_MAX
, desc_file_path
, fname
);
848 ret
= bdrv_open(&extent_file
, extent_path
, NULL
, NULL
,
849 bs
->open_flags
| BDRV_O_PROTOCOL
, NULL
, errp
);
855 /* save to extents array */
856 if (!strcmp(type
, "FLAT") || !strcmp(type
, "VMFS")) {
859 ret
= vmdk_add_extent(bs
, extent_file
, true, sectors
,
860 0, 0, 0, 0, 0, &extent
, errp
);
862 bdrv_unref(extent_file
);
865 extent
->flat_start_offset
= flat_offset
<< 9;
866 } else if (!strcmp(type
, "SPARSE") || !strcmp(type
, "VMFSSPARSE")) {
867 /* SPARSE extent and VMFSSPARSE extent are both "COWD" sparse file*/
868 char *buf
= vmdk_read_desc(extent_file
, 0, errp
);
872 ret
= vmdk_open_sparse(bs
, extent_file
, bs
->open_flags
, buf
, errp
);
876 bdrv_unref(extent_file
);
879 extent
= &s
->extents
[s
->num_extents
- 1];
881 error_setg(errp
, "Unsupported extent type '%s'", type
);
882 bdrv_unref(extent_file
);
885 extent
->type
= g_strdup(type
);
887 /* move to next line */
899 static int vmdk_open_desc_file(BlockDriverState
*bs
, int flags
, char *buf
,
904 BDRVVmdkState
*s
= bs
->opaque
;
906 if (vmdk_parse_description(buf
, "createType", ct
, sizeof(ct
))) {
907 error_setg(errp
, "invalid VMDK image descriptor");
911 if (strcmp(ct
, "monolithicFlat") &&
912 strcmp(ct
, "vmfs") &&
913 strcmp(ct
, "vmfsSparse") &&
914 strcmp(ct
, "twoGbMaxExtentSparse") &&
915 strcmp(ct
, "twoGbMaxExtentFlat")) {
916 error_setg(errp
, "Unsupported image type '%s'", ct
);
920 s
->create_type
= g_strdup(ct
);
922 ret
= vmdk_parse_extents(buf
, bs
, bs
->file
->exact_filename
, errp
);
927 static int vmdk_open(BlockDriverState
*bs
, QDict
*options
, int flags
,
932 BDRVVmdkState
*s
= bs
->opaque
;
935 buf
= vmdk_read_desc(bs
->file
, 0, errp
);
940 magic
= ldl_be_p(buf
);
944 ret
= vmdk_open_sparse(bs
, bs
->file
, flags
, buf
, errp
);
945 s
->desc_offset
= 0x200;
948 ret
= vmdk_open_desc_file(bs
, flags
, buf
, errp
);
955 /* try to open parent images, if exist */
956 ret
= vmdk_parent_open(bs
);
960 s
->cid
= vmdk_read_cid(bs
, 0);
961 s
->parent_cid
= vmdk_read_cid(bs
, 1);
962 qemu_co_mutex_init(&s
->lock
);
964 /* Disable migration when VMDK images are used */
965 error_set(&s
->migration_blocker
,
966 QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED
,
967 "vmdk", bdrv_get_device_name(bs
), "live migration");
968 migrate_add_blocker(s
->migration_blocker
);
974 g_free(s
->create_type
);
975 s
->create_type
= NULL
;
976 vmdk_free_extents(bs
);
981 static void vmdk_refresh_limits(BlockDriverState
*bs
, Error
**errp
)
983 BDRVVmdkState
*s
= bs
->opaque
;
986 for (i
= 0; i
< s
->num_extents
; i
++) {
987 if (!s
->extents
[i
].flat
) {
988 bs
->bl
.write_zeroes_alignment
=
989 MAX(bs
->bl
.write_zeroes_alignment
,
990 s
->extents
[i
].cluster_sectors
);
998 * Copy backing file's cluster that covers @sector_num, otherwise write zero,
999 * to the cluster at @cluster_sector_num.
1001 * If @skip_start_sector < @skip_end_sector, the relative range
1002 * [@skip_start_sector, @skip_end_sector) is not copied or written, and leave
1003 * it for call to write user data in the request.
1005 static int get_whole_cluster(BlockDriverState
*bs
,
1007 uint64_t cluster_sector_num
,
1008 uint64_t sector_num
,
1009 uint64_t skip_start_sector
,
1010 uint64_t skip_end_sector
)
1013 int64_t cluster_bytes
;
1014 uint8_t *whole_grain
;
1016 /* For COW, align request sector_num to cluster start */
1017 sector_num
= QEMU_ALIGN_DOWN(sector_num
, extent
->cluster_sectors
);
1018 cluster_bytes
= extent
->cluster_sectors
<< BDRV_SECTOR_BITS
;
1019 whole_grain
= qemu_blockalign(bs
, cluster_bytes
);
1021 if (!bs
->backing_hd
) {
1022 memset(whole_grain
, 0, skip_start_sector
<< BDRV_SECTOR_BITS
);
1023 memset(whole_grain
+ (skip_end_sector
<< BDRV_SECTOR_BITS
), 0,
1024 cluster_bytes
- (skip_end_sector
<< BDRV_SECTOR_BITS
));
1027 assert(skip_end_sector
<= extent
->cluster_sectors
);
1028 /* we will be here if it's first write on non-exist grain(cluster).
1029 * try to read from parent image, if exist */
1030 if (bs
->backing_hd
&& !vmdk_is_cid_valid(bs
)) {
1035 /* Read backing data before skip range */
1036 if (skip_start_sector
> 0) {
1037 if (bs
->backing_hd
) {
1038 ret
= bdrv_read(bs
->backing_hd
, sector_num
,
1039 whole_grain
, skip_start_sector
);
1045 ret
= bdrv_write(extent
->file
, cluster_sector_num
, whole_grain
,
1052 /* Read backing data after skip range */
1053 if (skip_end_sector
< extent
->cluster_sectors
) {
1054 if (bs
->backing_hd
) {
1055 ret
= bdrv_read(bs
->backing_hd
, sector_num
+ skip_end_sector
,
1056 whole_grain
+ (skip_end_sector
<< BDRV_SECTOR_BITS
),
1057 extent
->cluster_sectors
- skip_end_sector
);
1063 ret
= bdrv_write(extent
->file
, cluster_sector_num
+ skip_end_sector
,
1064 whole_grain
+ (skip_end_sector
<< BDRV_SECTOR_BITS
),
1065 extent
->cluster_sectors
- skip_end_sector
);
1073 qemu_vfree(whole_grain
);
1077 static int vmdk_L2update(VmdkExtent
*extent
, VmdkMetaData
*m_data
,
1080 offset
= cpu_to_le32(offset
);
1081 /* update L2 table */
1082 if (bdrv_pwrite_sync(
1084 ((int64_t)m_data
->l2_offset
* 512)
1085 + (m_data
->l2_index
* sizeof(offset
)),
1086 &offset
, sizeof(offset
)) < 0) {
1089 /* update backup L2 table */
1090 if (extent
->l1_backup_table_offset
!= 0) {
1091 m_data
->l2_offset
= extent
->l1_backup_table
[m_data
->l1_index
];
1092 if (bdrv_pwrite_sync(
1094 ((int64_t)m_data
->l2_offset
* 512)
1095 + (m_data
->l2_index
* sizeof(offset
)),
1096 &offset
, sizeof(offset
)) < 0) {
1100 if (m_data
->l2_cache_entry
) {
1101 *m_data
->l2_cache_entry
= offset
;
1108 * get_cluster_offset
1110 * Look up cluster offset in extent file by sector number, and store in
1113 * For flat extents, the start offset as parsed from the description file is
1116 * For sparse extents, look up in L1, L2 table. If allocate is true, return an
1117 * offset for a new cluster and update L2 cache. If there is a backing file,
1118 * COW is done before returning; otherwise, zeroes are written to the allocated
1119 * cluster. Both COW and zero writing skips the sector range
1120 * [@skip_start_sector, @skip_end_sector) passed in by caller, because caller
1121 * has new data to write there.
1123 * Returns: VMDK_OK if cluster exists and mapped in the image.
1124 * VMDK_UNALLOC if cluster is not mapped and @allocate is false.
1125 * VMDK_ERROR if failed.
1127 static int get_cluster_offset(BlockDriverState
*bs
,
1129 VmdkMetaData
*m_data
,
1132 uint64_t *cluster_offset
,
1133 uint64_t skip_start_sector
,
1134 uint64_t skip_end_sector
)
1136 unsigned int l1_index
, l2_offset
, l2_index
;
1137 int min_index
, i
, j
;
1138 uint32_t min_count
, *l2_table
;
1139 bool zeroed
= false;
1141 int64_t cluster_sector
;
1147 *cluster_offset
= extent
->flat_start_offset
;
1151 offset
-= (extent
->end_sector
- extent
->sectors
) * SECTOR_SIZE
;
1152 l1_index
= (offset
>> 9) / extent
->l1_entry_sectors
;
1153 if (l1_index
>= extent
->l1_size
) {
1156 l2_offset
= extent
->l1_table
[l1_index
];
1158 return VMDK_UNALLOC
;
1160 for (i
= 0; i
< L2_CACHE_SIZE
; i
++) {
1161 if (l2_offset
== extent
->l2_cache_offsets
[i
]) {
1162 /* increment the hit count */
1163 if (++extent
->l2_cache_counts
[i
] == 0xffffffff) {
1164 for (j
= 0; j
< L2_CACHE_SIZE
; j
++) {
1165 extent
->l2_cache_counts
[j
] >>= 1;
1168 l2_table
= extent
->l2_cache
+ (i
* extent
->l2_size
);
1172 /* not found: load a new entry in the least used one */
1174 min_count
= 0xffffffff;
1175 for (i
= 0; i
< L2_CACHE_SIZE
; i
++) {
1176 if (extent
->l2_cache_counts
[i
] < min_count
) {
1177 min_count
= extent
->l2_cache_counts
[i
];
1181 l2_table
= extent
->l2_cache
+ (min_index
* extent
->l2_size
);
1184 (int64_t)l2_offset
* 512,
1186 extent
->l2_size
* sizeof(uint32_t)
1187 ) != extent
->l2_size
* sizeof(uint32_t)) {
1191 extent
->l2_cache_offsets
[min_index
] = l2_offset
;
1192 extent
->l2_cache_counts
[min_index
] = 1;
1194 l2_index
= ((offset
>> 9) / extent
->cluster_sectors
) % extent
->l2_size
;
1195 cluster_sector
= le32_to_cpu(l2_table
[l2_index
]);
1199 m_data
->l1_index
= l1_index
;
1200 m_data
->l2_index
= l2_index
;
1201 m_data
->l2_offset
= l2_offset
;
1202 m_data
->l2_cache_entry
= &l2_table
[l2_index
];
1204 if (extent
->has_zero_grain
&& cluster_sector
== VMDK_GTE_ZEROED
) {
1208 if (!cluster_sector
|| zeroed
) {
1210 return zeroed
? VMDK_ZEROED
: VMDK_UNALLOC
;
1213 cluster_sector
= extent
->next_cluster_sector
;
1214 extent
->next_cluster_sector
+= extent
->cluster_sectors
;
1216 /* First of all we write grain itself, to avoid race condition
1217 * that may to corrupt the image.
1218 * This problem may occur because of insufficient space on host disk
1219 * or inappropriate VM shutdown.
1221 ret
= get_whole_cluster(bs
, extent
,
1223 offset
>> BDRV_SECTOR_BITS
,
1224 skip_start_sector
, skip_end_sector
);
1229 *cluster_offset
= cluster_sector
<< BDRV_SECTOR_BITS
;
1233 static VmdkExtent
*find_extent(BDRVVmdkState
*s
,
1234 int64_t sector_num
, VmdkExtent
*start_hint
)
1236 VmdkExtent
*extent
= start_hint
;
1239 extent
= &s
->extents
[0];
1241 while (extent
< &s
->extents
[s
->num_extents
]) {
1242 if (sector_num
< extent
->end_sector
) {
1250 static int64_t coroutine_fn
vmdk_co_get_block_status(BlockDriverState
*bs
,
1251 int64_t sector_num
, int nb_sectors
, int *pnum
)
1253 BDRVVmdkState
*s
= bs
->opaque
;
1254 int64_t index_in_cluster
, n
, ret
;
1258 extent
= find_extent(s
, sector_num
, NULL
);
1262 qemu_co_mutex_lock(&s
->lock
);
1263 ret
= get_cluster_offset(bs
, extent
, NULL
,
1264 sector_num
* 512, false, &offset
,
1266 qemu_co_mutex_unlock(&s
->lock
);
1276 ret
= BDRV_BLOCK_ZERO
;
1279 ret
= BDRV_BLOCK_DATA
;
1280 if (extent
->file
== bs
->file
&& !extent
->compressed
) {
1281 ret
|= BDRV_BLOCK_OFFSET_VALID
| offset
;
1287 index_in_cluster
= sector_num
% extent
->cluster_sectors
;
1288 n
= extent
->cluster_sectors
- index_in_cluster
;
1289 if (n
> nb_sectors
) {
1296 static int vmdk_write_extent(VmdkExtent
*extent
, int64_t cluster_offset
,
1297 int64_t offset_in_cluster
, const uint8_t *buf
,
1298 int nb_sectors
, int64_t sector_num
)
1301 VmdkGrainMarker
*data
= NULL
;
1303 const uint8_t *write_buf
= buf
;
1304 int write_len
= nb_sectors
* 512;
1306 if (extent
->compressed
) {
1307 if (!extent
->has_marker
) {
1311 buf_len
= (extent
->cluster_sectors
<< 9) * 2;
1312 data
= g_malloc(buf_len
+ sizeof(VmdkGrainMarker
));
1313 if (compress(data
->data
, &buf_len
, buf
, nb_sectors
<< 9) != Z_OK
||
1318 data
->lba
= sector_num
;
1319 data
->size
= buf_len
;
1320 write_buf
= (uint8_t *)data
;
1321 write_len
= buf_len
+ sizeof(VmdkGrainMarker
);
1323 ret
= bdrv_pwrite(extent
->file
,
1324 cluster_offset
+ offset_in_cluster
,
1327 if (ret
!= write_len
) {
1328 ret
= ret
< 0 ? ret
: -EIO
;
1337 static int vmdk_read_extent(VmdkExtent
*extent
, int64_t cluster_offset
,
1338 int64_t offset_in_cluster
, uint8_t *buf
,
1342 int cluster_bytes
, buf_bytes
;
1343 uint8_t *cluster_buf
, *compressed_data
;
1344 uint8_t *uncomp_buf
;
1346 VmdkGrainMarker
*marker
;
1350 if (!extent
->compressed
) {
1351 ret
= bdrv_pread(extent
->file
,
1352 cluster_offset
+ offset_in_cluster
,
1353 buf
, nb_sectors
* 512);
1354 if (ret
== nb_sectors
* 512) {
1360 cluster_bytes
= extent
->cluster_sectors
* 512;
1361 /* Read two clusters in case GrainMarker + compressed data > one cluster */
1362 buf_bytes
= cluster_bytes
* 2;
1363 cluster_buf
= g_malloc(buf_bytes
);
1364 uncomp_buf
= g_malloc(cluster_bytes
);
1365 ret
= bdrv_pread(extent
->file
,
1367 cluster_buf
, buf_bytes
);
1371 compressed_data
= cluster_buf
;
1372 buf_len
= cluster_bytes
;
1373 data_len
= cluster_bytes
;
1374 if (extent
->has_marker
) {
1375 marker
= (VmdkGrainMarker
*)cluster_buf
;
1376 compressed_data
= marker
->data
;
1377 data_len
= le32_to_cpu(marker
->size
);
1379 if (!data_len
|| data_len
> buf_bytes
) {
1383 ret
= uncompress(uncomp_buf
, &buf_len
, compressed_data
, data_len
);
1389 if (offset_in_cluster
< 0 ||
1390 offset_in_cluster
+ nb_sectors
* 512 > buf_len
) {
1394 memcpy(buf
, uncomp_buf
+ offset_in_cluster
, nb_sectors
* 512);
1399 g_free(cluster_buf
);
1403 static int vmdk_read(BlockDriverState
*bs
, int64_t sector_num
,
1404 uint8_t *buf
, int nb_sectors
)
1406 BDRVVmdkState
*s
= bs
->opaque
;
1408 uint64_t n
, index_in_cluster
;
1409 uint64_t extent_begin_sector
, extent_relative_sector_num
;
1410 VmdkExtent
*extent
= NULL
;
1411 uint64_t cluster_offset
;
1413 while (nb_sectors
> 0) {
1414 extent
= find_extent(s
, sector_num
, extent
);
1418 ret
= get_cluster_offset(bs
, extent
, NULL
,
1419 sector_num
<< 9, false, &cluster_offset
,
1421 extent_begin_sector
= extent
->end_sector
- extent
->sectors
;
1422 extent_relative_sector_num
= sector_num
- extent_begin_sector
;
1423 index_in_cluster
= extent_relative_sector_num
% extent
->cluster_sectors
;
1424 n
= extent
->cluster_sectors
- index_in_cluster
;
1425 if (n
> nb_sectors
) {
1428 if (ret
!= VMDK_OK
) {
1429 /* if not allocated, try to read from parent image, if exist */
1430 if (bs
->backing_hd
&& ret
!= VMDK_ZEROED
) {
1431 if (!vmdk_is_cid_valid(bs
)) {
1434 ret
= bdrv_read(bs
->backing_hd
, sector_num
, buf
, n
);
1439 memset(buf
, 0, 512 * n
);
1442 ret
= vmdk_read_extent(extent
,
1443 cluster_offset
, index_in_cluster
* 512,
1456 static coroutine_fn
int vmdk_co_read(BlockDriverState
*bs
, int64_t sector_num
,
1457 uint8_t *buf
, int nb_sectors
)
1460 BDRVVmdkState
*s
= bs
->opaque
;
1461 qemu_co_mutex_lock(&s
->lock
);
1462 ret
= vmdk_read(bs
, sector_num
, buf
, nb_sectors
);
1463 qemu_co_mutex_unlock(&s
->lock
);
1469 * @zeroed: buf is ignored (data is zero), use zeroed_grain GTE feature
1470 * if possible, otherwise return -ENOTSUP.
1471 * @zero_dry_run: used for zeroed == true only, don't update L2 table, just try
1472 * with each cluster. By dry run we can find if the zero write
1473 * is possible without modifying image data.
1475 * Returns: error code with 0 for success.
1477 static int vmdk_write(BlockDriverState
*bs
, int64_t sector_num
,
1478 const uint8_t *buf
, int nb_sectors
,
1479 bool zeroed
, bool zero_dry_run
)
1481 BDRVVmdkState
*s
= bs
->opaque
;
1482 VmdkExtent
*extent
= NULL
;
1484 int64_t index_in_cluster
, n
;
1485 uint64_t extent_begin_sector
, extent_relative_sector_num
;
1486 uint64_t cluster_offset
;
1487 VmdkMetaData m_data
;
1489 if (sector_num
> bs
->total_sectors
) {
1490 error_report("Wrong offset: sector_num=0x%" PRIx64
1491 " total_sectors=0x%" PRIx64
"\n",
1492 sector_num
, bs
->total_sectors
);
1496 while (nb_sectors
> 0) {
1497 extent
= find_extent(s
, sector_num
, extent
);
1501 extent_begin_sector
= extent
->end_sector
- extent
->sectors
;
1502 extent_relative_sector_num
= sector_num
- extent_begin_sector
;
1503 index_in_cluster
= extent_relative_sector_num
% extent
->cluster_sectors
;
1504 n
= extent
->cluster_sectors
- index_in_cluster
;
1505 if (n
> nb_sectors
) {
1508 ret
= get_cluster_offset(bs
, extent
, &m_data
, sector_num
<< 9,
1509 !(extent
->compressed
|| zeroed
),
1511 index_in_cluster
, index_in_cluster
+ n
);
1512 if (extent
->compressed
) {
1513 if (ret
== VMDK_OK
) {
1514 /* Refuse write to allocated cluster for streamOptimized */
1515 error_report("Could not write to allocated cluster"
1516 " for streamOptimized");
1520 ret
= get_cluster_offset(bs
, extent
, &m_data
, sector_num
<< 9,
1521 true, &cluster_offset
, 0, 0);
1524 if (ret
== VMDK_ERROR
) {
1528 /* Do zeroed write, buf is ignored */
1529 if (extent
->has_zero_grain
&&
1530 index_in_cluster
== 0 &&
1531 n
>= extent
->cluster_sectors
) {
1532 n
= extent
->cluster_sectors
;
1533 if (!zero_dry_run
) {
1534 /* update L2 tables */
1535 if (vmdk_L2update(extent
, &m_data
, VMDK_GTE_ZEROED
)
1544 ret
= vmdk_write_extent(extent
,
1545 cluster_offset
, index_in_cluster
* 512,
1546 buf
, n
, sector_num
);
1551 /* update L2 tables */
1552 if (vmdk_L2update(extent
, &m_data
,
1553 cluster_offset
>> BDRV_SECTOR_BITS
)
1563 /* update CID on the first write every time the virtual disk is
1565 if (!s
->cid_updated
) {
1566 ret
= vmdk_write_cid(bs
, g_random_int());
1570 s
->cid_updated
= true;
1576 static coroutine_fn
int vmdk_co_write(BlockDriverState
*bs
, int64_t sector_num
,
1577 const uint8_t *buf
, int nb_sectors
)
1580 BDRVVmdkState
*s
= bs
->opaque
;
1581 qemu_co_mutex_lock(&s
->lock
);
1582 ret
= vmdk_write(bs
, sector_num
, buf
, nb_sectors
, false, false);
1583 qemu_co_mutex_unlock(&s
->lock
);
1587 static int vmdk_write_compressed(BlockDriverState
*bs
,
1592 BDRVVmdkState
*s
= bs
->opaque
;
1593 if (s
->num_extents
== 1 && s
->extents
[0].compressed
) {
1594 return vmdk_write(bs
, sector_num
, buf
, nb_sectors
, false, false);
1600 static int coroutine_fn
vmdk_co_write_zeroes(BlockDriverState
*bs
,
1603 BdrvRequestFlags flags
)
1606 BDRVVmdkState
*s
= bs
->opaque
;
1607 qemu_co_mutex_lock(&s
->lock
);
1608 /* write zeroes could fail if sectors not aligned to cluster, test it with
1609 * dry_run == true before really updating image */
1610 ret
= vmdk_write(bs
, sector_num
, NULL
, nb_sectors
, true, true);
1612 ret
= vmdk_write(bs
, sector_num
, NULL
, nb_sectors
, true, false);
1614 qemu_co_mutex_unlock(&s
->lock
);
1618 static int vmdk_create_extent(const char *filename
, int64_t filesize
,
1619 bool flat
, bool compress
, bool zeroed_grain
,
1620 QemuOpts
*opts
, Error
**errp
)
1623 BlockDriverState
*bs
= NULL
;
1625 Error
*local_err
= NULL
;
1626 uint32_t tmp
, magic
, grains
, gd_sectors
, gt_size
, gt_count
;
1627 uint32_t *gd_buf
= NULL
;
1630 ret
= bdrv_create_file(filename
, opts
, &local_err
);
1632 error_propagate(errp
, local_err
);
1637 ret
= bdrv_open(&bs
, filename
, NULL
, NULL
, BDRV_O_RDWR
| BDRV_O_PROTOCOL
,
1640 error_propagate(errp
, local_err
);
1645 ret
= bdrv_truncate(bs
, filesize
);
1647 error_setg_errno(errp
, -ret
, "Could not truncate file");
1651 magic
= cpu_to_be32(VMDK4_MAGIC
);
1652 memset(&header
, 0, sizeof(header
));
1653 header
.version
= zeroed_grain
? 2 : 1;
1654 header
.flags
= VMDK4_FLAG_RGD
| VMDK4_FLAG_NL_DETECT
1655 | (compress
? VMDK4_FLAG_COMPRESS
| VMDK4_FLAG_MARKER
: 0)
1656 | (zeroed_grain
? VMDK4_FLAG_ZERO_GRAIN
: 0);
1657 header
.compressAlgorithm
= compress
? VMDK4_COMPRESSION_DEFLATE
: 0;
1658 header
.capacity
= filesize
/ BDRV_SECTOR_SIZE
;
1659 header
.granularity
= 128;
1660 header
.num_gtes_per_gt
= BDRV_SECTOR_SIZE
;
1662 grains
= DIV_ROUND_UP(filesize
/ BDRV_SECTOR_SIZE
, header
.granularity
);
1663 gt_size
= DIV_ROUND_UP(header
.num_gtes_per_gt
* sizeof(uint32_t),
1665 gt_count
= DIV_ROUND_UP(grains
, header
.num_gtes_per_gt
);
1666 gd_sectors
= DIV_ROUND_UP(gt_count
* sizeof(uint32_t), BDRV_SECTOR_SIZE
);
1668 header
.desc_offset
= 1;
1669 header
.desc_size
= 20;
1670 header
.rgd_offset
= header
.desc_offset
+ header
.desc_size
;
1671 header
.gd_offset
= header
.rgd_offset
+ gd_sectors
+ (gt_size
* gt_count
);
1672 header
.grain_offset
=
1673 ROUND_UP(header
.gd_offset
+ gd_sectors
+ (gt_size
* gt_count
),
1674 header
.granularity
);
1675 /* swap endianness for all header fields */
1676 header
.version
= cpu_to_le32(header
.version
);
1677 header
.flags
= cpu_to_le32(header
.flags
);
1678 header
.capacity
= cpu_to_le64(header
.capacity
);
1679 header
.granularity
= cpu_to_le64(header
.granularity
);
1680 header
.num_gtes_per_gt
= cpu_to_le32(header
.num_gtes_per_gt
);
1681 header
.desc_offset
= cpu_to_le64(header
.desc_offset
);
1682 header
.desc_size
= cpu_to_le64(header
.desc_size
);
1683 header
.rgd_offset
= cpu_to_le64(header
.rgd_offset
);
1684 header
.gd_offset
= cpu_to_le64(header
.gd_offset
);
1685 header
.grain_offset
= cpu_to_le64(header
.grain_offset
);
1686 header
.compressAlgorithm
= cpu_to_le16(header
.compressAlgorithm
);
1688 header
.check_bytes
[0] = 0xa;
1689 header
.check_bytes
[1] = 0x20;
1690 header
.check_bytes
[2] = 0xd;
1691 header
.check_bytes
[3] = 0xa;
1693 /* write all the data */
1694 ret
= bdrv_pwrite(bs
, 0, &magic
, sizeof(magic
));
1696 error_set(errp
, QERR_IO_ERROR
);
1699 ret
= bdrv_pwrite(bs
, sizeof(magic
), &header
, sizeof(header
));
1701 error_set(errp
, QERR_IO_ERROR
);
1705 ret
= bdrv_truncate(bs
, le64_to_cpu(header
.grain_offset
) << 9);
1707 error_setg_errno(errp
, -ret
, "Could not truncate file");
1711 /* write grain directory */
1712 gd_buf_size
= gd_sectors
* BDRV_SECTOR_SIZE
;
1713 gd_buf
= g_malloc0(gd_buf_size
);
1714 for (i
= 0, tmp
= le64_to_cpu(header
.rgd_offset
) + gd_sectors
;
1715 i
< gt_count
; i
++, tmp
+= gt_size
) {
1716 gd_buf
[i
] = cpu_to_le32(tmp
);
1718 ret
= bdrv_pwrite(bs
, le64_to_cpu(header
.rgd_offset
) * BDRV_SECTOR_SIZE
,
1719 gd_buf
, gd_buf_size
);
1721 error_set(errp
, QERR_IO_ERROR
);
1725 /* write backup grain directory */
1726 for (i
= 0, tmp
= le64_to_cpu(header
.gd_offset
) + gd_sectors
;
1727 i
< gt_count
; i
++, tmp
+= gt_size
) {
1728 gd_buf
[i
] = cpu_to_le32(tmp
);
1730 ret
= bdrv_pwrite(bs
, le64_to_cpu(header
.gd_offset
) * BDRV_SECTOR_SIZE
,
1731 gd_buf
, gd_buf_size
);
1733 error_set(errp
, QERR_IO_ERROR
);
1746 static int filename_decompose(const char *filename
, char *path
, char *prefix
,
1747 char *postfix
, size_t buf_len
, Error
**errp
)
1751 if (filename
== NULL
|| !strlen(filename
)) {
1752 error_setg(errp
, "No filename provided");
1755 p
= strrchr(filename
, '/');
1757 p
= strrchr(filename
, '\\');
1760 p
= strrchr(filename
, ':');
1764 if (p
- filename
>= buf_len
) {
1767 pstrcpy(path
, p
- filename
+ 1, filename
);
1772 q
= strrchr(p
, '.');
1774 pstrcpy(prefix
, buf_len
, p
);
1777 if (q
- p
>= buf_len
) {
1780 pstrcpy(prefix
, q
- p
+ 1, p
);
1781 pstrcpy(postfix
, buf_len
, q
);
1786 static int vmdk_create(const char *filename
, QemuOpts
*opts
, Error
**errp
)
1789 BlockDriverState
*new_bs
= NULL
;
1790 Error
*local_err
= NULL
;
1792 int64_t total_size
= 0, filesize
;
1793 char *adapter_type
= NULL
;
1794 char *backing_file
= NULL
;
1798 bool flat
, split
, compress
;
1799 GString
*ext_desc_lines
;
1800 char *path
= g_malloc0(PATH_MAX
);
1801 char *prefix
= g_malloc0(PATH_MAX
);
1802 char *postfix
= g_malloc0(PATH_MAX
);
1803 char *desc_line
= g_malloc0(BUF_SIZE
);
1804 char *ext_filename
= g_malloc0(PATH_MAX
);
1805 char *desc_filename
= g_malloc0(PATH_MAX
);
1806 const int64_t split_size
= 0x80000000; /* VMDK has constant split size */
1807 const char *desc_extent_line
;
1808 char *parent_desc_line
= g_malloc0(BUF_SIZE
);
1809 uint32_t parent_cid
= 0xffffffff;
1810 uint32_t number_heads
= 16;
1811 bool zeroed_grain
= false;
1812 uint32_t desc_offset
= 0, desc_len
;
1813 const char desc_template
[] =
1814 "# Disk DescriptorFile\n"
1817 "parentCID=%" PRIx32
"\n"
1818 "createType=\"%s\"\n"
1821 "# Extent description\n"
1824 "# The Disk Data Base\n"
1827 "ddb.virtualHWVersion = \"%d\"\n"
1828 "ddb.geometry.cylinders = \"%" PRId64
"\"\n"
1829 "ddb.geometry.heads = \"%" PRIu32
"\"\n"
1830 "ddb.geometry.sectors = \"63\"\n"
1831 "ddb.adapterType = \"%s\"\n";
1833 ext_desc_lines
= g_string_new(NULL
);
1835 if (filename_decompose(filename
, path
, prefix
, postfix
, PATH_MAX
, errp
)) {
1839 /* Read out options */
1840 total_size
= ROUND_UP(qemu_opt_get_size_del(opts
, BLOCK_OPT_SIZE
, 0),
1842 adapter_type
= qemu_opt_get_del(opts
, BLOCK_OPT_ADAPTER_TYPE
);
1843 backing_file
= qemu_opt_get_del(opts
, BLOCK_OPT_BACKING_FILE
);
1844 if (qemu_opt_get_bool_del(opts
, BLOCK_OPT_COMPAT6
, false)) {
1845 flags
|= BLOCK_FLAG_COMPAT6
;
1847 fmt
= qemu_opt_get_del(opts
, BLOCK_OPT_SUBFMT
);
1848 if (qemu_opt_get_bool_del(opts
, BLOCK_OPT_ZEROED_GRAIN
, false)) {
1849 zeroed_grain
= true;
1852 if (!adapter_type
) {
1853 adapter_type
= g_strdup("ide");
1854 } else if (strcmp(adapter_type
, "ide") &&
1855 strcmp(adapter_type
, "buslogic") &&
1856 strcmp(adapter_type
, "lsilogic") &&
1857 strcmp(adapter_type
, "legacyESX")) {
1858 error_setg(errp
, "Unknown adapter type: '%s'", adapter_type
);
1862 if (strcmp(adapter_type
, "ide") != 0) {
1863 /* that's the number of heads with which vmware operates when
1864 creating, exporting, etc. vmdk files with a non-ide adapter type */
1868 /* Default format to monolithicSparse */
1869 fmt
= g_strdup("monolithicSparse");
1870 } else if (strcmp(fmt
, "monolithicFlat") &&
1871 strcmp(fmt
, "monolithicSparse") &&
1872 strcmp(fmt
, "twoGbMaxExtentSparse") &&
1873 strcmp(fmt
, "twoGbMaxExtentFlat") &&
1874 strcmp(fmt
, "streamOptimized")) {
1875 error_setg(errp
, "Unknown subformat: '%s'", fmt
);
1879 split
= !(strcmp(fmt
, "twoGbMaxExtentFlat") &&
1880 strcmp(fmt
, "twoGbMaxExtentSparse"));
1881 flat
= !(strcmp(fmt
, "monolithicFlat") &&
1882 strcmp(fmt
, "twoGbMaxExtentFlat"));
1883 compress
= !strcmp(fmt
, "streamOptimized");
1885 desc_extent_line
= "RW %" PRId64
" FLAT \"%s\" 0\n";
1887 desc_extent_line
= "RW %" PRId64
" SPARSE \"%s\"\n";
1889 if (flat
&& backing_file
) {
1890 error_setg(errp
, "Flat image can't have backing file");
1894 if (flat
&& zeroed_grain
) {
1895 error_setg(errp
, "Flat image can't enable zeroed grain");
1900 BlockDriverState
*bs
= NULL
;
1901 char *full_backing
= g_new0(char, PATH_MAX
);
1902 bdrv_get_full_backing_filename_from_filename(filename
, backing_file
,
1903 full_backing
, PATH_MAX
,
1906 g_free(full_backing
);
1907 error_propagate(errp
, local_err
);
1911 ret
= bdrv_open(&bs
, full_backing
, NULL
, NULL
, BDRV_O_NO_BACKING
, NULL
,
1913 g_free(full_backing
);
1917 if (strcmp(bs
->drv
->format_name
, "vmdk")) {
1922 parent_cid
= vmdk_read_cid(bs
, 0);
1924 snprintf(parent_desc_line
, BUF_SIZE
,
1925 "parentFileNameHint=\"%s\"", backing_file
);
1928 /* Create extents */
1929 filesize
= total_size
;
1930 while (filesize
> 0) {
1931 int64_t size
= filesize
;
1933 if (split
&& size
> split_size
) {
1937 snprintf(desc_filename
, PATH_MAX
, "%s-%c%03d%s",
1938 prefix
, flat
? 'f' : 's', ++idx
, postfix
);
1940 snprintf(desc_filename
, PATH_MAX
, "%s-flat%s", prefix
, postfix
);
1942 snprintf(desc_filename
, PATH_MAX
, "%s%s", prefix
, postfix
);
1944 snprintf(ext_filename
, PATH_MAX
, "%s%s", path
, desc_filename
);
1946 if (vmdk_create_extent(ext_filename
, size
,
1947 flat
, compress
, zeroed_grain
, opts
, errp
)) {
1953 /* Format description line */
1954 snprintf(desc_line
, BUF_SIZE
,
1955 desc_extent_line
, size
/ BDRV_SECTOR_SIZE
, desc_filename
);
1956 g_string_append(ext_desc_lines
, desc_line
);
1958 /* generate descriptor file */
1959 desc
= g_strdup_printf(desc_template
,
1964 ext_desc_lines
->str
,
1965 (flags
& BLOCK_FLAG_COMPAT6
? 6 : 4),
1967 (int64_t)(63 * number_heads
* BDRV_SECTOR_SIZE
),
1970 desc_len
= strlen(desc
);
1971 /* the descriptor offset = 0x200 */
1972 if (!split
&& !flat
) {
1973 desc_offset
= 0x200;
1975 ret
= bdrv_create_file(filename
, opts
, &local_err
);
1977 error_propagate(errp
, local_err
);
1981 assert(new_bs
== NULL
);
1982 ret
= bdrv_open(&new_bs
, filename
, NULL
, NULL
,
1983 BDRV_O_RDWR
| BDRV_O_PROTOCOL
, NULL
, &local_err
);
1985 error_propagate(errp
, local_err
);
1988 ret
= bdrv_pwrite(new_bs
, desc_offset
, desc
, desc_len
);
1990 error_setg_errno(errp
, -ret
, "Could not write description");
1993 /* bdrv_pwrite write padding zeros to align to sector, we don't need that
1994 * for description file */
1995 if (desc_offset
== 0) {
1996 ret
= bdrv_truncate(new_bs
, desc_len
);
1998 error_setg_errno(errp
, -ret
, "Could not truncate file");
2005 g_free(adapter_type
);
2006 g_free(backing_file
);
2013 g_free(ext_filename
);
2014 g_free(desc_filename
);
2015 g_free(parent_desc_line
);
2016 g_string_free(ext_desc_lines
, true);
2020 static void vmdk_close(BlockDriverState
*bs
)
2022 BDRVVmdkState
*s
= bs
->opaque
;
2024 vmdk_free_extents(bs
);
2025 g_free(s
->create_type
);
2027 migrate_del_blocker(s
->migration_blocker
);
2028 error_free(s
->migration_blocker
);
2031 static coroutine_fn
int vmdk_co_flush(BlockDriverState
*bs
)
2033 BDRVVmdkState
*s
= bs
->opaque
;
2037 for (i
= 0; i
< s
->num_extents
; i
++) {
2038 err
= bdrv_co_flush(s
->extents
[i
].file
);
2046 static int64_t vmdk_get_allocated_file_size(BlockDriverState
*bs
)
2051 BDRVVmdkState
*s
= bs
->opaque
;
2053 ret
= bdrv_get_allocated_file_size(bs
->file
);
2057 for (i
= 0; i
< s
->num_extents
; i
++) {
2058 if (s
->extents
[i
].file
== bs
->file
) {
2061 r
= bdrv_get_allocated_file_size(s
->extents
[i
].file
);
2070 static int vmdk_has_zero_init(BlockDriverState
*bs
)
2073 BDRVVmdkState
*s
= bs
->opaque
;
2075 /* If has a flat extent and its underlying storage doesn't have zero init,
2077 for (i
= 0; i
< s
->num_extents
; i
++) {
2078 if (s
->extents
[i
].flat
) {
2079 if (!bdrv_has_zero_init(s
->extents
[i
].file
)) {
2087 static ImageInfo
*vmdk_get_extent_info(VmdkExtent
*extent
)
2089 ImageInfo
*info
= g_new0(ImageInfo
, 1);
2091 *info
= (ImageInfo
){
2092 .filename
= g_strdup(extent
->file
->filename
),
2093 .format
= g_strdup(extent
->type
),
2094 .virtual_size
= extent
->sectors
* BDRV_SECTOR_SIZE
,
2095 .compressed
= extent
->compressed
,
2096 .has_compressed
= extent
->compressed
,
2097 .cluster_size
= extent
->cluster_sectors
* BDRV_SECTOR_SIZE
,
2098 .has_cluster_size
= !extent
->flat
,
2104 static int vmdk_check(BlockDriverState
*bs
, BdrvCheckResult
*result
,
2107 BDRVVmdkState
*s
= bs
->opaque
;
2108 VmdkExtent
*extent
= NULL
;
2109 int64_t sector_num
= 0;
2110 int64_t total_sectors
= bdrv_nb_sectors(bs
);
2112 uint64_t cluster_offset
;
2119 if (sector_num
>= total_sectors
) {
2122 extent
= find_extent(s
, sector_num
, extent
);
2125 "ERROR: could not find extent for sector %" PRId64
"\n",
2129 ret
= get_cluster_offset(bs
, extent
, NULL
,
2130 sector_num
<< BDRV_SECTOR_BITS
,
2131 false, &cluster_offset
, 0, 0);
2132 if (ret
== VMDK_ERROR
) {
2134 "ERROR: could not get cluster_offset for sector %"
2135 PRId64
"\n", sector_num
);
2138 if (ret
== VMDK_OK
&& cluster_offset
>= bdrv_getlength(extent
->file
)) {
2140 "ERROR: cluster offset for sector %"
2141 PRId64
" points after EOF\n", sector_num
);
2144 sector_num
+= extent
->cluster_sectors
;
2147 result
->corruptions
++;
2151 static ImageInfoSpecific
*vmdk_get_specific_info(BlockDriverState
*bs
)
2154 BDRVVmdkState
*s
= bs
->opaque
;
2155 ImageInfoSpecific
*spec_info
= g_new0(ImageInfoSpecific
, 1);
2156 ImageInfoList
**next
;
2158 *spec_info
= (ImageInfoSpecific
){
2159 .kind
= IMAGE_INFO_SPECIFIC_KIND_VMDK
,
2161 .vmdk
= g_new0(ImageInfoSpecificVmdk
, 1),
2165 *spec_info
->vmdk
= (ImageInfoSpecificVmdk
) {
2166 .create_type
= g_strdup(s
->create_type
),
2168 .parent_cid
= s
->parent_cid
,
2171 next
= &spec_info
->vmdk
->extents
;
2172 for (i
= 0; i
< s
->num_extents
; i
++) {
2173 *next
= g_new0(ImageInfoList
, 1);
2174 (*next
)->value
= vmdk_get_extent_info(&s
->extents
[i
]);
2175 (*next
)->next
= NULL
;
2176 next
= &(*next
)->next
;
2182 static bool vmdk_extents_type_eq(const VmdkExtent
*a
, const VmdkExtent
*b
)
2184 return a
->flat
== b
->flat
&&
2185 a
->compressed
== b
->compressed
&&
2186 (a
->flat
|| a
->cluster_sectors
== b
->cluster_sectors
);
2189 static int vmdk_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
)
2192 BDRVVmdkState
*s
= bs
->opaque
;
2193 assert(s
->num_extents
);
2195 /* See if we have multiple extents but they have different cases */
2196 for (i
= 1; i
< s
->num_extents
; i
++) {
2197 if (!vmdk_extents_type_eq(&s
->extents
[0], &s
->extents
[i
])) {
2201 bdi
->needs_compressed_writes
= s
->extents
[0].compressed
;
2202 if (!s
->extents
[0].flat
) {
2203 bdi
->cluster_size
= s
->extents
[0].cluster_sectors
<< BDRV_SECTOR_BITS
;
2208 static void vmdk_detach_aio_context(BlockDriverState
*bs
)
2210 BDRVVmdkState
*s
= bs
->opaque
;
2213 for (i
= 0; i
< s
->num_extents
; i
++) {
2214 bdrv_detach_aio_context(s
->extents
[i
].file
);
2218 static void vmdk_attach_aio_context(BlockDriverState
*bs
,
2219 AioContext
*new_context
)
2221 BDRVVmdkState
*s
= bs
->opaque
;
2224 for (i
= 0; i
< s
->num_extents
; i
++) {
2225 bdrv_attach_aio_context(s
->extents
[i
].file
, new_context
);
2229 static QemuOptsList vmdk_create_opts
= {
2230 .name
= "vmdk-create-opts",
2231 .head
= QTAILQ_HEAD_INITIALIZER(vmdk_create_opts
.head
),
2234 .name
= BLOCK_OPT_SIZE
,
2235 .type
= QEMU_OPT_SIZE
,
2236 .help
= "Virtual disk size"
2239 .name
= BLOCK_OPT_ADAPTER_TYPE
,
2240 .type
= QEMU_OPT_STRING
,
2241 .help
= "Virtual adapter type, can be one of "
2242 "ide (default), lsilogic, buslogic or legacyESX"
2245 .name
= BLOCK_OPT_BACKING_FILE
,
2246 .type
= QEMU_OPT_STRING
,
2247 .help
= "File name of a base image"
2250 .name
= BLOCK_OPT_COMPAT6
,
2251 .type
= QEMU_OPT_BOOL
,
2252 .help
= "VMDK version 6 image",
2253 .def_value_str
= "off"
2256 .name
= BLOCK_OPT_SUBFMT
,
2257 .type
= QEMU_OPT_STRING
,
2259 "VMDK flat extent format, can be one of "
2260 "{monolithicSparse (default) | monolithicFlat | twoGbMaxExtentSparse | twoGbMaxExtentFlat | streamOptimized} "
2263 .name
= BLOCK_OPT_ZEROED_GRAIN
,
2264 .type
= QEMU_OPT_BOOL
,
2265 .help
= "Enable efficient zero writes "
2266 "using the zeroed-grain GTE feature"
2268 { /* end of list */ }
2272 static BlockDriver bdrv_vmdk
= {
2273 .format_name
= "vmdk",
2274 .instance_size
= sizeof(BDRVVmdkState
),
2275 .bdrv_probe
= vmdk_probe
,
2276 .bdrv_open
= vmdk_open
,
2277 .bdrv_check
= vmdk_check
,
2278 .bdrv_reopen_prepare
= vmdk_reopen_prepare
,
2279 .bdrv_read
= vmdk_co_read
,
2280 .bdrv_write
= vmdk_co_write
,
2281 .bdrv_write_compressed
= vmdk_write_compressed
,
2282 .bdrv_co_write_zeroes
= vmdk_co_write_zeroes
,
2283 .bdrv_close
= vmdk_close
,
2284 .bdrv_create
= vmdk_create
,
2285 .bdrv_co_flush_to_disk
= vmdk_co_flush
,
2286 .bdrv_co_get_block_status
= vmdk_co_get_block_status
,
2287 .bdrv_get_allocated_file_size
= vmdk_get_allocated_file_size
,
2288 .bdrv_has_zero_init
= vmdk_has_zero_init
,
2289 .bdrv_get_specific_info
= vmdk_get_specific_info
,
2290 .bdrv_refresh_limits
= vmdk_refresh_limits
,
2291 .bdrv_get_info
= vmdk_get_info
,
2292 .bdrv_detach_aio_context
= vmdk_detach_aio_context
,
2293 .bdrv_attach_aio_context
= vmdk_attach_aio_context
,
2295 .supports_backing
= true,
2296 .create_opts
= &vmdk_create_opts
,
2299 static void bdrv_vmdk_init(void)
2301 bdrv_register(&bdrv_vmdk
);
2304 block_init(bdrv_vmdk_init
);