]> git.proxmox.com Git - mirror_qemu.git/blob - block/vmdk.c
vmdk: Set errp on failures in vmdk_open_vmdk4
[mirror_qemu.git] / block / vmdk.c
1 /*
2 * Block driver for the VMDK format
3 *
4 * Copyright (c) 2004 Fabrice Bellard
5 * Copyright (c) 2005 Filip Navara
6 *
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:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
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.
24 */
25
26 #include "qemu-common.h"
27 #include "block/block_int.h"
28 #include "qemu/module.h"
29 #include "migration/migration.h"
30 #include <zlib.h>
31 #include <glib.h>
32
33 #define VMDK3_MAGIC (('C' << 24) | ('O' << 16) | ('W' << 8) | 'D')
34 #define VMDK4_MAGIC (('K' << 24) | ('D' << 16) | ('M' << 8) | 'V')
35 #define VMDK4_COMPRESSION_DEFLATE 1
36 #define VMDK4_FLAG_NL_DETECT (1 << 0)
37 #define VMDK4_FLAG_RGD (1 << 1)
38 /* Zeroed-grain enable bit */
39 #define VMDK4_FLAG_ZERO_GRAIN (1 << 2)
40 #define VMDK4_FLAG_COMPRESS (1 << 16)
41 #define VMDK4_FLAG_MARKER (1 << 17)
42 #define VMDK4_GD_AT_END 0xffffffffffffffffULL
43
44 #define VMDK_GTE_ZEROED 0x1
45
46 /* VMDK internal error codes */
47 #define VMDK_OK 0
48 #define VMDK_ERROR (-1)
49 /* Cluster not allocated */
50 #define VMDK_UNALLOC (-2)
51 #define VMDK_ZEROED (-3)
52
53 #define BLOCK_OPT_ZEROED_GRAIN "zeroed_grain"
54
55 typedef struct {
56 uint32_t version;
57 uint32_t flags;
58 uint32_t disk_sectors;
59 uint32_t granularity;
60 uint32_t l1dir_offset;
61 uint32_t l1dir_size;
62 uint32_t file_sectors;
63 uint32_t cylinders;
64 uint32_t heads;
65 uint32_t sectors_per_track;
66 } QEMU_PACKED VMDK3Header;
67
68 typedef struct {
69 uint32_t version;
70 uint32_t flags;
71 uint64_t capacity;
72 uint64_t granularity;
73 uint64_t desc_offset;
74 uint64_t desc_size;
75 /* Number of GrainTableEntries per GrainTable */
76 uint32_t num_gtes_per_gt;
77 uint64_t rgd_offset;
78 uint64_t gd_offset;
79 uint64_t grain_offset;
80 char filler[1];
81 char check_bytes[4];
82 uint16_t compressAlgorithm;
83 } QEMU_PACKED VMDK4Header;
84
85 #define L2_CACHE_SIZE 16
86
87 typedef struct VmdkExtent {
88 BlockDriverState *file;
89 bool flat;
90 bool compressed;
91 bool has_marker;
92 bool has_zero_grain;
93 int version;
94 int64_t sectors;
95 int64_t end_sector;
96 int64_t flat_start_offset;
97 int64_t l1_table_offset;
98 int64_t l1_backup_table_offset;
99 uint32_t *l1_table;
100 uint32_t *l1_backup_table;
101 unsigned int l1_size;
102 uint32_t l1_entry_sectors;
103
104 unsigned int l2_size;
105 uint32_t *l2_cache;
106 uint32_t l2_cache_offsets[L2_CACHE_SIZE];
107 uint32_t l2_cache_counts[L2_CACHE_SIZE];
108
109 int64_t cluster_sectors;
110 int64_t next_cluster_sector;
111 char *type;
112 } VmdkExtent;
113
114 typedef struct BDRVVmdkState {
115 CoMutex lock;
116 uint64_t desc_offset;
117 bool cid_updated;
118 bool cid_checked;
119 uint32_t cid;
120 uint32_t parent_cid;
121 int num_extents;
122 /* Extent array with num_extents entries, ascend ordered by address */
123 VmdkExtent *extents;
124 Error *migration_blocker;
125 char *create_type;
126 } BDRVVmdkState;
127
128 typedef struct VmdkMetaData {
129 unsigned int l1_index;
130 unsigned int l2_index;
131 unsigned int l2_offset;
132 int valid;
133 uint32_t *l2_cache_entry;
134 } VmdkMetaData;
135
136 typedef struct VmdkGrainMarker {
137 uint64_t lba;
138 uint32_t size;
139 uint8_t data[0];
140 } QEMU_PACKED VmdkGrainMarker;
141
142 enum {
143 MARKER_END_OF_STREAM = 0,
144 MARKER_GRAIN_TABLE = 1,
145 MARKER_GRAIN_DIRECTORY = 2,
146 MARKER_FOOTER = 3,
147 };
148
149 static int vmdk_probe(const uint8_t *buf, int buf_size, const char *filename)
150 {
151 uint32_t magic;
152
153 if (buf_size < 4) {
154 return 0;
155 }
156 magic = be32_to_cpu(*(uint32_t *)buf);
157 if (magic == VMDK3_MAGIC ||
158 magic == VMDK4_MAGIC) {
159 return 100;
160 } else {
161 const char *p = (const char *)buf;
162 const char *end = p + buf_size;
163 while (p < end) {
164 if (*p == '#') {
165 /* skip comment line */
166 while (p < end && *p != '\n') {
167 p++;
168 }
169 p++;
170 continue;
171 }
172 if (*p == ' ') {
173 while (p < end && *p == ' ') {
174 p++;
175 }
176 /* skip '\r' if windows line endings used. */
177 if (p < end && *p == '\r') {
178 p++;
179 }
180 /* only accept blank lines before 'version=' line */
181 if (p == end || *p != '\n') {
182 return 0;
183 }
184 p++;
185 continue;
186 }
187 if (end - p >= strlen("version=X\n")) {
188 if (strncmp("version=1\n", p, strlen("version=1\n")) == 0 ||
189 strncmp("version=2\n", p, strlen("version=2\n")) == 0) {
190 return 100;
191 }
192 }
193 if (end - p >= strlen("version=X\r\n")) {
194 if (strncmp("version=1\r\n", p, strlen("version=1\r\n")) == 0 ||
195 strncmp("version=2\r\n", p, strlen("version=2\r\n")) == 0) {
196 return 100;
197 }
198 }
199 return 0;
200 }
201 return 0;
202 }
203 }
204
205 #define SECTOR_SIZE 512
206 #define DESC_SIZE (20 * SECTOR_SIZE) /* 20 sectors of 512 bytes each */
207 #define BUF_SIZE 4096
208 #define HEADER_SIZE 512 /* first sector of 512 bytes */
209
210 static void vmdk_free_extents(BlockDriverState *bs)
211 {
212 int i;
213 BDRVVmdkState *s = bs->opaque;
214 VmdkExtent *e;
215
216 for (i = 0; i < s->num_extents; i++) {
217 e = &s->extents[i];
218 g_free(e->l1_table);
219 g_free(e->l2_cache);
220 g_free(e->l1_backup_table);
221 g_free(e->type);
222 if (e->file != bs->file) {
223 bdrv_unref(e->file);
224 }
225 }
226 g_free(s->extents);
227 }
228
229 static void vmdk_free_last_extent(BlockDriverState *bs)
230 {
231 BDRVVmdkState *s = bs->opaque;
232
233 if (s->num_extents == 0) {
234 return;
235 }
236 s->num_extents--;
237 s->extents = g_renew(VmdkExtent, s->extents, s->num_extents);
238 }
239
240 static uint32_t vmdk_read_cid(BlockDriverState *bs, int parent)
241 {
242 char desc[DESC_SIZE];
243 uint32_t cid = 0xffffffff;
244 const char *p_name, *cid_str;
245 size_t cid_str_size;
246 BDRVVmdkState *s = bs->opaque;
247 int ret;
248
249 ret = bdrv_pread(bs->file, s->desc_offset, desc, DESC_SIZE);
250 if (ret < 0) {
251 return 0;
252 }
253
254 if (parent) {
255 cid_str = "parentCID";
256 cid_str_size = sizeof("parentCID");
257 } else {
258 cid_str = "CID";
259 cid_str_size = sizeof("CID");
260 }
261
262 desc[DESC_SIZE - 1] = '\0';
263 p_name = strstr(desc, cid_str);
264 if (p_name != NULL) {
265 p_name += cid_str_size;
266 sscanf(p_name, "%" SCNx32, &cid);
267 }
268
269 return cid;
270 }
271
272 static int vmdk_write_cid(BlockDriverState *bs, uint32_t cid)
273 {
274 char desc[DESC_SIZE], tmp_desc[DESC_SIZE];
275 char *p_name, *tmp_str;
276 BDRVVmdkState *s = bs->opaque;
277 int ret;
278
279 ret = bdrv_pread(bs->file, s->desc_offset, desc, DESC_SIZE);
280 if (ret < 0) {
281 return ret;
282 }
283
284 desc[DESC_SIZE - 1] = '\0';
285 tmp_str = strstr(desc, "parentCID");
286 if (tmp_str == NULL) {
287 return -EINVAL;
288 }
289
290 pstrcpy(tmp_desc, sizeof(tmp_desc), tmp_str);
291 p_name = strstr(desc, "CID");
292 if (p_name != NULL) {
293 p_name += sizeof("CID");
294 snprintf(p_name, sizeof(desc) - (p_name - desc), "%" PRIx32 "\n", cid);
295 pstrcat(desc, sizeof(desc), tmp_desc);
296 }
297
298 ret = bdrv_pwrite_sync(bs->file, s->desc_offset, desc, DESC_SIZE);
299 if (ret < 0) {
300 return ret;
301 }
302
303 return 0;
304 }
305
306 static int vmdk_is_cid_valid(BlockDriverState *bs)
307 {
308 BDRVVmdkState *s = bs->opaque;
309 BlockDriverState *p_bs = bs->backing_hd;
310 uint32_t cur_pcid;
311
312 if (!s->cid_checked && p_bs) {
313 cur_pcid = vmdk_read_cid(p_bs, 0);
314 if (s->parent_cid != cur_pcid) {
315 /* CID not valid */
316 return 0;
317 }
318 }
319 s->cid_checked = true;
320 /* CID valid */
321 return 1;
322 }
323
324 /* Queue extents, if any, for reopen() */
325 static int vmdk_reopen_prepare(BDRVReopenState *state,
326 BlockReopenQueue *queue, Error **errp)
327 {
328 BDRVVmdkState *s;
329 int ret = -1;
330 int i;
331 VmdkExtent *e;
332
333 assert(state != NULL);
334 assert(state->bs != NULL);
335
336 if (queue == NULL) {
337 error_setg(errp, "No reopen queue for VMDK extents");
338 goto exit;
339 }
340
341 s = state->bs->opaque;
342
343 assert(s != NULL);
344
345 for (i = 0; i < s->num_extents; i++) {
346 e = &s->extents[i];
347 if (e->file != state->bs->file) {
348 bdrv_reopen_queue(queue, e->file, state->flags);
349 }
350 }
351 ret = 0;
352
353 exit:
354 return ret;
355 }
356
357 static int vmdk_parent_open(BlockDriverState *bs)
358 {
359 char *p_name;
360 char desc[DESC_SIZE + 1];
361 BDRVVmdkState *s = bs->opaque;
362 int ret;
363
364 desc[DESC_SIZE] = '\0';
365 ret = bdrv_pread(bs->file, s->desc_offset, desc, DESC_SIZE);
366 if (ret < 0) {
367 return ret;
368 }
369
370 p_name = strstr(desc, "parentFileNameHint");
371 if (p_name != NULL) {
372 char *end_name;
373
374 p_name += sizeof("parentFileNameHint") + 1;
375 end_name = strchr(p_name, '\"');
376 if (end_name == NULL) {
377 return -EINVAL;
378 }
379 if ((end_name - p_name) > sizeof(bs->backing_file) - 1) {
380 return -EINVAL;
381 }
382
383 pstrcpy(bs->backing_file, end_name - p_name + 1, p_name);
384 }
385
386 return 0;
387 }
388
389 /* Create and append extent to the extent array. Return the added VmdkExtent
390 * address. return NULL if allocation failed. */
391 static int vmdk_add_extent(BlockDriverState *bs,
392 BlockDriverState *file, bool flat, int64_t sectors,
393 int64_t l1_offset, int64_t l1_backup_offset,
394 uint32_t l1_size,
395 int l2_size, uint64_t cluster_sectors,
396 VmdkExtent **new_extent,
397 Error **errp)
398 {
399 VmdkExtent *extent;
400 BDRVVmdkState *s = bs->opaque;
401 int64_t nb_sectors;
402
403 if (cluster_sectors > 0x200000) {
404 /* 0x200000 * 512Bytes = 1GB for one cluster is unrealistic */
405 error_setg(errp, "Invalid granularity, image may be corrupt");
406 return -EFBIG;
407 }
408 if (l1_size > 512 * 1024 * 1024) {
409 /* Although with big capacity and small l1_entry_sectors, we can get a
410 * big l1_size, we don't want unbounded value to allocate the table.
411 * Limit it to 512M, which is 16PB for default cluster and L2 table
412 * size */
413 error_setg(errp, "L1 size too big");
414 return -EFBIG;
415 }
416
417 nb_sectors = bdrv_nb_sectors(file);
418 if (nb_sectors < 0) {
419 return nb_sectors;
420 }
421
422 s->extents = g_renew(VmdkExtent, s->extents, s->num_extents + 1);
423 extent = &s->extents[s->num_extents];
424 s->num_extents++;
425
426 memset(extent, 0, sizeof(VmdkExtent));
427 extent->file = file;
428 extent->flat = flat;
429 extent->sectors = sectors;
430 extent->l1_table_offset = l1_offset;
431 extent->l1_backup_table_offset = l1_backup_offset;
432 extent->l1_size = l1_size;
433 extent->l1_entry_sectors = l2_size * cluster_sectors;
434 extent->l2_size = l2_size;
435 extent->cluster_sectors = flat ? sectors : cluster_sectors;
436 extent->next_cluster_sector = ROUND_UP(nb_sectors, cluster_sectors);
437
438 if (s->num_extents > 1) {
439 extent->end_sector = (*(extent - 1)).end_sector + extent->sectors;
440 } else {
441 extent->end_sector = extent->sectors;
442 }
443 bs->total_sectors = extent->end_sector;
444 if (new_extent) {
445 *new_extent = extent;
446 }
447 return 0;
448 }
449
450 static int vmdk_init_tables(BlockDriverState *bs, VmdkExtent *extent,
451 Error **errp)
452 {
453 int ret;
454 int l1_size, i;
455
456 /* read the L1 table */
457 l1_size = extent->l1_size * sizeof(uint32_t);
458 extent->l1_table = g_try_malloc(l1_size);
459 if (l1_size && extent->l1_table == NULL) {
460 return -ENOMEM;
461 }
462
463 ret = bdrv_pread(extent->file,
464 extent->l1_table_offset,
465 extent->l1_table,
466 l1_size);
467 if (ret < 0) {
468 error_setg_errno(errp, -ret,
469 "Could not read l1 table from extent '%s'",
470 extent->file->filename);
471 goto fail_l1;
472 }
473 for (i = 0; i < extent->l1_size; i++) {
474 le32_to_cpus(&extent->l1_table[i]);
475 }
476
477 if (extent->l1_backup_table_offset) {
478 extent->l1_backup_table = g_try_malloc(l1_size);
479 if (l1_size && extent->l1_backup_table == NULL) {
480 ret = -ENOMEM;
481 goto fail_l1;
482 }
483 ret = bdrv_pread(extent->file,
484 extent->l1_backup_table_offset,
485 extent->l1_backup_table,
486 l1_size);
487 if (ret < 0) {
488 error_setg_errno(errp, -ret,
489 "Could not read l1 backup table from extent '%s'",
490 extent->file->filename);
491 goto fail_l1b;
492 }
493 for (i = 0; i < extent->l1_size; i++) {
494 le32_to_cpus(&extent->l1_backup_table[i]);
495 }
496 }
497
498 extent->l2_cache =
499 g_new(uint32_t, extent->l2_size * L2_CACHE_SIZE);
500 return 0;
501 fail_l1b:
502 g_free(extent->l1_backup_table);
503 fail_l1:
504 g_free(extent->l1_table);
505 return ret;
506 }
507
508 static int vmdk_open_vmfs_sparse(BlockDriverState *bs,
509 BlockDriverState *file,
510 int flags, Error **errp)
511 {
512 int ret;
513 uint32_t magic;
514 VMDK3Header header;
515 VmdkExtent *extent;
516
517 ret = bdrv_pread(file, sizeof(magic), &header, sizeof(header));
518 if (ret < 0) {
519 error_setg_errno(errp, -ret,
520 "Could not read header from file '%s'",
521 file->filename);
522 return ret;
523 }
524 ret = vmdk_add_extent(bs, file, false,
525 le32_to_cpu(header.disk_sectors),
526 le32_to_cpu(header.l1dir_offset) << 9,
527 0,
528 le32_to_cpu(header.l1dir_size),
529 4096,
530 le32_to_cpu(header.granularity),
531 &extent,
532 errp);
533 if (ret < 0) {
534 return ret;
535 }
536 ret = vmdk_init_tables(bs, extent, errp);
537 if (ret) {
538 /* free extent allocated by vmdk_add_extent */
539 vmdk_free_last_extent(bs);
540 }
541 return ret;
542 }
543
544 static int vmdk_open_desc_file(BlockDriverState *bs, int flags, char *buf,
545 Error **errp);
546
547 static char *vmdk_read_desc(BlockDriverState *file, uint64_t desc_offset,
548 Error **errp)
549 {
550 int64_t size;
551 char *buf;
552 int ret;
553
554 size = bdrv_getlength(file);
555 if (size < 0) {
556 error_setg_errno(errp, -size, "Could not access file");
557 return NULL;
558 }
559
560 if (size < 4) {
561 /* Both descriptor file and sparse image must be much larger than 4
562 * bytes, also callers of vmdk_read_desc want to compare the first 4
563 * bytes with VMDK4_MAGIC, let's error out if less is read. */
564 error_setg(errp, "File is too small, not a valid image");
565 return NULL;
566 }
567
568 size = MIN(size, (1 << 20) - 1); /* avoid unbounded allocation */
569 buf = g_malloc(size + 1);
570
571 ret = bdrv_pread(file, desc_offset, buf, size);
572 if (ret < 0) {
573 error_setg_errno(errp, -ret, "Could not read from file");
574 g_free(buf);
575 return NULL;
576 }
577 buf[ret] = 0;
578
579 return buf;
580 }
581
582 static int vmdk_open_vmdk4(BlockDriverState *bs,
583 BlockDriverState *file,
584 int flags, Error **errp)
585 {
586 int ret;
587 uint32_t magic;
588 uint32_t l1_size, l1_entry_sectors;
589 VMDK4Header header;
590 VmdkExtent *extent;
591 BDRVVmdkState *s = bs->opaque;
592 int64_t l1_backup_offset = 0;
593
594 ret = bdrv_pread(file, sizeof(magic), &header, sizeof(header));
595 if (ret < 0) {
596 error_setg_errno(errp, -ret,
597 "Could not read header from file '%s'",
598 file->filename);
599 return -EINVAL;
600 }
601 if (header.capacity == 0) {
602 uint64_t desc_offset = le64_to_cpu(header.desc_offset);
603 if (desc_offset) {
604 char *buf = vmdk_read_desc(file, desc_offset << 9, errp);
605 if (!buf) {
606 return -EINVAL;
607 }
608 ret = vmdk_open_desc_file(bs, flags, buf, errp);
609 g_free(buf);
610 return ret;
611 }
612 }
613
614 if (!s->create_type) {
615 s->create_type = g_strdup("monolithicSparse");
616 }
617
618 if (le64_to_cpu(header.gd_offset) == VMDK4_GD_AT_END) {
619 /*
620 * The footer takes precedence over the header, so read it in. The
621 * footer starts at offset -1024 from the end: One sector for the
622 * footer, and another one for the end-of-stream marker.
623 */
624 struct {
625 struct {
626 uint64_t val;
627 uint32_t size;
628 uint32_t type;
629 uint8_t pad[512 - 16];
630 } QEMU_PACKED footer_marker;
631
632 uint32_t magic;
633 VMDK4Header header;
634 uint8_t pad[512 - 4 - sizeof(VMDK4Header)];
635
636 struct {
637 uint64_t val;
638 uint32_t size;
639 uint32_t type;
640 uint8_t pad[512 - 16];
641 } QEMU_PACKED eos_marker;
642 } QEMU_PACKED footer;
643
644 ret = bdrv_pread(file,
645 bs->file->total_sectors * 512 - 1536,
646 &footer, sizeof(footer));
647 if (ret < 0) {
648 error_setg_errno(errp, -ret, "Failed to read footer");
649 return ret;
650 }
651
652 /* Some sanity checks for the footer */
653 if (be32_to_cpu(footer.magic) != VMDK4_MAGIC ||
654 le32_to_cpu(footer.footer_marker.size) != 0 ||
655 le32_to_cpu(footer.footer_marker.type) != MARKER_FOOTER ||
656 le64_to_cpu(footer.eos_marker.val) != 0 ||
657 le32_to_cpu(footer.eos_marker.size) != 0 ||
658 le32_to_cpu(footer.eos_marker.type) != MARKER_END_OF_STREAM)
659 {
660 error_setg(errp, "Invalid footer");
661 return -EINVAL;
662 }
663
664 header = footer.header;
665 }
666
667 if (le32_to_cpu(header.version) > 3) {
668 char buf[64];
669 snprintf(buf, sizeof(buf), "VMDK version %" PRId32,
670 le32_to_cpu(header.version));
671 error_set(errp, QERR_UNKNOWN_BLOCK_FORMAT_FEATURE,
672 bdrv_get_device_name(bs), "vmdk", buf);
673 return -ENOTSUP;
674 } else if (le32_to_cpu(header.version) == 3 && (flags & BDRV_O_RDWR)) {
675 /* VMware KB 2064959 explains that version 3 added support for
676 * persistent changed block tracking (CBT), and backup software can
677 * read it as version=1 if it doesn't care about the changed area
678 * information. So we are safe to enable read only. */
679 error_setg(errp, "VMDK version 3 must be read only");
680 return -EINVAL;
681 }
682
683 if (le32_to_cpu(header.num_gtes_per_gt) > 512) {
684 error_setg(errp, "L2 table size too big");
685 return -EINVAL;
686 }
687
688 l1_entry_sectors = le32_to_cpu(header.num_gtes_per_gt)
689 * le64_to_cpu(header.granularity);
690 if (l1_entry_sectors == 0) {
691 error_setg(errp, "L1 entry size is invalid");
692 return -EINVAL;
693 }
694 l1_size = (le64_to_cpu(header.capacity) + l1_entry_sectors - 1)
695 / l1_entry_sectors;
696 if (le32_to_cpu(header.flags) & VMDK4_FLAG_RGD) {
697 l1_backup_offset = le64_to_cpu(header.rgd_offset) << 9;
698 }
699 if (bdrv_nb_sectors(file) < le64_to_cpu(header.grain_offset)) {
700 error_setg(errp, "File truncated, expecting at least %" PRId64 " bytes",
701 (int64_t)(le64_to_cpu(header.grain_offset)
702 * BDRV_SECTOR_SIZE));
703 return -EINVAL;
704 }
705
706 ret = vmdk_add_extent(bs, file, false,
707 le64_to_cpu(header.capacity),
708 le64_to_cpu(header.gd_offset) << 9,
709 l1_backup_offset,
710 l1_size,
711 le32_to_cpu(header.num_gtes_per_gt),
712 le64_to_cpu(header.granularity),
713 &extent,
714 errp);
715 if (ret < 0) {
716 return ret;
717 }
718 extent->compressed =
719 le16_to_cpu(header.compressAlgorithm) == VMDK4_COMPRESSION_DEFLATE;
720 if (extent->compressed) {
721 g_free(s->create_type);
722 s->create_type = g_strdup("streamOptimized");
723 }
724 extent->has_marker = le32_to_cpu(header.flags) & VMDK4_FLAG_MARKER;
725 extent->version = le32_to_cpu(header.version);
726 extent->has_zero_grain = le32_to_cpu(header.flags) & VMDK4_FLAG_ZERO_GRAIN;
727 ret = vmdk_init_tables(bs, extent, errp);
728 if (ret) {
729 /* free extent allocated by vmdk_add_extent */
730 vmdk_free_last_extent(bs);
731 }
732 return ret;
733 }
734
735 /* find an option value out of descriptor file */
736 static int vmdk_parse_description(const char *desc, const char *opt_name,
737 char *buf, int buf_size)
738 {
739 char *opt_pos, *opt_end;
740 const char *end = desc + strlen(desc);
741
742 opt_pos = strstr(desc, opt_name);
743 if (!opt_pos) {
744 return VMDK_ERROR;
745 }
746 /* Skip "=\"" following opt_name */
747 opt_pos += strlen(opt_name) + 2;
748 if (opt_pos >= end) {
749 return VMDK_ERROR;
750 }
751 opt_end = opt_pos;
752 while (opt_end < end && *opt_end != '"') {
753 opt_end++;
754 }
755 if (opt_end == end || buf_size < opt_end - opt_pos + 1) {
756 return VMDK_ERROR;
757 }
758 pstrcpy(buf, opt_end - opt_pos + 1, opt_pos);
759 return VMDK_OK;
760 }
761
762 /* Open an extent file and append to bs array */
763 static int vmdk_open_sparse(BlockDriverState *bs,
764 BlockDriverState *file, int flags,
765 char *buf, Error **errp)
766 {
767 uint32_t magic;
768
769 magic = ldl_be_p(buf);
770 switch (magic) {
771 case VMDK3_MAGIC:
772 return vmdk_open_vmfs_sparse(bs, file, flags, errp);
773 break;
774 case VMDK4_MAGIC:
775 return vmdk_open_vmdk4(bs, file, flags, errp);
776 break;
777 default:
778 error_setg(errp, "Image not in VMDK format");
779 return -EINVAL;
780 break;
781 }
782 }
783
784 static int vmdk_parse_extents(const char *desc, BlockDriverState *bs,
785 const char *desc_file_path, Error **errp)
786 {
787 int ret;
788 char access[11];
789 char type[11];
790 char fname[512];
791 const char *p = desc;
792 int64_t sectors = 0;
793 int64_t flat_offset;
794 char extent_path[PATH_MAX];
795 BlockDriverState *extent_file;
796 BDRVVmdkState *s = bs->opaque;
797 VmdkExtent *extent;
798
799 while (*p) {
800 /* parse extent line in one of below formats:
801 *
802 * RW [size in sectors] FLAT "file-name.vmdk" OFFSET
803 * RW [size in sectors] SPARSE "file-name.vmdk"
804 * RW [size in sectors] VMFS "file-name.vmdk"
805 * RW [size in sectors] VMFSSPARSE "file-name.vmdk"
806 */
807 flat_offset = -1;
808 ret = sscanf(p, "%10s %" SCNd64 " %10s \"%511[^\n\r\"]\" %" SCNd64,
809 access, &sectors, type, fname, &flat_offset);
810 if (ret < 4 || strcmp(access, "RW")) {
811 goto next_line;
812 } else if (!strcmp(type, "FLAT")) {
813 if (ret != 5 || flat_offset < 0) {
814 error_setg(errp, "Invalid extent lines: \n%s", p);
815 return -EINVAL;
816 }
817 } else if (!strcmp(type, "VMFS")) {
818 if (ret == 4) {
819 flat_offset = 0;
820 } else {
821 error_setg(errp, "Invalid extent lines:\n%s", p);
822 return -EINVAL;
823 }
824 } else if (ret != 4) {
825 error_setg(errp, "Invalid extent lines:\n%s", p);
826 return -EINVAL;
827 }
828
829 if (sectors <= 0 ||
830 (strcmp(type, "FLAT") && strcmp(type, "SPARSE") &&
831 strcmp(type, "VMFS") && strcmp(type, "VMFSSPARSE")) ||
832 (strcmp(access, "RW"))) {
833 goto next_line;
834 }
835
836 path_combine(extent_path, sizeof(extent_path),
837 desc_file_path, fname);
838 extent_file = NULL;
839 ret = bdrv_open(&extent_file, extent_path, NULL, NULL,
840 bs->open_flags | BDRV_O_PROTOCOL, NULL, errp);
841 if (ret) {
842 return ret;
843 }
844
845 /* save to extents array */
846 if (!strcmp(type, "FLAT") || !strcmp(type, "VMFS")) {
847 /* FLAT extent */
848
849 ret = vmdk_add_extent(bs, extent_file, true, sectors,
850 0, 0, 0, 0, 0, &extent, errp);
851 if (ret < 0) {
852 bdrv_unref(extent_file);
853 return ret;
854 }
855 extent->flat_start_offset = flat_offset << 9;
856 } else if (!strcmp(type, "SPARSE") || !strcmp(type, "VMFSSPARSE")) {
857 /* SPARSE extent and VMFSSPARSE extent are both "COWD" sparse file*/
858 char *buf = vmdk_read_desc(extent_file, 0, errp);
859 if (!buf) {
860 ret = -EINVAL;
861 } else {
862 ret = vmdk_open_sparse(bs, extent_file, bs->open_flags, buf, errp);
863 }
864 g_free(buf);
865 if (ret) {
866 bdrv_unref(extent_file);
867 return ret;
868 }
869 extent = &s->extents[s->num_extents - 1];
870 } else {
871 error_setg(errp, "Unsupported extent type '%s'", type);
872 bdrv_unref(extent_file);
873 return -ENOTSUP;
874 }
875 extent->type = g_strdup(type);
876 next_line:
877 /* move to next line */
878 while (*p) {
879 if (*p == '\n') {
880 p++;
881 break;
882 }
883 p++;
884 }
885 }
886 return 0;
887 }
888
889 static int vmdk_open_desc_file(BlockDriverState *bs, int flags, char *buf,
890 Error **errp)
891 {
892 int ret;
893 char ct[128];
894 BDRVVmdkState *s = bs->opaque;
895
896 if (vmdk_parse_description(buf, "createType", ct, sizeof(ct))) {
897 error_setg(errp, "invalid VMDK image descriptor");
898 ret = -EINVAL;
899 goto exit;
900 }
901 if (strcmp(ct, "monolithicFlat") &&
902 strcmp(ct, "vmfs") &&
903 strcmp(ct, "vmfsSparse") &&
904 strcmp(ct, "twoGbMaxExtentSparse") &&
905 strcmp(ct, "twoGbMaxExtentFlat")) {
906 error_setg(errp, "Unsupported image type '%s'", ct);
907 ret = -ENOTSUP;
908 goto exit;
909 }
910 s->create_type = g_strdup(ct);
911 s->desc_offset = 0;
912 ret = vmdk_parse_extents(buf, bs, bs->file->filename, errp);
913 exit:
914 return ret;
915 }
916
917 static int vmdk_open(BlockDriverState *bs, QDict *options, int flags,
918 Error **errp)
919 {
920 char *buf;
921 int ret;
922 BDRVVmdkState *s = bs->opaque;
923 uint32_t magic;
924
925 buf = vmdk_read_desc(bs->file, 0, errp);
926 if (!buf) {
927 return -EINVAL;
928 }
929
930 magic = ldl_be_p(buf);
931 switch (magic) {
932 case VMDK3_MAGIC:
933 case VMDK4_MAGIC:
934 ret = vmdk_open_sparse(bs, bs->file, flags, buf, errp);
935 s->desc_offset = 0x200;
936 break;
937 default:
938 ret = vmdk_open_desc_file(bs, flags, buf, errp);
939 break;
940 }
941 if (ret) {
942 goto fail;
943 }
944
945 /* try to open parent images, if exist */
946 ret = vmdk_parent_open(bs);
947 if (ret) {
948 goto fail;
949 }
950 s->cid = vmdk_read_cid(bs, 0);
951 s->parent_cid = vmdk_read_cid(bs, 1);
952 qemu_co_mutex_init(&s->lock);
953
954 /* Disable migration when VMDK images are used */
955 error_set(&s->migration_blocker,
956 QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
957 "vmdk", bdrv_get_device_name(bs), "live migration");
958 migrate_add_blocker(s->migration_blocker);
959 g_free(buf);
960 return 0;
961
962 fail:
963 g_free(buf);
964 g_free(s->create_type);
965 s->create_type = NULL;
966 vmdk_free_extents(bs);
967 return ret;
968 }
969
970
971 static void vmdk_refresh_limits(BlockDriverState *bs, Error **errp)
972 {
973 BDRVVmdkState *s = bs->opaque;
974 int i;
975
976 for (i = 0; i < s->num_extents; i++) {
977 if (!s->extents[i].flat) {
978 bs->bl.write_zeroes_alignment =
979 MAX(bs->bl.write_zeroes_alignment,
980 s->extents[i].cluster_sectors);
981 }
982 }
983 }
984
985 /**
986 * get_whole_cluster
987 *
988 * Copy backing file's cluster that covers @sector_num, otherwise write zero,
989 * to the cluster at @cluster_sector_num.
990 *
991 * If @skip_start_sector < @skip_end_sector, the relative range
992 * [@skip_start_sector, @skip_end_sector) is not copied or written, and leave
993 * it for call to write user data in the request.
994 */
995 static int get_whole_cluster(BlockDriverState *bs,
996 VmdkExtent *extent,
997 uint64_t cluster_sector_num,
998 uint64_t sector_num,
999 uint64_t skip_start_sector,
1000 uint64_t skip_end_sector)
1001 {
1002 int ret = VMDK_OK;
1003 int64_t cluster_bytes;
1004 uint8_t *whole_grain;
1005
1006 /* For COW, align request sector_num to cluster start */
1007 sector_num = QEMU_ALIGN_DOWN(sector_num, extent->cluster_sectors);
1008 cluster_bytes = extent->cluster_sectors << BDRV_SECTOR_BITS;
1009 whole_grain = qemu_blockalign(bs, cluster_bytes);
1010
1011 if (!bs->backing_hd) {
1012 memset(whole_grain, 0, skip_start_sector << BDRV_SECTOR_BITS);
1013 memset(whole_grain + (skip_end_sector << BDRV_SECTOR_BITS), 0,
1014 cluster_bytes - (skip_end_sector << BDRV_SECTOR_BITS));
1015 }
1016
1017 assert(skip_end_sector <= extent->cluster_sectors);
1018 /* we will be here if it's first write on non-exist grain(cluster).
1019 * try to read from parent image, if exist */
1020 if (bs->backing_hd && !vmdk_is_cid_valid(bs)) {
1021 ret = VMDK_ERROR;
1022 goto exit;
1023 }
1024
1025 /* Read backing data before skip range */
1026 if (skip_start_sector > 0) {
1027 if (bs->backing_hd) {
1028 ret = bdrv_read(bs->backing_hd, sector_num,
1029 whole_grain, skip_start_sector);
1030 if (ret < 0) {
1031 ret = VMDK_ERROR;
1032 goto exit;
1033 }
1034 }
1035 ret = bdrv_write(extent->file, cluster_sector_num, whole_grain,
1036 skip_start_sector);
1037 if (ret < 0) {
1038 ret = VMDK_ERROR;
1039 goto exit;
1040 }
1041 }
1042 /* Read backing data after skip range */
1043 if (skip_end_sector < extent->cluster_sectors) {
1044 if (bs->backing_hd) {
1045 ret = bdrv_read(bs->backing_hd, sector_num + skip_end_sector,
1046 whole_grain + (skip_end_sector << BDRV_SECTOR_BITS),
1047 extent->cluster_sectors - skip_end_sector);
1048 if (ret < 0) {
1049 ret = VMDK_ERROR;
1050 goto exit;
1051 }
1052 }
1053 ret = bdrv_write(extent->file, cluster_sector_num + skip_end_sector,
1054 whole_grain + (skip_end_sector << BDRV_SECTOR_BITS),
1055 extent->cluster_sectors - skip_end_sector);
1056 if (ret < 0) {
1057 ret = VMDK_ERROR;
1058 goto exit;
1059 }
1060 }
1061
1062 exit:
1063 qemu_vfree(whole_grain);
1064 return ret;
1065 }
1066
1067 static int vmdk_L2update(VmdkExtent *extent, VmdkMetaData *m_data,
1068 uint32_t offset)
1069 {
1070 offset = cpu_to_le32(offset);
1071 /* update L2 table */
1072 if (bdrv_pwrite_sync(
1073 extent->file,
1074 ((int64_t)m_data->l2_offset * 512)
1075 + (m_data->l2_index * sizeof(offset)),
1076 &offset, sizeof(offset)) < 0) {
1077 return VMDK_ERROR;
1078 }
1079 /* update backup L2 table */
1080 if (extent->l1_backup_table_offset != 0) {
1081 m_data->l2_offset = extent->l1_backup_table[m_data->l1_index];
1082 if (bdrv_pwrite_sync(
1083 extent->file,
1084 ((int64_t)m_data->l2_offset * 512)
1085 + (m_data->l2_index * sizeof(offset)),
1086 &offset, sizeof(offset)) < 0) {
1087 return VMDK_ERROR;
1088 }
1089 }
1090 if (m_data->l2_cache_entry) {
1091 *m_data->l2_cache_entry = offset;
1092 }
1093
1094 return VMDK_OK;
1095 }
1096
1097 /**
1098 * get_cluster_offset
1099 *
1100 * Look up cluster offset in extent file by sector number, and store in
1101 * @cluster_offset.
1102 *
1103 * For flat extents, the start offset as parsed from the description file is
1104 * returned.
1105 *
1106 * For sparse extents, look up in L1, L2 table. If allocate is true, return an
1107 * offset for a new cluster and update L2 cache. If there is a backing file,
1108 * COW is done before returning; otherwise, zeroes are written to the allocated
1109 * cluster. Both COW and zero writing skips the sector range
1110 * [@skip_start_sector, @skip_end_sector) passed in by caller, because caller
1111 * has new data to write there.
1112 *
1113 * Returns: VMDK_OK if cluster exists and mapped in the image.
1114 * VMDK_UNALLOC if cluster is not mapped and @allocate is false.
1115 * VMDK_ERROR if failed.
1116 */
1117 static int get_cluster_offset(BlockDriverState *bs,
1118 VmdkExtent *extent,
1119 VmdkMetaData *m_data,
1120 uint64_t offset,
1121 bool allocate,
1122 uint64_t *cluster_offset,
1123 uint64_t skip_start_sector,
1124 uint64_t skip_end_sector)
1125 {
1126 unsigned int l1_index, l2_offset, l2_index;
1127 int min_index, i, j;
1128 uint32_t min_count, *l2_table;
1129 bool zeroed = false;
1130 int64_t ret;
1131 int64_t cluster_sector;
1132
1133 if (m_data) {
1134 m_data->valid = 0;
1135 }
1136 if (extent->flat) {
1137 *cluster_offset = extent->flat_start_offset;
1138 return VMDK_OK;
1139 }
1140
1141 offset -= (extent->end_sector - extent->sectors) * SECTOR_SIZE;
1142 l1_index = (offset >> 9) / extent->l1_entry_sectors;
1143 if (l1_index >= extent->l1_size) {
1144 return VMDK_ERROR;
1145 }
1146 l2_offset = extent->l1_table[l1_index];
1147 if (!l2_offset) {
1148 return VMDK_UNALLOC;
1149 }
1150 for (i = 0; i < L2_CACHE_SIZE; i++) {
1151 if (l2_offset == extent->l2_cache_offsets[i]) {
1152 /* increment the hit count */
1153 if (++extent->l2_cache_counts[i] == 0xffffffff) {
1154 for (j = 0; j < L2_CACHE_SIZE; j++) {
1155 extent->l2_cache_counts[j] >>= 1;
1156 }
1157 }
1158 l2_table = extent->l2_cache + (i * extent->l2_size);
1159 goto found;
1160 }
1161 }
1162 /* not found: load a new entry in the least used one */
1163 min_index = 0;
1164 min_count = 0xffffffff;
1165 for (i = 0; i < L2_CACHE_SIZE; i++) {
1166 if (extent->l2_cache_counts[i] < min_count) {
1167 min_count = extent->l2_cache_counts[i];
1168 min_index = i;
1169 }
1170 }
1171 l2_table = extent->l2_cache + (min_index * extent->l2_size);
1172 if (bdrv_pread(
1173 extent->file,
1174 (int64_t)l2_offset * 512,
1175 l2_table,
1176 extent->l2_size * sizeof(uint32_t)
1177 ) != extent->l2_size * sizeof(uint32_t)) {
1178 return VMDK_ERROR;
1179 }
1180
1181 extent->l2_cache_offsets[min_index] = l2_offset;
1182 extent->l2_cache_counts[min_index] = 1;
1183 found:
1184 l2_index = ((offset >> 9) / extent->cluster_sectors) % extent->l2_size;
1185 cluster_sector = le32_to_cpu(l2_table[l2_index]);
1186
1187 if (m_data) {
1188 m_data->valid = 1;
1189 m_data->l1_index = l1_index;
1190 m_data->l2_index = l2_index;
1191 m_data->l2_offset = l2_offset;
1192 m_data->l2_cache_entry = &l2_table[l2_index];
1193 }
1194 if (extent->has_zero_grain && cluster_sector == VMDK_GTE_ZEROED) {
1195 zeroed = true;
1196 }
1197
1198 if (!cluster_sector || zeroed) {
1199 if (!allocate) {
1200 return zeroed ? VMDK_ZEROED : VMDK_UNALLOC;
1201 }
1202
1203 cluster_sector = extent->next_cluster_sector;
1204 extent->next_cluster_sector += extent->cluster_sectors;
1205
1206 /* First of all we write grain itself, to avoid race condition
1207 * that may to corrupt the image.
1208 * This problem may occur because of insufficient space on host disk
1209 * or inappropriate VM shutdown.
1210 */
1211 ret = get_whole_cluster(bs, extent,
1212 cluster_sector,
1213 offset >> BDRV_SECTOR_BITS,
1214 skip_start_sector, skip_end_sector);
1215 if (ret) {
1216 return ret;
1217 }
1218 }
1219 *cluster_offset = cluster_sector << BDRV_SECTOR_BITS;
1220 return VMDK_OK;
1221 }
1222
1223 static VmdkExtent *find_extent(BDRVVmdkState *s,
1224 int64_t sector_num, VmdkExtent *start_hint)
1225 {
1226 VmdkExtent *extent = start_hint;
1227
1228 if (!extent) {
1229 extent = &s->extents[0];
1230 }
1231 while (extent < &s->extents[s->num_extents]) {
1232 if (sector_num < extent->end_sector) {
1233 return extent;
1234 }
1235 extent++;
1236 }
1237 return NULL;
1238 }
1239
1240 static int64_t coroutine_fn vmdk_co_get_block_status(BlockDriverState *bs,
1241 int64_t sector_num, int nb_sectors, int *pnum)
1242 {
1243 BDRVVmdkState *s = bs->opaque;
1244 int64_t index_in_cluster, n, ret;
1245 uint64_t offset;
1246 VmdkExtent *extent;
1247
1248 extent = find_extent(s, sector_num, NULL);
1249 if (!extent) {
1250 return 0;
1251 }
1252 qemu_co_mutex_lock(&s->lock);
1253 ret = get_cluster_offset(bs, extent, NULL,
1254 sector_num * 512, false, &offset,
1255 0, 0);
1256 qemu_co_mutex_unlock(&s->lock);
1257
1258 switch (ret) {
1259 case VMDK_ERROR:
1260 ret = -EIO;
1261 break;
1262 case VMDK_UNALLOC:
1263 ret = 0;
1264 break;
1265 case VMDK_ZEROED:
1266 ret = BDRV_BLOCK_ZERO;
1267 break;
1268 case VMDK_OK:
1269 ret = BDRV_BLOCK_DATA;
1270 if (extent->file == bs->file && !extent->compressed) {
1271 ret |= BDRV_BLOCK_OFFSET_VALID | offset;
1272 }
1273
1274 break;
1275 }
1276
1277 index_in_cluster = sector_num % extent->cluster_sectors;
1278 n = extent->cluster_sectors - index_in_cluster;
1279 if (n > nb_sectors) {
1280 n = nb_sectors;
1281 }
1282 *pnum = n;
1283 return ret;
1284 }
1285
1286 static int vmdk_write_extent(VmdkExtent *extent, int64_t cluster_offset,
1287 int64_t offset_in_cluster, const uint8_t *buf,
1288 int nb_sectors, int64_t sector_num)
1289 {
1290 int ret;
1291 VmdkGrainMarker *data = NULL;
1292 uLongf buf_len;
1293 const uint8_t *write_buf = buf;
1294 int write_len = nb_sectors * 512;
1295
1296 if (extent->compressed) {
1297 if (!extent->has_marker) {
1298 ret = -EINVAL;
1299 goto out;
1300 }
1301 buf_len = (extent->cluster_sectors << 9) * 2;
1302 data = g_malloc(buf_len + sizeof(VmdkGrainMarker));
1303 if (compress(data->data, &buf_len, buf, nb_sectors << 9) != Z_OK ||
1304 buf_len == 0) {
1305 ret = -EINVAL;
1306 goto out;
1307 }
1308 data->lba = sector_num;
1309 data->size = buf_len;
1310 write_buf = (uint8_t *)data;
1311 write_len = buf_len + sizeof(VmdkGrainMarker);
1312 }
1313 ret = bdrv_pwrite(extent->file,
1314 cluster_offset + offset_in_cluster,
1315 write_buf,
1316 write_len);
1317 if (ret != write_len) {
1318 ret = ret < 0 ? ret : -EIO;
1319 goto out;
1320 }
1321 ret = 0;
1322 out:
1323 g_free(data);
1324 return ret;
1325 }
1326
1327 static int vmdk_read_extent(VmdkExtent *extent, int64_t cluster_offset,
1328 int64_t offset_in_cluster, uint8_t *buf,
1329 int nb_sectors)
1330 {
1331 int ret;
1332 int cluster_bytes, buf_bytes;
1333 uint8_t *cluster_buf, *compressed_data;
1334 uint8_t *uncomp_buf;
1335 uint32_t data_len;
1336 VmdkGrainMarker *marker;
1337 uLongf buf_len;
1338
1339
1340 if (!extent->compressed) {
1341 ret = bdrv_pread(extent->file,
1342 cluster_offset + offset_in_cluster,
1343 buf, nb_sectors * 512);
1344 if (ret == nb_sectors * 512) {
1345 return 0;
1346 } else {
1347 return -EIO;
1348 }
1349 }
1350 cluster_bytes = extent->cluster_sectors * 512;
1351 /* Read two clusters in case GrainMarker + compressed data > one cluster */
1352 buf_bytes = cluster_bytes * 2;
1353 cluster_buf = g_malloc(buf_bytes);
1354 uncomp_buf = g_malloc(cluster_bytes);
1355 ret = bdrv_pread(extent->file,
1356 cluster_offset,
1357 cluster_buf, buf_bytes);
1358 if (ret < 0) {
1359 goto out;
1360 }
1361 compressed_data = cluster_buf;
1362 buf_len = cluster_bytes;
1363 data_len = cluster_bytes;
1364 if (extent->has_marker) {
1365 marker = (VmdkGrainMarker *)cluster_buf;
1366 compressed_data = marker->data;
1367 data_len = le32_to_cpu(marker->size);
1368 }
1369 if (!data_len || data_len > buf_bytes) {
1370 ret = -EINVAL;
1371 goto out;
1372 }
1373 ret = uncompress(uncomp_buf, &buf_len, compressed_data, data_len);
1374 if (ret != Z_OK) {
1375 ret = -EINVAL;
1376 goto out;
1377
1378 }
1379 if (offset_in_cluster < 0 ||
1380 offset_in_cluster + nb_sectors * 512 > buf_len) {
1381 ret = -EINVAL;
1382 goto out;
1383 }
1384 memcpy(buf, uncomp_buf + offset_in_cluster, nb_sectors * 512);
1385 ret = 0;
1386
1387 out:
1388 g_free(uncomp_buf);
1389 g_free(cluster_buf);
1390 return ret;
1391 }
1392
1393 static int vmdk_read(BlockDriverState *bs, int64_t sector_num,
1394 uint8_t *buf, int nb_sectors)
1395 {
1396 BDRVVmdkState *s = bs->opaque;
1397 int ret;
1398 uint64_t n, index_in_cluster;
1399 uint64_t extent_begin_sector, extent_relative_sector_num;
1400 VmdkExtent *extent = NULL;
1401 uint64_t cluster_offset;
1402
1403 while (nb_sectors > 0) {
1404 extent = find_extent(s, sector_num, extent);
1405 if (!extent) {
1406 return -EIO;
1407 }
1408 ret = get_cluster_offset(bs, extent, NULL,
1409 sector_num << 9, false, &cluster_offset,
1410 0, 0);
1411 extent_begin_sector = extent->end_sector - extent->sectors;
1412 extent_relative_sector_num = sector_num - extent_begin_sector;
1413 index_in_cluster = extent_relative_sector_num % extent->cluster_sectors;
1414 n = extent->cluster_sectors - index_in_cluster;
1415 if (n > nb_sectors) {
1416 n = nb_sectors;
1417 }
1418 if (ret != VMDK_OK) {
1419 /* if not allocated, try to read from parent image, if exist */
1420 if (bs->backing_hd && ret != VMDK_ZEROED) {
1421 if (!vmdk_is_cid_valid(bs)) {
1422 return -EINVAL;
1423 }
1424 ret = bdrv_read(bs->backing_hd, sector_num, buf, n);
1425 if (ret < 0) {
1426 return ret;
1427 }
1428 } else {
1429 memset(buf, 0, 512 * n);
1430 }
1431 } else {
1432 ret = vmdk_read_extent(extent,
1433 cluster_offset, index_in_cluster * 512,
1434 buf, n);
1435 if (ret) {
1436 return ret;
1437 }
1438 }
1439 nb_sectors -= n;
1440 sector_num += n;
1441 buf += n * 512;
1442 }
1443 return 0;
1444 }
1445
1446 static coroutine_fn int vmdk_co_read(BlockDriverState *bs, int64_t sector_num,
1447 uint8_t *buf, int nb_sectors)
1448 {
1449 int ret;
1450 BDRVVmdkState *s = bs->opaque;
1451 qemu_co_mutex_lock(&s->lock);
1452 ret = vmdk_read(bs, sector_num, buf, nb_sectors);
1453 qemu_co_mutex_unlock(&s->lock);
1454 return ret;
1455 }
1456
1457 /**
1458 * vmdk_write:
1459 * @zeroed: buf is ignored (data is zero), use zeroed_grain GTE feature
1460 * if possible, otherwise return -ENOTSUP.
1461 * @zero_dry_run: used for zeroed == true only, don't update L2 table, just try
1462 * with each cluster. By dry run we can find if the zero write
1463 * is possible without modifying image data.
1464 *
1465 * Returns: error code with 0 for success.
1466 */
1467 static int vmdk_write(BlockDriverState *bs, int64_t sector_num,
1468 const uint8_t *buf, int nb_sectors,
1469 bool zeroed, bool zero_dry_run)
1470 {
1471 BDRVVmdkState *s = bs->opaque;
1472 VmdkExtent *extent = NULL;
1473 int ret;
1474 int64_t index_in_cluster, n;
1475 uint64_t extent_begin_sector, extent_relative_sector_num;
1476 uint64_t cluster_offset;
1477 VmdkMetaData m_data;
1478
1479 if (sector_num > bs->total_sectors) {
1480 error_report("Wrong offset: sector_num=0x%" PRIx64
1481 " total_sectors=0x%" PRIx64 "\n",
1482 sector_num, bs->total_sectors);
1483 return -EIO;
1484 }
1485
1486 while (nb_sectors > 0) {
1487 extent = find_extent(s, sector_num, extent);
1488 if (!extent) {
1489 return -EIO;
1490 }
1491 extent_begin_sector = extent->end_sector - extent->sectors;
1492 extent_relative_sector_num = sector_num - extent_begin_sector;
1493 index_in_cluster = extent_relative_sector_num % extent->cluster_sectors;
1494 n = extent->cluster_sectors - index_in_cluster;
1495 if (n > nb_sectors) {
1496 n = nb_sectors;
1497 }
1498 ret = get_cluster_offset(bs, extent, &m_data, sector_num << 9,
1499 !(extent->compressed || zeroed),
1500 &cluster_offset,
1501 index_in_cluster, index_in_cluster + n);
1502 if (extent->compressed) {
1503 if (ret == VMDK_OK) {
1504 /* Refuse write to allocated cluster for streamOptimized */
1505 error_report("Could not write to allocated cluster"
1506 " for streamOptimized");
1507 return -EIO;
1508 } else {
1509 /* allocate */
1510 ret = get_cluster_offset(bs, extent, &m_data, sector_num << 9,
1511 true, &cluster_offset, 0, 0);
1512 }
1513 }
1514 if (ret == VMDK_ERROR) {
1515 return -EINVAL;
1516 }
1517 if (zeroed) {
1518 /* Do zeroed write, buf is ignored */
1519 if (extent->has_zero_grain &&
1520 index_in_cluster == 0 &&
1521 n >= extent->cluster_sectors) {
1522 n = extent->cluster_sectors;
1523 if (!zero_dry_run) {
1524 /* update L2 tables */
1525 if (vmdk_L2update(extent, &m_data, VMDK_GTE_ZEROED)
1526 != VMDK_OK) {
1527 return -EIO;
1528 }
1529 }
1530 } else {
1531 return -ENOTSUP;
1532 }
1533 } else {
1534 ret = vmdk_write_extent(extent,
1535 cluster_offset, index_in_cluster * 512,
1536 buf, n, sector_num);
1537 if (ret) {
1538 return ret;
1539 }
1540 if (m_data.valid) {
1541 /* update L2 tables */
1542 if (vmdk_L2update(extent, &m_data,
1543 cluster_offset >> BDRV_SECTOR_BITS)
1544 != VMDK_OK) {
1545 return -EIO;
1546 }
1547 }
1548 }
1549 nb_sectors -= n;
1550 sector_num += n;
1551 buf += n * 512;
1552
1553 /* update CID on the first write every time the virtual disk is
1554 * opened */
1555 if (!s->cid_updated) {
1556 ret = vmdk_write_cid(bs, g_random_int());
1557 if (ret < 0) {
1558 return ret;
1559 }
1560 s->cid_updated = true;
1561 }
1562 }
1563 return 0;
1564 }
1565
1566 static coroutine_fn int vmdk_co_write(BlockDriverState *bs, int64_t sector_num,
1567 const uint8_t *buf, int nb_sectors)
1568 {
1569 int ret;
1570 BDRVVmdkState *s = bs->opaque;
1571 qemu_co_mutex_lock(&s->lock);
1572 ret = vmdk_write(bs, sector_num, buf, nb_sectors, false, false);
1573 qemu_co_mutex_unlock(&s->lock);
1574 return ret;
1575 }
1576
1577 static int vmdk_write_compressed(BlockDriverState *bs,
1578 int64_t sector_num,
1579 const uint8_t *buf,
1580 int nb_sectors)
1581 {
1582 BDRVVmdkState *s = bs->opaque;
1583 if (s->num_extents == 1 && s->extents[0].compressed) {
1584 return vmdk_write(bs, sector_num, buf, nb_sectors, false, false);
1585 } else {
1586 return -ENOTSUP;
1587 }
1588 }
1589
1590 static int coroutine_fn vmdk_co_write_zeroes(BlockDriverState *bs,
1591 int64_t sector_num,
1592 int nb_sectors,
1593 BdrvRequestFlags flags)
1594 {
1595 int ret;
1596 BDRVVmdkState *s = bs->opaque;
1597 qemu_co_mutex_lock(&s->lock);
1598 /* write zeroes could fail if sectors not aligned to cluster, test it with
1599 * dry_run == true before really updating image */
1600 ret = vmdk_write(bs, sector_num, NULL, nb_sectors, true, true);
1601 if (!ret) {
1602 ret = vmdk_write(bs, sector_num, NULL, nb_sectors, true, false);
1603 }
1604 qemu_co_mutex_unlock(&s->lock);
1605 return ret;
1606 }
1607
1608 static int vmdk_create_extent(const char *filename, int64_t filesize,
1609 bool flat, bool compress, bool zeroed_grain,
1610 QemuOpts *opts, Error **errp)
1611 {
1612 int ret, i;
1613 BlockDriverState *bs = NULL;
1614 VMDK4Header header;
1615 Error *local_err = NULL;
1616 uint32_t tmp, magic, grains, gd_sectors, gt_size, gt_count;
1617 uint32_t *gd_buf = NULL;
1618 int gd_buf_size;
1619
1620 ret = bdrv_create_file(filename, opts, &local_err);
1621 if (ret < 0) {
1622 error_propagate(errp, local_err);
1623 goto exit;
1624 }
1625
1626 assert(bs == NULL);
1627 ret = bdrv_open(&bs, filename, NULL, NULL, BDRV_O_RDWR | BDRV_O_PROTOCOL,
1628 NULL, &local_err);
1629 if (ret < 0) {
1630 error_propagate(errp, local_err);
1631 goto exit;
1632 }
1633
1634 if (flat) {
1635 ret = bdrv_truncate(bs, filesize);
1636 if (ret < 0) {
1637 error_setg_errno(errp, -ret, "Could not truncate file");
1638 }
1639 goto exit;
1640 }
1641 magic = cpu_to_be32(VMDK4_MAGIC);
1642 memset(&header, 0, sizeof(header));
1643 header.version = zeroed_grain ? 2 : 1;
1644 header.flags = VMDK4_FLAG_RGD | VMDK4_FLAG_NL_DETECT
1645 | (compress ? VMDK4_FLAG_COMPRESS | VMDK4_FLAG_MARKER : 0)
1646 | (zeroed_grain ? VMDK4_FLAG_ZERO_GRAIN : 0);
1647 header.compressAlgorithm = compress ? VMDK4_COMPRESSION_DEFLATE : 0;
1648 header.capacity = filesize / BDRV_SECTOR_SIZE;
1649 header.granularity = 128;
1650 header.num_gtes_per_gt = BDRV_SECTOR_SIZE;
1651
1652 grains = DIV_ROUND_UP(filesize / BDRV_SECTOR_SIZE, header.granularity);
1653 gt_size = DIV_ROUND_UP(header.num_gtes_per_gt * sizeof(uint32_t),
1654 BDRV_SECTOR_SIZE);
1655 gt_count = DIV_ROUND_UP(grains, header.num_gtes_per_gt);
1656 gd_sectors = DIV_ROUND_UP(gt_count * sizeof(uint32_t), BDRV_SECTOR_SIZE);
1657
1658 header.desc_offset = 1;
1659 header.desc_size = 20;
1660 header.rgd_offset = header.desc_offset + header.desc_size;
1661 header.gd_offset = header.rgd_offset + gd_sectors + (gt_size * gt_count);
1662 header.grain_offset =
1663 ROUND_UP(header.gd_offset + gd_sectors + (gt_size * gt_count),
1664 header.granularity);
1665 /* swap endianness for all header fields */
1666 header.version = cpu_to_le32(header.version);
1667 header.flags = cpu_to_le32(header.flags);
1668 header.capacity = cpu_to_le64(header.capacity);
1669 header.granularity = cpu_to_le64(header.granularity);
1670 header.num_gtes_per_gt = cpu_to_le32(header.num_gtes_per_gt);
1671 header.desc_offset = cpu_to_le64(header.desc_offset);
1672 header.desc_size = cpu_to_le64(header.desc_size);
1673 header.rgd_offset = cpu_to_le64(header.rgd_offset);
1674 header.gd_offset = cpu_to_le64(header.gd_offset);
1675 header.grain_offset = cpu_to_le64(header.grain_offset);
1676 header.compressAlgorithm = cpu_to_le16(header.compressAlgorithm);
1677
1678 header.check_bytes[0] = 0xa;
1679 header.check_bytes[1] = 0x20;
1680 header.check_bytes[2] = 0xd;
1681 header.check_bytes[3] = 0xa;
1682
1683 /* write all the data */
1684 ret = bdrv_pwrite(bs, 0, &magic, sizeof(magic));
1685 if (ret < 0) {
1686 error_set(errp, QERR_IO_ERROR);
1687 goto exit;
1688 }
1689 ret = bdrv_pwrite(bs, sizeof(magic), &header, sizeof(header));
1690 if (ret < 0) {
1691 error_set(errp, QERR_IO_ERROR);
1692 goto exit;
1693 }
1694
1695 ret = bdrv_truncate(bs, le64_to_cpu(header.grain_offset) << 9);
1696 if (ret < 0) {
1697 error_setg_errno(errp, -ret, "Could not truncate file");
1698 goto exit;
1699 }
1700
1701 /* write grain directory */
1702 gd_buf_size = gd_sectors * BDRV_SECTOR_SIZE;
1703 gd_buf = g_malloc0(gd_buf_size);
1704 for (i = 0, tmp = le64_to_cpu(header.rgd_offset) + gd_sectors;
1705 i < gt_count; i++, tmp += gt_size) {
1706 gd_buf[i] = cpu_to_le32(tmp);
1707 }
1708 ret = bdrv_pwrite(bs, le64_to_cpu(header.rgd_offset) * BDRV_SECTOR_SIZE,
1709 gd_buf, gd_buf_size);
1710 if (ret < 0) {
1711 error_set(errp, QERR_IO_ERROR);
1712 goto exit;
1713 }
1714
1715 /* write backup grain directory */
1716 for (i = 0, tmp = le64_to_cpu(header.gd_offset) + gd_sectors;
1717 i < gt_count; i++, tmp += gt_size) {
1718 gd_buf[i] = cpu_to_le32(tmp);
1719 }
1720 ret = bdrv_pwrite(bs, le64_to_cpu(header.gd_offset) * BDRV_SECTOR_SIZE,
1721 gd_buf, gd_buf_size);
1722 if (ret < 0) {
1723 error_set(errp, QERR_IO_ERROR);
1724 goto exit;
1725 }
1726
1727 ret = 0;
1728 exit:
1729 if (bs) {
1730 bdrv_unref(bs);
1731 }
1732 g_free(gd_buf);
1733 return ret;
1734 }
1735
1736 static int filename_decompose(const char *filename, char *path, char *prefix,
1737 char *postfix, size_t buf_len, Error **errp)
1738 {
1739 const char *p, *q;
1740
1741 if (filename == NULL || !strlen(filename)) {
1742 error_setg(errp, "No filename provided");
1743 return VMDK_ERROR;
1744 }
1745 p = strrchr(filename, '/');
1746 if (p == NULL) {
1747 p = strrchr(filename, '\\');
1748 }
1749 if (p == NULL) {
1750 p = strrchr(filename, ':');
1751 }
1752 if (p != NULL) {
1753 p++;
1754 if (p - filename >= buf_len) {
1755 return VMDK_ERROR;
1756 }
1757 pstrcpy(path, p - filename + 1, filename);
1758 } else {
1759 p = filename;
1760 path[0] = '\0';
1761 }
1762 q = strrchr(p, '.');
1763 if (q == NULL) {
1764 pstrcpy(prefix, buf_len, p);
1765 postfix[0] = '\0';
1766 } else {
1767 if (q - p >= buf_len) {
1768 return VMDK_ERROR;
1769 }
1770 pstrcpy(prefix, q - p + 1, p);
1771 pstrcpy(postfix, buf_len, q);
1772 }
1773 return VMDK_OK;
1774 }
1775
1776 static int vmdk_create(const char *filename, QemuOpts *opts, Error **errp)
1777 {
1778 int idx = 0;
1779 BlockDriverState *new_bs = NULL;
1780 Error *local_err = NULL;
1781 char *desc = NULL;
1782 int64_t total_size = 0, filesize;
1783 char *adapter_type = NULL;
1784 char *backing_file = NULL;
1785 char *fmt = NULL;
1786 int flags = 0;
1787 int ret = 0;
1788 bool flat, split, compress;
1789 GString *ext_desc_lines;
1790 char path[PATH_MAX], prefix[PATH_MAX], postfix[PATH_MAX];
1791 const int64_t split_size = 0x80000000; /* VMDK has constant split size */
1792 const char *desc_extent_line;
1793 char parent_desc_line[BUF_SIZE] = "";
1794 uint32_t parent_cid = 0xffffffff;
1795 uint32_t number_heads = 16;
1796 bool zeroed_grain = false;
1797 uint32_t desc_offset = 0, desc_len;
1798 const char desc_template[] =
1799 "# Disk DescriptorFile\n"
1800 "version=1\n"
1801 "CID=%" PRIx32 "\n"
1802 "parentCID=%" PRIx32 "\n"
1803 "createType=\"%s\"\n"
1804 "%s"
1805 "\n"
1806 "# Extent description\n"
1807 "%s"
1808 "\n"
1809 "# The Disk Data Base\n"
1810 "#DDB\n"
1811 "\n"
1812 "ddb.virtualHWVersion = \"%d\"\n"
1813 "ddb.geometry.cylinders = \"%" PRId64 "\"\n"
1814 "ddb.geometry.heads = \"%" PRIu32 "\"\n"
1815 "ddb.geometry.sectors = \"63\"\n"
1816 "ddb.adapterType = \"%s\"\n";
1817
1818 ext_desc_lines = g_string_new(NULL);
1819
1820 if (filename_decompose(filename, path, prefix, postfix, PATH_MAX, errp)) {
1821 ret = -EINVAL;
1822 goto exit;
1823 }
1824 /* Read out options */
1825 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
1826 BDRV_SECTOR_SIZE);
1827 adapter_type = qemu_opt_get_del(opts, BLOCK_OPT_ADAPTER_TYPE);
1828 backing_file = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FILE);
1829 if (qemu_opt_get_bool_del(opts, BLOCK_OPT_COMPAT6, false)) {
1830 flags |= BLOCK_FLAG_COMPAT6;
1831 }
1832 fmt = qemu_opt_get_del(opts, BLOCK_OPT_SUBFMT);
1833 if (qemu_opt_get_bool_del(opts, BLOCK_OPT_ZEROED_GRAIN, false)) {
1834 zeroed_grain = true;
1835 }
1836
1837 if (!adapter_type) {
1838 adapter_type = g_strdup("ide");
1839 } else if (strcmp(adapter_type, "ide") &&
1840 strcmp(adapter_type, "buslogic") &&
1841 strcmp(adapter_type, "lsilogic") &&
1842 strcmp(adapter_type, "legacyESX")) {
1843 error_setg(errp, "Unknown adapter type: '%s'", adapter_type);
1844 ret = -EINVAL;
1845 goto exit;
1846 }
1847 if (strcmp(adapter_type, "ide") != 0) {
1848 /* that's the number of heads with which vmware operates when
1849 creating, exporting, etc. vmdk files with a non-ide adapter type */
1850 number_heads = 255;
1851 }
1852 if (!fmt) {
1853 /* Default format to monolithicSparse */
1854 fmt = g_strdup("monolithicSparse");
1855 } else if (strcmp(fmt, "monolithicFlat") &&
1856 strcmp(fmt, "monolithicSparse") &&
1857 strcmp(fmt, "twoGbMaxExtentSparse") &&
1858 strcmp(fmt, "twoGbMaxExtentFlat") &&
1859 strcmp(fmt, "streamOptimized")) {
1860 error_setg(errp, "Unknown subformat: '%s'", fmt);
1861 ret = -EINVAL;
1862 goto exit;
1863 }
1864 split = !(strcmp(fmt, "twoGbMaxExtentFlat") &&
1865 strcmp(fmt, "twoGbMaxExtentSparse"));
1866 flat = !(strcmp(fmt, "monolithicFlat") &&
1867 strcmp(fmt, "twoGbMaxExtentFlat"));
1868 compress = !strcmp(fmt, "streamOptimized");
1869 if (flat) {
1870 desc_extent_line = "RW %" PRId64 " FLAT \"%s\" 0\n";
1871 } else {
1872 desc_extent_line = "RW %" PRId64 " SPARSE \"%s\"\n";
1873 }
1874 if (flat && backing_file) {
1875 error_setg(errp, "Flat image can't have backing file");
1876 ret = -ENOTSUP;
1877 goto exit;
1878 }
1879 if (flat && zeroed_grain) {
1880 error_setg(errp, "Flat image can't enable zeroed grain");
1881 ret = -ENOTSUP;
1882 goto exit;
1883 }
1884 if (backing_file) {
1885 BlockDriverState *bs = NULL;
1886 ret = bdrv_open(&bs, backing_file, NULL, NULL, BDRV_O_NO_BACKING, NULL,
1887 errp);
1888 if (ret != 0) {
1889 goto exit;
1890 }
1891 if (strcmp(bs->drv->format_name, "vmdk")) {
1892 bdrv_unref(bs);
1893 ret = -EINVAL;
1894 goto exit;
1895 }
1896 parent_cid = vmdk_read_cid(bs, 0);
1897 bdrv_unref(bs);
1898 snprintf(parent_desc_line, sizeof(parent_desc_line),
1899 "parentFileNameHint=\"%s\"", backing_file);
1900 }
1901
1902 /* Create extents */
1903 filesize = total_size;
1904 while (filesize > 0) {
1905 char desc_line[BUF_SIZE];
1906 char ext_filename[PATH_MAX];
1907 char desc_filename[PATH_MAX];
1908 int64_t size = filesize;
1909
1910 if (split && size > split_size) {
1911 size = split_size;
1912 }
1913 if (split) {
1914 snprintf(desc_filename, sizeof(desc_filename), "%s-%c%03d%s",
1915 prefix, flat ? 'f' : 's', ++idx, postfix);
1916 } else if (flat) {
1917 snprintf(desc_filename, sizeof(desc_filename), "%s-flat%s",
1918 prefix, postfix);
1919 } else {
1920 snprintf(desc_filename, sizeof(desc_filename), "%s%s",
1921 prefix, postfix);
1922 }
1923 snprintf(ext_filename, sizeof(ext_filename), "%s%s",
1924 path, desc_filename);
1925
1926 if (vmdk_create_extent(ext_filename, size,
1927 flat, compress, zeroed_grain, opts, errp)) {
1928 ret = -EINVAL;
1929 goto exit;
1930 }
1931 filesize -= size;
1932
1933 /* Format description line */
1934 snprintf(desc_line, sizeof(desc_line),
1935 desc_extent_line, size / BDRV_SECTOR_SIZE, desc_filename);
1936 g_string_append(ext_desc_lines, desc_line);
1937 }
1938 /* generate descriptor file */
1939 desc = g_strdup_printf(desc_template,
1940 g_random_int(),
1941 parent_cid,
1942 fmt,
1943 parent_desc_line,
1944 ext_desc_lines->str,
1945 (flags & BLOCK_FLAG_COMPAT6 ? 6 : 4),
1946 total_size /
1947 (int64_t)(63 * number_heads * BDRV_SECTOR_SIZE),
1948 number_heads,
1949 adapter_type);
1950 desc_len = strlen(desc);
1951 /* the descriptor offset = 0x200 */
1952 if (!split && !flat) {
1953 desc_offset = 0x200;
1954 } else {
1955 ret = bdrv_create_file(filename, opts, &local_err);
1956 if (ret < 0) {
1957 error_propagate(errp, local_err);
1958 goto exit;
1959 }
1960 }
1961 assert(new_bs == NULL);
1962 ret = bdrv_open(&new_bs, filename, NULL, NULL,
1963 BDRV_O_RDWR | BDRV_O_PROTOCOL, NULL, &local_err);
1964 if (ret < 0) {
1965 error_propagate(errp, local_err);
1966 goto exit;
1967 }
1968 ret = bdrv_pwrite(new_bs, desc_offset, desc, desc_len);
1969 if (ret < 0) {
1970 error_setg_errno(errp, -ret, "Could not write description");
1971 goto exit;
1972 }
1973 /* bdrv_pwrite write padding zeros to align to sector, we don't need that
1974 * for description file */
1975 if (desc_offset == 0) {
1976 ret = bdrv_truncate(new_bs, desc_len);
1977 if (ret < 0) {
1978 error_setg_errno(errp, -ret, "Could not truncate file");
1979 }
1980 }
1981 exit:
1982 if (new_bs) {
1983 bdrv_unref(new_bs);
1984 }
1985 g_free(adapter_type);
1986 g_free(backing_file);
1987 g_free(fmt);
1988 g_free(desc);
1989 g_string_free(ext_desc_lines, true);
1990 return ret;
1991 }
1992
1993 static void vmdk_close(BlockDriverState *bs)
1994 {
1995 BDRVVmdkState *s = bs->opaque;
1996
1997 vmdk_free_extents(bs);
1998 g_free(s->create_type);
1999
2000 migrate_del_blocker(s->migration_blocker);
2001 error_free(s->migration_blocker);
2002 }
2003
2004 static coroutine_fn int vmdk_co_flush(BlockDriverState *bs)
2005 {
2006 BDRVVmdkState *s = bs->opaque;
2007 int i, err;
2008 int ret = 0;
2009
2010 for (i = 0; i < s->num_extents; i++) {
2011 err = bdrv_co_flush(s->extents[i].file);
2012 if (err < 0) {
2013 ret = err;
2014 }
2015 }
2016 return ret;
2017 }
2018
2019 static int64_t vmdk_get_allocated_file_size(BlockDriverState *bs)
2020 {
2021 int i;
2022 int64_t ret = 0;
2023 int64_t r;
2024 BDRVVmdkState *s = bs->opaque;
2025
2026 ret = bdrv_get_allocated_file_size(bs->file);
2027 if (ret < 0) {
2028 return ret;
2029 }
2030 for (i = 0; i < s->num_extents; i++) {
2031 if (s->extents[i].file == bs->file) {
2032 continue;
2033 }
2034 r = bdrv_get_allocated_file_size(s->extents[i].file);
2035 if (r < 0) {
2036 return r;
2037 }
2038 ret += r;
2039 }
2040 return ret;
2041 }
2042
2043 static int vmdk_has_zero_init(BlockDriverState *bs)
2044 {
2045 int i;
2046 BDRVVmdkState *s = bs->opaque;
2047
2048 /* If has a flat extent and its underlying storage doesn't have zero init,
2049 * return 0. */
2050 for (i = 0; i < s->num_extents; i++) {
2051 if (s->extents[i].flat) {
2052 if (!bdrv_has_zero_init(s->extents[i].file)) {
2053 return 0;
2054 }
2055 }
2056 }
2057 return 1;
2058 }
2059
2060 static ImageInfo *vmdk_get_extent_info(VmdkExtent *extent)
2061 {
2062 ImageInfo *info = g_new0(ImageInfo, 1);
2063
2064 *info = (ImageInfo){
2065 .filename = g_strdup(extent->file->filename),
2066 .format = g_strdup(extent->type),
2067 .virtual_size = extent->sectors * BDRV_SECTOR_SIZE,
2068 .compressed = extent->compressed,
2069 .has_compressed = extent->compressed,
2070 .cluster_size = extent->cluster_sectors * BDRV_SECTOR_SIZE,
2071 .has_cluster_size = !extent->flat,
2072 };
2073
2074 return info;
2075 }
2076
2077 static int vmdk_check(BlockDriverState *bs, BdrvCheckResult *result,
2078 BdrvCheckMode fix)
2079 {
2080 BDRVVmdkState *s = bs->opaque;
2081 VmdkExtent *extent = NULL;
2082 int64_t sector_num = 0;
2083 int64_t total_sectors = bdrv_nb_sectors(bs);
2084 int ret;
2085 uint64_t cluster_offset;
2086
2087 if (fix) {
2088 return -ENOTSUP;
2089 }
2090
2091 for (;;) {
2092 if (sector_num >= total_sectors) {
2093 return 0;
2094 }
2095 extent = find_extent(s, sector_num, extent);
2096 if (!extent) {
2097 fprintf(stderr,
2098 "ERROR: could not find extent for sector %" PRId64 "\n",
2099 sector_num);
2100 break;
2101 }
2102 ret = get_cluster_offset(bs, extent, NULL,
2103 sector_num << BDRV_SECTOR_BITS,
2104 false, &cluster_offset, 0, 0);
2105 if (ret == VMDK_ERROR) {
2106 fprintf(stderr,
2107 "ERROR: could not get cluster_offset for sector %"
2108 PRId64 "\n", sector_num);
2109 break;
2110 }
2111 if (ret == VMDK_OK && cluster_offset >= bdrv_getlength(extent->file)) {
2112 fprintf(stderr,
2113 "ERROR: cluster offset for sector %"
2114 PRId64 " points after EOF\n", sector_num);
2115 break;
2116 }
2117 sector_num += extent->cluster_sectors;
2118 }
2119
2120 result->corruptions++;
2121 return 0;
2122 }
2123
2124 static ImageInfoSpecific *vmdk_get_specific_info(BlockDriverState *bs)
2125 {
2126 int i;
2127 BDRVVmdkState *s = bs->opaque;
2128 ImageInfoSpecific *spec_info = g_new0(ImageInfoSpecific, 1);
2129 ImageInfoList **next;
2130
2131 *spec_info = (ImageInfoSpecific){
2132 .kind = IMAGE_INFO_SPECIFIC_KIND_VMDK,
2133 {
2134 .vmdk = g_new0(ImageInfoSpecificVmdk, 1),
2135 },
2136 };
2137
2138 *spec_info->vmdk = (ImageInfoSpecificVmdk) {
2139 .create_type = g_strdup(s->create_type),
2140 .cid = s->cid,
2141 .parent_cid = s->parent_cid,
2142 };
2143
2144 next = &spec_info->vmdk->extents;
2145 for (i = 0; i < s->num_extents; i++) {
2146 *next = g_new0(ImageInfoList, 1);
2147 (*next)->value = vmdk_get_extent_info(&s->extents[i]);
2148 (*next)->next = NULL;
2149 next = &(*next)->next;
2150 }
2151
2152 return spec_info;
2153 }
2154
2155 static bool vmdk_extents_type_eq(const VmdkExtent *a, const VmdkExtent *b)
2156 {
2157 return a->flat == b->flat &&
2158 a->compressed == b->compressed &&
2159 (a->flat || a->cluster_sectors == b->cluster_sectors);
2160 }
2161
2162 static int vmdk_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
2163 {
2164 int i;
2165 BDRVVmdkState *s = bs->opaque;
2166 assert(s->num_extents);
2167
2168 /* See if we have multiple extents but they have different cases */
2169 for (i = 1; i < s->num_extents; i++) {
2170 if (!vmdk_extents_type_eq(&s->extents[0], &s->extents[i])) {
2171 return -ENOTSUP;
2172 }
2173 }
2174 bdi->needs_compressed_writes = s->extents[0].compressed;
2175 if (!s->extents[0].flat) {
2176 bdi->cluster_size = s->extents[0].cluster_sectors << BDRV_SECTOR_BITS;
2177 }
2178 return 0;
2179 }
2180
2181 static void vmdk_detach_aio_context(BlockDriverState *bs)
2182 {
2183 BDRVVmdkState *s = bs->opaque;
2184 int i;
2185
2186 for (i = 0; i < s->num_extents; i++) {
2187 bdrv_detach_aio_context(s->extents[i].file);
2188 }
2189 }
2190
2191 static void vmdk_attach_aio_context(BlockDriverState *bs,
2192 AioContext *new_context)
2193 {
2194 BDRVVmdkState *s = bs->opaque;
2195 int i;
2196
2197 for (i = 0; i < s->num_extents; i++) {
2198 bdrv_attach_aio_context(s->extents[i].file, new_context);
2199 }
2200 }
2201
2202 static QemuOptsList vmdk_create_opts = {
2203 .name = "vmdk-create-opts",
2204 .head = QTAILQ_HEAD_INITIALIZER(vmdk_create_opts.head),
2205 .desc = {
2206 {
2207 .name = BLOCK_OPT_SIZE,
2208 .type = QEMU_OPT_SIZE,
2209 .help = "Virtual disk size"
2210 },
2211 {
2212 .name = BLOCK_OPT_ADAPTER_TYPE,
2213 .type = QEMU_OPT_STRING,
2214 .help = "Virtual adapter type, can be one of "
2215 "ide (default), lsilogic, buslogic or legacyESX"
2216 },
2217 {
2218 .name = BLOCK_OPT_BACKING_FILE,
2219 .type = QEMU_OPT_STRING,
2220 .help = "File name of a base image"
2221 },
2222 {
2223 .name = BLOCK_OPT_COMPAT6,
2224 .type = QEMU_OPT_BOOL,
2225 .help = "VMDK version 6 image",
2226 .def_value_str = "off"
2227 },
2228 {
2229 .name = BLOCK_OPT_SUBFMT,
2230 .type = QEMU_OPT_STRING,
2231 .help =
2232 "VMDK flat extent format, can be one of "
2233 "{monolithicSparse (default) | monolithicFlat | twoGbMaxExtentSparse | twoGbMaxExtentFlat | streamOptimized} "
2234 },
2235 {
2236 .name = BLOCK_OPT_ZEROED_GRAIN,
2237 .type = QEMU_OPT_BOOL,
2238 .help = "Enable efficient zero writes "
2239 "using the zeroed-grain GTE feature"
2240 },
2241 { /* end of list */ }
2242 }
2243 };
2244
2245 static BlockDriver bdrv_vmdk = {
2246 .format_name = "vmdk",
2247 .instance_size = sizeof(BDRVVmdkState),
2248 .bdrv_probe = vmdk_probe,
2249 .bdrv_open = vmdk_open,
2250 .bdrv_check = vmdk_check,
2251 .bdrv_reopen_prepare = vmdk_reopen_prepare,
2252 .bdrv_read = vmdk_co_read,
2253 .bdrv_write = vmdk_co_write,
2254 .bdrv_write_compressed = vmdk_write_compressed,
2255 .bdrv_co_write_zeroes = vmdk_co_write_zeroes,
2256 .bdrv_close = vmdk_close,
2257 .bdrv_create = vmdk_create,
2258 .bdrv_co_flush_to_disk = vmdk_co_flush,
2259 .bdrv_co_get_block_status = vmdk_co_get_block_status,
2260 .bdrv_get_allocated_file_size = vmdk_get_allocated_file_size,
2261 .bdrv_has_zero_init = vmdk_has_zero_init,
2262 .bdrv_get_specific_info = vmdk_get_specific_info,
2263 .bdrv_refresh_limits = vmdk_refresh_limits,
2264 .bdrv_get_info = vmdk_get_info,
2265 .bdrv_detach_aio_context = vmdk_detach_aio_context,
2266 .bdrv_attach_aio_context = vmdk_attach_aio_context,
2267
2268 .supports_backing = true,
2269 .create_opts = &vmdk_create_opts,
2270 };
2271
2272 static void bdrv_vmdk_init(void)
2273 {
2274 bdrv_register(&bdrv_vmdk);
2275 }
2276
2277 block_init(bdrv_vmdk_init);