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