block/vdi.c

   1 /*
   2  * Block driver for the Virtual Disk Image (VDI) format
   3  *
   4  * Copyright (c) 2009, 2012 Stefan Weil
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 2 of the License, or
   9  * (at your option) version 3 or any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  *
  19  * Reference:
  20  * http://forums.virtualbox.org/viewtopic.php?t=8046
  21  *
  22  * This driver supports create / read / write operations on VDI images.
  23  *
  24  * Todo (see also TODO in code):
  25  *
  26  * Some features like snapshots are still missing.
  27  *
  28  * Deallocation of zero-filled blocks and shrinking images are missing, too
  29  * (might be added to common block layer).
  30  *
  31  * Allocation of blocks could be optimized (less writes to block map and
  32  * header).
  33  *
  34  * Read and write of adjacent blocks could be done in one operation
  35  * (current code uses one operation per block (1 MiB).
  36  *
  37  * The code is not thread safe (missing locks for changes in header and
  38  * block table, no problem with current QEMU).
  39  *
  40  * Hints:
  41  *
  42  * Blocks (VDI documentation) correspond to clusters (QEMU).
  43  * QEMU's backing files could be implemented using VDI snapshot files (TODO).
  44  * VDI snapshot files may also contain the complete machine state.
  45  * Maybe this machine state can be converted to QEMU PC machine snapshot data.
  46  *
  47  * The driver keeps a block cache (little endian entries) in memory.
  48  * For the standard block size (1 MiB), a 1 TiB disk will use 4 MiB RAM,
  49  * so this seems to be reasonable.
  50  */
  51
  52 #include "qemu-common.h"
  53 #include "block/block_int.h"
  54 #include "qemu/module.h"
  55 #include "migration/migration.h"
  56
  57 #if defined(CONFIG_UUID)
  58 #include <uuid/uuid.h>
  59 #else
  60 /* TODO: move uuid emulation to some central place in QEMU. */
  61 #include "sysemu/sysemu.h"     /* UUID_FMT */
  62 typedef unsigned char uuid_t[16];
  63 #endif
  64
  65 /* Code configuration options. */
  66
  67 /* Enable debug messages. */
  68 //~ #define CONFIG_VDI_DEBUG
  69
  70 /* Support write operations on VDI images. */
  71 #define CONFIG_VDI_WRITE
  72
  73 /* Support non-standard block (cluster) size. This is untested.
  74  * Maybe it will be needed for very large images.
  75  */
  76 //~ #define CONFIG_VDI_BLOCK_SIZE
  77
  78 /* Support static (fixed, pre-allocated) images. */
  79 #define CONFIG_VDI_STATIC_IMAGE
  80
  81 /* Command line option for static images. */
  82 #define BLOCK_OPT_STATIC "static"
  83
  84 #define KiB     1024
  85 #define MiB     (KiB * KiB)
  86
  87 #define SECTOR_SIZE 512
  88 #define DEFAULT_CLUSTER_SIZE (1 * MiB)
  89
  90 #if defined(CONFIG_VDI_DEBUG)
  91 #define logout(fmt, ...) \
  92                 fprintf(stderr, "vdi\t%-24s" fmt, __func__, ##__VA_ARGS__)
  93 #else
  94 #define logout(fmt, ...) ((void)0)
  95 #endif
  96
  97 /* Image signature. */
  98 #define VDI_SIGNATURE 0xbeda107f
  99
 100 /* Image version. */
 101 #define VDI_VERSION_1_1 0x00010001
 102
 103 /* Image type. */
 104 #define VDI_TYPE_DYNAMIC 1
 105 #define VDI_TYPE_STATIC  2
 106
 107 /* Innotek / SUN images use these strings in header.text:
 108  * "<<< innotek VirtualBox Disk Image >>>\n"
 109  * "<<< Sun xVM VirtualBox Disk Image >>>\n"
 110  * "<<< Sun VirtualBox Disk Image >>>\n"
 111  * The value does not matter, so QEMU created images use a different text.
 112  */
 113 #define VDI_TEXT "<<< QEMU VM Virtual Disk Image >>>\n"
 114
 115 /* A never-allocated block; semantically arbitrary content. */
 116 #define VDI_UNALLOCATED 0xffffffffU
 117
 118 /* A discarded (no longer allocated) block; semantically zero-filled. */
 119 #define VDI_DISCARDED   0xfffffffeU
 120
 121 #define VDI_IS_ALLOCATED(X) ((X) < VDI_DISCARDED)
 122
 123 /* max blocks in image is (0xffffffff / 4) */
 124 #define VDI_BLOCKS_IN_IMAGE_MAX  0x3fffffff
 125 #define VDI_DISK_SIZE_MAX        ((uint64_t)VDI_BLOCKS_IN_IMAGE_MAX * \
 126                                   (uint64_t)DEFAULT_CLUSTER_SIZE)
 127
 128 #if !defined(CONFIG_UUID)
 129 static inline void uuid_generate(uuid_t out)
 130 {
 131     memset(out, 0, sizeof(uuid_t));
 132 }
 133
 134 static inline int uuid_is_null(const uuid_t uu)
 135 {
 136     uuid_t null_uuid = { 0 };
 137     return memcmp(uu, null_uuid, sizeof(uuid_t)) == 0;
 138 }
 139
 140 static inline void uuid_unparse(const uuid_t uu, char *out)
 141 {
 142     snprintf(out, 37, UUID_FMT,
 143             uu[0], uu[1], uu[2], uu[3], uu[4], uu[5], uu[6], uu[7],
 144             uu[8], uu[9], uu[10], uu[11], uu[12], uu[13], uu[14], uu[15]);
 145 }
 146 #endif
 147
 148 typedef struct {
 149     char text[0x40];
 150     uint32_t signature;
 151     uint32_t version;
 152     uint32_t header_size;
 153     uint32_t image_type;
 154     uint32_t image_flags;
 155     char description[256];
 156     uint32_t offset_bmap;
 157     uint32_t offset_data;
 158     uint32_t cylinders;         /* disk geometry, unused here */
 159     uint32_t heads;             /* disk geometry, unused here */
 160     uint32_t sectors;           /* disk geometry, unused here */
 161     uint32_t sector_size;
 162     uint32_t unused1;
 163     uint64_t disk_size;
 164     uint32_t block_size;
 165     uint32_t block_extra;       /* unused here */
 166     uint32_t blocks_in_image;
 167     uint32_t blocks_allocated;
 168     uuid_t uuid_image;
 169     uuid_t uuid_last_snap;
 170     uuid_t uuid_link;
 171     uuid_t uuid_parent;
 172     uint64_t unused2[7];
 173 } QEMU_PACKED VdiHeader;
 174
 175 typedef struct {
 176     /* The block map entries are little endian (even in memory). */
 177     uint32_t *bmap;
 178     /* Size of block (bytes). */
 179     uint32_t block_size;
 180     /* Size of block (sectors). */
 181     uint32_t block_sectors;
 182     /* First sector of block map. */
 183     uint32_t bmap_sector;
 184     /* VDI header (converted to host endianness). */
 185     VdiHeader header;
 186
 187     Error *migration_blocker;
 188 } BDRVVdiState;
 189
 190 /* Change UUID from little endian (IPRT = VirtualBox format) to big endian
 191  * format (network byte order, standard, see RFC 4122) and vice versa.
 192  */
 193 static void uuid_convert(uuid_t uuid)
 194 {
 195     bswap32s((uint32_t *)&uuid[0]);
 196     bswap16s((uint16_t *)&uuid[4]);
 197     bswap16s((uint16_t *)&uuid[6]);
 198 }
 199
 200 static void vdi_header_to_cpu(VdiHeader *header)
 201 {
 202     le32_to_cpus(&header->signature);
 203     le32_to_cpus(&header->version);
 204     le32_to_cpus(&header->header_size);
 205     le32_to_cpus(&header->image_type);
 206     le32_to_cpus(&header->image_flags);
 207     le32_to_cpus(&header->offset_bmap);
 208     le32_to_cpus(&header->offset_data);
 209     le32_to_cpus(&header->cylinders);
 210     le32_to_cpus(&header->heads);
 211     le32_to_cpus(&header->sectors);
 212     le32_to_cpus(&header->sector_size);
 213     le64_to_cpus(&header->disk_size);
 214     le32_to_cpus(&header->block_size);
 215     le32_to_cpus(&header->block_extra);
 216     le32_to_cpus(&header->blocks_in_image);
 217     le32_to_cpus(&header->blocks_allocated);
 218     uuid_convert(header->uuid_image);
 219     uuid_convert(header->uuid_last_snap);
 220     uuid_convert(header->uuid_link);
 221     uuid_convert(header->uuid_parent);
 222 }
 223
 224 static void vdi_header_to_le(VdiHeader *header)
 225 {
 226     cpu_to_le32s(&header->signature);
 227     cpu_to_le32s(&header->version);
 228     cpu_to_le32s(&header->header_size);
 229     cpu_to_le32s(&header->image_type);
 230     cpu_to_le32s(&header->image_flags);
 231     cpu_to_le32s(&header->offset_bmap);
 232     cpu_to_le32s(&header->offset_data);
 233     cpu_to_le32s(&header->cylinders);
 234     cpu_to_le32s(&header->heads);
 235     cpu_to_le32s(&header->sectors);
 236     cpu_to_le32s(&header->sector_size);
 237     cpu_to_le64s(&header->disk_size);
 238     cpu_to_le32s(&header->block_size);
 239     cpu_to_le32s(&header->block_extra);
 240     cpu_to_le32s(&header->blocks_in_image);
 241     cpu_to_le32s(&header->blocks_allocated);
 242     cpu_to_le32s(&header->blocks_allocated);
 243     uuid_convert(header->uuid_image);
 244     uuid_convert(header->uuid_last_snap);
 245     uuid_convert(header->uuid_link);
 246     uuid_convert(header->uuid_parent);
 247 }
 248
 249 #if defined(CONFIG_VDI_DEBUG)
 250 static void vdi_header_print(VdiHeader *header)
 251 {
 252     char uuid[37];
 253     logout("text        %s", header->text);
 254     logout("signature   0x%08x\n", header->signature);
 255     logout("header size 0x%04x\n", header->header_size);
 256     logout("image type  0x%04x\n", header->image_type);
 257     logout("image flags 0x%04x\n", header->image_flags);
 258     logout("description %s\n", header->description);
 259     logout("offset bmap 0x%04x\n", header->offset_bmap);
 260     logout("offset data 0x%04x\n", header->offset_data);
 261     logout("cylinders   0x%04x\n", header->cylinders);
 262     logout("heads       0x%04x\n", header->heads);
 263     logout("sectors     0x%04x\n", header->sectors);
 264     logout("sector size 0x%04x\n", header->sector_size);
 265     logout("image size  0x%" PRIx64 " B (%" PRIu64 " MiB)\n",
 266            header->disk_size, header->disk_size / MiB);
 267     logout("block size  0x%04x\n", header->block_size);
 268     logout("block extra 0x%04x\n", header->block_extra);
 269     logout("blocks tot. 0x%04x\n", header->blocks_in_image);
 270     logout("blocks all. 0x%04x\n", header->blocks_allocated);
 271     uuid_unparse(header->uuid_image, uuid);
 272     logout("uuid image  %s\n", uuid);
 273     uuid_unparse(header->uuid_last_snap, uuid);
 274     logout("uuid snap   %s\n", uuid);
 275     uuid_unparse(header->uuid_link, uuid);
 276     logout("uuid link   %s\n", uuid);
 277     uuid_unparse(header->uuid_parent, uuid);
 278     logout("uuid parent %s\n", uuid);
 279 }
 280 #endif
 281
 282 static int vdi_check(BlockDriverState *bs, BdrvCheckResult *res,
 283                      BdrvCheckMode fix)
 284 {
 285     /* TODO: additional checks possible. */
 286     BDRVVdiState *s = (BDRVVdiState *)bs->opaque;
 287     uint32_t blocks_allocated = 0;
 288     uint32_t block;
 289     uint32_t *bmap;
 290     logout("\n");
 291
 292     if (fix) {
 293         return -ENOTSUP;
 294     }
 295
 296     bmap = g_malloc(s->header.blocks_in_image * sizeof(uint32_t));
 297     memset(bmap, 0xff, s->header.blocks_in_image * sizeof(uint32_t));
 298
 299     /* Check block map and value of blocks_allocated. */
 300     for (block = 0; block < s->header.blocks_in_image; block++) {
 301         uint32_t bmap_entry = le32_to_cpu(s->bmap[block]);
 302         if (VDI_IS_ALLOCATED(bmap_entry)) {
 303             if (bmap_entry < s->header.blocks_in_image) {
 304                 blocks_allocated++;
 305                 if (!VDI_IS_ALLOCATED(bmap[bmap_entry])) {
 306                     bmap[bmap_entry] = bmap_entry;
 307                 } else {
 308                     fprintf(stderr, "ERROR: block index %" PRIu32
 309                             " also used by %" PRIu32 "\n", bmap[bmap_entry], bmap_entry);
 310                     res->corruptions++;
 311                 }
 312             } else {
 313                 fprintf(stderr, "ERROR: block index %" PRIu32
 314                         " too large, is %" PRIu32 "\n", block, bmap_entry);
 315                 res->corruptions++;
 316             }
 317         }
 318     }
 319     if (blocks_allocated != s->header.blocks_allocated) {
 320         fprintf(stderr, "ERROR: allocated blocks mismatch, is %" PRIu32
 321                ", should be %" PRIu32 "\n",
 322                blocks_allocated, s->header.blocks_allocated);
 323         res->corruptions++;
 324     }
 325
 326     g_free(bmap);
 327
 328     return 0;
 329 }
 330
 331 static int vdi_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
 332 {
 333     /* TODO: vdi_get_info would be needed for machine snapshots.
 334        vm_state_offset is still missing. */
 335     BDRVVdiState *s = (BDRVVdiState *)bs->opaque;
 336     logout("\n");
 337     bdi->cluster_size = s->block_size;
 338     bdi->vm_state_offset = 0;
 339     bdi->unallocated_blocks_are_zero = true;
 340     return 0;
 341 }
 342
 343 static int vdi_make_empty(BlockDriverState *bs)
 344 {
 345     /* TODO: missing code. */
 346     logout("\n");
 347     /* The return value for missing code must be 0, see block.c. */
 348     return 0;
 349 }
 350
 351 static int vdi_probe(const uint8_t *buf, int buf_size, const char *filename)
 352 {
 353     const VdiHeader *header = (const VdiHeader *)buf;
 354     int result = 0;
 355
 356     logout("\n");
 357
 358     if (buf_size < sizeof(*header)) {
 359         /* Header too small, no VDI. */
 360     } else if (le32_to_cpu(header->signature) == VDI_SIGNATURE) {
 361         result = 100;
 362     }
 363
 364     if (result == 0) {
 365         logout("no vdi image\n");
 366     } else {
 367         logout("%s", header->text);
 368     }
 369
 370     return result;
 371 }
 372
 373 static int vdi_open(BlockDriverState *bs, QDict *options, int flags,
 374                     Error **errp)
 375 {
 376     BDRVVdiState *s = bs->opaque;
 377     VdiHeader header;
 378     size_t bmap_size;
 379     int ret;
 380
 381     logout("\n");
 382
 383     ret = bdrv_read(bs->file, 0, (uint8_t *)&header, 1);
 384     if (ret < 0) {
 385         goto fail;
 386     }
 387
 388     vdi_header_to_cpu(&header);
 389 #if defined(CONFIG_VDI_DEBUG)
 390     vdi_header_print(&header);
 391 #endif
 392
 393     if (header.disk_size > VDI_DISK_SIZE_MAX) {
 394         error_setg(errp, "Unsupported VDI image size (size is 0x%" PRIx64
 395                           ", max supported is 0x%" PRIx64 ")",
 396                           header.disk_size, VDI_DISK_SIZE_MAX);
 397         ret = -ENOTSUP;
 398         goto fail;
 399     }
 400
 401     if (header.disk_size % SECTOR_SIZE != 0) {
 402         /* 'VBoxManage convertfromraw' can create images with odd disk sizes.
 403            We accept them but round the disk size to the next multiple of
 404            SECTOR_SIZE. */
 405         logout("odd disk size %" PRIu64 " B, round up\n", header.disk_size);
 406         header.disk_size += SECTOR_SIZE - 1;
 407         header.disk_size &= ~(SECTOR_SIZE - 1);
 408     }
 409
 410     if (header.signature != VDI_SIGNATURE) {
 411         error_setg(errp, "Image not in VDI format (bad signature %08x)", header.signature);
 412         ret = -EINVAL;
 413         goto fail;
 414     } else if (header.version != VDI_VERSION_1_1) {
 415         error_setg(errp, "unsupported VDI image (version %u.%u)",
 416                    header.version >> 16, header.version & 0xffff);
 417         ret = -ENOTSUP;
 418         goto fail;
 419     } else if (header.offset_bmap % SECTOR_SIZE != 0) {
 420         /* We only support block maps which start on a sector boundary. */
 421         error_setg(errp, "unsupported VDI image (unaligned block map offset "
 422                    "0x%x)", header.offset_bmap);
 423         ret = -ENOTSUP;
 424         goto fail;
 425     } else if (header.offset_data % SECTOR_SIZE != 0) {
 426         /* We only support data blocks which start on a sector boundary. */
 427         error_setg(errp, "unsupported VDI image (unaligned data offset 0x%x)",
 428                    header.offset_data);
 429         ret = -ENOTSUP;
 430         goto fail;
 431     } else if (header.sector_size != SECTOR_SIZE) {
 432         error_setg(errp, "unsupported VDI image (sector size %u is not %u)",
 433                    header.sector_size, SECTOR_SIZE);
 434         ret = -ENOTSUP;
 435         goto fail;
 436     } else if (header.block_size != DEFAULT_CLUSTER_SIZE) {
 437         error_setg(errp, "unsupported VDI image (block size %u is not %u)",
 438                    header.block_size, DEFAULT_CLUSTER_SIZE);
 439         ret = -ENOTSUP;
 440         goto fail;
 441     } else if (header.disk_size >
 442                (uint64_t)header.blocks_in_image * header.block_size) {
 443         error_setg(errp, "unsupported VDI image (disk size %" PRIu64 ", "
 444                    "image bitmap has room for %" PRIu64 ")",
 445                    header.disk_size,
 446                    (uint64_t)header.blocks_in_image * header.block_size);
 447         ret = -ENOTSUP;
 448         goto fail;
 449     } else if (!uuid_is_null(header.uuid_link)) {
 450         error_setg(errp, "unsupported VDI image (non-NULL link UUID)");
 451         ret = -ENOTSUP;
 452         goto fail;
 453     } else if (!uuid_is_null(header.uuid_parent)) {
 454         error_setg(errp, "unsupported VDI image (non-NULL parent UUID)");
 455         ret = -ENOTSUP;
 456         goto fail;
 457     } else if (header.blocks_in_image > VDI_BLOCKS_IN_IMAGE_MAX) {
 458         error_setg(errp, "unsupported VDI image "
 459                          "(too many blocks %u, max is %u)",
 460                           header.blocks_in_image, VDI_BLOCKS_IN_IMAGE_MAX);
 461         ret = -ENOTSUP;
 462         goto fail;
 463     }
 464
 465     bs->total_sectors = header.disk_size / SECTOR_SIZE;
 466
 467     s->block_size = header.block_size;
 468     s->block_sectors = header.block_size / SECTOR_SIZE;
 469     s->bmap_sector = header.offset_bmap / SECTOR_SIZE;
 470     s->header = header;
 471
 472     bmap_size = header.blocks_in_image * sizeof(uint32_t);
 473     bmap_size = (bmap_size + SECTOR_SIZE - 1) / SECTOR_SIZE;
 474     s->bmap = g_malloc(bmap_size * SECTOR_SIZE);
 475     ret = bdrv_read(bs->file, s->bmap_sector, (uint8_t *)s->bmap, bmap_size);
 476     if (ret < 0) {
 477         goto fail_free_bmap;
 478     }
 479
 480     /* Disable migration when vdi images are used */
 481     error_set(&s->migration_blocker,
 482               QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
 483               "vdi", bs->device_name, "live migration");
 484     migrate_add_blocker(s->migration_blocker);
 485
 486     return 0;
 487
 488  fail_free_bmap:
 489     g_free(s->bmap);
 490
 491  fail:
 492     return ret;
 493 }
 494
 495 static int vdi_reopen_prepare(BDRVReopenState *state,
 496                               BlockReopenQueue *queue, Error **errp)
 497 {
 498     return 0;
 499 }
 500
 501 static int64_t coroutine_fn vdi_co_get_block_status(BlockDriverState *bs,
 502         int64_t sector_num, int nb_sectors, int *pnum)
 503 {
 504     /* TODO: Check for too large sector_num (in bdrv_is_allocated or here). */
 505     BDRVVdiState *s = (BDRVVdiState *)bs->opaque;
 506     size_t bmap_index = sector_num / s->block_sectors;
 507     size_t sector_in_block = sector_num % s->block_sectors;
 508     int n_sectors = s->block_sectors - sector_in_block;
 509     uint32_t bmap_entry = le32_to_cpu(s->bmap[bmap_index]);
 510     uint64_t offset;
 511     int result;
 512
 513     logout("%p, %" PRId64 ", %d, %p\n", bs, sector_num, nb_sectors, pnum);
 514     if (n_sectors > nb_sectors) {
 515         n_sectors = nb_sectors;
 516     }
 517     *pnum = n_sectors;
 518     result = VDI_IS_ALLOCATED(bmap_entry);
 519     if (!result) {
 520         return 0;
 521     }
 522
 523     offset = s->header.offset_data +
 524                               (uint64_t)bmap_entry * s->block_size +
 525                               sector_in_block * SECTOR_SIZE;
 526     return BDRV_BLOCK_DATA | BDRV_BLOCK_OFFSET_VALID | offset;
 527 }
 528
 529 static int vdi_co_read(BlockDriverState *bs,
 530         int64_t sector_num, uint8_t *buf, int nb_sectors)
 531 {
 532     BDRVVdiState *s = bs->opaque;
 533     uint32_t bmap_entry;
 534     uint32_t block_index;
 535     uint32_t sector_in_block;
 536     uint32_t n_sectors;
 537     int ret = 0;
 538
 539     logout("\n");
 540
 541     while (ret >= 0 && nb_sectors > 0) {
 542         block_index = sector_num / s->block_sectors;
 543         sector_in_block = sector_num % s->block_sectors;
 544         n_sectors = s->block_sectors - sector_in_block;
 545         if (n_sectors > nb_sectors) {
 546             n_sectors = nb_sectors;
 547         }
 548
 549         logout("will read %u sectors starting at sector %" PRIu64 "\n",
 550                n_sectors, sector_num);
 551
 552         /* prepare next AIO request */
 553         bmap_entry = le32_to_cpu(s->bmap[block_index]);
 554         if (!VDI_IS_ALLOCATED(bmap_entry)) {
 555             /* Block not allocated, return zeros, no need to wait. */
 556             memset(buf, 0, n_sectors * SECTOR_SIZE);
 557             ret = 0;
 558         } else {
 559             uint64_t offset = s->header.offset_data / SECTOR_SIZE +
 560                               (uint64_t)bmap_entry * s->block_sectors +
 561                               sector_in_block;
 562             ret = bdrv_read(bs->file, offset, buf, n_sectors);
 563         }
 564         logout("%u sectors read\n", n_sectors);
 565
 566         nb_sectors -= n_sectors;
 567         sector_num += n_sectors;
 568         buf += n_sectors * SECTOR_SIZE;
 569     }
 570
 571     return ret;
 572 }
 573
 574 static int vdi_co_write(BlockDriverState *bs,
 575         int64_t sector_num, const uint8_t *buf, int nb_sectors)
 576 {
 577     BDRVVdiState *s = bs->opaque;
 578     uint32_t bmap_entry;
 579     uint32_t block_index;
 580     uint32_t sector_in_block;
 581     uint32_t n_sectors;
 582     uint32_t bmap_first = VDI_UNALLOCATED;
 583     uint32_t bmap_last = VDI_UNALLOCATED;
 584     uint8_t *block = NULL;
 585     int ret = 0;
 586
 587     logout("\n");
 588
 589     while (ret >= 0 && nb_sectors > 0) {
 590         block_index = sector_num / s->block_sectors;
 591         sector_in_block = sector_num % s->block_sectors;
 592         n_sectors = s->block_sectors - sector_in_block;
 593         if (n_sectors > nb_sectors) {
 594             n_sectors = nb_sectors;
 595         }
 596
 597         logout("will write %u sectors starting at sector %" PRIu64 "\n",
 598                n_sectors, sector_num);
 599
 600         /* prepare next AIO request */
 601         bmap_entry = le32_to_cpu(s->bmap[block_index]);
 602         if (!VDI_IS_ALLOCATED(bmap_entry)) {
 603             /* Allocate new block and write to it. */
 604             uint64_t offset;
 605             bmap_entry = s->header.blocks_allocated;
 606             s->bmap[block_index] = cpu_to_le32(bmap_entry);
 607             s->header.blocks_allocated++;
 608             offset = s->header.offset_data / SECTOR_SIZE +
 609                      (uint64_t)bmap_entry * s->block_sectors;
 610             if (block == NULL) {
 611                 block = g_malloc(s->block_size);
 612                 bmap_first = block_index;
 613             }
 614             bmap_last = block_index;
 615             /* Copy data to be written to new block and zero unused parts. */
 616             memset(block, 0, sector_in_block * SECTOR_SIZE);
 617             memcpy(block + sector_in_block * SECTOR_SIZE,
 618                    buf, n_sectors * SECTOR_SIZE);
 619             memset(block + (sector_in_block + n_sectors) * SECTOR_SIZE, 0,
 620                    (s->block_sectors - n_sectors - sector_in_block) * SECTOR_SIZE);
 621             ret = bdrv_write(bs->file, offset, block, s->block_sectors);
 622         } else {
 623             uint64_t offset = s->header.offset_data / SECTOR_SIZE +
 624                               (uint64_t)bmap_entry * s->block_sectors +
 625                               sector_in_block;
 626             ret = bdrv_write(bs->file, offset, buf, n_sectors);
 627         }
 628
 629         nb_sectors -= n_sectors;
 630         sector_num += n_sectors;
 631         buf += n_sectors * SECTOR_SIZE;
 632
 633         logout("%u sectors written\n", n_sectors);
 634     }
 635
 636     logout("finished data write\n");
 637     if (ret < 0) {
 638         return ret;
 639     }
 640
 641     if (block) {
 642         /* One or more new blocks were allocated. */
 643         VdiHeader *header = (VdiHeader *) block;
 644         uint8_t *base;
 645         uint64_t offset;
 646
 647         logout("now writing modified header\n");
 648         assert(VDI_IS_ALLOCATED(bmap_first));
 649         *header = s->header;
 650         vdi_header_to_le(header);
 651         ret = bdrv_write(bs->file, 0, block, 1);
 652         g_free(block);
 653         block = NULL;
 654
 655         if (ret < 0) {
 656             return ret;
 657         }
 658
 659         logout("now writing modified block map entry %u...%u\n",
 660                bmap_first, bmap_last);
 661         /* Write modified sectors from block map. */
 662         bmap_first /= (SECTOR_SIZE / sizeof(uint32_t));
 663         bmap_last /= (SECTOR_SIZE / sizeof(uint32_t));
 664         n_sectors = bmap_last - bmap_first + 1;
 665         offset = s->bmap_sector + bmap_first;
 666         base = ((uint8_t *)&s->bmap[0]) + bmap_first * SECTOR_SIZE;
 667         logout("will write %u block map sectors starting from entry %u\n",
 668                n_sectors, bmap_first);
 669         ret = bdrv_write(bs->file, offset, base, n_sectors);
 670     }
 671
 672     return ret;
 673 }
 674
 675 static int vdi_create(const char *filename, QEMUOptionParameter *options,
 676                       Error **errp)
 677 {
 678     int fd;
 679     int result = 0;
 680     uint64_t bytes = 0;
 681     uint32_t blocks;
 682     size_t block_size = DEFAULT_CLUSTER_SIZE;
 683     uint32_t image_type = VDI_TYPE_DYNAMIC;
 684     VdiHeader header;
 685     size_t i;
 686     size_t bmap_size;
 687
 688     logout("\n");
 689
 690     /* Read out options. */
 691     while (options && options->name) {
 692         if (!strcmp(options->name, BLOCK_OPT_SIZE)) {
 693             bytes = options->value.n;
 694 #if defined(CONFIG_VDI_BLOCK_SIZE)
 695         } else if (!strcmp(options->name, BLOCK_OPT_CLUSTER_SIZE)) {
 696             if (options->value.n) {
 697                 /* TODO: Additional checks (SECTOR_SIZE * 2^n, ...). */
 698                 block_size = options->value.n;
 699             }
 700 #endif
 701 #if defined(CONFIG_VDI_STATIC_IMAGE)
 702         } else if (!strcmp(options->name, BLOCK_OPT_STATIC)) {
 703             if (options->value.n) {
 704                 image_type = VDI_TYPE_STATIC;
 705             }
 706 #endif
 707         }
 708         options++;
 709     }
 710
 711     if (bytes > VDI_DISK_SIZE_MAX) {
 712         result = -ENOTSUP;
 713         error_setg(errp, "Unsupported VDI image size (size is 0x%" PRIx64
 714                           ", max supported is 0x%" PRIx64 ")",
 715                           bytes, VDI_DISK_SIZE_MAX);
 716         goto exit;
 717     }
 718
 719     fd = qemu_open(filename,
 720                    O_WRONLY | O_CREAT | O_TRUNC | O_BINARY | O_LARGEFILE,
 721                    0644);
 722     if (fd < 0) {
 723         result = -errno;
 724         goto exit;
 725     }
 726
 727     /* We need enough blocks to store the given disk size,
 728        so always round up. */
 729     blocks = (bytes + block_size - 1) / block_size;
 730
 731     bmap_size = blocks * sizeof(uint32_t);
 732     bmap_size = ((bmap_size + SECTOR_SIZE - 1) & ~(SECTOR_SIZE -1));
 733
 734     memset(&header, 0, sizeof(header));
 735     pstrcpy(header.text, sizeof(header.text), VDI_TEXT);
 736     header.signature = VDI_SIGNATURE;
 737     header.version = VDI_VERSION_1_1;
 738     header.header_size = 0x180;
 739     header.image_type = image_type;
 740     header.offset_bmap = 0x200;
 741     header.offset_data = 0x200 + bmap_size;
 742     header.sector_size = SECTOR_SIZE;
 743     header.disk_size = bytes;
 744     header.block_size = block_size;
 745     header.blocks_in_image = blocks;
 746     if (image_type == VDI_TYPE_STATIC) {
 747         header.blocks_allocated = blocks;
 748     }
 749     uuid_generate(header.uuid_image);
 750     uuid_generate(header.uuid_last_snap);
 751     /* There is no need to set header.uuid_link or header.uuid_parent here. */
 752 #if defined(CONFIG_VDI_DEBUG)
 753     vdi_header_print(&header);
 754 #endif
 755     vdi_header_to_le(&header);
 756     if (write(fd, &header, sizeof(header)) < 0) {
 757         result = -errno;
 758     }
 759
 760     if (bmap_size > 0) {
 761         uint32_t *bmap = g_malloc0(bmap_size);
 762         for (i = 0; i < blocks; i++) {
 763             if (image_type == VDI_TYPE_STATIC) {
 764                 bmap[i] = i;
 765             } else {
 766                 bmap[i] = VDI_UNALLOCATED;
 767             }
 768         }
 769         if (write(fd, bmap, bmap_size) < 0) {
 770             result = -errno;
 771         }
 772         g_free(bmap);
 773     }
 774
 775     if (image_type == VDI_TYPE_STATIC) {
 776         if (ftruncate(fd, sizeof(header) + bmap_size + blocks * block_size)) {
 777             result = -errno;
 778         }
 779     }
 780
 781     if (close(fd) < 0) {
 782         result = -errno;
 783     }
 784
 785 exit:
 786     return result;
 787 }
 788
 789 static void vdi_close(BlockDriverState *bs)
 790 {
 791     BDRVVdiState *s = bs->opaque;
 792
 793     g_free(s->bmap);
 794
 795     migrate_del_blocker(s->migration_blocker);
 796     error_free(s->migration_blocker);
 797 }
 798
 799 static QEMUOptionParameter vdi_create_options[] = {
 800     {
 801         .name = BLOCK_OPT_SIZE,
 802         .type = OPT_SIZE,
 803         .help = "Virtual disk size"
 804     },
 805 #if defined(CONFIG_VDI_BLOCK_SIZE)
 806     {
 807         .name = BLOCK_OPT_CLUSTER_SIZE,
 808         .type = OPT_SIZE,
 809         .help = "VDI cluster (block) size",
 810         .value = { .n = DEFAULT_CLUSTER_SIZE },
 811     },
 812 #endif
 813 #if defined(CONFIG_VDI_STATIC_IMAGE)
 814     {
 815         .name = BLOCK_OPT_STATIC,
 816         .type = OPT_FLAG,
 817         .help = "VDI static (pre-allocated) image"
 818     },
 819 #endif
 820     /* TODO: An additional option to set UUID values might be useful. */
 821     { NULL }
 822 };
 823
 824 static BlockDriver bdrv_vdi = {
 825     .format_name = "vdi",
 826     .instance_size = sizeof(BDRVVdiState),
 827     .bdrv_probe = vdi_probe,
 828     .bdrv_open = vdi_open,
 829     .bdrv_close = vdi_close,
 830     .bdrv_reopen_prepare = vdi_reopen_prepare,
 831     .bdrv_create = vdi_create,
 832     .bdrv_has_zero_init = bdrv_has_zero_init_1,
 833     .bdrv_co_get_block_status = vdi_co_get_block_status,
 834     .bdrv_make_empty = vdi_make_empty,
 835
 836     .bdrv_read = vdi_co_read,
 837 #if defined(CONFIG_VDI_WRITE)
 838     .bdrv_write = vdi_co_write,
 839 #endif
 840
 841     .bdrv_get_info = vdi_get_info,
 842
 843     .create_options = vdi_create_options,
 844     .bdrv_check = vdi_check,
 845 };
 846
 847 static void bdrv_vdi_init(void)
 848 {
 849     logout("\n");
 850     bdrv_register(&bdrv_vdi);
 851 }
 852
 853 block_init(bdrv_vdi_init);