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
;
184 for (i
= 0; i
< s
->num_extents
; i
++) {
188 g_free(e
->l1_backup_table
);
189 if (e
->file
!= bs
->file
) {
190 bdrv_delete(e
->file
);
196 static void vmdk_free_last_extent(BlockDriverState
*bs
)
198 BDRVVmdkState
*s
= bs
->opaque
;
200 if (s
->num_extents
== 0) {
204 s
->extents
= g_realloc(s
->extents
, s
->num_extents
* sizeof(VmdkExtent
));
207 static uint32_t vmdk_read_cid(BlockDriverState
*bs
, int parent
)
209 char desc
[DESC_SIZE
];
211 const char *p_name
, *cid_str
;
213 BDRVVmdkState
*s
= bs
->opaque
;
215 if (bdrv_pread(bs
->file
, s
->desc_offset
, desc
, DESC_SIZE
) != DESC_SIZE
) {
220 cid_str
= "parentCID";
221 cid_str_size
= sizeof("parentCID");
224 cid_str_size
= sizeof("CID");
227 p_name
= strstr(desc
, cid_str
);
228 if (p_name
!= NULL
) {
229 p_name
+= cid_str_size
;
230 sscanf(p_name
, "%x", &cid
);
236 static int vmdk_write_cid(BlockDriverState
*bs
, uint32_t cid
)
238 char desc
[DESC_SIZE
], tmp_desc
[DESC_SIZE
];
239 char *p_name
, *tmp_str
;
240 BDRVVmdkState
*s
= bs
->opaque
;
242 memset(desc
, 0, sizeof(desc
));
243 if (bdrv_pread(bs
->file
, s
->desc_offset
, desc
, DESC_SIZE
) != DESC_SIZE
) {
247 tmp_str
= strstr(desc
, "parentCID");
248 pstrcpy(tmp_desc
, sizeof(tmp_desc
), tmp_str
);
249 p_name
= strstr(desc
, "CID");
250 if (p_name
!= NULL
) {
251 p_name
+= sizeof("CID");
252 snprintf(p_name
, sizeof(desc
) - (p_name
- desc
), "%x\n", cid
);
253 pstrcat(desc
, sizeof(desc
), tmp_desc
);
256 if (bdrv_pwrite_sync(bs
->file
, s
->desc_offset
, desc
, DESC_SIZE
) < 0) {
262 static int vmdk_is_cid_valid(BlockDriverState
*bs
)
265 BDRVVmdkState
*s
= bs
->opaque
;
266 BlockDriverState
*p_bs
= bs
->backing_hd
;
270 cur_pcid
= vmdk_read_cid(p_bs
, 0);
271 if (s
->parent_cid
!= cur_pcid
) {
281 static int vmdk_parent_open(BlockDriverState
*bs
)
284 char desc
[DESC_SIZE
+ 1];
285 BDRVVmdkState
*s
= bs
->opaque
;
288 desc
[DESC_SIZE
] = '\0';
289 ret
= bdrv_pread(bs
->file
, s
->desc_offset
, desc
, DESC_SIZE
);
294 p_name
= strstr(desc
, "parentFileNameHint");
295 if (p_name
!= NULL
) {
298 p_name
+= sizeof("parentFileNameHint") + 1;
299 end_name
= strchr(p_name
, '\"');
300 if (end_name
== NULL
) {
303 if ((end_name
- p_name
) > sizeof(bs
->backing_file
) - 1) {
307 pstrcpy(bs
->backing_file
, end_name
- p_name
+ 1, p_name
);
313 /* Create and append extent to the extent array. Return the added VmdkExtent
314 * address. return NULL if allocation failed. */
315 static VmdkExtent
*vmdk_add_extent(BlockDriverState
*bs
,
316 BlockDriverState
*file
, bool flat
, int64_t sectors
,
317 int64_t l1_offset
, int64_t l1_backup_offset
,
319 int l2_size
, unsigned int cluster_sectors
)
322 BDRVVmdkState
*s
= bs
->opaque
;
324 s
->extents
= g_realloc(s
->extents
,
325 (s
->num_extents
+ 1) * sizeof(VmdkExtent
));
326 extent
= &s
->extents
[s
->num_extents
];
329 memset(extent
, 0, sizeof(VmdkExtent
));
332 extent
->sectors
= sectors
;
333 extent
->l1_table_offset
= l1_offset
;
334 extent
->l1_backup_table_offset
= l1_backup_offset
;
335 extent
->l1_size
= l1_size
;
336 extent
->l1_entry_sectors
= l2_size
* cluster_sectors
;
337 extent
->l2_size
= l2_size
;
338 extent
->cluster_sectors
= cluster_sectors
;
340 if (s
->num_extents
> 1) {
341 extent
->end_sector
= (*(extent
- 1)).end_sector
+ extent
->sectors
;
343 extent
->end_sector
= extent
->sectors
;
345 bs
->total_sectors
= extent
->end_sector
;
349 static int vmdk_init_tables(BlockDriverState
*bs
, VmdkExtent
*extent
)
354 /* read the L1 table */
355 l1_size
= extent
->l1_size
* sizeof(uint32_t);
356 extent
->l1_table
= g_malloc(l1_size
);
357 ret
= bdrv_pread(extent
->file
,
358 extent
->l1_table_offset
,
364 for (i
= 0; i
< extent
->l1_size
; i
++) {
365 le32_to_cpus(&extent
->l1_table
[i
]);
368 if (extent
->l1_backup_table_offset
) {
369 extent
->l1_backup_table
= g_malloc(l1_size
);
370 ret
= bdrv_pread(extent
->file
,
371 extent
->l1_backup_table_offset
,
372 extent
->l1_backup_table
,
377 for (i
= 0; i
< extent
->l1_size
; i
++) {
378 le32_to_cpus(&extent
->l1_backup_table
[i
]);
383 g_malloc(extent
->l2_size
* L2_CACHE_SIZE
* sizeof(uint32_t));
386 g_free(extent
->l1_backup_table
);
388 g_free(extent
->l1_table
);
392 static int vmdk_open_vmdk3(BlockDriverState
*bs
,
393 BlockDriverState
*file
,
401 ret
= bdrv_pread(file
, sizeof(magic
), &header
, sizeof(header
));
405 extent
= vmdk_add_extent(bs
,
407 le32_to_cpu(header
.disk_sectors
),
408 le32_to_cpu(header
.l1dir_offset
) << 9,
410 le32_to_cpu(header
.granularity
));
411 ret
= vmdk_init_tables(bs
, extent
);
413 /* free extent allocated by vmdk_add_extent */
414 vmdk_free_last_extent(bs
);
419 static int vmdk_open_desc_file(BlockDriverState
*bs
, int flags
,
420 int64_t desc_offset
);
422 static int vmdk_open_vmdk4(BlockDriverState
*bs
,
423 BlockDriverState
*file
,
428 uint32_t l1_size
, l1_entry_sectors
;
431 int64_t l1_backup_offset
= 0;
433 ret
= bdrv_pread(file
, sizeof(magic
), &header
, sizeof(header
));
437 if (header
.capacity
== 0 && header
.desc_offset
) {
438 return vmdk_open_desc_file(bs
, flags
, header
.desc_offset
<< 9);
440 l1_entry_sectors
= le32_to_cpu(header
.num_gtes_per_gte
)
441 * le64_to_cpu(header
.granularity
);
442 if (l1_entry_sectors
<= 0) {
445 l1_size
= (le64_to_cpu(header
.capacity
) + l1_entry_sectors
- 1)
447 if (le32_to_cpu(header
.flags
) & VMDK4_FLAG_RGD
) {
448 l1_backup_offset
= le64_to_cpu(header
.rgd_offset
) << 9;
450 extent
= vmdk_add_extent(bs
, file
, false,
451 le64_to_cpu(header
.capacity
),
452 le64_to_cpu(header
.gd_offset
) << 9,
455 le32_to_cpu(header
.num_gtes_per_gte
),
456 le64_to_cpu(header
.granularity
));
458 le16_to_cpu(header
.compressAlgorithm
) == VMDK4_COMPRESSION_DEFLATE
;
459 extent
->has_marker
= le32_to_cpu(header
.flags
) & VMDK4_FLAG_MARKER
;
460 ret
= vmdk_init_tables(bs
, extent
);
462 /* free extent allocated by vmdk_add_extent */
463 vmdk_free_last_extent(bs
);
468 /* find an option value out of descriptor file */
469 static int vmdk_parse_description(const char *desc
, const char *opt_name
,
470 char *buf
, int buf_size
)
472 char *opt_pos
, *opt_end
;
473 const char *end
= desc
+ strlen(desc
);
475 opt_pos
= strstr(desc
, opt_name
);
479 /* Skip "=\"" following opt_name */
480 opt_pos
+= strlen(opt_name
) + 2;
481 if (opt_pos
>= end
) {
485 while (opt_end
< end
&& *opt_end
!= '"') {
488 if (opt_end
== end
|| buf_size
< opt_end
- opt_pos
+ 1) {
491 pstrcpy(buf
, opt_end
- opt_pos
+ 1, opt_pos
);
495 /* Open an extent file and append to bs array */
496 static int vmdk_open_sparse(BlockDriverState
*bs
,
497 BlockDriverState
*file
,
502 if (bdrv_pread(file
, 0, &magic
, sizeof(magic
)) != sizeof(magic
)) {
506 magic
= be32_to_cpu(magic
);
509 return vmdk_open_vmdk3(bs
, file
, flags
);
512 return vmdk_open_vmdk4(bs
, file
, flags
);
520 static int vmdk_parse_extents(const char *desc
, BlockDriverState
*bs
,
521 const char *desc_file_path
)
527 const char *p
= desc
;
530 char extent_path
[PATH_MAX
];
531 BlockDriverState
*extent_file
;
534 /* parse extent line:
535 * RW [size in sectors] FLAT "file-name.vmdk" OFFSET
537 * RW [size in sectors] SPARSE "file-name.vmdk"
540 ret
= sscanf(p
, "%10s %" SCNd64
" %10s %511s %" SCNd64
,
541 access
, §ors
, type
, fname
, &flat_offset
);
542 if (ret
< 4 || strcmp(access
, "RW")) {
544 } else if (!strcmp(type
, "FLAT")) {
545 if (ret
!= 5 || flat_offset
< 0) {
548 } else if (ret
!= 4) {
552 /* trim the quotation marks around */
553 if (fname
[0] == '"') {
554 memmove(fname
, fname
+ 1, strlen(fname
));
555 if (strlen(fname
) <= 1 || fname
[strlen(fname
) - 1] != '"') {
558 fname
[strlen(fname
) - 1] = '\0';
561 (strcmp(type
, "FLAT") && strcmp(type
, "SPARSE")) ||
562 (strcmp(access
, "RW"))) {
566 path_combine(extent_path
, sizeof(extent_path
),
567 desc_file_path
, fname
);
568 ret
= bdrv_file_open(&extent_file
, extent_path
, bs
->open_flags
);
573 /* save to extents array */
574 if (!strcmp(type
, "FLAT")) {
578 extent
= vmdk_add_extent(bs
, extent_file
, true, sectors
,
579 0, 0, 0, 0, sectors
);
580 extent
->flat_start_offset
= flat_offset
<< 9;
581 } else if (!strcmp(type
, "SPARSE")) {
583 ret
= vmdk_open_sparse(bs
, extent_file
, bs
->open_flags
);
585 bdrv_delete(extent_file
);
590 "VMDK: Not supported extent type \"%s\""".\n", type
);
594 /* move to next line */
595 while (*p
&& *p
!= '\n') {
603 static int vmdk_open_desc_file(BlockDriverState
*bs
, int flags
,
609 BDRVVmdkState
*s
= bs
->opaque
;
611 ret
= bdrv_pread(bs
->file
, desc_offset
, buf
, sizeof(buf
));
616 if (vmdk_parse_description(buf
, "createType", ct
, sizeof(ct
))) {
619 if (strcmp(ct
, "monolithicFlat") &&
620 strcmp(ct
, "twoGbMaxExtentSparse") &&
621 strcmp(ct
, "twoGbMaxExtentFlat")) {
623 "VMDK: Not supported image type \"%s\""".\n", ct
);
627 ret
= vmdk_parse_extents(buf
, bs
, bs
->file
->filename
);
629 vmdk_free_extents(bs
);
633 /* try to open parent images, if exist */
634 ret
= vmdk_parent_open(bs
);
636 vmdk_free_extents(bs
);
639 s
->parent_cid
= vmdk_read_cid(bs
, 1);
643 static int vmdk_open(BlockDriverState
*bs
, int flags
)
646 BDRVVmdkState
*s
= bs
->opaque
;
648 if (vmdk_open_sparse(bs
, bs
->file
, flags
) == 0) {
649 s
->desc_offset
= 0x200;
650 /* try to open parent images, if exist */
651 ret
= vmdk_parent_open(bs
);
653 vmdk_free_extents(bs
);
656 s
->parent_cid
= vmdk_read_cid(bs
, 1);
659 return vmdk_open_desc_file(bs
, flags
, 0);
663 static int get_whole_cluster(BlockDriverState
*bs
,
665 uint64_t cluster_offset
,
669 /* 128 sectors * 512 bytes each = grain size 64KB */
670 uint8_t whole_grain
[extent
->cluster_sectors
* 512];
672 /* we will be here if it's first write on non-exist grain(cluster).
673 * try to read from parent image, if exist */
674 if (bs
->backing_hd
) {
677 if (!vmdk_is_cid_valid(bs
)) {
681 /* floor offset to cluster */
682 offset
-= offset
% (extent
->cluster_sectors
* 512);
683 ret
= bdrv_read(bs
->backing_hd
, offset
>> 9, whole_grain
,
684 extent
->cluster_sectors
);
689 /* Write grain only into the active image */
690 ret
= bdrv_write(extent
->file
, cluster_offset
, whole_grain
,
691 extent
->cluster_sectors
);
699 static int vmdk_L2update(VmdkExtent
*extent
, VmdkMetaData
*m_data
)
701 /* update L2 table */
702 if (bdrv_pwrite_sync(
704 ((int64_t)m_data
->l2_offset
* 512)
705 + (m_data
->l2_index
* sizeof(m_data
->offset
)),
707 sizeof(m_data
->offset
)
711 /* update backup L2 table */
712 if (extent
->l1_backup_table_offset
!= 0) {
713 m_data
->l2_offset
= extent
->l1_backup_table
[m_data
->l1_index
];
714 if (bdrv_pwrite_sync(
716 ((int64_t)m_data
->l2_offset
* 512)
717 + (m_data
->l2_index
* sizeof(m_data
->offset
)),
718 &(m_data
->offset
), sizeof(m_data
->offset
)
727 static int get_cluster_offset(BlockDriverState
*bs
,
729 VmdkMetaData
*m_data
,
732 uint64_t *cluster_offset
)
734 unsigned int l1_index
, l2_offset
, l2_index
;
736 uint32_t min_count
, *l2_table
, tmp
= 0;
742 *cluster_offset
= extent
->flat_start_offset
;
746 offset
-= (extent
->end_sector
- extent
->sectors
) * SECTOR_SIZE
;
747 l1_index
= (offset
>> 9) / extent
->l1_entry_sectors
;
748 if (l1_index
>= extent
->l1_size
) {
751 l2_offset
= extent
->l1_table
[l1_index
];
755 for (i
= 0; i
< L2_CACHE_SIZE
; i
++) {
756 if (l2_offset
== extent
->l2_cache_offsets
[i
]) {
757 /* increment the hit count */
758 if (++extent
->l2_cache_counts
[i
] == 0xffffffff) {
759 for (j
= 0; j
< L2_CACHE_SIZE
; j
++) {
760 extent
->l2_cache_counts
[j
] >>= 1;
763 l2_table
= extent
->l2_cache
+ (i
* extent
->l2_size
);
767 /* not found: load a new entry in the least used one */
769 min_count
= 0xffffffff;
770 for (i
= 0; i
< L2_CACHE_SIZE
; i
++) {
771 if (extent
->l2_cache_counts
[i
] < min_count
) {
772 min_count
= extent
->l2_cache_counts
[i
];
776 l2_table
= extent
->l2_cache
+ (min_index
* extent
->l2_size
);
779 (int64_t)l2_offset
* 512,
781 extent
->l2_size
* sizeof(uint32_t)
782 ) != extent
->l2_size
* sizeof(uint32_t)) {
786 extent
->l2_cache_offsets
[min_index
] = l2_offset
;
787 extent
->l2_cache_counts
[min_index
] = 1;
789 l2_index
= ((offset
>> 9) / extent
->cluster_sectors
) % extent
->l2_size
;
790 *cluster_offset
= le32_to_cpu(l2_table
[l2_index
]);
792 if (!*cluster_offset
) {
797 /* Avoid the L2 tables update for the images that have snapshots. */
798 *cluster_offset
= bdrv_getlength(extent
->file
);
799 if (!extent
->compressed
) {
802 *cluster_offset
+ (extent
->cluster_sectors
<< 9)
806 *cluster_offset
>>= 9;
807 tmp
= cpu_to_le32(*cluster_offset
);
808 l2_table
[l2_index
] = tmp
;
810 /* First of all we write grain itself, to avoid race condition
811 * that may to corrupt the image.
812 * This problem may occur because of insufficient space on host disk
813 * or inappropriate VM shutdown.
815 if (get_whole_cluster(
816 bs
, extent
, *cluster_offset
, offset
, allocate
) == -1) {
821 m_data
->offset
= tmp
;
822 m_data
->l1_index
= l1_index
;
823 m_data
->l2_index
= l2_index
;
824 m_data
->l2_offset
= l2_offset
;
828 *cluster_offset
<<= 9;
832 static VmdkExtent
*find_extent(BDRVVmdkState
*s
,
833 int64_t sector_num
, VmdkExtent
*start_hint
)
835 VmdkExtent
*extent
= start_hint
;
838 extent
= &s
->extents
[0];
840 while (extent
< &s
->extents
[s
->num_extents
]) {
841 if (sector_num
< extent
->end_sector
) {
849 static int vmdk_is_allocated(BlockDriverState
*bs
, int64_t sector_num
,
850 int nb_sectors
, int *pnum
)
852 BDRVVmdkState
*s
= bs
->opaque
;
853 int64_t index_in_cluster
, n
, ret
;
857 extent
= find_extent(s
, sector_num
, NULL
);
861 ret
= get_cluster_offset(bs
, extent
, NULL
,
862 sector_num
* 512, 0, &offset
);
863 /* get_cluster_offset returning 0 means success */
866 index_in_cluster
= sector_num
% extent
->cluster_sectors
;
867 n
= extent
->cluster_sectors
- index_in_cluster
;
868 if (n
> nb_sectors
) {
875 static int vmdk_write_extent(VmdkExtent
*extent
, int64_t cluster_offset
,
876 int64_t offset_in_cluster
, const uint8_t *buf
,
877 int nb_sectors
, int64_t sector_num
)
880 VmdkGrainMarker
*data
= NULL
;
882 const uint8_t *write_buf
= buf
;
883 int write_len
= nb_sectors
* 512;
885 if (extent
->compressed
) {
886 if (!extent
->has_marker
) {
890 buf_len
= (extent
->cluster_sectors
<< 9) * 2;
891 data
= g_malloc(buf_len
+ sizeof(VmdkGrainMarker
));
892 if (compress(data
->data
, &buf_len
, buf
, nb_sectors
<< 9) != Z_OK
||
897 data
->lba
= sector_num
;
898 data
->size
= buf_len
;
899 write_buf
= (uint8_t *)data
;
900 write_len
= buf_len
+ sizeof(VmdkGrainMarker
);
902 ret
= bdrv_pwrite(extent
->file
,
903 cluster_offset
+ offset_in_cluster
,
906 if (ret
!= write_len
) {
907 ret
= ret
< 0 ? ret
: -EIO
;
916 static int vmdk_read_extent(VmdkExtent
*extent
, int64_t cluster_offset
,
917 int64_t offset_in_cluster
, uint8_t *buf
,
921 int cluster_bytes
, buf_bytes
;
922 uint8_t *cluster_buf
, *compressed_data
;
925 VmdkGrainMarker
*marker
;
929 if (!extent
->compressed
) {
930 ret
= bdrv_pread(extent
->file
,
931 cluster_offset
+ offset_in_cluster
,
932 buf
, nb_sectors
* 512);
933 if (ret
== nb_sectors
* 512) {
939 cluster_bytes
= extent
->cluster_sectors
* 512;
940 /* Read two clusters in case GrainMarker + compressed data > one cluster */
941 buf_bytes
= cluster_bytes
* 2;
942 cluster_buf
= g_malloc(buf_bytes
);
943 uncomp_buf
= g_malloc(cluster_bytes
);
944 ret
= bdrv_pread(extent
->file
,
946 cluster_buf
, buf_bytes
);
950 compressed_data
= cluster_buf
;
951 buf_len
= cluster_bytes
;
952 data_len
= cluster_bytes
;
953 if (extent
->has_marker
) {
954 marker
= (VmdkGrainMarker
*)cluster_buf
;
955 compressed_data
= marker
->data
;
956 data_len
= le32_to_cpu(marker
->size
);
958 if (!data_len
|| data_len
> buf_bytes
) {
962 ret
= uncompress(uncomp_buf
, &buf_len
, compressed_data
, data_len
);
968 if (offset_in_cluster
< 0 ||
969 offset_in_cluster
+ nb_sectors
* 512 > buf_len
) {
973 memcpy(buf
, uncomp_buf
+ offset_in_cluster
, nb_sectors
* 512);
982 static int vmdk_read(BlockDriverState
*bs
, int64_t sector_num
,
983 uint8_t *buf
, int nb_sectors
)
985 BDRVVmdkState
*s
= bs
->opaque
;
987 uint64_t n
, index_in_cluster
;
988 VmdkExtent
*extent
= NULL
;
989 uint64_t cluster_offset
;
991 while (nb_sectors
> 0) {
992 extent
= find_extent(s
, sector_num
, extent
);
996 ret
= get_cluster_offset(
998 sector_num
<< 9, 0, &cluster_offset
);
999 index_in_cluster
= sector_num
% extent
->cluster_sectors
;
1000 n
= extent
->cluster_sectors
- index_in_cluster
;
1001 if (n
> nb_sectors
) {
1005 /* if not allocated, try to read from parent image, if exist */
1006 if (bs
->backing_hd
) {
1007 if (!vmdk_is_cid_valid(bs
)) {
1010 ret
= bdrv_read(bs
->backing_hd
, sector_num
, buf
, n
);
1015 memset(buf
, 0, 512 * n
);
1018 ret
= vmdk_read_extent(extent
,
1019 cluster_offset
, index_in_cluster
* 512,
1032 static int vmdk_write(BlockDriverState
*bs
, int64_t sector_num
,
1033 const uint8_t *buf
, int nb_sectors
)
1035 BDRVVmdkState
*s
= bs
->opaque
;
1036 VmdkExtent
*extent
= NULL
;
1038 int64_t index_in_cluster
;
1039 uint64_t cluster_offset
;
1040 VmdkMetaData m_data
;
1042 if (sector_num
> bs
->total_sectors
) {
1044 "(VMDK) Wrong offset: sector_num=0x%" PRIx64
1045 " total_sectors=0x%" PRIx64
"\n",
1046 sector_num
, bs
->total_sectors
);
1050 while (nb_sectors
> 0) {
1051 extent
= find_extent(s
, sector_num
, extent
);
1055 ret
= get_cluster_offset(
1059 sector_num
<< 9, !extent
->compressed
,
1061 if (extent
->compressed
) {
1063 /* Refuse write to allocated cluster for streamOptimized */
1065 "VMDK: can't write to allocated cluster"
1066 " for streamOptimized\n");
1070 ret
= get_cluster_offset(
1081 index_in_cluster
= sector_num
% extent
->cluster_sectors
;
1082 n
= extent
->cluster_sectors
- index_in_cluster
;
1083 if (n
> nb_sectors
) {
1087 ret
= vmdk_write_extent(extent
,
1088 cluster_offset
, index_in_cluster
* 512,
1089 buf
, n
, sector_num
);
1094 /* update L2 tables */
1095 if (vmdk_L2update(extent
, &m_data
) == -1) {
1103 /* update CID on the first write every time the virtual disk is
1105 if (!s
->cid_updated
) {
1106 vmdk_write_cid(bs
, time(NULL
));
1107 s
->cid_updated
= true;
1114 static int vmdk_create_extent(const char *filename
, int64_t filesize
,
1115 bool flat
, bool compress
)
1120 uint32_t tmp
, magic
, grains
, gd_size
, gt_size
, gt_count
;
1124 O_WRONLY
| O_CREAT
| O_TRUNC
| O_BINARY
| O_LARGEFILE
,
1130 ret
= ftruncate(fd
, filesize
);
1136 magic
= cpu_to_be32(VMDK4_MAGIC
);
1137 memset(&header
, 0, sizeof(header
));
1140 3 | (compress
? VMDK4_FLAG_COMPRESS
| VMDK4_FLAG_MARKER
: 0);
1141 header
.compressAlgorithm
= compress
? VMDK4_COMPRESSION_DEFLATE
: 0;
1142 header
.capacity
= filesize
/ 512;
1143 header
.granularity
= 128;
1144 header
.num_gtes_per_gte
= 512;
1146 grains
= (filesize
/ 512 + header
.granularity
- 1) / header
.granularity
;
1147 gt_size
= ((header
.num_gtes_per_gte
* sizeof(uint32_t)) + 511) >> 9;
1149 (grains
+ header
.num_gtes_per_gte
- 1) / header
.num_gtes_per_gte
;
1150 gd_size
= (gt_count
* sizeof(uint32_t) + 511) >> 9;
1152 header
.desc_offset
= 1;
1153 header
.desc_size
= 20;
1154 header
.rgd_offset
= header
.desc_offset
+ header
.desc_size
;
1155 header
.gd_offset
= header
.rgd_offset
+ gd_size
+ (gt_size
* gt_count
);
1156 header
.grain_offset
=
1157 ((header
.gd_offset
+ gd_size
+ (gt_size
* gt_count
) +
1158 header
.granularity
- 1) / header
.granularity
) *
1160 /* swap endianness for all header fields */
1161 header
.version
= cpu_to_le32(header
.version
);
1162 header
.flags
= cpu_to_le32(header
.flags
);
1163 header
.capacity
= cpu_to_le64(header
.capacity
);
1164 header
.granularity
= cpu_to_le64(header
.granularity
);
1165 header
.num_gtes_per_gte
= cpu_to_le32(header
.num_gtes_per_gte
);
1166 header
.desc_offset
= cpu_to_le64(header
.desc_offset
);
1167 header
.desc_size
= cpu_to_le64(header
.desc_size
);
1168 header
.rgd_offset
= cpu_to_le64(header
.rgd_offset
);
1169 header
.gd_offset
= cpu_to_le64(header
.gd_offset
);
1170 header
.grain_offset
= cpu_to_le64(header
.grain_offset
);
1171 header
.compressAlgorithm
= cpu_to_le16(header
.compressAlgorithm
);
1173 header
.check_bytes
[0] = 0xa;
1174 header
.check_bytes
[1] = 0x20;
1175 header
.check_bytes
[2] = 0xd;
1176 header
.check_bytes
[3] = 0xa;
1178 /* write all the data */
1179 ret
= qemu_write_full(fd
, &magic
, sizeof(magic
));
1180 if (ret
!= sizeof(magic
)) {
1184 ret
= qemu_write_full(fd
, &header
, sizeof(header
));
1185 if (ret
!= sizeof(header
)) {
1190 ret
= ftruncate(fd
, le64_to_cpu(header
.grain_offset
) << 9);
1196 /* write grain directory */
1197 lseek(fd
, le64_to_cpu(header
.rgd_offset
) << 9, SEEK_SET
);
1198 for (i
= 0, tmp
= le64_to_cpu(header
.rgd_offset
) + gd_size
;
1199 i
< gt_count
; i
++, tmp
+= gt_size
) {
1200 ret
= qemu_write_full(fd
, &tmp
, sizeof(tmp
));
1201 if (ret
!= sizeof(tmp
)) {
1207 /* write backup grain directory */
1208 lseek(fd
, le64_to_cpu(header
.gd_offset
) << 9, SEEK_SET
);
1209 for (i
= 0, tmp
= le64_to_cpu(header
.gd_offset
) + gd_size
;
1210 i
< gt_count
; i
++, tmp
+= gt_size
) {
1211 ret
= qemu_write_full(fd
, &tmp
, sizeof(tmp
));
1212 if (ret
!= sizeof(tmp
)) {
1224 static int filename_decompose(const char *filename
, char *path
, char *prefix
,
1225 char *postfix
, size_t buf_len
)
1229 if (filename
== NULL
|| !strlen(filename
)) {
1230 fprintf(stderr
, "Vmdk: no filename provided.\n");
1233 p
= strrchr(filename
, '/');
1235 p
= strrchr(filename
, '\\');
1238 p
= strrchr(filename
, ':');
1242 if (p
- filename
>= buf_len
) {
1245 pstrcpy(path
, p
- filename
+ 1, filename
);
1250 q
= strrchr(p
, '.');
1252 pstrcpy(prefix
, buf_len
, p
);
1255 if (q
- p
>= buf_len
) {
1258 pstrcpy(prefix
, q
- p
+ 1, p
);
1259 pstrcpy(postfix
, buf_len
, q
);
1264 static int relative_path(char *dest
, int dest_size
,
1265 const char *base
, const char *target
)
1271 const char *sep
= "\\";
1273 const char *sep
= "/";
1276 if (!(dest
&& base
&& target
)) {
1279 if (path_is_absolute(target
)) {
1280 dest
[dest_size
- 1] = '\0';
1281 strncpy(dest
, target
, dest_size
- 1);
1284 while (base
[i
] == target
[i
]) {
1297 pstrcat(dest
, dest_size
, "..");
1298 pstrcat(dest
, dest_size
, sep
);
1300 pstrcat(dest
, dest_size
, q
);
1304 static int vmdk_create(const char *filename
, QEMUOptionParameter
*options
)
1307 char desc
[BUF_SIZE
];
1308 int64_t total_size
= 0, filesize
;
1309 const char *backing_file
= NULL
;
1310 const char *fmt
= NULL
;
1313 bool flat
, split
, compress
;
1314 char ext_desc_lines
[BUF_SIZE
] = "";
1315 char path
[PATH_MAX
], prefix
[PATH_MAX
], postfix
[PATH_MAX
];
1316 const int64_t split_size
= 0x80000000; /* VMDK has constant split size */
1317 const char *desc_extent_line
;
1318 char parent_desc_line
[BUF_SIZE
] = "";
1319 uint32_t parent_cid
= 0xffffffff;
1320 const char desc_template
[] =
1321 "# Disk DescriptorFile\n"
1325 "createType=\"%s\"\n"
1328 "# Extent description\n"
1331 "# The Disk Data Base\n"
1334 "ddb.virtualHWVersion = \"%d\"\n"
1335 "ddb.geometry.cylinders = \"%" PRId64
"\"\n"
1336 "ddb.geometry.heads = \"16\"\n"
1337 "ddb.geometry.sectors = \"63\"\n"
1338 "ddb.adapterType = \"ide\"\n";
1340 if (filename_decompose(filename
, path
, prefix
, postfix
, PATH_MAX
)) {
1343 /* Read out options */
1344 while (options
&& options
->name
) {
1345 if (!strcmp(options
->name
, BLOCK_OPT_SIZE
)) {
1346 total_size
= options
->value
.n
;
1347 } else if (!strcmp(options
->name
, BLOCK_OPT_BACKING_FILE
)) {
1348 backing_file
= options
->value
.s
;
1349 } else if (!strcmp(options
->name
, BLOCK_OPT_COMPAT6
)) {
1350 flags
|= options
->value
.n
? BLOCK_FLAG_COMPAT6
: 0;
1351 } else if (!strcmp(options
->name
, BLOCK_OPT_SUBFMT
)) {
1352 fmt
= options
->value
.s
;
1357 /* Default format to monolithicSparse */
1358 fmt
= "monolithicSparse";
1359 } else if (strcmp(fmt
, "monolithicFlat") &&
1360 strcmp(fmt
, "monolithicSparse") &&
1361 strcmp(fmt
, "twoGbMaxExtentSparse") &&
1362 strcmp(fmt
, "twoGbMaxExtentFlat") &&
1363 strcmp(fmt
, "streamOptimized")) {
1364 fprintf(stderr
, "VMDK: Unknown subformat: %s\n", fmt
);
1367 split
= !(strcmp(fmt
, "twoGbMaxExtentFlat") &&
1368 strcmp(fmt
, "twoGbMaxExtentSparse"));
1369 flat
= !(strcmp(fmt
, "monolithicFlat") &&
1370 strcmp(fmt
, "twoGbMaxExtentFlat"));
1371 compress
= !strcmp(fmt
, "streamOptimized");
1373 desc_extent_line
= "RW %lld FLAT \"%s\" 0\n";
1375 desc_extent_line
= "RW %lld SPARSE \"%s\"\n";
1377 if (flat
&& backing_file
) {
1378 /* not supporting backing file for flat image */
1382 char parent_filename
[PATH_MAX
];
1383 BlockDriverState
*bs
= bdrv_new("");
1384 ret
= bdrv_open(bs
, backing_file
, 0, NULL
);
1389 if (strcmp(bs
->drv
->format_name
, "vmdk")) {
1393 filesize
= bdrv_getlength(bs
);
1394 parent_cid
= vmdk_read_cid(bs
, 0);
1396 relative_path(parent_filename
, sizeof(parent_filename
),
1397 filename
, backing_file
);
1398 snprintf(parent_desc_line
, sizeof(parent_desc_line
),
1399 "parentFileNameHint=\"%s\"", parent_filename
);
1402 /* Create extents */
1403 filesize
= total_size
;
1404 while (filesize
> 0) {
1405 char desc_line
[BUF_SIZE
];
1406 char ext_filename
[PATH_MAX
];
1407 char desc_filename
[PATH_MAX
];
1408 int64_t size
= filesize
;
1410 if (split
&& size
> split_size
) {
1414 snprintf(desc_filename
, sizeof(desc_filename
), "%s-%c%03d%s",
1415 prefix
, flat
? 'f' : 's', ++idx
, postfix
);
1417 snprintf(desc_filename
, sizeof(desc_filename
), "%s-flat%s",
1420 snprintf(desc_filename
, sizeof(desc_filename
), "%s%s",
1423 snprintf(ext_filename
, sizeof(ext_filename
), "%s%s",
1424 path
, desc_filename
);
1426 if (vmdk_create_extent(ext_filename
, size
, flat
, compress
)) {
1431 /* Format description line */
1432 snprintf(desc_line
, sizeof(desc_line
),
1433 desc_extent_line
, size
/ 512, desc_filename
);
1434 pstrcat(ext_desc_lines
, sizeof(ext_desc_lines
), desc_line
);
1436 /* generate descriptor file */
1437 snprintf(desc
, sizeof(desc
), desc_template
,
1438 (unsigned int)time(NULL
),
1443 (flags
& BLOCK_FLAG_COMPAT6
? 6 : 4),
1444 total_size
/ (int64_t)(63 * 16 * 512));
1445 if (split
|| flat
) {
1448 O_WRONLY
| O_CREAT
| O_TRUNC
| O_BINARY
| O_LARGEFILE
,
1453 O_WRONLY
| O_BINARY
| O_LARGEFILE
,
1459 /* the descriptor offset = 0x200 */
1460 if (!split
&& !flat
&& 0x200 != lseek(fd
, 0x200, SEEK_SET
)) {
1464 ret
= qemu_write_full(fd
, desc
, strlen(desc
));
1465 if (ret
!= strlen(desc
)) {
1475 static void vmdk_close(BlockDriverState
*bs
)
1477 vmdk_free_extents(bs
);
1480 static int vmdk_flush(BlockDriverState
*bs
)
1483 BDRVVmdkState
*s
= bs
->opaque
;
1485 ret
= bdrv_flush(bs
->file
);
1486 for (i
= 0; i
< s
->num_extents
; i
++) {
1487 err
= bdrv_flush(s
->extents
[i
].file
);
1495 static int64_t vmdk_get_allocated_file_size(BlockDriverState
*bs
)
1500 BDRVVmdkState
*s
= bs
->opaque
;
1502 ret
= bdrv_get_allocated_file_size(bs
->file
);
1506 for (i
= 0; i
< s
->num_extents
; i
++) {
1507 if (s
->extents
[i
].file
== bs
->file
) {
1510 r
= bdrv_get_allocated_file_size(s
->extents
[i
].file
);
1519 static QEMUOptionParameter vmdk_create_options
[] = {
1521 .name
= BLOCK_OPT_SIZE
,
1523 .help
= "Virtual disk size"
1526 .name
= BLOCK_OPT_BACKING_FILE
,
1528 .help
= "File name of a base image"
1531 .name
= BLOCK_OPT_COMPAT6
,
1533 .help
= "VMDK version 6 image"
1536 .name
= BLOCK_OPT_SUBFMT
,
1539 "VMDK flat extent format, can be one of "
1540 "{monolithicSparse (default) | monolithicFlat | twoGbMaxExtentSparse | twoGbMaxExtentFlat | streamOptimized} "
1545 static BlockDriver bdrv_vmdk
= {
1546 .format_name
= "vmdk",
1547 .instance_size
= sizeof(BDRVVmdkState
),
1548 .bdrv_probe
= vmdk_probe
,
1549 .bdrv_open
= vmdk_open
,
1550 .bdrv_read
= vmdk_read
,
1551 .bdrv_write
= vmdk_write
,
1552 .bdrv_close
= vmdk_close
,
1553 .bdrv_create
= vmdk_create
,
1554 .bdrv_flush
= vmdk_flush
,
1555 .bdrv_is_allocated
= vmdk_is_allocated
,
1556 .bdrv_get_allocated_file_size
= vmdk_get_allocated_file_size
,
1558 .create_options
= vmdk_create_options
,
1561 static void bdrv_vmdk_init(void)
1563 bdrv_register(&bdrv_vmdk
);
1566 block_init(bdrv_vmdk_init
);