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