qemu: avoid memory leak while remove disk
[qemu/ar7.git] / block / vmdk.c
blob2c9e86d98f742108bfc4e3beb1186ecfa94b9820
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 "qapi/error.h"
28 #include "block/block_int.h"
29 #include "sysemu/block-backend.h"
30 #include "qapi/qmp/qerror.h"
31 #include "qemu/error-report.h"
32 #include "qemu/module.h"
33 #include "qemu/option.h"
34 #include "qemu/bswap.h"
35 #include "migration/blocker.h"
36 #include "qemu/cutils.h"
37 #include <zlib.h>
39 #define VMDK3_MAGIC (('C' << 24) | ('O' << 16) | ('W' << 8) | 'D')
40 #define VMDK4_MAGIC (('K' << 24) | ('D' << 16) | ('M' << 8) | 'V')
41 #define VMDK4_COMPRESSION_DEFLATE 1
42 #define VMDK4_FLAG_NL_DETECT (1 << 0)
43 #define VMDK4_FLAG_RGD (1 << 1)
44 /* Zeroed-grain enable bit */
45 #define VMDK4_FLAG_ZERO_GRAIN (1 << 2)
46 #define VMDK4_FLAG_COMPRESS (1 << 16)
47 #define VMDK4_FLAG_MARKER (1 << 17)
48 #define VMDK4_GD_AT_END 0xffffffffffffffffULL
50 #define VMDK_EXTENT_MAX_SECTORS (1ULL << 32)
52 #define VMDK_GTE_ZEROED 0x1
54 /* VMDK internal error codes */
55 #define VMDK_OK 0
56 #define VMDK_ERROR (-1)
57 /* Cluster not allocated */
58 #define VMDK_UNALLOC (-2)
59 #define VMDK_ZEROED (-3)
61 #define BLOCK_OPT_ZEROED_GRAIN "zeroed_grain"
63 typedef struct {
64 uint32_t version;
65 uint32_t flags;
66 uint32_t disk_sectors;
67 uint32_t granularity;
68 uint32_t l1dir_offset;
69 uint32_t l1dir_size;
70 uint32_t file_sectors;
71 uint32_t cylinders;
72 uint32_t heads;
73 uint32_t sectors_per_track;
74 } QEMU_PACKED VMDK3Header;
76 typedef struct {
77 uint32_t version;
78 uint32_t flags;
79 uint64_t capacity;
80 uint64_t granularity;
81 uint64_t desc_offset;
82 uint64_t desc_size;
83 /* Number of GrainTableEntries per GrainTable */
84 uint32_t num_gtes_per_gt;
85 uint64_t rgd_offset;
86 uint64_t gd_offset;
87 uint64_t grain_offset;
88 char filler[1];
89 char check_bytes[4];
90 uint16_t compressAlgorithm;
91 } QEMU_PACKED VMDK4Header;
93 #define L2_CACHE_SIZE 16
95 typedef struct VmdkExtent {
96 BdrvChild *file;
97 bool flat;
98 bool compressed;
99 bool has_marker;
100 bool has_zero_grain;
101 int version;
102 int64_t sectors;
103 int64_t end_sector;
104 int64_t flat_start_offset;
105 int64_t l1_table_offset;
106 int64_t l1_backup_table_offset;
107 uint32_t *l1_table;
108 uint32_t *l1_backup_table;
109 unsigned int l1_size;
110 uint32_t l1_entry_sectors;
112 unsigned int l2_size;
113 uint32_t *l2_cache;
114 uint32_t l2_cache_offsets[L2_CACHE_SIZE];
115 uint32_t l2_cache_counts[L2_CACHE_SIZE];
117 int64_t cluster_sectors;
118 int64_t next_cluster_sector;
119 char *type;
120 } VmdkExtent;
122 typedef struct BDRVVmdkState {
123 CoMutex lock;
124 uint64_t desc_offset;
125 bool cid_updated;
126 bool cid_checked;
127 uint32_t cid;
128 uint32_t parent_cid;
129 int num_extents;
130 /* Extent array with num_extents entries, ascend ordered by address */
131 VmdkExtent *extents;
132 Error *migration_blocker;
133 char *create_type;
134 } BDRVVmdkState;
136 typedef struct VmdkMetaData {
137 unsigned int l1_index;
138 unsigned int l2_index;
139 unsigned int l2_offset;
140 int valid;
141 uint32_t *l2_cache_entry;
142 } VmdkMetaData;
144 typedef struct VmdkGrainMarker {
145 uint64_t lba;
146 uint32_t size;
147 uint8_t data[0];
148 } QEMU_PACKED VmdkGrainMarker;
150 enum {
151 MARKER_END_OF_STREAM = 0,
152 MARKER_GRAIN_TABLE = 1,
153 MARKER_GRAIN_DIRECTORY = 2,
154 MARKER_FOOTER = 3,
157 static int vmdk_probe(const uint8_t *buf, int buf_size, const char *filename)
159 uint32_t magic;
161 if (buf_size < 4) {
162 return 0;
164 magic = be32_to_cpu(*(uint32_t *)buf);
165 if (magic == VMDK3_MAGIC ||
166 magic == VMDK4_MAGIC) {
167 return 100;
168 } else {
169 const char *p = (const char *)buf;
170 const char *end = p + buf_size;
171 while (p < end) {
172 if (*p == '#') {
173 /* skip comment line */
174 while (p < end && *p != '\n') {
175 p++;
177 p++;
178 continue;
180 if (*p == ' ') {
181 while (p < end && *p == ' ') {
182 p++;
184 /* skip '\r' if windows line endings used. */
185 if (p < end && *p == '\r') {
186 p++;
188 /* only accept blank lines before 'version=' line */
189 if (p == end || *p != '\n') {
190 return 0;
192 p++;
193 continue;
195 if (end - p >= strlen("version=X\n")) {
196 if (strncmp("version=1\n", p, strlen("version=1\n")) == 0 ||
197 strncmp("version=2\n", p, strlen("version=2\n")) == 0) {
198 return 100;
201 if (end - p >= strlen("version=X\r\n")) {
202 if (strncmp("version=1\r\n", p, strlen("version=1\r\n")) == 0 ||
203 strncmp("version=2\r\n", p, strlen("version=2\r\n")) == 0) {
204 return 100;
207 return 0;
209 return 0;
213 #define SECTOR_SIZE 512
214 #define DESC_SIZE (20 * SECTOR_SIZE) /* 20 sectors of 512 bytes each */
215 #define BUF_SIZE 4096
216 #define HEADER_SIZE 512 /* first sector of 512 bytes */
218 static void vmdk_free_extents(BlockDriverState *bs)
220 int i;
221 BDRVVmdkState *s = bs->opaque;
222 VmdkExtent *e;
224 for (i = 0; i < s->num_extents; i++) {
225 e = &s->extents[i];
226 g_free(e->l1_table);
227 g_free(e->l2_cache);
228 g_free(e->l1_backup_table);
229 g_free(e->type);
230 if (e->file != bs->file) {
231 bdrv_unref_child(bs, e->file);
234 g_free(s->extents);
237 static void vmdk_free_last_extent(BlockDriverState *bs)
239 BDRVVmdkState *s = bs->opaque;
241 if (s->num_extents == 0) {
242 return;
244 s->num_extents--;
245 s->extents = g_renew(VmdkExtent, s->extents, s->num_extents);
248 /* Return -ve errno, or 0 on success and write CID into *pcid. */
249 static int vmdk_read_cid(BlockDriverState *bs, int parent, uint32_t *pcid)
251 char *desc;
252 uint32_t cid;
253 const char *p_name, *cid_str;
254 size_t cid_str_size;
255 BDRVVmdkState *s = bs->opaque;
256 int ret;
258 desc = g_malloc0(DESC_SIZE);
259 ret = bdrv_pread(bs->file, s->desc_offset, desc, DESC_SIZE);
260 if (ret < 0) {
261 goto out;
264 if (parent) {
265 cid_str = "parentCID";
266 cid_str_size = sizeof("parentCID");
267 } else {
268 cid_str = "CID";
269 cid_str_size = sizeof("CID");
272 desc[DESC_SIZE - 1] = '\0';
273 p_name = strstr(desc, cid_str);
274 if (p_name == NULL) {
275 ret = -EINVAL;
276 goto out;
278 p_name += cid_str_size;
279 if (sscanf(p_name, "%" SCNx32, &cid) != 1) {
280 ret = -EINVAL;
281 goto out;
283 *pcid = cid;
284 ret = 0;
286 out:
287 g_free(desc);
288 return ret;
291 static int vmdk_write_cid(BlockDriverState *bs, uint32_t cid)
293 char *desc, *tmp_desc;
294 char *p_name, *tmp_str;
295 BDRVVmdkState *s = bs->opaque;
296 int ret = 0;
298 desc = g_malloc0(DESC_SIZE);
299 tmp_desc = g_malloc0(DESC_SIZE);
300 ret = bdrv_pread(bs->file, s->desc_offset, desc, DESC_SIZE);
301 if (ret < 0) {
302 goto out;
305 desc[DESC_SIZE - 1] = '\0';
306 tmp_str = strstr(desc, "parentCID");
307 if (tmp_str == NULL) {
308 ret = -EINVAL;
309 goto out;
312 pstrcpy(tmp_desc, DESC_SIZE, tmp_str);
313 p_name = strstr(desc, "CID");
314 if (p_name != NULL) {
315 p_name += sizeof("CID");
316 snprintf(p_name, DESC_SIZE - (p_name - desc), "%" PRIx32 "\n", cid);
317 pstrcat(desc, DESC_SIZE, tmp_desc);
320 ret = bdrv_pwrite_sync(bs->file, s->desc_offset, desc, DESC_SIZE);
322 out:
323 g_free(desc);
324 g_free(tmp_desc);
325 return ret;
328 static int vmdk_is_cid_valid(BlockDriverState *bs)
330 BDRVVmdkState *s = bs->opaque;
331 uint32_t cur_pcid;
333 if (!s->cid_checked && bs->backing) {
334 BlockDriverState *p_bs = bs->backing->bs;
336 if (strcmp(p_bs->drv->format_name, "vmdk")) {
337 /* Backing file is not in vmdk format, so it does not have
338 * a CID, which makes the overlay's parent CID invalid */
339 return 0;
342 if (vmdk_read_cid(p_bs, 0, &cur_pcid) != 0) {
343 /* read failure: report as not valid */
344 return 0;
346 if (s->parent_cid != cur_pcid) {
347 /* CID not valid */
348 return 0;
351 s->cid_checked = true;
352 /* CID valid */
353 return 1;
356 /* We have nothing to do for VMDK reopen, stubs just return success */
357 static int vmdk_reopen_prepare(BDRVReopenState *state,
358 BlockReopenQueue *queue, Error **errp)
360 assert(state != NULL);
361 assert(state->bs != NULL);
362 return 0;
365 static int vmdk_parent_open(BlockDriverState *bs)
367 char *p_name;
368 char *desc;
369 BDRVVmdkState *s = bs->opaque;
370 int ret;
372 desc = g_malloc0(DESC_SIZE + 1);
373 ret = bdrv_pread(bs->file, s->desc_offset, desc, DESC_SIZE);
374 if (ret < 0) {
375 goto out;
377 ret = 0;
379 p_name = strstr(desc, "parentFileNameHint");
380 if (p_name != NULL) {
381 char *end_name;
383 p_name += sizeof("parentFileNameHint") + 1;
384 end_name = strchr(p_name, '\"');
385 if (end_name == NULL) {
386 ret = -EINVAL;
387 goto out;
389 if ((end_name - p_name) > sizeof(bs->backing_file) - 1) {
390 ret = -EINVAL;
391 goto out;
394 pstrcpy(bs->backing_file, end_name - p_name + 1, p_name);
397 out:
398 g_free(desc);
399 return ret;
402 /* Create and append extent to the extent array. Return the added VmdkExtent
403 * address. return NULL if allocation failed. */
404 static int vmdk_add_extent(BlockDriverState *bs,
405 BdrvChild *file, bool flat, int64_t sectors,
406 int64_t l1_offset, int64_t l1_backup_offset,
407 uint32_t l1_size,
408 int l2_size, uint64_t cluster_sectors,
409 VmdkExtent **new_extent,
410 Error **errp)
412 VmdkExtent *extent;
413 BDRVVmdkState *s = bs->opaque;
414 int64_t nb_sectors;
416 if (cluster_sectors > 0x200000) {
417 /* 0x200000 * 512Bytes = 1GB for one cluster is unrealistic */
418 error_setg(errp, "Invalid granularity, image may be corrupt");
419 return -EFBIG;
421 if (l1_size > 512 * 1024 * 1024) {
422 /* Although with big capacity and small l1_entry_sectors, we can get a
423 * big l1_size, we don't want unbounded value to allocate the table.
424 * Limit it to 512M, which is 16PB for default cluster and L2 table
425 * size */
426 error_setg(errp, "L1 size too big");
427 return -EFBIG;
430 nb_sectors = bdrv_nb_sectors(file->bs);
431 if (nb_sectors < 0) {
432 return nb_sectors;
435 s->extents = g_renew(VmdkExtent, s->extents, s->num_extents + 1);
436 extent = &s->extents[s->num_extents];
437 s->num_extents++;
439 memset(extent, 0, sizeof(VmdkExtent));
440 extent->file = file;
441 extent->flat = flat;
442 extent->sectors = sectors;
443 extent->l1_table_offset = l1_offset;
444 extent->l1_backup_table_offset = l1_backup_offset;
445 extent->l1_size = l1_size;
446 extent->l1_entry_sectors = l2_size * cluster_sectors;
447 extent->l2_size = l2_size;
448 extent->cluster_sectors = flat ? sectors : cluster_sectors;
449 extent->next_cluster_sector = ROUND_UP(nb_sectors, cluster_sectors);
451 if (s->num_extents > 1) {
452 extent->end_sector = (*(extent - 1)).end_sector + extent->sectors;
453 } else {
454 extent->end_sector = extent->sectors;
456 bs->total_sectors = extent->end_sector;
457 if (new_extent) {
458 *new_extent = extent;
460 return 0;
463 static int vmdk_init_tables(BlockDriverState *bs, VmdkExtent *extent,
464 Error **errp)
466 int ret;
467 size_t l1_size;
468 int i;
470 /* read the L1 table */
471 l1_size = extent->l1_size * sizeof(uint32_t);
472 extent->l1_table = g_try_malloc(l1_size);
473 if (l1_size && extent->l1_table == NULL) {
474 return -ENOMEM;
477 ret = bdrv_pread(extent->file,
478 extent->l1_table_offset,
479 extent->l1_table,
480 l1_size);
481 if (ret < 0) {
482 error_setg_errno(errp, -ret,
483 "Could not read l1 table from extent '%s'",
484 extent->file->bs->filename);
485 goto fail_l1;
487 for (i = 0; i < extent->l1_size; i++) {
488 le32_to_cpus(&extent->l1_table[i]);
491 if (extent->l1_backup_table_offset) {
492 extent->l1_backup_table = g_try_malloc(l1_size);
493 if (l1_size && extent->l1_backup_table == NULL) {
494 ret = -ENOMEM;
495 goto fail_l1;
497 ret = bdrv_pread(extent->file,
498 extent->l1_backup_table_offset,
499 extent->l1_backup_table,
500 l1_size);
501 if (ret < 0) {
502 error_setg_errno(errp, -ret,
503 "Could not read l1 backup table from extent '%s'",
504 extent->file->bs->filename);
505 goto fail_l1b;
507 for (i = 0; i < extent->l1_size; i++) {
508 le32_to_cpus(&extent->l1_backup_table[i]);
512 extent->l2_cache =
513 g_new(uint32_t, extent->l2_size * L2_CACHE_SIZE);
514 return 0;
515 fail_l1b:
516 g_free(extent->l1_backup_table);
517 fail_l1:
518 g_free(extent->l1_table);
519 return ret;
522 static int vmdk_open_vmfs_sparse(BlockDriverState *bs,
523 BdrvChild *file,
524 int flags, Error **errp)
526 int ret;
527 uint32_t magic;
528 VMDK3Header header;
529 VmdkExtent *extent;
531 ret = bdrv_pread(file, sizeof(magic), &header, sizeof(header));
532 if (ret < 0) {
533 error_setg_errno(errp, -ret,
534 "Could not read header from file '%s'",
535 file->bs->filename);
536 return ret;
538 ret = vmdk_add_extent(bs, file, false,
539 le32_to_cpu(header.disk_sectors),
540 (int64_t)le32_to_cpu(header.l1dir_offset) << 9,
542 le32_to_cpu(header.l1dir_size),
543 4096,
544 le32_to_cpu(header.granularity),
545 &extent,
546 errp);
547 if (ret < 0) {
548 return ret;
550 ret = vmdk_init_tables(bs, extent, errp);
551 if (ret) {
552 /* free extent allocated by vmdk_add_extent */
553 vmdk_free_last_extent(bs);
555 return ret;
558 static int vmdk_open_desc_file(BlockDriverState *bs, int flags, char *buf,
559 QDict *options, Error **errp);
561 static char *vmdk_read_desc(BdrvChild *file, uint64_t desc_offset, Error **errp)
563 int64_t size;
564 char *buf;
565 int ret;
567 size = bdrv_getlength(file->bs);
568 if (size < 0) {
569 error_setg_errno(errp, -size, "Could not access file");
570 return NULL;
573 if (size < 4) {
574 /* Both descriptor file and sparse image must be much larger than 4
575 * bytes, also callers of vmdk_read_desc want to compare the first 4
576 * bytes with VMDK4_MAGIC, let's error out if less is read. */
577 error_setg(errp, "File is too small, not a valid image");
578 return NULL;
581 size = MIN(size, (1 << 20) - 1); /* avoid unbounded allocation */
582 buf = g_malloc(size + 1);
584 ret = bdrv_pread(file, desc_offset, buf, size);
585 if (ret < 0) {
586 error_setg_errno(errp, -ret, "Could not read from file");
587 g_free(buf);
588 return NULL;
590 buf[ret] = 0;
592 return buf;
595 static int vmdk_open_vmdk4(BlockDriverState *bs,
596 BdrvChild *file,
597 int flags, QDict *options, Error **errp)
599 int ret;
600 uint32_t magic;
601 uint32_t l1_size, l1_entry_sectors;
602 VMDK4Header header;
603 VmdkExtent *extent;
604 BDRVVmdkState *s = bs->opaque;
605 int64_t l1_backup_offset = 0;
606 bool compressed;
608 ret = bdrv_pread(file, sizeof(magic), &header, sizeof(header));
609 if (ret < 0) {
610 error_setg_errno(errp, -ret,
611 "Could not read header from file '%s'",
612 file->bs->filename);
613 return -EINVAL;
615 if (header.capacity == 0) {
616 uint64_t desc_offset = le64_to_cpu(header.desc_offset);
617 if (desc_offset) {
618 char *buf = vmdk_read_desc(file, desc_offset << 9, errp);
619 if (!buf) {
620 return -EINVAL;
622 ret = vmdk_open_desc_file(bs, flags, buf, options, errp);
623 g_free(buf);
624 return ret;
628 if (!s->create_type) {
629 s->create_type = g_strdup("monolithicSparse");
632 if (le64_to_cpu(header.gd_offset) == VMDK4_GD_AT_END) {
634 * The footer takes precedence over the header, so read it in. The
635 * footer starts at offset -1024 from the end: One sector for the
636 * footer, and another one for the end-of-stream marker.
638 struct {
639 struct {
640 uint64_t val;
641 uint32_t size;
642 uint32_t type;
643 uint8_t pad[512 - 16];
644 } QEMU_PACKED footer_marker;
646 uint32_t magic;
647 VMDK4Header header;
648 uint8_t pad[512 - 4 - sizeof(VMDK4Header)];
650 struct {
651 uint64_t val;
652 uint32_t size;
653 uint32_t type;
654 uint8_t pad[512 - 16];
655 } QEMU_PACKED eos_marker;
656 } QEMU_PACKED footer;
658 ret = bdrv_pread(file,
659 bs->file->bs->total_sectors * 512 - 1536,
660 &footer, sizeof(footer));
661 if (ret < 0) {
662 error_setg_errno(errp, -ret, "Failed to read footer");
663 return ret;
666 /* Some sanity checks for the footer */
667 if (be32_to_cpu(footer.magic) != VMDK4_MAGIC ||
668 le32_to_cpu(footer.footer_marker.size) != 0 ||
669 le32_to_cpu(footer.footer_marker.type) != MARKER_FOOTER ||
670 le64_to_cpu(footer.eos_marker.val) != 0 ||
671 le32_to_cpu(footer.eos_marker.size) != 0 ||
672 le32_to_cpu(footer.eos_marker.type) != MARKER_END_OF_STREAM)
674 error_setg(errp, "Invalid footer");
675 return -EINVAL;
678 header = footer.header;
681 compressed =
682 le16_to_cpu(header.compressAlgorithm) == VMDK4_COMPRESSION_DEFLATE;
683 if (le32_to_cpu(header.version) > 3) {
684 error_setg(errp, "Unsupported VMDK version %" PRIu32,
685 le32_to_cpu(header.version));
686 return -ENOTSUP;
687 } else if (le32_to_cpu(header.version) == 3 && (flags & BDRV_O_RDWR) &&
688 !compressed) {
689 /* VMware KB 2064959 explains that version 3 added support for
690 * persistent changed block tracking (CBT), and backup software can
691 * read it as version=1 if it doesn't care about the changed area
692 * information. So we are safe to enable read only. */
693 error_setg(errp, "VMDK version 3 must be read only");
694 return -EINVAL;
697 if (le32_to_cpu(header.num_gtes_per_gt) > 512) {
698 error_setg(errp, "L2 table size too big");
699 return -EINVAL;
702 l1_entry_sectors = le32_to_cpu(header.num_gtes_per_gt)
703 * le64_to_cpu(header.granularity);
704 if (l1_entry_sectors == 0) {
705 error_setg(errp, "L1 entry size is invalid");
706 return -EINVAL;
708 l1_size = (le64_to_cpu(header.capacity) + l1_entry_sectors - 1)
709 / l1_entry_sectors;
710 if (le32_to_cpu(header.flags) & VMDK4_FLAG_RGD) {
711 l1_backup_offset = le64_to_cpu(header.rgd_offset) << 9;
713 if (bdrv_nb_sectors(file->bs) < le64_to_cpu(header.grain_offset)) {
714 error_setg(errp, "File truncated, expecting at least %" PRId64 " bytes",
715 (int64_t)(le64_to_cpu(header.grain_offset)
716 * BDRV_SECTOR_SIZE));
717 return -EINVAL;
720 ret = vmdk_add_extent(bs, file, false,
721 le64_to_cpu(header.capacity),
722 le64_to_cpu(header.gd_offset) << 9,
723 l1_backup_offset,
724 l1_size,
725 le32_to_cpu(header.num_gtes_per_gt),
726 le64_to_cpu(header.granularity),
727 &extent,
728 errp);
729 if (ret < 0) {
730 return ret;
732 extent->compressed =
733 le16_to_cpu(header.compressAlgorithm) == VMDK4_COMPRESSION_DEFLATE;
734 if (extent->compressed) {
735 g_free(s->create_type);
736 s->create_type = g_strdup("streamOptimized");
738 extent->has_marker = le32_to_cpu(header.flags) & VMDK4_FLAG_MARKER;
739 extent->version = le32_to_cpu(header.version);
740 extent->has_zero_grain = le32_to_cpu(header.flags) & VMDK4_FLAG_ZERO_GRAIN;
741 ret = vmdk_init_tables(bs, extent, errp);
742 if (ret) {
743 /* free extent allocated by vmdk_add_extent */
744 vmdk_free_last_extent(bs);
746 return ret;
749 /* find an option value out of descriptor file */
750 static int vmdk_parse_description(const char *desc, const char *opt_name,
751 char *buf, int buf_size)
753 char *opt_pos, *opt_end;
754 const char *end = desc + strlen(desc);
756 opt_pos = strstr(desc, opt_name);
757 if (!opt_pos) {
758 return VMDK_ERROR;
760 /* Skip "=\"" following opt_name */
761 opt_pos += strlen(opt_name) + 2;
762 if (opt_pos >= end) {
763 return VMDK_ERROR;
765 opt_end = opt_pos;
766 while (opt_end < end && *opt_end != '"') {
767 opt_end++;
769 if (opt_end == end || buf_size < opt_end - opt_pos + 1) {
770 return VMDK_ERROR;
772 pstrcpy(buf, opt_end - opt_pos + 1, opt_pos);
773 return VMDK_OK;
776 /* Open an extent file and append to bs array */
777 static int vmdk_open_sparse(BlockDriverState *bs, BdrvChild *file, int flags,
778 char *buf, QDict *options, Error **errp)
780 uint32_t magic;
782 magic = ldl_be_p(buf);
783 switch (magic) {
784 case VMDK3_MAGIC:
785 return vmdk_open_vmfs_sparse(bs, file, flags, errp);
786 break;
787 case VMDK4_MAGIC:
788 return vmdk_open_vmdk4(bs, file, flags, options, errp);
789 break;
790 default:
791 error_setg(errp, "Image not in VMDK format");
792 return -EINVAL;
793 break;
797 static const char *next_line(const char *s)
799 while (*s) {
800 if (*s == '\n') {
801 return s + 1;
803 s++;
805 return s;
808 static int vmdk_parse_extents(const char *desc, BlockDriverState *bs,
809 const char *desc_file_path, QDict *options,
810 Error **errp)
812 int ret;
813 int matches;
814 char access[11];
815 char type[11];
816 char fname[512];
817 const char *p, *np;
818 int64_t sectors = 0;
819 int64_t flat_offset;
820 char *extent_path;
821 BdrvChild *extent_file;
822 BDRVVmdkState *s = bs->opaque;
823 VmdkExtent *extent;
824 char extent_opt_prefix[32];
825 Error *local_err = NULL;
827 for (p = desc; *p; p = next_line(p)) {
828 /* parse extent line in one of below formats:
830 * RW [size in sectors] FLAT "file-name.vmdk" OFFSET
831 * RW [size in sectors] SPARSE "file-name.vmdk"
832 * RW [size in sectors] VMFS "file-name.vmdk"
833 * RW [size in sectors] VMFSSPARSE "file-name.vmdk"
835 flat_offset = -1;
836 matches = sscanf(p, "%10s %" SCNd64 " %10s \"%511[^\n\r\"]\" %" SCNd64,
837 access, &sectors, type, fname, &flat_offset);
838 if (matches < 4 || strcmp(access, "RW")) {
839 continue;
840 } else if (!strcmp(type, "FLAT")) {
841 if (matches != 5 || flat_offset < 0) {
842 goto invalid;
844 } else if (!strcmp(type, "VMFS")) {
845 if (matches == 4) {
846 flat_offset = 0;
847 } else {
848 goto invalid;
850 } else if (matches != 4) {
851 goto invalid;
854 if (sectors <= 0 ||
855 (strcmp(type, "FLAT") && strcmp(type, "SPARSE") &&
856 strcmp(type, "VMFS") && strcmp(type, "VMFSSPARSE")) ||
857 (strcmp(access, "RW"))) {
858 continue;
861 if (!path_is_absolute(fname) && !path_has_protocol(fname) &&
862 !desc_file_path[0])
864 error_setg(errp, "Cannot use relative extent paths with VMDK "
865 "descriptor file '%s'", bs->file->bs->filename);
866 return -EINVAL;
869 extent_path = g_malloc0(PATH_MAX);
870 path_combine(extent_path, PATH_MAX, desc_file_path, fname);
872 ret = snprintf(extent_opt_prefix, 32, "extents.%d", s->num_extents);
873 assert(ret < 32);
875 extent_file = bdrv_open_child(extent_path, options, extent_opt_prefix,
876 bs, &child_file, false, &local_err);
877 g_free(extent_path);
878 if (local_err) {
879 error_propagate(errp, local_err);
880 return -EINVAL;
883 /* save to extents array */
884 if (!strcmp(type, "FLAT") || !strcmp(type, "VMFS")) {
885 /* FLAT extent */
887 ret = vmdk_add_extent(bs, extent_file, true, sectors,
888 0, 0, 0, 0, 0, &extent, errp);
889 if (ret < 0) {
890 bdrv_unref_child(bs, extent_file);
891 return ret;
893 extent->flat_start_offset = flat_offset << 9;
894 } else if (!strcmp(type, "SPARSE") || !strcmp(type, "VMFSSPARSE")) {
895 /* SPARSE extent and VMFSSPARSE extent are both "COWD" sparse file*/
896 char *buf = vmdk_read_desc(extent_file, 0, errp);
897 if (!buf) {
898 ret = -EINVAL;
899 } else {
900 ret = vmdk_open_sparse(bs, extent_file, bs->open_flags, buf,
901 options, errp);
903 g_free(buf);
904 if (ret) {
905 bdrv_unref_child(bs, extent_file);
906 return ret;
908 extent = &s->extents[s->num_extents - 1];
909 } else {
910 error_setg(errp, "Unsupported extent type '%s'", type);
911 bdrv_unref_child(bs, extent_file);
912 return -ENOTSUP;
914 extent->type = g_strdup(type);
916 return 0;
918 invalid:
919 np = next_line(p);
920 assert(np != p);
921 if (np[-1] == '\n') {
922 np--;
924 error_setg(errp, "Invalid extent line: %.*s", (int)(np - p), p);
925 return -EINVAL;
928 static int vmdk_open_desc_file(BlockDriverState *bs, int flags, char *buf,
929 QDict *options, Error **errp)
931 int ret;
932 char ct[128];
933 BDRVVmdkState *s = bs->opaque;
935 if (vmdk_parse_description(buf, "createType", ct, sizeof(ct))) {
936 error_setg(errp, "invalid VMDK image descriptor");
937 ret = -EINVAL;
938 goto exit;
940 if (strcmp(ct, "monolithicFlat") &&
941 strcmp(ct, "vmfs") &&
942 strcmp(ct, "vmfsSparse") &&
943 strcmp(ct, "twoGbMaxExtentSparse") &&
944 strcmp(ct, "twoGbMaxExtentFlat")) {
945 error_setg(errp, "Unsupported image type '%s'", ct);
946 ret = -ENOTSUP;
947 goto exit;
949 s->create_type = g_strdup(ct);
950 s->desc_offset = 0;
951 ret = vmdk_parse_extents(buf, bs, bs->file->bs->exact_filename, options,
952 errp);
953 exit:
954 return ret;
957 static int vmdk_open(BlockDriverState *bs, QDict *options, int flags,
958 Error **errp)
960 char *buf;
961 int ret;
962 BDRVVmdkState *s = bs->opaque;
963 uint32_t magic;
964 Error *local_err = NULL;
966 bs->file = bdrv_open_child(NULL, options, "file", bs, &child_file,
967 false, errp);
968 if (!bs->file) {
969 return -EINVAL;
972 buf = vmdk_read_desc(bs->file, 0, errp);
973 if (!buf) {
974 return -EINVAL;
977 magic = ldl_be_p(buf);
978 switch (magic) {
979 case VMDK3_MAGIC:
980 case VMDK4_MAGIC:
981 ret = vmdk_open_sparse(bs, bs->file, flags, buf, options,
982 errp);
983 s->desc_offset = 0x200;
984 break;
985 default:
986 ret = vmdk_open_desc_file(bs, flags, buf, options, errp);
987 break;
989 if (ret) {
990 goto fail;
993 /* try to open parent images, if exist */
994 ret = vmdk_parent_open(bs);
995 if (ret) {
996 goto fail;
998 ret = vmdk_read_cid(bs, 0, &s->cid);
999 if (ret) {
1000 goto fail;
1002 ret = vmdk_read_cid(bs, 1, &s->parent_cid);
1003 if (ret) {
1004 goto fail;
1006 qemu_co_mutex_init(&s->lock);
1008 /* Disable migration when VMDK images are used */
1009 error_setg(&s->migration_blocker, "The vmdk format used by node '%s' "
1010 "does not support live migration",
1011 bdrv_get_device_or_node_name(bs));
1012 ret = migrate_add_blocker(s->migration_blocker, &local_err);
1013 if (local_err) {
1014 error_propagate(errp, local_err);
1015 error_free(s->migration_blocker);
1016 goto fail;
1019 g_free(buf);
1020 return 0;
1022 fail:
1023 g_free(buf);
1024 g_free(s->create_type);
1025 s->create_type = NULL;
1026 vmdk_free_extents(bs);
1027 return ret;
1031 static void vmdk_refresh_limits(BlockDriverState *bs, Error **errp)
1033 BDRVVmdkState *s = bs->opaque;
1034 int i;
1036 for (i = 0; i < s->num_extents; i++) {
1037 if (!s->extents[i].flat) {
1038 bs->bl.pwrite_zeroes_alignment =
1039 MAX(bs->bl.pwrite_zeroes_alignment,
1040 s->extents[i].cluster_sectors << BDRV_SECTOR_BITS);
1046 * get_whole_cluster
1048 * Copy backing file's cluster that covers @sector_num, otherwise write zero,
1049 * to the cluster at @cluster_sector_num.
1051 * If @skip_start_sector < @skip_end_sector, the relative range
1052 * [@skip_start_sector, @skip_end_sector) is not copied or written, and leave
1053 * it for call to write user data in the request.
1055 static int get_whole_cluster(BlockDriverState *bs,
1056 VmdkExtent *extent,
1057 uint64_t cluster_offset,
1058 uint64_t offset,
1059 uint64_t skip_start_bytes,
1060 uint64_t skip_end_bytes)
1062 int ret = VMDK_OK;
1063 int64_t cluster_bytes;
1064 uint8_t *whole_grain;
1066 /* For COW, align request sector_num to cluster start */
1067 cluster_bytes = extent->cluster_sectors << BDRV_SECTOR_BITS;
1068 offset = QEMU_ALIGN_DOWN(offset, cluster_bytes);
1069 whole_grain = qemu_blockalign(bs, cluster_bytes);
1071 if (!bs->backing) {
1072 memset(whole_grain, 0, skip_start_bytes);
1073 memset(whole_grain + skip_end_bytes, 0, cluster_bytes - skip_end_bytes);
1076 assert(skip_end_bytes <= cluster_bytes);
1077 /* we will be here if it's first write on non-exist grain(cluster).
1078 * try to read from parent image, if exist */
1079 if (bs->backing && !vmdk_is_cid_valid(bs)) {
1080 ret = VMDK_ERROR;
1081 goto exit;
1084 /* Read backing data before skip range */
1085 if (skip_start_bytes > 0) {
1086 if (bs->backing) {
1087 /* qcow2 emits this on bs->file instead of bs->backing */
1088 BLKDBG_EVENT(extent->file, BLKDBG_COW_READ);
1089 ret = bdrv_pread(bs->backing, offset, whole_grain,
1090 skip_start_bytes);
1091 if (ret < 0) {
1092 ret = VMDK_ERROR;
1093 goto exit;
1096 BLKDBG_EVENT(extent->file, BLKDBG_COW_WRITE);
1097 ret = bdrv_pwrite(extent->file, cluster_offset, whole_grain,
1098 skip_start_bytes);
1099 if (ret < 0) {
1100 ret = VMDK_ERROR;
1101 goto exit;
1104 /* Read backing data after skip range */
1105 if (skip_end_bytes < cluster_bytes) {
1106 if (bs->backing) {
1107 /* qcow2 emits this on bs->file instead of bs->backing */
1108 BLKDBG_EVENT(extent->file, BLKDBG_COW_READ);
1109 ret = bdrv_pread(bs->backing, offset + skip_end_bytes,
1110 whole_grain + skip_end_bytes,
1111 cluster_bytes - skip_end_bytes);
1112 if (ret < 0) {
1113 ret = VMDK_ERROR;
1114 goto exit;
1117 BLKDBG_EVENT(extent->file, BLKDBG_COW_WRITE);
1118 ret = bdrv_pwrite(extent->file, cluster_offset + skip_end_bytes,
1119 whole_grain + skip_end_bytes,
1120 cluster_bytes - skip_end_bytes);
1121 if (ret < 0) {
1122 ret = VMDK_ERROR;
1123 goto exit;
1127 ret = VMDK_OK;
1128 exit:
1129 qemu_vfree(whole_grain);
1130 return ret;
1133 static int vmdk_L2update(VmdkExtent *extent, VmdkMetaData *m_data,
1134 uint32_t offset)
1136 offset = cpu_to_le32(offset);
1137 /* update L2 table */
1138 BLKDBG_EVENT(extent->file, BLKDBG_L2_UPDATE);
1139 if (bdrv_pwrite_sync(extent->file,
1140 ((int64_t)m_data->l2_offset * 512)
1141 + (m_data->l2_index * sizeof(offset)),
1142 &offset, sizeof(offset)) < 0) {
1143 return VMDK_ERROR;
1145 /* update backup L2 table */
1146 if (extent->l1_backup_table_offset != 0) {
1147 m_data->l2_offset = extent->l1_backup_table[m_data->l1_index];
1148 if (bdrv_pwrite_sync(extent->file,
1149 ((int64_t)m_data->l2_offset * 512)
1150 + (m_data->l2_index * sizeof(offset)),
1151 &offset, sizeof(offset)) < 0) {
1152 return VMDK_ERROR;
1155 if (m_data->l2_cache_entry) {
1156 *m_data->l2_cache_entry = offset;
1159 return VMDK_OK;
1163 * get_cluster_offset
1165 * Look up cluster offset in extent file by sector number, and store in
1166 * @cluster_offset.
1168 * For flat extents, the start offset as parsed from the description file is
1169 * returned.
1171 * For sparse extents, look up in L1, L2 table. If allocate is true, return an
1172 * offset for a new cluster and update L2 cache. If there is a backing file,
1173 * COW is done before returning; otherwise, zeroes are written to the allocated
1174 * cluster. Both COW and zero writing skips the sector range
1175 * [@skip_start_sector, @skip_end_sector) passed in by caller, because caller
1176 * has new data to write there.
1178 * Returns: VMDK_OK if cluster exists and mapped in the image.
1179 * VMDK_UNALLOC if cluster is not mapped and @allocate is false.
1180 * VMDK_ERROR if failed.
1182 static int get_cluster_offset(BlockDriverState *bs,
1183 VmdkExtent *extent,
1184 VmdkMetaData *m_data,
1185 uint64_t offset,
1186 bool allocate,
1187 uint64_t *cluster_offset,
1188 uint64_t skip_start_bytes,
1189 uint64_t skip_end_bytes)
1191 unsigned int l1_index, l2_offset, l2_index;
1192 int min_index, i, j;
1193 uint32_t min_count, *l2_table;
1194 bool zeroed = false;
1195 int64_t ret;
1196 int64_t cluster_sector;
1198 if (m_data) {
1199 m_data->valid = 0;
1201 if (extent->flat) {
1202 *cluster_offset = extent->flat_start_offset;
1203 return VMDK_OK;
1206 offset -= (extent->end_sector - extent->sectors) * SECTOR_SIZE;
1207 l1_index = (offset >> 9) / extent->l1_entry_sectors;
1208 if (l1_index >= extent->l1_size) {
1209 return VMDK_ERROR;
1211 l2_offset = extent->l1_table[l1_index];
1212 if (!l2_offset) {
1213 return VMDK_UNALLOC;
1215 for (i = 0; i < L2_CACHE_SIZE; i++) {
1216 if (l2_offset == extent->l2_cache_offsets[i]) {
1217 /* increment the hit count */
1218 if (++extent->l2_cache_counts[i] == 0xffffffff) {
1219 for (j = 0; j < L2_CACHE_SIZE; j++) {
1220 extent->l2_cache_counts[j] >>= 1;
1223 l2_table = extent->l2_cache + (i * extent->l2_size);
1224 goto found;
1227 /* not found: load a new entry in the least used one */
1228 min_index = 0;
1229 min_count = 0xffffffff;
1230 for (i = 0; i < L2_CACHE_SIZE; i++) {
1231 if (extent->l2_cache_counts[i] < min_count) {
1232 min_count = extent->l2_cache_counts[i];
1233 min_index = i;
1236 l2_table = extent->l2_cache + (min_index * extent->l2_size);
1237 BLKDBG_EVENT(extent->file, BLKDBG_L2_LOAD);
1238 if (bdrv_pread(extent->file,
1239 (int64_t)l2_offset * 512,
1240 l2_table,
1241 extent->l2_size * sizeof(uint32_t)
1242 ) != extent->l2_size * sizeof(uint32_t)) {
1243 return VMDK_ERROR;
1246 extent->l2_cache_offsets[min_index] = l2_offset;
1247 extent->l2_cache_counts[min_index] = 1;
1248 found:
1249 l2_index = ((offset >> 9) / extent->cluster_sectors) % extent->l2_size;
1250 cluster_sector = le32_to_cpu(l2_table[l2_index]);
1252 if (extent->has_zero_grain && cluster_sector == VMDK_GTE_ZEROED) {
1253 zeroed = true;
1256 if (!cluster_sector || zeroed) {
1257 if (!allocate) {
1258 return zeroed ? VMDK_ZEROED : VMDK_UNALLOC;
1261 if (extent->next_cluster_sector >= VMDK_EXTENT_MAX_SECTORS) {
1262 return VMDK_ERROR;
1265 cluster_sector = extent->next_cluster_sector;
1266 extent->next_cluster_sector += extent->cluster_sectors;
1268 /* First of all we write grain itself, to avoid race condition
1269 * that may to corrupt the image.
1270 * This problem may occur because of insufficient space on host disk
1271 * or inappropriate VM shutdown.
1273 ret = get_whole_cluster(bs, extent, cluster_sector * BDRV_SECTOR_SIZE,
1274 offset, skip_start_bytes, skip_end_bytes);
1275 if (ret) {
1276 return ret;
1278 if (m_data) {
1279 m_data->valid = 1;
1280 m_data->l1_index = l1_index;
1281 m_data->l2_index = l2_index;
1282 m_data->l2_offset = l2_offset;
1283 m_data->l2_cache_entry = &l2_table[l2_index];
1286 *cluster_offset = cluster_sector << BDRV_SECTOR_BITS;
1287 return VMDK_OK;
1290 static VmdkExtent *find_extent(BDRVVmdkState *s,
1291 int64_t sector_num, VmdkExtent *start_hint)
1293 VmdkExtent *extent = start_hint;
1295 if (!extent) {
1296 extent = &s->extents[0];
1298 while (extent < &s->extents[s->num_extents]) {
1299 if (sector_num < extent->end_sector) {
1300 return extent;
1302 extent++;
1304 return NULL;
1307 static inline uint64_t vmdk_find_offset_in_cluster(VmdkExtent *extent,
1308 int64_t offset)
1310 uint64_t extent_begin_offset, extent_relative_offset;
1311 uint64_t cluster_size = extent->cluster_sectors * BDRV_SECTOR_SIZE;
1313 extent_begin_offset =
1314 (extent->end_sector - extent->sectors) * BDRV_SECTOR_SIZE;
1315 extent_relative_offset = offset - extent_begin_offset;
1316 return extent_relative_offset % cluster_size;
1319 static int coroutine_fn vmdk_co_block_status(BlockDriverState *bs,
1320 bool want_zero,
1321 int64_t offset, int64_t bytes,
1322 int64_t *pnum, int64_t *map,
1323 BlockDriverState **file)
1325 BDRVVmdkState *s = bs->opaque;
1326 int64_t index_in_cluster, n, ret;
1327 uint64_t cluster_offset;
1328 VmdkExtent *extent;
1330 extent = find_extent(s, offset >> BDRV_SECTOR_BITS, NULL);
1331 if (!extent) {
1332 return -EIO;
1334 qemu_co_mutex_lock(&s->lock);
1335 ret = get_cluster_offset(bs, extent, NULL, offset, false, &cluster_offset,
1336 0, 0);
1337 qemu_co_mutex_unlock(&s->lock);
1339 index_in_cluster = vmdk_find_offset_in_cluster(extent, offset);
1340 switch (ret) {
1341 case VMDK_ERROR:
1342 ret = -EIO;
1343 break;
1344 case VMDK_UNALLOC:
1345 ret = 0;
1346 break;
1347 case VMDK_ZEROED:
1348 ret = BDRV_BLOCK_ZERO;
1349 break;
1350 case VMDK_OK:
1351 ret = BDRV_BLOCK_DATA;
1352 if (!extent->compressed) {
1353 ret |= BDRV_BLOCK_OFFSET_VALID;
1354 *map = cluster_offset + index_in_cluster;
1356 *file = extent->file->bs;
1357 break;
1360 n = extent->cluster_sectors * BDRV_SECTOR_SIZE - index_in_cluster;
1361 *pnum = MIN(n, bytes);
1362 return ret;
1365 static int vmdk_write_extent(VmdkExtent *extent, int64_t cluster_offset,
1366 int64_t offset_in_cluster, QEMUIOVector *qiov,
1367 uint64_t qiov_offset, uint64_t n_bytes,
1368 uint64_t offset)
1370 int ret;
1371 VmdkGrainMarker *data = NULL;
1372 uLongf buf_len;
1373 QEMUIOVector local_qiov;
1374 struct iovec iov;
1375 int64_t write_offset;
1376 int64_t write_end_sector;
1378 if (extent->compressed) {
1379 void *compressed_data;
1381 if (!extent->has_marker) {
1382 ret = -EINVAL;
1383 goto out;
1385 buf_len = (extent->cluster_sectors << 9) * 2;
1386 data = g_malloc(buf_len + sizeof(VmdkGrainMarker));
1388 compressed_data = g_malloc(n_bytes);
1389 qemu_iovec_to_buf(qiov, qiov_offset, compressed_data, n_bytes);
1390 ret = compress(data->data, &buf_len, compressed_data, n_bytes);
1391 g_free(compressed_data);
1393 if (ret != Z_OK || buf_len == 0) {
1394 ret = -EINVAL;
1395 goto out;
1398 data->lba = cpu_to_le64(offset >> BDRV_SECTOR_BITS);
1399 data->size = cpu_to_le32(buf_len);
1401 n_bytes = buf_len + sizeof(VmdkGrainMarker);
1402 iov = (struct iovec) {
1403 .iov_base = data,
1404 .iov_len = n_bytes,
1406 qemu_iovec_init_external(&local_qiov, &iov, 1);
1408 BLKDBG_EVENT(extent->file, BLKDBG_WRITE_COMPRESSED);
1409 } else {
1410 qemu_iovec_init(&local_qiov, qiov->niov);
1411 qemu_iovec_concat(&local_qiov, qiov, qiov_offset, n_bytes);
1413 BLKDBG_EVENT(extent->file, BLKDBG_WRITE_AIO);
1416 write_offset = cluster_offset + offset_in_cluster;
1417 ret = bdrv_co_pwritev(extent->file, write_offset, n_bytes,
1418 &local_qiov, 0);
1420 write_end_sector = DIV_ROUND_UP(write_offset + n_bytes, BDRV_SECTOR_SIZE);
1422 if (extent->compressed) {
1423 extent->next_cluster_sector = write_end_sector;
1424 } else {
1425 extent->next_cluster_sector = MAX(extent->next_cluster_sector,
1426 write_end_sector);
1429 if (ret < 0) {
1430 goto out;
1432 ret = 0;
1433 out:
1434 g_free(data);
1435 if (!extent->compressed) {
1436 qemu_iovec_destroy(&local_qiov);
1438 return ret;
1441 static int vmdk_read_extent(VmdkExtent *extent, int64_t cluster_offset,
1442 int64_t offset_in_cluster, QEMUIOVector *qiov,
1443 int bytes)
1445 int ret;
1446 int cluster_bytes, buf_bytes;
1447 uint8_t *cluster_buf, *compressed_data;
1448 uint8_t *uncomp_buf;
1449 uint32_t data_len;
1450 VmdkGrainMarker *marker;
1451 uLongf buf_len;
1454 if (!extent->compressed) {
1455 BLKDBG_EVENT(extent->file, BLKDBG_READ_AIO);
1456 ret = bdrv_co_preadv(extent->file,
1457 cluster_offset + offset_in_cluster, bytes,
1458 qiov, 0);
1459 if (ret < 0) {
1460 return ret;
1462 return 0;
1464 cluster_bytes = extent->cluster_sectors * 512;
1465 /* Read two clusters in case GrainMarker + compressed data > one cluster */
1466 buf_bytes = cluster_bytes * 2;
1467 cluster_buf = g_malloc(buf_bytes);
1468 uncomp_buf = g_malloc(cluster_bytes);
1469 BLKDBG_EVENT(extent->file, BLKDBG_READ_COMPRESSED);
1470 ret = bdrv_pread(extent->file,
1471 cluster_offset,
1472 cluster_buf, buf_bytes);
1473 if (ret < 0) {
1474 goto out;
1476 compressed_data = cluster_buf;
1477 buf_len = cluster_bytes;
1478 data_len = cluster_bytes;
1479 if (extent->has_marker) {
1480 marker = (VmdkGrainMarker *)cluster_buf;
1481 compressed_data = marker->data;
1482 data_len = le32_to_cpu(marker->size);
1484 if (!data_len || data_len > buf_bytes) {
1485 ret = -EINVAL;
1486 goto out;
1488 ret = uncompress(uncomp_buf, &buf_len, compressed_data, data_len);
1489 if (ret != Z_OK) {
1490 ret = -EINVAL;
1491 goto out;
1494 if (offset_in_cluster < 0 ||
1495 offset_in_cluster + bytes > buf_len) {
1496 ret = -EINVAL;
1497 goto out;
1499 qemu_iovec_from_buf(qiov, 0, uncomp_buf + offset_in_cluster, bytes);
1500 ret = 0;
1502 out:
1503 g_free(uncomp_buf);
1504 g_free(cluster_buf);
1505 return ret;
1508 static int coroutine_fn
1509 vmdk_co_preadv(BlockDriverState *bs, uint64_t offset, uint64_t bytes,
1510 QEMUIOVector *qiov, int flags)
1512 BDRVVmdkState *s = bs->opaque;
1513 int ret;
1514 uint64_t n_bytes, offset_in_cluster;
1515 VmdkExtent *extent = NULL;
1516 QEMUIOVector local_qiov;
1517 uint64_t cluster_offset;
1518 uint64_t bytes_done = 0;
1520 qemu_iovec_init(&local_qiov, qiov->niov);
1521 qemu_co_mutex_lock(&s->lock);
1523 while (bytes > 0) {
1524 extent = find_extent(s, offset >> BDRV_SECTOR_BITS, extent);
1525 if (!extent) {
1526 ret = -EIO;
1527 goto fail;
1529 ret = get_cluster_offset(bs, extent, NULL,
1530 offset, false, &cluster_offset, 0, 0);
1531 offset_in_cluster = vmdk_find_offset_in_cluster(extent, offset);
1533 n_bytes = MIN(bytes, extent->cluster_sectors * BDRV_SECTOR_SIZE
1534 - offset_in_cluster);
1536 if (ret != VMDK_OK) {
1537 /* if not allocated, try to read from parent image, if exist */
1538 if (bs->backing && ret != VMDK_ZEROED) {
1539 if (!vmdk_is_cid_valid(bs)) {
1540 ret = -EINVAL;
1541 goto fail;
1544 qemu_iovec_reset(&local_qiov);
1545 qemu_iovec_concat(&local_qiov, qiov, bytes_done, n_bytes);
1547 /* qcow2 emits this on bs->file instead of bs->backing */
1548 BLKDBG_EVENT(bs->file, BLKDBG_READ_BACKING_AIO);
1549 ret = bdrv_co_preadv(bs->backing, offset, n_bytes,
1550 &local_qiov, 0);
1551 if (ret < 0) {
1552 goto fail;
1554 } else {
1555 qemu_iovec_memset(qiov, bytes_done, 0, n_bytes);
1557 } else {
1558 qemu_iovec_reset(&local_qiov);
1559 qemu_iovec_concat(&local_qiov, qiov, bytes_done, n_bytes);
1561 ret = vmdk_read_extent(extent, cluster_offset, offset_in_cluster,
1562 &local_qiov, n_bytes);
1563 if (ret) {
1564 goto fail;
1567 bytes -= n_bytes;
1568 offset += n_bytes;
1569 bytes_done += n_bytes;
1572 ret = 0;
1573 fail:
1574 qemu_co_mutex_unlock(&s->lock);
1575 qemu_iovec_destroy(&local_qiov);
1577 return ret;
1581 * vmdk_write:
1582 * @zeroed: buf is ignored (data is zero), use zeroed_grain GTE feature
1583 * if possible, otherwise return -ENOTSUP.
1584 * @zero_dry_run: used for zeroed == true only, don't update L2 table, just try
1585 * with each cluster. By dry run we can find if the zero write
1586 * is possible without modifying image data.
1588 * Returns: error code with 0 for success.
1590 static int vmdk_pwritev(BlockDriverState *bs, uint64_t offset,
1591 uint64_t bytes, QEMUIOVector *qiov,
1592 bool zeroed, bool zero_dry_run)
1594 BDRVVmdkState *s = bs->opaque;
1595 VmdkExtent *extent = NULL;
1596 int ret;
1597 int64_t offset_in_cluster, n_bytes;
1598 uint64_t cluster_offset;
1599 uint64_t bytes_done = 0;
1600 VmdkMetaData m_data;
1602 if (DIV_ROUND_UP(offset, BDRV_SECTOR_SIZE) > bs->total_sectors) {
1603 error_report("Wrong offset: offset=0x%" PRIx64
1604 " total_sectors=0x%" PRIx64,
1605 offset, bs->total_sectors);
1606 return -EIO;
1609 while (bytes > 0) {
1610 extent = find_extent(s, offset >> BDRV_SECTOR_BITS, extent);
1611 if (!extent) {
1612 return -EIO;
1614 offset_in_cluster = vmdk_find_offset_in_cluster(extent, offset);
1615 n_bytes = MIN(bytes, extent->cluster_sectors * BDRV_SECTOR_SIZE
1616 - offset_in_cluster);
1618 ret = get_cluster_offset(bs, extent, &m_data, offset,
1619 !(extent->compressed || zeroed),
1620 &cluster_offset, offset_in_cluster,
1621 offset_in_cluster + n_bytes);
1622 if (extent->compressed) {
1623 if (ret == VMDK_OK) {
1624 /* Refuse write to allocated cluster for streamOptimized */
1625 error_report("Could not write to allocated cluster"
1626 " for streamOptimized");
1627 return -EIO;
1628 } else {
1629 /* allocate */
1630 ret = get_cluster_offset(bs, extent, &m_data, offset,
1631 true, &cluster_offset, 0, 0);
1634 if (ret == VMDK_ERROR) {
1635 return -EINVAL;
1637 if (zeroed) {
1638 /* Do zeroed write, buf is ignored */
1639 if (extent->has_zero_grain &&
1640 offset_in_cluster == 0 &&
1641 n_bytes >= extent->cluster_sectors * BDRV_SECTOR_SIZE) {
1642 n_bytes = extent->cluster_sectors * BDRV_SECTOR_SIZE;
1643 if (!zero_dry_run) {
1644 /* update L2 tables */
1645 if (vmdk_L2update(extent, &m_data, VMDK_GTE_ZEROED)
1646 != VMDK_OK) {
1647 return -EIO;
1650 } else {
1651 return -ENOTSUP;
1653 } else {
1654 ret = vmdk_write_extent(extent, cluster_offset, offset_in_cluster,
1655 qiov, bytes_done, n_bytes, offset);
1656 if (ret) {
1657 return ret;
1659 if (m_data.valid) {
1660 /* update L2 tables */
1661 if (vmdk_L2update(extent, &m_data,
1662 cluster_offset >> BDRV_SECTOR_BITS)
1663 != VMDK_OK) {
1664 return -EIO;
1668 bytes -= n_bytes;
1669 offset += n_bytes;
1670 bytes_done += n_bytes;
1672 /* update CID on the first write every time the virtual disk is
1673 * opened */
1674 if (!s->cid_updated) {
1675 ret = vmdk_write_cid(bs, g_random_int());
1676 if (ret < 0) {
1677 return ret;
1679 s->cid_updated = true;
1682 return 0;
1685 static int coroutine_fn
1686 vmdk_co_pwritev(BlockDriverState *bs, uint64_t offset, uint64_t bytes,
1687 QEMUIOVector *qiov, int flags)
1689 int ret;
1690 BDRVVmdkState *s = bs->opaque;
1691 qemu_co_mutex_lock(&s->lock);
1692 ret = vmdk_pwritev(bs, offset, bytes, qiov, false, false);
1693 qemu_co_mutex_unlock(&s->lock);
1694 return ret;
1697 static int coroutine_fn
1698 vmdk_co_pwritev_compressed(BlockDriverState *bs, uint64_t offset,
1699 uint64_t bytes, QEMUIOVector *qiov)
1701 if (bytes == 0) {
1702 /* The caller will write bytes 0 to signal EOF.
1703 * When receive it, we align EOF to a sector boundary. */
1704 BDRVVmdkState *s = bs->opaque;
1705 int i, ret;
1706 int64_t length;
1708 for (i = 0; i < s->num_extents; i++) {
1709 length = bdrv_getlength(s->extents[i].file->bs);
1710 if (length < 0) {
1711 return length;
1713 length = QEMU_ALIGN_UP(length, BDRV_SECTOR_SIZE);
1714 ret = bdrv_truncate(s->extents[i].file, length,
1715 PREALLOC_MODE_OFF, NULL);
1716 if (ret < 0) {
1717 return ret;
1720 return 0;
1722 return vmdk_co_pwritev(bs, offset, bytes, qiov, 0);
1725 static int coroutine_fn vmdk_co_pwrite_zeroes(BlockDriverState *bs,
1726 int64_t offset,
1727 int bytes,
1728 BdrvRequestFlags flags)
1730 int ret;
1731 BDRVVmdkState *s = bs->opaque;
1733 qemu_co_mutex_lock(&s->lock);
1734 /* write zeroes could fail if sectors not aligned to cluster, test it with
1735 * dry_run == true before really updating image */
1736 ret = vmdk_pwritev(bs, offset, bytes, NULL, true, true);
1737 if (!ret) {
1738 ret = vmdk_pwritev(bs, offset, bytes, NULL, true, false);
1740 qemu_co_mutex_unlock(&s->lock);
1741 return ret;
1744 static int vmdk_create_extent(const char *filename, int64_t filesize,
1745 bool flat, bool compress, bool zeroed_grain,
1746 QemuOpts *opts, Error **errp)
1748 int ret, i;
1749 BlockBackend *blk = NULL;
1750 VMDK4Header header;
1751 Error *local_err = NULL;
1752 uint32_t tmp, magic, grains, gd_sectors, gt_size, gt_count;
1753 uint32_t *gd_buf = NULL;
1754 int gd_buf_size;
1756 ret = bdrv_create_file(filename, opts, &local_err);
1757 if (ret < 0) {
1758 error_propagate(errp, local_err);
1759 goto exit;
1762 blk = blk_new_open(filename, NULL, NULL,
1763 BDRV_O_RDWR | BDRV_O_RESIZE | BDRV_O_PROTOCOL,
1764 &local_err);
1765 if (blk == NULL) {
1766 error_propagate(errp, local_err);
1767 ret = -EIO;
1768 goto exit;
1771 blk_set_allow_write_beyond_eof(blk, true);
1773 if (flat) {
1774 ret = blk_truncate(blk, filesize, PREALLOC_MODE_OFF, errp);
1775 goto exit;
1777 magic = cpu_to_be32(VMDK4_MAGIC);
1778 memset(&header, 0, sizeof(header));
1779 if (compress) {
1780 header.version = 3;
1781 } else if (zeroed_grain) {
1782 header.version = 2;
1783 } else {
1784 header.version = 1;
1786 header.flags = VMDK4_FLAG_RGD | VMDK4_FLAG_NL_DETECT
1787 | (compress ? VMDK4_FLAG_COMPRESS | VMDK4_FLAG_MARKER : 0)
1788 | (zeroed_grain ? VMDK4_FLAG_ZERO_GRAIN : 0);
1789 header.compressAlgorithm = compress ? VMDK4_COMPRESSION_DEFLATE : 0;
1790 header.capacity = filesize / BDRV_SECTOR_SIZE;
1791 header.granularity = 128;
1792 header.num_gtes_per_gt = BDRV_SECTOR_SIZE;
1794 grains = DIV_ROUND_UP(filesize / BDRV_SECTOR_SIZE, header.granularity);
1795 gt_size = DIV_ROUND_UP(header.num_gtes_per_gt * sizeof(uint32_t),
1796 BDRV_SECTOR_SIZE);
1797 gt_count = DIV_ROUND_UP(grains, header.num_gtes_per_gt);
1798 gd_sectors = DIV_ROUND_UP(gt_count * sizeof(uint32_t), BDRV_SECTOR_SIZE);
1800 header.desc_offset = 1;
1801 header.desc_size = 20;
1802 header.rgd_offset = header.desc_offset + header.desc_size;
1803 header.gd_offset = header.rgd_offset + gd_sectors + (gt_size * gt_count);
1804 header.grain_offset =
1805 ROUND_UP(header.gd_offset + gd_sectors + (gt_size * gt_count),
1806 header.granularity);
1807 /* swap endianness for all header fields */
1808 header.version = cpu_to_le32(header.version);
1809 header.flags = cpu_to_le32(header.flags);
1810 header.capacity = cpu_to_le64(header.capacity);
1811 header.granularity = cpu_to_le64(header.granularity);
1812 header.num_gtes_per_gt = cpu_to_le32(header.num_gtes_per_gt);
1813 header.desc_offset = cpu_to_le64(header.desc_offset);
1814 header.desc_size = cpu_to_le64(header.desc_size);
1815 header.rgd_offset = cpu_to_le64(header.rgd_offset);
1816 header.gd_offset = cpu_to_le64(header.gd_offset);
1817 header.grain_offset = cpu_to_le64(header.grain_offset);
1818 header.compressAlgorithm = cpu_to_le16(header.compressAlgorithm);
1820 header.check_bytes[0] = 0xa;
1821 header.check_bytes[1] = 0x20;
1822 header.check_bytes[2] = 0xd;
1823 header.check_bytes[3] = 0xa;
1825 /* write all the data */
1826 ret = blk_pwrite(blk, 0, &magic, sizeof(magic), 0);
1827 if (ret < 0) {
1828 error_setg(errp, QERR_IO_ERROR);
1829 goto exit;
1831 ret = blk_pwrite(blk, sizeof(magic), &header, sizeof(header), 0);
1832 if (ret < 0) {
1833 error_setg(errp, QERR_IO_ERROR);
1834 goto exit;
1837 ret = blk_truncate(blk, le64_to_cpu(header.grain_offset) << 9,
1838 PREALLOC_MODE_OFF, errp);
1839 if (ret < 0) {
1840 goto exit;
1843 /* write grain directory */
1844 gd_buf_size = gd_sectors * BDRV_SECTOR_SIZE;
1845 gd_buf = g_malloc0(gd_buf_size);
1846 for (i = 0, tmp = le64_to_cpu(header.rgd_offset) + gd_sectors;
1847 i < gt_count; i++, tmp += gt_size) {
1848 gd_buf[i] = cpu_to_le32(tmp);
1850 ret = blk_pwrite(blk, le64_to_cpu(header.rgd_offset) * BDRV_SECTOR_SIZE,
1851 gd_buf, gd_buf_size, 0);
1852 if (ret < 0) {
1853 error_setg(errp, QERR_IO_ERROR);
1854 goto exit;
1857 /* write backup grain directory */
1858 for (i = 0, tmp = le64_to_cpu(header.gd_offset) + gd_sectors;
1859 i < gt_count; i++, tmp += gt_size) {
1860 gd_buf[i] = cpu_to_le32(tmp);
1862 ret = blk_pwrite(blk, le64_to_cpu(header.gd_offset) * BDRV_SECTOR_SIZE,
1863 gd_buf, gd_buf_size, 0);
1864 if (ret < 0) {
1865 error_setg(errp, QERR_IO_ERROR);
1866 goto exit;
1869 ret = 0;
1870 exit:
1871 if (blk) {
1872 blk_unref(blk);
1874 g_free(gd_buf);
1875 return ret;
1878 static int filename_decompose(const char *filename, char *path, char *prefix,
1879 char *postfix, size_t buf_len, Error **errp)
1881 const char *p, *q;
1883 if (filename == NULL || !strlen(filename)) {
1884 error_setg(errp, "No filename provided");
1885 return VMDK_ERROR;
1887 p = strrchr(filename, '/');
1888 if (p == NULL) {
1889 p = strrchr(filename, '\\');
1891 if (p == NULL) {
1892 p = strrchr(filename, ':');
1894 if (p != NULL) {
1895 p++;
1896 if (p - filename >= buf_len) {
1897 return VMDK_ERROR;
1899 pstrcpy(path, p - filename + 1, filename);
1900 } else {
1901 p = filename;
1902 path[0] = '\0';
1904 q = strrchr(p, '.');
1905 if (q == NULL) {
1906 pstrcpy(prefix, buf_len, p);
1907 postfix[0] = '\0';
1908 } else {
1909 if (q - p >= buf_len) {
1910 return VMDK_ERROR;
1912 pstrcpy(prefix, q - p + 1, p);
1913 pstrcpy(postfix, buf_len, q);
1915 return VMDK_OK;
1918 static int coroutine_fn vmdk_co_create_opts(const char *filename, QemuOpts *opts,
1919 Error **errp)
1921 int idx = 0;
1922 BlockBackend *new_blk = NULL;
1923 Error *local_err = NULL;
1924 char *desc = NULL;
1925 int64_t total_size = 0, filesize;
1926 char *adapter_type = NULL;
1927 char *backing_file = NULL;
1928 char *hw_version = NULL;
1929 char *fmt = NULL;
1930 int ret = 0;
1931 bool flat, split, compress;
1932 GString *ext_desc_lines;
1933 char *path = g_malloc0(PATH_MAX);
1934 char *prefix = g_malloc0(PATH_MAX);
1935 char *postfix = g_malloc0(PATH_MAX);
1936 char *desc_line = g_malloc0(BUF_SIZE);
1937 char *ext_filename = g_malloc0(PATH_MAX);
1938 char *desc_filename = g_malloc0(PATH_MAX);
1939 const int64_t split_size = 0x80000000; /* VMDK has constant split size */
1940 const char *desc_extent_line;
1941 char *parent_desc_line = g_malloc0(BUF_SIZE);
1942 uint32_t parent_cid = 0xffffffff;
1943 uint32_t number_heads = 16;
1944 bool zeroed_grain = false;
1945 uint32_t desc_offset = 0, desc_len;
1946 const char desc_template[] =
1947 "# Disk DescriptorFile\n"
1948 "version=1\n"
1949 "CID=%" PRIx32 "\n"
1950 "parentCID=%" PRIx32 "\n"
1951 "createType=\"%s\"\n"
1952 "%s"
1953 "\n"
1954 "# Extent description\n"
1955 "%s"
1956 "\n"
1957 "# The Disk Data Base\n"
1958 "#DDB\n"
1959 "\n"
1960 "ddb.virtualHWVersion = \"%s\"\n"
1961 "ddb.geometry.cylinders = \"%" PRId64 "\"\n"
1962 "ddb.geometry.heads = \"%" PRIu32 "\"\n"
1963 "ddb.geometry.sectors = \"63\"\n"
1964 "ddb.adapterType = \"%s\"\n";
1966 ext_desc_lines = g_string_new(NULL);
1968 if (filename_decompose(filename, path, prefix, postfix, PATH_MAX, errp)) {
1969 ret = -EINVAL;
1970 goto exit;
1972 /* Read out options */
1973 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
1974 BDRV_SECTOR_SIZE);
1975 adapter_type = qemu_opt_get_del(opts, BLOCK_OPT_ADAPTER_TYPE);
1976 backing_file = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FILE);
1977 hw_version = qemu_opt_get_del(opts, BLOCK_OPT_HWVERSION);
1978 if (qemu_opt_get_bool_del(opts, BLOCK_OPT_COMPAT6, false)) {
1979 if (strcmp(hw_version, "undefined")) {
1980 error_setg(errp,
1981 "compat6 cannot be enabled with hwversion set");
1982 ret = -EINVAL;
1983 goto exit;
1985 g_free(hw_version);
1986 hw_version = g_strdup("6");
1988 if (strcmp(hw_version, "undefined") == 0) {
1989 g_free(hw_version);
1990 hw_version = g_strdup("4");
1992 fmt = qemu_opt_get_del(opts, BLOCK_OPT_SUBFMT);
1993 if (qemu_opt_get_bool_del(opts, BLOCK_OPT_ZEROED_GRAIN, false)) {
1994 zeroed_grain = true;
1997 if (!adapter_type) {
1998 adapter_type = g_strdup("ide");
1999 } else if (strcmp(adapter_type, "ide") &&
2000 strcmp(adapter_type, "buslogic") &&
2001 strcmp(adapter_type, "lsilogic") &&
2002 strcmp(adapter_type, "legacyESX")) {
2003 error_setg(errp, "Unknown adapter type: '%s'", adapter_type);
2004 ret = -EINVAL;
2005 goto exit;
2007 if (strcmp(adapter_type, "ide") != 0) {
2008 /* that's the number of heads with which vmware operates when
2009 creating, exporting, etc. vmdk files with a non-ide adapter type */
2010 number_heads = 255;
2012 if (!fmt) {
2013 /* Default format to monolithicSparse */
2014 fmt = g_strdup("monolithicSparse");
2015 } else if (strcmp(fmt, "monolithicFlat") &&
2016 strcmp(fmt, "monolithicSparse") &&
2017 strcmp(fmt, "twoGbMaxExtentSparse") &&
2018 strcmp(fmt, "twoGbMaxExtentFlat") &&
2019 strcmp(fmt, "streamOptimized")) {
2020 error_setg(errp, "Unknown subformat: '%s'", fmt);
2021 ret = -EINVAL;
2022 goto exit;
2024 split = !(strcmp(fmt, "twoGbMaxExtentFlat") &&
2025 strcmp(fmt, "twoGbMaxExtentSparse"));
2026 flat = !(strcmp(fmt, "monolithicFlat") &&
2027 strcmp(fmt, "twoGbMaxExtentFlat"));
2028 compress = !strcmp(fmt, "streamOptimized");
2029 if (flat) {
2030 desc_extent_line = "RW %" PRId64 " FLAT \"%s\" 0\n";
2031 } else {
2032 desc_extent_line = "RW %" PRId64 " SPARSE \"%s\"\n";
2034 if (flat && backing_file) {
2035 error_setg(errp, "Flat image can't have backing file");
2036 ret = -ENOTSUP;
2037 goto exit;
2039 if (flat && zeroed_grain) {
2040 error_setg(errp, "Flat image can't enable zeroed grain");
2041 ret = -ENOTSUP;
2042 goto exit;
2044 if (backing_file) {
2045 BlockBackend *blk;
2046 char *full_backing = g_new0(char, PATH_MAX);
2047 bdrv_get_full_backing_filename_from_filename(filename, backing_file,
2048 full_backing, PATH_MAX,
2049 &local_err);
2050 if (local_err) {
2051 g_free(full_backing);
2052 error_propagate(errp, local_err);
2053 ret = -ENOENT;
2054 goto exit;
2057 blk = blk_new_open(full_backing, NULL, NULL,
2058 BDRV_O_NO_BACKING, errp);
2059 g_free(full_backing);
2060 if (blk == NULL) {
2061 ret = -EIO;
2062 goto exit;
2064 if (strcmp(blk_bs(blk)->drv->format_name, "vmdk")) {
2065 blk_unref(blk);
2066 ret = -EINVAL;
2067 goto exit;
2069 ret = vmdk_read_cid(blk_bs(blk), 0, &parent_cid);
2070 blk_unref(blk);
2071 if (ret) {
2072 goto exit;
2074 snprintf(parent_desc_line, BUF_SIZE,
2075 "parentFileNameHint=\"%s\"", backing_file);
2078 /* Create extents */
2079 filesize = total_size;
2080 while (filesize > 0) {
2081 int64_t size = filesize;
2083 if (split && size > split_size) {
2084 size = split_size;
2086 if (split) {
2087 snprintf(desc_filename, PATH_MAX, "%s-%c%03d%s",
2088 prefix, flat ? 'f' : 's', ++idx, postfix);
2089 } else if (flat) {
2090 snprintf(desc_filename, PATH_MAX, "%s-flat%s", prefix, postfix);
2091 } else {
2092 snprintf(desc_filename, PATH_MAX, "%s%s", prefix, postfix);
2094 snprintf(ext_filename, PATH_MAX, "%s%s", path, desc_filename);
2096 if (vmdk_create_extent(ext_filename, size,
2097 flat, compress, zeroed_grain, opts, errp)) {
2098 ret = -EINVAL;
2099 goto exit;
2101 filesize -= size;
2103 /* Format description line */
2104 snprintf(desc_line, BUF_SIZE,
2105 desc_extent_line, size / BDRV_SECTOR_SIZE, desc_filename);
2106 g_string_append(ext_desc_lines, desc_line);
2108 /* generate descriptor file */
2109 desc = g_strdup_printf(desc_template,
2110 g_random_int(),
2111 parent_cid,
2112 fmt,
2113 parent_desc_line,
2114 ext_desc_lines->str,
2115 hw_version,
2116 total_size /
2117 (int64_t)(63 * number_heads * BDRV_SECTOR_SIZE),
2118 number_heads,
2119 adapter_type);
2120 desc_len = strlen(desc);
2121 /* the descriptor offset = 0x200 */
2122 if (!split && !flat) {
2123 desc_offset = 0x200;
2124 } else {
2125 ret = bdrv_create_file(filename, opts, &local_err);
2126 if (ret < 0) {
2127 error_propagate(errp, local_err);
2128 goto exit;
2132 new_blk = blk_new_open(filename, NULL, NULL,
2133 BDRV_O_RDWR | BDRV_O_RESIZE | BDRV_O_PROTOCOL,
2134 &local_err);
2135 if (new_blk == NULL) {
2136 error_propagate(errp, local_err);
2137 ret = -EIO;
2138 goto exit;
2141 blk_set_allow_write_beyond_eof(new_blk, true);
2143 ret = blk_pwrite(new_blk, desc_offset, desc, desc_len, 0);
2144 if (ret < 0) {
2145 error_setg_errno(errp, -ret, "Could not write description");
2146 goto exit;
2148 /* bdrv_pwrite write padding zeros to align to sector, we don't need that
2149 * for description file */
2150 if (desc_offset == 0) {
2151 ret = blk_truncate(new_blk, desc_len, PREALLOC_MODE_OFF, errp);
2153 exit:
2154 if (new_blk) {
2155 blk_unref(new_blk);
2157 g_free(adapter_type);
2158 g_free(backing_file);
2159 g_free(hw_version);
2160 g_free(fmt);
2161 g_free(desc);
2162 g_free(path);
2163 g_free(prefix);
2164 g_free(postfix);
2165 g_free(desc_line);
2166 g_free(ext_filename);
2167 g_free(desc_filename);
2168 g_free(parent_desc_line);
2169 g_string_free(ext_desc_lines, true);
2170 return ret;
2173 static void vmdk_close(BlockDriverState *bs)
2175 BDRVVmdkState *s = bs->opaque;
2177 vmdk_free_extents(bs);
2178 g_free(s->create_type);
2180 migrate_del_blocker(s->migration_blocker);
2181 error_free(s->migration_blocker);
2184 static coroutine_fn int vmdk_co_flush(BlockDriverState *bs)
2186 BDRVVmdkState *s = bs->opaque;
2187 int i, err;
2188 int ret = 0;
2190 for (i = 0; i < s->num_extents; i++) {
2191 err = bdrv_co_flush(s->extents[i].file->bs);
2192 if (err < 0) {
2193 ret = err;
2196 return ret;
2199 static int64_t vmdk_get_allocated_file_size(BlockDriverState *bs)
2201 int i;
2202 int64_t ret = 0;
2203 int64_t r;
2204 BDRVVmdkState *s = bs->opaque;
2206 ret = bdrv_get_allocated_file_size(bs->file->bs);
2207 if (ret < 0) {
2208 return ret;
2210 for (i = 0; i < s->num_extents; i++) {
2211 if (s->extents[i].file == bs->file) {
2212 continue;
2214 r = bdrv_get_allocated_file_size(s->extents[i].file->bs);
2215 if (r < 0) {
2216 return r;
2218 ret += r;
2220 return ret;
2223 static int vmdk_has_zero_init(BlockDriverState *bs)
2225 int i;
2226 BDRVVmdkState *s = bs->opaque;
2228 /* If has a flat extent and its underlying storage doesn't have zero init,
2229 * return 0. */
2230 for (i = 0; i < s->num_extents; i++) {
2231 if (s->extents[i].flat) {
2232 if (!bdrv_has_zero_init(s->extents[i].file->bs)) {
2233 return 0;
2237 return 1;
2240 static ImageInfo *vmdk_get_extent_info(VmdkExtent *extent)
2242 ImageInfo *info = g_new0(ImageInfo, 1);
2244 *info = (ImageInfo){
2245 .filename = g_strdup(extent->file->bs->filename),
2246 .format = g_strdup(extent->type),
2247 .virtual_size = extent->sectors * BDRV_SECTOR_SIZE,
2248 .compressed = extent->compressed,
2249 .has_compressed = extent->compressed,
2250 .cluster_size = extent->cluster_sectors * BDRV_SECTOR_SIZE,
2251 .has_cluster_size = !extent->flat,
2254 return info;
2257 static int coroutine_fn vmdk_co_check(BlockDriverState *bs,
2258 BdrvCheckResult *result,
2259 BdrvCheckMode fix)
2261 BDRVVmdkState *s = bs->opaque;
2262 VmdkExtent *extent = NULL;
2263 int64_t sector_num = 0;
2264 int64_t total_sectors = bdrv_nb_sectors(bs);
2265 int ret;
2266 uint64_t cluster_offset;
2268 if (fix) {
2269 return -ENOTSUP;
2272 for (;;) {
2273 if (sector_num >= total_sectors) {
2274 return 0;
2276 extent = find_extent(s, sector_num, extent);
2277 if (!extent) {
2278 fprintf(stderr,
2279 "ERROR: could not find extent for sector %" PRId64 "\n",
2280 sector_num);
2281 ret = -EINVAL;
2282 break;
2284 ret = get_cluster_offset(bs, extent, NULL,
2285 sector_num << BDRV_SECTOR_BITS,
2286 false, &cluster_offset, 0, 0);
2287 if (ret == VMDK_ERROR) {
2288 fprintf(stderr,
2289 "ERROR: could not get cluster_offset for sector %"
2290 PRId64 "\n", sector_num);
2291 break;
2293 if (ret == VMDK_OK) {
2294 int64_t extent_len = bdrv_getlength(extent->file->bs);
2295 if (extent_len < 0) {
2296 fprintf(stderr,
2297 "ERROR: could not get extent file length for sector %"
2298 PRId64 "\n", sector_num);
2299 ret = extent_len;
2300 break;
2302 if (cluster_offset >= extent_len) {
2303 fprintf(stderr,
2304 "ERROR: cluster offset for sector %"
2305 PRId64 " points after EOF\n", sector_num);
2306 ret = -EINVAL;
2307 break;
2310 sector_num += extent->cluster_sectors;
2313 result->corruptions++;
2314 return ret;
2317 static ImageInfoSpecific *vmdk_get_specific_info(BlockDriverState *bs)
2319 int i;
2320 BDRVVmdkState *s = bs->opaque;
2321 ImageInfoSpecific *spec_info = g_new0(ImageInfoSpecific, 1);
2322 ImageInfoList **next;
2324 *spec_info = (ImageInfoSpecific){
2325 .type = IMAGE_INFO_SPECIFIC_KIND_VMDK,
2326 .u = {
2327 .vmdk.data = g_new0(ImageInfoSpecificVmdk, 1),
2331 *spec_info->u.vmdk.data = (ImageInfoSpecificVmdk) {
2332 .create_type = g_strdup(s->create_type),
2333 .cid = s->cid,
2334 .parent_cid = s->parent_cid,
2337 next = &spec_info->u.vmdk.data->extents;
2338 for (i = 0; i < s->num_extents; i++) {
2339 *next = g_new0(ImageInfoList, 1);
2340 (*next)->value = vmdk_get_extent_info(&s->extents[i]);
2341 (*next)->next = NULL;
2342 next = &(*next)->next;
2345 return spec_info;
2348 static bool vmdk_extents_type_eq(const VmdkExtent *a, const VmdkExtent *b)
2350 return a->flat == b->flat &&
2351 a->compressed == b->compressed &&
2352 (a->flat || a->cluster_sectors == b->cluster_sectors);
2355 static int vmdk_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
2357 int i;
2358 BDRVVmdkState *s = bs->opaque;
2359 assert(s->num_extents);
2361 /* See if we have multiple extents but they have different cases */
2362 for (i = 1; i < s->num_extents; i++) {
2363 if (!vmdk_extents_type_eq(&s->extents[0], &s->extents[i])) {
2364 return -ENOTSUP;
2367 bdi->needs_compressed_writes = s->extents[0].compressed;
2368 if (!s->extents[0].flat) {
2369 bdi->cluster_size = s->extents[0].cluster_sectors << BDRV_SECTOR_BITS;
2371 return 0;
2374 static QemuOptsList vmdk_create_opts = {
2375 .name = "vmdk-create-opts",
2376 .head = QTAILQ_HEAD_INITIALIZER(vmdk_create_opts.head),
2377 .desc = {
2379 .name = BLOCK_OPT_SIZE,
2380 .type = QEMU_OPT_SIZE,
2381 .help = "Virtual disk size"
2384 .name = BLOCK_OPT_ADAPTER_TYPE,
2385 .type = QEMU_OPT_STRING,
2386 .help = "Virtual adapter type, can be one of "
2387 "ide (default), lsilogic, buslogic or legacyESX"
2390 .name = BLOCK_OPT_BACKING_FILE,
2391 .type = QEMU_OPT_STRING,
2392 .help = "File name of a base image"
2395 .name = BLOCK_OPT_COMPAT6,
2396 .type = QEMU_OPT_BOOL,
2397 .help = "VMDK version 6 image",
2398 .def_value_str = "off"
2401 .name = BLOCK_OPT_HWVERSION,
2402 .type = QEMU_OPT_STRING,
2403 .help = "VMDK hardware version",
2404 .def_value_str = "undefined"
2407 .name = BLOCK_OPT_SUBFMT,
2408 .type = QEMU_OPT_STRING,
2409 .help =
2410 "VMDK flat extent format, can be one of "
2411 "{monolithicSparse (default) | monolithicFlat | twoGbMaxExtentSparse | twoGbMaxExtentFlat | streamOptimized} "
2414 .name = BLOCK_OPT_ZEROED_GRAIN,
2415 .type = QEMU_OPT_BOOL,
2416 .help = "Enable efficient zero writes "
2417 "using the zeroed-grain GTE feature"
2419 { /* end of list */ }
2423 static BlockDriver bdrv_vmdk = {
2424 .format_name = "vmdk",
2425 .instance_size = sizeof(BDRVVmdkState),
2426 .bdrv_probe = vmdk_probe,
2427 .bdrv_open = vmdk_open,
2428 .bdrv_co_check = vmdk_co_check,
2429 .bdrv_reopen_prepare = vmdk_reopen_prepare,
2430 .bdrv_child_perm = bdrv_format_default_perms,
2431 .bdrv_co_preadv = vmdk_co_preadv,
2432 .bdrv_co_pwritev = vmdk_co_pwritev,
2433 .bdrv_co_pwritev_compressed = vmdk_co_pwritev_compressed,
2434 .bdrv_co_pwrite_zeroes = vmdk_co_pwrite_zeroes,
2435 .bdrv_close = vmdk_close,
2436 .bdrv_co_create_opts = vmdk_co_create_opts,
2437 .bdrv_co_flush_to_disk = vmdk_co_flush,
2438 .bdrv_co_block_status = vmdk_co_block_status,
2439 .bdrv_get_allocated_file_size = vmdk_get_allocated_file_size,
2440 .bdrv_has_zero_init = vmdk_has_zero_init,
2441 .bdrv_get_specific_info = vmdk_get_specific_info,
2442 .bdrv_refresh_limits = vmdk_refresh_limits,
2443 .bdrv_get_info = vmdk_get_info,
2445 .supports_backing = true,
2446 .create_opts = &vmdk_create_opts,
2449 static void bdrv_vmdk_init(void)
2451 bdrv_register(&bdrv_vmdk);
2454 block_init(bdrv_vmdk_init);