xref: /openbmc/qemu/block/vmdk.c (revision d6e59931)
1019d6b8fSAnthony Liguori /*
2019d6b8fSAnthony Liguori  * Block driver for the VMDK format
3019d6b8fSAnthony Liguori  *
4019d6b8fSAnthony Liguori  * Copyright (c) 2004 Fabrice Bellard
5019d6b8fSAnthony Liguori  * Copyright (c) 2005 Filip Navara
6019d6b8fSAnthony Liguori  *
7019d6b8fSAnthony Liguori  * Permission is hereby granted, free of charge, to any person obtaining a copy
8019d6b8fSAnthony Liguori  * of this software and associated documentation files (the "Software"), to deal
9019d6b8fSAnthony Liguori  * in the Software without restriction, including without limitation the rights
10019d6b8fSAnthony Liguori  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11019d6b8fSAnthony Liguori  * copies of the Software, and to permit persons to whom the Software is
12019d6b8fSAnthony Liguori  * furnished to do so, subject to the following conditions:
13019d6b8fSAnthony Liguori  *
14019d6b8fSAnthony Liguori  * The above copyright notice and this permission notice shall be included in
15019d6b8fSAnthony Liguori  * all copies or substantial portions of the Software.
16019d6b8fSAnthony Liguori  *
17019d6b8fSAnthony Liguori  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18019d6b8fSAnthony Liguori  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19019d6b8fSAnthony Liguori  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20019d6b8fSAnthony Liguori  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21019d6b8fSAnthony Liguori  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22019d6b8fSAnthony Liguori  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23019d6b8fSAnthony Liguori  * THE SOFTWARE.
24019d6b8fSAnthony Liguori  */
25019d6b8fSAnthony Liguori 
26019d6b8fSAnthony Liguori #include "qemu-common.h"
27737e150eSPaolo Bonzini #include "block/block_int.h"
281de7afc9SPaolo Bonzini #include "qemu/module.h"
29caf71f86SPaolo Bonzini #include "migration/migration.h"
302923d34fSStefan Weil #include <zlib.h>
31019d6b8fSAnthony Liguori 
32019d6b8fSAnthony Liguori #define VMDK3_MAGIC (('C' << 24) | ('O' << 16) | ('W' << 8) | 'D')
33019d6b8fSAnthony Liguori #define VMDK4_MAGIC (('K' << 24) | ('D' << 16) | ('M' << 8) | 'V')
34432bb170SFam Zheng #define VMDK4_COMPRESSION_DEFLATE 1
3595b0aa42SFam Zheng #define VMDK4_FLAG_NL_DETECT (1 << 0)
36bb45ded9SFam Zheng #define VMDK4_FLAG_RGD (1 << 1)
3714ead646SFam Zheng /* Zeroed-grain enable bit */
3814ead646SFam Zheng #define VMDK4_FLAG_ZERO_GRAIN   (1 << 2)
39432bb170SFam Zheng #define VMDK4_FLAG_COMPRESS (1 << 16)
40432bb170SFam Zheng #define VMDK4_FLAG_MARKER (1 << 17)
4165bd155cSKevin Wolf #define VMDK4_GD_AT_END 0xffffffffffffffffULL
42019d6b8fSAnthony Liguori 
4314ead646SFam Zheng #define VMDK_GTE_ZEROED 0x1
4465f74725SFam Zheng 
4565f74725SFam Zheng /* VMDK internal error codes */
4665f74725SFam Zheng #define VMDK_OK      0
4765f74725SFam Zheng #define VMDK_ERROR   (-1)
4865f74725SFam Zheng /* Cluster not allocated */
4965f74725SFam Zheng #define VMDK_UNALLOC (-2)
5065f74725SFam Zheng #define VMDK_ZEROED  (-3)
5165f74725SFam Zheng 
5269e0b6dfSFam Zheng #define BLOCK_OPT_ZEROED_GRAIN "zeroed_grain"
5369e0b6dfSFam Zheng 
54019d6b8fSAnthony Liguori typedef struct {
55019d6b8fSAnthony Liguori     uint32_t version;
56019d6b8fSAnthony Liguori     uint32_t flags;
57019d6b8fSAnthony Liguori     uint32_t disk_sectors;
58019d6b8fSAnthony Liguori     uint32_t granularity;
59019d6b8fSAnthony Liguori     uint32_t l1dir_offset;
60019d6b8fSAnthony Liguori     uint32_t l1dir_size;
61019d6b8fSAnthony Liguori     uint32_t file_sectors;
62019d6b8fSAnthony Liguori     uint32_t cylinders;
63019d6b8fSAnthony Liguori     uint32_t heads;
64019d6b8fSAnthony Liguori     uint32_t sectors_per_track;
655d8caa54SFam Zheng } QEMU_PACKED VMDK3Header;
66019d6b8fSAnthony Liguori 
67019d6b8fSAnthony Liguori typedef struct {
68019d6b8fSAnthony Liguori     uint32_t version;
69019d6b8fSAnthony Liguori     uint32_t flags;
70e98768d4SFam Zheng     uint64_t capacity;
71e98768d4SFam Zheng     uint64_t granularity;
72e98768d4SFam Zheng     uint64_t desc_offset;
73e98768d4SFam Zheng     uint64_t desc_size;
74ca8804ceSFam Zheng     /* Number of GrainTableEntries per GrainTable */
75ca8804ceSFam Zheng     uint32_t num_gtes_per_gt;
76e98768d4SFam Zheng     uint64_t rgd_offset;
77e98768d4SFam Zheng     uint64_t gd_offset;
78e98768d4SFam Zheng     uint64_t grain_offset;
79019d6b8fSAnthony Liguori     char filler[1];
80019d6b8fSAnthony Liguori     char check_bytes[4];
81432bb170SFam Zheng     uint16_t compressAlgorithm;
82541dc0d4SStefan Weil } QEMU_PACKED VMDK4Header;
83019d6b8fSAnthony Liguori 
84019d6b8fSAnthony Liguori #define L2_CACHE_SIZE 16
85019d6b8fSAnthony Liguori 
86b3976d3cSFam Zheng typedef struct VmdkExtent {
87b3976d3cSFam Zheng     BlockDriverState *file;
88b3976d3cSFam Zheng     bool flat;
89432bb170SFam Zheng     bool compressed;
90432bb170SFam Zheng     bool has_marker;
9114ead646SFam Zheng     bool has_zero_grain;
9214ead646SFam Zheng     int version;
93b3976d3cSFam Zheng     int64_t sectors;
94b3976d3cSFam Zheng     int64_t end_sector;
957fa60fa3SFam Zheng     int64_t flat_start_offset;
96019d6b8fSAnthony Liguori     int64_t l1_table_offset;
97019d6b8fSAnthony Liguori     int64_t l1_backup_table_offset;
98019d6b8fSAnthony Liguori     uint32_t *l1_table;
99019d6b8fSAnthony Liguori     uint32_t *l1_backup_table;
100019d6b8fSAnthony Liguori     unsigned int l1_size;
101019d6b8fSAnthony Liguori     uint32_t l1_entry_sectors;
102019d6b8fSAnthony Liguori 
103019d6b8fSAnthony Liguori     unsigned int l2_size;
104019d6b8fSAnthony Liguori     uint32_t *l2_cache;
105019d6b8fSAnthony Liguori     uint32_t l2_cache_offsets[L2_CACHE_SIZE];
106019d6b8fSAnthony Liguori     uint32_t l2_cache_counts[L2_CACHE_SIZE];
107019d6b8fSAnthony Liguori 
108301c7d38SFam Zheng     int64_t cluster_sectors;
109c6ac36e1SFam Zheng     int64_t next_cluster_sector;
110f4c129a3SFam Zheng     char *type;
111b3976d3cSFam Zheng } VmdkExtent;
112b3976d3cSFam Zheng 
113b3976d3cSFam Zheng typedef struct BDRVVmdkState {
114848c66e8SPaolo Bonzini     CoMutex lock;
115e98768d4SFam Zheng     uint64_t desc_offset;
11669b4d86dSFam Zheng     bool cid_updated;
117c338b6adSFam Zheng     bool cid_checked;
118f4c129a3SFam Zheng     uint32_t cid;
119019d6b8fSAnthony Liguori     uint32_t parent_cid;
120b3976d3cSFam Zheng     int num_extents;
121b3976d3cSFam Zheng     /* Extent array with num_extents entries, ascend ordered by address */
122b3976d3cSFam Zheng     VmdkExtent *extents;
1232bc3166cSKevin Wolf     Error *migration_blocker;
124f4c129a3SFam Zheng     char *create_type;
125019d6b8fSAnthony Liguori } BDRVVmdkState;
126019d6b8fSAnthony Liguori 
127019d6b8fSAnthony Liguori typedef struct VmdkMetaData {
128019d6b8fSAnthony Liguori     unsigned int l1_index;
129019d6b8fSAnthony Liguori     unsigned int l2_index;
130019d6b8fSAnthony Liguori     unsigned int l2_offset;
131019d6b8fSAnthony Liguori     int valid;
132cdeaf1f1SFam Zheng     uint32_t *l2_cache_entry;
133019d6b8fSAnthony Liguori } VmdkMetaData;
134019d6b8fSAnthony Liguori 
135432bb170SFam Zheng typedef struct VmdkGrainMarker {
136432bb170SFam Zheng     uint64_t lba;
137432bb170SFam Zheng     uint32_t size;
138432bb170SFam Zheng     uint8_t  data[0];
1395d8caa54SFam Zheng } QEMU_PACKED VmdkGrainMarker;
140432bb170SFam Zheng 
14165bd155cSKevin Wolf enum {
14265bd155cSKevin Wolf     MARKER_END_OF_STREAM    = 0,
14365bd155cSKevin Wolf     MARKER_GRAIN_TABLE      = 1,
14465bd155cSKevin Wolf     MARKER_GRAIN_DIRECTORY  = 2,
14565bd155cSKevin Wolf     MARKER_FOOTER           = 3,
14665bd155cSKevin Wolf };
14765bd155cSKevin Wolf 
148019d6b8fSAnthony Liguori static int vmdk_probe(const uint8_t *buf, int buf_size, const char *filename)
149019d6b8fSAnthony Liguori {
150019d6b8fSAnthony Liguori     uint32_t magic;
151019d6b8fSAnthony Liguori 
152ae261c86SFam Zheng     if (buf_size < 4) {
153019d6b8fSAnthony Liguori         return 0;
154ae261c86SFam Zheng     }
155019d6b8fSAnthony Liguori     magic = be32_to_cpu(*(uint32_t *)buf);
156019d6b8fSAnthony Liguori     if (magic == VMDK3_MAGIC ||
15701fc99d6SFam Zheng         magic == VMDK4_MAGIC) {
158019d6b8fSAnthony Liguori         return 100;
15901fc99d6SFam Zheng     } else {
16001fc99d6SFam Zheng         const char *p = (const char *)buf;
16101fc99d6SFam Zheng         const char *end = p + buf_size;
16201fc99d6SFam Zheng         while (p < end) {
16301fc99d6SFam Zheng             if (*p == '#') {
16401fc99d6SFam Zheng                 /* skip comment line */
16501fc99d6SFam Zheng                 while (p < end && *p != '\n') {
16601fc99d6SFam Zheng                     p++;
16701fc99d6SFam Zheng                 }
16801fc99d6SFam Zheng                 p++;
16901fc99d6SFam Zheng                 continue;
17001fc99d6SFam Zheng             }
17101fc99d6SFam Zheng             if (*p == ' ') {
17201fc99d6SFam Zheng                 while (p < end && *p == ' ') {
17301fc99d6SFam Zheng                     p++;
17401fc99d6SFam Zheng                 }
17501fc99d6SFam Zheng                 /* skip '\r' if windows line endings used. */
17601fc99d6SFam Zheng                 if (p < end && *p == '\r') {
17701fc99d6SFam Zheng                     p++;
17801fc99d6SFam Zheng                 }
17901fc99d6SFam Zheng                 /* only accept blank lines before 'version=' line */
18001fc99d6SFam Zheng                 if (p == end || *p != '\n') {
181019d6b8fSAnthony Liguori                     return 0;
182019d6b8fSAnthony Liguori                 }
18301fc99d6SFam Zheng                 p++;
18401fc99d6SFam Zheng                 continue;
18501fc99d6SFam Zheng             }
18601fc99d6SFam Zheng             if (end - p >= strlen("version=X\n")) {
18701fc99d6SFam Zheng                 if (strncmp("version=1\n", p, strlen("version=1\n")) == 0 ||
18801fc99d6SFam Zheng                     strncmp("version=2\n", p, strlen("version=2\n")) == 0) {
18901fc99d6SFam Zheng                     return 100;
19001fc99d6SFam Zheng                 }
19101fc99d6SFam Zheng             }
19201fc99d6SFam Zheng             if (end - p >= strlen("version=X\r\n")) {
19301fc99d6SFam Zheng                 if (strncmp("version=1\r\n", p, strlen("version=1\r\n")) == 0 ||
19401fc99d6SFam Zheng                     strncmp("version=2\r\n", p, strlen("version=2\r\n")) == 0) {
19501fc99d6SFam Zheng                     return 100;
19601fc99d6SFam Zheng                 }
19701fc99d6SFam Zheng             }
19801fc99d6SFam Zheng             return 0;
19901fc99d6SFam Zheng         }
20001fc99d6SFam Zheng         return 0;
20101fc99d6SFam Zheng     }
20201fc99d6SFam Zheng }
203019d6b8fSAnthony Liguori 
204019d6b8fSAnthony Liguori #define SECTOR_SIZE 512
205f66fd6c3SFam Zheng #define DESC_SIZE (20 * SECTOR_SIZE)    /* 20 sectors of 512 bytes each */
206f66fd6c3SFam Zheng #define BUF_SIZE 4096
207f66fd6c3SFam Zheng #define HEADER_SIZE 512                 /* first sector of 512 bytes */
208019d6b8fSAnthony Liguori 
209b3976d3cSFam Zheng static void vmdk_free_extents(BlockDriverState *bs)
210b3976d3cSFam Zheng {
211b3976d3cSFam Zheng     int i;
212b3976d3cSFam Zheng     BDRVVmdkState *s = bs->opaque;
213b3c0bfb6SFam Zheng     VmdkExtent *e;
214b3976d3cSFam Zheng 
215b3976d3cSFam Zheng     for (i = 0; i < s->num_extents; i++) {
216b3c0bfb6SFam Zheng         e = &s->extents[i];
217b3c0bfb6SFam Zheng         g_free(e->l1_table);
218b3c0bfb6SFam Zheng         g_free(e->l2_cache);
219b3c0bfb6SFam Zheng         g_free(e->l1_backup_table);
220f4c129a3SFam Zheng         g_free(e->type);
221b3c0bfb6SFam Zheng         if (e->file != bs->file) {
2224f6fd349SFam Zheng             bdrv_unref(e->file);
223b3c0bfb6SFam Zheng         }
224b3976d3cSFam Zheng     }
2257267c094SAnthony Liguori     g_free(s->extents);
226b3976d3cSFam Zheng }
227b3976d3cSFam Zheng 
22886c6b429SFam Zheng static void vmdk_free_last_extent(BlockDriverState *bs)
22986c6b429SFam Zheng {
23086c6b429SFam Zheng     BDRVVmdkState *s = bs->opaque;
23186c6b429SFam Zheng 
23286c6b429SFam Zheng     if (s->num_extents == 0) {
23386c6b429SFam Zheng         return;
23486c6b429SFam Zheng     }
23586c6b429SFam Zheng     s->num_extents--;
23686c6b429SFam Zheng     s->extents = g_realloc(s->extents, s->num_extents * sizeof(VmdkExtent));
23786c6b429SFam Zheng }
23886c6b429SFam Zheng 
239019d6b8fSAnthony Liguori static uint32_t vmdk_read_cid(BlockDriverState *bs, int parent)
240019d6b8fSAnthony Liguori {
241019d6b8fSAnthony Liguori     char desc[DESC_SIZE];
2428379e46dSPavel Borzenkov     uint32_t cid = 0xffffffff;
243019d6b8fSAnthony Liguori     const char *p_name, *cid_str;
244019d6b8fSAnthony Liguori     size_t cid_str_size;
245e1da9b24SFam Zheng     BDRVVmdkState *s = bs->opaque;
24699f1835dSKevin Wolf     int ret;
247019d6b8fSAnthony Liguori 
24899f1835dSKevin Wolf     ret = bdrv_pread(bs->file, s->desc_offset, desc, DESC_SIZE);
24999f1835dSKevin Wolf     if (ret < 0) {
250019d6b8fSAnthony Liguori         return 0;
251e1da9b24SFam Zheng     }
252019d6b8fSAnthony Liguori 
253019d6b8fSAnthony Liguori     if (parent) {
254019d6b8fSAnthony Liguori         cid_str = "parentCID";
255019d6b8fSAnthony Liguori         cid_str_size = sizeof("parentCID");
256019d6b8fSAnthony Liguori     } else {
257019d6b8fSAnthony Liguori         cid_str = "CID";
258019d6b8fSAnthony Liguori         cid_str_size = sizeof("CID");
259019d6b8fSAnthony Liguori     }
260019d6b8fSAnthony Liguori 
26193897b9fSKevin Wolf     desc[DESC_SIZE - 1] = '\0';
262ae261c86SFam Zheng     p_name = strstr(desc, cid_str);
263ae261c86SFam Zheng     if (p_name != NULL) {
264019d6b8fSAnthony Liguori         p_name += cid_str_size;
2659b17031aSFam Zheng         sscanf(p_name, "%" SCNx32, &cid);
266019d6b8fSAnthony Liguori     }
267019d6b8fSAnthony Liguori 
268019d6b8fSAnthony Liguori     return cid;
269019d6b8fSAnthony Liguori }
270019d6b8fSAnthony Liguori 
271019d6b8fSAnthony Liguori static int vmdk_write_cid(BlockDriverState *bs, uint32_t cid)
272019d6b8fSAnthony Liguori {
273019d6b8fSAnthony Liguori     char desc[DESC_SIZE], tmp_desc[DESC_SIZE];
274019d6b8fSAnthony Liguori     char *p_name, *tmp_str;
275e1da9b24SFam Zheng     BDRVVmdkState *s = bs->opaque;
27699f1835dSKevin Wolf     int ret;
277019d6b8fSAnthony Liguori 
27899f1835dSKevin Wolf     ret = bdrv_pread(bs->file, s->desc_offset, desc, DESC_SIZE);
27999f1835dSKevin Wolf     if (ret < 0) {
28099f1835dSKevin Wolf         return ret;
281e1da9b24SFam Zheng     }
282019d6b8fSAnthony Liguori 
28393897b9fSKevin Wolf     desc[DESC_SIZE - 1] = '\0';
284019d6b8fSAnthony Liguori     tmp_str = strstr(desc, "parentCID");
28593897b9fSKevin Wolf     if (tmp_str == NULL) {
28693897b9fSKevin Wolf         return -EINVAL;
28793897b9fSKevin Wolf     }
28893897b9fSKevin Wolf 
289019d6b8fSAnthony Liguori     pstrcpy(tmp_desc, sizeof(tmp_desc), tmp_str);
290ae261c86SFam Zheng     p_name = strstr(desc, "CID");
291ae261c86SFam Zheng     if (p_name != NULL) {
292019d6b8fSAnthony Liguori         p_name += sizeof("CID");
2939b17031aSFam Zheng         snprintf(p_name, sizeof(desc) - (p_name - desc), "%" PRIx32 "\n", cid);
294019d6b8fSAnthony Liguori         pstrcat(desc, sizeof(desc), tmp_desc);
295019d6b8fSAnthony Liguori     }
296019d6b8fSAnthony Liguori 
29799f1835dSKevin Wolf     ret = bdrv_pwrite_sync(bs->file, s->desc_offset, desc, DESC_SIZE);
29899f1835dSKevin Wolf     if (ret < 0) {
29999f1835dSKevin Wolf         return ret;
300e1da9b24SFam Zheng     }
30199f1835dSKevin Wolf 
302019d6b8fSAnthony Liguori     return 0;
303019d6b8fSAnthony Liguori }
304019d6b8fSAnthony Liguori 
305019d6b8fSAnthony Liguori static int vmdk_is_cid_valid(BlockDriverState *bs)
306019d6b8fSAnthony Liguori {
307019d6b8fSAnthony Liguori     BDRVVmdkState *s = bs->opaque;
308b171271aSKevin Wolf     BlockDriverState *p_bs = bs->backing_hd;
309019d6b8fSAnthony Liguori     uint32_t cur_pcid;
310019d6b8fSAnthony Liguori 
311c338b6adSFam Zheng     if (!s->cid_checked && p_bs) {
312019d6b8fSAnthony Liguori         cur_pcid = vmdk_read_cid(p_bs, 0);
313ae261c86SFam Zheng         if (s->parent_cid != cur_pcid) {
314ae261c86SFam Zheng             /* CID not valid */
315019d6b8fSAnthony Liguori             return 0;
316019d6b8fSAnthony Liguori         }
317ae261c86SFam Zheng     }
318c338b6adSFam Zheng     s->cid_checked = true;
319ae261c86SFam Zheng     /* CID valid */
320019d6b8fSAnthony Liguori     return 1;
321019d6b8fSAnthony Liguori }
322019d6b8fSAnthony Liguori 
3233897575fSJeff Cody /* Queue extents, if any, for reopen() */
3243897575fSJeff Cody static int vmdk_reopen_prepare(BDRVReopenState *state,
3253897575fSJeff Cody                                BlockReopenQueue *queue, Error **errp)
3263897575fSJeff Cody {
3273897575fSJeff Cody     BDRVVmdkState *s;
3283897575fSJeff Cody     int ret = -1;
3293897575fSJeff Cody     int i;
3303897575fSJeff Cody     VmdkExtent *e;
3313897575fSJeff Cody 
3323897575fSJeff Cody     assert(state != NULL);
3333897575fSJeff Cody     assert(state->bs != NULL);
3343897575fSJeff Cody 
3353897575fSJeff Cody     if (queue == NULL) {
3364823970bSFam Zheng         error_setg(errp, "No reopen queue for VMDK extents");
3373897575fSJeff Cody         goto exit;
3383897575fSJeff Cody     }
3393897575fSJeff Cody 
3403897575fSJeff Cody     s = state->bs->opaque;
3413897575fSJeff Cody 
3423897575fSJeff Cody     assert(s != NULL);
3433897575fSJeff Cody 
3443897575fSJeff Cody     for (i = 0; i < s->num_extents; i++) {
3453897575fSJeff Cody         e = &s->extents[i];
3463897575fSJeff Cody         if (e->file != state->bs->file) {
3473897575fSJeff Cody             bdrv_reopen_queue(queue, e->file, state->flags);
3483897575fSJeff Cody         }
3493897575fSJeff Cody     }
3503897575fSJeff Cody     ret = 0;
3513897575fSJeff Cody 
3523897575fSJeff Cody exit:
3533897575fSJeff Cody     return ret;
3543897575fSJeff Cody }
3553897575fSJeff Cody 
3569949f97eSKevin Wolf static int vmdk_parent_open(BlockDriverState *bs)
357019d6b8fSAnthony Liguori {
358019d6b8fSAnthony Liguori     char *p_name;
3597fa60fa3SFam Zheng     char desc[DESC_SIZE + 1];
360e1da9b24SFam Zheng     BDRVVmdkState *s = bs->opaque;
361588b65a3SPaolo Bonzini     int ret;
362019d6b8fSAnthony Liguori 
3637fa60fa3SFam Zheng     desc[DESC_SIZE] = '\0';
364588b65a3SPaolo Bonzini     ret = bdrv_pread(bs->file, s->desc_offset, desc, DESC_SIZE);
365588b65a3SPaolo Bonzini     if (ret < 0) {
366588b65a3SPaolo Bonzini         return ret;
367e1da9b24SFam Zheng     }
368019d6b8fSAnthony Liguori 
369ae261c86SFam Zheng     p_name = strstr(desc, "parentFileNameHint");
370ae261c86SFam Zheng     if (p_name != NULL) {
371019d6b8fSAnthony Liguori         char *end_name;
372019d6b8fSAnthony Liguori 
373019d6b8fSAnthony Liguori         p_name += sizeof("parentFileNameHint") + 1;
374ae261c86SFam Zheng         end_name = strchr(p_name, '\"');
375ae261c86SFam Zheng         if (end_name == NULL) {
376588b65a3SPaolo Bonzini             return -EINVAL;
377ae261c86SFam Zheng         }
378ae261c86SFam Zheng         if ((end_name - p_name) > sizeof(bs->backing_file) - 1) {
379588b65a3SPaolo Bonzini             return -EINVAL;
380ae261c86SFam Zheng         }
381019d6b8fSAnthony Liguori 
382b171271aSKevin Wolf         pstrcpy(bs->backing_file, end_name - p_name + 1, p_name);
383019d6b8fSAnthony Liguori     }
384019d6b8fSAnthony Liguori 
385019d6b8fSAnthony Liguori     return 0;
386019d6b8fSAnthony Liguori }
387019d6b8fSAnthony Liguori 
388b3976d3cSFam Zheng /* Create and append extent to the extent array. Return the added VmdkExtent
389b3976d3cSFam Zheng  * address. return NULL if allocation failed. */
3908aa1331cSFam Zheng static int vmdk_add_extent(BlockDriverState *bs,
391b3976d3cSFam Zheng                            BlockDriverState *file, bool flat, int64_t sectors,
392b3976d3cSFam Zheng                            int64_t l1_offset, int64_t l1_backup_offset,
393b3976d3cSFam Zheng                            uint32_t l1_size,
3948aa1331cSFam Zheng                            int l2_size, uint64_t cluster_sectors,
3954823970bSFam Zheng                            VmdkExtent **new_extent,
3964823970bSFam Zheng                            Error **errp)
397b3976d3cSFam Zheng {
398b3976d3cSFam Zheng     VmdkExtent *extent;
399b3976d3cSFam Zheng     BDRVVmdkState *s = bs->opaque;
400c6ac36e1SFam Zheng     int64_t length;
401b3976d3cSFam Zheng 
4028aa1331cSFam Zheng     if (cluster_sectors > 0x200000) {
4038aa1331cSFam Zheng         /* 0x200000 * 512Bytes = 1GB for one cluster is unrealistic */
4044823970bSFam Zheng         error_setg(errp, "Invalid granularity, image may be corrupt");
4054823970bSFam Zheng         return -EFBIG;
4068aa1331cSFam Zheng     }
407b0651b8cSFam Zheng     if (l1_size > 512 * 1024 * 1024) {
408b0651b8cSFam Zheng         /* Although with big capacity and small l1_entry_sectors, we can get a
409b0651b8cSFam Zheng          * big l1_size, we don't want unbounded value to allocate the table.
410b0651b8cSFam Zheng          * Limit it to 512M, which is 16PB for default cluster and L2 table
411b0651b8cSFam Zheng          * size */
4124823970bSFam Zheng         error_setg(errp, "L1 size too big");
413b0651b8cSFam Zheng         return -EFBIG;
414b0651b8cSFam Zheng     }
4158aa1331cSFam Zheng 
416c6ac36e1SFam Zheng     length = bdrv_getlength(file);
417c6ac36e1SFam Zheng     if (length < 0) {
418c6ac36e1SFam Zheng         return length;
419c6ac36e1SFam Zheng     }
420c6ac36e1SFam Zheng 
4217267c094SAnthony Liguori     s->extents = g_realloc(s->extents,
422b3976d3cSFam Zheng                               (s->num_extents + 1) * sizeof(VmdkExtent));
423b3976d3cSFam Zheng     extent = &s->extents[s->num_extents];
424b3976d3cSFam Zheng     s->num_extents++;
425b3976d3cSFam Zheng 
426b3976d3cSFam Zheng     memset(extent, 0, sizeof(VmdkExtent));
427b3976d3cSFam Zheng     extent->file = file;
428b3976d3cSFam Zheng     extent->flat = flat;
429b3976d3cSFam Zheng     extent->sectors = sectors;
430b3976d3cSFam Zheng     extent->l1_table_offset = l1_offset;
431b3976d3cSFam Zheng     extent->l1_backup_table_offset = l1_backup_offset;
432b3976d3cSFam Zheng     extent->l1_size = l1_size;
433b3976d3cSFam Zheng     extent->l1_entry_sectors = l2_size * cluster_sectors;
434b3976d3cSFam Zheng     extent->l2_size = l2_size;
435301c7d38SFam Zheng     extent->cluster_sectors = flat ? sectors : cluster_sectors;
436c6ac36e1SFam Zheng     extent->next_cluster_sector =
437c6ac36e1SFam Zheng         ROUND_UP(DIV_ROUND_UP(length, BDRV_SECTOR_SIZE), cluster_sectors);
438b3976d3cSFam Zheng 
439b3976d3cSFam Zheng     if (s->num_extents > 1) {
440b3976d3cSFam Zheng         extent->end_sector = (*(extent - 1)).end_sector + extent->sectors;
441b3976d3cSFam Zheng     } else {
442b3976d3cSFam Zheng         extent->end_sector = extent->sectors;
443b3976d3cSFam Zheng     }
444b3976d3cSFam Zheng     bs->total_sectors = extent->end_sector;
4458aa1331cSFam Zheng     if (new_extent) {
4468aa1331cSFam Zheng         *new_extent = extent;
4478aa1331cSFam Zheng     }
4488aa1331cSFam Zheng     return 0;
449b3976d3cSFam Zheng }
450b3976d3cSFam Zheng 
4514823970bSFam Zheng static int vmdk_init_tables(BlockDriverState *bs, VmdkExtent *extent,
4524823970bSFam Zheng                             Error **errp)
453019d6b8fSAnthony Liguori {
454b4b3ab14SFam Zheng     int ret;
455b4b3ab14SFam Zheng     int l1_size, i;
456b4b3ab14SFam Zheng 
457b4b3ab14SFam Zheng     /* read the L1 table */
458b4b3ab14SFam Zheng     l1_size = extent->l1_size * sizeof(uint32_t);
459*d6e59931SKevin Wolf     extent->l1_table = g_try_malloc(l1_size);
460*d6e59931SKevin Wolf     if (l1_size && extent->l1_table == NULL) {
461*d6e59931SKevin Wolf         return -ENOMEM;
462*d6e59931SKevin Wolf     }
463*d6e59931SKevin Wolf 
464b4b3ab14SFam Zheng     ret = bdrv_pread(extent->file,
465b4b3ab14SFam Zheng                      extent->l1_table_offset,
466b4b3ab14SFam Zheng                      extent->l1_table,
467b4b3ab14SFam Zheng                      l1_size);
468b4b3ab14SFam Zheng     if (ret < 0) {
4694823970bSFam Zheng         error_setg_errno(errp, -ret,
4704823970bSFam Zheng                          "Could not read l1 table from extent '%s'",
4714823970bSFam Zheng                          extent->file->filename);
472b4b3ab14SFam Zheng         goto fail_l1;
473b4b3ab14SFam Zheng     }
474b4b3ab14SFam Zheng     for (i = 0; i < extent->l1_size; i++) {
475b4b3ab14SFam Zheng         le32_to_cpus(&extent->l1_table[i]);
476b4b3ab14SFam Zheng     }
477b4b3ab14SFam Zheng 
478b4b3ab14SFam Zheng     if (extent->l1_backup_table_offset) {
479*d6e59931SKevin Wolf         extent->l1_backup_table = g_try_malloc(l1_size);
480*d6e59931SKevin Wolf         if (l1_size && extent->l1_backup_table == NULL) {
481*d6e59931SKevin Wolf             ret = -ENOMEM;
482*d6e59931SKevin Wolf             goto fail_l1;
483*d6e59931SKevin Wolf         }
484b4b3ab14SFam Zheng         ret = bdrv_pread(extent->file,
485b4b3ab14SFam Zheng                          extent->l1_backup_table_offset,
486b4b3ab14SFam Zheng                          extent->l1_backup_table,
487b4b3ab14SFam Zheng                          l1_size);
488b4b3ab14SFam Zheng         if (ret < 0) {
4894823970bSFam Zheng             error_setg_errno(errp, -ret,
4904823970bSFam Zheng                              "Could not read l1 backup table from extent '%s'",
4914823970bSFam Zheng                              extent->file->filename);
492b4b3ab14SFam Zheng             goto fail_l1b;
493b4b3ab14SFam Zheng         }
494b4b3ab14SFam Zheng         for (i = 0; i < extent->l1_size; i++) {
495b4b3ab14SFam Zheng             le32_to_cpus(&extent->l1_backup_table[i]);
496b4b3ab14SFam Zheng         }
497b4b3ab14SFam Zheng     }
498b4b3ab14SFam Zheng 
499b4b3ab14SFam Zheng     extent->l2_cache =
5007267c094SAnthony Liguori         g_malloc(extent->l2_size * L2_CACHE_SIZE * sizeof(uint32_t));
501b4b3ab14SFam Zheng     return 0;
502b4b3ab14SFam Zheng  fail_l1b:
5037267c094SAnthony Liguori     g_free(extent->l1_backup_table);
504b4b3ab14SFam Zheng  fail_l1:
5057267c094SAnthony Liguori     g_free(extent->l1_table);
506b4b3ab14SFam Zheng     return ret;
507b4b3ab14SFam Zheng }
508b4b3ab14SFam Zheng 
509daac8fdcSFam Zheng static int vmdk_open_vmfs_sparse(BlockDriverState *bs,
51086c6b429SFam Zheng                                  BlockDriverState *file,
5114823970bSFam Zheng                                  int flags, Error **errp)
512b4b3ab14SFam Zheng {
513b4b3ab14SFam Zheng     int ret;
514019d6b8fSAnthony Liguori     uint32_t magic;
515019d6b8fSAnthony Liguori     VMDK3Header header;
516b4b3ab14SFam Zheng     VmdkExtent *extent;
517b4b3ab14SFam Zheng 
51886c6b429SFam Zheng     ret = bdrv_pread(file, sizeof(magic), &header, sizeof(header));
519b4b3ab14SFam Zheng     if (ret < 0) {
5204823970bSFam Zheng         error_setg_errno(errp, -ret,
5214823970bSFam Zheng                          "Could not read header from file '%s'",
5224823970bSFam Zheng                          file->filename);
52386c6b429SFam Zheng         return ret;
524b3976d3cSFam Zheng     }
525f6b61e54SFam Zheng     ret = vmdk_add_extent(bs, file, false,
526b3976d3cSFam Zheng                           le32_to_cpu(header.disk_sectors),
527b4b3ab14SFam Zheng                           le32_to_cpu(header.l1dir_offset) << 9,
528f6b61e54SFam Zheng                           0,
529f6b61e54SFam Zheng                           le32_to_cpu(header.l1dir_size),
530f6b61e54SFam Zheng                           4096,
5318aa1331cSFam Zheng                           le32_to_cpu(header.granularity),
5324823970bSFam Zheng                           &extent,
5334823970bSFam Zheng                           errp);
5348aa1331cSFam Zheng     if (ret < 0) {
5358aa1331cSFam Zheng         return ret;
5368aa1331cSFam Zheng     }
5374823970bSFam Zheng     ret = vmdk_init_tables(bs, extent, errp);
538b4b3ab14SFam Zheng     if (ret) {
53986c6b429SFam Zheng         /* free extent allocated by vmdk_add_extent */
54086c6b429SFam Zheng         vmdk_free_last_extent(bs);
541b4b3ab14SFam Zheng     }
542b4b3ab14SFam Zheng     return ret;
543b4b3ab14SFam Zheng }
544b4b3ab14SFam Zheng 
545d1833ef5SPaolo Bonzini static int vmdk_open_desc_file(BlockDriverState *bs, int flags, char *buf,
546d1833ef5SPaolo Bonzini                                Error **errp);
547f16f509dSFam Zheng 
548a8842e6dSPaolo Bonzini static char *vmdk_read_desc(BlockDriverState *file, uint64_t desc_offset,
549a8842e6dSPaolo Bonzini                             Error **errp)
550a8842e6dSPaolo Bonzini {
551a8842e6dSPaolo Bonzini     int64_t size;
552a8842e6dSPaolo Bonzini     char *buf;
553a8842e6dSPaolo Bonzini     int ret;
554a8842e6dSPaolo Bonzini 
555a8842e6dSPaolo Bonzini     size = bdrv_getlength(file);
556a8842e6dSPaolo Bonzini     if (size < 0) {
557a8842e6dSPaolo Bonzini         error_setg_errno(errp, -size, "Could not access file");
558a8842e6dSPaolo Bonzini         return NULL;
559a8842e6dSPaolo Bonzini     }
560a8842e6dSPaolo Bonzini 
561a8842e6dSPaolo Bonzini     size = MIN(size, 1 << 20);  /* avoid unbounded allocation */
562a8842e6dSPaolo Bonzini     buf = g_malloc0(size + 1);
563a8842e6dSPaolo Bonzini 
564a8842e6dSPaolo Bonzini     ret = bdrv_pread(file, desc_offset, buf, size);
565a8842e6dSPaolo Bonzini     if (ret < 0) {
566a8842e6dSPaolo Bonzini         error_setg_errno(errp, -ret, "Could not read from file");
567a8842e6dSPaolo Bonzini         g_free(buf);
568a8842e6dSPaolo Bonzini         return NULL;
569a8842e6dSPaolo Bonzini     }
570a8842e6dSPaolo Bonzini 
571a8842e6dSPaolo Bonzini     return buf;
572a8842e6dSPaolo Bonzini }
573a8842e6dSPaolo Bonzini 
57486c6b429SFam Zheng static int vmdk_open_vmdk4(BlockDriverState *bs,
57586c6b429SFam Zheng                            BlockDriverState *file,
5764823970bSFam Zheng                            int flags, Error **errp)
577b4b3ab14SFam Zheng {
578b4b3ab14SFam Zheng     int ret;
579b4b3ab14SFam Zheng     uint32_t magic;
580b4b3ab14SFam Zheng     uint32_t l1_size, l1_entry_sectors;
581019d6b8fSAnthony Liguori     VMDK4Header header;
582b4b3ab14SFam Zheng     VmdkExtent *extent;
583f4c129a3SFam Zheng     BDRVVmdkState *s = bs->opaque;
584bb45ded9SFam Zheng     int64_t l1_backup_offset = 0;
585b4b3ab14SFam Zheng 
58686c6b429SFam Zheng     ret = bdrv_pread(file, sizeof(magic), &header, sizeof(header));
587b4b3ab14SFam Zheng     if (ret < 0) {
5884823970bSFam Zheng         error_setg_errno(errp, -ret,
5894823970bSFam Zheng                          "Could not read header from file '%s'",
5904823970bSFam Zheng                          file->filename);
59189ac8480SPaolo Bonzini         return -EINVAL;
592b3976d3cSFam Zheng     }
5935a394b9eSStefan Hajnoczi     if (header.capacity == 0) {
594e98768d4SFam Zheng         uint64_t desc_offset = le64_to_cpu(header.desc_offset);
5955a394b9eSStefan Hajnoczi         if (desc_offset) {
596d1833ef5SPaolo Bonzini             char *buf = vmdk_read_desc(file, desc_offset << 9, errp);
597d1833ef5SPaolo Bonzini             if (!buf) {
598d1833ef5SPaolo Bonzini                 return -EINVAL;
599d1833ef5SPaolo Bonzini             }
600d1833ef5SPaolo Bonzini             ret = vmdk_open_desc_file(bs, flags, buf, errp);
601d1833ef5SPaolo Bonzini             g_free(buf);
602d1833ef5SPaolo Bonzini             return ret;
6035a394b9eSStefan Hajnoczi         }
604f16f509dSFam Zheng     }
60565bd155cSKevin Wolf 
606f4c129a3SFam Zheng     if (!s->create_type) {
607f4c129a3SFam Zheng         s->create_type = g_strdup("monolithicSparse");
608f4c129a3SFam Zheng     }
609f4c129a3SFam Zheng 
61065bd155cSKevin Wolf     if (le64_to_cpu(header.gd_offset) == VMDK4_GD_AT_END) {
61165bd155cSKevin Wolf         /*
61265bd155cSKevin Wolf          * The footer takes precedence over the header, so read it in. The
61365bd155cSKevin Wolf          * footer starts at offset -1024 from the end: One sector for the
61465bd155cSKevin Wolf          * footer, and another one for the end-of-stream marker.
61565bd155cSKevin Wolf          */
61665bd155cSKevin Wolf         struct {
61765bd155cSKevin Wolf             struct {
61865bd155cSKevin Wolf                 uint64_t val;
61965bd155cSKevin Wolf                 uint32_t size;
62065bd155cSKevin Wolf                 uint32_t type;
62165bd155cSKevin Wolf                 uint8_t pad[512 - 16];
62265bd155cSKevin Wolf             } QEMU_PACKED footer_marker;
62365bd155cSKevin Wolf 
62465bd155cSKevin Wolf             uint32_t magic;
62565bd155cSKevin Wolf             VMDK4Header header;
62665bd155cSKevin Wolf             uint8_t pad[512 - 4 - sizeof(VMDK4Header)];
62765bd155cSKevin Wolf 
62865bd155cSKevin Wolf             struct {
62965bd155cSKevin Wolf                 uint64_t val;
63065bd155cSKevin Wolf                 uint32_t size;
63165bd155cSKevin Wolf                 uint32_t type;
63265bd155cSKevin Wolf                 uint8_t pad[512 - 16];
63365bd155cSKevin Wolf             } QEMU_PACKED eos_marker;
63465bd155cSKevin Wolf         } QEMU_PACKED footer;
63565bd155cSKevin Wolf 
63665bd155cSKevin Wolf         ret = bdrv_pread(file,
63765bd155cSKevin Wolf             bs->file->total_sectors * 512 - 1536,
63865bd155cSKevin Wolf             &footer, sizeof(footer));
63965bd155cSKevin Wolf         if (ret < 0) {
64065bd155cSKevin Wolf             return ret;
64165bd155cSKevin Wolf         }
64265bd155cSKevin Wolf 
64365bd155cSKevin Wolf         /* Some sanity checks for the footer */
64465bd155cSKevin Wolf         if (be32_to_cpu(footer.magic) != VMDK4_MAGIC ||
64565bd155cSKevin Wolf             le32_to_cpu(footer.footer_marker.size) != 0  ||
64665bd155cSKevin Wolf             le32_to_cpu(footer.footer_marker.type) != MARKER_FOOTER ||
64765bd155cSKevin Wolf             le64_to_cpu(footer.eos_marker.val) != 0  ||
64865bd155cSKevin Wolf             le32_to_cpu(footer.eos_marker.size) != 0  ||
64965bd155cSKevin Wolf             le32_to_cpu(footer.eos_marker.type) != MARKER_END_OF_STREAM)
65065bd155cSKevin Wolf         {
65165bd155cSKevin Wolf             return -EINVAL;
65265bd155cSKevin Wolf         }
65365bd155cSKevin Wolf 
65465bd155cSKevin Wolf         header = footer.header;
65565bd155cSKevin Wolf     }
65665bd155cSKevin Wolf 
657509d39aaSFam Zheng     if (le32_to_cpu(header.version) > 3) {
65896c51eb5SFam Zheng         char buf[64];
6594ab9dab5SFam Zheng         snprintf(buf, sizeof(buf), "VMDK version %" PRId32,
66096c51eb5SFam Zheng                  le32_to_cpu(header.version));
66189ac8480SPaolo Bonzini         error_set(errp, QERR_UNKNOWN_BLOCK_FORMAT_FEATURE,
66296c51eb5SFam Zheng                   bs->device_name, "vmdk", buf);
66396c51eb5SFam Zheng         return -ENOTSUP;
664509d39aaSFam Zheng     } else if (le32_to_cpu(header.version) == 3 && (flags & BDRV_O_RDWR)) {
665509d39aaSFam Zheng         /* VMware KB 2064959 explains that version 3 added support for
666509d39aaSFam Zheng          * persistent changed block tracking (CBT), and backup software can
667509d39aaSFam Zheng          * read it as version=1 if it doesn't care about the changed area
668509d39aaSFam Zheng          * information. So we are safe to enable read only. */
669509d39aaSFam Zheng         error_setg(errp, "VMDK version 3 must be read only");
670509d39aaSFam Zheng         return -EINVAL;
67196c51eb5SFam Zheng     }
67296c51eb5SFam Zheng 
673ca8804ceSFam Zheng     if (le32_to_cpu(header.num_gtes_per_gt) > 512) {
67489ac8480SPaolo Bonzini         error_setg(errp, "L2 table size too big");
675f8ce0403SFam Zheng         return -EINVAL;
676f8ce0403SFam Zheng     }
677f8ce0403SFam Zheng 
678ca8804ceSFam Zheng     l1_entry_sectors = le32_to_cpu(header.num_gtes_per_gt)
679b3976d3cSFam Zheng                         * le64_to_cpu(header.granularity);
68075d12341SStefan Weil     if (l1_entry_sectors == 0) {
68186c6b429SFam Zheng         return -EINVAL;
68286c6b429SFam Zheng     }
683b3976d3cSFam Zheng     l1_size = (le64_to_cpu(header.capacity) + l1_entry_sectors - 1)
684b3976d3cSFam Zheng                 / l1_entry_sectors;
685bb45ded9SFam Zheng     if (le32_to_cpu(header.flags) & VMDK4_FLAG_RGD) {
686bb45ded9SFam Zheng         l1_backup_offset = le64_to_cpu(header.rgd_offset) << 9;
687bb45ded9SFam Zheng     }
68857322b78SMarkus Armbruster     if (bdrv_nb_sectors(file) < le64_to_cpu(header.grain_offset)) {
6894ab9dab5SFam Zheng         error_setg(errp, "File truncated, expecting at least %" PRId64 " bytes",
6904ab9dab5SFam Zheng                    (int64_t)(le64_to_cpu(header.grain_offset)
6914ab9dab5SFam Zheng                              * BDRV_SECTOR_SIZE));
69234ceed81SFam Zheng         return -EINVAL;
69334ceed81SFam Zheng     }
69434ceed81SFam Zheng 
6958aa1331cSFam Zheng     ret = vmdk_add_extent(bs, file, false,
696b3976d3cSFam Zheng                           le64_to_cpu(header.capacity),
697b3976d3cSFam Zheng                           le64_to_cpu(header.gd_offset) << 9,
698bb45ded9SFam Zheng                           l1_backup_offset,
699b3976d3cSFam Zheng                           l1_size,
700ca8804ceSFam Zheng                           le32_to_cpu(header.num_gtes_per_gt),
7018aa1331cSFam Zheng                           le64_to_cpu(header.granularity),
7024823970bSFam Zheng                           &extent,
7034823970bSFam Zheng                           errp);
7048aa1331cSFam Zheng     if (ret < 0) {
7058aa1331cSFam Zheng         return ret;
7068aa1331cSFam Zheng     }
707432bb170SFam Zheng     extent->compressed =
708432bb170SFam Zheng         le16_to_cpu(header.compressAlgorithm) == VMDK4_COMPRESSION_DEFLATE;
709d8a7b061SFam Zheng     if (extent->compressed) {
710d8a7b061SFam Zheng         g_free(s->create_type);
711d8a7b061SFam Zheng         s->create_type = g_strdup("streamOptimized");
712d8a7b061SFam Zheng     }
713432bb170SFam Zheng     extent->has_marker = le32_to_cpu(header.flags) & VMDK4_FLAG_MARKER;
71414ead646SFam Zheng     extent->version = le32_to_cpu(header.version);
71514ead646SFam Zheng     extent->has_zero_grain = le32_to_cpu(header.flags) & VMDK4_FLAG_ZERO_GRAIN;
7164823970bSFam Zheng     ret = vmdk_init_tables(bs, extent, errp);
717b4b3ab14SFam Zheng     if (ret) {
71886c6b429SFam Zheng         /* free extent allocated by vmdk_add_extent */
71986c6b429SFam Zheng         vmdk_free_last_extent(bs);
720019d6b8fSAnthony Liguori     }
721b4b3ab14SFam Zheng     return ret;
722b4b3ab14SFam Zheng }
723b4b3ab14SFam Zheng 
7247fa60fa3SFam Zheng /* find an option value out of descriptor file */
7257fa60fa3SFam Zheng static int vmdk_parse_description(const char *desc, const char *opt_name,
7267fa60fa3SFam Zheng         char *buf, int buf_size)
7277fa60fa3SFam Zheng {
7287fa60fa3SFam Zheng     char *opt_pos, *opt_end;
7297fa60fa3SFam Zheng     const char *end = desc + strlen(desc);
7307fa60fa3SFam Zheng 
7317fa60fa3SFam Zheng     opt_pos = strstr(desc, opt_name);
7327fa60fa3SFam Zheng     if (!opt_pos) {
73365f74725SFam Zheng         return VMDK_ERROR;
7347fa60fa3SFam Zheng     }
7357fa60fa3SFam Zheng     /* Skip "=\"" following opt_name */
7367fa60fa3SFam Zheng     opt_pos += strlen(opt_name) + 2;
7377fa60fa3SFam Zheng     if (opt_pos >= end) {
73865f74725SFam Zheng         return VMDK_ERROR;
7397fa60fa3SFam Zheng     }
7407fa60fa3SFam Zheng     opt_end = opt_pos;
7417fa60fa3SFam Zheng     while (opt_end < end && *opt_end != '"') {
7427fa60fa3SFam Zheng         opt_end++;
7437fa60fa3SFam Zheng     }
7447fa60fa3SFam Zheng     if (opt_end == end || buf_size < opt_end - opt_pos + 1) {
74565f74725SFam Zheng         return VMDK_ERROR;
7467fa60fa3SFam Zheng     }
7477fa60fa3SFam Zheng     pstrcpy(buf, opt_end - opt_pos + 1, opt_pos);
74865f74725SFam Zheng     return VMDK_OK;
7497fa60fa3SFam Zheng }
7507fa60fa3SFam Zheng 
75186c6b429SFam Zheng /* Open an extent file and append to bs array */
75286c6b429SFam Zheng static int vmdk_open_sparse(BlockDriverState *bs,
753d1833ef5SPaolo Bonzini                             BlockDriverState *file, int flags,
754d1833ef5SPaolo Bonzini                             char *buf, Error **errp)
75586c6b429SFam Zheng {
75686c6b429SFam Zheng     uint32_t magic;
75786c6b429SFam Zheng 
758d1833ef5SPaolo Bonzini     magic = ldl_be_p(buf);
75986c6b429SFam Zheng     switch (magic) {
76086c6b429SFam Zheng         case VMDK3_MAGIC:
7614823970bSFam Zheng             return vmdk_open_vmfs_sparse(bs, file, flags, errp);
76286c6b429SFam Zheng             break;
76386c6b429SFam Zheng         case VMDK4_MAGIC:
7644823970bSFam Zheng             return vmdk_open_vmdk4(bs, file, flags, errp);
76586c6b429SFam Zheng             break;
76686c6b429SFam Zheng         default:
76776abe407SPaolo Bonzini             error_setg(errp, "Image not in VMDK format");
76876abe407SPaolo Bonzini             return -EINVAL;
76986c6b429SFam Zheng             break;
77086c6b429SFam Zheng     }
77186c6b429SFam Zheng }
77286c6b429SFam Zheng 
7737fa60fa3SFam Zheng static int vmdk_parse_extents(const char *desc, BlockDriverState *bs,
7744823970bSFam Zheng                               const char *desc_file_path, Error **errp)
7757fa60fa3SFam Zheng {
7767fa60fa3SFam Zheng     int ret;
7777fa60fa3SFam Zheng     char access[11];
7787fa60fa3SFam Zheng     char type[11];
7797fa60fa3SFam Zheng     char fname[512];
7807fa60fa3SFam Zheng     const char *p = desc;
7817fa60fa3SFam Zheng     int64_t sectors = 0;
7827fa60fa3SFam Zheng     int64_t flat_offset;
78386c6b429SFam Zheng     char extent_path[PATH_MAX];
78486c6b429SFam Zheng     BlockDriverState *extent_file;
785f4c129a3SFam Zheng     BDRVVmdkState *s = bs->opaque;
786f4c129a3SFam Zheng     VmdkExtent *extent;
7877fa60fa3SFam Zheng 
7887fa60fa3SFam Zheng     while (*p) {
7897fa60fa3SFam Zheng         /* parse extent line:
7907fa60fa3SFam Zheng          * RW [size in sectors] FLAT "file-name.vmdk" OFFSET
7917fa60fa3SFam Zheng          * or
7927fa60fa3SFam Zheng          * RW [size in sectors] SPARSE "file-name.vmdk"
7937fa60fa3SFam Zheng          */
7947fa60fa3SFam Zheng         flat_offset = -1;
795cd923475SPhilipp Hahn         ret = sscanf(p, "%10s %" SCNd64 " %10s \"%511[^\n\r\"]\" %" SCNd64,
7967fa60fa3SFam Zheng                 access, &sectors, type, fname, &flat_offset);
7977fa60fa3SFam Zheng         if (ret < 4 || strcmp(access, "RW")) {
7987fa60fa3SFam Zheng             goto next_line;
7997fa60fa3SFam Zheng         } else if (!strcmp(type, "FLAT")) {
8007fa60fa3SFam Zheng             if (ret != 5 || flat_offset < 0) {
8014823970bSFam Zheng                 error_setg(errp, "Invalid extent lines: \n%s", p);
8027fa60fa3SFam Zheng                 return -EINVAL;
8037fa60fa3SFam Zheng             }
804dbbcaa8dSFam Zheng         } else if (!strcmp(type, "VMFS")) {
805b47053bdSFam Zheng             if (ret == 4) {
806dbbcaa8dSFam Zheng                 flat_offset = 0;
807b47053bdSFam Zheng             } else {
808b47053bdSFam Zheng                 error_setg(errp, "Invalid extent lines:\n%s", p);
809b47053bdSFam Zheng                 return -EINVAL;
810b47053bdSFam Zheng             }
8117fa60fa3SFam Zheng         } else if (ret != 4) {
8124823970bSFam Zheng             error_setg(errp, "Invalid extent lines:\n%s", p);
8137fa60fa3SFam Zheng             return -EINVAL;
8147fa60fa3SFam Zheng         }
8157fa60fa3SFam Zheng 
8167fa60fa3SFam Zheng         if (sectors <= 0 ||
817daac8fdcSFam Zheng             (strcmp(type, "FLAT") && strcmp(type, "SPARSE") &&
81804d542c8SPaolo Bonzini              strcmp(type, "VMFS") && strcmp(type, "VMFSSPARSE")) ||
8197fa60fa3SFam Zheng             (strcmp(access, "RW"))) {
8207fa60fa3SFam Zheng             goto next_line;
8217fa60fa3SFam Zheng         }
8227fa60fa3SFam Zheng 
8237fa60fa3SFam Zheng         path_combine(extent_path, sizeof(extent_path),
8247fa60fa3SFam Zheng                 desc_file_path, fname);
8252e40134bSMax Reitz         extent_file = NULL;
8262e40134bSMax Reitz         ret = bdrv_open(&extent_file, extent_path, NULL, NULL,
8272e40134bSMax Reitz                         bs->open_flags | BDRV_O_PROTOCOL, NULL, errp);
8287fa60fa3SFam Zheng         if (ret) {
8297fa60fa3SFam Zheng             return ret;
8307fa60fa3SFam Zheng         }
83186c6b429SFam Zheng 
83286c6b429SFam Zheng         /* save to extents array */
83304d542c8SPaolo Bonzini         if (!strcmp(type, "FLAT") || !strcmp(type, "VMFS")) {
83486c6b429SFam Zheng             /* FLAT extent */
83586c6b429SFam Zheng 
8368aa1331cSFam Zheng             ret = vmdk_add_extent(bs, extent_file, true, sectors,
8374823970bSFam Zheng                             0, 0, 0, 0, 0, &extent, errp);
8388aa1331cSFam Zheng             if (ret < 0) {
8398aa1331cSFam Zheng                 return ret;
8408aa1331cSFam Zheng             }
841f16f509dSFam Zheng             extent->flat_start_offset = flat_offset << 9;
842daac8fdcSFam Zheng         } else if (!strcmp(type, "SPARSE") || !strcmp(type, "VMFSSPARSE")) {
843daac8fdcSFam Zheng             /* SPARSE extent and VMFSSPARSE extent are both "COWD" sparse file*/
844d1833ef5SPaolo Bonzini             char *buf = vmdk_read_desc(extent_file, 0, errp);
845d1833ef5SPaolo Bonzini             if (!buf) {
846d1833ef5SPaolo Bonzini                 ret = -EINVAL;
847d1833ef5SPaolo Bonzini             } else {
848d1833ef5SPaolo Bonzini                 ret = vmdk_open_sparse(bs, extent_file, bs->open_flags, buf, errp);
849d1833ef5SPaolo Bonzini             }
85086c6b429SFam Zheng             if (ret) {
851d1833ef5SPaolo Bonzini                 g_free(buf);
8524f6fd349SFam Zheng                 bdrv_unref(extent_file);
85386c6b429SFam Zheng                 return ret;
85486c6b429SFam Zheng             }
855f4c129a3SFam Zheng             extent = &s->extents[s->num_extents - 1];
8567fa60fa3SFam Zheng         } else {
8574823970bSFam Zheng             error_setg(errp, "Unsupported extent type '%s'", type);
8587fa60fa3SFam Zheng             return -ENOTSUP;
8597fa60fa3SFam Zheng         }
860f4c129a3SFam Zheng         extent->type = g_strdup(type);
8617fa60fa3SFam Zheng next_line:
8627fa60fa3SFam Zheng         /* move to next line */
863899f1ae2SFam Zheng         while (*p) {
864899f1ae2SFam Zheng             if (*p == '\n') {
8657fa60fa3SFam Zheng                 p++;
866899f1ae2SFam Zheng                 break;
8677fa60fa3SFam Zheng             }
8687fa60fa3SFam Zheng             p++;
8697fa60fa3SFam Zheng         }
870899f1ae2SFam Zheng     }
8717fa60fa3SFam Zheng     return 0;
8727fa60fa3SFam Zheng }
8737fa60fa3SFam Zheng 
874d1833ef5SPaolo Bonzini static int vmdk_open_desc_file(BlockDriverState *bs, int flags, char *buf,
875d1833ef5SPaolo Bonzini                                Error **errp)
8767fa60fa3SFam Zheng {
8777fa60fa3SFam Zheng     int ret;
8787fa60fa3SFam Zheng     char ct[128];
8797fa60fa3SFam Zheng     BDRVVmdkState *s = bs->opaque;
8807fa60fa3SFam Zheng 
8817fa60fa3SFam Zheng     if (vmdk_parse_description(buf, "createType", ct, sizeof(ct))) {
88276abe407SPaolo Bonzini         error_setg(errp, "invalid VMDK image descriptor");
88376abe407SPaolo Bonzini         ret = -EINVAL;
8840bed087dSEvgeny Budilovsky         goto exit;
8857fa60fa3SFam Zheng     }
8866398de51SFam Zheng     if (strcmp(ct, "monolithicFlat") &&
88704d542c8SPaolo Bonzini         strcmp(ct, "vmfs") &&
888daac8fdcSFam Zheng         strcmp(ct, "vmfsSparse") &&
88986c6b429SFam Zheng         strcmp(ct, "twoGbMaxExtentSparse") &&
8906398de51SFam Zheng         strcmp(ct, "twoGbMaxExtentFlat")) {
8914823970bSFam Zheng         error_setg(errp, "Unsupported image type '%s'", ct);
8920bed087dSEvgeny Budilovsky         ret = -ENOTSUP;
8930bed087dSEvgeny Budilovsky         goto exit;
8947fa60fa3SFam Zheng     }
895f4c129a3SFam Zheng     s->create_type = g_strdup(ct);
8967fa60fa3SFam Zheng     s->desc_offset = 0;
8974823970bSFam Zheng     ret = vmdk_parse_extents(buf, bs, bs->file->filename, errp);
8980bed087dSEvgeny Budilovsky exit:
8990bed087dSEvgeny Budilovsky     return ret;
9007fa60fa3SFam Zheng }
9017fa60fa3SFam Zheng 
902015a1036SMax Reitz static int vmdk_open(BlockDriverState *bs, QDict *options, int flags,
903015a1036SMax Reitz                      Error **errp)
904b4b3ab14SFam Zheng {
905d1833ef5SPaolo Bonzini     char *buf = NULL;
90686c6b429SFam Zheng     int ret;
90786c6b429SFam Zheng     BDRVVmdkState *s = bs->opaque;
90837f09e5eSPaolo Bonzini     uint32_t magic;
909b4b3ab14SFam Zheng 
910d1833ef5SPaolo Bonzini     buf = vmdk_read_desc(bs->file, 0, errp);
911d1833ef5SPaolo Bonzini     if (!buf) {
912d1833ef5SPaolo Bonzini         return -EINVAL;
913d1833ef5SPaolo Bonzini     }
914d1833ef5SPaolo Bonzini 
91537f09e5eSPaolo Bonzini     magic = ldl_be_p(buf);
91637f09e5eSPaolo Bonzini     switch (magic) {
91737f09e5eSPaolo Bonzini         case VMDK3_MAGIC:
91837f09e5eSPaolo Bonzini         case VMDK4_MAGIC:
91937f09e5eSPaolo Bonzini             ret = vmdk_open_sparse(bs, bs->file, flags, buf, errp);
92086c6b429SFam Zheng             s->desc_offset = 0x200;
92137f09e5eSPaolo Bonzini             break;
92237f09e5eSPaolo Bonzini         default:
923d1833ef5SPaolo Bonzini             ret = vmdk_open_desc_file(bs, flags, buf, errp);
92437f09e5eSPaolo Bonzini             break;
92537f09e5eSPaolo Bonzini     }
926bae0a0ccSPaolo Bonzini     if (ret) {
927bae0a0ccSPaolo Bonzini         goto fail;
928bae0a0ccSPaolo Bonzini     }
92937f09e5eSPaolo Bonzini 
93086c6b429SFam Zheng     /* try to open parent images, if exist */
93186c6b429SFam Zheng     ret = vmdk_parent_open(bs);
93286c6b429SFam Zheng     if (ret) {
933bae0a0ccSPaolo Bonzini         goto fail;
934b4b3ab14SFam Zheng     }
935f4c129a3SFam Zheng     s->cid = vmdk_read_cid(bs, 0);
93686c6b429SFam Zheng     s->parent_cid = vmdk_read_cid(bs, 1);
937848c66e8SPaolo Bonzini     qemu_co_mutex_init(&s->lock);
9382bc3166cSKevin Wolf 
9392bc3166cSKevin Wolf     /* Disable migration when VMDK images are used */
9402bc3166cSKevin Wolf     error_set(&s->migration_blocker,
9412bc3166cSKevin Wolf               QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
9422bc3166cSKevin Wolf               "vmdk", bs->device_name, "live migration");
9432bc3166cSKevin Wolf     migrate_add_blocker(s->migration_blocker);
944d1833ef5SPaolo Bonzini     g_free(buf);
9452bc3166cSKevin Wolf     return 0;
946bae0a0ccSPaolo Bonzini 
947bae0a0ccSPaolo Bonzini fail:
948d1833ef5SPaolo Bonzini     g_free(buf);
949f4c129a3SFam Zheng     g_free(s->create_type);
950f4c129a3SFam Zheng     s->create_type = NULL;
951bae0a0ccSPaolo Bonzini     vmdk_free_extents(bs);
952bae0a0ccSPaolo Bonzini     return ret;
953019d6b8fSAnthony Liguori }
954019d6b8fSAnthony Liguori 
955d34682cdSKevin Wolf 
9563baca891SKevin Wolf static void vmdk_refresh_limits(BlockDriverState *bs, Error **errp)
957d34682cdSKevin Wolf {
958d34682cdSKevin Wolf     BDRVVmdkState *s = bs->opaque;
959d34682cdSKevin Wolf     int i;
960d34682cdSKevin Wolf 
961d34682cdSKevin Wolf     for (i = 0; i < s->num_extents; i++) {
962d34682cdSKevin Wolf         if (!s->extents[i].flat) {
963d34682cdSKevin Wolf             bs->bl.write_zeroes_alignment =
964d34682cdSKevin Wolf                 MAX(bs->bl.write_zeroes_alignment,
965d34682cdSKevin Wolf                     s->extents[i].cluster_sectors);
966d34682cdSKevin Wolf         }
967d34682cdSKevin Wolf     }
968d34682cdSKevin Wolf }
969d34682cdSKevin Wolf 
970c6ac36e1SFam Zheng /**
971c6ac36e1SFam Zheng  * get_whole_cluster
972c6ac36e1SFam Zheng  *
973c6ac36e1SFam Zheng  * Copy backing file's cluster that covers @sector_num, otherwise write zero,
974c6ac36e1SFam Zheng  * to the cluster at @cluster_sector_num.
975c6ac36e1SFam Zheng  *
976c6ac36e1SFam Zheng  * If @skip_start_sector < @skip_end_sector, the relative range
977c6ac36e1SFam Zheng  * [@skip_start_sector, @skip_end_sector) is not copied or written, and leave
978c6ac36e1SFam Zheng  * it for call to write user data in the request.
979c6ac36e1SFam Zheng  */
980b3976d3cSFam Zheng static int get_whole_cluster(BlockDriverState *bs,
981b3976d3cSFam Zheng                              VmdkExtent *extent,
982c6ac36e1SFam Zheng                              uint64_t cluster_sector_num,
983c6ac36e1SFam Zheng                              uint64_t sector_num,
984c6ac36e1SFam Zheng                              uint64_t skip_start_sector,
985c6ac36e1SFam Zheng                              uint64_t skip_end_sector)
986019d6b8fSAnthony Liguori {
987bf81507dSFam Zheng     int ret = VMDK_OK;
988c6ac36e1SFam Zheng     int64_t cluster_bytes;
989c6ac36e1SFam Zheng     uint8_t *whole_grain;
990019d6b8fSAnthony Liguori 
991c6ac36e1SFam Zheng     /* For COW, align request sector_num to cluster start */
992c6ac36e1SFam Zheng     sector_num = QEMU_ALIGN_DOWN(sector_num, extent->cluster_sectors);
993c6ac36e1SFam Zheng     cluster_bytes = extent->cluster_sectors << BDRV_SECTOR_BITS;
994c6ac36e1SFam Zheng     whole_grain = qemu_blockalign(bs, cluster_bytes);
995c6ac36e1SFam Zheng 
996c6ac36e1SFam Zheng     if (!bs->backing_hd) {
997c6ac36e1SFam Zheng         memset(whole_grain, 0,  skip_start_sector << BDRV_SECTOR_BITS);
998c6ac36e1SFam Zheng         memset(whole_grain + (skip_end_sector << BDRV_SECTOR_BITS), 0,
999c6ac36e1SFam Zheng                cluster_bytes - (skip_end_sector << BDRV_SECTOR_BITS));
1000c6ac36e1SFam Zheng     }
1001c6ac36e1SFam Zheng 
1002c6ac36e1SFam Zheng     assert(skip_end_sector <= extent->cluster_sectors);
10030e69c543SFam Zheng     /* we will be here if it's first write on non-exist grain(cluster).
10040e69c543SFam Zheng      * try to read from parent image, if exist */
1005c6ac36e1SFam Zheng     if (bs->backing_hd && !vmdk_is_cid_valid(bs)) {
1006c6ac36e1SFam Zheng         ret = VMDK_ERROR;
1007c6ac36e1SFam Zheng         goto exit;
1008c6ac36e1SFam Zheng     }
1009c6ac36e1SFam Zheng 
1010c6ac36e1SFam Zheng     /* Read backing data before skip range */
1011c6ac36e1SFam Zheng     if (skip_start_sector > 0) {
1012b171271aSKevin Wolf         if (bs->backing_hd) {
1013c6ac36e1SFam Zheng             ret = bdrv_read(bs->backing_hd, sector_num,
1014c6ac36e1SFam Zheng                             whole_grain, skip_start_sector);
1015c336500dSKevin Wolf             if (ret < 0) {
1016bf81507dSFam Zheng                 ret = VMDK_ERROR;
1017bf81507dSFam Zheng                 goto exit;
1018019d6b8fSAnthony Liguori             }
1019019d6b8fSAnthony Liguori         }
1020c6ac36e1SFam Zheng         ret = bdrv_write(extent->file, cluster_sector_num, whole_grain,
1021c6ac36e1SFam Zheng                          skip_start_sector);
1022c6ac36e1SFam Zheng         if (ret < 0) {
1023c6ac36e1SFam Zheng             ret = VMDK_ERROR;
1024c6ac36e1SFam Zheng             goto exit;
1025c6ac36e1SFam Zheng         }
1026c6ac36e1SFam Zheng     }
1027c6ac36e1SFam Zheng     /* Read backing data after skip range */
1028c6ac36e1SFam Zheng     if (skip_end_sector < extent->cluster_sectors) {
1029c6ac36e1SFam Zheng         if (bs->backing_hd) {
1030c6ac36e1SFam Zheng             ret = bdrv_read(bs->backing_hd, sector_num + skip_end_sector,
1031c6ac36e1SFam Zheng                             whole_grain + (skip_end_sector << BDRV_SECTOR_BITS),
1032c6ac36e1SFam Zheng                             extent->cluster_sectors - skip_end_sector);
1033c6ac36e1SFam Zheng             if (ret < 0) {
1034c6ac36e1SFam Zheng                 ret = VMDK_ERROR;
1035c6ac36e1SFam Zheng                 goto exit;
1036c6ac36e1SFam Zheng             }
1037c6ac36e1SFam Zheng         }
1038c6ac36e1SFam Zheng         ret = bdrv_write(extent->file, cluster_sector_num + skip_end_sector,
1039c6ac36e1SFam Zheng                          whole_grain + (skip_end_sector << BDRV_SECTOR_BITS),
1040c6ac36e1SFam Zheng                          extent->cluster_sectors - skip_end_sector);
1041c6ac36e1SFam Zheng         if (ret < 0) {
1042c6ac36e1SFam Zheng             ret = VMDK_ERROR;
1043c6ac36e1SFam Zheng             goto exit;
1044c6ac36e1SFam Zheng         }
1045c6ac36e1SFam Zheng     }
1046c6ac36e1SFam Zheng 
1047bf81507dSFam Zheng exit:
1048bf81507dSFam Zheng     qemu_vfree(whole_grain);
1049bf81507dSFam Zheng     return ret;
1050019d6b8fSAnthony Liguori }
1051019d6b8fSAnthony Liguori 
1052c6ac36e1SFam Zheng static int vmdk_L2update(VmdkExtent *extent, VmdkMetaData *m_data,
1053c6ac36e1SFam Zheng                          uint32_t offset)
1054019d6b8fSAnthony Liguori {
1055c6ac36e1SFam Zheng     offset = cpu_to_le32(offset);
1056019d6b8fSAnthony Liguori     /* update L2 table */
1057b3976d3cSFam Zheng     if (bdrv_pwrite_sync(
1058b3976d3cSFam Zheng                 extent->file,
1059b3976d3cSFam Zheng                 ((int64_t)m_data->l2_offset * 512)
1060c6ac36e1SFam Zheng                     + (m_data->l2_index * sizeof(offset)),
1061e304e8e5SFam Zheng                 &offset, sizeof(offset)) < 0) {
106265f74725SFam Zheng         return VMDK_ERROR;
1063b3976d3cSFam Zheng     }
1064019d6b8fSAnthony Liguori     /* update backup L2 table */
1065b3976d3cSFam Zheng     if (extent->l1_backup_table_offset != 0) {
1066b3976d3cSFam Zheng         m_data->l2_offset = extent->l1_backup_table[m_data->l1_index];
1067b3976d3cSFam Zheng         if (bdrv_pwrite_sync(
1068b3976d3cSFam Zheng                     extent->file,
1069b3976d3cSFam Zheng                     ((int64_t)m_data->l2_offset * 512)
1070c6ac36e1SFam Zheng                         + (m_data->l2_index * sizeof(offset)),
1071e304e8e5SFam Zheng                     &offset, sizeof(offset)) < 0) {
107265f74725SFam Zheng             return VMDK_ERROR;
1073019d6b8fSAnthony Liguori         }
1074b3976d3cSFam Zheng     }
1075cdeaf1f1SFam Zheng     if (m_data->l2_cache_entry) {
1076cdeaf1f1SFam Zheng         *m_data->l2_cache_entry = offset;
1077cdeaf1f1SFam Zheng     }
1078019d6b8fSAnthony Liguori 
107965f74725SFam Zheng     return VMDK_OK;
1080019d6b8fSAnthony Liguori }
1081019d6b8fSAnthony Liguori 
1082c6ac36e1SFam Zheng /**
1083c6ac36e1SFam Zheng  * get_cluster_offset
1084c6ac36e1SFam Zheng  *
1085c6ac36e1SFam Zheng  * Look up cluster offset in extent file by sector number, and store in
1086c6ac36e1SFam Zheng  * @cluster_offset.
1087c6ac36e1SFam Zheng  *
1088c6ac36e1SFam Zheng  * For flat extents, the start offset as parsed from the description file is
1089c6ac36e1SFam Zheng  * returned.
1090c6ac36e1SFam Zheng  *
1091c6ac36e1SFam Zheng  * For sparse extents, look up in L1, L2 table. If allocate is true, return an
1092c6ac36e1SFam Zheng  * offset for a new cluster and update L2 cache. If there is a backing file,
1093c6ac36e1SFam Zheng  * COW is done before returning; otherwise, zeroes are written to the allocated
1094c6ac36e1SFam Zheng  * cluster. Both COW and zero writing skips the sector range
1095c6ac36e1SFam Zheng  * [@skip_start_sector, @skip_end_sector) passed in by caller, because caller
1096c6ac36e1SFam Zheng  * has new data to write there.
1097c6ac36e1SFam Zheng  *
1098c6ac36e1SFam Zheng  * Returns: VMDK_OK if cluster exists and mapped in the image.
1099c6ac36e1SFam Zheng  *          VMDK_UNALLOC if cluster is not mapped and @allocate is false.
1100c6ac36e1SFam Zheng  *          VMDK_ERROR if failed.
1101c6ac36e1SFam Zheng  */
110291b85bd3SFam Zheng static int get_cluster_offset(BlockDriverState *bs,
1103b3976d3cSFam Zheng                               VmdkExtent *extent,
1104b3976d3cSFam Zheng                               VmdkMetaData *m_data,
110591b85bd3SFam Zheng                               uint64_t offset,
1106c6ac36e1SFam Zheng                               bool allocate,
1107c6ac36e1SFam Zheng                               uint64_t *cluster_offset,
1108c6ac36e1SFam Zheng                               uint64_t skip_start_sector,
1109c6ac36e1SFam Zheng                               uint64_t skip_end_sector)
1110019d6b8fSAnthony Liguori {
1111019d6b8fSAnthony Liguori     unsigned int l1_index, l2_offset, l2_index;
1112019d6b8fSAnthony Liguori     int min_index, i, j;
1113e304e8e5SFam Zheng     uint32_t min_count, *l2_table;
111414ead646SFam Zheng     bool zeroed = false;
1115c6ac36e1SFam Zheng     int64_t ret;
1116c6ac36e1SFam Zheng     int32_t cluster_sector;
1117019d6b8fSAnthony Liguori 
1118ae261c86SFam Zheng     if (m_data) {
1119019d6b8fSAnthony Liguori         m_data->valid = 0;
1120ae261c86SFam Zheng     }
112191b85bd3SFam Zheng     if (extent->flat) {
11227fa60fa3SFam Zheng         *cluster_offset = extent->flat_start_offset;
112365f74725SFam Zheng         return VMDK_OK;
112491b85bd3SFam Zheng     }
1125019d6b8fSAnthony Liguori 
11266398de51SFam Zheng     offset -= (extent->end_sector - extent->sectors) * SECTOR_SIZE;
1127b3976d3cSFam Zheng     l1_index = (offset >> 9) / extent->l1_entry_sectors;
1128b3976d3cSFam Zheng     if (l1_index >= extent->l1_size) {
112965f74725SFam Zheng         return VMDK_ERROR;
1130b3976d3cSFam Zheng     }
1131b3976d3cSFam Zheng     l2_offset = extent->l1_table[l1_index];
1132b3976d3cSFam Zheng     if (!l2_offset) {
113365f74725SFam Zheng         return VMDK_UNALLOC;
1134b3976d3cSFam Zheng     }
1135019d6b8fSAnthony Liguori     for (i = 0; i < L2_CACHE_SIZE; i++) {
1136b3976d3cSFam Zheng         if (l2_offset == extent->l2_cache_offsets[i]) {
1137019d6b8fSAnthony Liguori             /* increment the hit count */
1138b3976d3cSFam Zheng             if (++extent->l2_cache_counts[i] == 0xffffffff) {
1139019d6b8fSAnthony Liguori                 for (j = 0; j < L2_CACHE_SIZE; j++) {
1140b3976d3cSFam Zheng                     extent->l2_cache_counts[j] >>= 1;
1141019d6b8fSAnthony Liguori                 }
1142019d6b8fSAnthony Liguori             }
1143b3976d3cSFam Zheng             l2_table = extent->l2_cache + (i * extent->l2_size);
1144019d6b8fSAnthony Liguori             goto found;
1145019d6b8fSAnthony Liguori         }
1146019d6b8fSAnthony Liguori     }
1147019d6b8fSAnthony Liguori     /* not found: load a new entry in the least used one */
1148019d6b8fSAnthony Liguori     min_index = 0;
1149019d6b8fSAnthony Liguori     min_count = 0xffffffff;
1150019d6b8fSAnthony Liguori     for (i = 0; i < L2_CACHE_SIZE; i++) {
1151b3976d3cSFam Zheng         if (extent->l2_cache_counts[i] < min_count) {
1152b3976d3cSFam Zheng             min_count = extent->l2_cache_counts[i];
1153019d6b8fSAnthony Liguori             min_index = i;
1154019d6b8fSAnthony Liguori         }
1155019d6b8fSAnthony Liguori     }
1156b3976d3cSFam Zheng     l2_table = extent->l2_cache + (min_index * extent->l2_size);
1157b3976d3cSFam Zheng     if (bdrv_pread(
1158b3976d3cSFam Zheng                 extent->file,
1159b3976d3cSFam Zheng                 (int64_t)l2_offset * 512,
1160b3976d3cSFam Zheng                 l2_table,
1161b3976d3cSFam Zheng                 extent->l2_size * sizeof(uint32_t)
1162b3976d3cSFam Zheng             ) != extent->l2_size * sizeof(uint32_t)) {
116365f74725SFam Zheng         return VMDK_ERROR;
1164b3976d3cSFam Zheng     }
1165019d6b8fSAnthony Liguori 
1166b3976d3cSFam Zheng     extent->l2_cache_offsets[min_index] = l2_offset;
1167b3976d3cSFam Zheng     extent->l2_cache_counts[min_index] = 1;
1168019d6b8fSAnthony Liguori  found:
1169b3976d3cSFam Zheng     l2_index = ((offset >> 9) / extent->cluster_sectors) % extent->l2_size;
1170c6ac36e1SFam Zheng     cluster_sector = le32_to_cpu(l2_table[l2_index]);
1171019d6b8fSAnthony Liguori 
1172cdeaf1f1SFam Zheng     if (m_data) {
1173cdeaf1f1SFam Zheng         m_data->valid = 1;
1174cdeaf1f1SFam Zheng         m_data->l1_index = l1_index;
1175cdeaf1f1SFam Zheng         m_data->l2_index = l2_index;
1176cdeaf1f1SFam Zheng         m_data->l2_offset = l2_offset;
1177cdeaf1f1SFam Zheng         m_data->l2_cache_entry = &l2_table[l2_index];
1178cdeaf1f1SFam Zheng     }
1179c6ac36e1SFam Zheng     if (extent->has_zero_grain && cluster_sector == VMDK_GTE_ZEROED) {
118014ead646SFam Zheng         zeroed = true;
118114ead646SFam Zheng     }
118214ead646SFam Zheng 
1183c6ac36e1SFam Zheng     if (!cluster_sector || zeroed) {
118491b85bd3SFam Zheng         if (!allocate) {
118514ead646SFam Zheng             return zeroed ? VMDK_ZEROED : VMDK_UNALLOC;
118691b85bd3SFam Zheng         }
11879949f97eSKevin Wolf 
1188c6ac36e1SFam Zheng         cluster_sector = extent->next_cluster_sector;
1189c6ac36e1SFam Zheng         extent->next_cluster_sector += extent->cluster_sectors;
11909949f97eSKevin Wolf 
1191019d6b8fSAnthony Liguori         /* First of all we write grain itself, to avoid race condition
1192019d6b8fSAnthony Liguori          * that may to corrupt the image.
1193019d6b8fSAnthony Liguori          * This problem may occur because of insufficient space on host disk
1194019d6b8fSAnthony Liguori          * or inappropriate VM shutdown.
1195019d6b8fSAnthony Liguori          */
1196c6ac36e1SFam Zheng         ret = get_whole_cluster(bs, extent,
1197c6ac36e1SFam Zheng                                 cluster_sector,
1198c6ac36e1SFam Zheng                                 offset >> BDRV_SECTOR_BITS,
1199c6ac36e1SFam Zheng                                 skip_start_sector, skip_end_sector);
1200c6ac36e1SFam Zheng         if (ret) {
1201c6ac36e1SFam Zheng             return ret;
1202019d6b8fSAnthony Liguori         }
1203019d6b8fSAnthony Liguori     }
1204c6ac36e1SFam Zheng     *cluster_offset = cluster_sector << BDRV_SECTOR_BITS;
120565f74725SFam Zheng     return VMDK_OK;
1206019d6b8fSAnthony Liguori }
1207019d6b8fSAnthony Liguori 
1208b3976d3cSFam Zheng static VmdkExtent *find_extent(BDRVVmdkState *s,
1209b3976d3cSFam Zheng                                 int64_t sector_num, VmdkExtent *start_hint)
1210b3976d3cSFam Zheng {
1211b3976d3cSFam Zheng     VmdkExtent *extent = start_hint;
1212b3976d3cSFam Zheng 
1213b3976d3cSFam Zheng     if (!extent) {
1214b3976d3cSFam Zheng         extent = &s->extents[0];
1215b3976d3cSFam Zheng     }
1216b3976d3cSFam Zheng     while (extent < &s->extents[s->num_extents]) {
1217b3976d3cSFam Zheng         if (sector_num < extent->end_sector) {
1218b3976d3cSFam Zheng             return extent;
1219b3976d3cSFam Zheng         }
1220b3976d3cSFam Zheng         extent++;
1221b3976d3cSFam Zheng     }
1222b3976d3cSFam Zheng     return NULL;
1223b3976d3cSFam Zheng }
1224b3976d3cSFam Zheng 
1225b6b8a333SPaolo Bonzini static int64_t coroutine_fn vmdk_co_get_block_status(BlockDriverState *bs,
1226f8a2e5e3SStefan Hajnoczi         int64_t sector_num, int nb_sectors, int *pnum)
1227019d6b8fSAnthony Liguori {
1228019d6b8fSAnthony Liguori     BDRVVmdkState *s = bs->opaque;
1229b3976d3cSFam Zheng     int64_t index_in_cluster, n, ret;
1230b3976d3cSFam Zheng     uint64_t offset;
1231b3976d3cSFam Zheng     VmdkExtent *extent;
1232b3976d3cSFam Zheng 
1233b3976d3cSFam Zheng     extent = find_extent(s, sector_num, NULL);
1234b3976d3cSFam Zheng     if (!extent) {
1235b3976d3cSFam Zheng         return 0;
1236b3976d3cSFam Zheng     }
1237f8a2e5e3SStefan Hajnoczi     qemu_co_mutex_lock(&s->lock);
123891b85bd3SFam Zheng     ret = get_cluster_offset(bs, extent, NULL,
1239c6ac36e1SFam Zheng                              sector_num * 512, false, &offset,
1240c6ac36e1SFam Zheng                              0, 0);
1241f8a2e5e3SStefan Hajnoczi     qemu_co_mutex_unlock(&s->lock);
124214ead646SFam Zheng 
12434bc74be9SPaolo Bonzini     switch (ret) {
12444bc74be9SPaolo Bonzini     case VMDK_ERROR:
12454bc74be9SPaolo Bonzini         ret = -EIO;
12464bc74be9SPaolo Bonzini         break;
12474bc74be9SPaolo Bonzini     case VMDK_UNALLOC:
12484bc74be9SPaolo Bonzini         ret = 0;
12494bc74be9SPaolo Bonzini         break;
12504bc74be9SPaolo Bonzini     case VMDK_ZEROED:
12514bc74be9SPaolo Bonzini         ret = BDRV_BLOCK_ZERO;
12524bc74be9SPaolo Bonzini         break;
12534bc74be9SPaolo Bonzini     case VMDK_OK:
12544bc74be9SPaolo Bonzini         ret = BDRV_BLOCK_DATA;
12553eba13ecSPeter Lieven         if (extent->file == bs->file && !extent->compressed) {
12564bc74be9SPaolo Bonzini             ret |= BDRV_BLOCK_OFFSET_VALID | offset;
12574bc74be9SPaolo Bonzini         }
12584bc74be9SPaolo Bonzini 
12594bc74be9SPaolo Bonzini         break;
12604bc74be9SPaolo Bonzini     }
126191b85bd3SFam Zheng 
1262b3976d3cSFam Zheng     index_in_cluster = sector_num % extent->cluster_sectors;
1263b3976d3cSFam Zheng     n = extent->cluster_sectors - index_in_cluster;
1264ae261c86SFam Zheng     if (n > nb_sectors) {
1265019d6b8fSAnthony Liguori         n = nb_sectors;
1266ae261c86SFam Zheng     }
1267019d6b8fSAnthony Liguori     *pnum = n;
1268b3976d3cSFam Zheng     return ret;
1269019d6b8fSAnthony Liguori }
1270019d6b8fSAnthony Liguori 
1271dd3f6ee2SFam Zheng static int vmdk_write_extent(VmdkExtent *extent, int64_t cluster_offset,
1272dd3f6ee2SFam Zheng                             int64_t offset_in_cluster, const uint8_t *buf,
1273dd3f6ee2SFam Zheng                             int nb_sectors, int64_t sector_num)
1274dd3f6ee2SFam Zheng {
1275dd3f6ee2SFam Zheng     int ret;
12762b2c8c5dSFam Zheng     VmdkGrainMarker *data = NULL;
12772b2c8c5dSFam Zheng     uLongf buf_len;
1278dd3f6ee2SFam Zheng     const uint8_t *write_buf = buf;
1279dd3f6ee2SFam Zheng     int write_len = nb_sectors * 512;
1280dd3f6ee2SFam Zheng 
12812b2c8c5dSFam Zheng     if (extent->compressed) {
12822b2c8c5dSFam Zheng         if (!extent->has_marker) {
12832b2c8c5dSFam Zheng             ret = -EINVAL;
12842b2c8c5dSFam Zheng             goto out;
12852b2c8c5dSFam Zheng         }
12862b2c8c5dSFam Zheng         buf_len = (extent->cluster_sectors << 9) * 2;
12872b2c8c5dSFam Zheng         data = g_malloc(buf_len + sizeof(VmdkGrainMarker));
12882b2c8c5dSFam Zheng         if (compress(data->data, &buf_len, buf, nb_sectors << 9) != Z_OK ||
12892b2c8c5dSFam Zheng                 buf_len == 0) {
12902b2c8c5dSFam Zheng             ret = -EINVAL;
12912b2c8c5dSFam Zheng             goto out;
12922b2c8c5dSFam Zheng         }
12932b2c8c5dSFam Zheng         data->lba = sector_num;
12942b2c8c5dSFam Zheng         data->size = buf_len;
12952b2c8c5dSFam Zheng         write_buf = (uint8_t *)data;
12962b2c8c5dSFam Zheng         write_len = buf_len + sizeof(VmdkGrainMarker);
12972b2c8c5dSFam Zheng     }
1298dd3f6ee2SFam Zheng     ret = bdrv_pwrite(extent->file,
1299dd3f6ee2SFam Zheng                         cluster_offset + offset_in_cluster,
1300dd3f6ee2SFam Zheng                         write_buf,
1301dd3f6ee2SFam Zheng                         write_len);
1302dd3f6ee2SFam Zheng     if (ret != write_len) {
1303dd3f6ee2SFam Zheng         ret = ret < 0 ? ret : -EIO;
1304dd3f6ee2SFam Zheng         goto out;
1305dd3f6ee2SFam Zheng     }
1306dd3f6ee2SFam Zheng     ret = 0;
1307dd3f6ee2SFam Zheng  out:
13082b2c8c5dSFam Zheng     g_free(data);
1309dd3f6ee2SFam Zheng     return ret;
1310dd3f6ee2SFam Zheng }
1311dd3f6ee2SFam Zheng 
1312dd3f6ee2SFam Zheng static int vmdk_read_extent(VmdkExtent *extent, int64_t cluster_offset,
1313dd3f6ee2SFam Zheng                             int64_t offset_in_cluster, uint8_t *buf,
1314dd3f6ee2SFam Zheng                             int nb_sectors)
1315dd3f6ee2SFam Zheng {
1316dd3f6ee2SFam Zheng     int ret;
13172b2c8c5dSFam Zheng     int cluster_bytes, buf_bytes;
13182b2c8c5dSFam Zheng     uint8_t *cluster_buf, *compressed_data;
13192b2c8c5dSFam Zheng     uint8_t *uncomp_buf;
13202b2c8c5dSFam Zheng     uint32_t data_len;
13212b2c8c5dSFam Zheng     VmdkGrainMarker *marker;
13222b2c8c5dSFam Zheng     uLongf buf_len;
1323dd3f6ee2SFam Zheng 
13242b2c8c5dSFam Zheng 
13252b2c8c5dSFam Zheng     if (!extent->compressed) {
1326dd3f6ee2SFam Zheng         ret = bdrv_pread(extent->file,
1327dd3f6ee2SFam Zheng                           cluster_offset + offset_in_cluster,
1328dd3f6ee2SFam Zheng                           buf, nb_sectors * 512);
1329dd3f6ee2SFam Zheng         if (ret == nb_sectors * 512) {
1330dd3f6ee2SFam Zheng             return 0;
1331dd3f6ee2SFam Zheng         } else {
1332dd3f6ee2SFam Zheng             return -EIO;
1333dd3f6ee2SFam Zheng         }
1334dd3f6ee2SFam Zheng     }
13352b2c8c5dSFam Zheng     cluster_bytes = extent->cluster_sectors * 512;
13362b2c8c5dSFam Zheng     /* Read two clusters in case GrainMarker + compressed data > one cluster */
13372b2c8c5dSFam Zheng     buf_bytes = cluster_bytes * 2;
13382b2c8c5dSFam Zheng     cluster_buf = g_malloc(buf_bytes);
13392b2c8c5dSFam Zheng     uncomp_buf = g_malloc(cluster_bytes);
13402b2c8c5dSFam Zheng     ret = bdrv_pread(extent->file,
13412b2c8c5dSFam Zheng                 cluster_offset,
13422b2c8c5dSFam Zheng                 cluster_buf, buf_bytes);
13432b2c8c5dSFam Zheng     if (ret < 0) {
13442b2c8c5dSFam Zheng         goto out;
13452b2c8c5dSFam Zheng     }
13462b2c8c5dSFam Zheng     compressed_data = cluster_buf;
13472b2c8c5dSFam Zheng     buf_len = cluster_bytes;
13482b2c8c5dSFam Zheng     data_len = cluster_bytes;
13492b2c8c5dSFam Zheng     if (extent->has_marker) {
13502b2c8c5dSFam Zheng         marker = (VmdkGrainMarker *)cluster_buf;
13512b2c8c5dSFam Zheng         compressed_data = marker->data;
13522b2c8c5dSFam Zheng         data_len = le32_to_cpu(marker->size);
13532b2c8c5dSFam Zheng     }
13542b2c8c5dSFam Zheng     if (!data_len || data_len > buf_bytes) {
13552b2c8c5dSFam Zheng         ret = -EINVAL;
13562b2c8c5dSFam Zheng         goto out;
13572b2c8c5dSFam Zheng     }
13582b2c8c5dSFam Zheng     ret = uncompress(uncomp_buf, &buf_len, compressed_data, data_len);
13592b2c8c5dSFam Zheng     if (ret != Z_OK) {
13602b2c8c5dSFam Zheng         ret = -EINVAL;
13612b2c8c5dSFam Zheng         goto out;
13622b2c8c5dSFam Zheng 
13632b2c8c5dSFam Zheng     }
13642b2c8c5dSFam Zheng     if (offset_in_cluster < 0 ||
13652b2c8c5dSFam Zheng             offset_in_cluster + nb_sectors * 512 > buf_len) {
13662b2c8c5dSFam Zheng         ret = -EINVAL;
13672b2c8c5dSFam Zheng         goto out;
13682b2c8c5dSFam Zheng     }
13692b2c8c5dSFam Zheng     memcpy(buf, uncomp_buf + offset_in_cluster, nb_sectors * 512);
13702b2c8c5dSFam Zheng     ret = 0;
13712b2c8c5dSFam Zheng 
13722b2c8c5dSFam Zheng  out:
13732b2c8c5dSFam Zheng     g_free(uncomp_buf);
13742b2c8c5dSFam Zheng     g_free(cluster_buf);
13752b2c8c5dSFam Zheng     return ret;
13762b2c8c5dSFam Zheng }
1377dd3f6ee2SFam Zheng 
1378019d6b8fSAnthony Liguori static int vmdk_read(BlockDriverState *bs, int64_t sector_num,
1379019d6b8fSAnthony Liguori                     uint8_t *buf, int nb_sectors)
1380019d6b8fSAnthony Liguori {
1381019d6b8fSAnthony Liguori     BDRVVmdkState *s = bs->opaque;
1382b3976d3cSFam Zheng     int ret;
1383b3976d3cSFam Zheng     uint64_t n, index_in_cluster;
1384b1649faeSGerhard Wiesinger     uint64_t extent_begin_sector, extent_relative_sector_num;
1385b3976d3cSFam Zheng     VmdkExtent *extent = NULL;
1386019d6b8fSAnthony Liguori     uint64_t cluster_offset;
1387019d6b8fSAnthony Liguori 
1388019d6b8fSAnthony Liguori     while (nb_sectors > 0) {
1389b3976d3cSFam Zheng         extent = find_extent(s, sector_num, extent);
1390b3976d3cSFam Zheng         if (!extent) {
1391b3976d3cSFam Zheng             return -EIO;
1392b3976d3cSFam Zheng         }
1393c6ac36e1SFam Zheng         ret = get_cluster_offset(bs, extent, NULL,
1394c6ac36e1SFam Zheng                                  sector_num << 9, false, &cluster_offset,
1395c6ac36e1SFam Zheng                                  0, 0);
1396b1649faeSGerhard Wiesinger         extent_begin_sector = extent->end_sector - extent->sectors;
1397b1649faeSGerhard Wiesinger         extent_relative_sector_num = sector_num - extent_begin_sector;
1398b1649faeSGerhard Wiesinger         index_in_cluster = extent_relative_sector_num % extent->cluster_sectors;
1399b3976d3cSFam Zheng         n = extent->cluster_sectors - index_in_cluster;
1400ae261c86SFam Zheng         if (n > nb_sectors) {
1401019d6b8fSAnthony Liguori             n = nb_sectors;
1402ae261c86SFam Zheng         }
140314ead646SFam Zheng         if (ret != VMDK_OK) {
140491b85bd3SFam Zheng             /* if not allocated, try to read from parent image, if exist */
140514ead646SFam Zheng             if (bs->backing_hd && ret != VMDK_ZEROED) {
1406ae261c86SFam Zheng                 if (!vmdk_is_cid_valid(bs)) {
14077fa60fa3SFam Zheng                     return -EINVAL;
1408ae261c86SFam Zheng                 }
1409b171271aSKevin Wolf                 ret = bdrv_read(bs->backing_hd, sector_num, buf, n);
1410ae261c86SFam Zheng                 if (ret < 0) {
14117fa60fa3SFam Zheng                     return ret;
1412ae261c86SFam Zheng                 }
1413019d6b8fSAnthony Liguori             } else {
1414019d6b8fSAnthony Liguori                 memset(buf, 0, 512 * n);
1415019d6b8fSAnthony Liguori             }
1416019d6b8fSAnthony Liguori         } else {
1417dd3f6ee2SFam Zheng             ret = vmdk_read_extent(extent,
1418dd3f6ee2SFam Zheng                             cluster_offset, index_in_cluster * 512,
1419dd3f6ee2SFam Zheng                             buf, n);
1420dd3f6ee2SFam Zheng             if (ret) {
14217fa60fa3SFam Zheng                 return ret;
14227fa60fa3SFam Zheng             }
1423019d6b8fSAnthony Liguori         }
1424019d6b8fSAnthony Liguori         nb_sectors -= n;
1425019d6b8fSAnthony Liguori         sector_num += n;
1426019d6b8fSAnthony Liguori         buf += n * 512;
1427019d6b8fSAnthony Liguori     }
1428019d6b8fSAnthony Liguori     return 0;
1429019d6b8fSAnthony Liguori }
1430019d6b8fSAnthony Liguori 
14312914caa0SPaolo Bonzini static coroutine_fn int vmdk_co_read(BlockDriverState *bs, int64_t sector_num,
14322914caa0SPaolo Bonzini                                      uint8_t *buf, int nb_sectors)
14332914caa0SPaolo Bonzini {
14342914caa0SPaolo Bonzini     int ret;
14352914caa0SPaolo Bonzini     BDRVVmdkState *s = bs->opaque;
14362914caa0SPaolo Bonzini     qemu_co_mutex_lock(&s->lock);
14372914caa0SPaolo Bonzini     ret = vmdk_read(bs, sector_num, buf, nb_sectors);
14382914caa0SPaolo Bonzini     qemu_co_mutex_unlock(&s->lock);
14392914caa0SPaolo Bonzini     return ret;
14402914caa0SPaolo Bonzini }
14412914caa0SPaolo Bonzini 
1442cdeaf1f1SFam Zheng /**
1443cdeaf1f1SFam Zheng  * vmdk_write:
1444cdeaf1f1SFam Zheng  * @zeroed:       buf is ignored (data is zero), use zeroed_grain GTE feature
1445cdeaf1f1SFam Zheng  *                if possible, otherwise return -ENOTSUP.
14468e507243SFam Zheng  * @zero_dry_run: used for zeroed == true only, don't update L2 table, just try
14478e507243SFam Zheng  *                with each cluster. By dry run we can find if the zero write
14488e507243SFam Zheng  *                is possible without modifying image data.
1449cdeaf1f1SFam Zheng  *
1450cdeaf1f1SFam Zheng  * Returns: error code with 0 for success.
1451cdeaf1f1SFam Zheng  */
1452019d6b8fSAnthony Liguori static int vmdk_write(BlockDriverState *bs, int64_t sector_num,
1453cdeaf1f1SFam Zheng                       const uint8_t *buf, int nb_sectors,
1454cdeaf1f1SFam Zheng                       bool zeroed, bool zero_dry_run)
1455019d6b8fSAnthony Liguori {
1456019d6b8fSAnthony Liguori     BDRVVmdkState *s = bs->opaque;
1457b3976d3cSFam Zheng     VmdkExtent *extent = NULL;
1458585ea0c8SFam Zheng     int ret;
1459585ea0c8SFam Zheng     int64_t index_in_cluster, n;
1460b1649faeSGerhard Wiesinger     uint64_t extent_begin_sector, extent_relative_sector_num;
1461019d6b8fSAnthony Liguori     uint64_t cluster_offset;
1462b3976d3cSFam Zheng     VmdkMetaData m_data;
1463019d6b8fSAnthony Liguori 
1464019d6b8fSAnthony Liguori     if (sector_num > bs->total_sectors) {
14654823970bSFam Zheng         error_report("Wrong offset: sector_num=0x%" PRIx64
1466019d6b8fSAnthony Liguori                 " total_sectors=0x%" PRIx64 "\n",
1467019d6b8fSAnthony Liguori                 sector_num, bs->total_sectors);
14687fa60fa3SFam Zheng         return -EIO;
1469019d6b8fSAnthony Liguori     }
1470019d6b8fSAnthony Liguori 
1471019d6b8fSAnthony Liguori     while (nb_sectors > 0) {
1472b3976d3cSFam Zheng         extent = find_extent(s, sector_num, extent);
1473b3976d3cSFam Zheng         if (!extent) {
1474b3976d3cSFam Zheng             return -EIO;
1475b3976d3cSFam Zheng         }
1476c6ac36e1SFam Zheng         extent_begin_sector = extent->end_sector - extent->sectors;
1477c6ac36e1SFam Zheng         extent_relative_sector_num = sector_num - extent_begin_sector;
1478c6ac36e1SFam Zheng         index_in_cluster = extent_relative_sector_num % extent->cluster_sectors;
1479c6ac36e1SFam Zheng         n = extent->cluster_sectors - index_in_cluster;
1480c6ac36e1SFam Zheng         if (n > nb_sectors) {
1481c6ac36e1SFam Zheng             n = nb_sectors;
1482c6ac36e1SFam Zheng         }
1483c6ac36e1SFam Zheng         ret = get_cluster_offset(bs, extent, &m_data, sector_num << 9,
1484c6ac36e1SFam Zheng                                  !(extent->compressed || zeroed),
1485c6ac36e1SFam Zheng                                  &cluster_offset,
1486c6ac36e1SFam Zheng                                  index_in_cluster, index_in_cluster + n);
14872b2c8c5dSFam Zheng         if (extent->compressed) {
148865f74725SFam Zheng             if (ret == VMDK_OK) {
14892b2c8c5dSFam Zheng                 /* Refuse write to allocated cluster for streamOptimized */
14904823970bSFam Zheng                 error_report("Could not write to allocated cluster"
14914823970bSFam Zheng                               " for streamOptimized");
14922b2c8c5dSFam Zheng                 return -EIO;
14932b2c8c5dSFam Zheng             } else {
14942b2c8c5dSFam Zheng                 /* allocate */
1495c6ac36e1SFam Zheng                 ret = get_cluster_offset(bs, extent, &m_data, sector_num << 9,
1496c6ac36e1SFam Zheng                                          true, &cluster_offset, 0, 0);
14972b2c8c5dSFam Zheng             }
14982b2c8c5dSFam Zheng         }
1499cdeaf1f1SFam Zheng         if (ret == VMDK_ERROR) {
150091b85bd3SFam Zheng             return -EINVAL;
1501b3976d3cSFam Zheng         }
1502cdeaf1f1SFam Zheng         if (zeroed) {
1503cdeaf1f1SFam Zheng             /* Do zeroed write, buf is ignored */
1504cdeaf1f1SFam Zheng             if (extent->has_zero_grain &&
1505cdeaf1f1SFam Zheng                     index_in_cluster == 0 &&
1506cdeaf1f1SFam Zheng                     n >= extent->cluster_sectors) {
1507cdeaf1f1SFam Zheng                 n = extent->cluster_sectors;
1508cdeaf1f1SFam Zheng                 if (!zero_dry_run) {
1509cdeaf1f1SFam Zheng                     /* update L2 tables */
1510c6ac36e1SFam Zheng                     if (vmdk_L2update(extent, &m_data, VMDK_GTE_ZEROED)
1511c6ac36e1SFam Zheng                             != VMDK_OK) {
1512cdeaf1f1SFam Zheng                         return -EIO;
1513cdeaf1f1SFam Zheng                     }
1514cdeaf1f1SFam Zheng                 }
1515cdeaf1f1SFam Zheng             } else {
1516cdeaf1f1SFam Zheng                 return -ENOTSUP;
1517cdeaf1f1SFam Zheng             }
1518cdeaf1f1SFam Zheng         } else {
1519dd3f6ee2SFam Zheng             ret = vmdk_write_extent(extent,
1520dd3f6ee2SFam Zheng                             cluster_offset, index_in_cluster * 512,
1521dd3f6ee2SFam Zheng                             buf, n, sector_num);
1522dd3f6ee2SFam Zheng             if (ret) {
15237fa60fa3SFam Zheng                 return ret;
1524b3976d3cSFam Zheng             }
1525019d6b8fSAnthony Liguori             if (m_data.valid) {
1526019d6b8fSAnthony Liguori                 /* update L2 tables */
1527c6ac36e1SFam Zheng                 if (vmdk_L2update(extent, &m_data,
1528c6ac36e1SFam Zheng                                   cluster_offset >> BDRV_SECTOR_BITS)
1529c6ac36e1SFam Zheng                         != VMDK_OK) {
15307fa60fa3SFam Zheng                     return -EIO;
1531019d6b8fSAnthony Liguori                 }
1532b3976d3cSFam Zheng             }
1533cdeaf1f1SFam Zheng         }
1534019d6b8fSAnthony Liguori         nb_sectors -= n;
1535019d6b8fSAnthony Liguori         sector_num += n;
1536019d6b8fSAnthony Liguori         buf += n * 512;
1537019d6b8fSAnthony Liguori 
1538ae261c86SFam Zheng         /* update CID on the first write every time the virtual disk is
1539ae261c86SFam Zheng          * opened */
154069b4d86dSFam Zheng         if (!s->cid_updated) {
154199f1835dSKevin Wolf             ret = vmdk_write_cid(bs, time(NULL));
154299f1835dSKevin Wolf             if (ret < 0) {
154399f1835dSKevin Wolf                 return ret;
154499f1835dSKevin Wolf             }
154569b4d86dSFam Zheng             s->cid_updated = true;
1546019d6b8fSAnthony Liguori         }
1547019d6b8fSAnthony Liguori     }
1548019d6b8fSAnthony Liguori     return 0;
1549019d6b8fSAnthony Liguori }
1550019d6b8fSAnthony Liguori 
1551e183ef75SPaolo Bonzini static coroutine_fn int vmdk_co_write(BlockDriverState *bs, int64_t sector_num,
1552e183ef75SPaolo Bonzini                                       const uint8_t *buf, int nb_sectors)
1553e183ef75SPaolo Bonzini {
1554e183ef75SPaolo Bonzini     int ret;
1555e183ef75SPaolo Bonzini     BDRVVmdkState *s = bs->opaque;
1556e183ef75SPaolo Bonzini     qemu_co_mutex_lock(&s->lock);
1557cdeaf1f1SFam Zheng     ret = vmdk_write(bs, sector_num, buf, nb_sectors, false, false);
1558cdeaf1f1SFam Zheng     qemu_co_mutex_unlock(&s->lock);
1559cdeaf1f1SFam Zheng     return ret;
1560cdeaf1f1SFam Zheng }
1561cdeaf1f1SFam Zheng 
1562ba0ad89eSFam Zheng static int vmdk_write_compressed(BlockDriverState *bs,
1563ba0ad89eSFam Zheng                                  int64_t sector_num,
1564ba0ad89eSFam Zheng                                  const uint8_t *buf,
1565ba0ad89eSFam Zheng                                  int nb_sectors)
1566ba0ad89eSFam Zheng {
1567ba0ad89eSFam Zheng     BDRVVmdkState *s = bs->opaque;
1568ba0ad89eSFam Zheng     if (s->num_extents == 1 && s->extents[0].compressed) {
1569ba0ad89eSFam Zheng         return vmdk_write(bs, sector_num, buf, nb_sectors, false, false);
1570ba0ad89eSFam Zheng     } else {
1571ba0ad89eSFam Zheng         return -ENOTSUP;
1572ba0ad89eSFam Zheng     }
1573ba0ad89eSFam Zheng }
1574ba0ad89eSFam Zheng 
1575cdeaf1f1SFam Zheng static int coroutine_fn vmdk_co_write_zeroes(BlockDriverState *bs,
1576cdeaf1f1SFam Zheng                                              int64_t sector_num,
1577aa7bfbffSPeter Lieven                                              int nb_sectors,
1578aa7bfbffSPeter Lieven                                              BdrvRequestFlags flags)
1579cdeaf1f1SFam Zheng {
1580cdeaf1f1SFam Zheng     int ret;
1581cdeaf1f1SFam Zheng     BDRVVmdkState *s = bs->opaque;
1582cdeaf1f1SFam Zheng     qemu_co_mutex_lock(&s->lock);
15838e507243SFam Zheng     /* write zeroes could fail if sectors not aligned to cluster, test it with
15848e507243SFam Zheng      * dry_run == true before really updating image */
1585cdeaf1f1SFam Zheng     ret = vmdk_write(bs, sector_num, NULL, nb_sectors, true, true);
1586cdeaf1f1SFam Zheng     if (!ret) {
1587cdeaf1f1SFam Zheng         ret = vmdk_write(bs, sector_num, NULL, nb_sectors, true, false);
1588cdeaf1f1SFam Zheng     }
1589e183ef75SPaolo Bonzini     qemu_co_mutex_unlock(&s->lock);
1590e183ef75SPaolo Bonzini     return ret;
1591e183ef75SPaolo Bonzini }
1592e183ef75SPaolo Bonzini 
15936c031aacSFam Zheng static int vmdk_create_extent(const char *filename, int64_t filesize,
1594917703c1SFam Zheng                               bool flat, bool compress, bool zeroed_grain,
15954ab15590SChunyan Liu                               QemuOpts *opts, Error **errp)
1596019d6b8fSAnthony Liguori {
1597f66fd6c3SFam Zheng     int ret, i;
1598917703c1SFam Zheng     BlockDriverState *bs = NULL;
1599019d6b8fSAnthony Liguori     VMDK4Header header;
1600c13959c7SFam Zheng     Error *local_err = NULL;
1601917703c1SFam Zheng     uint32_t tmp, magic, grains, gd_sectors, gt_size, gt_count;
1602917703c1SFam Zheng     uint32_t *gd_buf = NULL;
1603917703c1SFam Zheng     int gd_buf_size;
16040e7e1989SKevin Wolf 
16054ab15590SChunyan Liu     ret = bdrv_create_file(filename, opts, &local_err);
1606f66fd6c3SFam Zheng     if (ret < 0) {
1607917703c1SFam Zheng         error_propagate(errp, local_err);
1608917703c1SFam Zheng         goto exit;
1609917703c1SFam Zheng     }
1610917703c1SFam Zheng 
16112e40134bSMax Reitz     assert(bs == NULL);
16122e40134bSMax Reitz     ret = bdrv_open(&bs, filename, NULL, NULL, BDRV_O_RDWR | BDRV_O_PROTOCOL,
16132e40134bSMax Reitz                     NULL, &local_err);
1614917703c1SFam Zheng     if (ret < 0) {
1615917703c1SFam Zheng         error_propagate(errp, local_err);
1616917703c1SFam Zheng         goto exit;
1617917703c1SFam Zheng     }
1618917703c1SFam Zheng 
1619917703c1SFam Zheng     if (flat) {
1620917703c1SFam Zheng         ret = bdrv_truncate(bs, filesize);
1621917703c1SFam Zheng         if (ret < 0) {
162239a611a3SJeff Cody             error_setg_errno(errp, -ret, "Could not truncate file");
1623f66fd6c3SFam Zheng         }
1624f66fd6c3SFam Zheng         goto exit;
1625f66fd6c3SFam Zheng     }
1626019d6b8fSAnthony Liguori     magic = cpu_to_be32(VMDK4_MAGIC);
1627019d6b8fSAnthony Liguori     memset(&header, 0, sizeof(header));
162869e0b6dfSFam Zheng     header.version = zeroed_grain ? 2 : 1;
162995b0aa42SFam Zheng     header.flags = VMDK4_FLAG_RGD | VMDK4_FLAG_NL_DETECT
163069e0b6dfSFam Zheng                    | (compress ? VMDK4_FLAG_COMPRESS | VMDK4_FLAG_MARKER : 0)
163169e0b6dfSFam Zheng                    | (zeroed_grain ? VMDK4_FLAG_ZERO_GRAIN : 0);
16326c031aacSFam Zheng     header.compressAlgorithm = compress ? VMDK4_COMPRESSION_DEFLATE : 0;
1633917703c1SFam Zheng     header.capacity = filesize / BDRV_SECTOR_SIZE;
163416372ff0SAlexander Graf     header.granularity = 128;
1635917703c1SFam Zheng     header.num_gtes_per_gt = BDRV_SECTOR_SIZE;
1636019d6b8fSAnthony Liguori 
1637917703c1SFam Zheng     grains = DIV_ROUND_UP(filesize / BDRV_SECTOR_SIZE, header.granularity);
1638917703c1SFam Zheng     gt_size = DIV_ROUND_UP(header.num_gtes_per_gt * sizeof(uint32_t),
1639917703c1SFam Zheng                            BDRV_SECTOR_SIZE);
1640917703c1SFam Zheng     gt_count = DIV_ROUND_UP(grains, header.num_gtes_per_gt);
1641917703c1SFam Zheng     gd_sectors = DIV_ROUND_UP(gt_count * sizeof(uint32_t), BDRV_SECTOR_SIZE);
1642019d6b8fSAnthony Liguori 
1643019d6b8fSAnthony Liguori     header.desc_offset = 1;
1644019d6b8fSAnthony Liguori     header.desc_size = 20;
1645019d6b8fSAnthony Liguori     header.rgd_offset = header.desc_offset + header.desc_size;
1646917703c1SFam Zheng     header.gd_offset = header.rgd_offset + gd_sectors + (gt_size * gt_count);
1647019d6b8fSAnthony Liguori     header.grain_offset =
1648917703c1SFam Zheng         ROUND_UP(header.gd_offset + gd_sectors + (gt_size * gt_count),
1649917703c1SFam Zheng                  header.granularity);
165016372ff0SAlexander Graf     /* swap endianness for all header fields */
165116372ff0SAlexander Graf     header.version = cpu_to_le32(header.version);
165216372ff0SAlexander Graf     header.flags = cpu_to_le32(header.flags);
165316372ff0SAlexander Graf     header.capacity = cpu_to_le64(header.capacity);
165416372ff0SAlexander Graf     header.granularity = cpu_to_le64(header.granularity);
1655ca8804ceSFam Zheng     header.num_gtes_per_gt = cpu_to_le32(header.num_gtes_per_gt);
1656019d6b8fSAnthony Liguori     header.desc_offset = cpu_to_le64(header.desc_offset);
1657019d6b8fSAnthony Liguori     header.desc_size = cpu_to_le64(header.desc_size);
1658019d6b8fSAnthony Liguori     header.rgd_offset = cpu_to_le64(header.rgd_offset);
1659019d6b8fSAnthony Liguori     header.gd_offset = cpu_to_le64(header.gd_offset);
1660019d6b8fSAnthony Liguori     header.grain_offset = cpu_to_le64(header.grain_offset);
16616c031aacSFam Zheng     header.compressAlgorithm = cpu_to_le16(header.compressAlgorithm);
1662019d6b8fSAnthony Liguori 
1663019d6b8fSAnthony Liguori     header.check_bytes[0] = 0xa;
1664019d6b8fSAnthony Liguori     header.check_bytes[1] = 0x20;
1665019d6b8fSAnthony Liguori     header.check_bytes[2] = 0xd;
1666019d6b8fSAnthony Liguori     header.check_bytes[3] = 0xa;
1667019d6b8fSAnthony Liguori 
1668019d6b8fSAnthony Liguori     /* write all the data */
1669917703c1SFam Zheng     ret = bdrv_pwrite(bs, 0, &magic, sizeof(magic));
1670917703c1SFam Zheng     if (ret < 0) {
1671917703c1SFam Zheng         error_set(errp, QERR_IO_ERROR);
16721640366cSKirill A. Shutemov         goto exit;
16731640366cSKirill A. Shutemov     }
1674917703c1SFam Zheng     ret = bdrv_pwrite(bs, sizeof(magic), &header, sizeof(header));
1675917703c1SFam Zheng     if (ret < 0) {
1676917703c1SFam Zheng         error_set(errp, QERR_IO_ERROR);
16771640366cSKirill A. Shutemov         goto exit;
16781640366cSKirill A. Shutemov     }
1679019d6b8fSAnthony Liguori 
1680917703c1SFam Zheng     ret = bdrv_truncate(bs, le64_to_cpu(header.grain_offset) << 9);
16811640366cSKirill A. Shutemov     if (ret < 0) {
168239a611a3SJeff Cody         error_setg_errno(errp, -ret, "Could not truncate file");
16831640366cSKirill A. Shutemov         goto exit;
16841640366cSKirill A. Shutemov     }
1685019d6b8fSAnthony Liguori 
1686019d6b8fSAnthony Liguori     /* write grain directory */
1687917703c1SFam Zheng     gd_buf_size = gd_sectors * BDRV_SECTOR_SIZE;
1688917703c1SFam Zheng     gd_buf = g_malloc0(gd_buf_size);
1689917703c1SFam Zheng     for (i = 0, tmp = le64_to_cpu(header.rgd_offset) + gd_sectors;
16901640366cSKirill A. Shutemov          i < gt_count; i++, tmp += gt_size) {
1691917703c1SFam Zheng         gd_buf[i] = cpu_to_le32(tmp);
16921640366cSKirill A. Shutemov     }
1693917703c1SFam Zheng     ret = bdrv_pwrite(bs, le64_to_cpu(header.rgd_offset) * BDRV_SECTOR_SIZE,
1694917703c1SFam Zheng                       gd_buf, gd_buf_size);
1695917703c1SFam Zheng     if (ret < 0) {
1696917703c1SFam Zheng         error_set(errp, QERR_IO_ERROR);
1697917703c1SFam Zheng         goto exit;
16981640366cSKirill A. Shutemov     }
1699019d6b8fSAnthony Liguori 
1700019d6b8fSAnthony Liguori     /* write backup grain directory */
1701917703c1SFam Zheng     for (i = 0, tmp = le64_to_cpu(header.gd_offset) + gd_sectors;
17021640366cSKirill A. Shutemov          i < gt_count; i++, tmp += gt_size) {
1703917703c1SFam Zheng         gd_buf[i] = cpu_to_le32(tmp);
17041640366cSKirill A. Shutemov     }
1705917703c1SFam Zheng     ret = bdrv_pwrite(bs, le64_to_cpu(header.gd_offset) * BDRV_SECTOR_SIZE,
1706917703c1SFam Zheng                       gd_buf, gd_buf_size);
1707917703c1SFam Zheng     if (ret < 0) {
1708917703c1SFam Zheng         error_set(errp, QERR_IO_ERROR);
1709917703c1SFam Zheng         goto exit;
17101640366cSKirill A. Shutemov     }
1711019d6b8fSAnthony Liguori 
1712f66fd6c3SFam Zheng     ret = 0;
1713f66fd6c3SFam Zheng exit:
1714917703c1SFam Zheng     if (bs) {
1715917703c1SFam Zheng         bdrv_unref(bs);
1716917703c1SFam Zheng     }
1717917703c1SFam Zheng     g_free(gd_buf);
1718f66fd6c3SFam Zheng     return ret;
1719f66fd6c3SFam Zheng }
1720019d6b8fSAnthony Liguori 
1721f66fd6c3SFam Zheng static int filename_decompose(const char *filename, char *path, char *prefix,
17224823970bSFam Zheng                               char *postfix, size_t buf_len, Error **errp)
1723f66fd6c3SFam Zheng {
1724f66fd6c3SFam Zheng     const char *p, *q;
1725f66fd6c3SFam Zheng 
1726f66fd6c3SFam Zheng     if (filename == NULL || !strlen(filename)) {
17274823970bSFam Zheng         error_setg(errp, "No filename provided");
172865f74725SFam Zheng         return VMDK_ERROR;
1729f66fd6c3SFam Zheng     }
1730f66fd6c3SFam Zheng     p = strrchr(filename, '/');
1731f66fd6c3SFam Zheng     if (p == NULL) {
1732f66fd6c3SFam Zheng         p = strrchr(filename, '\\');
1733f66fd6c3SFam Zheng     }
1734f66fd6c3SFam Zheng     if (p == NULL) {
1735f66fd6c3SFam Zheng         p = strrchr(filename, ':');
1736f66fd6c3SFam Zheng     }
1737f66fd6c3SFam Zheng     if (p != NULL) {
1738f66fd6c3SFam Zheng         p++;
1739f66fd6c3SFam Zheng         if (p - filename >= buf_len) {
174065f74725SFam Zheng             return VMDK_ERROR;
1741f66fd6c3SFam Zheng         }
1742f66fd6c3SFam Zheng         pstrcpy(path, p - filename + 1, filename);
1743f66fd6c3SFam Zheng     } else {
1744f66fd6c3SFam Zheng         p = filename;
1745f66fd6c3SFam Zheng         path[0] = '\0';
1746f66fd6c3SFam Zheng     }
1747f66fd6c3SFam Zheng     q = strrchr(p, '.');
1748f66fd6c3SFam Zheng     if (q == NULL) {
1749f66fd6c3SFam Zheng         pstrcpy(prefix, buf_len, p);
1750f66fd6c3SFam Zheng         postfix[0] = '\0';
1751f66fd6c3SFam Zheng     } else {
1752f66fd6c3SFam Zheng         if (q - p >= buf_len) {
175365f74725SFam Zheng             return VMDK_ERROR;
1754f66fd6c3SFam Zheng         }
1755f66fd6c3SFam Zheng         pstrcpy(prefix, q - p + 1, p);
1756f66fd6c3SFam Zheng         pstrcpy(postfix, buf_len, q);
1757f66fd6c3SFam Zheng     }
175865f74725SFam Zheng     return VMDK_OK;
1759f66fd6c3SFam Zheng }
1760f66fd6c3SFam Zheng 
17615820f1daSChunyan Liu static int vmdk_create(const char *filename, QemuOpts *opts, Error **errp)
1762f66fd6c3SFam Zheng {
1763917703c1SFam Zheng     int idx = 0;
1764917703c1SFam Zheng     BlockDriverState *new_bs = NULL;
1765c13959c7SFam Zheng     Error *local_err = NULL;
1766af057fe7SFam Zheng     char *desc = NULL;
1767f66fd6c3SFam Zheng     int64_t total_size = 0, filesize;
17685820f1daSChunyan Liu     char *adapter_type = NULL;
17695820f1daSChunyan Liu     char *backing_file = NULL;
17705820f1daSChunyan Liu     char *fmt = NULL;
1771f66fd6c3SFam Zheng     int flags = 0;
1772f66fd6c3SFam Zheng     int ret = 0;
17736c031aacSFam Zheng     bool flat, split, compress;
1774af057fe7SFam Zheng     GString *ext_desc_lines;
1775f66fd6c3SFam Zheng     char path[PATH_MAX], prefix[PATH_MAX], postfix[PATH_MAX];
1776f66fd6c3SFam Zheng     const int64_t split_size = 0x80000000;  /* VMDK has constant split size */
1777f66fd6c3SFam Zheng     const char *desc_extent_line;
1778f66fd6c3SFam Zheng     char parent_desc_line[BUF_SIZE] = "";
1779f66fd6c3SFam Zheng     uint32_t parent_cid = 0xffffffff;
17807f2039f6SOthmar Pasteka     uint32_t number_heads = 16;
178169e0b6dfSFam Zheng     bool zeroed_grain = false;
1782917703c1SFam Zheng     uint32_t desc_offset = 0, desc_len;
1783f66fd6c3SFam Zheng     const char desc_template[] =
1784f66fd6c3SFam Zheng         "# Disk DescriptorFile\n"
1785f66fd6c3SFam Zheng         "version=1\n"
17869b17031aSFam Zheng         "CID=%" PRIx32 "\n"
17879b17031aSFam Zheng         "parentCID=%" PRIx32 "\n"
1788f66fd6c3SFam Zheng         "createType=\"%s\"\n"
1789f66fd6c3SFam Zheng         "%s"
1790f66fd6c3SFam Zheng         "\n"
1791f66fd6c3SFam Zheng         "# Extent description\n"
1792f66fd6c3SFam Zheng         "%s"
1793f66fd6c3SFam Zheng         "\n"
1794f66fd6c3SFam Zheng         "# The Disk Data Base\n"
1795f66fd6c3SFam Zheng         "#DDB\n"
1796f66fd6c3SFam Zheng         "\n"
1797f66fd6c3SFam Zheng         "ddb.virtualHWVersion = \"%d\"\n"
1798f66fd6c3SFam Zheng         "ddb.geometry.cylinders = \"%" PRId64 "\"\n"
17994ab9dab5SFam Zheng         "ddb.geometry.heads = \"%" PRIu32 "\"\n"
1800f66fd6c3SFam Zheng         "ddb.geometry.sectors = \"63\"\n"
18017f2039f6SOthmar Pasteka         "ddb.adapterType = \"%s\"\n";
1802f66fd6c3SFam Zheng 
1803af057fe7SFam Zheng     ext_desc_lines = g_string_new(NULL);
1804af057fe7SFam Zheng 
18054823970bSFam Zheng     if (filename_decompose(filename, path, prefix, postfix, PATH_MAX, errp)) {
1806af057fe7SFam Zheng         ret = -EINVAL;
1807af057fe7SFam Zheng         goto exit;
1808f66fd6c3SFam Zheng     }
1809f66fd6c3SFam Zheng     /* Read out options */
18105820f1daSChunyan Liu     total_size = qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0);
18115820f1daSChunyan Liu     adapter_type = qemu_opt_get_del(opts, BLOCK_OPT_ADAPTER_TYPE);
18125820f1daSChunyan Liu     backing_file = qemu_opt_get_del(opts, BLOCK_OPT_BACKING_FILE);
18135820f1daSChunyan Liu     if (qemu_opt_get_bool_del(opts, BLOCK_OPT_COMPAT6, false)) {
18145820f1daSChunyan Liu         flags |= BLOCK_FLAG_COMPAT6;
1815f66fd6c3SFam Zheng     }
18165820f1daSChunyan Liu     fmt = qemu_opt_get_del(opts, BLOCK_OPT_SUBFMT);
18175820f1daSChunyan Liu     if (qemu_opt_get_bool_del(opts, BLOCK_OPT_ZEROED_GRAIN, false)) {
18185820f1daSChunyan Liu         zeroed_grain = true;
1819f66fd6c3SFam Zheng     }
18205820f1daSChunyan Liu 
18217f2039f6SOthmar Pasteka     if (!adapter_type) {
18225820f1daSChunyan Liu         adapter_type = g_strdup("ide");
18237f2039f6SOthmar Pasteka     } else if (strcmp(adapter_type, "ide") &&
18247f2039f6SOthmar Pasteka                strcmp(adapter_type, "buslogic") &&
18257f2039f6SOthmar Pasteka                strcmp(adapter_type, "lsilogic") &&
18267f2039f6SOthmar Pasteka                strcmp(adapter_type, "legacyESX")) {
18274823970bSFam Zheng         error_setg(errp, "Unknown adapter type: '%s'", adapter_type);
1828af057fe7SFam Zheng         ret = -EINVAL;
1829af057fe7SFam Zheng         goto exit;
18307f2039f6SOthmar Pasteka     }
18317f2039f6SOthmar Pasteka     if (strcmp(adapter_type, "ide") != 0) {
18327f2039f6SOthmar Pasteka         /* that's the number of heads with which vmware operates when
18337f2039f6SOthmar Pasteka            creating, exporting, etc. vmdk files with a non-ide adapter type */
18347f2039f6SOthmar Pasteka         number_heads = 255;
18357f2039f6SOthmar Pasteka     }
1836f66fd6c3SFam Zheng     if (!fmt) {
1837f66fd6c3SFam Zheng         /* Default format to monolithicSparse */
18385820f1daSChunyan Liu         fmt = g_strdup("monolithicSparse");
1839f66fd6c3SFam Zheng     } else if (strcmp(fmt, "monolithicFlat") &&
1840f66fd6c3SFam Zheng                strcmp(fmt, "monolithicSparse") &&
1841f66fd6c3SFam Zheng                strcmp(fmt, "twoGbMaxExtentSparse") &&
18426c031aacSFam Zheng                strcmp(fmt, "twoGbMaxExtentFlat") &&
18436c031aacSFam Zheng                strcmp(fmt, "streamOptimized")) {
18444823970bSFam Zheng         error_setg(errp, "Unknown subformat: '%s'", fmt);
1845af057fe7SFam Zheng         ret = -EINVAL;
1846af057fe7SFam Zheng         goto exit;
1847f66fd6c3SFam Zheng     }
1848f66fd6c3SFam Zheng     split = !(strcmp(fmt, "twoGbMaxExtentFlat") &&
1849f66fd6c3SFam Zheng               strcmp(fmt, "twoGbMaxExtentSparse"));
1850f66fd6c3SFam Zheng     flat = !(strcmp(fmt, "monolithicFlat") &&
1851f66fd6c3SFam Zheng              strcmp(fmt, "twoGbMaxExtentFlat"));
18526c031aacSFam Zheng     compress = !strcmp(fmt, "streamOptimized");
1853f66fd6c3SFam Zheng     if (flat) {
18544ab9dab5SFam Zheng         desc_extent_line = "RW %" PRId64 " FLAT \"%s\" 0\n";
1855f66fd6c3SFam Zheng     } else {
18564ab9dab5SFam Zheng         desc_extent_line = "RW %" PRId64 " SPARSE \"%s\"\n";
1857f66fd6c3SFam Zheng     }
1858f66fd6c3SFam Zheng     if (flat && backing_file) {
18594823970bSFam Zheng         error_setg(errp, "Flat image can't have backing file");
1860af057fe7SFam Zheng         ret = -ENOTSUP;
1861af057fe7SFam Zheng         goto exit;
1862f66fd6c3SFam Zheng     }
186352c8d629SFam Zheng     if (flat && zeroed_grain) {
186452c8d629SFam Zheng         error_setg(errp, "Flat image can't enable zeroed grain");
1865af057fe7SFam Zheng         ret = -ENOTSUP;
1866af057fe7SFam Zheng         goto exit;
186752c8d629SFam Zheng     }
1868f66fd6c3SFam Zheng     if (backing_file) {
1869f67503e5SMax Reitz         BlockDriverState *bs = NULL;
1870ddf5636dSMax Reitz         ret = bdrv_open(&bs, backing_file, NULL, NULL, BDRV_O_NO_BACKING, NULL,
1871ddf5636dSMax Reitz                         errp);
1872f66fd6c3SFam Zheng         if (ret != 0) {
1873af057fe7SFam Zheng             goto exit;
1874f66fd6c3SFam Zheng         }
1875f66fd6c3SFam Zheng         if (strcmp(bs->drv->format_name, "vmdk")) {
18764f6fd349SFam Zheng             bdrv_unref(bs);
1877af057fe7SFam Zheng             ret = -EINVAL;
1878af057fe7SFam Zheng             goto exit;
1879f66fd6c3SFam Zheng         }
1880f66fd6c3SFam Zheng         parent_cid = vmdk_read_cid(bs, 0);
18814f6fd349SFam Zheng         bdrv_unref(bs);
1882f66fd6c3SFam Zheng         snprintf(parent_desc_line, sizeof(parent_desc_line),
18838ed610a1SFam Zheng                 "parentFileNameHint=\"%s\"", backing_file);
1884f66fd6c3SFam Zheng     }
1885f66fd6c3SFam Zheng 
1886f66fd6c3SFam Zheng     /* Create extents */
1887f66fd6c3SFam Zheng     filesize = total_size;
1888f66fd6c3SFam Zheng     while (filesize > 0) {
1889f66fd6c3SFam Zheng         char desc_line[BUF_SIZE];
1890f66fd6c3SFam Zheng         char ext_filename[PATH_MAX];
1891f66fd6c3SFam Zheng         char desc_filename[PATH_MAX];
1892f66fd6c3SFam Zheng         int64_t size = filesize;
1893f66fd6c3SFam Zheng 
1894f66fd6c3SFam Zheng         if (split && size > split_size) {
1895f66fd6c3SFam Zheng             size = split_size;
1896f66fd6c3SFam Zheng         }
1897f66fd6c3SFam Zheng         if (split) {
1898f66fd6c3SFam Zheng             snprintf(desc_filename, sizeof(desc_filename), "%s-%c%03d%s",
1899f66fd6c3SFam Zheng                     prefix, flat ? 'f' : 's', ++idx, postfix);
1900f66fd6c3SFam Zheng         } else if (flat) {
1901f66fd6c3SFam Zheng             snprintf(desc_filename, sizeof(desc_filename), "%s-flat%s",
1902f66fd6c3SFam Zheng                     prefix, postfix);
1903f66fd6c3SFam Zheng         } else {
1904f66fd6c3SFam Zheng             snprintf(desc_filename, sizeof(desc_filename), "%s%s",
1905f66fd6c3SFam Zheng                     prefix, postfix);
1906f66fd6c3SFam Zheng         }
1907f66fd6c3SFam Zheng         snprintf(ext_filename, sizeof(ext_filename), "%s%s",
1908f66fd6c3SFam Zheng                 path, desc_filename);
1909f66fd6c3SFam Zheng 
191069e0b6dfSFam Zheng         if (vmdk_create_extent(ext_filename, size,
19114ab15590SChunyan Liu                                flat, compress, zeroed_grain, opts, errp)) {
1912af057fe7SFam Zheng             ret = -EINVAL;
1913af057fe7SFam Zheng             goto exit;
1914f66fd6c3SFam Zheng         }
1915f66fd6c3SFam Zheng         filesize -= size;
1916f66fd6c3SFam Zheng 
1917f66fd6c3SFam Zheng         /* Format description line */
1918f66fd6c3SFam Zheng         snprintf(desc_line, sizeof(desc_line),
1919917703c1SFam Zheng                     desc_extent_line, size / BDRV_SECTOR_SIZE, desc_filename);
1920af057fe7SFam Zheng         g_string_append(ext_desc_lines, desc_line);
1921f66fd6c3SFam Zheng     }
1922f66fd6c3SFam Zheng     /* generate descriptor file */
1923af057fe7SFam Zheng     desc = g_strdup_printf(desc_template,
19249b17031aSFam Zheng                            (uint32_t)time(NULL),
1925f66fd6c3SFam Zheng                            parent_cid,
1926f66fd6c3SFam Zheng                            fmt,
1927f66fd6c3SFam Zheng                            parent_desc_line,
1928af057fe7SFam Zheng                            ext_desc_lines->str,
1929f66fd6c3SFam Zheng                            (flags & BLOCK_FLAG_COMPAT6 ? 6 : 4),
1930917703c1SFam Zheng                            total_size /
1931917703c1SFam Zheng                                (int64_t)(63 * number_heads * BDRV_SECTOR_SIZE),
1932af057fe7SFam Zheng                            number_heads,
19337f2039f6SOthmar Pasteka                            adapter_type);
1934917703c1SFam Zheng     desc_len = strlen(desc);
1935917703c1SFam Zheng     /* the descriptor offset = 0x200 */
1936917703c1SFam Zheng     if (!split && !flat) {
1937917703c1SFam Zheng         desc_offset = 0x200;
1938f66fd6c3SFam Zheng     } else {
1939c282e1fdSChunyan Liu         ret = bdrv_create_file(filename, opts, &local_err);
1940917703c1SFam Zheng         if (ret < 0) {
1941c13959c7SFam Zheng             error_propagate(errp, local_err);
1942af057fe7SFam Zheng             goto exit;
1943f66fd6c3SFam Zheng         }
1944f66fd6c3SFam Zheng     }
19452e40134bSMax Reitz     assert(new_bs == NULL);
19462e40134bSMax Reitz     ret = bdrv_open(&new_bs, filename, NULL, NULL,
19472e40134bSMax Reitz                     BDRV_O_RDWR | BDRV_O_PROTOCOL, NULL, &local_err);
1948917703c1SFam Zheng     if (ret < 0) {
1949c13959c7SFam Zheng         error_propagate(errp, local_err);
1950917703c1SFam Zheng         goto exit;
19511640366cSKirill A. Shutemov     }
1952917703c1SFam Zheng     ret = bdrv_pwrite(new_bs, desc_offset, desc, desc_len);
1953917703c1SFam Zheng     if (ret < 0) {
1954917703c1SFam Zheng         error_setg_errno(errp, -ret, "Could not write description");
1955917703c1SFam Zheng         goto exit;
1956917703c1SFam Zheng     }
1957917703c1SFam Zheng     /* bdrv_pwrite write padding zeros to align to sector, we don't need that
1958917703c1SFam Zheng      * for description file */
1959917703c1SFam Zheng     if (desc_offset == 0) {
1960917703c1SFam Zheng         ret = bdrv_truncate(new_bs, desc_len);
1961917703c1SFam Zheng         if (ret < 0) {
196239a611a3SJeff Cody             error_setg_errno(errp, -ret, "Could not truncate file");
1963917703c1SFam Zheng         }
1964917703c1SFam Zheng     }
1965af057fe7SFam Zheng exit:
1966917703c1SFam Zheng     if (new_bs) {
1967917703c1SFam Zheng         bdrv_unref(new_bs);
1968917703c1SFam Zheng     }
19695820f1daSChunyan Liu     g_free(adapter_type);
19705820f1daSChunyan Liu     g_free(backing_file);
19715820f1daSChunyan Liu     g_free(fmt);
1972af057fe7SFam Zheng     g_free(desc);
1973af057fe7SFam Zheng     g_string_free(ext_desc_lines, true);
19741640366cSKirill A. Shutemov     return ret;
1975019d6b8fSAnthony Liguori }
1976019d6b8fSAnthony Liguori 
1977019d6b8fSAnthony Liguori static void vmdk_close(BlockDriverState *bs)
1978019d6b8fSAnthony Liguori {
19792bc3166cSKevin Wolf     BDRVVmdkState *s = bs->opaque;
19802bc3166cSKevin Wolf 
1981b3976d3cSFam Zheng     vmdk_free_extents(bs);
1982f4c129a3SFam Zheng     g_free(s->create_type);
19832bc3166cSKevin Wolf 
19842bc3166cSKevin Wolf     migrate_del_blocker(s->migration_blocker);
19852bc3166cSKevin Wolf     error_free(s->migration_blocker);
1986019d6b8fSAnthony Liguori }
1987019d6b8fSAnthony Liguori 
19888b94ff85SPaolo Bonzini static coroutine_fn int vmdk_co_flush(BlockDriverState *bs)
1989019d6b8fSAnthony Liguori {
1990333c574dSFam Zheng     BDRVVmdkState *s = bs->opaque;
199129cdb251SPaolo Bonzini     int i, err;
199229cdb251SPaolo Bonzini     int ret = 0;
1993333c574dSFam Zheng 
1994333c574dSFam Zheng     for (i = 0; i < s->num_extents; i++) {
19958b94ff85SPaolo Bonzini         err = bdrv_co_flush(s->extents[i].file);
1996333c574dSFam Zheng         if (err < 0) {
1997333c574dSFam Zheng             ret = err;
1998333c574dSFam Zheng         }
1999333c574dSFam Zheng     }
2000333c574dSFam Zheng     return ret;
2001019d6b8fSAnthony Liguori }
2002019d6b8fSAnthony Liguori 
20034a1d5e1fSFam Zheng static int64_t vmdk_get_allocated_file_size(BlockDriverState *bs)
20044a1d5e1fSFam Zheng {
20054a1d5e1fSFam Zheng     int i;
20064a1d5e1fSFam Zheng     int64_t ret = 0;
20074a1d5e1fSFam Zheng     int64_t r;
20084a1d5e1fSFam Zheng     BDRVVmdkState *s = bs->opaque;
20094a1d5e1fSFam Zheng 
20104a1d5e1fSFam Zheng     ret = bdrv_get_allocated_file_size(bs->file);
20114a1d5e1fSFam Zheng     if (ret < 0) {
20124a1d5e1fSFam Zheng         return ret;
20134a1d5e1fSFam Zheng     }
20144a1d5e1fSFam Zheng     for (i = 0; i < s->num_extents; i++) {
20154a1d5e1fSFam Zheng         if (s->extents[i].file == bs->file) {
20164a1d5e1fSFam Zheng             continue;
20174a1d5e1fSFam Zheng         }
20184a1d5e1fSFam Zheng         r = bdrv_get_allocated_file_size(s->extents[i].file);
20194a1d5e1fSFam Zheng         if (r < 0) {
20204a1d5e1fSFam Zheng             return r;
20214a1d5e1fSFam Zheng         }
20224a1d5e1fSFam Zheng         ret += r;
20234a1d5e1fSFam Zheng     }
20244a1d5e1fSFam Zheng     return ret;
20254a1d5e1fSFam Zheng }
20260e7e1989SKevin Wolf 
2027da7a50f9SFam Zheng static int vmdk_has_zero_init(BlockDriverState *bs)
2028da7a50f9SFam Zheng {
2029da7a50f9SFam Zheng     int i;
2030da7a50f9SFam Zheng     BDRVVmdkState *s = bs->opaque;
2031da7a50f9SFam Zheng 
2032da7a50f9SFam Zheng     /* If has a flat extent and its underlying storage doesn't have zero init,
2033da7a50f9SFam Zheng      * return 0. */
2034da7a50f9SFam Zheng     for (i = 0; i < s->num_extents; i++) {
2035da7a50f9SFam Zheng         if (s->extents[i].flat) {
2036da7a50f9SFam Zheng             if (!bdrv_has_zero_init(s->extents[i].file)) {
2037da7a50f9SFam Zheng                 return 0;
2038da7a50f9SFam Zheng             }
2039da7a50f9SFam Zheng         }
2040da7a50f9SFam Zheng     }
2041da7a50f9SFam Zheng     return 1;
2042da7a50f9SFam Zheng }
2043da7a50f9SFam Zheng 
2044f4c129a3SFam Zheng static ImageInfo *vmdk_get_extent_info(VmdkExtent *extent)
2045f4c129a3SFam Zheng {
2046f4c129a3SFam Zheng     ImageInfo *info = g_new0(ImageInfo, 1);
2047f4c129a3SFam Zheng 
2048f4c129a3SFam Zheng     *info = (ImageInfo){
2049f4c129a3SFam Zheng         .filename         = g_strdup(extent->file->filename),
2050f4c129a3SFam Zheng         .format           = g_strdup(extent->type),
2051f4c129a3SFam Zheng         .virtual_size     = extent->sectors * BDRV_SECTOR_SIZE,
2052f4c129a3SFam Zheng         .compressed       = extent->compressed,
2053f4c129a3SFam Zheng         .has_compressed   = extent->compressed,
2054f4c129a3SFam Zheng         .cluster_size     = extent->cluster_sectors * BDRV_SECTOR_SIZE,
2055f4c129a3SFam Zheng         .has_cluster_size = !extent->flat,
2056f4c129a3SFam Zheng     };
2057f4c129a3SFam Zheng 
2058f4c129a3SFam Zheng     return info;
2059f4c129a3SFam Zheng }
2060f4c129a3SFam Zheng 
2061f43aa8e1SPeter Lieven static int vmdk_check(BlockDriverState *bs, BdrvCheckResult *result,
2062f43aa8e1SPeter Lieven                       BdrvCheckMode fix)
2063f43aa8e1SPeter Lieven {
2064f43aa8e1SPeter Lieven     BDRVVmdkState *s = bs->opaque;
2065f43aa8e1SPeter Lieven     VmdkExtent *extent = NULL;
2066f43aa8e1SPeter Lieven     int64_t sector_num = 0;
206757322b78SMarkus Armbruster     int64_t total_sectors = bdrv_nb_sectors(bs);
2068f43aa8e1SPeter Lieven     int ret;
2069f43aa8e1SPeter Lieven     uint64_t cluster_offset;
2070f43aa8e1SPeter Lieven 
2071f43aa8e1SPeter Lieven     if (fix) {
2072f43aa8e1SPeter Lieven         return -ENOTSUP;
2073f43aa8e1SPeter Lieven     }
2074f43aa8e1SPeter Lieven 
2075f43aa8e1SPeter Lieven     for (;;) {
2076f43aa8e1SPeter Lieven         if (sector_num >= total_sectors) {
2077f43aa8e1SPeter Lieven             return 0;
2078f43aa8e1SPeter Lieven         }
2079f43aa8e1SPeter Lieven         extent = find_extent(s, sector_num, extent);
2080f43aa8e1SPeter Lieven         if (!extent) {
2081f43aa8e1SPeter Lieven             fprintf(stderr,
2082f43aa8e1SPeter Lieven                     "ERROR: could not find extent for sector %" PRId64 "\n",
2083f43aa8e1SPeter Lieven                     sector_num);
2084f43aa8e1SPeter Lieven             break;
2085f43aa8e1SPeter Lieven         }
2086f43aa8e1SPeter Lieven         ret = get_cluster_offset(bs, extent, NULL,
2087f43aa8e1SPeter Lieven                                  sector_num << BDRV_SECTOR_BITS,
2088c6ac36e1SFam Zheng                                  false, &cluster_offset, 0, 0);
2089f43aa8e1SPeter Lieven         if (ret == VMDK_ERROR) {
2090f43aa8e1SPeter Lieven             fprintf(stderr,
2091f43aa8e1SPeter Lieven                     "ERROR: could not get cluster_offset for sector %"
2092f43aa8e1SPeter Lieven                     PRId64 "\n", sector_num);
2093f43aa8e1SPeter Lieven             break;
2094f43aa8e1SPeter Lieven         }
2095f43aa8e1SPeter Lieven         if (ret == VMDK_OK && cluster_offset >= bdrv_getlength(extent->file)) {
2096f43aa8e1SPeter Lieven             fprintf(stderr,
2097f43aa8e1SPeter Lieven                     "ERROR: cluster offset for sector %"
2098f43aa8e1SPeter Lieven                     PRId64 " points after EOF\n", sector_num);
2099f43aa8e1SPeter Lieven             break;
2100f43aa8e1SPeter Lieven         }
2101f43aa8e1SPeter Lieven         sector_num += extent->cluster_sectors;
2102f43aa8e1SPeter Lieven     }
2103f43aa8e1SPeter Lieven 
2104f43aa8e1SPeter Lieven     result->corruptions++;
2105f43aa8e1SPeter Lieven     return 0;
2106f43aa8e1SPeter Lieven }
2107f43aa8e1SPeter Lieven 
2108f4c129a3SFam Zheng static ImageInfoSpecific *vmdk_get_specific_info(BlockDriverState *bs)
2109f4c129a3SFam Zheng {
2110f4c129a3SFam Zheng     int i;
2111f4c129a3SFam Zheng     BDRVVmdkState *s = bs->opaque;
2112f4c129a3SFam Zheng     ImageInfoSpecific *spec_info = g_new0(ImageInfoSpecific, 1);
2113f4c129a3SFam Zheng     ImageInfoList **next;
2114f4c129a3SFam Zheng 
2115f4c129a3SFam Zheng     *spec_info = (ImageInfoSpecific){
2116f4c129a3SFam Zheng         .kind = IMAGE_INFO_SPECIFIC_KIND_VMDK,
2117f4c129a3SFam Zheng         {
2118f4c129a3SFam Zheng             .vmdk = g_new0(ImageInfoSpecificVmdk, 1),
2119f4c129a3SFam Zheng         },
2120f4c129a3SFam Zheng     };
2121f4c129a3SFam Zheng 
2122f4c129a3SFam Zheng     *spec_info->vmdk = (ImageInfoSpecificVmdk) {
2123f4c129a3SFam Zheng         .create_type = g_strdup(s->create_type),
2124f4c129a3SFam Zheng         .cid = s->cid,
2125f4c129a3SFam Zheng         .parent_cid = s->parent_cid,
2126f4c129a3SFam Zheng     };
2127f4c129a3SFam Zheng 
2128f4c129a3SFam Zheng     next = &spec_info->vmdk->extents;
2129f4c129a3SFam Zheng     for (i = 0; i < s->num_extents; i++) {
2130f4c129a3SFam Zheng         *next = g_new0(ImageInfoList, 1);
2131f4c129a3SFam Zheng         (*next)->value = vmdk_get_extent_info(&s->extents[i]);
2132f4c129a3SFam Zheng         (*next)->next = NULL;
2133f4c129a3SFam Zheng         next = &(*next)->next;
2134f4c129a3SFam Zheng     }
2135f4c129a3SFam Zheng 
2136f4c129a3SFam Zheng     return spec_info;
2137f4c129a3SFam Zheng }
2138f4c129a3SFam Zheng 
213974fe188cSFam Zheng static int vmdk_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
214074fe188cSFam Zheng {
214174fe188cSFam Zheng     int i;
214274fe188cSFam Zheng     BDRVVmdkState *s = bs->opaque;
214374fe188cSFam Zheng     assert(s->num_extents);
214474fe188cSFam Zheng     bdi->needs_compressed_writes = s->extents[0].compressed;
214574fe188cSFam Zheng     if (!s->extents[0].flat) {
214674fe188cSFam Zheng         bdi->cluster_size = s->extents[0].cluster_sectors << BDRV_SECTOR_BITS;
214774fe188cSFam Zheng     }
214874fe188cSFam Zheng     /* See if we have multiple extents but they have different cases */
214974fe188cSFam Zheng     for (i = 1; i < s->num_extents; i++) {
215074fe188cSFam Zheng         if (bdi->needs_compressed_writes != s->extents[i].compressed ||
215174fe188cSFam Zheng             (bdi->cluster_size && bdi->cluster_size !=
215274fe188cSFam Zheng                 s->extents[i].cluster_sectors << BDRV_SECTOR_BITS)) {
215374fe188cSFam Zheng             return -ENOTSUP;
215474fe188cSFam Zheng         }
215574fe188cSFam Zheng     }
215674fe188cSFam Zheng     return 0;
215774fe188cSFam Zheng }
215874fe188cSFam Zheng 
2159c75f3bdfSStefan Hajnoczi static void vmdk_detach_aio_context(BlockDriverState *bs)
2160c75f3bdfSStefan Hajnoczi {
2161c75f3bdfSStefan Hajnoczi     BDRVVmdkState *s = bs->opaque;
2162c75f3bdfSStefan Hajnoczi     int i;
2163c75f3bdfSStefan Hajnoczi 
2164c75f3bdfSStefan Hajnoczi     for (i = 0; i < s->num_extents; i++) {
2165c75f3bdfSStefan Hajnoczi         bdrv_detach_aio_context(s->extents[i].file);
2166c75f3bdfSStefan Hajnoczi     }
2167c75f3bdfSStefan Hajnoczi }
2168c75f3bdfSStefan Hajnoczi 
2169c75f3bdfSStefan Hajnoczi static void vmdk_attach_aio_context(BlockDriverState *bs,
2170c75f3bdfSStefan Hajnoczi                                     AioContext *new_context)
2171c75f3bdfSStefan Hajnoczi {
2172c75f3bdfSStefan Hajnoczi     BDRVVmdkState *s = bs->opaque;
2173c75f3bdfSStefan Hajnoczi     int i;
2174c75f3bdfSStefan Hajnoczi 
2175c75f3bdfSStefan Hajnoczi     for (i = 0; i < s->num_extents; i++) {
2176c75f3bdfSStefan Hajnoczi         bdrv_attach_aio_context(s->extents[i].file, new_context);
2177c75f3bdfSStefan Hajnoczi     }
2178c75f3bdfSStefan Hajnoczi }
2179c75f3bdfSStefan Hajnoczi 
21805820f1daSChunyan Liu static QemuOptsList vmdk_create_opts = {
21815820f1daSChunyan Liu     .name = "vmdk-create-opts",
21825820f1daSChunyan Liu     .head = QTAILQ_HEAD_INITIALIZER(vmdk_create_opts.head),
21835820f1daSChunyan Liu     .desc = {
2184db08adf5SKevin Wolf         {
2185db08adf5SKevin Wolf             .name = BLOCK_OPT_SIZE,
21865820f1daSChunyan Liu             .type = QEMU_OPT_SIZE,
2187db08adf5SKevin Wolf             .help = "Virtual disk size"
2188db08adf5SKevin Wolf         },
2189db08adf5SKevin Wolf         {
21907f2039f6SOthmar Pasteka             .name = BLOCK_OPT_ADAPTER_TYPE,
21915820f1daSChunyan Liu             .type = QEMU_OPT_STRING,
21927f2039f6SOthmar Pasteka             .help = "Virtual adapter type, can be one of "
21937f2039f6SOthmar Pasteka                     "ide (default), lsilogic, buslogic or legacyESX"
21947f2039f6SOthmar Pasteka         },
21957f2039f6SOthmar Pasteka         {
2196db08adf5SKevin Wolf             .name = BLOCK_OPT_BACKING_FILE,
21975820f1daSChunyan Liu             .type = QEMU_OPT_STRING,
2198db08adf5SKevin Wolf             .help = "File name of a base image"
2199db08adf5SKevin Wolf         },
2200db08adf5SKevin Wolf         {
2201db08adf5SKevin Wolf             .name = BLOCK_OPT_COMPAT6,
22025820f1daSChunyan Liu             .type = QEMU_OPT_BOOL,
22035820f1daSChunyan Liu             .help = "VMDK version 6 image",
22045820f1daSChunyan Liu             .def_value_str = "off"
2205db08adf5SKevin Wolf         },
2206f66fd6c3SFam Zheng         {
2207f66fd6c3SFam Zheng             .name = BLOCK_OPT_SUBFMT,
22085820f1daSChunyan Liu             .type = QEMU_OPT_STRING,
2209f66fd6c3SFam Zheng             .help =
2210f66fd6c3SFam Zheng                 "VMDK flat extent format, can be one of "
22116c031aacSFam Zheng                 "{monolithicSparse (default) | monolithicFlat | twoGbMaxExtentSparse | twoGbMaxExtentFlat | streamOptimized} "
2212f66fd6c3SFam Zheng         },
221369e0b6dfSFam Zheng         {
221469e0b6dfSFam Zheng             .name = BLOCK_OPT_ZEROED_GRAIN,
22155820f1daSChunyan Liu             .type = QEMU_OPT_BOOL,
22165820f1daSChunyan Liu             .help = "Enable efficient zero writes "
22175820f1daSChunyan Liu                     "using the zeroed-grain GTE feature"
221869e0b6dfSFam Zheng         },
22195820f1daSChunyan Liu         { /* end of list */ }
22205820f1daSChunyan Liu     }
22210e7e1989SKevin Wolf };
22220e7e1989SKevin Wolf 
2223019d6b8fSAnthony Liguori static BlockDriver bdrv_vmdk = {
2224019d6b8fSAnthony Liguori     .format_name                  = "vmdk",
2225019d6b8fSAnthony Liguori     .instance_size                = sizeof(BDRVVmdkState),
2226019d6b8fSAnthony Liguori     .bdrv_probe                   = vmdk_probe,
22276511ef77SKevin Wolf     .bdrv_open                    = vmdk_open,
2228f43aa8e1SPeter Lieven     .bdrv_check                   = vmdk_check,
22293897575fSJeff Cody     .bdrv_reopen_prepare          = vmdk_reopen_prepare,
22302914caa0SPaolo Bonzini     .bdrv_read                    = vmdk_co_read,
2231e183ef75SPaolo Bonzini     .bdrv_write                   = vmdk_co_write,
2232ba0ad89eSFam Zheng     .bdrv_write_compressed        = vmdk_write_compressed,
2233cdeaf1f1SFam Zheng     .bdrv_co_write_zeroes         = vmdk_co_write_zeroes,
2234019d6b8fSAnthony Liguori     .bdrv_close                   = vmdk_close,
2235c282e1fdSChunyan Liu     .bdrv_create                  = vmdk_create,
2236c68b89acSKevin Wolf     .bdrv_co_flush_to_disk        = vmdk_co_flush,
2237b6b8a333SPaolo Bonzini     .bdrv_co_get_block_status     = vmdk_co_get_block_status,
22384a1d5e1fSFam Zheng     .bdrv_get_allocated_file_size = vmdk_get_allocated_file_size,
2239da7a50f9SFam Zheng     .bdrv_has_zero_init           = vmdk_has_zero_init,
2240f4c129a3SFam Zheng     .bdrv_get_specific_info       = vmdk_get_specific_info,
2241d34682cdSKevin Wolf     .bdrv_refresh_limits          = vmdk_refresh_limits,
224274fe188cSFam Zheng     .bdrv_get_info                = vmdk_get_info,
2243c75f3bdfSStefan Hajnoczi     .bdrv_detach_aio_context      = vmdk_detach_aio_context,
2244c75f3bdfSStefan Hajnoczi     .bdrv_attach_aio_context      = vmdk_attach_aio_context,
22450e7e1989SKevin Wolf 
22468ee79e70SKevin Wolf     .supports_backing             = true,
22475820f1daSChunyan Liu     .create_opts                  = &vmdk_create_opts,
2248019d6b8fSAnthony Liguori };
2249019d6b8fSAnthony Liguori 
2250019d6b8fSAnthony Liguori static void bdrv_vmdk_init(void)
2251019d6b8fSAnthony Liguori {
2252019d6b8fSAnthony Liguori     bdrv_register(&bdrv_vmdk);
2253019d6b8fSAnthony Liguori }
2254019d6b8fSAnthony Liguori 
2255019d6b8fSAnthony Liguori block_init(bdrv_vmdk_init);
2256