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_int.h"
31 #define VMDK3_MAGIC (('C' << 24) | ('O' << 16) | ('W' << 8) | 'D')
32 #define VMDK4_MAGIC (('K' << 24) | ('D' << 16) | ('M' << 8) | 'V')
33 #define VMDK4_COMPRESSION_DEFLATE 1
34 #define VMDK4_FLAG_RGD (1 << 1)
35 #define VMDK4_FLAG_COMPRESS (1 << 16)
36 #define VMDK4_FLAG_MARKER (1 << 17)
41 uint32_t disk_sectors
;
43 uint32_t l1dir_offset
;
45 uint32_t file_sectors
;
48 uint32_t sectors_per_track
;
58 int32_t num_gtes_per_gte
;
64 uint16_t compressAlgorithm
;
65 } QEMU_PACKED VMDK4Header
;
67 #define L2_CACHE_SIZE 16
69 typedef struct VmdkExtent
{
70 BlockDriverState
*file
;
76 int64_t flat_start_offset
;
77 int64_t l1_table_offset
;
78 int64_t l1_backup_table_offset
;
80 uint32_t *l1_backup_table
;
82 uint32_t l1_entry_sectors
;
86 uint32_t l2_cache_offsets
[L2_CACHE_SIZE
];
87 uint32_t l2_cache_counts
[L2_CACHE_SIZE
];
89 unsigned int cluster_sectors
;
92 typedef struct BDRVVmdkState
{
97 /* Extent array with num_extents entries, ascend ordered by address */
101 typedef struct VmdkMetaData
{
103 unsigned int l1_index
;
104 unsigned int l2_index
;
105 unsigned int l2_offset
;
109 typedef struct VmdkGrainMarker
{
115 static int vmdk_probe(const uint8_t *buf
, int buf_size
, const char *filename
)
122 magic
= be32_to_cpu(*(uint32_t *)buf
);
123 if (magic
== VMDK3_MAGIC
||
124 magic
== VMDK4_MAGIC
) {
127 const char *p
= (const char *)buf
;
128 const char *end
= p
+ buf_size
;
131 /* skip comment line */
132 while (p
< end
&& *p
!= '\n') {
139 while (p
< end
&& *p
== ' ') {
142 /* skip '\r' if windows line endings used. */
143 if (p
< end
&& *p
== '\r') {
146 /* only accept blank lines before 'version=' line */
147 if (p
== end
|| *p
!= '\n') {
153 if (end
- p
>= strlen("version=X\n")) {
154 if (strncmp("version=1\n", p
, strlen("version=1\n")) == 0 ||
155 strncmp("version=2\n", p
, strlen("version=2\n")) == 0) {
159 if (end
- p
>= strlen("version=X\r\n")) {
160 if (strncmp("version=1\r\n", p
, strlen("version=1\r\n")) == 0 ||
161 strncmp("version=2\r\n", p
, strlen("version=2\r\n")) == 0) {
173 #define SECTOR_SIZE 512
174 #define DESC_SIZE (20 * SECTOR_SIZE) /* 20 sectors of 512 bytes each */
175 #define BUF_SIZE 4096
176 #define HEADER_SIZE 512 /* first sector of 512 bytes */
178 static void vmdk_free_extents(BlockDriverState
*bs
)
181 BDRVVmdkState
*s
= bs
->opaque
;
183 for (i
= 0; i
< s
->num_extents
; i
++) {
184 g_free(s
->extents
[i
].l1_table
);
185 g_free(s
->extents
[i
].l2_cache
);
186 g_free(s
->extents
[i
].l1_backup_table
);
191 static void vmdk_free_last_extent(BlockDriverState
*bs
)
193 BDRVVmdkState
*s
= bs
->opaque
;
195 if (s
->num_extents
== 0) {
199 s
->extents
= g_realloc(s
->extents
, s
->num_extents
* sizeof(VmdkExtent
));
202 static uint32_t vmdk_read_cid(BlockDriverState
*bs
, int parent
)
204 char desc
[DESC_SIZE
];
206 const char *p_name
, *cid_str
;
208 BDRVVmdkState
*s
= bs
->opaque
;
210 if (bdrv_pread(bs
->file
, s
->desc_offset
, desc
, DESC_SIZE
) != DESC_SIZE
) {
215 cid_str
= "parentCID";
216 cid_str_size
= sizeof("parentCID");
219 cid_str_size
= sizeof("CID");
222 p_name
= strstr(desc
, cid_str
);
223 if (p_name
!= NULL
) {
224 p_name
+= cid_str_size
;
225 sscanf(p_name
, "%x", &cid
);
231 static int vmdk_write_cid(BlockDriverState
*bs
, uint32_t cid
)
233 char desc
[DESC_SIZE
], tmp_desc
[DESC_SIZE
];
234 char *p_name
, *tmp_str
;
235 BDRVVmdkState
*s
= bs
->opaque
;
237 memset(desc
, 0, sizeof(desc
));
238 if (bdrv_pread(bs
->file
, s
->desc_offset
, desc
, DESC_SIZE
) != DESC_SIZE
) {
242 tmp_str
= strstr(desc
, "parentCID");
243 pstrcpy(tmp_desc
, sizeof(tmp_desc
), tmp_str
);
244 p_name
= strstr(desc
, "CID");
245 if (p_name
!= NULL
) {
246 p_name
+= sizeof("CID");
247 snprintf(p_name
, sizeof(desc
) - (p_name
- desc
), "%x\n", cid
);
248 pstrcat(desc
, sizeof(desc
), tmp_desc
);
251 if (bdrv_pwrite_sync(bs
->file
, s
->desc_offset
, desc
, DESC_SIZE
) < 0) {
257 static int vmdk_is_cid_valid(BlockDriverState
*bs
)
260 BDRVVmdkState
*s
= bs
->opaque
;
261 BlockDriverState
*p_bs
= bs
->backing_hd
;
265 cur_pcid
= vmdk_read_cid(p_bs
, 0);
266 if (s
->parent_cid
!= cur_pcid
) {
276 static int vmdk_parent_open(BlockDriverState
*bs
)
279 char desc
[DESC_SIZE
+ 1];
280 BDRVVmdkState
*s
= bs
->opaque
;
282 desc
[DESC_SIZE
] = '\0';
283 if (bdrv_pread(bs
->file
, s
->desc_offset
, desc
, DESC_SIZE
) != DESC_SIZE
) {
287 p_name
= strstr(desc
, "parentFileNameHint");
288 if (p_name
!= NULL
) {
291 p_name
+= sizeof("parentFileNameHint") + 1;
292 end_name
= strchr(p_name
, '\"');
293 if (end_name
== NULL
) {
296 if ((end_name
- p_name
) > sizeof(bs
->backing_file
) - 1) {
300 pstrcpy(bs
->backing_file
, end_name
- p_name
+ 1, p_name
);
306 /* Create and append extent to the extent array. Return the added VmdkExtent
307 * address. return NULL if allocation failed. */
308 static VmdkExtent
*vmdk_add_extent(BlockDriverState
*bs
,
309 BlockDriverState
*file
, bool flat
, int64_t sectors
,
310 int64_t l1_offset
, int64_t l1_backup_offset
,
312 int l2_size
, unsigned int cluster_sectors
)
315 BDRVVmdkState
*s
= bs
->opaque
;
317 s
->extents
= g_realloc(s
->extents
,
318 (s
->num_extents
+ 1) * sizeof(VmdkExtent
));
319 extent
= &s
->extents
[s
->num_extents
];
322 memset(extent
, 0, sizeof(VmdkExtent
));
325 extent
->sectors
= sectors
;
326 extent
->l1_table_offset
= l1_offset
;
327 extent
->l1_backup_table_offset
= l1_backup_offset
;
328 extent
->l1_size
= l1_size
;
329 extent
->l1_entry_sectors
= l2_size
* cluster_sectors
;
330 extent
->l2_size
= l2_size
;
331 extent
->cluster_sectors
= cluster_sectors
;
333 if (s
->num_extents
> 1) {
334 extent
->end_sector
= (*(extent
- 1)).end_sector
+ extent
->sectors
;
336 extent
->end_sector
= extent
->sectors
;
338 bs
->total_sectors
= extent
->end_sector
;
342 static int vmdk_init_tables(BlockDriverState
*bs
, VmdkExtent
*extent
)
347 /* read the L1 table */
348 l1_size
= extent
->l1_size
* sizeof(uint32_t);
349 extent
->l1_table
= g_malloc(l1_size
);
350 ret
= bdrv_pread(extent
->file
,
351 extent
->l1_table_offset
,
357 for (i
= 0; i
< extent
->l1_size
; i
++) {
358 le32_to_cpus(&extent
->l1_table
[i
]);
361 if (extent
->l1_backup_table_offset
) {
362 extent
->l1_backup_table
= g_malloc(l1_size
);
363 ret
= bdrv_pread(extent
->file
,
364 extent
->l1_backup_table_offset
,
365 extent
->l1_backup_table
,
370 for (i
= 0; i
< extent
->l1_size
; i
++) {
371 le32_to_cpus(&extent
->l1_backup_table
[i
]);
376 g_malloc(extent
->l2_size
* L2_CACHE_SIZE
* sizeof(uint32_t));
379 g_free(extent
->l1_backup_table
);
381 g_free(extent
->l1_table
);
385 static int vmdk_open_vmdk3(BlockDriverState
*bs
,
386 BlockDriverState
*file
,
394 ret
= bdrv_pread(file
, sizeof(magic
), &header
, sizeof(header
));
398 extent
= vmdk_add_extent(bs
,
400 le32_to_cpu(header
.disk_sectors
),
401 le32_to_cpu(header
.l1dir_offset
) << 9,
403 le32_to_cpu(header
.granularity
));
404 ret
= vmdk_init_tables(bs
, extent
);
406 /* free extent allocated by vmdk_add_extent */
407 vmdk_free_last_extent(bs
);
412 static int vmdk_open_desc_file(BlockDriverState
*bs
, int flags
,
413 int64_t desc_offset
);
415 static int vmdk_open_vmdk4(BlockDriverState
*bs
,
416 BlockDriverState
*file
,
421 uint32_t l1_size
, l1_entry_sectors
;
424 int64_t l1_backup_offset
= 0;
426 ret
= bdrv_pread(file
, sizeof(magic
), &header
, sizeof(header
));
430 if (header
.capacity
== 0 && header
.desc_offset
) {
431 return vmdk_open_desc_file(bs
, flags
, header
.desc_offset
<< 9);
433 l1_entry_sectors
= le32_to_cpu(header
.num_gtes_per_gte
)
434 * le64_to_cpu(header
.granularity
);
435 if (l1_entry_sectors
<= 0) {
438 l1_size
= (le64_to_cpu(header
.capacity
) + l1_entry_sectors
- 1)
440 if (le32_to_cpu(header
.flags
) & VMDK4_FLAG_RGD
) {
441 l1_backup_offset
= le64_to_cpu(header
.rgd_offset
) << 9;
443 extent
= vmdk_add_extent(bs
, file
, false,
444 le64_to_cpu(header
.capacity
),
445 le64_to_cpu(header
.gd_offset
) << 9,
448 le32_to_cpu(header
.num_gtes_per_gte
),
449 le64_to_cpu(header
.granularity
));
451 le16_to_cpu(header
.compressAlgorithm
) == VMDK4_COMPRESSION_DEFLATE
;
452 extent
->has_marker
= le32_to_cpu(header
.flags
) & VMDK4_FLAG_MARKER
;
453 ret
= vmdk_init_tables(bs
, extent
);
455 /* free extent allocated by vmdk_add_extent */
456 vmdk_free_last_extent(bs
);
461 /* find an option value out of descriptor file */
462 static int vmdk_parse_description(const char *desc
, const char *opt_name
,
463 char *buf
, int buf_size
)
465 char *opt_pos
, *opt_end
;
466 const char *end
= desc
+ strlen(desc
);
468 opt_pos
= strstr(desc
, opt_name
);
472 /* Skip "=\"" following opt_name */
473 opt_pos
+= strlen(opt_name
) + 2;
474 if (opt_pos
>= end
) {
478 while (opt_end
< end
&& *opt_end
!= '"') {
481 if (opt_end
== end
|| buf_size
< opt_end
- opt_pos
+ 1) {
484 pstrcpy(buf
, opt_end
- opt_pos
+ 1, opt_pos
);
488 /* Open an extent file and append to bs array */
489 static int vmdk_open_sparse(BlockDriverState
*bs
,
490 BlockDriverState
*file
,
495 if (bdrv_pread(file
, 0, &magic
, sizeof(magic
)) != sizeof(magic
)) {
499 magic
= be32_to_cpu(magic
);
502 return vmdk_open_vmdk3(bs
, file
, flags
);
505 return vmdk_open_vmdk4(bs
, file
, flags
);
513 static int vmdk_parse_extents(const char *desc
, BlockDriverState
*bs
,
514 const char *desc_file_path
)
520 const char *p
= desc
;
523 char extent_path
[PATH_MAX
];
524 BlockDriverState
*extent_file
;
527 /* parse extent line:
528 * RW [size in sectors] FLAT "file-name.vmdk" OFFSET
530 * RW [size in sectors] SPARSE "file-name.vmdk"
533 ret
= sscanf(p
, "%10s %" SCNd64
" %10s %511s %" SCNd64
,
534 access
, §ors
, type
, fname
, &flat_offset
);
535 if (ret
< 4 || strcmp(access
, "RW")) {
537 } else if (!strcmp(type
, "FLAT")) {
538 if (ret
!= 5 || flat_offset
< 0) {
541 } else if (ret
!= 4) {
545 /* trim the quotation marks around */
546 if (fname
[0] == '"') {
547 memmove(fname
, fname
+ 1, strlen(fname
));
548 if (strlen(fname
) <= 1 || fname
[strlen(fname
) - 1] != '"') {
551 fname
[strlen(fname
) - 1] = '\0';
554 (strcmp(type
, "FLAT") && strcmp(type
, "SPARSE")) ||
555 (strcmp(access
, "RW"))) {
559 path_combine(extent_path
, sizeof(extent_path
),
560 desc_file_path
, fname
);
561 ret
= bdrv_file_open(&extent_file
, extent_path
, bs
->open_flags
);
566 /* save to extents array */
567 if (!strcmp(type
, "FLAT")) {
571 extent
= vmdk_add_extent(bs
, extent_file
, true, sectors
,
572 0, 0, 0, 0, sectors
);
573 extent
->flat_start_offset
= flat_offset
<< 9;
574 } else if (!strcmp(type
, "SPARSE")) {
576 ret
= vmdk_open_sparse(bs
, extent_file
, bs
->open_flags
);
578 bdrv_delete(extent_file
);
583 "VMDK: Not supported extent type \"%s\""".\n", type
);
587 /* move to next line */
588 while (*p
&& *p
!= '\n') {
596 static int vmdk_open_desc_file(BlockDriverState
*bs
, int flags
,
602 BDRVVmdkState
*s
= bs
->opaque
;
604 ret
= bdrv_pread(bs
->file
, desc_offset
, buf
, sizeof(buf
));
609 if (vmdk_parse_description(buf
, "createType", ct
, sizeof(ct
))) {
612 if (strcmp(ct
, "monolithicFlat") &&
613 strcmp(ct
, "twoGbMaxExtentSparse") &&
614 strcmp(ct
, "twoGbMaxExtentFlat")) {
616 "VMDK: Not supported image type \"%s\""".\n", ct
);
620 ret
= vmdk_parse_extents(buf
, bs
, bs
->file
->filename
);
625 /* try to open parent images, if exist */
626 if (vmdk_parent_open(bs
)) {
630 s
->parent_cid
= vmdk_read_cid(bs
, 1);
634 static int vmdk_open(BlockDriverState
*bs
, int flags
)
637 BDRVVmdkState
*s
= bs
->opaque
;
639 if (vmdk_open_sparse(bs
, bs
->file
, flags
) == 0) {
640 s
->desc_offset
= 0x200;
641 /* try to open parent images, if exist */
642 ret
= vmdk_parent_open(bs
);
644 vmdk_free_extents(bs
);
647 s
->parent_cid
= vmdk_read_cid(bs
, 1);
650 return vmdk_open_desc_file(bs
, flags
, 0);
654 static int get_whole_cluster(BlockDriverState
*bs
,
656 uint64_t cluster_offset
,
660 /* 128 sectors * 512 bytes each = grain size 64KB */
661 uint8_t whole_grain
[extent
->cluster_sectors
* 512];
663 /* we will be here if it's first write on non-exist grain(cluster).
664 * try to read from parent image, if exist */
665 if (bs
->backing_hd
) {
668 if (!vmdk_is_cid_valid(bs
)) {
672 /* floor offset to cluster */
673 offset
-= offset
% (extent
->cluster_sectors
* 512);
674 ret
= bdrv_read(bs
->backing_hd
, offset
>> 9, whole_grain
,
675 extent
->cluster_sectors
);
680 /* Write grain only into the active image */
681 ret
= bdrv_write(extent
->file
, cluster_offset
, whole_grain
,
682 extent
->cluster_sectors
);
690 static int vmdk_L2update(VmdkExtent
*extent
, VmdkMetaData
*m_data
)
692 /* update L2 table */
693 if (bdrv_pwrite_sync(
695 ((int64_t)m_data
->l2_offset
* 512)
696 + (m_data
->l2_index
* sizeof(m_data
->offset
)),
698 sizeof(m_data
->offset
)
702 /* update backup L2 table */
703 if (extent
->l1_backup_table_offset
!= 0) {
704 m_data
->l2_offset
= extent
->l1_backup_table
[m_data
->l1_index
];
705 if (bdrv_pwrite_sync(
707 ((int64_t)m_data
->l2_offset
* 512)
708 + (m_data
->l2_index
* sizeof(m_data
->offset
)),
709 &(m_data
->offset
), sizeof(m_data
->offset
)
718 static int get_cluster_offset(BlockDriverState
*bs
,
720 VmdkMetaData
*m_data
,
723 uint64_t *cluster_offset
)
725 unsigned int l1_index
, l2_offset
, l2_index
;
727 uint32_t min_count
, *l2_table
, tmp
= 0;
733 *cluster_offset
= extent
->flat_start_offset
;
737 offset
-= (extent
->end_sector
- extent
->sectors
) * SECTOR_SIZE
;
738 l1_index
= (offset
>> 9) / extent
->l1_entry_sectors
;
739 if (l1_index
>= extent
->l1_size
) {
742 l2_offset
= extent
->l1_table
[l1_index
];
746 for (i
= 0; i
< L2_CACHE_SIZE
; i
++) {
747 if (l2_offset
== extent
->l2_cache_offsets
[i
]) {
748 /* increment the hit count */
749 if (++extent
->l2_cache_counts
[i
] == 0xffffffff) {
750 for (j
= 0; j
< L2_CACHE_SIZE
; j
++) {
751 extent
->l2_cache_counts
[j
] >>= 1;
754 l2_table
= extent
->l2_cache
+ (i
* extent
->l2_size
);
758 /* not found: load a new entry in the least used one */
760 min_count
= 0xffffffff;
761 for (i
= 0; i
< L2_CACHE_SIZE
; i
++) {
762 if (extent
->l2_cache_counts
[i
] < min_count
) {
763 min_count
= extent
->l2_cache_counts
[i
];
767 l2_table
= extent
->l2_cache
+ (min_index
* extent
->l2_size
);
770 (int64_t)l2_offset
* 512,
772 extent
->l2_size
* sizeof(uint32_t)
773 ) != extent
->l2_size
* sizeof(uint32_t)) {
777 extent
->l2_cache_offsets
[min_index
] = l2_offset
;
778 extent
->l2_cache_counts
[min_index
] = 1;
780 l2_index
= ((offset
>> 9) / extent
->cluster_sectors
) % extent
->l2_size
;
781 *cluster_offset
= le32_to_cpu(l2_table
[l2_index
]);
783 if (!*cluster_offset
) {
788 /* Avoid the L2 tables update for the images that have snapshots. */
789 *cluster_offset
= bdrv_getlength(extent
->file
);
790 if (!extent
->compressed
) {
793 *cluster_offset
+ (extent
->cluster_sectors
<< 9)
797 *cluster_offset
>>= 9;
798 tmp
= cpu_to_le32(*cluster_offset
);
799 l2_table
[l2_index
] = tmp
;
801 /* First of all we write grain itself, to avoid race condition
802 * that may to corrupt the image.
803 * This problem may occur because of insufficient space on host disk
804 * or inappropriate VM shutdown.
806 if (get_whole_cluster(
807 bs
, extent
, *cluster_offset
, offset
, allocate
) == -1) {
812 m_data
->offset
= tmp
;
813 m_data
->l1_index
= l1_index
;
814 m_data
->l2_index
= l2_index
;
815 m_data
->l2_offset
= l2_offset
;
819 *cluster_offset
<<= 9;
823 static VmdkExtent
*find_extent(BDRVVmdkState
*s
,
824 int64_t sector_num
, VmdkExtent
*start_hint
)
826 VmdkExtent
*extent
= start_hint
;
829 extent
= &s
->extents
[0];
831 while (extent
< &s
->extents
[s
->num_extents
]) {
832 if (sector_num
< extent
->end_sector
) {
840 static int vmdk_is_allocated(BlockDriverState
*bs
, int64_t sector_num
,
841 int nb_sectors
, int *pnum
)
843 BDRVVmdkState
*s
= bs
->opaque
;
844 int64_t index_in_cluster
, n
, ret
;
848 extent
= find_extent(s
, sector_num
, NULL
);
852 ret
= get_cluster_offset(bs
, extent
, NULL
,
853 sector_num
* 512, 0, &offset
);
854 /* get_cluster_offset returning 0 means success */
857 index_in_cluster
= sector_num
% extent
->cluster_sectors
;
858 n
= extent
->cluster_sectors
- index_in_cluster
;
859 if (n
> nb_sectors
) {
866 static int vmdk_write_extent(VmdkExtent
*extent
, int64_t cluster_offset
,
867 int64_t offset_in_cluster
, const uint8_t *buf
,
868 int nb_sectors
, int64_t sector_num
)
871 VmdkGrainMarker
*data
= NULL
;
873 const uint8_t *write_buf
= buf
;
874 int write_len
= nb_sectors
* 512;
876 if (extent
->compressed
) {
877 if (!extent
->has_marker
) {
881 buf_len
= (extent
->cluster_sectors
<< 9) * 2;
882 data
= g_malloc(buf_len
+ sizeof(VmdkGrainMarker
));
883 if (compress(data
->data
, &buf_len
, buf
, nb_sectors
<< 9) != Z_OK
||
888 data
->lba
= sector_num
;
889 data
->size
= buf_len
;
890 write_buf
= (uint8_t *)data
;
891 write_len
= buf_len
+ sizeof(VmdkGrainMarker
);
893 ret
= bdrv_pwrite(extent
->file
,
894 cluster_offset
+ offset_in_cluster
,
897 if (ret
!= write_len
) {
898 ret
= ret
< 0 ? ret
: -EIO
;
907 static int vmdk_read_extent(VmdkExtent
*extent
, int64_t cluster_offset
,
908 int64_t offset_in_cluster
, uint8_t *buf
,
912 int cluster_bytes
, buf_bytes
;
913 uint8_t *cluster_buf
, *compressed_data
;
916 VmdkGrainMarker
*marker
;
920 if (!extent
->compressed
) {
921 ret
= bdrv_pread(extent
->file
,
922 cluster_offset
+ offset_in_cluster
,
923 buf
, nb_sectors
* 512);
924 if (ret
== nb_sectors
* 512) {
930 cluster_bytes
= extent
->cluster_sectors
* 512;
931 /* Read two clusters in case GrainMarker + compressed data > one cluster */
932 buf_bytes
= cluster_bytes
* 2;
933 cluster_buf
= g_malloc(buf_bytes
);
934 uncomp_buf
= g_malloc(cluster_bytes
);
935 ret
= bdrv_pread(extent
->file
,
937 cluster_buf
, buf_bytes
);
941 compressed_data
= cluster_buf
;
942 buf_len
= cluster_bytes
;
943 data_len
= cluster_bytes
;
944 if (extent
->has_marker
) {
945 marker
= (VmdkGrainMarker
*)cluster_buf
;
946 compressed_data
= marker
->data
;
947 data_len
= le32_to_cpu(marker
->size
);
949 if (!data_len
|| data_len
> buf_bytes
) {
953 ret
= uncompress(uncomp_buf
, &buf_len
, compressed_data
, data_len
);
959 if (offset_in_cluster
< 0 ||
960 offset_in_cluster
+ nb_sectors
* 512 > buf_len
) {
964 memcpy(buf
, uncomp_buf
+ offset_in_cluster
, nb_sectors
* 512);
973 static int vmdk_read(BlockDriverState
*bs
, int64_t sector_num
,
974 uint8_t *buf
, int nb_sectors
)
976 BDRVVmdkState
*s
= bs
->opaque
;
978 uint64_t n
, index_in_cluster
;
979 VmdkExtent
*extent
= NULL
;
980 uint64_t cluster_offset
;
982 while (nb_sectors
> 0) {
983 extent
= find_extent(s
, sector_num
, extent
);
987 ret
= get_cluster_offset(
989 sector_num
<< 9, 0, &cluster_offset
);
990 index_in_cluster
= sector_num
% extent
->cluster_sectors
;
991 n
= extent
->cluster_sectors
- index_in_cluster
;
992 if (n
> nb_sectors
) {
996 /* if not allocated, try to read from parent image, if exist */
997 if (bs
->backing_hd
) {
998 if (!vmdk_is_cid_valid(bs
)) {
1001 ret
= bdrv_read(bs
->backing_hd
, sector_num
, buf
, n
);
1006 memset(buf
, 0, 512 * n
);
1009 ret
= vmdk_read_extent(extent
,
1010 cluster_offset
, index_in_cluster
* 512,
1023 static int vmdk_write(BlockDriverState
*bs
, int64_t sector_num
,
1024 const uint8_t *buf
, int nb_sectors
)
1026 BDRVVmdkState
*s
= bs
->opaque
;
1027 VmdkExtent
*extent
= NULL
;
1029 int64_t index_in_cluster
;
1030 uint64_t cluster_offset
;
1031 VmdkMetaData m_data
;
1033 if (sector_num
> bs
->total_sectors
) {
1035 "(VMDK) Wrong offset: sector_num=0x%" PRIx64
1036 " total_sectors=0x%" PRIx64
"\n",
1037 sector_num
, bs
->total_sectors
);
1041 while (nb_sectors
> 0) {
1042 extent
= find_extent(s
, sector_num
, extent
);
1046 ret
= get_cluster_offset(
1050 sector_num
<< 9, !extent
->compressed
,
1052 if (extent
->compressed
) {
1054 /* Refuse write to allocated cluster for streamOptimized */
1056 "VMDK: can't write to allocated cluster"
1057 " for streamOptimized\n");
1061 ret
= get_cluster_offset(
1072 index_in_cluster
= sector_num
% extent
->cluster_sectors
;
1073 n
= extent
->cluster_sectors
- index_in_cluster
;
1074 if (n
> nb_sectors
) {
1078 ret
= vmdk_write_extent(extent
,
1079 cluster_offset
, index_in_cluster
* 512,
1080 buf
, n
, sector_num
);
1085 /* update L2 tables */
1086 if (vmdk_L2update(extent
, &m_data
) == -1) {
1094 /* update CID on the first write every time the virtual disk is
1096 if (!s
->cid_updated
) {
1097 vmdk_write_cid(bs
, time(NULL
));
1098 s
->cid_updated
= true;
1105 static int vmdk_create_extent(const char *filename
, int64_t filesize
,
1106 bool flat
, bool compress
)
1111 uint32_t tmp
, magic
, grains
, gd_size
, gt_size
, gt_count
;
1115 O_WRONLY
| O_CREAT
| O_TRUNC
| O_BINARY
| O_LARGEFILE
,
1121 ret
= ftruncate(fd
, filesize
);
1127 magic
= cpu_to_be32(VMDK4_MAGIC
);
1128 memset(&header
, 0, sizeof(header
));
1131 3 | (compress
? VMDK4_FLAG_COMPRESS
| VMDK4_FLAG_MARKER
: 0);
1132 header
.compressAlgorithm
= compress
? VMDK4_COMPRESSION_DEFLATE
: 0;
1133 header
.capacity
= filesize
/ 512;
1134 header
.granularity
= 128;
1135 header
.num_gtes_per_gte
= 512;
1137 grains
= (filesize
/ 512 + header
.granularity
- 1) / header
.granularity
;
1138 gt_size
= ((header
.num_gtes_per_gte
* sizeof(uint32_t)) + 511) >> 9;
1140 (grains
+ header
.num_gtes_per_gte
- 1) / header
.num_gtes_per_gte
;
1141 gd_size
= (gt_count
* sizeof(uint32_t) + 511) >> 9;
1143 header
.desc_offset
= 1;
1144 header
.desc_size
= 20;
1145 header
.rgd_offset
= header
.desc_offset
+ header
.desc_size
;
1146 header
.gd_offset
= header
.rgd_offset
+ gd_size
+ (gt_size
* gt_count
);
1147 header
.grain_offset
=
1148 ((header
.gd_offset
+ gd_size
+ (gt_size
* gt_count
) +
1149 header
.granularity
- 1) / header
.granularity
) *
1151 /* swap endianness for all header fields */
1152 header
.version
= cpu_to_le32(header
.version
);
1153 header
.flags
= cpu_to_le32(header
.flags
);
1154 header
.capacity
= cpu_to_le64(header
.capacity
);
1155 header
.granularity
= cpu_to_le64(header
.granularity
);
1156 header
.num_gtes_per_gte
= cpu_to_le32(header
.num_gtes_per_gte
);
1157 header
.desc_offset
= cpu_to_le64(header
.desc_offset
);
1158 header
.desc_size
= cpu_to_le64(header
.desc_size
);
1159 header
.rgd_offset
= cpu_to_le64(header
.rgd_offset
);
1160 header
.gd_offset
= cpu_to_le64(header
.gd_offset
);
1161 header
.grain_offset
= cpu_to_le64(header
.grain_offset
);
1162 header
.compressAlgorithm
= cpu_to_le16(header
.compressAlgorithm
);
1164 header
.check_bytes
[0] = 0xa;
1165 header
.check_bytes
[1] = 0x20;
1166 header
.check_bytes
[2] = 0xd;
1167 header
.check_bytes
[3] = 0xa;
1169 /* write all the data */
1170 ret
= qemu_write_full(fd
, &magic
, sizeof(magic
));
1171 if (ret
!= sizeof(magic
)) {
1175 ret
= qemu_write_full(fd
, &header
, sizeof(header
));
1176 if (ret
!= sizeof(header
)) {
1181 ret
= ftruncate(fd
, le64_to_cpu(header
.grain_offset
) << 9);
1187 /* write grain directory */
1188 lseek(fd
, le64_to_cpu(header
.rgd_offset
) << 9, SEEK_SET
);
1189 for (i
= 0, tmp
= le64_to_cpu(header
.rgd_offset
) + gd_size
;
1190 i
< gt_count
; i
++, tmp
+= gt_size
) {
1191 ret
= qemu_write_full(fd
, &tmp
, sizeof(tmp
));
1192 if (ret
!= sizeof(tmp
)) {
1198 /* write backup grain directory */
1199 lseek(fd
, le64_to_cpu(header
.gd_offset
) << 9, SEEK_SET
);
1200 for (i
= 0, tmp
= le64_to_cpu(header
.gd_offset
) + gd_size
;
1201 i
< gt_count
; i
++, tmp
+= gt_size
) {
1202 ret
= qemu_write_full(fd
, &tmp
, sizeof(tmp
));
1203 if (ret
!= sizeof(tmp
)) {
1215 static int filename_decompose(const char *filename
, char *path
, char *prefix
,
1216 char *postfix
, size_t buf_len
)
1220 if (filename
== NULL
|| !strlen(filename
)) {
1221 fprintf(stderr
, "Vmdk: no filename provided.\n");
1224 p
= strrchr(filename
, '/');
1226 p
= strrchr(filename
, '\\');
1229 p
= strrchr(filename
, ':');
1233 if (p
- filename
>= buf_len
) {
1236 pstrcpy(path
, p
- filename
+ 1, filename
);
1241 q
= strrchr(p
, '.');
1243 pstrcpy(prefix
, buf_len
, p
);
1246 if (q
- p
>= buf_len
) {
1249 pstrcpy(prefix
, q
- p
+ 1, p
);
1250 pstrcpy(postfix
, buf_len
, q
);
1255 static int relative_path(char *dest
, int dest_size
,
1256 const char *base
, const char *target
)
1262 const char *sep
= "\\";
1264 const char *sep
= "/";
1267 if (!(dest
&& base
&& target
)) {
1270 if (path_is_absolute(target
)) {
1271 dest
[dest_size
- 1] = '\0';
1272 strncpy(dest
, target
, dest_size
- 1);
1275 while (base
[i
] == target
[i
]) {
1288 pstrcat(dest
, dest_size
, "..");
1289 pstrcat(dest
, dest_size
, sep
);
1291 pstrcat(dest
, dest_size
, q
);
1295 static int vmdk_create(const char *filename
, QEMUOptionParameter
*options
)
1298 char desc
[BUF_SIZE
];
1299 int64_t total_size
= 0, filesize
;
1300 const char *backing_file
= NULL
;
1301 const char *fmt
= NULL
;
1304 bool flat
, split
, compress
;
1305 char ext_desc_lines
[BUF_SIZE
] = "";
1306 char path
[PATH_MAX
], prefix
[PATH_MAX
], postfix
[PATH_MAX
];
1307 const int64_t split_size
= 0x80000000; /* VMDK has constant split size */
1308 const char *desc_extent_line
;
1309 char parent_desc_line
[BUF_SIZE
] = "";
1310 uint32_t parent_cid
= 0xffffffff;
1311 const char desc_template
[] =
1312 "# Disk DescriptorFile\n"
1316 "createType=\"%s\"\n"
1319 "# Extent description\n"
1322 "# The Disk Data Base\n"
1325 "ddb.virtualHWVersion = \"%d\"\n"
1326 "ddb.geometry.cylinders = \"%" PRId64
"\"\n"
1327 "ddb.geometry.heads = \"16\"\n"
1328 "ddb.geometry.sectors = \"63\"\n"
1329 "ddb.adapterType = \"ide\"\n";
1331 if (filename_decompose(filename
, path
, prefix
, postfix
, PATH_MAX
)) {
1334 /* Read out options */
1335 while (options
&& options
->name
) {
1336 if (!strcmp(options
->name
, BLOCK_OPT_SIZE
)) {
1337 total_size
= options
->value
.n
;
1338 } else if (!strcmp(options
->name
, BLOCK_OPT_BACKING_FILE
)) {
1339 backing_file
= options
->value
.s
;
1340 } else if (!strcmp(options
->name
, BLOCK_OPT_COMPAT6
)) {
1341 flags
|= options
->value
.n
? BLOCK_FLAG_COMPAT6
: 0;
1342 } else if (!strcmp(options
->name
, BLOCK_OPT_SUBFMT
)) {
1343 fmt
= options
->value
.s
;
1348 /* Default format to monolithicSparse */
1349 fmt
= "monolithicSparse";
1350 } else if (strcmp(fmt
, "monolithicFlat") &&
1351 strcmp(fmt
, "monolithicSparse") &&
1352 strcmp(fmt
, "twoGbMaxExtentSparse") &&
1353 strcmp(fmt
, "twoGbMaxExtentFlat") &&
1354 strcmp(fmt
, "streamOptimized")) {
1355 fprintf(stderr
, "VMDK: Unknown subformat: %s\n", fmt
);
1358 split
= !(strcmp(fmt
, "twoGbMaxExtentFlat") &&
1359 strcmp(fmt
, "twoGbMaxExtentSparse"));
1360 flat
= !(strcmp(fmt
, "monolithicFlat") &&
1361 strcmp(fmt
, "twoGbMaxExtentFlat"));
1362 compress
= !strcmp(fmt
, "streamOptimized");
1364 desc_extent_line
= "RW %lld FLAT \"%s\" 0\n";
1366 desc_extent_line
= "RW %lld SPARSE \"%s\"\n";
1368 if (flat
&& backing_file
) {
1369 /* not supporting backing file for flat image */
1373 char parent_filename
[PATH_MAX
];
1374 BlockDriverState
*bs
= bdrv_new("");
1375 ret
= bdrv_open(bs
, backing_file
, 0, NULL
);
1380 if (strcmp(bs
->drv
->format_name
, "vmdk")) {
1384 filesize
= bdrv_getlength(bs
);
1385 parent_cid
= vmdk_read_cid(bs
, 0);
1387 relative_path(parent_filename
, sizeof(parent_filename
),
1388 filename
, backing_file
);
1389 snprintf(parent_desc_line
, sizeof(parent_desc_line
),
1390 "parentFileNameHint=\"%s\"", parent_filename
);
1393 /* Create extents */
1394 filesize
= total_size
;
1395 while (filesize
> 0) {
1396 char desc_line
[BUF_SIZE
];
1397 char ext_filename
[PATH_MAX
];
1398 char desc_filename
[PATH_MAX
];
1399 int64_t size
= filesize
;
1401 if (split
&& size
> split_size
) {
1405 snprintf(desc_filename
, sizeof(desc_filename
), "%s-%c%03d%s",
1406 prefix
, flat
? 'f' : 's', ++idx
, postfix
);
1408 snprintf(desc_filename
, sizeof(desc_filename
), "%s-flat%s",
1411 snprintf(desc_filename
, sizeof(desc_filename
), "%s%s",
1414 snprintf(ext_filename
, sizeof(ext_filename
), "%s%s",
1415 path
, desc_filename
);
1417 if (vmdk_create_extent(ext_filename
, size
, flat
, compress
)) {
1422 /* Format description line */
1423 snprintf(desc_line
, sizeof(desc_line
),
1424 desc_extent_line
, size
/ 512, desc_filename
);
1425 pstrcat(ext_desc_lines
, sizeof(ext_desc_lines
), desc_line
);
1427 /* generate descriptor file */
1428 snprintf(desc
, sizeof(desc
), desc_template
,
1429 (unsigned int)time(NULL
),
1434 (flags
& BLOCK_FLAG_COMPAT6
? 6 : 4),
1435 total_size
/ (int64_t)(63 * 16 * 512));
1436 if (split
|| flat
) {
1439 O_WRONLY
| O_CREAT
| O_TRUNC
| O_BINARY
| O_LARGEFILE
,
1444 O_WRONLY
| O_BINARY
| O_LARGEFILE
,
1450 /* the descriptor offset = 0x200 */
1451 if (!split
&& !flat
&& 0x200 != lseek(fd
, 0x200, SEEK_SET
)) {
1455 ret
= qemu_write_full(fd
, desc
, strlen(desc
));
1456 if (ret
!= strlen(desc
)) {
1466 static void vmdk_close(BlockDriverState
*bs
)
1468 vmdk_free_extents(bs
);
1471 static int vmdk_flush(BlockDriverState
*bs
)
1474 BDRVVmdkState
*s
= bs
->opaque
;
1476 ret
= bdrv_flush(bs
->file
);
1477 for (i
= 0; i
< s
->num_extents
; i
++) {
1478 err
= bdrv_flush(s
->extents
[i
].file
);
1486 static int64_t vmdk_get_allocated_file_size(BlockDriverState
*bs
)
1491 BDRVVmdkState
*s
= bs
->opaque
;
1493 ret
= bdrv_get_allocated_file_size(bs
->file
);
1497 for (i
= 0; i
< s
->num_extents
; i
++) {
1498 if (s
->extents
[i
].file
== bs
->file
) {
1501 r
= bdrv_get_allocated_file_size(s
->extents
[i
].file
);
1510 static QEMUOptionParameter vmdk_create_options
[] = {
1512 .name
= BLOCK_OPT_SIZE
,
1514 .help
= "Virtual disk size"
1517 .name
= BLOCK_OPT_BACKING_FILE
,
1519 .help
= "File name of a base image"
1522 .name
= BLOCK_OPT_COMPAT6
,
1524 .help
= "VMDK version 6 image"
1527 .name
= BLOCK_OPT_SUBFMT
,
1530 "VMDK flat extent format, can be one of "
1531 "{monolithicSparse (default) | monolithicFlat | twoGbMaxExtentSparse | twoGbMaxExtentFlat | streamOptimized} "
1536 static BlockDriver bdrv_vmdk
= {
1537 .format_name
= "vmdk",
1538 .instance_size
= sizeof(BDRVVmdkState
),
1539 .bdrv_probe
= vmdk_probe
,
1540 .bdrv_open
= vmdk_open
,
1541 .bdrv_read
= vmdk_read
,
1542 .bdrv_write
= vmdk_write
,
1543 .bdrv_close
= vmdk_close
,
1544 .bdrv_create
= vmdk_create
,
1545 .bdrv_flush
= vmdk_flush
,
1546 .bdrv_is_allocated
= vmdk_is_allocated
,
1547 .bdrv_get_allocated_file_size
= vmdk_get_allocated_file_size
,
1549 .create_options
= vmdk_create_options
,
1552 static void bdrv_vmdk_init(void)
1554 bdrv_register(&bdrv_vmdk
);
1557 block_init(bdrv_vmdk_init
);