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