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 "migration/blocker.h"
37 #include "qemu/cutils.h"
40 #define VMDK3_MAGIC (('C' << 24) | ('O' << 16) | ('W' << 8) | 'D')
41 #define VMDK4_MAGIC (('K' << 24) | ('D' << 16) | ('M' << 8) | 'V')
42 #define VMDK4_COMPRESSION_DEFLATE 1
43 #define VMDK4_FLAG_NL_DETECT (1 << 0)
44 #define VMDK4_FLAG_RGD (1 << 1)
45 /* Zeroed-grain enable bit */
46 #define VMDK4_FLAG_ZERO_GRAIN (1 << 2)
47 #define VMDK4_FLAG_COMPRESS (1 << 16)
48 #define VMDK4_FLAG_MARKER (1 << 17)
49 #define VMDK4_GD_AT_END 0xffffffffffffffffULL
51 #define VMDK_EXTENT_MAX_SECTORS (1ULL << 32)
53 #define VMDK_GTE_ZEROED 0x1
55 /* VMDK internal error codes */
57 #define VMDK_ERROR (-1)
58 /* Cluster not allocated */
59 #define VMDK_UNALLOC (-2)
60 #define VMDK_ZEROED (-3)
62 #define BLOCK_OPT_ZEROED_GRAIN "zeroed_grain"
67 uint32_t disk_sectors
;
69 uint32_t l1dir_offset
;
71 uint32_t file_sectors
;
74 uint32_t sectors_per_track
;
75 } QEMU_PACKED VMDK3Header
;
84 /* Number of GrainTableEntries per GrainTable */
85 uint32_t num_gtes_per_gt
;
88 uint64_t grain_offset
;
91 uint16_t compressAlgorithm
;
92 } QEMU_PACKED VMDK4Header
;
94 typedef struct VMDKSESparseConstHeader
{
99 uint64_t grain_table_size
;
105 uint64_t volatile_header_offset
;
106 uint64_t volatile_header_size
;
107 uint64_t journal_header_offset
;
108 uint64_t journal_header_size
;
109 uint64_t journal_offset
;
110 uint64_t journal_size
;
111 uint64_t grain_dir_offset
;
112 uint64_t grain_dir_size
;
113 uint64_t grain_tables_offset
;
114 uint64_t grain_tables_size
;
115 uint64_t free_bitmap_offset
;
116 uint64_t free_bitmap_size
;
117 uint64_t backmap_offset
;
118 uint64_t backmap_size
;
119 uint64_t grains_offset
;
120 uint64_t grains_size
;
122 } QEMU_PACKED VMDKSESparseConstHeader
;
124 typedef struct VMDKSESparseVolatileHeader
{
126 uint64_t free_gt_number
;
127 uint64_t next_txn_seq_number
;
128 uint64_t replay_journal
;
130 } QEMU_PACKED VMDKSESparseVolatileHeader
;
132 #define L2_CACHE_SIZE 16
134 typedef struct VmdkExtent
{
141 uint64_t sesparse_l2_tables_offset
;
142 uint64_t sesparse_clusters_offset
;
147 int64_t flat_start_offset
;
148 int64_t l1_table_offset
;
149 int64_t l1_backup_table_offset
;
151 uint32_t *l1_backup_table
;
152 unsigned int l1_size
;
153 uint32_t l1_entry_sectors
;
155 unsigned int l2_size
;
157 uint32_t l2_cache_offsets
[L2_CACHE_SIZE
];
158 uint32_t l2_cache_counts
[L2_CACHE_SIZE
];
160 int64_t cluster_sectors
;
161 int64_t next_cluster_sector
;
165 typedef struct BDRVVmdkState
{
167 uint64_t desc_offset
;
173 /* Extent array with num_extents entries, ascend ordered by address */
175 Error
*migration_blocker
;
179 typedef struct VmdkMetaData
{
180 unsigned int l1_index
;
181 unsigned int l2_index
;
182 unsigned int l2_offset
;
184 uint32_t *l2_cache_entry
;
187 typedef struct VmdkGrainMarker
{
191 } QEMU_PACKED VmdkGrainMarker
;
194 MARKER_END_OF_STREAM
= 0,
195 MARKER_GRAIN_TABLE
= 1,
196 MARKER_GRAIN_DIRECTORY
= 2,
200 static int vmdk_probe(const uint8_t *buf
, int buf_size
, const char *filename
)
207 magic
= be32_to_cpu(*(uint32_t *)buf
);
208 if (magic
== VMDK3_MAGIC
||
209 magic
== VMDK4_MAGIC
) {
212 const char *p
= (const char *)buf
;
213 const char *end
= p
+ buf_size
;
216 /* skip comment line */
217 while (p
< end
&& *p
!= '\n') {
224 while (p
< end
&& *p
== ' ') {
227 /* skip '\r' if windows line endings used. */
228 if (p
< end
&& *p
== '\r') {
231 /* only accept blank lines before 'version=' line */
232 if (p
== end
|| *p
!= '\n') {
238 if (end
- p
>= strlen("version=X\n")) {
239 if (strncmp("version=1\n", p
, strlen("version=1\n")) == 0 ||
240 strncmp("version=2\n", p
, strlen("version=2\n")) == 0 ||
241 strncmp("version=3\n", p
, strlen("version=3\n")) == 0) {
245 if (end
- p
>= strlen("version=X\r\n")) {
246 if (strncmp("version=1\r\n", p
, strlen("version=1\r\n")) == 0 ||
247 strncmp("version=2\r\n", p
, strlen("version=2\r\n")) == 0 ||
248 strncmp("version=3\r\n", p
, strlen("version=3\r\n")) == 0) {
258 #define SECTOR_SIZE 512
259 #define DESC_SIZE (20 * SECTOR_SIZE) /* 20 sectors of 512 bytes each */
260 #define BUF_SIZE 4096
261 #define HEADER_SIZE 512 /* first sector of 512 bytes */
263 static void vmdk_free_extents(BlockDriverState
*bs
)
266 BDRVVmdkState
*s
= bs
->opaque
;
269 for (i
= 0; i
< s
->num_extents
; i
++) {
273 g_free(e
->l1_backup_table
);
275 if (e
->file
!= bs
->file
) {
276 bdrv_unref_child(bs
, e
->file
);
282 static void vmdk_free_last_extent(BlockDriverState
*bs
)
284 BDRVVmdkState
*s
= bs
->opaque
;
286 if (s
->num_extents
== 0) {
290 s
->extents
= g_renew(VmdkExtent
, s
->extents
, s
->num_extents
);
293 /* Return -ve errno, or 0 on success and write CID into *pcid. */
294 static int vmdk_read_cid(BlockDriverState
*bs
, int parent
, uint32_t *pcid
)
298 const char *p_name
, *cid_str
;
300 BDRVVmdkState
*s
= bs
->opaque
;
303 desc
= g_malloc0(DESC_SIZE
);
304 ret
= bdrv_pread(bs
->file
, s
->desc_offset
, desc
, DESC_SIZE
);
310 cid_str
= "parentCID";
311 cid_str_size
= sizeof("parentCID");
314 cid_str_size
= sizeof("CID");
317 desc
[DESC_SIZE
- 1] = '\0';
318 p_name
= strstr(desc
, cid_str
);
319 if (p_name
== NULL
) {
323 p_name
+= cid_str_size
;
324 if (sscanf(p_name
, "%" SCNx32
, &cid
) != 1) {
336 static int vmdk_write_cid(BlockDriverState
*bs
, uint32_t cid
)
338 char *desc
, *tmp_desc
;
339 char *p_name
, *tmp_str
;
340 BDRVVmdkState
*s
= bs
->opaque
;
343 desc
= g_malloc0(DESC_SIZE
);
344 tmp_desc
= g_malloc0(DESC_SIZE
);
345 ret
= bdrv_pread(bs
->file
, s
->desc_offset
, desc
, DESC_SIZE
);
350 desc
[DESC_SIZE
- 1] = '\0';
351 tmp_str
= strstr(desc
, "parentCID");
352 if (tmp_str
== NULL
) {
357 pstrcpy(tmp_desc
, DESC_SIZE
, tmp_str
);
358 p_name
= strstr(desc
, "CID");
359 if (p_name
!= NULL
) {
360 p_name
+= sizeof("CID");
361 snprintf(p_name
, DESC_SIZE
- (p_name
- desc
), "%" PRIx32
"\n", cid
);
362 pstrcat(desc
, DESC_SIZE
, tmp_desc
);
365 ret
= bdrv_pwrite_sync(bs
->file
, s
->desc_offset
, desc
, DESC_SIZE
);
373 static int vmdk_is_cid_valid(BlockDriverState
*bs
)
375 BDRVVmdkState
*s
= bs
->opaque
;
378 if (!s
->cid_checked
&& bs
->backing
) {
379 BlockDriverState
*p_bs
= bs
->backing
->bs
;
381 if (strcmp(p_bs
->drv
->format_name
, "vmdk")) {
382 /* Backing file is not in vmdk format, so it does not have
383 * a CID, which makes the overlay's parent CID invalid */
387 if (vmdk_read_cid(p_bs
, 0, &cur_pcid
) != 0) {
388 /* read failure: report as not valid */
391 if (s
->parent_cid
!= cur_pcid
) {
396 s
->cid_checked
= true;
401 /* We have nothing to do for VMDK reopen, stubs just return success */
402 static int vmdk_reopen_prepare(BDRVReopenState
*state
,
403 BlockReopenQueue
*queue
, Error
**errp
)
405 assert(state
!= NULL
);
406 assert(state
->bs
!= NULL
);
410 static int vmdk_parent_open(BlockDriverState
*bs
)
414 BDRVVmdkState
*s
= bs
->opaque
;
417 desc
= g_malloc0(DESC_SIZE
+ 1);
418 ret
= bdrv_pread(bs
->file
, s
->desc_offset
, desc
, DESC_SIZE
);
424 p_name
= strstr(desc
, "parentFileNameHint");
425 if (p_name
!= NULL
) {
428 p_name
+= sizeof("parentFileNameHint") + 1;
429 end_name
= strchr(p_name
, '\"');
430 if (end_name
== NULL
) {
434 if ((end_name
- p_name
) > sizeof(bs
->auto_backing_file
) - 1) {
439 pstrcpy(bs
->auto_backing_file
, end_name
- p_name
+ 1, p_name
);
440 pstrcpy(bs
->backing_file
, sizeof(bs
->backing_file
),
441 bs
->auto_backing_file
);
442 pstrcpy(bs
->backing_format
, sizeof(bs
->backing_format
),
451 /* Create and append extent to the extent array. Return the added VmdkExtent
452 * address. return NULL if allocation failed. */
453 static int vmdk_add_extent(BlockDriverState
*bs
,
454 BdrvChild
*file
, bool flat
, int64_t sectors
,
455 int64_t l1_offset
, int64_t l1_backup_offset
,
457 int l2_size
, uint64_t cluster_sectors
,
458 VmdkExtent
**new_extent
,
462 BDRVVmdkState
*s
= bs
->opaque
;
465 if (cluster_sectors
> 0x200000) {
466 /* 0x200000 * 512Bytes = 1GB for one cluster is unrealistic */
467 error_setg(errp
, "Invalid granularity, image may be corrupt");
470 if (l1_size
> 32 * 1024 * 1024) {
472 * Although with big capacity and small l1_entry_sectors, we can get a
473 * big l1_size, we don't want unbounded value to allocate the table.
474 * Limit it to 32M, which is enough to store:
475 * 8TB - for both VMDK3 & VMDK4 with
476 * minimal cluster size: 512B
477 * minimal L2 table size: 512 entries
478 * 8 TB is still more than the maximal value supported for
479 * VMDK3 & VMDK4 which is 2TB.
480 * 64TB - for "ESXi seSparse Extent"
481 * minimal cluster size: 512B (default is 4KB)
482 * L2 table size: 4096 entries (const).
483 * 64TB is more than the maximal value supported for
484 * seSparse VMDKs (which is slightly less than 64TB)
486 error_setg(errp
, "L1 size too big");
490 nb_sectors
= bdrv_nb_sectors(file
->bs
);
491 if (nb_sectors
< 0) {
495 s
->extents
= g_renew(VmdkExtent
, s
->extents
, s
->num_extents
+ 1);
496 extent
= &s
->extents
[s
->num_extents
];
499 memset(extent
, 0, sizeof(VmdkExtent
));
502 extent
->sectors
= sectors
;
503 extent
->l1_table_offset
= l1_offset
;
504 extent
->l1_backup_table_offset
= l1_backup_offset
;
505 extent
->l1_size
= l1_size
;
506 extent
->l1_entry_sectors
= l2_size
* cluster_sectors
;
507 extent
->l2_size
= l2_size
;
508 extent
->cluster_sectors
= flat
? sectors
: cluster_sectors
;
509 extent
->next_cluster_sector
= ROUND_UP(nb_sectors
, cluster_sectors
);
510 extent
->entry_size
= sizeof(uint32_t);
512 if (s
->num_extents
> 1) {
513 extent
->end_sector
= (*(extent
- 1)).end_sector
+ extent
->sectors
;
515 extent
->end_sector
= extent
->sectors
;
517 bs
->total_sectors
= extent
->end_sector
;
519 *new_extent
= extent
;
524 static int vmdk_init_tables(BlockDriverState
*bs
, VmdkExtent
*extent
,
531 /* read the L1 table */
532 l1_size
= extent
->l1_size
* extent
->entry_size
;
533 extent
->l1_table
= g_try_malloc(l1_size
);
534 if (l1_size
&& extent
->l1_table
== NULL
) {
538 ret
= bdrv_pread(extent
->file
,
539 extent
->l1_table_offset
,
543 bdrv_refresh_filename(extent
->file
->bs
);
544 error_setg_errno(errp
, -ret
,
545 "Could not read l1 table from extent '%s'",
546 extent
->file
->bs
->filename
);
549 for (i
= 0; i
< extent
->l1_size
; i
++) {
550 if (extent
->entry_size
== sizeof(uint64_t)) {
551 le64_to_cpus((uint64_t *)extent
->l1_table
+ i
);
553 assert(extent
->entry_size
== sizeof(uint32_t));
554 le32_to_cpus((uint32_t *)extent
->l1_table
+ i
);
558 if (extent
->l1_backup_table_offset
) {
559 assert(!extent
->sesparse
);
560 extent
->l1_backup_table
= g_try_malloc(l1_size
);
561 if (l1_size
&& extent
->l1_backup_table
== NULL
) {
565 ret
= bdrv_pread(extent
->file
,
566 extent
->l1_backup_table_offset
,
567 extent
->l1_backup_table
,
570 bdrv_refresh_filename(extent
->file
->bs
);
571 error_setg_errno(errp
, -ret
,
572 "Could not read l1 backup table from extent '%s'",
573 extent
->file
->bs
->filename
);
576 for (i
= 0; i
< extent
->l1_size
; i
++) {
577 le32_to_cpus(&extent
->l1_backup_table
[i
]);
582 g_malloc(extent
->entry_size
* extent
->l2_size
* L2_CACHE_SIZE
);
585 g_free(extent
->l1_backup_table
);
587 g_free(extent
->l1_table
);
591 static int vmdk_open_vmfs_sparse(BlockDriverState
*bs
,
593 int flags
, Error
**errp
)
600 ret
= bdrv_pread(file
, sizeof(magic
), &header
, sizeof(header
));
602 bdrv_refresh_filename(file
->bs
);
603 error_setg_errno(errp
, -ret
,
604 "Could not read header from file '%s'",
608 ret
= vmdk_add_extent(bs
, file
, false,
609 le32_to_cpu(header
.disk_sectors
),
610 (int64_t)le32_to_cpu(header
.l1dir_offset
) << 9,
612 le32_to_cpu(header
.l1dir_size
),
614 le32_to_cpu(header
.granularity
),
620 ret
= vmdk_init_tables(bs
, extent
, errp
);
622 /* free extent allocated by vmdk_add_extent */
623 vmdk_free_last_extent(bs
);
628 #define SESPARSE_CONST_HEADER_MAGIC UINT64_C(0x00000000cafebabe)
629 #define SESPARSE_VOLATILE_HEADER_MAGIC UINT64_C(0x00000000cafecafe)
631 /* Strict checks - format not officially documented */
632 static int check_se_sparse_const_header(VMDKSESparseConstHeader
*header
,
635 header
->magic
= le64_to_cpu(header
->magic
);
636 header
->version
= le64_to_cpu(header
->version
);
637 header
->grain_size
= le64_to_cpu(header
->grain_size
);
638 header
->grain_table_size
= le64_to_cpu(header
->grain_table_size
);
639 header
->flags
= le64_to_cpu(header
->flags
);
640 header
->reserved1
= le64_to_cpu(header
->reserved1
);
641 header
->reserved2
= le64_to_cpu(header
->reserved2
);
642 header
->reserved3
= le64_to_cpu(header
->reserved3
);
643 header
->reserved4
= le64_to_cpu(header
->reserved4
);
645 header
->volatile_header_offset
=
646 le64_to_cpu(header
->volatile_header_offset
);
647 header
->volatile_header_size
= le64_to_cpu(header
->volatile_header_size
);
649 header
->journal_header_offset
= le64_to_cpu(header
->journal_header_offset
);
650 header
->journal_header_size
= le64_to_cpu(header
->journal_header_size
);
652 header
->journal_offset
= le64_to_cpu(header
->journal_offset
);
653 header
->journal_size
= le64_to_cpu(header
->journal_size
);
655 header
->grain_dir_offset
= le64_to_cpu(header
->grain_dir_offset
);
656 header
->grain_dir_size
= le64_to_cpu(header
->grain_dir_size
);
658 header
->grain_tables_offset
= le64_to_cpu(header
->grain_tables_offset
);
659 header
->grain_tables_size
= le64_to_cpu(header
->grain_tables_size
);
661 header
->free_bitmap_offset
= le64_to_cpu(header
->free_bitmap_offset
);
662 header
->free_bitmap_size
= le64_to_cpu(header
->free_bitmap_size
);
664 header
->backmap_offset
= le64_to_cpu(header
->backmap_offset
);
665 header
->backmap_size
= le64_to_cpu(header
->backmap_size
);
667 header
->grains_offset
= le64_to_cpu(header
->grains_offset
);
668 header
->grains_size
= le64_to_cpu(header
->grains_size
);
670 if (header
->magic
!= SESPARSE_CONST_HEADER_MAGIC
) {
671 error_setg(errp
, "Bad const header magic: 0x%016" PRIx64
,
676 if (header
->version
!= 0x0000000200000001) {
677 error_setg(errp
, "Unsupported version: 0x%016" PRIx64
,
682 if (header
->grain_size
!= 8) {
683 error_setg(errp
, "Unsupported grain size: %" PRIu64
,
688 if (header
->grain_table_size
!= 64) {
689 error_setg(errp
, "Unsupported grain table size: %" PRIu64
,
690 header
->grain_table_size
);
694 if (header
->flags
!= 0) {
695 error_setg(errp
, "Unsupported flags: 0x%016" PRIx64
,
700 if (header
->reserved1
!= 0 || header
->reserved2
!= 0 ||
701 header
->reserved3
!= 0 || header
->reserved4
!= 0) {
702 error_setg(errp
, "Unsupported reserved bits:"
703 " 0x%016" PRIx64
" 0x%016" PRIx64
704 " 0x%016" PRIx64
" 0x%016" PRIx64
,
705 header
->reserved1
, header
->reserved2
,
706 header
->reserved3
, header
->reserved4
);
710 /* check that padding is 0 */
711 if (!buffer_is_zero(header
->pad
, sizeof(header
->pad
))) {
712 error_setg(errp
, "Unsupported non-zero const header padding");
719 static int check_se_sparse_volatile_header(VMDKSESparseVolatileHeader
*header
,
722 header
->magic
= le64_to_cpu(header
->magic
);
723 header
->free_gt_number
= le64_to_cpu(header
->free_gt_number
);
724 header
->next_txn_seq_number
= le64_to_cpu(header
->next_txn_seq_number
);
725 header
->replay_journal
= le64_to_cpu(header
->replay_journal
);
727 if (header
->magic
!= SESPARSE_VOLATILE_HEADER_MAGIC
) {
728 error_setg(errp
, "Bad volatile header magic: 0x%016" PRIx64
,
733 if (header
->replay_journal
) {
734 error_setg(errp
, "Image is dirty, Replaying journal not supported");
738 /* check that padding is 0 */
739 if (!buffer_is_zero(header
->pad
, sizeof(header
->pad
))) {
740 error_setg(errp
, "Unsupported non-zero volatile header padding");
747 static int vmdk_open_se_sparse(BlockDriverState
*bs
,
749 int flags
, Error
**errp
)
752 VMDKSESparseConstHeader const_header
;
753 VMDKSESparseVolatileHeader volatile_header
;
756 ret
= bdrv_apply_auto_read_only(bs
,
757 "No write support for seSparse images available", errp
);
762 assert(sizeof(const_header
) == SECTOR_SIZE
);
764 ret
= bdrv_pread(file
, 0, &const_header
, sizeof(const_header
));
766 bdrv_refresh_filename(file
->bs
);
767 error_setg_errno(errp
, -ret
,
768 "Could not read const header from file '%s'",
773 /* check const header */
774 ret
= check_se_sparse_const_header(&const_header
, errp
);
779 assert(sizeof(volatile_header
) == SECTOR_SIZE
);
781 ret
= bdrv_pread(file
,
782 const_header
.volatile_header_offset
* SECTOR_SIZE
,
783 &volatile_header
, sizeof(volatile_header
));
785 bdrv_refresh_filename(file
->bs
);
786 error_setg_errno(errp
, -ret
,
787 "Could not read volatile header from file '%s'",
792 /* check volatile header */
793 ret
= check_se_sparse_volatile_header(&volatile_header
, errp
);
798 ret
= vmdk_add_extent(bs
, file
, false,
799 const_header
.capacity
,
800 const_header
.grain_dir_offset
* SECTOR_SIZE
,
802 const_header
.grain_dir_size
*
803 SECTOR_SIZE
/ sizeof(uint64_t),
804 const_header
.grain_table_size
*
805 SECTOR_SIZE
/ sizeof(uint64_t),
806 const_header
.grain_size
,
813 extent
->sesparse
= true;
814 extent
->sesparse_l2_tables_offset
= const_header
.grain_tables_offset
;
815 extent
->sesparse_clusters_offset
= const_header
.grains_offset
;
816 extent
->entry_size
= sizeof(uint64_t);
818 ret
= vmdk_init_tables(bs
, extent
, errp
);
820 /* free extent allocated by vmdk_add_extent */
821 vmdk_free_last_extent(bs
);
827 static int vmdk_open_desc_file(BlockDriverState
*bs
, int flags
, char *buf
,
828 QDict
*options
, Error
**errp
);
830 static char *vmdk_read_desc(BdrvChild
*file
, uint64_t desc_offset
, Error
**errp
)
836 size
= bdrv_getlength(file
->bs
);
838 error_setg_errno(errp
, -size
, "Could not access file");
843 /* Both descriptor file and sparse image must be much larger than 4
844 * bytes, also callers of vmdk_read_desc want to compare the first 4
845 * bytes with VMDK4_MAGIC, let's error out if less is read. */
846 error_setg(errp
, "File is too small, not a valid image");
850 size
= MIN(size
, (1 << 20) - 1); /* avoid unbounded allocation */
851 buf
= g_malloc(size
+ 1);
853 ret
= bdrv_pread(file
, desc_offset
, buf
, size
);
855 error_setg_errno(errp
, -ret
, "Could not read from file");
864 static int vmdk_open_vmdk4(BlockDriverState
*bs
,
866 int flags
, QDict
*options
, Error
**errp
)
870 uint32_t l1_size
, l1_entry_sectors
;
873 BDRVVmdkState
*s
= bs
->opaque
;
874 int64_t l1_backup_offset
= 0;
877 ret
= bdrv_pread(file
, sizeof(magic
), &header
, sizeof(header
));
879 bdrv_refresh_filename(file
->bs
);
880 error_setg_errno(errp
, -ret
,
881 "Could not read header from file '%s'",
885 if (header
.capacity
== 0) {
886 uint64_t desc_offset
= le64_to_cpu(header
.desc_offset
);
888 char *buf
= vmdk_read_desc(file
, desc_offset
<< 9, errp
);
892 ret
= vmdk_open_desc_file(bs
, flags
, buf
, options
, errp
);
898 if (!s
->create_type
) {
899 s
->create_type
= g_strdup("monolithicSparse");
902 if (le64_to_cpu(header
.gd_offset
) == VMDK4_GD_AT_END
) {
904 * The footer takes precedence over the header, so read it in. The
905 * footer starts at offset -1024 from the end: One sector for the
906 * footer, and another one for the end-of-stream marker.
913 uint8_t pad
[512 - 16];
914 } QEMU_PACKED footer_marker
;
918 uint8_t pad
[512 - 4 - sizeof(VMDK4Header
)];
924 uint8_t pad
[512 - 16];
925 } QEMU_PACKED eos_marker
;
926 } QEMU_PACKED footer
;
928 ret
= bdrv_pread(file
,
929 bs
->file
->bs
->total_sectors
* 512 - 1536,
930 &footer
, sizeof(footer
));
932 error_setg_errno(errp
, -ret
, "Failed to read footer");
936 /* Some sanity checks for the footer */
937 if (be32_to_cpu(footer
.magic
) != VMDK4_MAGIC
||
938 le32_to_cpu(footer
.footer_marker
.size
) != 0 ||
939 le32_to_cpu(footer
.footer_marker
.type
) != MARKER_FOOTER
||
940 le64_to_cpu(footer
.eos_marker
.val
) != 0 ||
941 le32_to_cpu(footer
.eos_marker
.size
) != 0 ||
942 le32_to_cpu(footer
.eos_marker
.type
) != MARKER_END_OF_STREAM
)
944 error_setg(errp
, "Invalid footer");
948 header
= footer
.header
;
952 le16_to_cpu(header
.compressAlgorithm
) == VMDK4_COMPRESSION_DEFLATE
;
953 if (le32_to_cpu(header
.version
) > 3) {
954 error_setg(errp
, "Unsupported VMDK version %" PRIu32
,
955 le32_to_cpu(header
.version
));
957 } else if (le32_to_cpu(header
.version
) == 3 && (flags
& BDRV_O_RDWR
) &&
959 /* VMware KB 2064959 explains that version 3 added support for
960 * persistent changed block tracking (CBT), and backup software can
961 * read it as version=1 if it doesn't care about the changed area
962 * information. So we are safe to enable read only. */
963 error_setg(errp
, "VMDK version 3 must be read only");
967 if (le32_to_cpu(header
.num_gtes_per_gt
) > 512) {
968 error_setg(errp
, "L2 table size too big");
972 l1_entry_sectors
= le32_to_cpu(header
.num_gtes_per_gt
)
973 * le64_to_cpu(header
.granularity
);
974 if (l1_entry_sectors
== 0) {
975 error_setg(errp
, "L1 entry size is invalid");
978 l1_size
= (le64_to_cpu(header
.capacity
) + l1_entry_sectors
- 1)
980 if (le32_to_cpu(header
.flags
) & VMDK4_FLAG_RGD
) {
981 l1_backup_offset
= le64_to_cpu(header
.rgd_offset
) << 9;
983 if (bdrv_nb_sectors(file
->bs
) < le64_to_cpu(header
.grain_offset
)) {
984 error_setg(errp
, "File truncated, expecting at least %" PRId64
" bytes",
985 (int64_t)(le64_to_cpu(header
.grain_offset
)
986 * BDRV_SECTOR_SIZE
));
990 ret
= vmdk_add_extent(bs
, file
, false,
991 le64_to_cpu(header
.capacity
),
992 le64_to_cpu(header
.gd_offset
) << 9,
995 le32_to_cpu(header
.num_gtes_per_gt
),
996 le64_to_cpu(header
.granularity
),
1002 extent
->compressed
=
1003 le16_to_cpu(header
.compressAlgorithm
) == VMDK4_COMPRESSION_DEFLATE
;
1004 if (extent
->compressed
) {
1005 g_free(s
->create_type
);
1006 s
->create_type
= g_strdup("streamOptimized");
1008 extent
->has_marker
= le32_to_cpu(header
.flags
) & VMDK4_FLAG_MARKER
;
1009 extent
->version
= le32_to_cpu(header
.version
);
1010 extent
->has_zero_grain
= le32_to_cpu(header
.flags
) & VMDK4_FLAG_ZERO_GRAIN
;
1011 ret
= vmdk_init_tables(bs
, extent
, errp
);
1013 /* free extent allocated by vmdk_add_extent */
1014 vmdk_free_last_extent(bs
);
1019 /* find an option value out of descriptor file */
1020 static int vmdk_parse_description(const char *desc
, const char *opt_name
,
1021 char *buf
, int buf_size
)
1023 char *opt_pos
, *opt_end
;
1024 const char *end
= desc
+ strlen(desc
);
1026 opt_pos
= strstr(desc
, opt_name
);
1030 /* Skip "=\"" following opt_name */
1031 opt_pos
+= strlen(opt_name
) + 2;
1032 if (opt_pos
>= end
) {
1036 while (opt_end
< end
&& *opt_end
!= '"') {
1039 if (opt_end
== end
|| buf_size
< opt_end
- opt_pos
+ 1) {
1042 pstrcpy(buf
, opt_end
- opt_pos
+ 1, opt_pos
);
1046 /* Open an extent file and append to bs array */
1047 static int vmdk_open_sparse(BlockDriverState
*bs
, BdrvChild
*file
, int flags
,
1048 char *buf
, QDict
*options
, Error
**errp
)
1052 magic
= ldl_be_p(buf
);
1055 return vmdk_open_vmfs_sparse(bs
, file
, flags
, errp
);
1058 return vmdk_open_vmdk4(bs
, file
, flags
, options
, errp
);
1061 error_setg(errp
, "Image not in VMDK format");
1067 static const char *next_line(const char *s
)
1078 static int vmdk_parse_extents(const char *desc
, BlockDriverState
*bs
,
1079 QDict
*options
, Error
**errp
)
1087 int64_t sectors
= 0;
1088 int64_t flat_offset
;
1089 char *desc_file_dir
= NULL
;
1091 BdrvChild
*extent_file
;
1092 BDRVVmdkState
*s
= bs
->opaque
;
1094 char extent_opt_prefix
[32];
1095 Error
*local_err
= NULL
;
1097 for (p
= desc
; *p
; p
= next_line(p
)) {
1098 /* parse extent line in one of below formats:
1100 * RW [size in sectors] FLAT "file-name.vmdk" OFFSET
1101 * RW [size in sectors] SPARSE "file-name.vmdk"
1102 * RW [size in sectors] VMFS "file-name.vmdk"
1103 * RW [size in sectors] VMFSSPARSE "file-name.vmdk"
1104 * RW [size in sectors] SESPARSE "file-name.vmdk"
1107 matches
= sscanf(p
, "%10s %" SCNd64
" %10s \"%511[^\n\r\"]\" %" SCNd64
,
1108 access
, §ors
, type
, fname
, &flat_offset
);
1109 if (matches
< 4 || strcmp(access
, "RW")) {
1111 } else if (!strcmp(type
, "FLAT")) {
1112 if (matches
!= 5 || flat_offset
< 0) {
1115 } else if (!strcmp(type
, "VMFS")) {
1121 } else if (matches
!= 4) {
1126 (strcmp(type
, "FLAT") && strcmp(type
, "SPARSE") &&
1127 strcmp(type
, "VMFS") && strcmp(type
, "VMFSSPARSE") &&
1128 strcmp(type
, "SESPARSE")) ||
1129 (strcmp(access
, "RW"))) {
1133 if (path_is_absolute(fname
)) {
1134 extent_path
= g_strdup(fname
);
1136 if (!desc_file_dir
) {
1137 desc_file_dir
= bdrv_dirname(bs
->file
->bs
, errp
);
1138 if (!desc_file_dir
) {
1139 bdrv_refresh_filename(bs
->file
->bs
);
1140 error_prepend(errp
, "Cannot use relative paths with VMDK "
1141 "descriptor file '%s': ",
1142 bs
->file
->bs
->filename
);
1148 extent_path
= g_strconcat(desc_file_dir
, fname
, NULL
);
1151 ret
= snprintf(extent_opt_prefix
, 32, "extents.%d", s
->num_extents
);
1154 extent_file
= bdrv_open_child(extent_path
, options
, extent_opt_prefix
,
1155 bs
, &child_file
, false, &local_err
);
1156 g_free(extent_path
);
1158 error_propagate(errp
, local_err
);
1163 /* save to extents array */
1164 if (!strcmp(type
, "FLAT") || !strcmp(type
, "VMFS")) {
1167 ret
= vmdk_add_extent(bs
, extent_file
, true, sectors
,
1168 0, 0, 0, 0, 0, &extent
, errp
);
1170 bdrv_unref_child(bs
, extent_file
);
1173 extent
->flat_start_offset
= flat_offset
<< 9;
1174 } else if (!strcmp(type
, "SPARSE") || !strcmp(type
, "VMFSSPARSE")) {
1175 /* SPARSE extent and VMFSSPARSE extent are both "COWD" sparse file*/
1176 char *buf
= vmdk_read_desc(extent_file
, 0, errp
);
1180 ret
= vmdk_open_sparse(bs
, extent_file
, bs
->open_flags
, buf
,
1185 bdrv_unref_child(bs
, extent_file
);
1188 extent
= &s
->extents
[s
->num_extents
- 1];
1189 } else if (!strcmp(type
, "SESPARSE")) {
1190 ret
= vmdk_open_se_sparse(bs
, extent_file
, bs
->open_flags
, errp
);
1192 bdrv_unref_child(bs
, extent_file
);
1195 extent
= &s
->extents
[s
->num_extents
- 1];
1197 error_setg(errp
, "Unsupported extent type '%s'", type
);
1198 bdrv_unref_child(bs
, extent_file
);
1202 extent
->type
= g_strdup(type
);
1211 if (np
[-1] == '\n') {
1214 error_setg(errp
, "Invalid extent line: %.*s", (int)(np
- p
), p
);
1218 g_free(desc_file_dir
);
1222 static int vmdk_open_desc_file(BlockDriverState
*bs
, int flags
, char *buf
,
1223 QDict
*options
, Error
**errp
)
1227 BDRVVmdkState
*s
= bs
->opaque
;
1229 if (vmdk_parse_description(buf
, "createType", ct
, sizeof(ct
))) {
1230 error_setg(errp
, "invalid VMDK image descriptor");
1234 if (strcmp(ct
, "monolithicFlat") &&
1235 strcmp(ct
, "vmfs") &&
1236 strcmp(ct
, "vmfsSparse") &&
1237 strcmp(ct
, "seSparse") &&
1238 strcmp(ct
, "twoGbMaxExtentSparse") &&
1239 strcmp(ct
, "twoGbMaxExtentFlat")) {
1240 error_setg(errp
, "Unsupported image type '%s'", ct
);
1244 s
->create_type
= g_strdup(ct
);
1246 ret
= vmdk_parse_extents(buf
, bs
, options
, errp
);
1251 static int vmdk_open(BlockDriverState
*bs
, QDict
*options
, int flags
,
1256 BDRVVmdkState
*s
= bs
->opaque
;
1258 Error
*local_err
= NULL
;
1260 bs
->file
= bdrv_open_child(NULL
, options
, "file", bs
, &child_file
,
1266 buf
= vmdk_read_desc(bs
->file
, 0, errp
);
1271 magic
= ldl_be_p(buf
);
1275 ret
= vmdk_open_sparse(bs
, bs
->file
, flags
, buf
, options
,
1277 s
->desc_offset
= 0x200;
1280 ret
= vmdk_open_desc_file(bs
, flags
, buf
, options
, errp
);
1287 /* try to open parent images, if exist */
1288 ret
= vmdk_parent_open(bs
);
1292 ret
= vmdk_read_cid(bs
, 0, &s
->cid
);
1296 ret
= vmdk_read_cid(bs
, 1, &s
->parent_cid
);
1300 qemu_co_mutex_init(&s
->lock
);
1302 /* Disable migration when VMDK images are used */
1303 error_setg(&s
->migration_blocker
, "The vmdk format used by node '%s' "
1304 "does not support live migration",
1305 bdrv_get_device_or_node_name(bs
));
1306 ret
= migrate_add_blocker(s
->migration_blocker
, &local_err
);
1308 error_propagate(errp
, local_err
);
1309 error_free(s
->migration_blocker
);
1318 g_free(s
->create_type
);
1319 s
->create_type
= NULL
;
1320 vmdk_free_extents(bs
);
1325 static void vmdk_refresh_limits(BlockDriverState
*bs
, Error
**errp
)
1327 BDRVVmdkState
*s
= bs
->opaque
;
1330 for (i
= 0; i
< s
->num_extents
; i
++) {
1331 if (!s
->extents
[i
].flat
) {
1332 bs
->bl
.pwrite_zeroes_alignment
=
1333 MAX(bs
->bl
.pwrite_zeroes_alignment
,
1334 s
->extents
[i
].cluster_sectors
<< BDRV_SECTOR_BITS
);
1342 * Copy backing file's cluster that covers @sector_num, otherwise write zero,
1343 * to the cluster at @cluster_sector_num.
1345 * If @skip_start_sector < @skip_end_sector, the relative range
1346 * [@skip_start_sector, @skip_end_sector) is not copied or written, and leave
1347 * it for call to write user data in the request.
1349 static int get_whole_cluster(BlockDriverState
*bs
,
1351 uint64_t cluster_offset
,
1353 uint64_t skip_start_bytes
,
1354 uint64_t skip_end_bytes
)
1357 int64_t cluster_bytes
;
1358 uint8_t *whole_grain
;
1360 /* For COW, align request sector_num to cluster start */
1361 cluster_bytes
= extent
->cluster_sectors
<< BDRV_SECTOR_BITS
;
1362 offset
= QEMU_ALIGN_DOWN(offset
, cluster_bytes
);
1363 whole_grain
= qemu_blockalign(bs
, cluster_bytes
);
1366 memset(whole_grain
, 0, skip_start_bytes
);
1367 memset(whole_grain
+ skip_end_bytes
, 0, cluster_bytes
- skip_end_bytes
);
1370 assert(skip_end_bytes
<= cluster_bytes
);
1371 /* we will be here if it's first write on non-exist grain(cluster).
1372 * try to read from parent image, if exist */
1373 if (bs
->backing
&& !vmdk_is_cid_valid(bs
)) {
1378 /* Read backing data before skip range */
1379 if (skip_start_bytes
> 0) {
1381 /* qcow2 emits this on bs->file instead of bs->backing */
1382 BLKDBG_EVENT(extent
->file
, BLKDBG_COW_READ
);
1383 ret
= bdrv_pread(bs
->backing
, offset
, whole_grain
,
1390 BLKDBG_EVENT(extent
->file
, BLKDBG_COW_WRITE
);
1391 ret
= bdrv_pwrite(extent
->file
, cluster_offset
, whole_grain
,
1398 /* Read backing data after skip range */
1399 if (skip_end_bytes
< cluster_bytes
) {
1401 /* qcow2 emits this on bs->file instead of bs->backing */
1402 BLKDBG_EVENT(extent
->file
, BLKDBG_COW_READ
);
1403 ret
= bdrv_pread(bs
->backing
, offset
+ skip_end_bytes
,
1404 whole_grain
+ skip_end_bytes
,
1405 cluster_bytes
- skip_end_bytes
);
1411 BLKDBG_EVENT(extent
->file
, BLKDBG_COW_WRITE
);
1412 ret
= bdrv_pwrite(extent
->file
, cluster_offset
+ skip_end_bytes
,
1413 whole_grain
+ skip_end_bytes
,
1414 cluster_bytes
- skip_end_bytes
);
1423 qemu_vfree(whole_grain
);
1427 static int vmdk_L2update(VmdkExtent
*extent
, VmdkMetaData
*m_data
,
1430 offset
= cpu_to_le32(offset
);
1431 /* update L2 table */
1432 BLKDBG_EVENT(extent
->file
, BLKDBG_L2_UPDATE
);
1433 if (bdrv_pwrite_sync(extent
->file
,
1434 ((int64_t)m_data
->l2_offset
* 512)
1435 + (m_data
->l2_index
* sizeof(offset
)),
1436 &offset
, sizeof(offset
)) < 0) {
1439 /* update backup L2 table */
1440 if (extent
->l1_backup_table_offset
!= 0) {
1441 m_data
->l2_offset
= extent
->l1_backup_table
[m_data
->l1_index
];
1442 if (bdrv_pwrite_sync(extent
->file
,
1443 ((int64_t)m_data
->l2_offset
* 512)
1444 + (m_data
->l2_index
* sizeof(offset
)),
1445 &offset
, sizeof(offset
)) < 0) {
1449 if (m_data
->l2_cache_entry
) {
1450 *m_data
->l2_cache_entry
= offset
;
1457 * get_cluster_offset
1459 * Look up cluster offset in extent file by sector number, and store in
1462 * For flat extents, the start offset as parsed from the description file is
1465 * For sparse extents, look up in L1, L2 table. If allocate is true, return an
1466 * offset for a new cluster and update L2 cache. If there is a backing file,
1467 * COW is done before returning; otherwise, zeroes are written to the allocated
1468 * cluster. Both COW and zero writing skips the sector range
1469 * [@skip_start_sector, @skip_end_sector) passed in by caller, because caller
1470 * has new data to write there.
1472 * Returns: VMDK_OK if cluster exists and mapped in the image.
1473 * VMDK_UNALLOC if cluster is not mapped and @allocate is false.
1474 * VMDK_ERROR if failed.
1476 static int get_cluster_offset(BlockDriverState
*bs
,
1478 VmdkMetaData
*m_data
,
1481 uint64_t *cluster_offset
,
1482 uint64_t skip_start_bytes
,
1483 uint64_t skip_end_bytes
)
1485 unsigned int l1_index
, l2_offset
, l2_index
;
1486 int min_index
, i
, j
;
1489 bool zeroed
= false;
1491 int64_t cluster_sector
;
1492 unsigned int l2_size_bytes
= extent
->l2_size
* extent
->entry_size
;
1495 m_data
->new_allocation
= false;
1498 *cluster_offset
= extent
->flat_start_offset
;
1502 offset
-= (extent
->end_sector
- extent
->sectors
) * SECTOR_SIZE
;
1503 l1_index
= (offset
>> 9) / extent
->l1_entry_sectors
;
1504 if (l1_index
>= extent
->l1_size
) {
1507 if (extent
->sesparse
) {
1508 uint64_t l2_offset_u64
;
1510 assert(extent
->entry_size
== sizeof(uint64_t));
1512 l2_offset_u64
= ((uint64_t *)extent
->l1_table
)[l1_index
];
1513 if (l2_offset_u64
== 0) {
1515 } else if ((l2_offset_u64
& 0xffffffff00000000) != 0x1000000000000000) {
1517 * Top most nibble is 0x1 if grain table is allocated.
1518 * strict check - top most 4 bytes must be 0x10000000 since max
1519 * supported size is 64TB for disk - so no more than 64TB / 16MB
1520 * grain directories which is smaller than uint32,
1521 * where 16MB is the only supported default grain table coverage.
1525 l2_offset_u64
= l2_offset_u64
& 0x00000000ffffffff;
1526 l2_offset_u64
= extent
->sesparse_l2_tables_offset
+
1527 l2_offset_u64
* l2_size_bytes
/ SECTOR_SIZE
;
1528 if (l2_offset_u64
> 0x00000000ffffffff) {
1531 l2_offset
= (unsigned int)(l2_offset_u64
);
1534 assert(extent
->entry_size
== sizeof(uint32_t));
1535 l2_offset
= ((uint32_t *)extent
->l1_table
)[l1_index
];
1538 return VMDK_UNALLOC
;
1540 for (i
= 0; i
< L2_CACHE_SIZE
; i
++) {
1541 if (l2_offset
== extent
->l2_cache_offsets
[i
]) {
1542 /* increment the hit count */
1543 if (++extent
->l2_cache_counts
[i
] == 0xffffffff) {
1544 for (j
= 0; j
< L2_CACHE_SIZE
; j
++) {
1545 extent
->l2_cache_counts
[j
] >>= 1;
1548 l2_table
= (char *)extent
->l2_cache
+ (i
* l2_size_bytes
);
1552 /* not found: load a new entry in the least used one */
1554 min_count
= 0xffffffff;
1555 for (i
= 0; i
< L2_CACHE_SIZE
; i
++) {
1556 if (extent
->l2_cache_counts
[i
] < min_count
) {
1557 min_count
= extent
->l2_cache_counts
[i
];
1561 l2_table
= (char *)extent
->l2_cache
+ (min_index
* l2_size_bytes
);
1562 BLKDBG_EVENT(extent
->file
, BLKDBG_L2_LOAD
);
1563 if (bdrv_pread(extent
->file
,
1564 (int64_t)l2_offset
* 512,
1567 ) != l2_size_bytes
) {
1571 extent
->l2_cache_offsets
[min_index
] = l2_offset
;
1572 extent
->l2_cache_counts
[min_index
] = 1;
1574 l2_index
= ((offset
>> 9) / extent
->cluster_sectors
) % extent
->l2_size
;
1576 m_data
->l1_index
= l1_index
;
1577 m_data
->l2_index
= l2_index
;
1578 m_data
->l2_offset
= l2_offset
;
1579 m_data
->l2_cache_entry
= ((uint32_t *)l2_table
) + l2_index
;
1582 if (extent
->sesparse
) {
1583 cluster_sector
= le64_to_cpu(((uint64_t *)l2_table
)[l2_index
]);
1584 switch (cluster_sector
& 0xf000000000000000) {
1585 case 0x0000000000000000:
1586 /* unallocated grain */
1587 if (cluster_sector
!= 0) {
1591 case 0x1000000000000000:
1592 /* scsi-unmapped grain - fallthrough */
1593 case 0x2000000000000000:
1597 case 0x3000000000000000:
1598 /* allocated grain */
1599 cluster_sector
= (((cluster_sector
& 0x0fff000000000000) >> 48) |
1600 ((cluster_sector
& 0x0000ffffffffffff) << 12));
1601 cluster_sector
= extent
->sesparse_clusters_offset
+
1602 cluster_sector
* extent
->cluster_sectors
;
1608 cluster_sector
= le32_to_cpu(((uint32_t *)l2_table
)[l2_index
]);
1610 if (extent
->has_zero_grain
&& cluster_sector
== VMDK_GTE_ZEROED
) {
1615 if (!cluster_sector
|| zeroed
) {
1617 return zeroed
? VMDK_ZEROED
: VMDK_UNALLOC
;
1619 assert(!extent
->sesparse
);
1621 if (extent
->next_cluster_sector
>= VMDK_EXTENT_MAX_SECTORS
) {
1625 cluster_sector
= extent
->next_cluster_sector
;
1626 extent
->next_cluster_sector
+= extent
->cluster_sectors
;
1628 /* First of all we write grain itself, to avoid race condition
1629 * that may to corrupt the image.
1630 * This problem may occur because of insufficient space on host disk
1631 * or inappropriate VM shutdown.
1633 ret
= get_whole_cluster(bs
, extent
, cluster_sector
* BDRV_SECTOR_SIZE
,
1634 offset
, skip_start_bytes
, skip_end_bytes
);
1639 m_data
->new_allocation
= true;
1642 *cluster_offset
= cluster_sector
<< BDRV_SECTOR_BITS
;
1646 static VmdkExtent
*find_extent(BDRVVmdkState
*s
,
1647 int64_t sector_num
, VmdkExtent
*start_hint
)
1649 VmdkExtent
*extent
= start_hint
;
1652 extent
= &s
->extents
[0];
1654 while (extent
< &s
->extents
[s
->num_extents
]) {
1655 if (sector_num
< extent
->end_sector
) {
1663 static inline uint64_t vmdk_find_offset_in_cluster(VmdkExtent
*extent
,
1666 uint64_t extent_begin_offset
, extent_relative_offset
;
1667 uint64_t cluster_size
= extent
->cluster_sectors
* BDRV_SECTOR_SIZE
;
1669 extent_begin_offset
=
1670 (extent
->end_sector
- extent
->sectors
) * BDRV_SECTOR_SIZE
;
1671 extent_relative_offset
= offset
- extent_begin_offset
;
1672 return extent_relative_offset
% cluster_size
;
1675 static int coroutine_fn
vmdk_co_block_status(BlockDriverState
*bs
,
1677 int64_t offset
, int64_t bytes
,
1678 int64_t *pnum
, int64_t *map
,
1679 BlockDriverState
**file
)
1681 BDRVVmdkState
*s
= bs
->opaque
;
1682 int64_t index_in_cluster
, n
, ret
;
1683 uint64_t cluster_offset
;
1686 extent
= find_extent(s
, offset
>> BDRV_SECTOR_BITS
, NULL
);
1690 qemu_co_mutex_lock(&s
->lock
);
1691 ret
= get_cluster_offset(bs
, extent
, NULL
, offset
, false, &cluster_offset
,
1693 qemu_co_mutex_unlock(&s
->lock
);
1695 index_in_cluster
= vmdk_find_offset_in_cluster(extent
, offset
);
1704 ret
= BDRV_BLOCK_ZERO
;
1707 ret
= BDRV_BLOCK_DATA
;
1708 if (!extent
->compressed
) {
1709 ret
|= BDRV_BLOCK_OFFSET_VALID
;
1710 *map
= cluster_offset
+ index_in_cluster
;
1712 ret
|= BDRV_BLOCK_RECURSE
;
1715 *file
= extent
->file
->bs
;
1719 n
= extent
->cluster_sectors
* BDRV_SECTOR_SIZE
- index_in_cluster
;
1720 *pnum
= MIN(n
, bytes
);
1724 static int vmdk_write_extent(VmdkExtent
*extent
, int64_t cluster_offset
,
1725 int64_t offset_in_cluster
, QEMUIOVector
*qiov
,
1726 uint64_t qiov_offset
, uint64_t n_bytes
,
1730 VmdkGrainMarker
*data
= NULL
;
1732 QEMUIOVector local_qiov
;
1733 int64_t write_offset
;
1734 int64_t write_end_sector
;
1736 if (extent
->compressed
) {
1737 void *compressed_data
;
1739 /* Only whole clusters */
1740 if (offset_in_cluster
||
1741 n_bytes
> (extent
->cluster_sectors
* SECTOR_SIZE
) ||
1742 (n_bytes
< (extent
->cluster_sectors
* SECTOR_SIZE
) &&
1743 offset
+ n_bytes
!= extent
->end_sector
* SECTOR_SIZE
))
1749 if (!extent
->has_marker
) {
1753 buf_len
= (extent
->cluster_sectors
<< 9) * 2;
1754 data
= g_malloc(buf_len
+ sizeof(VmdkGrainMarker
));
1756 compressed_data
= g_malloc(n_bytes
);
1757 qemu_iovec_to_buf(qiov
, qiov_offset
, compressed_data
, n_bytes
);
1758 ret
= compress(data
->data
, &buf_len
, compressed_data
, n_bytes
);
1759 g_free(compressed_data
);
1761 if (ret
!= Z_OK
|| buf_len
== 0) {
1766 data
->lba
= cpu_to_le64(offset
>> BDRV_SECTOR_BITS
);
1767 data
->size
= cpu_to_le32(buf_len
);
1769 n_bytes
= buf_len
+ sizeof(VmdkGrainMarker
);
1770 qemu_iovec_init_buf(&local_qiov
, data
, n_bytes
);
1772 BLKDBG_EVENT(extent
->file
, BLKDBG_WRITE_COMPRESSED
);
1774 qemu_iovec_init(&local_qiov
, qiov
->niov
);
1775 qemu_iovec_concat(&local_qiov
, qiov
, qiov_offset
, n_bytes
);
1777 BLKDBG_EVENT(extent
->file
, BLKDBG_WRITE_AIO
);
1780 write_offset
= cluster_offset
+ offset_in_cluster
;
1781 ret
= bdrv_co_pwritev(extent
->file
, write_offset
, n_bytes
,
1784 write_end_sector
= DIV_ROUND_UP(write_offset
+ n_bytes
, BDRV_SECTOR_SIZE
);
1786 if (extent
->compressed
) {
1787 extent
->next_cluster_sector
= write_end_sector
;
1789 extent
->next_cluster_sector
= MAX(extent
->next_cluster_sector
,
1799 if (!extent
->compressed
) {
1800 qemu_iovec_destroy(&local_qiov
);
1805 static int vmdk_read_extent(VmdkExtent
*extent
, int64_t cluster_offset
,
1806 int64_t offset_in_cluster
, QEMUIOVector
*qiov
,
1810 int cluster_bytes
, buf_bytes
;
1811 uint8_t *cluster_buf
, *compressed_data
;
1812 uint8_t *uncomp_buf
;
1814 VmdkGrainMarker
*marker
;
1818 if (!extent
->compressed
) {
1819 BLKDBG_EVENT(extent
->file
, BLKDBG_READ_AIO
);
1820 ret
= bdrv_co_preadv(extent
->file
,
1821 cluster_offset
+ offset_in_cluster
, bytes
,
1828 cluster_bytes
= extent
->cluster_sectors
* 512;
1829 /* Read two clusters in case GrainMarker + compressed data > one cluster */
1830 buf_bytes
= cluster_bytes
* 2;
1831 cluster_buf
= g_malloc(buf_bytes
);
1832 uncomp_buf
= g_malloc(cluster_bytes
);
1833 BLKDBG_EVENT(extent
->file
, BLKDBG_READ_COMPRESSED
);
1834 ret
= bdrv_pread(extent
->file
,
1836 cluster_buf
, buf_bytes
);
1840 compressed_data
= cluster_buf
;
1841 buf_len
= cluster_bytes
;
1842 data_len
= cluster_bytes
;
1843 if (extent
->has_marker
) {
1844 marker
= (VmdkGrainMarker
*)cluster_buf
;
1845 compressed_data
= marker
->data
;
1846 data_len
= le32_to_cpu(marker
->size
);
1848 if (!data_len
|| data_len
> buf_bytes
) {
1852 ret
= uncompress(uncomp_buf
, &buf_len
, compressed_data
, data_len
);
1858 if (offset_in_cluster
< 0 ||
1859 offset_in_cluster
+ bytes
> buf_len
) {
1863 qemu_iovec_from_buf(qiov
, 0, uncomp_buf
+ offset_in_cluster
, bytes
);
1868 g_free(cluster_buf
);
1872 static int coroutine_fn
1873 vmdk_co_preadv(BlockDriverState
*bs
, uint64_t offset
, uint64_t bytes
,
1874 QEMUIOVector
*qiov
, int flags
)
1876 BDRVVmdkState
*s
= bs
->opaque
;
1878 uint64_t n_bytes
, offset_in_cluster
;
1879 VmdkExtent
*extent
= NULL
;
1880 QEMUIOVector local_qiov
;
1881 uint64_t cluster_offset
;
1882 uint64_t bytes_done
= 0;
1884 qemu_iovec_init(&local_qiov
, qiov
->niov
);
1885 qemu_co_mutex_lock(&s
->lock
);
1888 extent
= find_extent(s
, offset
>> BDRV_SECTOR_BITS
, extent
);
1893 ret
= get_cluster_offset(bs
, extent
, NULL
,
1894 offset
, false, &cluster_offset
, 0, 0);
1895 offset_in_cluster
= vmdk_find_offset_in_cluster(extent
, offset
);
1897 n_bytes
= MIN(bytes
, extent
->cluster_sectors
* BDRV_SECTOR_SIZE
1898 - offset_in_cluster
);
1900 if (ret
!= VMDK_OK
) {
1901 /* if not allocated, try to read from parent image, if exist */
1902 if (bs
->backing
&& ret
!= VMDK_ZEROED
) {
1903 if (!vmdk_is_cid_valid(bs
)) {
1908 qemu_iovec_reset(&local_qiov
);
1909 qemu_iovec_concat(&local_qiov
, qiov
, bytes_done
, n_bytes
);
1911 /* qcow2 emits this on bs->file instead of bs->backing */
1912 BLKDBG_EVENT(bs
->file
, BLKDBG_READ_BACKING_AIO
);
1913 ret
= bdrv_co_preadv(bs
->backing
, offset
, n_bytes
,
1919 qemu_iovec_memset(qiov
, bytes_done
, 0, n_bytes
);
1922 qemu_iovec_reset(&local_qiov
);
1923 qemu_iovec_concat(&local_qiov
, qiov
, bytes_done
, n_bytes
);
1925 ret
= vmdk_read_extent(extent
, cluster_offset
, offset_in_cluster
,
1926 &local_qiov
, n_bytes
);
1933 bytes_done
+= n_bytes
;
1938 qemu_co_mutex_unlock(&s
->lock
);
1939 qemu_iovec_destroy(&local_qiov
);
1946 * @zeroed: buf is ignored (data is zero), use zeroed_grain GTE feature
1947 * if possible, otherwise return -ENOTSUP.
1948 * @zero_dry_run: used for zeroed == true only, don't update L2 table, just try
1949 * with each cluster. By dry run we can find if the zero write
1950 * is possible without modifying image data.
1952 * Returns: error code with 0 for success.
1954 static int vmdk_pwritev(BlockDriverState
*bs
, uint64_t offset
,
1955 uint64_t bytes
, QEMUIOVector
*qiov
,
1956 bool zeroed
, bool zero_dry_run
)
1958 BDRVVmdkState
*s
= bs
->opaque
;
1959 VmdkExtent
*extent
= NULL
;
1961 int64_t offset_in_cluster
, n_bytes
;
1962 uint64_t cluster_offset
;
1963 uint64_t bytes_done
= 0;
1964 VmdkMetaData m_data
;
1966 if (DIV_ROUND_UP(offset
, BDRV_SECTOR_SIZE
) > bs
->total_sectors
) {
1967 error_report("Wrong offset: offset=0x%" PRIx64
1968 " total_sectors=0x%" PRIx64
,
1969 offset
, bs
->total_sectors
);
1974 extent
= find_extent(s
, offset
>> BDRV_SECTOR_BITS
, extent
);
1978 if (extent
->sesparse
) {
1981 offset_in_cluster
= vmdk_find_offset_in_cluster(extent
, offset
);
1982 n_bytes
= MIN(bytes
, extent
->cluster_sectors
* BDRV_SECTOR_SIZE
1983 - offset_in_cluster
);
1985 ret
= get_cluster_offset(bs
, extent
, &m_data
, offset
,
1986 !(extent
->compressed
|| zeroed
),
1987 &cluster_offset
, offset_in_cluster
,
1988 offset_in_cluster
+ n_bytes
);
1989 if (extent
->compressed
) {
1990 if (ret
== VMDK_OK
) {
1991 /* Refuse write to allocated cluster for streamOptimized */
1992 error_report("Could not write to allocated cluster"
1993 " for streamOptimized");
1995 } else if (!zeroed
) {
1997 ret
= get_cluster_offset(bs
, extent
, &m_data
, offset
,
1998 true, &cluster_offset
, 0, 0);
2001 if (ret
== VMDK_ERROR
) {
2005 /* Do zeroed write, buf is ignored */
2006 if (extent
->has_zero_grain
&&
2007 offset_in_cluster
== 0 &&
2008 n_bytes
>= extent
->cluster_sectors
* BDRV_SECTOR_SIZE
) {
2009 n_bytes
= extent
->cluster_sectors
* BDRV_SECTOR_SIZE
;
2010 if (!zero_dry_run
) {
2011 /* update L2 tables */
2012 if (vmdk_L2update(extent
, &m_data
, VMDK_GTE_ZEROED
)
2021 ret
= vmdk_write_extent(extent
, cluster_offset
, offset_in_cluster
,
2022 qiov
, bytes_done
, n_bytes
, offset
);
2026 if (m_data
.new_allocation
) {
2027 /* update L2 tables */
2028 if (vmdk_L2update(extent
, &m_data
,
2029 cluster_offset
>> BDRV_SECTOR_BITS
)
2037 bytes_done
+= n_bytes
;
2039 /* update CID on the first write every time the virtual disk is
2041 if (!s
->cid_updated
) {
2042 ret
= vmdk_write_cid(bs
, g_random_int());
2046 s
->cid_updated
= true;
2052 static int coroutine_fn
2053 vmdk_co_pwritev(BlockDriverState
*bs
, uint64_t offset
, uint64_t bytes
,
2054 QEMUIOVector
*qiov
, int flags
)
2057 BDRVVmdkState
*s
= bs
->opaque
;
2058 qemu_co_mutex_lock(&s
->lock
);
2059 ret
= vmdk_pwritev(bs
, offset
, bytes
, qiov
, false, false);
2060 qemu_co_mutex_unlock(&s
->lock
);
2064 static int coroutine_fn
2065 vmdk_co_pwritev_compressed(BlockDriverState
*bs
, uint64_t offset
,
2066 uint64_t bytes
, QEMUIOVector
*qiov
)
2069 /* The caller will write bytes 0 to signal EOF.
2070 * When receive it, we align EOF to a sector boundary. */
2071 BDRVVmdkState
*s
= bs
->opaque
;
2075 for (i
= 0; i
< s
->num_extents
; i
++) {
2076 length
= bdrv_getlength(s
->extents
[i
].file
->bs
);
2080 length
= QEMU_ALIGN_UP(length
, BDRV_SECTOR_SIZE
);
2081 ret
= bdrv_truncate(s
->extents
[i
].file
, length
, false,
2082 PREALLOC_MODE_OFF
, 0, NULL
);
2089 return vmdk_co_pwritev(bs
, offset
, bytes
, qiov
, 0);
2092 static int coroutine_fn
vmdk_co_pwrite_zeroes(BlockDriverState
*bs
,
2095 BdrvRequestFlags flags
)
2098 BDRVVmdkState
*s
= bs
->opaque
;
2100 qemu_co_mutex_lock(&s
->lock
);
2101 /* write zeroes could fail if sectors not aligned to cluster, test it with
2102 * dry_run == true before really updating image */
2103 ret
= vmdk_pwritev(bs
, offset
, bytes
, NULL
, true, true);
2105 ret
= vmdk_pwritev(bs
, offset
, bytes
, NULL
, true, false);
2107 qemu_co_mutex_unlock(&s
->lock
);
2111 static int vmdk_init_extent(BlockBackend
*blk
,
2112 int64_t filesize
, bool flat
,
2113 bool compress
, bool zeroed_grain
,
2118 uint32_t tmp
, magic
, grains
, gd_sectors
, gt_size
, gt_count
;
2119 uint32_t *gd_buf
= NULL
;
2123 ret
= blk_truncate(blk
, filesize
, false, PREALLOC_MODE_OFF
, 0, errp
);
2126 magic
= cpu_to_be32(VMDK4_MAGIC
);
2127 memset(&header
, 0, sizeof(header
));
2130 } else if (zeroed_grain
) {
2135 header
.flags
= VMDK4_FLAG_RGD
| VMDK4_FLAG_NL_DETECT
2136 | (compress
? VMDK4_FLAG_COMPRESS
| VMDK4_FLAG_MARKER
: 0)
2137 | (zeroed_grain
? VMDK4_FLAG_ZERO_GRAIN
: 0);
2138 header
.compressAlgorithm
= compress
? VMDK4_COMPRESSION_DEFLATE
: 0;
2139 header
.capacity
= filesize
/ BDRV_SECTOR_SIZE
;
2140 header
.granularity
= 128;
2141 header
.num_gtes_per_gt
= BDRV_SECTOR_SIZE
;
2143 grains
= DIV_ROUND_UP(filesize
/ BDRV_SECTOR_SIZE
, header
.granularity
);
2144 gt_size
= DIV_ROUND_UP(header
.num_gtes_per_gt
* sizeof(uint32_t),
2146 gt_count
= DIV_ROUND_UP(grains
, header
.num_gtes_per_gt
);
2147 gd_sectors
= DIV_ROUND_UP(gt_count
* sizeof(uint32_t), BDRV_SECTOR_SIZE
);
2149 header
.desc_offset
= 1;
2150 header
.desc_size
= 20;
2151 header
.rgd_offset
= header
.desc_offset
+ header
.desc_size
;
2152 header
.gd_offset
= header
.rgd_offset
+ gd_sectors
+ (gt_size
* gt_count
);
2153 header
.grain_offset
=
2154 ROUND_UP(header
.gd_offset
+ gd_sectors
+ (gt_size
* gt_count
),
2155 header
.granularity
);
2156 /* swap endianness for all header fields */
2157 header
.version
= cpu_to_le32(header
.version
);
2158 header
.flags
= cpu_to_le32(header
.flags
);
2159 header
.capacity
= cpu_to_le64(header
.capacity
);
2160 header
.granularity
= cpu_to_le64(header
.granularity
);
2161 header
.num_gtes_per_gt
= cpu_to_le32(header
.num_gtes_per_gt
);
2162 header
.desc_offset
= cpu_to_le64(header
.desc_offset
);
2163 header
.desc_size
= cpu_to_le64(header
.desc_size
);
2164 header
.rgd_offset
= cpu_to_le64(header
.rgd_offset
);
2165 header
.gd_offset
= cpu_to_le64(header
.gd_offset
);
2166 header
.grain_offset
= cpu_to_le64(header
.grain_offset
);
2167 header
.compressAlgorithm
= cpu_to_le16(header
.compressAlgorithm
);
2169 header
.check_bytes
[0] = 0xa;
2170 header
.check_bytes
[1] = 0x20;
2171 header
.check_bytes
[2] = 0xd;
2172 header
.check_bytes
[3] = 0xa;
2174 /* write all the data */
2175 ret
= blk_pwrite(blk
, 0, &magic
, sizeof(magic
), 0);
2177 error_setg(errp
, QERR_IO_ERROR
);
2180 ret
= blk_pwrite(blk
, sizeof(magic
), &header
, sizeof(header
), 0);
2182 error_setg(errp
, QERR_IO_ERROR
);
2186 ret
= blk_truncate(blk
, le64_to_cpu(header
.grain_offset
) << 9, false,
2187 PREALLOC_MODE_OFF
, 0, errp
);
2192 /* write grain directory */
2193 gd_buf_size
= gd_sectors
* BDRV_SECTOR_SIZE
;
2194 gd_buf
= g_malloc0(gd_buf_size
);
2195 for (i
= 0, tmp
= le64_to_cpu(header
.rgd_offset
) + gd_sectors
;
2196 i
< gt_count
; i
++, tmp
+= gt_size
) {
2197 gd_buf
[i
] = cpu_to_le32(tmp
);
2199 ret
= blk_pwrite(blk
, le64_to_cpu(header
.rgd_offset
) * BDRV_SECTOR_SIZE
,
2200 gd_buf
, gd_buf_size
, 0);
2202 error_setg(errp
, QERR_IO_ERROR
);
2206 /* write backup grain directory */
2207 for (i
= 0, tmp
= le64_to_cpu(header
.gd_offset
) + gd_sectors
;
2208 i
< gt_count
; i
++, tmp
+= gt_size
) {
2209 gd_buf
[i
] = cpu_to_le32(tmp
);
2211 ret
= blk_pwrite(blk
, le64_to_cpu(header
.gd_offset
) * BDRV_SECTOR_SIZE
,
2212 gd_buf
, gd_buf_size
, 0);
2214 error_setg(errp
, QERR_IO_ERROR
);
2223 static int vmdk_create_extent(const char *filename
, int64_t filesize
,
2224 bool flat
, bool compress
, bool zeroed_grain
,
2226 QemuOpts
*opts
, Error
**errp
)
2229 BlockBackend
*blk
= NULL
;
2230 Error
*local_err
= NULL
;
2232 ret
= bdrv_create_file(filename
, opts
, &local_err
);
2234 error_propagate(errp
, local_err
);
2238 blk
= blk_new_open(filename
, NULL
, NULL
,
2239 BDRV_O_RDWR
| BDRV_O_RESIZE
| BDRV_O_PROTOCOL
,
2242 error_propagate(errp
, local_err
);
2247 blk_set_allow_write_beyond_eof(blk
, true);
2249 ret
= vmdk_init_extent(blk
, filesize
, flat
, compress
, zeroed_grain
, errp
);
2262 static int filename_decompose(const char *filename
, char *path
, char *prefix
,
2263 char *postfix
, size_t buf_len
, Error
**errp
)
2267 if (filename
== NULL
|| !strlen(filename
)) {
2268 error_setg(errp
, "No filename provided");
2271 p
= strrchr(filename
, '/');
2273 p
= strrchr(filename
, '\\');
2276 p
= strrchr(filename
, ':');
2280 if (p
- filename
>= buf_len
) {
2283 pstrcpy(path
, p
- filename
+ 1, filename
);
2288 q
= strrchr(p
, '.');
2290 pstrcpy(prefix
, buf_len
, p
);
2293 if (q
- p
>= buf_len
) {
2296 pstrcpy(prefix
, q
- p
+ 1, p
);
2297 pstrcpy(postfix
, buf_len
, q
);
2303 * idx == 0: get or create the descriptor file (also the image file if in a
2305 * idx >= 1: get the n-th extent if in a split subformat
2307 typedef BlockBackend
*(*vmdk_create_extent_fn
)(int64_t size
,
2316 static void vmdk_desc_add_extent(GString
*desc
,
2317 const char *extent_line_fmt
,
2318 int64_t size
, const char *filename
)
2320 char *basename
= g_path_get_basename(filename
);
2322 g_string_append_printf(desc
, extent_line_fmt
,
2323 DIV_ROUND_UP(size
, BDRV_SECTOR_SIZE
), basename
);
2327 static int coroutine_fn
vmdk_co_do_create(int64_t size
,
2328 BlockdevVmdkSubformat subformat
,
2329 BlockdevVmdkAdapterType adapter_type
,
2330 const char *backing_file
,
2331 const char *hw_version
,
2334 vmdk_create_extent_fn extent_fn
,
2339 BlockBackend
*blk
= NULL
;
2340 BlockBackend
*extent_blk
;
2341 Error
*local_err
= NULL
;
2344 bool flat
, split
, compress
;
2345 GString
*ext_desc_lines
;
2346 const int64_t split_size
= 0x80000000; /* VMDK has constant split size */
2347 int64_t extent_size
;
2348 int64_t created_size
= 0;
2349 const char *extent_line_fmt
;
2350 char *parent_desc_line
= g_malloc0(BUF_SIZE
);
2351 uint32_t parent_cid
= 0xffffffff;
2352 uint32_t number_heads
= 16;
2353 uint32_t desc_offset
= 0, desc_len
;
2354 const char desc_template
[] =
2355 "# Disk DescriptorFile\n"
2358 "parentCID=%" PRIx32
"\n"
2359 "createType=\"%s\"\n"
2362 "# Extent description\n"
2365 "# The Disk Data Base\n"
2368 "ddb.virtualHWVersion = \"%s\"\n"
2369 "ddb.geometry.cylinders = \"%" PRId64
"\"\n"
2370 "ddb.geometry.heads = \"%" PRIu32
"\"\n"
2371 "ddb.geometry.sectors = \"63\"\n"
2372 "ddb.adapterType = \"%s\"\n";
2374 ext_desc_lines
= g_string_new(NULL
);
2376 /* Read out options */
2380 "compat6 cannot be enabled with hwversion set");
2390 if (adapter_type
!= BLOCKDEV_VMDK_ADAPTER_TYPE_IDE
) {
2391 /* that's the number of heads with which vmware operates when
2392 creating, exporting, etc. vmdk files with a non-ide adapter type */
2395 split
= (subformat
== BLOCKDEV_VMDK_SUBFORMAT_TWOGBMAXEXTENTFLAT
) ||
2396 (subformat
== BLOCKDEV_VMDK_SUBFORMAT_TWOGBMAXEXTENTSPARSE
);
2397 flat
= (subformat
== BLOCKDEV_VMDK_SUBFORMAT_MONOLITHICFLAT
) ||
2398 (subformat
== BLOCKDEV_VMDK_SUBFORMAT_TWOGBMAXEXTENTFLAT
);
2399 compress
= subformat
== BLOCKDEV_VMDK_SUBFORMAT_STREAMOPTIMIZED
;
2402 extent_line_fmt
= "RW %" PRId64
" FLAT \"%s\" 0\n";
2404 extent_line_fmt
= "RW %" PRId64
" SPARSE \"%s\"\n";
2406 if (flat
&& backing_file
) {
2407 error_setg(errp
, "Flat image can't have backing file");
2411 if (flat
&& zeroed_grain
) {
2412 error_setg(errp
, "Flat image can't enable zeroed grain");
2417 /* Create extents */
2419 extent_size
= split_size
;
2423 if (!split
&& !flat
) {
2424 created_size
= extent_size
;
2428 /* Get the descriptor file BDS */
2429 blk
= extent_fn(created_size
, 0, flat
, split
, compress
, zeroed_grain
,
2435 if (!split
&& !flat
) {
2436 vmdk_desc_add_extent(ext_desc_lines
, extent_line_fmt
, created_size
,
2437 blk_bs(blk
)->filename
);
2441 BlockBackend
*backing
;
2442 char *full_backing
=
2443 bdrv_get_full_backing_filename_from_filename(blk_bs(blk
)->filename
,
2447 error_propagate(errp
, local_err
);
2451 assert(full_backing
);
2453 backing
= blk_new_open(full_backing
, NULL
, NULL
,
2454 BDRV_O_NO_BACKING
, errp
);
2455 g_free(full_backing
);
2456 if (backing
== NULL
) {
2460 if (strcmp(blk_bs(backing
)->drv
->format_name
, "vmdk")) {
2461 error_setg(errp
, "Invalid backing file format: %s. Must be vmdk",
2462 blk_bs(backing
)->drv
->format_name
);
2467 ret
= vmdk_read_cid(blk_bs(backing
), 0, &parent_cid
);
2470 error_setg(errp
, "Failed to read parent CID");
2473 snprintf(parent_desc_line
, BUF_SIZE
,
2474 "parentFileNameHint=\"%s\"", backing_file
);
2477 while (created_size
< size
) {
2478 int64_t cur_size
= MIN(size
- created_size
, extent_size
);
2479 extent_blk
= extent_fn(cur_size
, extent_idx
, flat
, split
, compress
,
2480 zeroed_grain
, opaque
, errp
);
2485 vmdk_desc_add_extent(ext_desc_lines
, extent_line_fmt
, cur_size
,
2486 blk_bs(extent_blk
)->filename
);
2487 created_size
+= cur_size
;
2489 blk_unref(extent_blk
);
2492 /* Check whether we got excess extents */
2493 extent_blk
= extent_fn(-1, extent_idx
, flat
, split
, compress
, zeroed_grain
,
2496 blk_unref(extent_blk
);
2497 error_setg(errp
, "List of extents contains unused extents");
2502 /* generate descriptor file */
2503 desc
= g_strdup_printf(desc_template
,
2506 BlockdevVmdkSubformat_str(subformat
),
2508 ext_desc_lines
->str
,
2511 (int64_t)(63 * number_heads
* BDRV_SECTOR_SIZE
),
2513 BlockdevVmdkAdapterType_str(adapter_type
));
2514 desc_len
= strlen(desc
);
2515 /* the descriptor offset = 0x200 */
2516 if (!split
&& !flat
) {
2517 desc_offset
= 0x200;
2520 ret
= blk_pwrite(blk
, desc_offset
, desc
, desc_len
, 0);
2522 error_setg_errno(errp
, -ret
, "Could not write description");
2525 /* bdrv_pwrite write padding zeros to align to sector, we don't need that
2526 * for description file */
2527 if (desc_offset
== 0) {
2528 ret
= blk_truncate(blk
, desc_len
, false, PREALLOC_MODE_OFF
, 0, errp
);
2539 g_free(parent_desc_line
);
2540 g_string_free(ext_desc_lines
, true);
2549 } VMDKCreateOptsData
;
2551 static BlockBackend
*vmdk_co_create_opts_cb(int64_t size
, int idx
,
2552 bool flat
, bool split
, bool compress
,
2553 bool zeroed_grain
, void *opaque
,
2556 BlockBackend
*blk
= NULL
;
2557 BlockDriverState
*bs
= NULL
;
2558 VMDKCreateOptsData
*data
= opaque
;
2559 char *ext_filename
= NULL
;
2560 char *rel_filename
= NULL
;
2562 /* We're done, don't create excess extents. */
2564 assert(errp
== NULL
);
2569 rel_filename
= g_strdup_printf("%s%s", data
->prefix
, data
->postfix
);
2571 rel_filename
= g_strdup_printf("%s-%c%03d%s",
2573 flat
? 'f' : 's', idx
, data
->postfix
);
2576 rel_filename
= g_strdup_printf("%s-flat%s", data
->prefix
, data
->postfix
);
2579 ext_filename
= g_strdup_printf("%s%s", data
->path
, rel_filename
);
2580 g_free(rel_filename
);
2582 if (vmdk_create_extent(ext_filename
, size
,
2583 flat
, compress
, zeroed_grain
, &blk
, data
->opts
,
2589 g_free(ext_filename
);
2593 static int coroutine_fn
vmdk_co_create_opts(BlockDriver
*drv
,
2594 const char *filename
,
2598 Error
*local_err
= NULL
;
2600 int64_t total_size
= 0;
2601 char *adapter_type
= NULL
;
2602 BlockdevVmdkAdapterType adapter_type_enum
;
2603 char *backing_file
= NULL
;
2604 char *hw_version
= NULL
;
2606 BlockdevVmdkSubformat subformat
;
2608 char *path
= g_malloc0(PATH_MAX
);
2609 char *prefix
= g_malloc0(PATH_MAX
);
2610 char *postfix
= g_malloc0(PATH_MAX
);
2611 char *desc_line
= g_malloc0(BUF_SIZE
);
2612 char *ext_filename
= g_malloc0(PATH_MAX
);
2613 char *desc_filename
= g_malloc0(PATH_MAX
);
2614 char *parent_desc_line
= g_malloc0(BUF_SIZE
);
2617 VMDKCreateOptsData data
;
2619 if (filename_decompose(filename
, path
, prefix
, postfix
, PATH_MAX
, errp
)) {
2623 /* Read out options */
2624 total_size
= ROUND_UP(qemu_opt_get_size_del(opts
, BLOCK_OPT_SIZE
, 0),
2626 adapter_type
= qemu_opt_get_del(opts
, BLOCK_OPT_ADAPTER_TYPE
);
2627 backing_file
= qemu_opt_get_del(opts
, BLOCK_OPT_BACKING_FILE
);
2628 hw_version
= qemu_opt_get_del(opts
, BLOCK_OPT_HWVERSION
);
2629 compat6
= qemu_opt_get_bool_del(opts
, BLOCK_OPT_COMPAT6
, false);
2630 if (strcmp(hw_version
, "undefined") == 0) {
2634 fmt
= qemu_opt_get_del(opts
, BLOCK_OPT_SUBFMT
);
2635 zeroed_grain
= qemu_opt_get_bool_del(opts
, BLOCK_OPT_ZEROED_GRAIN
, false);
2638 adapter_type_enum
= qapi_enum_parse(&BlockdevVmdkAdapterType_lookup
,
2640 BLOCKDEV_VMDK_ADAPTER_TYPE_IDE
,
2643 error_propagate(errp
, local_err
);
2648 adapter_type_enum
= BLOCKDEV_VMDK_ADAPTER_TYPE_IDE
;
2652 /* Default format to monolithicSparse */
2653 subformat
= BLOCKDEV_VMDK_SUBFORMAT_MONOLITHICSPARSE
;
2655 subformat
= qapi_enum_parse(&BlockdevVmdkSubformat_lookup
,
2657 BLOCKDEV_VMDK_SUBFORMAT_MONOLITHICSPARSE
,
2660 error_propagate(errp
, local_err
);
2665 data
= (VMDKCreateOptsData
){
2671 ret
= vmdk_co_do_create(total_size
, subformat
, adapter_type_enum
,
2672 backing_file
, hw_version
, compat6
, zeroed_grain
,
2673 vmdk_co_create_opts_cb
, &data
, errp
);
2676 g_free(adapter_type
);
2677 g_free(backing_file
);
2685 g_free(ext_filename
);
2686 g_free(desc_filename
);
2687 g_free(parent_desc_line
);
2691 static BlockBackend
*vmdk_co_create_cb(int64_t size
, int idx
,
2692 bool flat
, bool split
, bool compress
,
2693 bool zeroed_grain
, void *opaque
,
2697 BlockDriverState
*bs
;
2699 BlockdevCreateOptionsVmdk
*opts
= opaque
;
2702 bs
= bdrv_open_blockdev_ref(opts
->file
, errp
);
2705 BlockdevRefList
*list
= opts
->extents
;
2706 for (i
= 1; i
< idx
; i
++) {
2707 if (!list
|| !list
->next
) {
2708 error_setg(errp
, "Extent [%d] not specified", i
);
2714 error_setg(errp
, "Extent [%d] not specified", idx
- 1);
2717 bs
= bdrv_open_blockdev_ref(list
->value
, errp
);
2722 blk
= blk_new_with_bs(bs
,
2723 BLK_PERM_CONSISTENT_READ
| BLK_PERM_WRITE
| BLK_PERM_RESIZE
,
2724 BLK_PERM_ALL
, errp
);
2728 blk_set_allow_write_beyond_eof(blk
, true);
2732 ret
= vmdk_init_extent(blk
, size
, flat
, compress
, zeroed_grain
, errp
);
2741 static int coroutine_fn
vmdk_co_create(BlockdevCreateOptions
*create_options
,
2745 BlockdevCreateOptionsVmdk
*opts
;
2747 opts
= &create_options
->u
.vmdk
;
2749 /* Validate options */
2750 if (!QEMU_IS_ALIGNED(opts
->size
, BDRV_SECTOR_SIZE
)) {
2751 error_setg(errp
, "Image size must be a multiple of 512 bytes");
2756 ret
= vmdk_co_do_create(opts
->size
,
2771 static void vmdk_close(BlockDriverState
*bs
)
2773 BDRVVmdkState
*s
= bs
->opaque
;
2775 vmdk_free_extents(bs
);
2776 g_free(s
->create_type
);
2778 migrate_del_blocker(s
->migration_blocker
);
2779 error_free(s
->migration_blocker
);
2782 static coroutine_fn
int vmdk_co_flush(BlockDriverState
*bs
)
2784 BDRVVmdkState
*s
= bs
->opaque
;
2788 for (i
= 0; i
< s
->num_extents
; i
++) {
2789 err
= bdrv_co_flush(s
->extents
[i
].file
->bs
);
2797 static int64_t vmdk_get_allocated_file_size(BlockDriverState
*bs
)
2802 BDRVVmdkState
*s
= bs
->opaque
;
2804 ret
= bdrv_get_allocated_file_size(bs
->file
->bs
);
2808 for (i
= 0; i
< s
->num_extents
; i
++) {
2809 if (s
->extents
[i
].file
== bs
->file
) {
2812 r
= bdrv_get_allocated_file_size(s
->extents
[i
].file
->bs
);
2821 static int vmdk_has_zero_init(BlockDriverState
*bs
)
2824 BDRVVmdkState
*s
= bs
->opaque
;
2826 /* If has a flat extent and its underlying storage doesn't have zero init,
2828 for (i
= 0; i
< s
->num_extents
; i
++) {
2829 if (s
->extents
[i
].flat
) {
2830 if (!bdrv_has_zero_init(s
->extents
[i
].file
->bs
)) {
2838 static ImageInfo
*vmdk_get_extent_info(VmdkExtent
*extent
)
2840 ImageInfo
*info
= g_new0(ImageInfo
, 1);
2842 bdrv_refresh_filename(extent
->file
->bs
);
2843 *info
= (ImageInfo
){
2844 .filename
= g_strdup(extent
->file
->bs
->filename
),
2845 .format
= g_strdup(extent
->type
),
2846 .virtual_size
= extent
->sectors
* BDRV_SECTOR_SIZE
,
2847 .compressed
= extent
->compressed
,
2848 .has_compressed
= extent
->compressed
,
2849 .cluster_size
= extent
->cluster_sectors
* BDRV_SECTOR_SIZE
,
2850 .has_cluster_size
= !extent
->flat
,
2856 static int coroutine_fn
vmdk_co_check(BlockDriverState
*bs
,
2857 BdrvCheckResult
*result
,
2860 BDRVVmdkState
*s
= bs
->opaque
;
2861 VmdkExtent
*extent
= NULL
;
2862 int64_t sector_num
= 0;
2863 int64_t total_sectors
= bdrv_nb_sectors(bs
);
2865 uint64_t cluster_offset
;
2872 if (sector_num
>= total_sectors
) {
2875 extent
= find_extent(s
, sector_num
, extent
);
2878 "ERROR: could not find extent for sector %" PRId64
"\n",
2883 ret
= get_cluster_offset(bs
, extent
, NULL
,
2884 sector_num
<< BDRV_SECTOR_BITS
,
2885 false, &cluster_offset
, 0, 0);
2886 if (ret
== VMDK_ERROR
) {
2888 "ERROR: could not get cluster_offset for sector %"
2889 PRId64
"\n", sector_num
);
2892 if (ret
== VMDK_OK
) {
2893 int64_t extent_len
= bdrv_getlength(extent
->file
->bs
);
2894 if (extent_len
< 0) {
2896 "ERROR: could not get extent file length for sector %"
2897 PRId64
"\n", sector_num
);
2901 if (cluster_offset
>= extent_len
) {
2903 "ERROR: cluster offset for sector %"
2904 PRId64
" points after EOF\n", sector_num
);
2909 sector_num
+= extent
->cluster_sectors
;
2912 result
->corruptions
++;
2916 static ImageInfoSpecific
*vmdk_get_specific_info(BlockDriverState
*bs
,
2920 BDRVVmdkState
*s
= bs
->opaque
;
2921 ImageInfoSpecific
*spec_info
= g_new0(ImageInfoSpecific
, 1);
2922 ImageInfoList
**next
;
2924 *spec_info
= (ImageInfoSpecific
){
2925 .type
= IMAGE_INFO_SPECIFIC_KIND_VMDK
,
2927 .vmdk
.data
= g_new0(ImageInfoSpecificVmdk
, 1),
2931 *spec_info
->u
.vmdk
.data
= (ImageInfoSpecificVmdk
) {
2932 .create_type
= g_strdup(s
->create_type
),
2934 .parent_cid
= s
->parent_cid
,
2937 next
= &spec_info
->u
.vmdk
.data
->extents
;
2938 for (i
= 0; i
< s
->num_extents
; i
++) {
2939 *next
= g_new0(ImageInfoList
, 1);
2940 (*next
)->value
= vmdk_get_extent_info(&s
->extents
[i
]);
2941 (*next
)->next
= NULL
;
2942 next
= &(*next
)->next
;
2948 static bool vmdk_extents_type_eq(const VmdkExtent
*a
, const VmdkExtent
*b
)
2950 return a
->flat
== b
->flat
&&
2951 a
->compressed
== b
->compressed
&&
2952 (a
->flat
|| a
->cluster_sectors
== b
->cluster_sectors
);
2955 static int vmdk_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
)
2958 BDRVVmdkState
*s
= bs
->opaque
;
2959 assert(s
->num_extents
);
2961 /* See if we have multiple extents but they have different cases */
2962 for (i
= 1; i
< s
->num_extents
; i
++) {
2963 if (!vmdk_extents_type_eq(&s
->extents
[0], &s
->extents
[i
])) {
2967 bdi
->needs_compressed_writes
= s
->extents
[0].compressed
;
2968 if (!s
->extents
[0].flat
) {
2969 bdi
->cluster_size
= s
->extents
[0].cluster_sectors
<< BDRV_SECTOR_BITS
;
2974 static void vmdk_gather_child_options(BlockDriverState
*bs
, QDict
*target
,
2975 bool backing_overridden
)
2977 /* No children but file and backing can be explicitly specified (TODO) */
2978 qdict_put(target
, "file",
2979 qobject_ref(bs
->file
->bs
->full_open_options
));
2981 if (backing_overridden
) {
2983 qdict_put(target
, "backing",
2984 qobject_ref(bs
->backing
->bs
->full_open_options
));
2986 qdict_put_null(target
, "backing");
2991 static QemuOptsList vmdk_create_opts
= {
2992 .name
= "vmdk-create-opts",
2993 .head
= QTAILQ_HEAD_INITIALIZER(vmdk_create_opts
.head
),
2996 .name
= BLOCK_OPT_SIZE
,
2997 .type
= QEMU_OPT_SIZE
,
2998 .help
= "Virtual disk size"
3001 .name
= BLOCK_OPT_ADAPTER_TYPE
,
3002 .type
= QEMU_OPT_STRING
,
3003 .help
= "Virtual adapter type, can be one of "
3004 "ide (default), lsilogic, buslogic or legacyESX"
3007 .name
= BLOCK_OPT_BACKING_FILE
,
3008 .type
= QEMU_OPT_STRING
,
3009 .help
= "File name of a base image"
3012 .name
= BLOCK_OPT_COMPAT6
,
3013 .type
= QEMU_OPT_BOOL
,
3014 .help
= "VMDK version 6 image",
3015 .def_value_str
= "off"
3018 .name
= BLOCK_OPT_HWVERSION
,
3019 .type
= QEMU_OPT_STRING
,
3020 .help
= "VMDK hardware version",
3021 .def_value_str
= "undefined"
3024 .name
= BLOCK_OPT_SUBFMT
,
3025 .type
= QEMU_OPT_STRING
,
3027 "VMDK flat extent format, can be one of "
3028 "{monolithicSparse (default) | monolithicFlat | twoGbMaxExtentSparse | twoGbMaxExtentFlat | streamOptimized} "
3031 .name
= BLOCK_OPT_ZEROED_GRAIN
,
3032 .type
= QEMU_OPT_BOOL
,
3033 .help
= "Enable efficient zero writes "
3034 "using the zeroed-grain GTE feature"
3036 { /* end of list */ }
3040 static BlockDriver bdrv_vmdk
= {
3041 .format_name
= "vmdk",
3042 .instance_size
= sizeof(BDRVVmdkState
),
3043 .bdrv_probe
= vmdk_probe
,
3044 .bdrv_open
= vmdk_open
,
3045 .bdrv_co_check
= vmdk_co_check
,
3046 .bdrv_reopen_prepare
= vmdk_reopen_prepare
,
3047 .bdrv_child_perm
= bdrv_format_default_perms
,
3048 .bdrv_co_preadv
= vmdk_co_preadv
,
3049 .bdrv_co_pwritev
= vmdk_co_pwritev
,
3050 .bdrv_co_pwritev_compressed
= vmdk_co_pwritev_compressed
,
3051 .bdrv_co_pwrite_zeroes
= vmdk_co_pwrite_zeroes
,
3052 .bdrv_close
= vmdk_close
,
3053 .bdrv_co_create_opts
= vmdk_co_create_opts
,
3054 .bdrv_co_create
= vmdk_co_create
,
3055 .bdrv_co_flush_to_disk
= vmdk_co_flush
,
3056 .bdrv_co_block_status
= vmdk_co_block_status
,
3057 .bdrv_get_allocated_file_size
= vmdk_get_allocated_file_size
,
3058 .bdrv_has_zero_init
= vmdk_has_zero_init
,
3059 .bdrv_get_specific_info
= vmdk_get_specific_info
,
3060 .bdrv_refresh_limits
= vmdk_refresh_limits
,
3061 .bdrv_get_info
= vmdk_get_info
,
3062 .bdrv_gather_child_options
= vmdk_gather_child_options
,
3064 .supports_backing
= true,
3065 .create_opts
= &vmdk_create_opts
,
3068 static void bdrv_vmdk_init(void)
3070 bdrv_register(&bdrv_vmdk
);
3073 block_init(bdrv_vmdk_init
);