vmdk: Switch to heap arrays for vmdk_read_cid
[qemu/ar7.git] / block / vmdk.c
blobc68f4563add289f58e57e146b7d44f7865eb8b1b
1 /*
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
23 * THE SOFTWARE.
26 #include "qemu/osdep.h"
27 #include "qemu-common.h"
28 #include "block/block_int.h"
29 #include "qapi/qmp/qerror.h"
30 #include "qemu/error-report.h"
31 #include "qemu/module.h"
32 #include "migration/migration.h"
33 #include <zlib.h>
34 #include <glib.h>
36 #define VMDK3_MAGIC (('C' << 24) | ('O' << 16) | ('W' << 8) | 'D')
37 #define VMDK4_MAGIC (('K' << 24) | ('D' << 16) | ('M' << 8) | 'V')
38 #define VMDK4_COMPRESSION_DEFLATE 1
39 #define VMDK4_FLAG_NL_DETECT (1 << 0)
40 #define VMDK4_FLAG_RGD (1 << 1)
41 /* Zeroed-grain enable bit */
42 #define VMDK4_FLAG_ZERO_GRAIN (1 << 2)
43 #define VMDK4_FLAG_COMPRESS (1 << 16)
44 #define VMDK4_FLAG_MARKER (1 << 17)
45 #define VMDK4_GD_AT_END 0xffffffffffffffffULL
47 #define VMDK_GTE_ZEROED 0x1
49 /* VMDK internal error codes */
50 #define VMDK_OK 0
51 #define VMDK_ERROR (-1)
52 /* Cluster not allocated */
53 #define VMDK_UNALLOC (-2)
54 #define VMDK_ZEROED (-3)
56 #define BLOCK_OPT_ZEROED_GRAIN "zeroed_grain"
58 typedef struct {
59 uint32_t version;
60 uint32_t flags;
61 uint32_t disk_sectors;
62 uint32_t granularity;
63 uint32_t l1dir_offset;
64 uint32_t l1dir_size;
65 uint32_t file_sectors;
66 uint32_t cylinders;
67 uint32_t heads;
68 uint32_t sectors_per_track;
69 } QEMU_PACKED VMDK3Header;
71 typedef struct {
72 uint32_t version;
73 uint32_t flags;
74 uint64_t capacity;
75 uint64_t granularity;
76 uint64_t desc_offset;
77 uint64_t desc_size;
78 /* Number of GrainTableEntries per GrainTable */
79 uint32_t num_gtes_per_gt;
80 uint64_t rgd_offset;
81 uint64_t gd_offset;
82 uint64_t grain_offset;
83 char filler[1];
84 char check_bytes[4];
85 uint16_t compressAlgorithm;
86 } QEMU_PACKED VMDK4Header;
88 #define L2_CACHE_SIZE 16
90 typedef struct VmdkExtent {
91 BdrvChild *file;
92 bool flat;
93 bool compressed;
94 bool has_marker;
95 bool has_zero_grain;
96 int version;
97 int64_t sectors;
98 int64_t end_sector;
99 int64_t flat_start_offset;
100 int64_t l1_table_offset;
101 int64_t l1_backup_table_offset;
102 uint32_t *l1_table;
103 uint32_t *l1_backup_table;
104 unsigned int l1_size;
105 uint32_t l1_entry_sectors;
107 unsigned int l2_size;
108 uint32_t *l2_cache;
109 uint32_t l2_cache_offsets[L2_CACHE_SIZE];
110 uint32_t l2_cache_counts[L2_CACHE_SIZE];
112 int64_t cluster_sectors;
113 int64_t next_cluster_sector;
114 char *type;
115 } VmdkExtent;
117 typedef struct BDRVVmdkState {
118 CoMutex lock;
119 uint64_t desc_offset;
120 bool cid_updated;
121 bool cid_checked;
122 uint32_t cid;
123 uint32_t parent_cid;
124 int num_extents;
125 /* Extent array with num_extents entries, ascend ordered by address */
126 VmdkExtent *extents;
127 Error *migration_blocker;
128 char *create_type;
129 } BDRVVmdkState;
131 typedef struct VmdkMetaData {
132 unsigned int l1_index;
133 unsigned int l2_index;
134 unsigned int l2_offset;
135 int valid;
136 uint32_t *l2_cache_entry;
137 } VmdkMetaData;
139 typedef struct VmdkGrainMarker {
140 uint64_t lba;
141 uint32_t size;
142 uint8_t data[0];
143 } QEMU_PACKED VmdkGrainMarker;
145 enum {
146 MARKER_END_OF_STREAM = 0,
147 MARKER_GRAIN_TABLE = 1,
148 MARKER_GRAIN_DIRECTORY = 2,
149 MARKER_FOOTER = 3,
152 static int vmdk_probe(const uint8_t *buf, int buf_size, const char *filename)
154 uint32_t magic;
156 if (buf_size < 4) {
157 return 0;
159 magic = be32_to_cpu(*(uint32_t *)buf);
160 if (magic == VMDK3_MAGIC ||
161 magic == VMDK4_MAGIC) {
162 return 100;
163 } else {
164 const char *p = (const char *)buf;
165 const char *end = p + buf_size;
166 while (p < end) {
167 if (*p == '#') {
168 /* skip comment line */
169 while (p < end && *p != '\n') {
170 p++;
172 p++;
173 continue;
175 if (*p == ' ') {
176 while (p < end && *p == ' ') {
177 p++;
179 /* skip '\r' if windows line endings used. */
180 if (p < end && *p == '\r') {
181 p++;
183 /* only accept blank lines before 'version=' line */
184 if (p == end || *p != '\n') {
185 return 0;
187 p++;
188 continue;
190 if (end - p >= strlen("version=X\n")) {
191 if (strncmp("version=1\n", p, strlen("version=1\n")) == 0 ||
192 strncmp("version=2\n", p, strlen("version=2\n")) == 0) {
193 return 100;
196 if (end - p >= strlen("version=X\r\n")) {
197 if (strncmp("version=1\r\n", p, strlen("version=1\r\n")) == 0 ||
198 strncmp("version=2\r\n", p, strlen("version=2\r\n")) == 0) {
199 return 100;
202 return 0;
204 return 0;
208 #define SECTOR_SIZE 512
209 #define DESC_SIZE (20 * SECTOR_SIZE) /* 20 sectors of 512 bytes each */
210 #define BUF_SIZE 4096
211 #define HEADER_SIZE 512 /* first sector of 512 bytes */
213 static void vmdk_free_extents(BlockDriverState *bs)
215 int i;
216 BDRVVmdkState *s = bs->opaque;
217 VmdkExtent *e;
219 for (i = 0; i < s->num_extents; i++) {
220 e = &s->extents[i];
221 g_free(e->l1_table);
222 g_free(e->l2_cache);
223 g_free(e->l1_backup_table);
224 g_free(e->type);
225 if (e->file != bs->file) {
226 bdrv_unref_child(bs, e->file);
229 g_free(s->extents);
232 static void vmdk_free_last_extent(BlockDriverState *bs)
234 BDRVVmdkState *s = bs->opaque;
236 if (s->num_extents == 0) {
237 return;
239 s->num_extents--;
240 s->extents = g_renew(VmdkExtent, s->extents, s->num_extents);
243 static uint32_t vmdk_read_cid(BlockDriverState *bs, int parent)
245 char *desc;
246 uint32_t cid = 0xffffffff;
247 const char *p_name, *cid_str;
248 size_t cid_str_size;
249 BDRVVmdkState *s = bs->opaque;
250 int ret;
252 desc = g_malloc0(DESC_SIZE);
253 ret = bdrv_pread(bs->file->bs, s->desc_offset, desc, DESC_SIZE);
254 if (ret < 0) {
255 g_free(desc);
256 return 0;
259 if (parent) {
260 cid_str = "parentCID";
261 cid_str_size = sizeof("parentCID");
262 } else {
263 cid_str = "CID";
264 cid_str_size = sizeof("CID");
267 desc[DESC_SIZE - 1] = '\0';
268 p_name = strstr(desc, cid_str);
269 if (p_name != NULL) {
270 p_name += cid_str_size;
271 sscanf(p_name, "%" SCNx32, &cid);
274 g_free(desc);
275 return cid;
278 static int vmdk_write_cid(BlockDriverState *bs, uint32_t cid)
280 char *desc, *tmp_desc;
281 char *p_name, *tmp_str;
282 BDRVVmdkState *s = bs->opaque;
283 int ret = 0;
285 desc = g_malloc0(DESC_SIZE);
286 tmp_desc = g_malloc0(DESC_SIZE);
287 ret = bdrv_pread(bs->file->bs, s->desc_offset, desc, DESC_SIZE);
288 if (ret < 0) {
289 goto out;
292 desc[DESC_SIZE - 1] = '\0';
293 tmp_str = strstr(desc, "parentCID");
294 if (tmp_str == NULL) {
295 ret = -EINVAL;
296 goto out;
299 pstrcpy(tmp_desc, DESC_SIZE, tmp_str);
300 p_name = strstr(desc, "CID");
301 if (p_name != NULL) {
302 p_name += sizeof("CID");
303 snprintf(p_name, DESC_SIZE - (p_name - desc), "%" PRIx32 "\n", cid);
304 pstrcat(desc, DESC_SIZE, tmp_desc);
307 ret = bdrv_pwrite_sync(bs->file->bs, s->desc_offset, desc, DESC_SIZE);
309 out:
310 g_free(desc);
311 g_free(tmp_desc);
312 return ret;
315 static int vmdk_is_cid_valid(BlockDriverState *bs)
317 BDRVVmdkState *s = bs->opaque;
318 uint32_t cur_pcid;
320 if (!s->cid_checked && bs->backing) {
321 BlockDriverState *p_bs = bs->backing->bs;
323 cur_pcid = vmdk_read_cid(p_bs, 0);
324 if (s->parent_cid != cur_pcid) {
325 /* CID not valid */
326 return 0;
329 s->cid_checked = true;
330 /* CID valid */
331 return 1;
334 /* We have nothing to do for VMDK reopen, stubs just return success */
335 static int vmdk_reopen_prepare(BDRVReopenState *state,
336 BlockReopenQueue *queue, Error **errp)
338 assert(state != NULL);
339 assert(state->bs != NULL);
340 return 0;
343 static int vmdk_parent_open(BlockDriverState *bs)
345 char *p_name;
346 char desc[DESC_SIZE + 1];
347 BDRVVmdkState *s = bs->opaque;
348 int ret;
350 desc[DESC_SIZE] = '\0';
351 ret = bdrv_pread(bs->file->bs, s->desc_offset, desc, DESC_SIZE);
352 if (ret < 0) {
353 return ret;
356 p_name = strstr(desc, "parentFileNameHint");
357 if (p_name != NULL) {
358 char *end_name;
360 p_name += sizeof("parentFileNameHint") + 1;
361 end_name = strchr(p_name, '\"');
362 if (end_name == NULL) {
363 return -EINVAL;
365 if ((end_name - p_name) > sizeof(bs->backing_file) - 1) {
366 return -EINVAL;
369 pstrcpy(bs->backing_file, end_name - p_name + 1, p_name);
372 return 0;
375 /* Create and append extent to the extent array. Return the added VmdkExtent
376 * address. return NULL if allocation failed. */
377 static int vmdk_add_extent(BlockDriverState *bs,
378 BdrvChild *file, bool flat, int64_t sectors,
379 int64_t l1_offset, int64_t l1_backup_offset,
380 uint32_t l1_size,
381 int l2_size, uint64_t cluster_sectors,
382 VmdkExtent **new_extent,
383 Error **errp)
385 VmdkExtent *extent;
386 BDRVVmdkState *s = bs->opaque;
387 int64_t nb_sectors;
389 if (cluster_sectors > 0x200000) {
390 /* 0x200000 * 512Bytes = 1GB for one cluster is unrealistic */
391 error_setg(errp, "Invalid granularity, image may be corrupt");
392 return -EFBIG;
394 if (l1_size > 512 * 1024 * 1024) {
395 /* Although with big capacity and small l1_entry_sectors, we can get a
396 * big l1_size, we don't want unbounded value to allocate the table.
397 * Limit it to 512M, which is 16PB for default cluster and L2 table
398 * size */
399 error_setg(errp, "L1 size too big");
400 return -EFBIG;
403 nb_sectors = bdrv_nb_sectors(file->bs);
404 if (nb_sectors < 0) {
405 return nb_sectors;
408 s->extents = g_renew(VmdkExtent, s->extents, s->num_extents + 1);
409 extent = &s->extents[s->num_extents];
410 s->num_extents++;
412 memset(extent, 0, sizeof(VmdkExtent));
413 extent->file = file;
414 extent->flat = flat;
415 extent->sectors = sectors;
416 extent->l1_table_offset = l1_offset;
417 extent->l1_backup_table_offset = l1_backup_offset;
418 extent->l1_size = l1_size;
419 extent->l1_entry_sectors = l2_size * cluster_sectors;
420 extent->l2_size = l2_size;
421 extent->cluster_sectors = flat ? sectors : cluster_sectors;
422 extent->next_cluster_sector = ROUND_UP(nb_sectors, cluster_sectors);
424 if (s->num_extents > 1) {
425 extent->end_sector = (*(extent - 1)).end_sector + extent->sectors;
426 } else {
427 extent->end_sector = extent->sectors;
429 bs->total_sectors = extent->end_sector;
430 if (new_extent) {
431 *new_extent = extent;
433 return 0;
436 static int vmdk_init_tables(BlockDriverState *bs, VmdkExtent *extent,
437 Error **errp)
439 int ret;
440 size_t l1_size;
441 int i;
443 /* read the L1 table */
444 l1_size = extent->l1_size * sizeof(uint32_t);
445 extent->l1_table = g_try_malloc(l1_size);
446 if (l1_size && extent->l1_table == NULL) {
447 return -ENOMEM;
450 ret = bdrv_pread(extent->file->bs,
451 extent->l1_table_offset,
452 extent->l1_table,
453 l1_size);
454 if (ret < 0) {
455 error_setg_errno(errp, -ret,
456 "Could not read l1 table from extent '%s'",
457 extent->file->bs->filename);
458 goto fail_l1;
460 for (i = 0; i < extent->l1_size; i++) {
461 le32_to_cpus(&extent->l1_table[i]);
464 if (extent->l1_backup_table_offset) {
465 extent->l1_backup_table = g_try_malloc(l1_size);
466 if (l1_size && extent->l1_backup_table == NULL) {
467 ret = -ENOMEM;
468 goto fail_l1;
470 ret = bdrv_pread(extent->file->bs,
471 extent->l1_backup_table_offset,
472 extent->l1_backup_table,
473 l1_size);
474 if (ret < 0) {
475 error_setg_errno(errp, -ret,
476 "Could not read l1 backup table from extent '%s'",
477 extent->file->bs->filename);
478 goto fail_l1b;
480 for (i = 0; i < extent->l1_size; i++) {
481 le32_to_cpus(&extent->l1_backup_table[i]);
485 extent->l2_cache =
486 g_new(uint32_t, extent->l2_size * L2_CACHE_SIZE);
487 return 0;
488 fail_l1b:
489 g_free(extent->l1_backup_table);
490 fail_l1:
491 g_free(extent->l1_table);
492 return ret;
495 static int vmdk_open_vmfs_sparse(BlockDriverState *bs,
496 BdrvChild *file,
497 int flags, Error **errp)
499 int ret;
500 uint32_t magic;
501 VMDK3Header header;
502 VmdkExtent *extent;
504 ret = bdrv_pread(file->bs, sizeof(magic), &header, sizeof(header));
505 if (ret < 0) {
506 error_setg_errno(errp, -ret,
507 "Could not read header from file '%s'",
508 file->bs->filename);
509 return ret;
511 ret = vmdk_add_extent(bs, file, false,
512 le32_to_cpu(header.disk_sectors),
513 (int64_t)le32_to_cpu(header.l1dir_offset) << 9,
515 le32_to_cpu(header.l1dir_size),
516 4096,
517 le32_to_cpu(header.granularity),
518 &extent,
519 errp);
520 if (ret < 0) {
521 return ret;
523 ret = vmdk_init_tables(bs, extent, errp);
524 if (ret) {
525 /* free extent allocated by vmdk_add_extent */
526 vmdk_free_last_extent(bs);
528 return ret;
531 static int vmdk_open_desc_file(BlockDriverState *bs, int flags, char *buf,
532 QDict *options, Error **errp);
534 static char *vmdk_read_desc(BlockDriverState *file, uint64_t desc_offset,
535 Error **errp)
537 int64_t size;
538 char *buf;
539 int ret;
541 size = bdrv_getlength(file);
542 if (size < 0) {
543 error_setg_errno(errp, -size, "Could not access file");
544 return NULL;
547 if (size < 4) {
548 /* Both descriptor file and sparse image must be much larger than 4
549 * bytes, also callers of vmdk_read_desc want to compare the first 4
550 * bytes with VMDK4_MAGIC, let's error out if less is read. */
551 error_setg(errp, "File is too small, not a valid image");
552 return NULL;
555 size = MIN(size, (1 << 20) - 1); /* avoid unbounded allocation */
556 buf = g_malloc(size + 1);
558 ret = bdrv_pread(file, desc_offset, buf, size);
559 if (ret < 0) {
560 error_setg_errno(errp, -ret, "Could not read from file");
561 g_free(buf);
562 return NULL;
564 buf[ret] = 0;
566 return buf;
569 static int vmdk_open_vmdk4(BlockDriverState *bs,
570 BdrvChild *file,
571 int flags, QDict *options, Error **errp)
573 int ret;
574 uint32_t magic;
575 uint32_t l1_size, l1_entry_sectors;
576 VMDK4Header header;
577 VmdkExtent *extent;
578 BDRVVmdkState *s = bs->opaque;
579 int64_t l1_backup_offset = 0;
580 bool compressed;
582 ret = bdrv_pread(file->bs, sizeof(magic), &header, sizeof(header));
583 if (ret < 0) {
584 error_setg_errno(errp, -ret,
585 "Could not read header from file '%s'",
586 file->bs->filename);
587 return -EINVAL;
589 if (header.capacity == 0) {
590 uint64_t desc_offset = le64_to_cpu(header.desc_offset);
591 if (desc_offset) {
592 char *buf = vmdk_read_desc(file->bs, desc_offset << 9, errp);
593 if (!buf) {
594 return -EINVAL;
596 ret = vmdk_open_desc_file(bs, flags, buf, options, errp);
597 g_free(buf);
598 return ret;
602 if (!s->create_type) {
603 s->create_type = g_strdup("monolithicSparse");
606 if (le64_to_cpu(header.gd_offset) == VMDK4_GD_AT_END) {
608 * The footer takes precedence over the header, so read it in. The
609 * footer starts at offset -1024 from the end: One sector for the
610 * footer, and another one for the end-of-stream marker.
612 struct {
613 struct {
614 uint64_t val;
615 uint32_t size;
616 uint32_t type;
617 uint8_t pad[512 - 16];
618 } QEMU_PACKED footer_marker;
620 uint32_t magic;
621 VMDK4Header header;
622 uint8_t pad[512 - 4 - sizeof(VMDK4Header)];
624 struct {
625 uint64_t val;
626 uint32_t size;
627 uint32_t type;
628 uint8_t pad[512 - 16];
629 } QEMU_PACKED eos_marker;
630 } QEMU_PACKED footer;
632 ret = bdrv_pread(file->bs,
633 bs->file->bs->total_sectors * 512 - 1536,
634 &footer, sizeof(footer));
635 if (ret < 0) {
636 error_setg_errno(errp, -ret, "Failed to read footer");
637 return ret;
640 /* Some sanity checks for the footer */
641 if (be32_to_cpu(footer.magic) != VMDK4_MAGIC ||
642 le32_to_cpu(footer.footer_marker.size) != 0 ||
643 le32_to_cpu(footer.footer_marker.type) != MARKER_FOOTER ||
644 le64_to_cpu(footer.eos_marker.val) != 0 ||
645 le32_to_cpu(footer.eos_marker.size) != 0 ||
646 le32_to_cpu(footer.eos_marker.type) != MARKER_END_OF_STREAM)
648 error_setg(errp, "Invalid footer");
649 return -EINVAL;
652 header = footer.header;
655 compressed =
656 le16_to_cpu(header.compressAlgorithm) == VMDK4_COMPRESSION_DEFLATE;
657 if (le32_to_cpu(header.version) > 3) {
658 char buf[64];
659 snprintf(buf, sizeof(buf), "VMDK version %" PRId32,
660 le32_to_cpu(header.version));
661 error_setg(errp, QERR_UNKNOWN_BLOCK_FORMAT_FEATURE,
662 bdrv_get_device_or_node_name(bs), "vmdk", buf);
663 return -ENOTSUP;
664 } else if (le32_to_cpu(header.version) == 3 && (flags & BDRV_O_RDWR) &&
665 !compressed) {
666 /* VMware KB 2064959 explains that version 3 added support for
667 * persistent changed block tracking (CBT), and backup software can
668 * read it as version=1 if it doesn't care about the changed area
669 * information. So we are safe to enable read only. */
670 error_setg(errp, "VMDK version 3 must be read only");
671 return -EINVAL;
674 if (le32_to_cpu(header.num_gtes_per_gt) > 512) {
675 error_setg(errp, "L2 table size too big");
676 return -EINVAL;
679 l1_entry_sectors = le32_to_cpu(header.num_gtes_per_gt)
680 * le64_to_cpu(header.granularity);
681 if (l1_entry_sectors == 0) {
682 error_setg(errp, "L1 entry size is invalid");
683 return -EINVAL;
685 l1_size = (le64_to_cpu(header.capacity) + l1_entry_sectors - 1)
686 / l1_entry_sectors;
687 if (le32_to_cpu(header.flags) & VMDK4_FLAG_RGD) {
688 l1_backup_offset = le64_to_cpu(header.rgd_offset) << 9;
690 if (bdrv_nb_sectors(file->bs) < le64_to_cpu(header.grain_offset)) {
691 error_setg(errp, "File truncated, expecting at least %" PRId64 " bytes",
692 (int64_t)(le64_to_cpu(header.grain_offset)
693 * BDRV_SECTOR_SIZE));
694 return -EINVAL;
697 ret = vmdk_add_extent(bs, file, false,
698 le64_to_cpu(header.capacity),
699 le64_to_cpu(header.gd_offset) << 9,
700 l1_backup_offset,
701 l1_size,
702 le32_to_cpu(header.num_gtes_per_gt),
703 le64_to_cpu(header.granularity),
704 &extent,
705 errp);
706 if (ret < 0) {
707 return ret;
709 extent->compressed =
710 le16_to_cpu(header.compressAlgorithm) == VMDK4_COMPRESSION_DEFLATE;
711 if (extent->compressed) {
712 g_free(s->create_type);
713 s->create_type = g_strdup("streamOptimized");
715 extent->has_marker = le32_to_cpu(header.flags) & VMDK4_FLAG_MARKER;
716 extent->version = le32_to_cpu(header.version);
717 extent->has_zero_grain = le32_to_cpu(header.flags) & VMDK4_FLAG_ZERO_GRAIN;
718 ret = vmdk_init_tables(bs, extent, errp);
719 if (ret) {
720 /* free extent allocated by vmdk_add_extent */
721 vmdk_free_last_extent(bs);
723 return ret;
726 /* find an option value out of descriptor file */
727 static int vmdk_parse_description(const char *desc, const char *opt_name,
728 char *buf, int buf_size)
730 char *opt_pos, *opt_end;
731 const char *end = desc + strlen(desc);
733 opt_pos = strstr(desc, opt_name);
734 if (!opt_pos) {
735 return VMDK_ERROR;
737 /* Skip "=\"" following opt_name */
738 opt_pos += strlen(opt_name) + 2;
739 if (opt_pos >= end) {
740 return VMDK_ERROR;
742 opt_end = opt_pos;
743 while (opt_end < end && *opt_end != '"') {
744 opt_end++;
746 if (opt_end == end || buf_size < opt_end - opt_pos + 1) {
747 return VMDK_ERROR;
749 pstrcpy(buf, opt_end - opt_pos + 1, opt_pos);
750 return VMDK_OK;
753 /* Open an extent file and append to bs array */
754 static int vmdk_open_sparse(BlockDriverState *bs, BdrvChild *file, int flags,
755 char *buf, QDict *options, Error **errp)
757 uint32_t magic;
759 magic = ldl_be_p(buf);
760 switch (magic) {
761 case VMDK3_MAGIC:
762 return vmdk_open_vmfs_sparse(bs, file, flags, errp);
763 break;
764 case VMDK4_MAGIC:
765 return vmdk_open_vmdk4(bs, file, flags, options, errp);
766 break;
767 default:
768 error_setg(errp, "Image not in VMDK format");
769 return -EINVAL;
770 break;
774 static const char *next_line(const char *s)
776 while (*s) {
777 if (*s == '\n') {
778 return s + 1;
780 s++;
782 return s;
785 static int vmdk_parse_extents(const char *desc, BlockDriverState *bs,
786 const char *desc_file_path, QDict *options,
787 Error **errp)
789 int ret;
790 int matches;
791 char access[11];
792 char type[11];
793 char fname[512];
794 const char *p, *np;
795 int64_t sectors = 0;
796 int64_t flat_offset;
797 char *extent_path;
798 BdrvChild *extent_file;
799 BDRVVmdkState *s = bs->opaque;
800 VmdkExtent *extent;
801 char extent_opt_prefix[32];
802 Error *local_err = NULL;
804 for (p = desc; *p; p = next_line(p)) {
805 /* parse extent line in one of below formats:
807 * RW [size in sectors] FLAT "file-name.vmdk" OFFSET
808 * RW [size in sectors] SPARSE "file-name.vmdk"
809 * RW [size in sectors] VMFS "file-name.vmdk"
810 * RW [size in sectors] VMFSSPARSE "file-name.vmdk"
812 flat_offset = -1;
813 matches = sscanf(p, "%10s %" SCNd64 " %10s \"%511[^\n\r\"]\" %" SCNd64,
814 access, &sectors, type, fname, &flat_offset);
815 if (matches < 4 || strcmp(access, "RW")) {
816 continue;
817 } else if (!strcmp(type, "FLAT")) {
818 if (matches != 5 || flat_offset < 0) {
819 goto invalid;
821 } else if (!strcmp(type, "VMFS")) {
822 if (matches == 4) {
823 flat_offset = 0;
824 } else {
825 goto invalid;
827 } else if (matches != 4) {
828 goto invalid;
831 if (sectors <= 0 ||
832 (strcmp(type, "FLAT") && strcmp(type, "SPARSE") &&
833 strcmp(type, "VMFS") && strcmp(type, "VMFSSPARSE")) ||
834 (strcmp(access, "RW"))) {
835 continue;
838 if (!path_is_absolute(fname) && !path_has_protocol(fname) &&
839 !desc_file_path[0])
841 error_setg(errp, "Cannot use relative extent paths with VMDK "
842 "descriptor file '%s'", bs->file->bs->filename);
843 return -EINVAL;
846 extent_path = g_malloc0(PATH_MAX);
847 path_combine(extent_path, PATH_MAX, desc_file_path, fname);
849 ret = snprintf(extent_opt_prefix, 32, "extents.%d", s->num_extents);
850 assert(ret < 32);
852 extent_file = bdrv_open_child(extent_path, options, extent_opt_prefix,
853 bs, &child_file, false, &local_err);
854 g_free(extent_path);
855 if (local_err) {
856 error_propagate(errp, local_err);
857 return -EINVAL;
860 /* save to extents array */
861 if (!strcmp(type, "FLAT") || !strcmp(type, "VMFS")) {
862 /* FLAT extent */
864 ret = vmdk_add_extent(bs, extent_file, true, sectors,
865 0, 0, 0, 0, 0, &extent, errp);
866 if (ret < 0) {
867 bdrv_unref_child(bs, extent_file);
868 return ret;
870 extent->flat_start_offset = flat_offset << 9;
871 } else if (!strcmp(type, "SPARSE") || !strcmp(type, "VMFSSPARSE")) {
872 /* SPARSE extent and VMFSSPARSE extent are both "COWD" sparse file*/
873 char *buf = vmdk_read_desc(extent_file->bs, 0, errp);
874 if (!buf) {
875 ret = -EINVAL;
876 } else {
877 ret = vmdk_open_sparse(bs, extent_file, bs->open_flags, buf,
878 options, errp);
880 g_free(buf);
881 if (ret) {
882 bdrv_unref_child(bs, extent_file);
883 return ret;
885 extent = &s->extents[s->num_extents - 1];
886 } else {
887 error_setg(errp, "Unsupported extent type '%s'", type);
888 bdrv_unref_child(bs, extent_file);
889 return -ENOTSUP;
891 extent->type = g_strdup(type);
893 return 0;
895 invalid:
896 np = next_line(p);
897 assert(np != p);
898 if (np[-1] == '\n') {
899 np--;
901 error_setg(errp, "Invalid extent line: %.*s", (int)(np - p), p);
902 return -EINVAL;
905 static int vmdk_open_desc_file(BlockDriverState *bs, int flags, char *buf,
906 QDict *options, Error **errp)
908 int ret;
909 char ct[128];
910 BDRVVmdkState *s = bs->opaque;
912 if (vmdk_parse_description(buf, "createType", ct, sizeof(ct))) {
913 error_setg(errp, "invalid VMDK image descriptor");
914 ret = -EINVAL;
915 goto exit;
917 if (strcmp(ct, "monolithicFlat") &&
918 strcmp(ct, "vmfs") &&
919 strcmp(ct, "vmfsSparse") &&
920 strcmp(ct, "twoGbMaxExtentSparse") &&
921 strcmp(ct, "twoGbMaxExtentFlat")) {
922 error_setg(errp, "Unsupported image type '%s'", ct);
923 ret = -ENOTSUP;
924 goto exit;
926 s->create_type = g_strdup(ct);
927 s->desc_offset = 0;
928 ret = vmdk_parse_extents(buf, bs, bs->file->bs->exact_filename, options,
929 errp);
930 exit:
931 return ret;
934 static int vmdk_open(BlockDriverState *bs, QDict *options, int flags,
935 Error **errp)
937 char *buf;
938 int ret;
939 BDRVVmdkState *s = bs->opaque;
940 uint32_t magic;
942 buf = vmdk_read_desc(bs->file->bs, 0, errp);
943 if (!buf) {
944 return -EINVAL;
947 magic = ldl_be_p(buf);
948 switch (magic) {
949 case VMDK3_MAGIC:
950 case VMDK4_MAGIC:
951 ret = vmdk_open_sparse(bs, bs->file, flags, buf, options,
952 errp);
953 s->desc_offset = 0x200;
954 break;
955 default:
956 ret = vmdk_open_desc_file(bs, flags, buf, options, errp);
957 break;
959 if (ret) {
960 goto fail;
963 /* try to open parent images, if exist */
964 ret = vmdk_parent_open(bs);
965 if (ret) {
966 goto fail;
968 s->cid = vmdk_read_cid(bs, 0);
969 s->parent_cid = vmdk_read_cid(bs, 1);
970 qemu_co_mutex_init(&s->lock);
972 /* Disable migration when VMDK images are used */
973 error_setg(&s->migration_blocker, "The vmdk format used by node '%s' "
974 "does not support live migration",
975 bdrv_get_device_or_node_name(bs));
976 migrate_add_blocker(s->migration_blocker);
977 g_free(buf);
978 return 0;
980 fail:
981 g_free(buf);
982 g_free(s->create_type);
983 s->create_type = NULL;
984 vmdk_free_extents(bs);
985 return ret;
989 static void vmdk_refresh_limits(BlockDriverState *bs, Error **errp)
991 BDRVVmdkState *s = bs->opaque;
992 int i;
994 for (i = 0; i < s->num_extents; i++) {
995 if (!s->extents[i].flat) {
996 bs->bl.write_zeroes_alignment =
997 MAX(bs->bl.write_zeroes_alignment,
998 s->extents[i].cluster_sectors);
1004 * get_whole_cluster
1006 * Copy backing file's cluster that covers @sector_num, otherwise write zero,
1007 * to the cluster at @cluster_sector_num.
1009 * If @skip_start_sector < @skip_end_sector, the relative range
1010 * [@skip_start_sector, @skip_end_sector) is not copied or written, and leave
1011 * it for call to write user data in the request.
1013 static int get_whole_cluster(BlockDriverState *bs,
1014 VmdkExtent *extent,
1015 uint64_t cluster_sector_num,
1016 uint64_t sector_num,
1017 uint64_t skip_start_sector,
1018 uint64_t skip_end_sector)
1020 int ret = VMDK_OK;
1021 int64_t cluster_bytes;
1022 uint8_t *whole_grain;
1024 /* For COW, align request sector_num to cluster start */
1025 sector_num = QEMU_ALIGN_DOWN(sector_num, extent->cluster_sectors);
1026 cluster_bytes = extent->cluster_sectors << BDRV_SECTOR_BITS;
1027 whole_grain = qemu_blockalign(bs, cluster_bytes);
1029 if (!bs->backing) {
1030 memset(whole_grain, 0, skip_start_sector << BDRV_SECTOR_BITS);
1031 memset(whole_grain + (skip_end_sector << BDRV_SECTOR_BITS), 0,
1032 cluster_bytes - (skip_end_sector << BDRV_SECTOR_BITS));
1035 assert(skip_end_sector <= extent->cluster_sectors);
1036 /* we will be here if it's first write on non-exist grain(cluster).
1037 * try to read from parent image, if exist */
1038 if (bs->backing && !vmdk_is_cid_valid(bs)) {
1039 ret = VMDK_ERROR;
1040 goto exit;
1043 /* Read backing data before skip range */
1044 if (skip_start_sector > 0) {
1045 if (bs->backing) {
1046 ret = bdrv_read(bs->backing->bs, sector_num,
1047 whole_grain, skip_start_sector);
1048 if (ret < 0) {
1049 ret = VMDK_ERROR;
1050 goto exit;
1053 ret = bdrv_write(extent->file->bs, cluster_sector_num, whole_grain,
1054 skip_start_sector);
1055 if (ret < 0) {
1056 ret = VMDK_ERROR;
1057 goto exit;
1060 /* Read backing data after skip range */
1061 if (skip_end_sector < extent->cluster_sectors) {
1062 if (bs->backing) {
1063 ret = bdrv_read(bs->backing->bs, sector_num + skip_end_sector,
1064 whole_grain + (skip_end_sector << BDRV_SECTOR_BITS),
1065 extent->cluster_sectors - skip_end_sector);
1066 if (ret < 0) {
1067 ret = VMDK_ERROR;
1068 goto exit;
1071 ret = bdrv_write(extent->file->bs, cluster_sector_num + skip_end_sector,
1072 whole_grain + (skip_end_sector << BDRV_SECTOR_BITS),
1073 extent->cluster_sectors - skip_end_sector);
1074 if (ret < 0) {
1075 ret = VMDK_ERROR;
1076 goto exit;
1080 exit:
1081 qemu_vfree(whole_grain);
1082 return ret;
1085 static int vmdk_L2update(VmdkExtent *extent, VmdkMetaData *m_data,
1086 uint32_t offset)
1088 offset = cpu_to_le32(offset);
1089 /* update L2 table */
1090 if (bdrv_pwrite_sync(
1091 extent->file->bs,
1092 ((int64_t)m_data->l2_offset * 512)
1093 + (m_data->l2_index * sizeof(offset)),
1094 &offset, sizeof(offset)) < 0) {
1095 return VMDK_ERROR;
1097 /* update backup L2 table */
1098 if (extent->l1_backup_table_offset != 0) {
1099 m_data->l2_offset = extent->l1_backup_table[m_data->l1_index];
1100 if (bdrv_pwrite_sync(
1101 extent->file->bs,
1102 ((int64_t)m_data->l2_offset * 512)
1103 + (m_data->l2_index * sizeof(offset)),
1104 &offset, sizeof(offset)) < 0) {
1105 return VMDK_ERROR;
1108 if (m_data->l2_cache_entry) {
1109 *m_data->l2_cache_entry = offset;
1112 return VMDK_OK;
1116 * get_cluster_offset
1118 * Look up cluster offset in extent file by sector number, and store in
1119 * @cluster_offset.
1121 * For flat extents, the start offset as parsed from the description file is
1122 * returned.
1124 * For sparse extents, look up in L1, L2 table. If allocate is true, return an
1125 * offset for a new cluster and update L2 cache. If there is a backing file,
1126 * COW is done before returning; otherwise, zeroes are written to the allocated
1127 * cluster. Both COW and zero writing skips the sector range
1128 * [@skip_start_sector, @skip_end_sector) passed in by caller, because caller
1129 * has new data to write there.
1131 * Returns: VMDK_OK if cluster exists and mapped in the image.
1132 * VMDK_UNALLOC if cluster is not mapped and @allocate is false.
1133 * VMDK_ERROR if failed.
1135 static int get_cluster_offset(BlockDriverState *bs,
1136 VmdkExtent *extent,
1137 VmdkMetaData *m_data,
1138 uint64_t offset,
1139 bool allocate,
1140 uint64_t *cluster_offset,
1141 uint64_t skip_start_sector,
1142 uint64_t skip_end_sector)
1144 unsigned int l1_index, l2_offset, l2_index;
1145 int min_index, i, j;
1146 uint32_t min_count, *l2_table;
1147 bool zeroed = false;
1148 int64_t ret;
1149 int64_t cluster_sector;
1151 if (m_data) {
1152 m_data->valid = 0;
1154 if (extent->flat) {
1155 *cluster_offset = extent->flat_start_offset;
1156 return VMDK_OK;
1159 offset -= (extent->end_sector - extent->sectors) * SECTOR_SIZE;
1160 l1_index = (offset >> 9) / extent->l1_entry_sectors;
1161 if (l1_index >= extent->l1_size) {
1162 return VMDK_ERROR;
1164 l2_offset = extent->l1_table[l1_index];
1165 if (!l2_offset) {
1166 return VMDK_UNALLOC;
1168 for (i = 0; i < L2_CACHE_SIZE; i++) {
1169 if (l2_offset == extent->l2_cache_offsets[i]) {
1170 /* increment the hit count */
1171 if (++extent->l2_cache_counts[i] == 0xffffffff) {
1172 for (j = 0; j < L2_CACHE_SIZE; j++) {
1173 extent->l2_cache_counts[j] >>= 1;
1176 l2_table = extent->l2_cache + (i * extent->l2_size);
1177 goto found;
1180 /* not found: load a new entry in the least used one */
1181 min_index = 0;
1182 min_count = 0xffffffff;
1183 for (i = 0; i < L2_CACHE_SIZE; i++) {
1184 if (extent->l2_cache_counts[i] < min_count) {
1185 min_count = extent->l2_cache_counts[i];
1186 min_index = i;
1189 l2_table = extent->l2_cache + (min_index * extent->l2_size);
1190 if (bdrv_pread(
1191 extent->file->bs,
1192 (int64_t)l2_offset * 512,
1193 l2_table,
1194 extent->l2_size * sizeof(uint32_t)
1195 ) != extent->l2_size * sizeof(uint32_t)) {
1196 return VMDK_ERROR;
1199 extent->l2_cache_offsets[min_index] = l2_offset;
1200 extent->l2_cache_counts[min_index] = 1;
1201 found:
1202 l2_index = ((offset >> 9) / extent->cluster_sectors) % extent->l2_size;
1203 cluster_sector = le32_to_cpu(l2_table[l2_index]);
1205 if (m_data) {
1206 m_data->valid = 1;
1207 m_data->l1_index = l1_index;
1208 m_data->l2_index = l2_index;
1209 m_data->l2_offset = l2_offset;
1210 m_data->l2_cache_entry = &l2_table[l2_index];
1212 if (extent->has_zero_grain && cluster_sector == VMDK_GTE_ZEROED) {
1213 zeroed = true;
1216 if (!cluster_sector || zeroed) {
1217 if (!allocate) {
1218 return zeroed ? VMDK_ZEROED : VMDK_UNALLOC;
1221 cluster_sector = extent->next_cluster_sector;
1222 extent->next_cluster_sector += extent->cluster_sectors;
1224 /* First of all we write grain itself, to avoid race condition
1225 * that may to corrupt the image.
1226 * This problem may occur because of insufficient space on host disk
1227 * or inappropriate VM shutdown.
1229 ret = get_whole_cluster(bs, extent,
1230 cluster_sector,
1231 offset >> BDRV_SECTOR_BITS,
1232 skip_start_sector, skip_end_sector);
1233 if (ret) {
1234 return ret;
1237 *cluster_offset = cluster_sector << BDRV_SECTOR_BITS;
1238 return VMDK_OK;
1241 static VmdkExtent *find_extent(BDRVVmdkState *s,
1242 int64_t sector_num, VmdkExtent *start_hint)
1244 VmdkExtent *extent = start_hint;
1246 if (!extent) {
1247 extent = &s->extents[0];
1249 while (extent < &s->extents[s->num_extents]) {
1250 if (sector_num < extent->end_sector) {
1251 return extent;
1253 extent++;
1255 return NULL;
1258 static inline uint64_t vmdk_find_index_in_cluster(VmdkExtent *extent,
1259 int64_t sector_num)
1261 uint64_t index_in_cluster, extent_begin_sector, extent_relative_sector_num;
1263 extent_begin_sector = extent->end_sector - extent->sectors;
1264 extent_relative_sector_num = sector_num - extent_begin_sector;
1265 index_in_cluster = extent_relative_sector_num % extent->cluster_sectors;
1266 return index_in_cluster;
1269 static int64_t coroutine_fn vmdk_co_get_block_status(BlockDriverState *bs,
1270 int64_t sector_num, int nb_sectors, int *pnum, BlockDriverState **file)
1272 BDRVVmdkState *s = bs->opaque;
1273 int64_t index_in_cluster, n, ret;
1274 uint64_t offset;
1275 VmdkExtent *extent;
1277 extent = find_extent(s, sector_num, NULL);
1278 if (!extent) {
1279 return 0;
1281 qemu_co_mutex_lock(&s->lock);
1282 ret = get_cluster_offset(bs, extent, NULL,
1283 sector_num * 512, false, &offset,
1284 0, 0);
1285 qemu_co_mutex_unlock(&s->lock);
1287 index_in_cluster = vmdk_find_index_in_cluster(extent, sector_num);
1288 switch (ret) {
1289 case VMDK_ERROR:
1290 ret = -EIO;
1291 break;
1292 case VMDK_UNALLOC:
1293 ret = 0;
1294 break;
1295 case VMDK_ZEROED:
1296 ret = BDRV_BLOCK_ZERO;
1297 break;
1298 case VMDK_OK:
1299 ret = BDRV_BLOCK_DATA;
1300 if (!extent->compressed) {
1301 ret |= BDRV_BLOCK_OFFSET_VALID;
1302 ret |= (offset + (index_in_cluster << BDRV_SECTOR_BITS))
1303 & BDRV_BLOCK_OFFSET_MASK;
1305 *file = extent->file->bs;
1306 break;
1309 n = extent->cluster_sectors - index_in_cluster;
1310 if (n > nb_sectors) {
1311 n = nb_sectors;
1313 *pnum = n;
1314 return ret;
1317 static int vmdk_write_extent(VmdkExtent *extent, int64_t cluster_offset,
1318 int64_t offset_in_cluster, const uint8_t *buf,
1319 int nb_sectors, int64_t sector_num)
1321 int ret;
1322 VmdkGrainMarker *data = NULL;
1323 uLongf buf_len;
1324 const uint8_t *write_buf = buf;
1325 int write_len = nb_sectors * 512;
1326 int64_t write_offset;
1327 int64_t write_end_sector;
1329 if (extent->compressed) {
1330 if (!extent->has_marker) {
1331 ret = -EINVAL;
1332 goto out;
1334 buf_len = (extent->cluster_sectors << 9) * 2;
1335 data = g_malloc(buf_len + sizeof(VmdkGrainMarker));
1336 if (compress(data->data, &buf_len, buf, nb_sectors << 9) != Z_OK ||
1337 buf_len == 0) {
1338 ret = -EINVAL;
1339 goto out;
1341 data->lba = sector_num;
1342 data->size = buf_len;
1343 write_buf = (uint8_t *)data;
1344 write_len = buf_len + sizeof(VmdkGrainMarker);
1346 write_offset = cluster_offset + offset_in_cluster,
1347 ret = bdrv_pwrite(extent->file->bs, write_offset, write_buf, write_len);
1349 write_end_sector = DIV_ROUND_UP(write_offset + write_len, BDRV_SECTOR_SIZE);
1351 if (extent->compressed) {
1352 extent->next_cluster_sector = write_end_sector;
1353 } else {
1354 extent->next_cluster_sector = MAX(extent->next_cluster_sector,
1355 write_end_sector);
1358 if (ret != write_len) {
1359 ret = ret < 0 ? ret : -EIO;
1360 goto out;
1362 ret = 0;
1363 out:
1364 g_free(data);
1365 return ret;
1368 static int vmdk_read_extent(VmdkExtent *extent, int64_t cluster_offset,
1369 int64_t offset_in_cluster, uint8_t *buf,
1370 int nb_sectors)
1372 int ret;
1373 int cluster_bytes, buf_bytes;
1374 uint8_t *cluster_buf, *compressed_data;
1375 uint8_t *uncomp_buf;
1376 uint32_t data_len;
1377 VmdkGrainMarker *marker;
1378 uLongf buf_len;
1381 if (!extent->compressed) {
1382 ret = bdrv_pread(extent->file->bs,
1383 cluster_offset + offset_in_cluster,
1384 buf, nb_sectors * 512);
1385 if (ret == nb_sectors * 512) {
1386 return 0;
1387 } else {
1388 return -EIO;
1391 cluster_bytes = extent->cluster_sectors * 512;
1392 /* Read two clusters in case GrainMarker + compressed data > one cluster */
1393 buf_bytes = cluster_bytes * 2;
1394 cluster_buf = g_malloc(buf_bytes);
1395 uncomp_buf = g_malloc(cluster_bytes);
1396 ret = bdrv_pread(extent->file->bs,
1397 cluster_offset,
1398 cluster_buf, buf_bytes);
1399 if (ret < 0) {
1400 goto out;
1402 compressed_data = cluster_buf;
1403 buf_len = cluster_bytes;
1404 data_len = cluster_bytes;
1405 if (extent->has_marker) {
1406 marker = (VmdkGrainMarker *)cluster_buf;
1407 compressed_data = marker->data;
1408 data_len = le32_to_cpu(marker->size);
1410 if (!data_len || data_len > buf_bytes) {
1411 ret = -EINVAL;
1412 goto out;
1414 ret = uncompress(uncomp_buf, &buf_len, compressed_data, data_len);
1415 if (ret != Z_OK) {
1416 ret = -EINVAL;
1417 goto out;
1420 if (offset_in_cluster < 0 ||
1421 offset_in_cluster + nb_sectors * 512 > buf_len) {
1422 ret = -EINVAL;
1423 goto out;
1425 memcpy(buf, uncomp_buf + offset_in_cluster, nb_sectors * 512);
1426 ret = 0;
1428 out:
1429 g_free(uncomp_buf);
1430 g_free(cluster_buf);
1431 return ret;
1434 static int vmdk_read(BlockDriverState *bs, int64_t sector_num,
1435 uint8_t *buf, int nb_sectors)
1437 BDRVVmdkState *s = bs->opaque;
1438 int ret;
1439 uint64_t n, index_in_cluster;
1440 VmdkExtent *extent = NULL;
1441 uint64_t cluster_offset;
1443 while (nb_sectors > 0) {
1444 extent = find_extent(s, sector_num, extent);
1445 if (!extent) {
1446 return -EIO;
1448 ret = get_cluster_offset(bs, extent, NULL,
1449 sector_num << 9, false, &cluster_offset,
1450 0, 0);
1451 index_in_cluster = vmdk_find_index_in_cluster(extent, sector_num);
1452 n = extent->cluster_sectors - index_in_cluster;
1453 if (n > nb_sectors) {
1454 n = nb_sectors;
1456 if (ret != VMDK_OK) {
1457 /* if not allocated, try to read from parent image, if exist */
1458 if (bs->backing && ret != VMDK_ZEROED) {
1459 if (!vmdk_is_cid_valid(bs)) {
1460 return -EINVAL;
1462 ret = bdrv_read(bs->backing->bs, sector_num, buf, n);
1463 if (ret < 0) {
1464 return ret;
1466 } else {
1467 memset(buf, 0, 512 * n);
1469 } else {
1470 ret = vmdk_read_extent(extent,
1471 cluster_offset, index_in_cluster * 512,
1472 buf, n);
1473 if (ret) {
1474 return ret;
1477 nb_sectors -= n;
1478 sector_num += n;
1479 buf += n * 512;
1481 return 0;
1484 static coroutine_fn int vmdk_co_read(BlockDriverState *bs, int64_t sector_num,
1485 uint8_t *buf, int nb_sectors)
1487 int ret;
1488 BDRVVmdkState *s = bs->opaque;
1489 qemu_co_mutex_lock(&s->lock);
1490 ret = vmdk_read(bs, sector_num, buf, nb_sectors);
1491 qemu_co_mutex_unlock(&s->lock);
1492 return ret;
1496 * vmdk_write:
1497 * @zeroed: buf is ignored (data is zero), use zeroed_grain GTE feature
1498 * if possible, otherwise return -ENOTSUP.
1499 * @zero_dry_run: used for zeroed == true only, don't update L2 table, just try
1500 * with each cluster. By dry run we can find if the zero write
1501 * is possible without modifying image data.
1503 * Returns: error code with 0 for success.
1505 static int vmdk_write(BlockDriverState *bs, int64_t sector_num,
1506 const uint8_t *buf, int nb_sectors,
1507 bool zeroed, bool zero_dry_run)
1509 BDRVVmdkState *s = bs->opaque;
1510 VmdkExtent *extent = NULL;
1511 int ret;
1512 int64_t index_in_cluster, n;
1513 uint64_t cluster_offset;
1514 VmdkMetaData m_data;
1516 if (sector_num > bs->total_sectors) {
1517 error_report("Wrong offset: sector_num=0x%" PRIx64
1518 " total_sectors=0x%" PRIx64,
1519 sector_num, bs->total_sectors);
1520 return -EIO;
1523 while (nb_sectors > 0) {
1524 extent = find_extent(s, sector_num, extent);
1525 if (!extent) {
1526 return -EIO;
1528 index_in_cluster = vmdk_find_index_in_cluster(extent, sector_num);
1529 n = extent->cluster_sectors - index_in_cluster;
1530 if (n > nb_sectors) {
1531 n = nb_sectors;
1533 ret = get_cluster_offset(bs, extent, &m_data, sector_num << 9,
1534 !(extent->compressed || zeroed),
1535 &cluster_offset,
1536 index_in_cluster, index_in_cluster + n);
1537 if (extent->compressed) {
1538 if (ret == VMDK_OK) {
1539 /* Refuse write to allocated cluster for streamOptimized */
1540 error_report("Could not write to allocated cluster"
1541 " for streamOptimized");
1542 return -EIO;
1543 } else {
1544 /* allocate */
1545 ret = get_cluster_offset(bs, extent, &m_data, sector_num << 9,
1546 true, &cluster_offset, 0, 0);
1549 if (ret == VMDK_ERROR) {
1550 return -EINVAL;
1552 if (zeroed) {
1553 /* Do zeroed write, buf is ignored */
1554 if (extent->has_zero_grain &&
1555 index_in_cluster == 0 &&
1556 n >= extent->cluster_sectors) {
1557 n = extent->cluster_sectors;
1558 if (!zero_dry_run) {
1559 /* update L2 tables */
1560 if (vmdk_L2update(extent, &m_data, VMDK_GTE_ZEROED)
1561 != VMDK_OK) {
1562 return -EIO;
1565 } else {
1566 return -ENOTSUP;
1568 } else {
1569 ret = vmdk_write_extent(extent,
1570 cluster_offset, index_in_cluster * 512,
1571 buf, n, sector_num);
1572 if (ret) {
1573 return ret;
1575 if (m_data.valid) {
1576 /* update L2 tables */
1577 if (vmdk_L2update(extent, &m_data,
1578 cluster_offset >> BDRV_SECTOR_BITS)
1579 != VMDK_OK) {
1580 return -EIO;
1584 nb_sectors -= n;
1585 sector_num += n;
1586 buf += n * 512;
1588 /* update CID on the first write every time the virtual disk is
1589 * opened */
1590 if (!s->cid_updated) {
1591 ret = vmdk_write_cid(bs, g_random_int());
1592 if (ret < 0) {
1593 return ret;
1595 s->cid_updated = true;
1598 return 0;
1601 static coroutine_fn int vmdk_co_write(BlockDriverState *bs, int64_t sector_num,
1602 const uint8_t *buf, int nb_sectors)
1604 int ret;
1605 BDRVVmdkState *s = bs->opaque;
1606 qemu_co_mutex_lock(&s->lock);
1607 ret = vmdk_write(bs, sector_num, buf, nb_sectors, false, false);
1608 qemu_co_mutex_unlock(&s->lock);
1609 return ret;
1612 static int vmdk_write_compressed(BlockDriverState *bs,
1613 int64_t sector_num,
1614 const uint8_t *buf,
1615 int nb_sectors)
1617 BDRVVmdkState *s = bs->opaque;
1618 if (s->num_extents == 1 && s->extents[0].compressed) {
1619 return vmdk_write(bs, sector_num, buf, nb_sectors, false, false);
1620 } else {
1621 return -ENOTSUP;
1625 static int coroutine_fn vmdk_co_write_zeroes(BlockDriverState *bs,
1626 int64_t sector_num,
1627 int nb_sectors,
1628 BdrvRequestFlags flags)
1630 int ret;
1631 BDRVVmdkState *s = bs->opaque;
1632 qemu_co_mutex_lock(&s->lock);
1633 /* write zeroes could fail if sectors not aligned to cluster, test it with
1634 * dry_run == true before really updating image */
1635 ret = vmdk_write(bs, sector_num, NULL, nb_sectors, true, true);
1636 if (!ret) {
1637 ret = vmdk_write(bs, sector_num, NULL, nb_sectors, true, false);
1639 qemu_co_mutex_unlock(&s->lock);
1640 return ret;
1643 static int vmdk_create_extent(const char *filename, int64_t filesize,
1644 bool flat, bool compress, bool zeroed_grain,
1645 QemuOpts *opts, Error **errp)
1647 int ret, i;
1648 BlockDriverState *bs = NULL;
1649 VMDK4Header header;
1650 Error *local_err = NULL;
1651 uint32_t tmp, magic, grains, gd_sectors, gt_size, gt_count;
1652 uint32_t *gd_buf = NULL;
1653 int gd_buf_size;
1655 ret = bdrv_create_file(filename, opts, &local_err);
1656 if (ret < 0) {
1657 error_propagate(errp, local_err);
1658 goto exit;
1661 assert(bs == NULL);
1662 ret = bdrv_open(&bs, filename, NULL, NULL, BDRV_O_RDWR | BDRV_O_PROTOCOL,
1663 &local_err);
1664 if (ret < 0) {
1665 error_propagate(errp, local_err);
1666 goto exit;
1669 if (flat) {
1670 ret = bdrv_truncate(bs, filesize);
1671 if (ret < 0) {
1672 error_setg_errno(errp, -ret, "Could not truncate file");
1674 goto exit;
1676 magic = cpu_to_be32(VMDK4_MAGIC);
1677 memset(&header, 0, sizeof(header));
1678 if (compress) {
1679 header.version = 3;
1680 } else if (zeroed_grain) {
1681 header.version = 2;
1682 } else {
1683 header.version = 1;
1685 header.flags = VMDK4_FLAG_RGD | VMDK4_FLAG_NL_DETECT
1686 | (compress ? VMDK4_FLAG_COMPRESS | VMDK4_FLAG_MARKER : 0)
1687 | (zeroed_grain ? VMDK4_FLAG_ZERO_GRAIN : 0);
1688 header.compressAlgorithm = compress ? VMDK4_COMPRESSION_DEFLATE : 0;
1689 header.capacity = filesize / BDRV_SECTOR_SIZE;
1690 header.granularity = 128;
1691 header.num_gtes_per_gt = BDRV_SECTOR_SIZE;
1693 grains = DIV_ROUND_UP(filesize / BDRV_SECTOR_SIZE, header.granularity);
1694 gt_size = DIV_ROUND_UP(header.num_gtes_per_gt * sizeof(uint32_t),
1695 BDRV_SECTOR_SIZE);
1696 gt_count = DIV_ROUND_UP(grains, header.num_gtes_per_gt);
1697 gd_sectors = DIV_ROUND_UP(gt_count * sizeof(uint32_t), BDRV_SECTOR_SIZE);
1699 header.desc_offset = 1;
1700 header.desc_size = 20;
1701 header.rgd_offset = header.desc_offset + header.desc_size;
1702 header.gd_offset = header.rgd_offset + gd_sectors + (gt_size * gt_count);
1703 header.grain_offset =
1704 ROUND_UP(header.gd_offset + gd_sectors + (gt_size * gt_count),
1705 header.granularity);
1706 /* swap endianness for all header fields */
1707 header.version = cpu_to_le32(header.version);
1708 header.flags = cpu_to_le32(header.flags);
1709 header.capacity = cpu_to_le64(header.capacity);
1710 header.granularity = cpu_to_le64(header.granularity);
1711 header.num_gtes_per_gt = cpu_to_le32(header.num_gtes_per_gt);
1712 header.desc_offset = cpu_to_le64(header.desc_offset);
1713 header.desc_size = cpu_to_le64(header.desc_size);
1714 header.rgd_offset = cpu_to_le64(header.rgd_offset);
1715 header.gd_offset = cpu_to_le64(header.gd_offset);
1716 header.grain_offset = cpu_to_le64(header.grain_offset);
1717 header.compressAlgorithm = cpu_to_le16(header.compressAlgorithm);
1719 header.check_bytes[0] = 0xa;
1720 header.check_bytes[1] = 0x20;
1721 header.check_bytes[2] = 0xd;
1722 header.check_bytes[3] = 0xa;
1724 /* write all the data */
1725 ret = bdrv_pwrite(bs, 0, &magic, sizeof(magic));
1726 if (ret < 0) {
1727 error_setg(errp, QERR_IO_ERROR);
1728 goto exit;
1730 ret = bdrv_pwrite(bs, sizeof(magic), &header, sizeof(header));
1731 if (ret < 0) {
1732 error_setg(errp, QERR_IO_ERROR);
1733 goto exit;
1736 ret = bdrv_truncate(bs, le64_to_cpu(header.grain_offset) << 9);
1737 if (ret < 0) {
1738 error_setg_errno(errp, -ret, "Could not truncate file");
1739 goto exit;
1742 /* write grain directory */
1743 gd_buf_size = gd_sectors * BDRV_SECTOR_SIZE;
1744 gd_buf = g_malloc0(gd_buf_size);
1745 for (i = 0, tmp = le64_to_cpu(header.rgd_offset) + gd_sectors;
1746 i < gt_count; i++, tmp += gt_size) {
1747 gd_buf[i] = cpu_to_le32(tmp);
1749 ret = bdrv_pwrite(bs, le64_to_cpu(header.rgd_offset) * BDRV_SECTOR_SIZE,
1750 gd_buf, gd_buf_size);
1751 if (ret < 0) {
1752 error_setg(errp, QERR_IO_ERROR);
1753 goto exit;
1756 /* write backup grain directory */
1757 for (i = 0, tmp = le64_to_cpu(header.gd_offset) + gd_sectors;
1758 i < gt_count; i++, tmp += gt_size) {
1759 gd_buf[i] = cpu_to_le32(tmp);
1761 ret = bdrv_pwrite(bs, le64_to_cpu(header.gd_offset) * BDRV_SECTOR_SIZE,
1762 gd_buf, gd_buf_size);
1763 if (ret < 0) {
1764 error_setg(errp, QERR_IO_ERROR);
1765 goto exit;
1768 ret = 0;
1769 exit:
1770 if (bs) {
1771 bdrv_unref(bs);
1773 g_free(gd_buf);
1774 return ret;
1777 static int filename_decompose(const char *filename, char *path, char *prefix,
1778 char *postfix, size_t buf_len, Error **errp)
1780 const char *p, *q;
1782 if (filename == NULL || !strlen(filename)) {
1783 error_setg(errp, "No filename provided");
1784 return VMDK_ERROR;
1786 p = strrchr(filename, '/');
1787 if (p == NULL) {
1788 p = strrchr(filename, '\\');
1790 if (p == NULL) {
1791 p = strrchr(filename, ':');
1793 if (p != NULL) {
1794 p++;
1795 if (p - filename >= buf_len) {
1796 return VMDK_ERROR;
1798 pstrcpy(path, p - filename + 1, filename);
1799 } else {
1800 p = filename;
1801 path[0] = '\0';
1803 q = strrchr(p, '.');
1804 if (q == NULL) {
1805 pstrcpy(prefix, buf_len, p);
1806 postfix[0] = '\0';
1807 } else {
1808 if (q - p >= buf_len) {
1809 return VMDK_ERROR;
1811 pstrcpy(prefix, q - p + 1, p);
1812 pstrcpy(postfix, buf_len, q);
1814 return VMDK_OK;
1817 static int vmdk_create(const char *filename, QemuOpts *opts, Error **errp)
1819 int idx = 0;
1820 BlockDriverState *new_bs = NULL;
1821 Error *local_err = NULL;
1822 char *desc = NULL;
1823 int64_t total_size = 0, filesize;
1824 char *adapter_type = NULL;
1825 char *backing_file = NULL;
1826 char *fmt = NULL;
1827 int flags = 0;
1828 int ret = 0;
1829 bool flat, split, compress;
1830 GString *ext_desc_lines;
1831 char *path = g_malloc0(PATH_MAX);
1832 char *prefix = g_malloc0(PATH_MAX);
1833 char *postfix = g_malloc0(PATH_MAX);
1834 char *desc_line = g_malloc0(BUF_SIZE);
1835 char *ext_filename = g_malloc0(PATH_MAX);
1836 char *desc_filename = g_malloc0(PATH_MAX);
1837 const int64_t split_size = 0x80000000; /* VMDK has constant split size */
1838 const char *desc_extent_line;
1839 char *parent_desc_line = g_malloc0(BUF_SIZE);
1840 uint32_t parent_cid = 0xffffffff;
1841 uint32_t number_heads = 16;
1842 bool zeroed_grain = false;
1843 uint32_t desc_offset = 0, desc_len;
1844 const char desc_template[] =
1845 "# Disk DescriptorFile\n"
1846 "version=1\n"
1847 "CID=%" PRIx32 "\n"
1848 "parentCID=%" PRIx32 "\n"
1849 "createType=\"%s\"\n"
1850 "%s"
1851 "\n"
1852 "# Extent description\n"
1853 "%s"
1854 "\n"
1855 "# The Disk Data Base\n"
1856 "#DDB\n"
1857 "\n"
1858 "ddb.virtualHWVersion = \"%d\"\n"
1859 "ddb.geometry.cylinders = \"%" PRId64 "\"\n"
1860 "ddb.geometry.heads = \"%" PRIu32 "\"\n"
1861 "ddb.geometry.sectors = \"63\"\n"
1862 "ddb.adapterType = \"%s\"\n";
1864 ext_desc_lines = g_string_new(NULL);
1866 if (filename_decompose(filename, path, prefix, postfix, PATH_MAX, errp)) {
1867 ret = -EINVAL;
1868 goto exit;
1870 /* Read out options */
1871 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
1872 BDRV_SECTOR_SIZE);
1873 adapter_type = qemu_opt_get_del(opts, BLOCK_OPT_ADAPTER_TYPE);
1874 backing_file = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FILE);
1875 if (qemu_opt_get_bool_del(opts, BLOCK_OPT_COMPAT6, false)) {
1876 flags |= BLOCK_FLAG_COMPAT6;
1878 fmt = qemu_opt_get_del(opts, BLOCK_OPT_SUBFMT);
1879 if (qemu_opt_get_bool_del(opts, BLOCK_OPT_ZEROED_GRAIN, false)) {
1880 zeroed_grain = true;
1883 if (!adapter_type) {
1884 adapter_type = g_strdup("ide");
1885 } else if (strcmp(adapter_type, "ide") &&
1886 strcmp(adapter_type, "buslogic") &&
1887 strcmp(adapter_type, "lsilogic") &&
1888 strcmp(adapter_type, "legacyESX")) {
1889 error_setg(errp, "Unknown adapter type: '%s'", adapter_type);
1890 ret = -EINVAL;
1891 goto exit;
1893 if (strcmp(adapter_type, "ide") != 0) {
1894 /* that's the number of heads with which vmware operates when
1895 creating, exporting, etc. vmdk files with a non-ide adapter type */
1896 number_heads = 255;
1898 if (!fmt) {
1899 /* Default format to monolithicSparse */
1900 fmt = g_strdup("monolithicSparse");
1901 } else if (strcmp(fmt, "monolithicFlat") &&
1902 strcmp(fmt, "monolithicSparse") &&
1903 strcmp(fmt, "twoGbMaxExtentSparse") &&
1904 strcmp(fmt, "twoGbMaxExtentFlat") &&
1905 strcmp(fmt, "streamOptimized")) {
1906 error_setg(errp, "Unknown subformat: '%s'", fmt);
1907 ret = -EINVAL;
1908 goto exit;
1910 split = !(strcmp(fmt, "twoGbMaxExtentFlat") &&
1911 strcmp(fmt, "twoGbMaxExtentSparse"));
1912 flat = !(strcmp(fmt, "monolithicFlat") &&
1913 strcmp(fmt, "twoGbMaxExtentFlat"));
1914 compress = !strcmp(fmt, "streamOptimized");
1915 if (flat) {
1916 desc_extent_line = "RW %" PRId64 " FLAT \"%s\" 0\n";
1917 } else {
1918 desc_extent_line = "RW %" PRId64 " SPARSE \"%s\"\n";
1920 if (flat && backing_file) {
1921 error_setg(errp, "Flat image can't have backing file");
1922 ret = -ENOTSUP;
1923 goto exit;
1925 if (flat && zeroed_grain) {
1926 error_setg(errp, "Flat image can't enable zeroed grain");
1927 ret = -ENOTSUP;
1928 goto exit;
1930 if (backing_file) {
1931 BlockDriverState *bs = NULL;
1932 char *full_backing = g_new0(char, PATH_MAX);
1933 bdrv_get_full_backing_filename_from_filename(filename, backing_file,
1934 full_backing, PATH_MAX,
1935 &local_err);
1936 if (local_err) {
1937 g_free(full_backing);
1938 error_propagate(errp, local_err);
1939 ret = -ENOENT;
1940 goto exit;
1942 ret = bdrv_open(&bs, full_backing, NULL, NULL, BDRV_O_NO_BACKING, errp);
1943 g_free(full_backing);
1944 if (ret != 0) {
1945 goto exit;
1947 if (strcmp(bs->drv->format_name, "vmdk")) {
1948 bdrv_unref(bs);
1949 ret = -EINVAL;
1950 goto exit;
1952 parent_cid = vmdk_read_cid(bs, 0);
1953 bdrv_unref(bs);
1954 snprintf(parent_desc_line, BUF_SIZE,
1955 "parentFileNameHint=\"%s\"", backing_file);
1958 /* Create extents */
1959 filesize = total_size;
1960 while (filesize > 0) {
1961 int64_t size = filesize;
1963 if (split && size > split_size) {
1964 size = split_size;
1966 if (split) {
1967 snprintf(desc_filename, PATH_MAX, "%s-%c%03d%s",
1968 prefix, flat ? 'f' : 's', ++idx, postfix);
1969 } else if (flat) {
1970 snprintf(desc_filename, PATH_MAX, "%s-flat%s", prefix, postfix);
1971 } else {
1972 snprintf(desc_filename, PATH_MAX, "%s%s", prefix, postfix);
1974 snprintf(ext_filename, PATH_MAX, "%s%s", path, desc_filename);
1976 if (vmdk_create_extent(ext_filename, size,
1977 flat, compress, zeroed_grain, opts, errp)) {
1978 ret = -EINVAL;
1979 goto exit;
1981 filesize -= size;
1983 /* Format description line */
1984 snprintf(desc_line, BUF_SIZE,
1985 desc_extent_line, size / BDRV_SECTOR_SIZE, desc_filename);
1986 g_string_append(ext_desc_lines, desc_line);
1988 /* generate descriptor file */
1989 desc = g_strdup_printf(desc_template,
1990 g_random_int(),
1991 parent_cid,
1992 fmt,
1993 parent_desc_line,
1994 ext_desc_lines->str,
1995 (flags & BLOCK_FLAG_COMPAT6 ? 6 : 4),
1996 total_size /
1997 (int64_t)(63 * number_heads * BDRV_SECTOR_SIZE),
1998 number_heads,
1999 adapter_type);
2000 desc_len = strlen(desc);
2001 /* the descriptor offset = 0x200 */
2002 if (!split && !flat) {
2003 desc_offset = 0x200;
2004 } else {
2005 ret = bdrv_create_file(filename, opts, &local_err);
2006 if (ret < 0) {
2007 error_propagate(errp, local_err);
2008 goto exit;
2011 assert(new_bs == NULL);
2012 ret = bdrv_open(&new_bs, filename, NULL, NULL,
2013 BDRV_O_RDWR | BDRV_O_PROTOCOL, &local_err);
2014 if (ret < 0) {
2015 error_propagate(errp, local_err);
2016 goto exit;
2018 ret = bdrv_pwrite(new_bs, desc_offset, desc, desc_len);
2019 if (ret < 0) {
2020 error_setg_errno(errp, -ret, "Could not write description");
2021 goto exit;
2023 /* bdrv_pwrite write padding zeros to align to sector, we don't need that
2024 * for description file */
2025 if (desc_offset == 0) {
2026 ret = bdrv_truncate(new_bs, desc_len);
2027 if (ret < 0) {
2028 error_setg_errno(errp, -ret, "Could not truncate file");
2031 exit:
2032 if (new_bs) {
2033 bdrv_unref(new_bs);
2035 g_free(adapter_type);
2036 g_free(backing_file);
2037 g_free(fmt);
2038 g_free(desc);
2039 g_free(path);
2040 g_free(prefix);
2041 g_free(postfix);
2042 g_free(desc_line);
2043 g_free(ext_filename);
2044 g_free(desc_filename);
2045 g_free(parent_desc_line);
2046 g_string_free(ext_desc_lines, true);
2047 return ret;
2050 static void vmdk_close(BlockDriverState *bs)
2052 BDRVVmdkState *s = bs->opaque;
2054 vmdk_free_extents(bs);
2055 g_free(s->create_type);
2057 migrate_del_blocker(s->migration_blocker);
2058 error_free(s->migration_blocker);
2061 static coroutine_fn int vmdk_co_flush(BlockDriverState *bs)
2063 BDRVVmdkState *s = bs->opaque;
2064 int i, err;
2065 int ret = 0;
2067 for (i = 0; i < s->num_extents; i++) {
2068 err = bdrv_co_flush(s->extents[i].file->bs);
2069 if (err < 0) {
2070 ret = err;
2073 return ret;
2076 static int64_t vmdk_get_allocated_file_size(BlockDriverState *bs)
2078 int i;
2079 int64_t ret = 0;
2080 int64_t r;
2081 BDRVVmdkState *s = bs->opaque;
2083 ret = bdrv_get_allocated_file_size(bs->file->bs);
2084 if (ret < 0) {
2085 return ret;
2087 for (i = 0; i < s->num_extents; i++) {
2088 if (s->extents[i].file == bs->file) {
2089 continue;
2091 r = bdrv_get_allocated_file_size(s->extents[i].file->bs);
2092 if (r < 0) {
2093 return r;
2095 ret += r;
2097 return ret;
2100 static int vmdk_has_zero_init(BlockDriverState *bs)
2102 int i;
2103 BDRVVmdkState *s = bs->opaque;
2105 /* If has a flat extent and its underlying storage doesn't have zero init,
2106 * return 0. */
2107 for (i = 0; i < s->num_extents; i++) {
2108 if (s->extents[i].flat) {
2109 if (!bdrv_has_zero_init(s->extents[i].file->bs)) {
2110 return 0;
2114 return 1;
2117 static ImageInfo *vmdk_get_extent_info(VmdkExtent *extent)
2119 ImageInfo *info = g_new0(ImageInfo, 1);
2121 *info = (ImageInfo){
2122 .filename = g_strdup(extent->file->bs->filename),
2123 .format = g_strdup(extent->type),
2124 .virtual_size = extent->sectors * BDRV_SECTOR_SIZE,
2125 .compressed = extent->compressed,
2126 .has_compressed = extent->compressed,
2127 .cluster_size = extent->cluster_sectors * BDRV_SECTOR_SIZE,
2128 .has_cluster_size = !extent->flat,
2131 return info;
2134 static int vmdk_check(BlockDriverState *bs, BdrvCheckResult *result,
2135 BdrvCheckMode fix)
2137 BDRVVmdkState *s = bs->opaque;
2138 VmdkExtent *extent = NULL;
2139 int64_t sector_num = 0;
2140 int64_t total_sectors = bdrv_nb_sectors(bs);
2141 int ret;
2142 uint64_t cluster_offset;
2144 if (fix) {
2145 return -ENOTSUP;
2148 for (;;) {
2149 if (sector_num >= total_sectors) {
2150 return 0;
2152 extent = find_extent(s, sector_num, extent);
2153 if (!extent) {
2154 fprintf(stderr,
2155 "ERROR: could not find extent for sector %" PRId64 "\n",
2156 sector_num);
2157 break;
2159 ret = get_cluster_offset(bs, extent, NULL,
2160 sector_num << BDRV_SECTOR_BITS,
2161 false, &cluster_offset, 0, 0);
2162 if (ret == VMDK_ERROR) {
2163 fprintf(stderr,
2164 "ERROR: could not get cluster_offset for sector %"
2165 PRId64 "\n", sector_num);
2166 break;
2168 if (ret == VMDK_OK &&
2169 cluster_offset >= bdrv_getlength(extent->file->bs))
2171 fprintf(stderr,
2172 "ERROR: cluster offset for sector %"
2173 PRId64 " points after EOF\n", sector_num);
2174 break;
2176 sector_num += extent->cluster_sectors;
2179 result->corruptions++;
2180 return 0;
2183 static ImageInfoSpecific *vmdk_get_specific_info(BlockDriverState *bs)
2185 int i;
2186 BDRVVmdkState *s = bs->opaque;
2187 ImageInfoSpecific *spec_info = g_new0(ImageInfoSpecific, 1);
2188 ImageInfoList **next;
2190 *spec_info = (ImageInfoSpecific){
2191 .type = IMAGE_INFO_SPECIFIC_KIND_VMDK,
2193 .vmdk = g_new0(ImageInfoSpecificVmdk, 1),
2197 *spec_info->u.vmdk = (ImageInfoSpecificVmdk) {
2198 .create_type = g_strdup(s->create_type),
2199 .cid = s->cid,
2200 .parent_cid = s->parent_cid,
2203 next = &spec_info->u.vmdk->extents;
2204 for (i = 0; i < s->num_extents; i++) {
2205 *next = g_new0(ImageInfoList, 1);
2206 (*next)->value = vmdk_get_extent_info(&s->extents[i]);
2207 (*next)->next = NULL;
2208 next = &(*next)->next;
2211 return spec_info;
2214 static bool vmdk_extents_type_eq(const VmdkExtent *a, const VmdkExtent *b)
2216 return a->flat == b->flat &&
2217 a->compressed == b->compressed &&
2218 (a->flat || a->cluster_sectors == b->cluster_sectors);
2221 static int vmdk_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
2223 int i;
2224 BDRVVmdkState *s = bs->opaque;
2225 assert(s->num_extents);
2227 /* See if we have multiple extents but they have different cases */
2228 for (i = 1; i < s->num_extents; i++) {
2229 if (!vmdk_extents_type_eq(&s->extents[0], &s->extents[i])) {
2230 return -ENOTSUP;
2233 bdi->needs_compressed_writes = s->extents[0].compressed;
2234 if (!s->extents[0].flat) {
2235 bdi->cluster_size = s->extents[0].cluster_sectors << BDRV_SECTOR_BITS;
2237 return 0;
2240 static void vmdk_detach_aio_context(BlockDriverState *bs)
2242 BDRVVmdkState *s = bs->opaque;
2243 int i;
2245 for (i = 0; i < s->num_extents; i++) {
2246 bdrv_detach_aio_context(s->extents[i].file->bs);
2250 static void vmdk_attach_aio_context(BlockDriverState *bs,
2251 AioContext *new_context)
2253 BDRVVmdkState *s = bs->opaque;
2254 int i;
2256 for (i = 0; i < s->num_extents; i++) {
2257 bdrv_attach_aio_context(s->extents[i].file->bs, new_context);
2261 static QemuOptsList vmdk_create_opts = {
2262 .name = "vmdk-create-opts",
2263 .head = QTAILQ_HEAD_INITIALIZER(vmdk_create_opts.head),
2264 .desc = {
2266 .name = BLOCK_OPT_SIZE,
2267 .type = QEMU_OPT_SIZE,
2268 .help = "Virtual disk size"
2271 .name = BLOCK_OPT_ADAPTER_TYPE,
2272 .type = QEMU_OPT_STRING,
2273 .help = "Virtual adapter type, can be one of "
2274 "ide (default), lsilogic, buslogic or legacyESX"
2277 .name = BLOCK_OPT_BACKING_FILE,
2278 .type = QEMU_OPT_STRING,
2279 .help = "File name of a base image"
2282 .name = BLOCK_OPT_COMPAT6,
2283 .type = QEMU_OPT_BOOL,
2284 .help = "VMDK version 6 image",
2285 .def_value_str = "off"
2288 .name = BLOCK_OPT_SUBFMT,
2289 .type = QEMU_OPT_STRING,
2290 .help =
2291 "VMDK flat extent format, can be one of "
2292 "{monolithicSparse (default) | monolithicFlat | twoGbMaxExtentSparse | twoGbMaxExtentFlat | streamOptimized} "
2295 .name = BLOCK_OPT_ZEROED_GRAIN,
2296 .type = QEMU_OPT_BOOL,
2297 .help = "Enable efficient zero writes "
2298 "using the zeroed-grain GTE feature"
2300 { /* end of list */ }
2304 static BlockDriver bdrv_vmdk = {
2305 .format_name = "vmdk",
2306 .instance_size = sizeof(BDRVVmdkState),
2307 .bdrv_probe = vmdk_probe,
2308 .bdrv_open = vmdk_open,
2309 .bdrv_check = vmdk_check,
2310 .bdrv_reopen_prepare = vmdk_reopen_prepare,
2311 .bdrv_read = vmdk_co_read,
2312 .bdrv_write = vmdk_co_write,
2313 .bdrv_write_compressed = vmdk_write_compressed,
2314 .bdrv_co_write_zeroes = vmdk_co_write_zeroes,
2315 .bdrv_close = vmdk_close,
2316 .bdrv_create = vmdk_create,
2317 .bdrv_co_flush_to_disk = vmdk_co_flush,
2318 .bdrv_co_get_block_status = vmdk_co_get_block_status,
2319 .bdrv_get_allocated_file_size = vmdk_get_allocated_file_size,
2320 .bdrv_has_zero_init = vmdk_has_zero_init,
2321 .bdrv_get_specific_info = vmdk_get_specific_info,
2322 .bdrv_refresh_limits = vmdk_refresh_limits,
2323 .bdrv_get_info = vmdk_get_info,
2324 .bdrv_detach_aio_context = vmdk_detach_aio_context,
2325 .bdrv_attach_aio_context = vmdk_attach_aio_context,
2327 .supports_backing = true,
2328 .create_opts = &vmdk_create_opts,
2331 static void bdrv_vmdk_init(void)
2333 bdrv_register(&bdrv_vmdk);
2336 block_init(bdrv_vmdk_init);