vmdk.c 45.8 KB
Newer Older
B
bellard 已提交
1 2
/*
 * Block driver for the VMDK format
3
 *
B
bellard 已提交
4
 * Copyright (c) 2004 Fabrice Bellard
5
 * Copyright (c) 2005 Filip Navara
6
 *
B
bellard 已提交
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
25

P
pbrook 已提交
26
#include "qemu-common.h"
B
bellard 已提交
27
#include "block_int.h"
28
#include "module.h"
K
Kevin Wolf 已提交
29
#include "migration.h"
S
Stefan Weil 已提交
30
#include <zlib.h>
B
bellard 已提交
31 32 33

#define VMDK3_MAGIC (('C' << 24) | ('O' << 16) | ('W' << 8) | 'D')
#define VMDK4_MAGIC (('K' << 24) | ('D' << 16) | ('M' << 8) | 'V')
F
Fam Zheng 已提交
34
#define VMDK4_COMPRESSION_DEFLATE 1
35
#define VMDK4_FLAG_RGD (1 << 1)
F
Fam Zheng 已提交
36 37
#define VMDK4_FLAG_COMPRESS (1 << 16)
#define VMDK4_FLAG_MARKER (1 << 17)
B
bellard 已提交
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

typedef struct {
    uint32_t version;
    uint32_t flags;
    uint32_t disk_sectors;
    uint32_t granularity;
    uint32_t l1dir_offset;
    uint32_t l1dir_size;
    uint32_t file_sectors;
    uint32_t cylinders;
    uint32_t heads;
    uint32_t sectors_per_track;
} VMDK3Header;

typedef struct {
    uint32_t version;
    uint32_t flags;
    int64_t capacity;
    int64_t granularity;
    int64_t desc_offset;
    int64_t desc_size;
    int32_t num_gtes_per_gte;
    int64_t gd_offset;
61
    int64_t rgd_offset;
B
bellard 已提交
62 63 64
    int64_t grain_offset;
    char filler[1];
    char check_bytes[4];
F
Fam Zheng 已提交
65
    uint16_t compressAlgorithm;
66
} QEMU_PACKED VMDK4Header;
B
bellard 已提交
67 68 69

#define L2_CACHE_SIZE 16

F
Fam Zheng 已提交
70 71 72
typedef struct VmdkExtent {
    BlockDriverState *file;
    bool flat;
F
Fam Zheng 已提交
73 74
    bool compressed;
    bool has_marker;
F
Fam Zheng 已提交
75 76
    int64_t sectors;
    int64_t end_sector;
77
    int64_t flat_start_offset;
B
bellard 已提交
78
    int64_t l1_table_offset;
79
    int64_t l1_backup_table_offset;
B
bellard 已提交
80
    uint32_t *l1_table;
81
    uint32_t *l1_backup_table;
B
bellard 已提交
82 83 84 85 86 87 88 89 90
    unsigned int l1_size;
    uint32_t l1_entry_sectors;

    unsigned int l2_size;
    uint32_t *l2_cache;
    uint32_t l2_cache_offsets[L2_CACHE_SIZE];
    uint32_t l2_cache_counts[L2_CACHE_SIZE];

    unsigned int cluster_sectors;
F
Fam Zheng 已提交
91 92 93
} VmdkExtent;

typedef struct BDRVVmdkState {
94
    CoMutex lock;
95
    int desc_offset;
96
    bool cid_updated;
97
    uint32_t parent_cid;
F
Fam Zheng 已提交
98 99 100
    int num_extents;
    /* Extent array with num_extents entries, ascend ordered by address */
    VmdkExtent *extents;
K
Kevin Wolf 已提交
101
    Error *migration_blocker;
B
bellard 已提交
102 103
} BDRVVmdkState;

104 105 106 107 108 109 110 111
typedef struct VmdkMetaData {
    uint32_t offset;
    unsigned int l1_index;
    unsigned int l2_index;
    unsigned int l2_offset;
    int valid;
} VmdkMetaData;

F
Fam Zheng 已提交
112 113 114 115 116 117
typedef struct VmdkGrainMarker {
    uint64_t lba;
    uint32_t size;
    uint8_t  data[0];
} VmdkGrainMarker;

B
bellard 已提交
118 119 120 121
static int vmdk_probe(const uint8_t *buf, int buf_size, const char *filename)
{
    uint32_t magic;

F
Fam Zheng 已提交
122
    if (buf_size < 4) {
B
bellard 已提交
123
        return 0;
F
Fam Zheng 已提交
124
    }
B
bellard 已提交
125 126
    magic = be32_to_cpu(*(uint32_t *)buf);
    if (magic == VMDK3_MAGIC ||
127
        magic == VMDK4_MAGIC) {
B
bellard 已提交
128
        return 100;
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
    } else {
        const char *p = (const char *)buf;
        const char *end = p + buf_size;
        while (p < end) {
            if (*p == '#') {
                /* skip comment line */
                while (p < end && *p != '\n') {
                    p++;
                }
                p++;
                continue;
            }
            if (*p == ' ') {
                while (p < end && *p == ' ') {
                    p++;
                }
                /* skip '\r' if windows line endings used. */
                if (p < end && *p == '\r') {
                    p++;
                }
                /* only accept blank lines before 'version=' line */
                if (p == end || *p != '\n') {
                    return 0;
                }
                p++;
                continue;
            }
            if (end - p >= strlen("version=X\n")) {
                if (strncmp("version=1\n", p, strlen("version=1\n")) == 0 ||
                    strncmp("version=2\n", p, strlen("version=2\n")) == 0) {
                    return 100;
                }
            }
            if (end - p >= strlen("version=X\r\n")) {
                if (strncmp("version=1\r\n", p, strlen("version=1\r\n")) == 0 ||
                    strncmp("version=2\r\n", p, strlen("version=2\r\n")) == 0) {
                    return 100;
                }
            }
            return 0;
        }
B
bellard 已提交
170
        return 0;
171
    }
B
bellard 已提交
172 173
}

174 175
#define CHECK_CID 1

176
#define SECTOR_SIZE 512
F
Fam Zheng 已提交
177 178 179
#define DESC_SIZE (20 * SECTOR_SIZE)    /* 20 sectors of 512 bytes each */
#define BUF_SIZE 4096
#define HEADER_SIZE 512                 /* first sector of 512 bytes */
180

F
Fam Zheng 已提交
181 182 183 184
static void vmdk_free_extents(BlockDriverState *bs)
{
    int i;
    BDRVVmdkState *s = bs->opaque;
F
Fam Zheng 已提交
185
    VmdkExtent *e;
F
Fam Zheng 已提交
186 187

    for (i = 0; i < s->num_extents; i++) {
F
Fam Zheng 已提交
188 189 190 191 192 193 194
        e = &s->extents[i];
        g_free(e->l1_table);
        g_free(e->l2_cache);
        g_free(e->l1_backup_table);
        if (e->file != bs->file) {
            bdrv_delete(e->file);
        }
F
Fam Zheng 已提交
195
    }
196
    g_free(s->extents);
F
Fam Zheng 已提交
197 198
}

199 200 201 202 203 204 205 206 207 208 209
static void vmdk_free_last_extent(BlockDriverState *bs)
{
    BDRVVmdkState *s = bs->opaque;

    if (s->num_extents == 0) {
        return;
    }
    s->num_extents--;
    s->extents = g_realloc(s->extents, s->num_extents * sizeof(VmdkExtent));
}

210
static uint32_t vmdk_read_cid(BlockDriverState *bs, int parent)
B
bellard 已提交
211
{
212
    char desc[DESC_SIZE];
213
    uint32_t cid = 0xffffffff;
214
    const char *p_name, *cid_str;
215
    size_t cid_str_size;
216
    BDRVVmdkState *s = bs->opaque;
K
Kevin Wolf 已提交
217
    int ret;
218

K
Kevin Wolf 已提交
219 220
    ret = bdrv_pread(bs->file, s->desc_offset, desc, DESC_SIZE);
    if (ret < 0) {
221
        return 0;
222
    }
223 224 225 226 227 228 229 230 231

    if (parent) {
        cid_str = "parentCID";
        cid_str_size = sizeof("parentCID");
    } else {
        cid_str = "CID";
        cid_str_size = sizeof("CID");
    }

K
Kevin Wolf 已提交
232
    desc[DESC_SIZE - 1] = '\0';
F
Fam Zheng 已提交
233 234
    p_name = strstr(desc, cid_str);
    if (p_name != NULL) {
235
        p_name += cid_str_size;
F
Fam Zheng 已提交
236
        sscanf(p_name, "%x", &cid);
237 238 239 240 241 242 243 244 245
    }

    return cid;
}

static int vmdk_write_cid(BlockDriverState *bs, uint32_t cid)
{
    char desc[DESC_SIZE], tmp_desc[DESC_SIZE];
    char *p_name, *tmp_str;
246
    BDRVVmdkState *s = bs->opaque;
K
Kevin Wolf 已提交
247
    int ret;
248

K
Kevin Wolf 已提交
249 250 251
    ret = bdrv_pread(bs->file, s->desc_offset, desc, DESC_SIZE);
    if (ret < 0) {
        return ret;
252
    }
253

K
Kevin Wolf 已提交
254
    desc[DESC_SIZE - 1] = '\0';
F
Fam Zheng 已提交
255
    tmp_str = strstr(desc, "parentCID");
K
Kevin Wolf 已提交
256 257 258 259
    if (tmp_str == NULL) {
        return -EINVAL;
    }

B
blueswir1 已提交
260
    pstrcpy(tmp_desc, sizeof(tmp_desc), tmp_str);
F
Fam Zheng 已提交
261 262
    p_name = strstr(desc, "CID");
    if (p_name != NULL) {
263
        p_name += sizeof("CID");
B
blueswir1 已提交
264 265
        snprintf(p_name, sizeof(desc) - (p_name - desc), "%x\n", cid);
        pstrcat(desc, sizeof(desc), tmp_desc);
266 267
    }

K
Kevin Wolf 已提交
268 269 270
    ret = bdrv_pwrite_sync(bs->file, s->desc_offset, desc, DESC_SIZE);
    if (ret < 0) {
        return ret;
271
    }
K
Kevin Wolf 已提交
272

273 274 275 276 277 278 279
    return 0;
}

static int vmdk_is_cid_valid(BlockDriverState *bs)
{
#ifdef CHECK_CID
    BDRVVmdkState *s = bs->opaque;
K
Kevin Wolf 已提交
280
    BlockDriverState *p_bs = bs->backing_hd;
281 282 283
    uint32_t cur_pcid;

    if (p_bs) {
F
Fam Zheng 已提交
284 285 286
        cur_pcid = vmdk_read_cid(p_bs, 0);
        if (s->parent_cid != cur_pcid) {
            /* CID not valid */
287
            return 0;
F
Fam Zheng 已提交
288
        }
289 290
    }
#endif
F
Fam Zheng 已提交
291
    /* CID valid */
292 293 294
    return 1;
}

295
static int vmdk_parent_open(BlockDriverState *bs)
296
{
297
    char *p_name;
298
    char desc[DESC_SIZE + 1];
299
    BDRVVmdkState *s = bs->opaque;
300
    int ret;
301

302
    desc[DESC_SIZE] = '\0';
303 304 305
    ret = bdrv_pread(bs->file, s->desc_offset, desc, DESC_SIZE);
    if (ret < 0) {
        return ret;
306
    }
307

F
Fam Zheng 已提交
308 309
    p_name = strstr(desc, "parentFileNameHint");
    if (p_name != NULL) {
310 311 312
        char *end_name;

        p_name += sizeof("parentFileNameHint") + 1;
F
Fam Zheng 已提交
313 314
        end_name = strchr(p_name, '\"');
        if (end_name == NULL) {
315
            return -EINVAL;
F
Fam Zheng 已提交
316 317
        }
        if ((end_name - p_name) > sizeof(bs->backing_file) - 1) {
318
            return -EINVAL;
F
Fam Zheng 已提交
319
        }
320

K
Kevin Wolf 已提交
321
        pstrcpy(bs->backing_file, end_name - p_name + 1, p_name);
322
    }
323 324 325 326

    return 0;
}

F
Fam Zheng 已提交
327 328 329 330 331 332 333 334 335 336 337
/* Create and append extent to the extent array. Return the added VmdkExtent
 * address. return NULL if allocation failed. */
static VmdkExtent *vmdk_add_extent(BlockDriverState *bs,
                           BlockDriverState *file, bool flat, int64_t sectors,
                           int64_t l1_offset, int64_t l1_backup_offset,
                           uint32_t l1_size,
                           int l2_size, unsigned int cluster_sectors)
{
    VmdkExtent *extent;
    BDRVVmdkState *s = bs->opaque;

338
    s->extents = g_realloc(s->extents,
F
Fam Zheng 已提交
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
                              (s->num_extents + 1) * sizeof(VmdkExtent));
    extent = &s->extents[s->num_extents];
    s->num_extents++;

    memset(extent, 0, sizeof(VmdkExtent));
    extent->file = file;
    extent->flat = flat;
    extent->sectors = sectors;
    extent->l1_table_offset = l1_offset;
    extent->l1_backup_table_offset = l1_backup_offset;
    extent->l1_size = l1_size;
    extent->l1_entry_sectors = l2_size * cluster_sectors;
    extent->l2_size = l2_size;
    extent->cluster_sectors = cluster_sectors;

    if (s->num_extents > 1) {
        extent->end_sector = (*(extent - 1)).end_sector + extent->sectors;
    } else {
        extent->end_sector = extent->sectors;
    }
    bs->total_sectors = extent->end_sector;
    return extent;
}

363
static int vmdk_init_tables(BlockDriverState *bs, VmdkExtent *extent)
364
{
365 366
    int ret;
    int l1_size, i;
367

B
bellard 已提交
368
    /* read the L1 table */
F
Fam Zheng 已提交
369
    l1_size = extent->l1_size * sizeof(uint32_t);
370
    extent->l1_table = g_malloc(l1_size);
371 372 373 374 375 376
    ret = bdrv_pread(extent->file,
                    extent->l1_table_offset,
                    extent->l1_table,
                    l1_size);
    if (ret < 0) {
        goto fail_l1;
F
Fam Zheng 已提交
377 378 379
    }
    for (i = 0; i < extent->l1_size; i++) {
        le32_to_cpus(&extent->l1_table[i]);
B
bellard 已提交
380 381
    }

F
Fam Zheng 已提交
382
    if (extent->l1_backup_table_offset) {
383
        extent->l1_backup_table = g_malloc(l1_size);
384 385 386 387 388 389
        ret = bdrv_pread(extent->file,
                        extent->l1_backup_table_offset,
                        extent->l1_backup_table,
                        l1_size);
        if (ret < 0) {
            goto fail_l1b;
F
Fam Zheng 已提交
390 391 392
        }
        for (i = 0; i < extent->l1_size; i++) {
            le32_to_cpus(&extent->l1_backup_table[i]);
393 394 395
        }
    }

F
Fam Zheng 已提交
396
    extent->l2_cache =
397
        g_malloc(extent->l2_size * L2_CACHE_SIZE * sizeof(uint32_t));
B
bellard 已提交
398
    return 0;
399
 fail_l1b:
400
    g_free(extent->l1_backup_table);
401
 fail_l1:
402
    g_free(extent->l1_table);
403 404 405
    return ret;
}

406 407 408
static int vmdk_open_vmdk3(BlockDriverState *bs,
                           BlockDriverState *file,
                           int flags)
409 410 411 412 413 414
{
    int ret;
    uint32_t magic;
    VMDK3Header header;
    VmdkExtent *extent;

415
    ret = bdrv_pread(file, sizeof(magic), &header, sizeof(header));
416
    if (ret < 0) {
417
        return ret;
418 419 420 421 422 423 424 425 426
    }
    extent = vmdk_add_extent(bs,
                             bs->file, false,
                             le32_to_cpu(header.disk_sectors),
                             le32_to_cpu(header.l1dir_offset) << 9,
                             0, 1 << 6, 1 << 9,
                             le32_to_cpu(header.granularity));
    ret = vmdk_init_tables(bs, extent);
    if (ret) {
427 428
        /* free extent allocated by vmdk_add_extent */
        vmdk_free_last_extent(bs);
429 430 431 432
    }
    return ret;
}

F
Fam Zheng 已提交
433 434 435
static int vmdk_open_desc_file(BlockDriverState *bs, int flags,
                               int64_t desc_offset);

436 437 438
static int vmdk_open_vmdk4(BlockDriverState *bs,
                           BlockDriverState *file,
                           int flags)
439 440 441 442 443 444
{
    int ret;
    uint32_t magic;
    uint32_t l1_size, l1_entry_sectors;
    VMDK4Header header;
    VmdkExtent *extent;
445
    int64_t l1_backup_offset = 0;
446

447
    ret = bdrv_pread(file, sizeof(magic), &header, sizeof(header));
448
    if (ret < 0) {
449
        return ret;
450
    }
F
Fam Zheng 已提交
451 452 453
    if (header.capacity == 0 && header.desc_offset) {
        return vmdk_open_desc_file(bs, flags, header.desc_offset << 9);
    }
454 455
    l1_entry_sectors = le32_to_cpu(header.num_gtes_per_gte)
                        * le64_to_cpu(header.granularity);
456
    if (l1_entry_sectors == 0) {
457 458
        return -EINVAL;
    }
459 460
    l1_size = (le64_to_cpu(header.capacity) + l1_entry_sectors - 1)
                / l1_entry_sectors;
461 462 463
    if (le32_to_cpu(header.flags) & VMDK4_FLAG_RGD) {
        l1_backup_offset = le64_to_cpu(header.rgd_offset) << 9;
    }
464
    extent = vmdk_add_extent(bs, file, false,
465 466
                          le64_to_cpu(header.capacity),
                          le64_to_cpu(header.gd_offset) << 9,
467
                          l1_backup_offset,
468 469 470
                          l1_size,
                          le32_to_cpu(header.num_gtes_per_gte),
                          le64_to_cpu(header.granularity));
F
Fam Zheng 已提交
471 472 473
    extent->compressed =
        le16_to_cpu(header.compressAlgorithm) == VMDK4_COMPRESSION_DEFLATE;
    extent->has_marker = le32_to_cpu(header.flags) & VMDK4_FLAG_MARKER;
474 475
    ret = vmdk_init_tables(bs, extent);
    if (ret) {
476 477
        /* free extent allocated by vmdk_add_extent */
        vmdk_free_last_extent(bs);
478 479 480 481
    }
    return ret;
}

482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
/* find an option value out of descriptor file */
static int vmdk_parse_description(const char *desc, const char *opt_name,
        char *buf, int buf_size)
{
    char *opt_pos, *opt_end;
    const char *end = desc + strlen(desc);

    opt_pos = strstr(desc, opt_name);
    if (!opt_pos) {
        return -1;
    }
    /* Skip "=\"" following opt_name */
    opt_pos += strlen(opt_name) + 2;
    if (opt_pos >= end) {
        return -1;
    }
    opt_end = opt_pos;
    while (opt_end < end && *opt_end != '"') {
        opt_end++;
    }
    if (opt_end == end || buf_size < opt_end - opt_pos + 1) {
        return -1;
    }
    pstrcpy(buf, opt_end - opt_pos + 1, opt_pos);
    return 0;
}

509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
/* Open an extent file and append to bs array */
static int vmdk_open_sparse(BlockDriverState *bs,
                            BlockDriverState *file,
                            int flags)
{
    uint32_t magic;

    if (bdrv_pread(file, 0, &magic, sizeof(magic)) != sizeof(magic)) {
        return -EIO;
    }

    magic = be32_to_cpu(magic);
    switch (magic) {
        case VMDK3_MAGIC:
            return vmdk_open_vmdk3(bs, file, flags);
            break;
        case VMDK4_MAGIC:
            return vmdk_open_vmdk4(bs, file, flags);
            break;
        default:
            return -EINVAL;
            break;
    }
}

534 535 536 537 538 539 540 541 542 543
static int vmdk_parse_extents(const char *desc, BlockDriverState *bs,
        const char *desc_file_path)
{
    int ret;
    char access[11];
    char type[11];
    char fname[512];
    const char *p = desc;
    int64_t sectors = 0;
    int64_t flat_offset;
544 545
    char extent_path[PATH_MAX];
    BlockDriverState *extent_file;
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579

    while (*p) {
        /* parse extent line:
         * RW [size in sectors] FLAT "file-name.vmdk" OFFSET
         * or
         * RW [size in sectors] SPARSE "file-name.vmdk"
         */
        flat_offset = -1;
        ret = sscanf(p, "%10s %" SCNd64 " %10s %511s %" SCNd64,
                access, &sectors, type, fname, &flat_offset);
        if (ret < 4 || strcmp(access, "RW")) {
            goto next_line;
        } else if (!strcmp(type, "FLAT")) {
            if (ret != 5 || flat_offset < 0) {
                return -EINVAL;
            }
        } else if (ret != 4) {
            return -EINVAL;
        }

        /* trim the quotation marks around */
        if (fname[0] == '"') {
            memmove(fname, fname + 1, strlen(fname));
            if (strlen(fname) <= 1 || fname[strlen(fname) - 1] != '"') {
                return -EINVAL;
            }
            fname[strlen(fname) - 1] = '\0';
        }
        if (sectors <= 0 ||
            (strcmp(type, "FLAT") && strcmp(type, "SPARSE")) ||
            (strcmp(access, "RW"))) {
            goto next_line;
        }

580 581 582 583 584 585 586
        path_combine(extent_path, sizeof(extent_path),
                desc_file_path, fname);
        ret = bdrv_file_open(&extent_file, extent_path, bs->open_flags);
        if (ret) {
            return ret;
        }

587 588 589 590 591 592 593
        /* save to extents array */
        if (!strcmp(type, "FLAT")) {
            /* FLAT extent */
            VmdkExtent *extent;

            extent = vmdk_add_extent(bs, extent_file, true, sectors,
                            0, 0, 0, 0, sectors);
F
Fam Zheng 已提交
594
            extent->flat_start_offset = flat_offset << 9;
595 596 597 598 599 600 601
        } else if (!strcmp(type, "SPARSE")) {
            /* SPARSE extent */
            ret = vmdk_open_sparse(bs, extent_file, bs->open_flags);
            if (ret) {
                bdrv_delete(extent_file);
                return ret;
            }
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
        } else {
            fprintf(stderr,
                "VMDK: Not supported extent type \"%s\""".\n", type);
            return -ENOTSUP;
        }
next_line:
        /* move to next line */
        while (*p && *p != '\n') {
            p++;
        }
        p++;
    }
    return 0;
}

F
Fam Zheng 已提交
617 618
static int vmdk_open_desc_file(BlockDriverState *bs, int flags,
                               int64_t desc_offset)
619 620 621 622 623 624
{
    int ret;
    char buf[2048];
    char ct[128];
    BDRVVmdkState *s = bs->opaque;

F
Fam Zheng 已提交
625
    ret = bdrv_pread(bs->file, desc_offset, buf, sizeof(buf));
626 627 628 629 630 631 632
    if (ret < 0) {
        return ret;
    }
    buf[2047] = '\0';
    if (vmdk_parse_description(buf, "createType", ct, sizeof(ct))) {
        return -EINVAL;
    }
F
Fam Zheng 已提交
633
    if (strcmp(ct, "monolithicFlat") &&
634
        strcmp(ct, "twoGbMaxExtentSparse") &&
F
Fam Zheng 已提交
635
        strcmp(ct, "twoGbMaxExtentFlat")) {
636 637 638 639 640
        fprintf(stderr,
                "VMDK: Not supported image type \"%s\""".\n", ct);
        return -ENOTSUP;
    }
    s->desc_offset = 0;
P
Paolo Bonzini 已提交
641
    return vmdk_parse_extents(buf, bs, bs->file->filename);
642 643
}

644 645
static int vmdk_open(BlockDriverState *bs, int flags)
{
646 647
    int ret;
    BDRVVmdkState *s = bs->opaque;
648

649 650
    if (vmdk_open_sparse(bs, bs->file, flags) == 0) {
        s->desc_offset = 0x200;
P
Paolo Bonzini 已提交
651 652
    } else {
        ret = vmdk_open_desc_file(bs, flags, 0);
653
        if (ret) {
P
Paolo Bonzini 已提交
654
            goto fail;
655
        }
656
    }
P
Paolo Bonzini 已提交
657 658 659 660 661 662
    /* try to open parent images, if exist */
    ret = vmdk_parent_open(bs);
    if (ret) {
        goto fail;
    }
    s->parent_cid = vmdk_read_cid(bs, 1);
663
    qemu_co_mutex_init(&s->lock);
K
Kevin Wolf 已提交
664 665 666 667 668 669 670 671

    /* Disable migration when VMDK images are used */
    error_set(&s->migration_blocker,
              QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
              "vmdk", bs->device_name, "live migration");
    migrate_add_blocker(s->migration_blocker);

    return 0;
P
Paolo Bonzini 已提交
672 673 674 675

fail:
    vmdk_free_extents(bs);
    return ret;
B
bellard 已提交
676 677
}

F
Fam Zheng 已提交
678 679 680 681 682
static int get_whole_cluster(BlockDriverState *bs,
                VmdkExtent *extent,
                uint64_t cluster_offset,
                uint64_t offset,
                bool allocate)
683
{
F
Fam Zheng 已提交
684 685
    /* 128 sectors * 512 bytes each = grain size 64KB */
    uint8_t  whole_grain[extent->cluster_sectors * 512];
686

687 688
    /* we will be here if it's first write on non-exist grain(cluster).
     * try to read from parent image, if exist */
K
Kevin Wolf 已提交
689
    if (bs->backing_hd) {
K
Kevin Wolf 已提交
690
        int ret;
691

F
Fam Zheng 已提交
692
        if (!vmdk_is_cid_valid(bs)) {
693
            return -1;
F
Fam Zheng 已提交
694
        }
695

696 697
        /* floor offset to cluster */
        offset -= offset % (extent->cluster_sectors * 512);
K
Kevin Wolf 已提交
698
        ret = bdrv_read(bs->backing_hd, offset >> 9, whole_grain,
F
Fam Zheng 已提交
699
                extent->cluster_sectors);
K
Kevin Wolf 已提交
700 701 702
        if (ret < 0) {
            return -1;
        }
703

704
        /* Write grain only into the active image */
F
Fam Zheng 已提交
705 706
        ret = bdrv_write(extent->file, cluster_offset, whole_grain,
                extent->cluster_sectors);
K
Kevin Wolf 已提交
707 708
        if (ret < 0) {
            return -1;
709 710 711 712 713
        }
    }
    return 0;
}

F
Fam Zheng 已提交
714
static int vmdk_L2update(VmdkExtent *extent, VmdkMetaData *m_data)
715 716
{
    /* update L2 table */
F
Fam Zheng 已提交
717 718 719 720 721 722 723
    if (bdrv_pwrite_sync(
                extent->file,
                ((int64_t)m_data->l2_offset * 512)
                    + (m_data->l2_index * sizeof(m_data->offset)),
                &(m_data->offset),
                sizeof(m_data->offset)
            ) < 0) {
724
        return -1;
F
Fam Zheng 已提交
725
    }
726
    /* update backup L2 table */
F
Fam Zheng 已提交
727 728 729 730 731 732 733 734
    if (extent->l1_backup_table_offset != 0) {
        m_data->l2_offset = extent->l1_backup_table[m_data->l1_index];
        if (bdrv_pwrite_sync(
                    extent->file,
                    ((int64_t)m_data->l2_offset * 512)
                        + (m_data->l2_index * sizeof(m_data->offset)),
                    &(m_data->offset), sizeof(m_data->offset)
                ) < 0) {
735
            return -1;
F
Fam Zheng 已提交
736
        }
737
    }
738

739 740 741
    return 0;
}

742
static int get_cluster_offset(BlockDriverState *bs,
F
Fam Zheng 已提交
743 744
                                    VmdkExtent *extent,
                                    VmdkMetaData *m_data,
745 746 747
                                    uint64_t offset,
                                    int allocate,
                                    uint64_t *cluster_offset)
B
bellard 已提交
748 749 750
{
    unsigned int l1_index, l2_offset, l2_index;
    int min_index, i, j;
751 752
    uint32_t min_count, *l2_table, tmp = 0;

F
Fam Zheng 已提交
753
    if (m_data) {
754
        m_data->valid = 0;
F
Fam Zheng 已提交
755
    }
756
    if (extent->flat) {
757
        *cluster_offset = extent->flat_start_offset;
758 759
        return 0;
    }
760

F
Fam Zheng 已提交
761
    offset -= (extent->end_sector - extent->sectors) * SECTOR_SIZE;
F
Fam Zheng 已提交
762 763
    l1_index = (offset >> 9) / extent->l1_entry_sectors;
    if (l1_index >= extent->l1_size) {
764
        return -1;
F
Fam Zheng 已提交
765 766 767
    }
    l2_offset = extent->l1_table[l1_index];
    if (!l2_offset) {
768
        return -1;
F
Fam Zheng 已提交
769
    }
770
    for (i = 0; i < L2_CACHE_SIZE; i++) {
F
Fam Zheng 已提交
771
        if (l2_offset == extent->l2_cache_offsets[i]) {
B
bellard 已提交
772
            /* increment the hit count */
F
Fam Zheng 已提交
773
            if (++extent->l2_cache_counts[i] == 0xffffffff) {
774
                for (j = 0; j < L2_CACHE_SIZE; j++) {
F
Fam Zheng 已提交
775
                    extent->l2_cache_counts[j] >>= 1;
B
bellard 已提交
776 777
                }
            }
F
Fam Zheng 已提交
778
            l2_table = extent->l2_cache + (i * extent->l2_size);
B
bellard 已提交
779 780 781 782 783 784
            goto found;
        }
    }
    /* not found: load a new entry in the least used one */
    min_index = 0;
    min_count = 0xffffffff;
785
    for (i = 0; i < L2_CACHE_SIZE; i++) {
F
Fam Zheng 已提交
786 787
        if (extent->l2_cache_counts[i] < min_count) {
            min_count = extent->l2_cache_counts[i];
B
bellard 已提交
788 789 790
            min_index = i;
        }
    }
F
Fam Zheng 已提交
791 792 793 794 795 796 797
    l2_table = extent->l2_cache + (min_index * extent->l2_size);
    if (bdrv_pread(
                extent->file,
                (int64_t)l2_offset * 512,
                l2_table,
                extent->l2_size * sizeof(uint32_t)
            ) != extent->l2_size * sizeof(uint32_t)) {
798
        return -1;
F
Fam Zheng 已提交
799
    }
800

F
Fam Zheng 已提交
801 802
    extent->l2_cache_offsets[min_index] = l2_offset;
    extent->l2_cache_counts[min_index] = 1;
B
bellard 已提交
803
 found:
F
Fam Zheng 已提交
804
    l2_index = ((offset >> 9) / extent->cluster_sectors) % extent->l2_size;
805
    *cluster_offset = le32_to_cpu(l2_table[l2_index]);
806

807 808 809 810
    if (!*cluster_offset) {
        if (!allocate) {
            return -1;
        }
811

F
Fam Zheng 已提交
812
        /* Avoid the L2 tables update for the images that have snapshots. */
813
        *cluster_offset = bdrv_getlength(extent->file);
F
Fam Zheng 已提交
814 815 816 817 818 819
        if (!extent->compressed) {
            bdrv_truncate(
                extent->file,
                *cluster_offset + (extent->cluster_sectors << 9)
            );
        }
820

821 822
        *cluster_offset >>= 9;
        tmp = cpu_to_le32(*cluster_offset);
823
        l2_table[l2_index] = tmp;
824 825 826 827 828 829

        /* First of all we write grain itself, to avoid race condition
         * that may to corrupt the image.
         * This problem may occur because of insufficient space on host disk
         * or inappropriate VM shutdown.
         */
F
Fam Zheng 已提交
830
        if (get_whole_cluster(
F
Fam Zheng 已提交
831
                bs, extent, *cluster_offset, offset, allocate) == -1) {
832
            return -1;
F
Fam Zheng 已提交
833
        }
834 835 836 837 838 839 840 841

        if (m_data) {
            m_data->offset = tmp;
            m_data->l1_index = l1_index;
            m_data->l2_index = l2_index;
            m_data->l2_offset = l2_offset;
            m_data->valid = 1;
        }
842
    }
843 844
    *cluster_offset <<= 9;
    return 0;
B
bellard 已提交
845 846
}

F
Fam Zheng 已提交
847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
static VmdkExtent *find_extent(BDRVVmdkState *s,
                                int64_t sector_num, VmdkExtent *start_hint)
{
    VmdkExtent *extent = start_hint;

    if (!extent) {
        extent = &s->extents[0];
    }
    while (extent < &s->extents[s->num_extents]) {
        if (sector_num < extent->end_sector) {
            return extent;
        }
        extent++;
    }
    return NULL;
}

864 865
static int coroutine_fn vmdk_co_is_allocated(BlockDriverState *bs,
        int64_t sector_num, int nb_sectors, int *pnum)
B
bellard 已提交
866 867
{
    BDRVVmdkState *s = bs->opaque;
F
Fam Zheng 已提交
868 869 870 871 872 873 874 875
    int64_t index_in_cluster, n, ret;
    uint64_t offset;
    VmdkExtent *extent;

    extent = find_extent(s, sector_num, NULL);
    if (!extent) {
        return 0;
    }
876
    qemu_co_mutex_lock(&s->lock);
877 878
    ret = get_cluster_offset(bs, extent, NULL,
                            sector_num * 512, 0, &offset);
879
    qemu_co_mutex_unlock(&s->lock);
880 881 882 883 884
    /* get_cluster_offset returning 0 means success */
    ret = !ret;

    index_in_cluster = sector_num % extent->cluster_sectors;
    n = extent->cluster_sectors - index_in_cluster;
F
Fam Zheng 已提交
885
    if (n > nb_sectors) {
B
bellard 已提交
886
        n = nb_sectors;
F
Fam Zheng 已提交
887
    }
B
bellard 已提交
888
    *pnum = n;
F
Fam Zheng 已提交
889
    return ret;
B
bellard 已提交
890 891
}

892 893 894 895 896
static int vmdk_write_extent(VmdkExtent *extent, int64_t cluster_offset,
                            int64_t offset_in_cluster, const uint8_t *buf,
                            int nb_sectors, int64_t sector_num)
{
    int ret;
F
Fam Zheng 已提交
897 898
    VmdkGrainMarker *data = NULL;
    uLongf buf_len;
899 900 901
    const uint8_t *write_buf = buf;
    int write_len = nb_sectors * 512;

F
Fam Zheng 已提交
902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
    if (extent->compressed) {
        if (!extent->has_marker) {
            ret = -EINVAL;
            goto out;
        }
        buf_len = (extent->cluster_sectors << 9) * 2;
        data = g_malloc(buf_len + sizeof(VmdkGrainMarker));
        if (compress(data->data, &buf_len, buf, nb_sectors << 9) != Z_OK ||
                buf_len == 0) {
            ret = -EINVAL;
            goto out;
        }
        data->lba = sector_num;
        data->size = buf_len;
        write_buf = (uint8_t *)data;
        write_len = buf_len + sizeof(VmdkGrainMarker);
    }
919 920 921 922 923 924 925 926 927 928
    ret = bdrv_pwrite(extent->file,
                        cluster_offset + offset_in_cluster,
                        write_buf,
                        write_len);
    if (ret != write_len) {
        ret = ret < 0 ? ret : -EIO;
        goto out;
    }
    ret = 0;
 out:
F
Fam Zheng 已提交
929
    g_free(data);
930 931 932 933 934 935 936 937
    return ret;
}

static int vmdk_read_extent(VmdkExtent *extent, int64_t cluster_offset,
                            int64_t offset_in_cluster, uint8_t *buf,
                            int nb_sectors)
{
    int ret;
F
Fam Zheng 已提交
938 939 940 941 942 943 944
    int cluster_bytes, buf_bytes;
    uint8_t *cluster_buf, *compressed_data;
    uint8_t *uncomp_buf;
    uint32_t data_len;
    VmdkGrainMarker *marker;
    uLongf buf_len;

945

F
Fam Zheng 已提交
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
    if (!extent->compressed) {
        ret = bdrv_pread(extent->file,
                          cluster_offset + offset_in_cluster,
                          buf, nb_sectors * 512);
        if (ret == nb_sectors * 512) {
            return 0;
        } else {
            return -EIO;
        }
    }
    cluster_bytes = extent->cluster_sectors * 512;
    /* Read two clusters in case GrainMarker + compressed data > one cluster */
    buf_bytes = cluster_bytes * 2;
    cluster_buf = g_malloc(buf_bytes);
    uncomp_buf = g_malloc(cluster_bytes);
961
    ret = bdrv_pread(extent->file,
F
Fam Zheng 已提交
962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988
                cluster_offset,
                cluster_buf, buf_bytes);
    if (ret < 0) {
        goto out;
    }
    compressed_data = cluster_buf;
    buf_len = cluster_bytes;
    data_len = cluster_bytes;
    if (extent->has_marker) {
        marker = (VmdkGrainMarker *)cluster_buf;
        compressed_data = marker->data;
        data_len = le32_to_cpu(marker->size);
    }
    if (!data_len || data_len > buf_bytes) {
        ret = -EINVAL;
        goto out;
    }
    ret = uncompress(uncomp_buf, &buf_len, compressed_data, data_len);
    if (ret != Z_OK) {
        ret = -EINVAL;
        goto out;

    }
    if (offset_in_cluster < 0 ||
            offset_in_cluster + nb_sectors * 512 > buf_len) {
        ret = -EINVAL;
        goto out;
989
    }
F
Fam Zheng 已提交
990 991 992 993 994 995 996
    memcpy(buf, uncomp_buf + offset_in_cluster, nb_sectors * 512);
    ret = 0;

 out:
    g_free(uncomp_buf);
    g_free(cluster_buf);
    return ret;
997 998
}

999
static int vmdk_read(BlockDriverState *bs, int64_t sector_num,
B
bellard 已提交
1000 1001 1002
                    uint8_t *buf, int nb_sectors)
{
    BDRVVmdkState *s = bs->opaque;
F
Fam Zheng 已提交
1003 1004 1005
    int ret;
    uint64_t n, index_in_cluster;
    VmdkExtent *extent = NULL;
B
bellard 已提交
1006
    uint64_t cluster_offset;
1007

B
bellard 已提交
1008
    while (nb_sectors > 0) {
F
Fam Zheng 已提交
1009 1010 1011 1012
        extent = find_extent(s, sector_num, extent);
        if (!extent) {
            return -EIO;
        }
1013 1014 1015
        ret = get_cluster_offset(
                            bs, extent, NULL,
                            sector_num << 9, 0, &cluster_offset);
F
Fam Zheng 已提交
1016 1017
        index_in_cluster = sector_num % extent->cluster_sectors;
        n = extent->cluster_sectors - index_in_cluster;
F
Fam Zheng 已提交
1018
        if (n > nb_sectors) {
B
bellard 已提交
1019
            n = nb_sectors;
F
Fam Zheng 已提交
1020
        }
1021 1022
        if (ret) {
            /* if not allocated, try to read from parent image, if exist */
K
Kevin Wolf 已提交
1023
            if (bs->backing_hd) {
F
Fam Zheng 已提交
1024
                if (!vmdk_is_cid_valid(bs)) {
1025
                    return -EINVAL;
F
Fam Zheng 已提交
1026
                }
K
Kevin Wolf 已提交
1027
                ret = bdrv_read(bs->backing_hd, sector_num, buf, n);
F
Fam Zheng 已提交
1028
                if (ret < 0) {
1029
                    return ret;
F
Fam Zheng 已提交
1030
                }
1031 1032 1033
            } else {
                memset(buf, 0, 512 * n);
            }
B
bellard 已提交
1034
        } else {
1035 1036 1037 1038
            ret = vmdk_read_extent(extent,
                            cluster_offset, index_in_cluster * 512,
                            buf, n);
            if (ret) {
1039 1040
                return ret;
            }
B
bellard 已提交
1041 1042 1043 1044 1045 1046 1047 1048
        }
        nb_sectors -= n;
        sector_num += n;
        buf += n * 512;
    }
    return 0;
}

1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
static coroutine_fn int vmdk_co_read(BlockDriverState *bs, int64_t sector_num,
                                     uint8_t *buf, int nb_sectors)
{
    int ret;
    BDRVVmdkState *s = bs->opaque;
    qemu_co_mutex_lock(&s->lock);
    ret = vmdk_read(bs, sector_num, buf, nb_sectors);
    qemu_co_mutex_unlock(&s->lock);
    return ret;
}

1060
static int vmdk_write(BlockDriverState *bs, int64_t sector_num,
B
bellard 已提交
1061 1062
                     const uint8_t *buf, int nb_sectors)
{
1063
    BDRVVmdkState *s = bs->opaque;
F
Fam Zheng 已提交
1064
    VmdkExtent *extent = NULL;
1065
    int n, ret;
F
Fam Zheng 已提交
1066
    int64_t index_in_cluster;
1067
    uint64_t cluster_offset;
F
Fam Zheng 已提交
1068
    VmdkMetaData m_data;
1069

1070 1071
    if (sector_num > bs->total_sectors) {
        fprintf(stderr,
1072 1073
                "(VMDK) Wrong offset: sector_num=0x%" PRIx64
                " total_sectors=0x%" PRIx64 "\n",
1074
                sector_num, bs->total_sectors);
1075
        return -EIO;
1076 1077
    }

1078
    while (nb_sectors > 0) {
F
Fam Zheng 已提交
1079 1080 1081 1082
        extent = find_extent(s, sector_num, extent);
        if (!extent) {
            return -EIO;
        }
1083
        ret = get_cluster_offset(
F
Fam Zheng 已提交
1084 1085 1086
                                bs,
                                extent,
                                &m_data,
F
Fam Zheng 已提交
1087
                                sector_num << 9, !extent->compressed,
1088
                                &cluster_offset);
F
Fam Zheng 已提交
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
        if (extent->compressed) {
            if (ret == 0) {
                /* Refuse write to allocated cluster for streamOptimized */
                fprintf(stderr,
                        "VMDK: can't write to allocated cluster"
                        " for streamOptimized\n");
                return -EIO;
            } else {
                /* allocate */
                ret = get_cluster_offset(
                                        bs,
                                        extent,
                                        &m_data,
                                        sector_num << 9, 1,
                                        &cluster_offset);
            }
        }
1106 1107
        if (ret) {
            return -EINVAL;
F
Fam Zheng 已提交
1108 1109 1110 1111 1112 1113
        }
        index_in_cluster = sector_num % extent->cluster_sectors;
        n = extent->cluster_sectors - index_in_cluster;
        if (n > nb_sectors) {
            n = nb_sectors;
        }
1114

1115 1116 1117 1118
        ret = vmdk_write_extent(extent,
                        cluster_offset, index_in_cluster * 512,
                        buf, n, sector_num);
        if (ret) {
1119
            return ret;
F
Fam Zheng 已提交
1120
        }
1121 1122
        if (m_data.valid) {
            /* update L2 tables */
F
Fam Zheng 已提交
1123
            if (vmdk_L2update(extent, &m_data) == -1) {
1124
                return -EIO;
F
Fam Zheng 已提交
1125
            }
1126
        }
1127 1128 1129
        nb_sectors -= n;
        sector_num += n;
        buf += n * 512;
1130

F
Fam Zheng 已提交
1131 1132
        /* update CID on the first write every time the virtual disk is
         * opened */
1133
        if (!s->cid_updated) {
K
Kevin Wolf 已提交
1134 1135 1136 1137
            ret = vmdk_write_cid(bs, time(NULL));
            if (ret < 0) {
                return ret;
            }
1138
            s->cid_updated = true;
1139
        }
1140 1141
    }
    return 0;
B
bellard 已提交
1142 1143
}

1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
static coroutine_fn int vmdk_co_write(BlockDriverState *bs, int64_t sector_num,
                                      const uint8_t *buf, int nb_sectors)
{
    int ret;
    BDRVVmdkState *s = bs->opaque;
    qemu_co_mutex_lock(&s->lock);
    ret = vmdk_write(bs, sector_num, buf, nb_sectors);
    qemu_co_mutex_unlock(&s->lock);
    return ret;
}

F
Fam Zheng 已提交
1155

1156 1157
static int vmdk_create_extent(const char *filename, int64_t filesize,
                              bool flat, bool compress)
1158
{
F
Fam Zheng 已提交
1159 1160
    int ret, i;
    int fd = 0;
1161 1162
    VMDK4Header header;
    uint32_t tmp, magic, grains, gd_size, gt_size, gt_count;
1163

1164 1165 1166
    fd = qemu_open(filename,
                   O_WRONLY | O_CREAT | O_TRUNC | O_BINARY | O_LARGEFILE,
                   0644);
F
Fam Zheng 已提交
1167 1168
    if (fd < 0) {
        return -errno;
1169
    }
F
Fam Zheng 已提交
1170 1171 1172 1173 1174 1175
    if (flat) {
        ret = ftruncate(fd, filesize);
        if (ret < 0) {
            ret = -errno;
        }
        goto exit;
1176
    }
1177 1178
    magic = cpu_to_be32(VMDK4_MAGIC);
    memset(&header, 0, sizeof(header));
A
Alexander Graf 已提交
1179
    header.version = 1;
1180 1181 1182
    header.flags =
        3 | (compress ? VMDK4_FLAG_COMPRESS | VMDK4_FLAG_MARKER : 0);
    header.compressAlgorithm = compress ? VMDK4_COMPRESSION_DEFLATE : 0;
F
Fam Zheng 已提交
1183
    header.capacity = filesize / 512;
A
Alexander Graf 已提交
1184 1185
    header.granularity = 128;
    header.num_gtes_per_gte = 512;
1186

F
Fam Zheng 已提交
1187
    grains = (filesize / 512 + header.granularity - 1) / header.granularity;
1188
    gt_size = ((header.num_gtes_per_gte * sizeof(uint32_t)) + 511) >> 9;
F
Fam Zheng 已提交
1189 1190
    gt_count =
        (grains + header.num_gtes_per_gte - 1) / header.num_gtes_per_gte;
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
    gd_size = (gt_count * sizeof(uint32_t) + 511) >> 9;

    header.desc_offset = 1;
    header.desc_size = 20;
    header.rgd_offset = header.desc_offset + header.desc_size;
    header.gd_offset = header.rgd_offset + gd_size + (gt_size * gt_count);
    header.grain_offset =
       ((header.gd_offset + gd_size + (gt_size * gt_count) +
         header.granularity - 1) / header.granularity) *
        header.granularity;
A
Alexander Graf 已提交
1201 1202 1203 1204 1205 1206
    /* swap endianness for all header fields */
    header.version = cpu_to_le32(header.version);
    header.flags = cpu_to_le32(header.flags);
    header.capacity = cpu_to_le64(header.capacity);
    header.granularity = cpu_to_le64(header.granularity);
    header.num_gtes_per_gte = cpu_to_le32(header.num_gtes_per_gte);
1207 1208 1209 1210 1211
    header.desc_offset = cpu_to_le64(header.desc_offset);
    header.desc_size = cpu_to_le64(header.desc_size);
    header.rgd_offset = cpu_to_le64(header.rgd_offset);
    header.gd_offset = cpu_to_le64(header.gd_offset);
    header.grain_offset = cpu_to_le64(header.grain_offset);
1212
    header.compressAlgorithm = cpu_to_le16(header.compressAlgorithm);
1213 1214 1215 1216 1217

    header.check_bytes[0] = 0xa;
    header.check_bytes[1] = 0x20;
    header.check_bytes[2] = 0xd;
    header.check_bytes[3] = 0xa;
1218 1219

    /* write all the data */
1220 1221
    ret = qemu_write_full(fd, &magic, sizeof(magic));
    if (ret != sizeof(magic)) {
J
Juan Quintela 已提交
1222
        ret = -errno;
1223 1224 1225 1226
        goto exit;
    }
    ret = qemu_write_full(fd, &header, sizeof(header));
    if (ret != sizeof(header)) {
J
Juan Quintela 已提交
1227
        ret = -errno;
1228 1229
        goto exit;
    }
1230

A
Alexander Graf 已提交
1231
    ret = ftruncate(fd, le64_to_cpu(header.grain_offset) << 9);
1232
    if (ret < 0) {
J
Juan Quintela 已提交
1233
        ret = -errno;
1234 1235
        goto exit;
    }
1236 1237 1238

    /* write grain directory */
    lseek(fd, le64_to_cpu(header.rgd_offset) << 9, SEEK_SET);
A
Alexander Graf 已提交
1239
    for (i = 0, tmp = le64_to_cpu(header.rgd_offset) + gd_size;
1240 1241 1242
         i < gt_count; i++, tmp += gt_size) {
        ret = qemu_write_full(fd, &tmp, sizeof(tmp));
        if (ret != sizeof(tmp)) {
J
Juan Quintela 已提交
1243
            ret = -errno;
1244 1245 1246
            goto exit;
        }
    }
1247

1248 1249
    /* write backup grain directory */
    lseek(fd, le64_to_cpu(header.gd_offset) << 9, SEEK_SET);
A
Alexander Graf 已提交
1250
    for (i = 0, tmp = le64_to_cpu(header.gd_offset) + gd_size;
1251 1252 1253
         i < gt_count; i++, tmp += gt_size) {
        ret = qemu_write_full(fd, &tmp, sizeof(tmp));
        if (ret != sizeof(tmp)) {
J
Juan Quintela 已提交
1254
            ret = -errno;
1255 1256 1257
            goto exit;
        }
    }
1258

F
Fam Zheng 已提交
1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353
    ret = 0;
 exit:
    close(fd);
    return ret;
}

static int filename_decompose(const char *filename, char *path, char *prefix,
        char *postfix, size_t buf_len)
{
    const char *p, *q;

    if (filename == NULL || !strlen(filename)) {
        fprintf(stderr, "Vmdk: no filename provided.\n");
        return -1;
    }
    p = strrchr(filename, '/');
    if (p == NULL) {
        p = strrchr(filename, '\\');
    }
    if (p == NULL) {
        p = strrchr(filename, ':');
    }
    if (p != NULL) {
        p++;
        if (p - filename >= buf_len) {
            return -1;
        }
        pstrcpy(path, p - filename + 1, filename);
    } else {
        p = filename;
        path[0] = '\0';
    }
    q = strrchr(p, '.');
    if (q == NULL) {
        pstrcpy(prefix, buf_len, p);
        postfix[0] = '\0';
    } else {
        if (q - p >= buf_len) {
            return -1;
        }
        pstrcpy(prefix, q - p + 1, p);
        pstrcpy(postfix, buf_len, q);
    }
    return 0;
}

static int relative_path(char *dest, int dest_size,
        const char *base, const char *target)
{
    int i = 0;
    int n = 0;
    const char *p, *q;
#ifdef _WIN32
    const char *sep = "\\";
#else
    const char *sep = "/";
#endif

    if (!(dest && base && target)) {
        return -1;
    }
    if (path_is_absolute(target)) {
        dest[dest_size - 1] = '\0';
        strncpy(dest, target, dest_size - 1);
        return 0;
    }
    while (base[i] == target[i]) {
        i++;
    }
    p = &base[i];
    q = &target[i];
    while (*p) {
        if (*p == *sep) {
            n++;
        }
        p++;
    }
    dest[0] = '\0';
    for (; n; n--) {
        pstrcat(dest, dest_size, "..");
        pstrcat(dest, dest_size, sep);
    }
    pstrcat(dest, dest_size, q);
    return 0;
}

static int vmdk_create(const char *filename, QEMUOptionParameter *options)
{
    int fd, idx = 0;
    char desc[BUF_SIZE];
    int64_t total_size = 0, filesize;
    const char *backing_file = NULL;
    const char *fmt = NULL;
    int flags = 0;
    int ret = 0;
1354
    bool flat, split, compress;
F
Fam Zheng 已提交
1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402
    char ext_desc_lines[BUF_SIZE] = "";
    char path[PATH_MAX], prefix[PATH_MAX], postfix[PATH_MAX];
    const int64_t split_size = 0x80000000;  /* VMDK has constant split size */
    const char *desc_extent_line;
    char parent_desc_line[BUF_SIZE] = "";
    uint32_t parent_cid = 0xffffffff;
    const char desc_template[] =
        "# Disk DescriptorFile\n"
        "version=1\n"
        "CID=%x\n"
        "parentCID=%x\n"
        "createType=\"%s\"\n"
        "%s"
        "\n"
        "# Extent description\n"
        "%s"
        "\n"
        "# The Disk Data Base\n"
        "#DDB\n"
        "\n"
        "ddb.virtualHWVersion = \"%d\"\n"
        "ddb.geometry.cylinders = \"%" PRId64 "\"\n"
        "ddb.geometry.heads = \"16\"\n"
        "ddb.geometry.sectors = \"63\"\n"
        "ddb.adapterType = \"ide\"\n";

    if (filename_decompose(filename, path, prefix, postfix, PATH_MAX)) {
        return -EINVAL;
    }
    /* Read out options */
    while (options && options->name) {
        if (!strcmp(options->name, BLOCK_OPT_SIZE)) {
            total_size = options->value.n;
        } else if (!strcmp(options->name, BLOCK_OPT_BACKING_FILE)) {
            backing_file = options->value.s;
        } else if (!strcmp(options->name, BLOCK_OPT_COMPAT6)) {
            flags |= options->value.n ? BLOCK_FLAG_COMPAT6 : 0;
        } else if (!strcmp(options->name, BLOCK_OPT_SUBFMT)) {
            fmt = options->value.s;
        }
        options++;
    }
    if (!fmt) {
        /* Default format to monolithicSparse */
        fmt = "monolithicSparse";
    } else if (strcmp(fmt, "monolithicFlat") &&
               strcmp(fmt, "monolithicSparse") &&
               strcmp(fmt, "twoGbMaxExtentSparse") &&
1403 1404
               strcmp(fmt, "twoGbMaxExtentFlat") &&
               strcmp(fmt, "streamOptimized")) {
F
Fam Zheng 已提交
1405 1406 1407 1408 1409 1410 1411
        fprintf(stderr, "VMDK: Unknown subformat: %s\n", fmt);
        return -EINVAL;
    }
    split = !(strcmp(fmt, "twoGbMaxExtentFlat") &&
              strcmp(fmt, "twoGbMaxExtentSparse"));
    flat = !(strcmp(fmt, "monolithicFlat") &&
             strcmp(fmt, "twoGbMaxExtentFlat"));
1412
    compress = !strcmp(fmt, "streamOptimized");
F
Fam Zheng 已提交
1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465
    if (flat) {
        desc_extent_line = "RW %lld FLAT \"%s\" 0\n";
    } else {
        desc_extent_line = "RW %lld SPARSE \"%s\"\n";
    }
    if (flat && backing_file) {
        /* not supporting backing file for flat image */
        return -ENOTSUP;
    }
    if (backing_file) {
        char parent_filename[PATH_MAX];
        BlockDriverState *bs = bdrv_new("");
        ret = bdrv_open(bs, backing_file, 0, NULL);
        if (ret != 0) {
            bdrv_delete(bs);
            return ret;
        }
        if (strcmp(bs->drv->format_name, "vmdk")) {
            bdrv_delete(bs);
            return -EINVAL;
        }
        parent_cid = vmdk_read_cid(bs, 0);
        bdrv_delete(bs);
        relative_path(parent_filename, sizeof(parent_filename),
                      filename, backing_file);
        snprintf(parent_desc_line, sizeof(parent_desc_line),
                "parentFileNameHint=\"%s\"", parent_filename);
    }

    /* Create extents */
    filesize = total_size;
    while (filesize > 0) {
        char desc_line[BUF_SIZE];
        char ext_filename[PATH_MAX];
        char desc_filename[PATH_MAX];
        int64_t size = filesize;

        if (split && size > split_size) {
            size = split_size;
        }
        if (split) {
            snprintf(desc_filename, sizeof(desc_filename), "%s-%c%03d%s",
                    prefix, flat ? 'f' : 's', ++idx, postfix);
        } else if (flat) {
            snprintf(desc_filename, sizeof(desc_filename), "%s-flat%s",
                    prefix, postfix);
        } else {
            snprintf(desc_filename, sizeof(desc_filename), "%s%s",
                    prefix, postfix);
        }
        snprintf(ext_filename, sizeof(ext_filename), "%s%s",
                path, desc_filename);

1466
        if (vmdk_create_extent(ext_filename, size, flat, compress)) {
F
Fam Zheng 已提交
1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485
            return -EINVAL;
        }
        filesize -= size;

        /* Format description line */
        snprintf(desc_line, sizeof(desc_line),
                    desc_extent_line, size / 512, desc_filename);
        pstrcat(ext_desc_lines, sizeof(ext_desc_lines), desc_line);
    }
    /* generate descriptor file */
    snprintf(desc, sizeof(desc), desc_template,
            (unsigned int)time(NULL),
            parent_cid,
            fmt,
            parent_desc_line,
            ext_desc_lines,
            (flags & BLOCK_FLAG_COMPAT6 ? 6 : 4),
            total_size / (int64_t)(63 * 16 * 512));
    if (split || flat) {
1486 1487 1488
        fd = qemu_open(filename,
                       O_WRONLY | O_CREAT | O_TRUNC | O_BINARY | O_LARGEFILE,
                       0644);
F
Fam Zheng 已提交
1489
    } else {
1490 1491 1492
        fd = qemu_open(filename,
                       O_WRONLY | O_BINARY | O_LARGEFILE,
                       0644);
F
Fam Zheng 已提交
1493 1494 1495 1496 1497 1498 1499 1500 1501
    }
    if (fd < 0) {
        return -errno;
    }
    /* the descriptor offset = 0x200 */
    if (!split && !flat && 0x200 != lseek(fd, 0x200, SEEK_SET)) {
        ret = -errno;
        goto exit;
    }
1502 1503
    ret = qemu_write_full(fd, desc, strlen(desc));
    if (ret != strlen(desc)) {
J
Juan Quintela 已提交
1504
        ret = -errno;
1505 1506 1507 1508
        goto exit;
    }
    ret = 0;
exit:
1509
    close(fd);
1510
    return ret;
1511 1512
}

B
bellard 已提交
1513
static void vmdk_close(BlockDriverState *bs)
B
bellard 已提交
1514
{
K
Kevin Wolf 已提交
1515 1516
    BDRVVmdkState *s = bs->opaque;

F
Fam Zheng 已提交
1517
    vmdk_free_extents(bs);
K
Kevin Wolf 已提交
1518 1519 1520

    migrate_del_blocker(s->migration_blocker);
    error_free(s->migration_blocker);
B
bellard 已提交
1521 1522
}

P
Paolo Bonzini 已提交
1523
static coroutine_fn int vmdk_co_flush(BlockDriverState *bs)
P
pbrook 已提交
1524
{
F
Fam Zheng 已提交
1525
    BDRVVmdkState *s = bs->opaque;
1526 1527
    int i, err;
    int ret = 0;
F
Fam Zheng 已提交
1528 1529

    for (i = 0; i < s->num_extents; i++) {
P
Paolo Bonzini 已提交
1530
        err = bdrv_co_flush(s->extents[i].file);
F
Fam Zheng 已提交
1531 1532 1533 1534 1535
        if (err < 0) {
            ret = err;
        }
    }
    return ret;
P
pbrook 已提交
1536 1537
}

1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560
static int64_t vmdk_get_allocated_file_size(BlockDriverState *bs)
{
    int i;
    int64_t ret = 0;
    int64_t r;
    BDRVVmdkState *s = bs->opaque;

    ret = bdrv_get_allocated_file_size(bs->file);
    if (ret < 0) {
        return ret;
    }
    for (i = 0; i < s->num_extents; i++) {
        if (s->extents[i].file == bs->file) {
            continue;
        }
        r = bdrv_get_allocated_file_size(s->extents[i].file);
        if (r < 0) {
            return r;
        }
        ret += r;
    }
    return ret;
}
1561 1562

static QEMUOptionParameter vmdk_create_options[] = {
1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577
    {
        .name = BLOCK_OPT_SIZE,
        .type = OPT_SIZE,
        .help = "Virtual disk size"
    },
    {
        .name = BLOCK_OPT_BACKING_FILE,
        .type = OPT_STRING,
        .help = "File name of a base image"
    },
    {
        .name = BLOCK_OPT_COMPAT6,
        .type = OPT_FLAG,
        .help = "VMDK version 6 image"
    },
F
Fam Zheng 已提交
1578 1579 1580 1581 1582
    {
        .name = BLOCK_OPT_SUBFMT,
        .type = OPT_STRING,
        .help =
            "VMDK flat extent format, can be one of "
1583
            "{monolithicSparse (default) | monolithicFlat | twoGbMaxExtentSparse | twoGbMaxExtentFlat | streamOptimized} "
F
Fam Zheng 已提交
1584
    },
1585 1586 1587
    { NULL }
};

1588
static BlockDriver bdrv_vmdk = {
F
Fam Zheng 已提交
1589 1590 1591
    .format_name    = "vmdk",
    .instance_size  = sizeof(BDRVVmdkState),
    .bdrv_probe     = vmdk_probe,
K
Kevin Wolf 已提交
1592
    .bdrv_open      = vmdk_open,
1593
    .bdrv_read      = vmdk_co_read,
1594
    .bdrv_write     = vmdk_co_write,
F
Fam Zheng 已提交
1595 1596
    .bdrv_close     = vmdk_close,
    .bdrv_create    = vmdk_create,
1597
    .bdrv_co_flush_to_disk  = vmdk_co_flush,
1598
    .bdrv_co_is_allocated   = vmdk_co_is_allocated,
1599
    .bdrv_get_allocated_file_size  = vmdk_get_allocated_file_size,
1600 1601

    .create_options = vmdk_create_options,
B
bellard 已提交
1602
};
1603 1604 1605 1606 1607 1608 1609

static void bdrv_vmdk_init(void)
{
    bdrv_register(&bdrv_vmdk);
}

block_init(bdrv_vmdk_init);