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/osdep.h"
  53 #include "qemu/units.h"
  54 #include "qapi/error.h"
  55 #include "qapi/qobject-input-visitor.h"
  56 #include "qapi/qapi-visit-block-core.h"
  57 #include "block/block_int.h"
  58 #include "block/qdict.h"
  59 #include "sysemu/block-backend.h"
  60 #include "qemu/module.h"
  61 #include "qemu/option.h"
  62 #include "qemu/bswap.h"
  63 #include "migration/blocker.h"
  64 #include "qemu/coroutine.h"
  65 #include "qemu/cutils.h"
  66 #include "qemu/uuid.h"
  67
  68 /* Code configuration options. */
  69
  70 /* Enable debug messages. */
  71 //~ #define CONFIG_VDI_DEBUG
  72
  73 /* Support write operations on VDI images. */
  74 #define CONFIG_VDI_WRITE
  75
  76 /* Support non-standard block (cluster) size. This is untested.
  77  * Maybe it will be needed for very large images.
  78  */
  79 //~ #define CONFIG_VDI_BLOCK_SIZE
  80
  81 /* Support static (fixed, pre-allocated) images. */
  82 #define CONFIG_VDI_STATIC_IMAGE
  83
  84 /* Command line option for static images. */
  85 #define BLOCK_OPT_STATIC "static"
  86
  87 #define SECTOR_SIZE 512
  88 #define DEFAULT_CLUSTER_SIZE S_1MiB
  89
  90 #if defined(CONFIG_VDI_DEBUG)
  91 #define VDI_DEBUG 1
  92 #else
  93 #define VDI_DEBUG 0
  94 #endif
  95
  96 #define logout(fmt, ...) \
  97     do {                                                                \
  98         if (VDI_DEBUG) {                                                \
  99             fprintf(stderr, "vdi\t%-24s" fmt, __func__, ##__VA_ARGS__); \
 100         }                                                               \
 101     } while (0)
 102
 103 /* Image signature. */
 104 #define VDI_SIGNATURE 0xbeda107f
 105
 106 /* Image version. */
 107 #define VDI_VERSION_1_1 0x00010001
 108
 109 /* Image type. */
 110 #define VDI_TYPE_DYNAMIC 1
 111 #define VDI_TYPE_STATIC  2
 112
 113 /* Innotek / SUN images use these strings in header.text:
 114  * "<<< innotek VirtualBox Disk Image >>>\n"
 115  * "<<< Sun xVM VirtualBox Disk Image >>>\n"
 116  * "<<< Sun VirtualBox Disk Image >>>\n"
 117  * The value does not matter, so QEMU created images use a different text.
 118  */
 119 #define VDI_TEXT "<<< QEMU VM Virtual Disk Image >>>\n"
 120
 121 /* A never-allocated block; semantically arbitrary content. */
 122 #define VDI_UNALLOCATED 0xffffffffU
 123
 124 /* A discarded (no longer allocated) block; semantically zero-filled. */
 125 #define VDI_DISCARDED   0xfffffffeU
 126
 127 #define VDI_IS_ALLOCATED(X) ((X) < VDI_DISCARDED)
 128
 129 /* The bmap will take up VDI_BLOCKS_IN_IMAGE_MAX * sizeof(uint32_t) bytes; since
 130  * the bmap is read and written in a single operation, its size needs to be
 131  * limited to INT_MAX; furthermore, when opening an image, the bmap size is
 132  * rounded up to be aligned on BDRV_SECTOR_SIZE.
 133  * Therefore this should satisfy the following:
 134  * VDI_BLOCKS_IN_IMAGE_MAX * sizeof(uint32_t) + BDRV_SECTOR_SIZE == INT_MAX + 1
 135  * (INT_MAX + 1 is the first value not representable as an int)
 136  * This guarantees that any value below or equal to the constant will, when
 137  * multiplied by sizeof(uint32_t) and rounded up to a BDRV_SECTOR_SIZE boundary,
 138  * still be below or equal to INT_MAX. */
 139 #define VDI_BLOCKS_IN_IMAGE_MAX \
 140     ((unsigned)((INT_MAX + 1u - BDRV_SECTOR_SIZE) / sizeof(uint32_t)))
 141 #define VDI_DISK_SIZE_MAX        ((uint64_t)VDI_BLOCKS_IN_IMAGE_MAX * \
 142                                   (uint64_t)DEFAULT_CLUSTER_SIZE)
 143
 144 static QemuOptsList vdi_create_opts;
 145
 146 typedef struct {
 147     char text[0x40];
 148     uint32_t signature;
 149     uint32_t version;
 150     uint32_t header_size;
 151     uint32_t image_type;
 152     uint32_t image_flags;
 153     char description[256];
 154     uint32_t offset_bmap;
 155     uint32_t offset_data;
 156     uint32_t cylinders;         /* disk geometry, unused here */
 157     uint32_t heads;             /* disk geometry, unused here */
 158     uint32_t sectors;           /* disk geometry, unused here */
 159     uint32_t sector_size;
 160     uint32_t unused1;
 161     uint64_t disk_size;
 162     uint32_t block_size;
 163     uint32_t block_extra;       /* unused here */
 164     uint32_t blocks_in_image;
 165     uint32_t blocks_allocated;
 166     QemuUUID uuid_image;
 167     QemuUUID uuid_last_snap;
 168     QemuUUID uuid_link;
 169     QemuUUID uuid_parent;
 170     uint64_t unused2[7];
 171 } QEMU_PACKED VdiHeader;
 172
 173 typedef struct {
 174     /* The block map entries are little endian (even in memory). */
 175     uint32_t *bmap;
 176     /* Size of block (bytes). */
 177     uint32_t block_size;
 178     /* First sector of block map. */
 179     uint32_t bmap_sector;
 180     /* VDI header (converted to host endianness). */
 181     VdiHeader header;
 182
 183     CoRwlock bmap_lock;
 184
 185     Error *migration_blocker;
 186 } BDRVVdiState;
 187
 188 static void vdi_header_to_cpu(VdiHeader *header)
 189 {
 190     header->signature = le32_to_cpu(header->signature);
 191     header->version = le32_to_cpu(header->version);
 192     header->header_size = le32_to_cpu(header->header_size);
 193     header->image_type = le32_to_cpu(header->image_type);
 194     header->image_flags = le32_to_cpu(header->image_flags);
 195     header->offset_bmap = le32_to_cpu(header->offset_bmap);
 196     header->offset_data = le32_to_cpu(header->offset_data);
 197     header->cylinders = le32_to_cpu(header->cylinders);
 198     header->heads = le32_to_cpu(header->heads);
 199     header->sectors = le32_to_cpu(header->sectors);
 200     header->sector_size = le32_to_cpu(header->sector_size);
 201     header->disk_size = le64_to_cpu(header->disk_size);
 202     header->block_size = le32_to_cpu(header->block_size);
 203     header->block_extra = le32_to_cpu(header->block_extra);
 204     header->blocks_in_image = le32_to_cpu(header->blocks_in_image);
 205     header->blocks_allocated = le32_to_cpu(header->blocks_allocated);
 206     header->uuid_image = qemu_uuid_bswap(header->uuid_image);
 207     header->uuid_last_snap = qemu_uuid_bswap(header->uuid_last_snap);
 208     header->uuid_link = qemu_uuid_bswap(header->uuid_link);
 209     header->uuid_parent = qemu_uuid_bswap(header->uuid_parent);
 210 }
 211
 212 static void vdi_header_to_le(VdiHeader *header)
 213 {
 214     header->signature = cpu_to_le32(header->signature);
 215     header->version = cpu_to_le32(header->version);
 216     header->header_size = cpu_to_le32(header->header_size);
 217     header->image_type = cpu_to_le32(header->image_type);
 218     header->image_flags = cpu_to_le32(header->image_flags);
 219     header->offset_bmap = cpu_to_le32(header->offset_bmap);
 220     header->offset_data = cpu_to_le32(header->offset_data);
 221     header->cylinders = cpu_to_le32(header->cylinders);
 222     header->heads = cpu_to_le32(header->heads);
 223     header->sectors = cpu_to_le32(header->sectors);
 224     header->sector_size = cpu_to_le32(header->sector_size);
 225     header->disk_size = cpu_to_le64(header->disk_size);
 226     header->block_size = cpu_to_le32(header->block_size);
 227     header->block_extra = cpu_to_le32(header->block_extra);
 228     header->blocks_in_image = cpu_to_le32(header->blocks_in_image);
 229     header->blocks_allocated = cpu_to_le32(header->blocks_allocated);
 230     header->uuid_image = qemu_uuid_bswap(header->uuid_image);
 231     header->uuid_last_snap = qemu_uuid_bswap(header->uuid_last_snap);
 232     header->uuid_link = qemu_uuid_bswap(header->uuid_link);
 233     header->uuid_parent = qemu_uuid_bswap(header->uuid_parent);
 234 }
 235
 236 static void vdi_header_print(VdiHeader *header)
 237 {
 238     char uuidstr[37];
 239     QemuUUID uuid;
 240     logout("text        %s", header->text);
 241     logout("signature   0x%08x\n", header->signature);
 242     logout("header size 0x%04x\n", header->header_size);
 243     logout("image type  0x%04x\n", header->image_type);
 244     logout("image flags 0x%04x\n", header->image_flags);
 245     logout("description %s\n", header->description);
 246     logout("offset bmap 0x%04x\n", header->offset_bmap);
 247     logout("offset data 0x%04x\n", header->offset_data);
 248     logout("cylinders   0x%04x\n", header->cylinders);
 249     logout("heads       0x%04x\n", header->heads);
 250     logout("sectors     0x%04x\n", header->sectors);
 251     logout("sector size 0x%04x\n", header->sector_size);
 252     logout("image size  0x%" PRIx64 " B (%" PRIu64 " MiB)\n",
 253            header->disk_size, header->disk_size / MiB);
 254     logout("block size  0x%04x\n", header->block_size);
 255     logout("block extra 0x%04x\n", header->block_extra);
 256     logout("blocks tot. 0x%04x\n", header->blocks_in_image);
 257     logout("blocks all. 0x%04x\n", header->blocks_allocated);
 258     uuid = header->uuid_image;
 259     qemu_uuid_unparse(&uuid, uuidstr);
 260     logout("uuid image  %s\n", uuidstr);
 261     uuid = header->uuid_last_snap;
 262     qemu_uuid_unparse(&uuid, uuidstr);
 263     logout("uuid snap   %s\n", uuidstr);
 264     uuid = header->uuid_link;
 265     qemu_uuid_unparse(&uuid, uuidstr);
 266     logout("uuid link   %s\n", uuidstr);
 267     uuid = header->uuid_parent;
 268     qemu_uuid_unparse(&uuid, uuidstr);
 269     logout("uuid parent %s\n", uuidstr);
 270 }
 271
 272 static int coroutine_fn vdi_co_check(BlockDriverState *bs, BdrvCheckResult *res,
 273                                      BdrvCheckMode fix)
 274 {
 275     /* TODO: additional checks possible. */
 276     BDRVVdiState *s = (BDRVVdiState *)bs->opaque;
 277     uint32_t blocks_allocated = 0;
 278     uint32_t block;
 279     uint32_t *bmap;
 280     logout("\n");
 281
 282     if (fix) {
 283         return -ENOTSUP;
 284     }
 285
 286     bmap = g_try_new(uint32_t, s->header.blocks_in_image);
 287     if (s->header.blocks_in_image && bmap == NULL) {
 288         res->check_errors++;
 289         return -ENOMEM;
 290     }
 291
 292     memset(bmap, 0xff, s->header.blocks_in_image * sizeof(uint32_t));
 293
 294     /* Check block map and value of blocks_allocated. */
 295     for (block = 0; block < s->header.blocks_in_image; block++) {
 296         uint32_t bmap_entry = le32_to_cpu(s->bmap[block]);
 297         if (VDI_IS_ALLOCATED(bmap_entry)) {
 298             if (bmap_entry < s->header.blocks_in_image) {
 299                 blocks_allocated++;
 300                 if (!VDI_IS_ALLOCATED(bmap[bmap_entry])) {
 301                     bmap[bmap_entry] = bmap_entry;
 302                 } else {
 303                     fprintf(stderr, "ERROR: block index %" PRIu32
 304                             " also used by %" PRIu32 "\n", bmap[bmap_entry], bmap_entry);
 305                     res->corruptions++;
 306                 }
 307             } else {
 308                 fprintf(stderr, "ERROR: block index %" PRIu32
 309                         " too large, is %" PRIu32 "\n", block, bmap_entry);
 310                 res->corruptions++;
 311             }
 312         }
 313     }
 314     if (blocks_allocated != s->header.blocks_allocated) {
 315         fprintf(stderr, "ERROR: allocated blocks mismatch, is %" PRIu32
 316                ", should be %" PRIu32 "\n",
 317                blocks_allocated, s->header.blocks_allocated);
 318         res->corruptions++;
 319     }
 320
 321     g_free(bmap);
 322
 323     return 0;
 324 }
 325
 326 static int vdi_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
 327 {
 328     /* TODO: vdi_get_info would be needed for machine snapshots.
 329        vm_state_offset is still missing. */
 330     BDRVVdiState *s = (BDRVVdiState *)bs->opaque;
 331     logout("\n");
 332     bdi->cluster_size = s->block_size;
 333     bdi->vm_state_offset = 0;
 334     bdi->unallocated_blocks_are_zero = true;
 335     return 0;
 336 }
 337
 338 static int vdi_make_empty(BlockDriverState *bs)
 339 {
 340     /* TODO: missing code. */
 341     logout("\n");
 342     /* The return value for missing code must be 0, see block.c. */
 343     return 0;
 344 }
 345
 346 static int vdi_probe(const uint8_t *buf, int buf_size, const char *filename)
 347 {
 348     const VdiHeader *header = (const VdiHeader *)buf;
 349     int ret = 0;
 350
 351     logout("\n");
 352
 353     if (buf_size < sizeof(*header)) {
 354         /* Header too small, no VDI. */
 355     } else if (le32_to_cpu(header->signature) == VDI_SIGNATURE) {
 356         ret = 100;
 357     }
 358
 359     if (ret == 0) {
 360         logout("no vdi image\n");
 361     } else {
 362         logout("%s", header->text);
 363     }
 364
 365     return ret;
 366 }
 367
 368 static int vdi_open(BlockDriverState *bs, QDict *options, int flags,
 369                     Error **errp)
 370 {
 371     BDRVVdiState *s = bs->opaque;
 372     VdiHeader header;
 373     size_t bmap_size;
 374     int ret;
 375     Error *local_err = NULL;
 376     QemuUUID uuid_link, uuid_parent;
 377
 378     bs->file = bdrv_open_child(NULL, options, "file", bs, &child_file,
 379                                false, errp);
 380     if (!bs->file) {
 381         return -EINVAL;
 382     }
 383
 384     logout("\n");
 385
 386     ret = bdrv_read(bs->file, 0, (uint8_t *)&header, 1);
 387     if (ret < 0) {
 388         goto fail;
 389     }
 390
 391     vdi_header_to_cpu(&header);
 392     if (VDI_DEBUG) {
 393         vdi_header_print(&header);
 394     }
 395
 396     if (header.disk_size > VDI_DISK_SIZE_MAX) {
 397         error_setg(errp, "Unsupported VDI image size (size is 0x%" PRIx64
 398                           ", max supported is 0x%" PRIx64 ")",
 399                           header.disk_size, VDI_DISK_SIZE_MAX);
 400         ret = -ENOTSUP;
 401         goto fail;
 402     }
 403
 404     uuid_link = header.uuid_link;
 405     uuid_parent = header.uuid_parent;
 406
 407     if (header.disk_size % SECTOR_SIZE != 0) {
 408         /* 'VBoxManage convertfromraw' can create images with odd disk sizes.
 409            We accept them but round the disk size to the next multiple of
 410            SECTOR_SIZE. */
 411         logout("odd disk size %" PRIu64 " B, round up\n", header.disk_size);
 412         header.disk_size = ROUND_UP(header.disk_size, SECTOR_SIZE);
 413     }
 414
 415     if (header.signature != VDI_SIGNATURE) {
 416         error_setg(errp, "Image not in VDI format (bad signature %08" PRIx32
 417                    ")", header.signature);
 418         ret = -EINVAL;
 419         goto fail;
 420     } else if (header.version != VDI_VERSION_1_1) {
 421         error_setg(errp, "unsupported VDI image (version %" PRIu32 ".%" PRIu32
 422                    ")", header.version >> 16, header.version & 0xffff);
 423         ret = -ENOTSUP;
 424         goto fail;
 425     } else if (header.offset_bmap % SECTOR_SIZE != 0) {
 426         /* We only support block maps which start on a sector boundary. */
 427         error_setg(errp, "unsupported VDI image (unaligned block map offset "
 428                    "0x%" PRIx32 ")", header.offset_bmap);
 429         ret = -ENOTSUP;
 430         goto fail;
 431     } else if (header.offset_data % SECTOR_SIZE != 0) {
 432         /* We only support data blocks which start on a sector boundary. */
 433         error_setg(errp, "unsupported VDI image (unaligned data offset 0x%"
 434                    PRIx32 ")", header.offset_data);
 435         ret = -ENOTSUP;
 436         goto fail;
 437     } else if (header.sector_size != SECTOR_SIZE) {
 438         error_setg(errp, "unsupported VDI image (sector size %" PRIu32
 439                    " is not %u)", header.sector_size, SECTOR_SIZE);
 440         ret = -ENOTSUP;
 441         goto fail;
 442     } else if (header.block_size != DEFAULT_CLUSTER_SIZE) {
 443         error_setg(errp, "unsupported VDI image (block size %" PRIu32
 444                          " is not %" PRIu32 ")",
 445                    header.block_size, DEFAULT_CLUSTER_SIZE);
 446         ret = -ENOTSUP;
 447         goto fail;
 448     } else if (header.disk_size >
 449                (uint64_t)header.blocks_in_image * header.block_size) {
 450         error_setg(errp, "unsupported VDI image (disk size %" PRIu64 ", "
 451                    "image bitmap has room for %" PRIu64 ")",
 452                    header.disk_size,
 453                    (uint64_t)header.blocks_in_image * header.block_size);
 454         ret = -ENOTSUP;
 455         goto fail;
 456     } else if (!qemu_uuid_is_null(&uuid_link)) {
 457         error_setg(errp, "unsupported VDI image (non-NULL link UUID)");
 458         ret = -ENOTSUP;
 459         goto fail;
 460     } else if (!qemu_uuid_is_null(&uuid_parent)) {
 461         error_setg(errp, "unsupported VDI image (non-NULL parent UUID)");
 462         ret = -ENOTSUP;
 463         goto fail;
 464     } else if (header.blocks_in_image > VDI_BLOCKS_IN_IMAGE_MAX) {
 465         error_setg(errp, "unsupported VDI image "
 466                          "(too many blocks %u, max is %u)",
 467                           header.blocks_in_image, VDI_BLOCKS_IN_IMAGE_MAX);
 468         ret = -ENOTSUP;
 469         goto fail;
 470     }
 471
 472     bs->total_sectors = header.disk_size / SECTOR_SIZE;
 473
 474     s->block_size = header.block_size;
 475     s->bmap_sector = header.offset_bmap / SECTOR_SIZE;
 476     s->header = header;
 477
 478     bmap_size = header.blocks_in_image * sizeof(uint32_t);
 479     bmap_size = DIV_ROUND_UP(bmap_size, SECTOR_SIZE);
 480     s->bmap = qemu_try_blockalign(bs->file->bs, bmap_size * SECTOR_SIZE);
 481     if (s->bmap == NULL) {
 482         ret = -ENOMEM;
 483         goto fail;
 484     }
 485
 486     ret = bdrv_read(bs->file, s->bmap_sector, (uint8_t *)s->bmap,
 487                     bmap_size);
 488     if (ret < 0) {
 489         goto fail_free_bmap;
 490     }
 491
 492     /* Disable migration when vdi images are used */
 493     error_setg(&s->migration_blocker, "The vdi format used by node '%s' "
 494                "does not support live migration",
 495                bdrv_get_device_or_node_name(bs));
 496     ret = migrate_add_blocker(s->migration_blocker, &local_err);
 497     if (local_err) {
 498         error_propagate(errp, local_err);
 499         error_free(s->migration_blocker);
 500         goto fail_free_bmap;
 501     }
 502
 503     qemu_co_rwlock_init(&s->bmap_lock);
 504
 505     return 0;
 506
 507  fail_free_bmap:
 508     qemu_vfree(s->bmap);
 509
 510  fail:
 511     return ret;
 512 }
 513
 514 static int vdi_reopen_prepare(BDRVReopenState *state,
 515                               BlockReopenQueue *queue, Error **errp)
 516 {
 517     return 0;
 518 }
 519
 520 static int coroutine_fn vdi_co_block_status(BlockDriverState *bs,
 521                                             bool want_zero,
 522                                             int64_t offset, int64_t bytes,
 523                                             int64_t *pnum, int64_t *map,
 524                                             BlockDriverState **file)
 525 {
 526     BDRVVdiState *s = (BDRVVdiState *)bs->opaque;
 527     size_t bmap_index = offset / s->block_size;
 528     size_t index_in_block = offset % s->block_size;
 529     uint32_t bmap_entry = le32_to_cpu(s->bmap[bmap_index]);
 530     int result;
 531
 532     logout("%p, %" PRId64 ", %" PRId64 ", %p\n", bs, offset, bytes, pnum);
 533     *pnum = MIN(s->block_size - index_in_block, bytes);
 534     result = VDI_IS_ALLOCATED(bmap_entry);
 535     if (!result) {
 536         return 0;
 537     }
 538
 539     *map = s->header.offset_data + (uint64_t)bmap_entry * s->block_size +
 540         index_in_block;
 541     *file = bs->file->bs;
 542     return BDRV_BLOCK_DATA | BDRV_BLOCK_OFFSET_VALID;
 543 }
 544
 545 static int coroutine_fn
 546 vdi_co_preadv(BlockDriverState *bs, uint64_t offset, uint64_t bytes,
 547               QEMUIOVector *qiov, int flags)
 548 {
 549     BDRVVdiState *s = bs->opaque;
 550     QEMUIOVector local_qiov;
 551     uint32_t bmap_entry;
 552     uint32_t block_index;
 553     uint32_t offset_in_block;
 554     uint32_t n_bytes;
 555     uint64_t bytes_done = 0;
 556     int ret = 0;
 557
 558     logout("\n");
 559
 560     qemu_iovec_init(&local_qiov, qiov->niov);
 561
 562     while (ret >= 0 && bytes > 0) {
 563         block_index = offset / s->block_size;
 564         offset_in_block = offset % s->block_size;
 565         n_bytes = MIN(bytes, s->block_size - offset_in_block);
 566
 567         logout("will read %u bytes starting at offset %" PRIu64 "\n",
 568                n_bytes, offset);
 569
 570         /* prepare next AIO request */
 571         qemu_co_rwlock_rdlock(&s->bmap_lock);
 572         bmap_entry = le32_to_cpu(s->bmap[block_index]);
 573         qemu_co_rwlock_unlock(&s->bmap_lock);
 574         if (!VDI_IS_ALLOCATED(bmap_entry)) {
 575             /* Block not allocated, return zeros, no need to wait. */
 576             qemu_iovec_memset(qiov, bytes_done, 0, n_bytes);
 577             ret = 0;
 578         } else {
 579             uint64_t data_offset = s->header.offset_data +
 580                                    (uint64_t)bmap_entry * s->block_size +
 581                                    offset_in_block;
 582
 583             qemu_iovec_reset(&local_qiov);
 584             qemu_iovec_concat(&local_qiov, qiov, bytes_done, n_bytes);
 585
 586             ret = bdrv_co_preadv(bs->file, data_offset, n_bytes,
 587                                  &local_qiov, 0);
 588         }
 589         logout("%u bytes read\n", n_bytes);
 590
 591         bytes -= n_bytes;
 592         offset += n_bytes;
 593         bytes_done += n_bytes;
 594     }
 595
 596     qemu_iovec_destroy(&local_qiov);
 597
 598     return ret;
 599 }
 600
 601 static int coroutine_fn
 602 vdi_co_pwritev(BlockDriverState *bs, uint64_t offset, uint64_t bytes,
 603                QEMUIOVector *qiov, int flags)
 604 {
 605     BDRVVdiState *s = bs->opaque;
 606     QEMUIOVector local_qiov;
 607     uint32_t bmap_entry;
 608     uint32_t block_index;
 609     uint32_t offset_in_block;
 610     uint32_t n_bytes;
 611     uint64_t data_offset;
 612     uint32_t bmap_first = VDI_UNALLOCATED;
 613     uint32_t bmap_last = VDI_UNALLOCATED;
 614     uint8_t *block = NULL;
 615     uint64_t bytes_done = 0;
 616     int ret = 0;
 617
 618     logout("\n");
 619
 620     qemu_iovec_init(&local_qiov, qiov->niov);
 621
 622     while (ret >= 0 && bytes > 0) {
 623         block_index = offset / s->block_size;
 624         offset_in_block = offset % s->block_size;
 625         n_bytes = MIN(bytes, s->block_size - offset_in_block);
 626
 627         logout("will write %u bytes starting at offset %" PRIu64 "\n",
 628                n_bytes, offset);
 629
 630         /* prepare next AIO request */
 631         qemu_co_rwlock_rdlock(&s->bmap_lock);
 632         bmap_entry = le32_to_cpu(s->bmap[block_index]);
 633         if (!VDI_IS_ALLOCATED(bmap_entry)) {
 634             /* Allocate new block and write to it. */
 635             uint64_t data_offset;
 636             qemu_co_rwlock_upgrade(&s->bmap_lock);
 637             bmap_entry = le32_to_cpu(s->bmap[block_index]);
 638             if (VDI_IS_ALLOCATED(bmap_entry)) {
 639                 /* A concurrent allocation did the work for us.  */
 640                 qemu_co_rwlock_downgrade(&s->bmap_lock);
 641                 goto nonallocating_write;
 642             }
 643
 644             bmap_entry = s->header.blocks_allocated;
 645             s->bmap[block_index] = cpu_to_le32(bmap_entry);
 646             s->header.blocks_allocated++;
 647             data_offset = s->header.offset_data +
 648                           (uint64_t)bmap_entry * s->block_size;
 649             if (block == NULL) {
 650                 block = g_malloc(s->block_size);
 651                 bmap_first = block_index;
 652             }
 653             bmap_last = block_index;
 654             /* Copy data to be written to new block and zero unused parts. */
 655             memset(block, 0, offset_in_block);
 656             qemu_iovec_to_buf(qiov, bytes_done, block + offset_in_block,
 657                               n_bytes);
 658             memset(block + offset_in_block + n_bytes, 0,
 659                    s->block_size - n_bytes - offset_in_block);
 660
 661             /* Write the new block under CoRwLock write-side protection,
 662              * so this full-cluster write does not overlap a partial write
 663              * of the same cluster, issued from the "else" branch.
 664              */
 665             ret = bdrv_pwrite(bs->file, data_offset, block, s->block_size);
 666             qemu_co_rwlock_unlock(&s->bmap_lock);
 667         } else {
 668 nonallocating_write:
 669             data_offset = s->header.offset_data +
 670                            (uint64_t)bmap_entry * s->block_size +
 671                            offset_in_block;
 672             qemu_co_rwlock_unlock(&s->bmap_lock);
 673
 674             qemu_iovec_reset(&local_qiov);
 675             qemu_iovec_concat(&local_qiov, qiov, bytes_done, n_bytes);
 676
 677             ret = bdrv_co_pwritev(bs->file, data_offset, n_bytes,
 678                                   &local_qiov, 0);
 679         }
 680
 681         bytes -= n_bytes;
 682         offset += n_bytes;
 683         bytes_done += n_bytes;
 684
 685         logout("%u bytes written\n", n_bytes);
 686     }
 687
 688     qemu_iovec_destroy(&local_qiov);
 689
 690     logout("finished data write\n");
 691     if (ret < 0) {
 692         return ret;
 693     }
 694
 695     if (block) {
 696         /* One or more new blocks were allocated. */
 697         VdiHeader *header = (VdiHeader *) block;
 698         uint8_t *base;
 699         uint64_t offset;
 700         uint32_t n_sectors;
 701
 702         logout("now writing modified header\n");
 703         assert(VDI_IS_ALLOCATED(bmap_first));
 704         *header = s->header;
 705         vdi_header_to_le(header);
 706         ret = bdrv_write(bs->file, 0, block, 1);
 707         g_free(block);
 708         block = NULL;
 709
 710         if (ret < 0) {
 711             return ret;
 712         }
 713
 714         logout("now writing modified block map entry %u...%u\n",
 715                bmap_first, bmap_last);
 716         /* Write modified sectors from block map. */
 717         bmap_first /= (SECTOR_SIZE / sizeof(uint32_t));
 718         bmap_last /= (SECTOR_SIZE / sizeof(uint32_t));
 719         n_sectors = bmap_last - bmap_first + 1;
 720         offset = s->bmap_sector + bmap_first;
 721         base = ((uint8_t *)&s->bmap[0]) + bmap_first * SECTOR_SIZE;
 722         logout("will write %u block map sectors starting from entry %u\n",
 723                n_sectors, bmap_first);
 724         ret = bdrv_write(bs->file, offset, base, n_sectors);
 725     }
 726
 727     return ret;
 728 }
 729
 730 static int coroutine_fn vdi_co_do_create(BlockdevCreateOptions *create_options,
 731                                          size_t block_size, Error **errp)
 732 {
 733     BlockdevCreateOptionsVdi *vdi_opts;
 734     int ret = 0;
 735     uint64_t bytes = 0;
 736     uint32_t blocks;
 737     uint32_t image_type;
 738     VdiHeader header;
 739     size_t i;
 740     size_t bmap_size;
 741     int64_t offset = 0;
 742     BlockDriverState *bs_file = NULL;
 743     BlockBackend *blk = NULL;
 744     uint32_t *bmap = NULL;
 745     QemuUUID uuid;
 746
 747     assert(create_options->driver == BLOCKDEV_DRIVER_VDI);
 748     vdi_opts = &create_options->u.vdi;
 749
 750     logout("\n");
 751
 752     /* Validate options and set default values */
 753     bytes = vdi_opts->size;
 754
 755     if (!vdi_opts->has_preallocation) {
 756         vdi_opts->preallocation = PREALLOC_MODE_OFF;
 757     }
 758     switch (vdi_opts->preallocation) {
 759     case PREALLOC_MODE_OFF:
 760         image_type = VDI_TYPE_DYNAMIC;
 761         break;
 762     case PREALLOC_MODE_METADATA:
 763         image_type = VDI_TYPE_STATIC;
 764         break;
 765     default:
 766         error_setg(errp, "Preallocation mode not supported for vdi");
 767         return -EINVAL;
 768     }
 769
 770 #ifndef CONFIG_VDI_STATIC_IMAGE
 771     if (image_type == VDI_TYPE_STATIC) {
 772         ret = -ENOTSUP;
 773         error_setg(errp, "Statically allocated images cannot be created in "
 774                    "this build");
 775         goto exit;
 776     }
 777 #endif
 778 #ifndef CONFIG_VDI_BLOCK_SIZE
 779     if (block_size != DEFAULT_CLUSTER_SIZE) {
 780         ret = -ENOTSUP;
 781         error_setg(errp,
 782                    "A non-default cluster size is not supported in this build");
 783         goto exit;
 784     }
 785 #endif
 786
 787     if (bytes > VDI_DISK_SIZE_MAX) {
 788         ret = -ENOTSUP;
 789         error_setg(errp, "Unsupported VDI image size (size is 0x%" PRIx64
 790                           ", max supported is 0x%" PRIx64 ")",
 791                           bytes, VDI_DISK_SIZE_MAX);
 792         goto exit;
 793     }
 794
 795     /* Create BlockBackend to write to the image */
 796     bs_file = bdrv_open_blockdev_ref(vdi_opts->file, errp);
 797     if (!bs_file) {
 798         ret = -EIO;
 799         goto exit;
 800     }
 801
 802     blk = blk_new(BLK_PERM_WRITE | BLK_PERM_RESIZE, BLK_PERM_ALL);
 803     ret = blk_insert_bs(blk, bs_file, errp);
 804     if (ret < 0) {
 805         goto exit;
 806     }
 807
 808     blk_set_allow_write_beyond_eof(blk, true);
 809
 810     /* We need enough blocks to store the given disk size,
 811        so always round up. */
 812     blocks = DIV_ROUND_UP(bytes, block_size);
 813
 814     bmap_size = blocks * sizeof(uint32_t);
 815     bmap_size = ROUND_UP(bmap_size, SECTOR_SIZE);
 816
 817     memset(&header, 0, sizeof(header));
 818     pstrcpy(header.text, sizeof(header.text), VDI_TEXT);
 819     header.signature = VDI_SIGNATURE;
 820     header.version = VDI_VERSION_1_1;
 821     header.header_size = 0x180;
 822     header.image_type = image_type;
 823     header.offset_bmap = 0x200;
 824     header.offset_data = 0x200 + bmap_size;
 825     header.sector_size = SECTOR_SIZE;
 826     header.disk_size = bytes;
 827     header.block_size = block_size;
 828     header.blocks_in_image = blocks;
 829     if (image_type == VDI_TYPE_STATIC) {
 830         header.blocks_allocated = blocks;
 831     }
 832     qemu_uuid_generate(&uuid);
 833     header.uuid_image = uuid;
 834     qemu_uuid_generate(&uuid);
 835     header.uuid_last_snap = uuid;
 836     /* There is no need to set header.uuid_link or header.uuid_parent here. */
 837     if (VDI_DEBUG) {
 838         vdi_header_print(&header);
 839     }
 840     vdi_header_to_le(&header);
 841     ret = blk_pwrite(blk, offset, &header, sizeof(header), 0);
 842     if (ret < 0) {
 843         error_setg(errp, "Error writing header");
 844         goto exit;
 845     }
 846     offset += sizeof(header);
 847
 848     if (bmap_size > 0) {
 849         bmap = g_try_malloc0(bmap_size);
 850         if (bmap == NULL) {
 851             ret = -ENOMEM;
 852             error_setg(errp, "Could not allocate bmap");
 853             goto exit;
 854         }
 855         for (i = 0; i < blocks; i++) {
 856             if (image_type == VDI_TYPE_STATIC) {
 857                 bmap[i] = i;
 858             } else {
 859                 bmap[i] = VDI_UNALLOCATED;
 860             }
 861         }
 862         ret = blk_pwrite(blk, offset, bmap, bmap_size, 0);
 863         if (ret < 0) {
 864             error_setg(errp, "Error writing bmap");
 865             goto exit;
 866         }
 867         offset += bmap_size;
 868     }
 869
 870     if (image_type == VDI_TYPE_STATIC) {
 871         ret = blk_truncate(blk, offset + blocks * block_size,
 872                            PREALLOC_MODE_OFF, errp);
 873         if (ret < 0) {
 874             error_prepend(errp, "Failed to statically allocate file");
 875             goto exit;
 876         }
 877     }
 878
 879     ret = 0;
 880 exit:
 881     blk_unref(blk);
 882     bdrv_unref(bs_file);
 883     g_free(bmap);
 884     return ret;
 885 }
 886
 887 static int coroutine_fn vdi_co_create(BlockdevCreateOptions *create_options,
 888                                       Error **errp)
 889 {
 890     return vdi_co_do_create(create_options, DEFAULT_CLUSTER_SIZE, errp);
 891 }
 892
 893 static int coroutine_fn vdi_co_create_opts(const char *filename, QemuOpts *opts,
 894                                            Error **errp)
 895 {
 896     QDict *qdict = NULL;
 897     BlockdevCreateOptions *create_options = NULL;
 898     BlockDriverState *bs_file = NULL;
 899     uint64_t block_size = DEFAULT_CLUSTER_SIZE;
 900     bool is_static = false;
 901     Visitor *v;
 902     Error *local_err = NULL;
 903     int ret;
 904
 905     /* Parse options and convert legacy syntax.
 906      *
 907      * Since CONFIG_VDI_BLOCK_SIZE is disabled by default,
 908      * cluster-size is not part of the QAPI schema; therefore we have
 909      * to parse it before creating the QAPI object. */
 910 #if defined(CONFIG_VDI_BLOCK_SIZE)
 911     block_size = qemu_opt_get_size_del(opts,
 912                                        BLOCK_OPT_CLUSTER_SIZE,
 913                                        DEFAULT_CLUSTER_SIZE);
 914     if (block_size < BDRV_SECTOR_SIZE || block_size > UINT32_MAX ||
 915         !is_power_of_2(block_size))
 916     {
 917         error_setg(errp, "Invalid cluster size");
 918         ret = -EINVAL;
 919         goto done;
 920     }
 921 #endif
 922     if (qemu_opt_get_bool_del(opts, BLOCK_OPT_STATIC, false)) {
 923         is_static = true;
 924     }
 925
 926     qdict = qemu_opts_to_qdict_filtered(opts, NULL, &vdi_create_opts, true);
 927
 928     /* Create and open the file (protocol layer) */
 929     ret = bdrv_create_file(filename, opts, errp);
 930     if (ret < 0) {
 931         goto done;
 932     }
 933
 934     bs_file = bdrv_open(filename, NULL, NULL,
 935                         BDRV_O_RDWR | BDRV_O_RESIZE | BDRV_O_PROTOCOL, errp);
 936     if (!bs_file) {
 937         ret = -EIO;
 938         goto done;
 939     }
 940
 941     qdict_put_str(qdict, "driver", "vdi");
 942     qdict_put_str(qdict, "file", bs_file->node_name);
 943     if (is_static) {
 944         qdict_put_str(qdict, "preallocation", "metadata");
 945     }
 946
 947     /* Get the QAPI object */
 948     v = qobject_input_visitor_new_flat_confused(qdict, errp);
 949     if (!v) {
 950         ret = -EINVAL;
 951         goto done;
 952     }
 953     visit_type_BlockdevCreateOptions(v, NULL, &create_options, &local_err);
 954     visit_free(v);
 955
 956     if (local_err) {
 957         error_propagate(errp, local_err);
 958         ret = -EINVAL;
 959         goto done;
 960     }
 961
 962     /* Silently round up size */
 963     assert(create_options->driver == BLOCKDEV_DRIVER_VDI);
 964     create_options->u.vdi.size = ROUND_UP(create_options->u.vdi.size,
 965                                           BDRV_SECTOR_SIZE);
 966
 967     /* Create the vdi image (format layer) */
 968     ret = vdi_co_do_create(create_options, block_size, errp);
 969 done:
 970     qobject_unref(qdict);
 971     qapi_free_BlockdevCreateOptions(create_options);
 972     bdrv_unref(bs_file);
 973     return ret;
 974 }
 975
 976 static void vdi_close(BlockDriverState *bs)
 977 {
 978     BDRVVdiState *s = bs->opaque;
 979
 980     qemu_vfree(s->bmap);
 981
 982     migrate_del_blocker(s->migration_blocker);
 983     error_free(s->migration_blocker);
 984 }
 985
 986 static QemuOptsList vdi_create_opts = {
 987     .name = "vdi-create-opts",
 988     .head = QTAILQ_HEAD_INITIALIZER(vdi_create_opts.head),
 989     .desc = {
 990         {
 991             .name = BLOCK_OPT_SIZE,
 992             .type = QEMU_OPT_SIZE,
 993             .help = "Virtual disk size"
 994         },
 995 #if defined(CONFIG_VDI_BLOCK_SIZE)
 996         {
 997             .name = BLOCK_OPT_CLUSTER_SIZE,
 998             .type = QEMU_OPT_SIZE,
 999             .help = "VDI cluster (block) size",
1000             .def_value_str = stringify(DEFAULT_CLUSTER_SIZE)
1001         },
1002 #endif
1003 #if defined(CONFIG_VDI_STATIC_IMAGE)
1004         {
1005             .name = BLOCK_OPT_STATIC,
1006             .type = QEMU_OPT_BOOL,
1007             .help = "VDI static (pre-allocated) image",
1008             .def_value_str = "off"
1009         },
1010 #endif
1011         /* TODO: An additional option to set UUID values might be useful. */
1012         { /* end of list */ }
1013     }
1014 };
1015
1016 static BlockDriver bdrv_vdi = {
1017     .format_name = "vdi",
1018     .instance_size = sizeof(BDRVVdiState),
1019     .bdrv_probe = vdi_probe,
1020     .bdrv_open = vdi_open,
1021     .bdrv_close = vdi_close,
1022     .bdrv_reopen_prepare = vdi_reopen_prepare,
1023     .bdrv_child_perm          = bdrv_format_default_perms,
1024     .bdrv_co_create      = vdi_co_create,
1025     .bdrv_co_create_opts = vdi_co_create_opts,
1026     .bdrv_has_zero_init = bdrv_has_zero_init_1,
1027     .bdrv_co_block_status = vdi_co_block_status,
1028     .bdrv_make_empty = vdi_make_empty,
1029
1030     .bdrv_co_preadv     = vdi_co_preadv,
1031 #if defined(CONFIG_VDI_WRITE)
1032     .bdrv_co_pwritev    = vdi_co_pwritev,
1033 #endif
1034
1035     .bdrv_get_info = vdi_get_info,
1036
1037     .create_opts = &vdi_create_opts,
1038     .bdrv_co_check = vdi_co_check,
1039 };
1040
1041 static void bdrv_vdi_init(void)
1042 {
1043     logout("\n");
1044     bdrv_register(&bdrv_vdi);
1045 }
1046
1047 block_init(bdrv_vdi_init);