block/parallels.c

   1 /*
   2  * Block driver for Parallels disk image format
   3  *
   4  * Copyright (c) 2007 Alex Beregszaszi
   5  * Copyright (c) 2015 Denis V. Lunev <den@openvz.org>
   6  *
   7  * This code was originally based on comparing different disk images created
   8  * by Parallels. Currently it is based on opened OpenVZ sources
   9  * available at
  10  *     http://git.openvz.org/?p=ploop;a=summary
  11  *
  12  * Permission is hereby granted, free of charge, to any person obtaining a copy
  13  * of this software and associated documentation files (the "Software"), to deal
  14  * in the Software without restriction, including without limitation the rights
  15  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  16  * copies of the Software, and to permit persons to whom the Software is
  17  * furnished to do so, subject to the following conditions:
  18  *
  19  * The above copyright notice and this permission notice shall be included in
  20  * all copies or substantial portions of the Software.
  21  *
  22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  23  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  25  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  26  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  27  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  28  * THE SOFTWARE.
  29  */
  30
  31 #include "qemu/osdep.h"
  32 #include "qemu/error-report.h"
  33 #include "qapi/error.h"
  34 #include "block/block_int.h"
  35 #include "block/qdict.h"
  36 #include "sysemu/block-backend.h"
  37 #include "qemu/module.h"
  38 #include "qemu/option.h"
  39 #include "qapi/qmp/qdict.h"
  40 #include "qapi/qobject-input-visitor.h"
  41 #include "qapi/qapi-visit-block-core.h"
  42 #include "qemu/bswap.h"
  43 #include "qemu/bitmap.h"
  44 #include "qemu/memalign.h"
  45 #include "migration/blocker.h"
  46 #include "parallels.h"
  47
  48 /**************************************************************/
  49
  50 #define HEADER_MAGIC "WithoutFreeSpace"
  51 #define HEADER_MAGIC2 "WithouFreSpacExt"
  52 #define HEADER_VERSION 2
  53 #define HEADER_INUSE_MAGIC  (0x746F6E59)
  54 #define MAX_PARALLELS_IMAGE_FACTOR (1ull << 32)
  55
  56 static QEnumLookup prealloc_mode_lookup = {
  57     .array = (const char *const[]) {
  58         "falloc",
  59         "truncate",
  60     },
  61     .size = PRL_PREALLOC_MODE__MAX
  62 };
  63
  64 #define PARALLELS_OPT_PREALLOC_MODE     "prealloc-mode"
  65 #define PARALLELS_OPT_PREALLOC_SIZE     "prealloc-size"
  66
  67 static QemuOptsList parallels_runtime_opts = {
  68     .name = "parallels",
  69     .head = QTAILQ_HEAD_INITIALIZER(parallels_runtime_opts.head),
  70     .desc = {
  71         {
  72             .name = PARALLELS_OPT_PREALLOC_SIZE,
  73             .type = QEMU_OPT_SIZE,
  74             .help = "Preallocation size on image expansion",
  75             .def_value_str = "128M",
  76         },
  77         {
  78             .name = PARALLELS_OPT_PREALLOC_MODE,
  79             .type = QEMU_OPT_STRING,
  80             .help = "Preallocation mode on image expansion "
  81                     "(allowed values: falloc, truncate)",
  82             .def_value_str = "falloc",
  83         },
  84         { /* end of list */ },
  85     },
  86 };
  87
  88 static QemuOptsList parallels_create_opts = {
  89     .name = "parallels-create-opts",
  90     .head = QTAILQ_HEAD_INITIALIZER(parallels_create_opts.head),
  91     .desc = {
  92         {
  93             .name = BLOCK_OPT_SIZE,
  94             .type = QEMU_OPT_SIZE,
  95             .help = "Virtual disk size",
  96         },
  97         {
  98             .name = BLOCK_OPT_CLUSTER_SIZE,
  99             .type = QEMU_OPT_SIZE,
 100             .help = "Parallels image cluster size",
 101             .def_value_str = stringify(DEFAULT_CLUSTER_SIZE),
 102         },
 103         { /* end of list */ }
 104     }
 105 };
 106
 107
 108 static int64_t bat2sect(BDRVParallelsState *s, uint32_t idx)
 109 {
 110     return (uint64_t)le32_to_cpu(s->bat_bitmap[idx]) * s->off_multiplier;
 111 }
 112
 113 static uint32_t bat_entry_off(uint32_t idx)
 114 {
 115     return sizeof(ParallelsHeader) + sizeof(uint32_t) * idx;
 116 }
 117
 118 static int64_t seek_to_sector(BDRVParallelsState *s, int64_t sector_num)
 119 {
 120     uint32_t index, offset;
 121
 122     index = sector_num / s->tracks;
 123     offset = sector_num % s->tracks;
 124
 125     /* not allocated */
 126     if ((index >= s->bat_size) || (s->bat_bitmap[index] == 0)) {
 127         return -1;
 128     }
 129     return bat2sect(s, index) + offset;
 130 }
 131
 132 static int cluster_remainder(BDRVParallelsState *s, int64_t sector_num,
 133         int nb_sectors)
 134 {
 135     int ret = s->tracks - sector_num % s->tracks;
 136     return MIN(nb_sectors, ret);
 137 }
 138
 139 static int64_t block_status(BDRVParallelsState *s, int64_t sector_num,
 140                             int nb_sectors, int *pnum)
 141 {
 142     int64_t start_off = -2, prev_end_off = -2;
 143
 144     *pnum = 0;
 145     while (nb_sectors > 0 || start_off == -2) {
 146         int64_t offset = seek_to_sector(s, sector_num);
 147         int to_end;
 148
 149         if (start_off == -2) {
 150             start_off = offset;
 151             prev_end_off = offset;
 152         } else if (offset != prev_end_off) {
 153             break;
 154         }
 155
 156         to_end = cluster_remainder(s, sector_num, nb_sectors);
 157         nb_sectors -= to_end;
 158         sector_num += to_end;
 159         *pnum += to_end;
 160
 161         if (offset > 0) {
 162             prev_end_off += to_end;
 163         }
 164     }
 165     return start_off;
 166 }
 167
 168 static void parallels_set_bat_entry(BDRVParallelsState *s,
 169                                     uint32_t index, uint32_t offset)
 170 {
 171     s->bat_bitmap[index] = cpu_to_le32(offset);
 172     bitmap_set(s->bat_dirty_bmap, bat_entry_off(index) / s->bat_dirty_block, 1);
 173 }
 174
 175 static int64_t coroutine_fn GRAPH_RDLOCK
 176 allocate_clusters(BlockDriverState *bs, int64_t sector_num,
 177                   int nb_sectors, int *pnum)
 178 {
 179     int ret = 0;
 180     BDRVParallelsState *s = bs->opaque;
 181     int64_t pos, space, idx, to_allocate, i, len;
 182
 183     pos = block_status(s, sector_num, nb_sectors, pnum);
 184     if (pos > 0) {
 185         return pos;
 186     }
 187
 188     idx = sector_num / s->tracks;
 189     to_allocate = DIV_ROUND_UP(sector_num + *pnum, s->tracks) - idx;
 190
 191     /*
 192      * This function is called only by parallels_co_writev(), which will never
 193      * pass a sector_num at or beyond the end of the image (because the block
 194      * layer never passes such a sector_num to that function). Therefore, idx
 195      * is always below s->bat_size.
 196      * block_status() will limit *pnum so that sector_num + *pnum will not
 197      * exceed the image end. Therefore, idx + to_allocate cannot exceed
 198      * s->bat_size.
 199      * Note that s->bat_size is an unsigned int, therefore idx + to_allocate
 200      * will always fit into a uint32_t.
 201      */
 202     assert(idx < s->bat_size && idx + to_allocate <= s->bat_size);
 203
 204     space = to_allocate * s->tracks;
 205     len = bdrv_co_getlength(bs->file->bs);
 206     if (len < 0) {
 207         return len;
 208     }
 209     if (s->data_end + space > (len >> BDRV_SECTOR_BITS)) {
 210         space += s->prealloc_size;
 211         /*
 212          * We require the expanded size to read back as zero. If the
 213          * user permitted truncation, we try that; but if it fails, we
 214          * force the safer-but-slower fallocate.
 215          */
 216         if (s->prealloc_mode == PRL_PREALLOC_MODE_TRUNCATE) {
 217             ret = bdrv_co_truncate(bs->file,
 218                                    (s->data_end + space) << BDRV_SECTOR_BITS,
 219                                    false, PREALLOC_MODE_OFF,
 220                                    BDRV_REQ_ZERO_WRITE, NULL);
 221             if (ret == -ENOTSUP) {
 222                 s->prealloc_mode = PRL_PREALLOC_MODE_FALLOCATE;
 223             }
 224         }
 225         if (s->prealloc_mode == PRL_PREALLOC_MODE_FALLOCATE) {
 226             ret = bdrv_co_pwrite_zeroes(bs->file,
 227                                         s->data_end << BDRV_SECTOR_BITS,
 228                                         space << BDRV_SECTOR_BITS, 0);
 229         }
 230         if (ret < 0) {
 231             return ret;
 232         }
 233     }
 234
 235     /*
 236      * Try to read from backing to fill empty clusters
 237      * FIXME: 1. previous write_zeroes may be redundant
 238      *        2. most of data we read from backing will be rewritten by
 239      *           parallels_co_writev. On aligned-to-cluster write we do not need
 240      *           this read at all.
 241      *        3. it would be good to combine write of data from backing and new
 242      *           data into one write call.
 243      */
 244     if (bs->backing) {
 245         int64_t nb_cow_sectors = to_allocate * s->tracks;
 246         int64_t nb_cow_bytes = nb_cow_sectors << BDRV_SECTOR_BITS;
 247         void *buf = qemu_blockalign(bs, nb_cow_bytes);
 248
 249         ret = bdrv_co_pread(bs->backing, idx * s->tracks * BDRV_SECTOR_SIZE,
 250                             nb_cow_bytes, buf, 0);
 251         if (ret < 0) {
 252             qemu_vfree(buf);
 253             return ret;
 254         }
 255
 256         ret = bdrv_co_pwrite(bs->file, s->data_end * BDRV_SECTOR_SIZE,
 257                              nb_cow_bytes, buf, 0);
 258         qemu_vfree(buf);
 259         if (ret < 0) {
 260             return ret;
 261         }
 262     }
 263
 264     for (i = 0; i < to_allocate; i++) {
 265         parallels_set_bat_entry(s, idx + i, s->data_end / s->off_multiplier);
 266         s->data_end += s->tracks;
 267     }
 268
 269     return bat2sect(s, idx) + sector_num % s->tracks;
 270 }
 271
 272
 273 static int coroutine_fn GRAPH_RDLOCK
 274 parallels_co_flush_to_os(BlockDriverState *bs)
 275 {
 276     BDRVParallelsState *s = bs->opaque;
 277     unsigned long size = DIV_ROUND_UP(s->header_size, s->bat_dirty_block);
 278     unsigned long bit;
 279
 280     qemu_co_mutex_lock(&s->lock);
 281
 282     bit = find_first_bit(s->bat_dirty_bmap, size);
 283     while (bit < size) {
 284         uint32_t off = bit * s->bat_dirty_block;
 285         uint32_t to_write = s->bat_dirty_block;
 286         int ret;
 287
 288         if (off + to_write > s->header_size) {
 289             to_write = s->header_size - off;
 290         }
 291         ret = bdrv_co_pwrite(bs->file, off, to_write,
 292                              (uint8_t *)s->header + off, 0);
 293         if (ret < 0) {
 294             qemu_co_mutex_unlock(&s->lock);
 295             return ret;
 296         }
 297         bit = find_next_bit(s->bat_dirty_bmap, size, bit + 1);
 298     }
 299     bitmap_zero(s->bat_dirty_bmap, size);
 300
 301     qemu_co_mutex_unlock(&s->lock);
 302     return 0;
 303 }
 304
 305
 306 static int coroutine_fn parallels_co_block_status(BlockDriverState *bs,
 307                                                   bool want_zero,
 308                                                   int64_t offset,
 309                                                   int64_t bytes,
 310                                                   int64_t *pnum,
 311                                                   int64_t *map,
 312                                                   BlockDriverState **file)
 313 {
 314     BDRVParallelsState *s = bs->opaque;
 315     int count;
 316
 317     assert(QEMU_IS_ALIGNED(offset | bytes, BDRV_SECTOR_SIZE));
 318     qemu_co_mutex_lock(&s->lock);
 319     offset = block_status(s, offset >> BDRV_SECTOR_BITS,
 320                           bytes >> BDRV_SECTOR_BITS, &count);
 321     qemu_co_mutex_unlock(&s->lock);
 322
 323     *pnum = count * BDRV_SECTOR_SIZE;
 324     if (offset < 0) {
 325         return 0;
 326     }
 327
 328     *map = offset * BDRV_SECTOR_SIZE;
 329     *file = bs->file->bs;
 330     return BDRV_BLOCK_DATA | BDRV_BLOCK_OFFSET_VALID;
 331 }
 332
 333 static int coroutine_fn GRAPH_RDLOCK
 334 parallels_co_writev(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
 335                     QEMUIOVector *qiov, int flags)
 336 {
 337     BDRVParallelsState *s = bs->opaque;
 338     uint64_t bytes_done = 0;
 339     QEMUIOVector hd_qiov;
 340     int ret = 0;
 341
 342     qemu_iovec_init(&hd_qiov, qiov->niov);
 343
 344     while (nb_sectors > 0) {
 345         int64_t position;
 346         int n, nbytes;
 347
 348         qemu_co_mutex_lock(&s->lock);
 349         position = allocate_clusters(bs, sector_num, nb_sectors, &n);
 350         qemu_co_mutex_unlock(&s->lock);
 351         if (position < 0) {
 352             ret = (int)position;
 353             break;
 354         }
 355
 356         nbytes = n << BDRV_SECTOR_BITS;
 357
 358         qemu_iovec_reset(&hd_qiov);
 359         qemu_iovec_concat(&hd_qiov, qiov, bytes_done, nbytes);
 360
 361         ret = bdrv_co_pwritev(bs->file, position * BDRV_SECTOR_SIZE, nbytes,
 362                               &hd_qiov, 0);
 363         if (ret < 0) {
 364             break;
 365         }
 366
 367         nb_sectors -= n;
 368         sector_num += n;
 369         bytes_done += nbytes;
 370     }
 371
 372     qemu_iovec_destroy(&hd_qiov);
 373     return ret;
 374 }
 375
 376 static int coroutine_fn GRAPH_RDLOCK
 377 parallels_co_readv(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
 378                    QEMUIOVector *qiov)
 379 {
 380     BDRVParallelsState *s = bs->opaque;
 381     uint64_t bytes_done = 0;
 382     QEMUIOVector hd_qiov;
 383     int ret = 0;
 384
 385     qemu_iovec_init(&hd_qiov, qiov->niov);
 386
 387     while (nb_sectors > 0) {
 388         int64_t position;
 389         int n, nbytes;
 390
 391         qemu_co_mutex_lock(&s->lock);
 392         position = block_status(s, sector_num, nb_sectors, &n);
 393         qemu_co_mutex_unlock(&s->lock);
 394
 395         nbytes = n << BDRV_SECTOR_BITS;
 396
 397         qemu_iovec_reset(&hd_qiov);
 398         qemu_iovec_concat(&hd_qiov, qiov, bytes_done, nbytes);
 399
 400         if (position < 0) {
 401             if (bs->backing) {
 402                 ret = bdrv_co_preadv(bs->backing, sector_num * BDRV_SECTOR_SIZE,
 403                                      nbytes, &hd_qiov, 0);
 404                 if (ret < 0) {
 405                     break;
 406                 }
 407             } else {
 408                 qemu_iovec_memset(&hd_qiov, 0, 0, nbytes);
 409             }
 410         } else {
 411             ret = bdrv_co_preadv(bs->file, position * BDRV_SECTOR_SIZE, nbytes,
 412                                  &hd_qiov, 0);
 413             if (ret < 0) {
 414                 break;
 415             }
 416         }
 417
 418         nb_sectors -= n;
 419         sector_num += n;
 420         bytes_done += nbytes;
 421     }
 422
 423     qemu_iovec_destroy(&hd_qiov);
 424     return ret;
 425 }
 426
 427 static void parallels_check_unclean(BlockDriverState *bs,
 428                                     BdrvCheckResult *res,
 429                                     BdrvCheckMode fix)
 430 {
 431     BDRVParallelsState *s = bs->opaque;
 432
 433     if (!s->header_unclean) {
 434         return;
 435     }
 436
 437     fprintf(stderr, "%s image was not closed correctly\n",
 438             fix & BDRV_FIX_ERRORS ? "Repairing" : "ERROR");
 439     res->corruptions++;
 440     if (fix & BDRV_FIX_ERRORS) {
 441         /* parallels_close will do the job right */
 442         res->corruptions_fixed++;
 443         s->header_unclean = false;
 444     }
 445 }
 446
 447 static int coroutine_fn GRAPH_RDLOCK
 448 parallels_check_outside_image(BlockDriverState *bs, BdrvCheckResult *res,
 449                               BdrvCheckMode fix)
 450 {
 451     BDRVParallelsState *s = bs->opaque;
 452     uint32_t i;
 453     int64_t off, high_off, size;
 454
 455     size = bdrv_co_getlength(bs->file->bs);
 456     if (size < 0) {
 457         res->check_errors++;
 458         return size;
 459     }
 460
 461     high_off = 0;
 462     for (i = 0; i < s->bat_size; i++) {
 463         off = bat2sect(s, i) << BDRV_SECTOR_BITS;
 464         if (off + s->cluster_size > size) {
 465             fprintf(stderr, "%s cluster %u is outside image\n",
 466                     fix & BDRV_FIX_ERRORS ? "Repairing" : "ERROR", i);
 467             res->corruptions++;
 468             if (fix & BDRV_FIX_ERRORS) {
 469                 parallels_set_bat_entry(s, i, 0);
 470                 res->corruptions_fixed++;
 471             }
 472             continue;
 473         }
 474         if (high_off < off) {
 475             high_off = off;
 476         }
 477     }
 478
 479     if (high_off == 0) {
 480         res->image_end_offset = s->data_end << BDRV_SECTOR_BITS;
 481     } else {
 482         res->image_end_offset = high_off + s->cluster_size;
 483         s->data_end = res->image_end_offset >> BDRV_SECTOR_BITS;
 484     }
 485
 486     return 0;
 487 }
 488
 489 static int coroutine_fn GRAPH_RDLOCK
 490 parallels_check_leak(BlockDriverState *bs, BdrvCheckResult *res,
 491                      BdrvCheckMode fix)
 492 {
 493     BDRVParallelsState *s = bs->opaque;
 494     int64_t size;
 495     int ret;
 496
 497     size = bdrv_getlength(bs->file->bs);
 498     if (size < 0) {
 499         res->check_errors++;
 500         return size;
 501     }
 502
 503     if (size > res->image_end_offset) {
 504         int64_t count;
 505         count = DIV_ROUND_UP(size - res->image_end_offset, s->cluster_size);
 506         fprintf(stderr, "%s space leaked at the end of the image %" PRId64 "\n",
 507                 fix & BDRV_FIX_LEAKS ? "Repairing" : "ERROR",
 508                 size - res->image_end_offset);
 509         res->leaks += count;
 510         if (fix & BDRV_FIX_LEAKS) {
 511             Error *local_err = NULL;
 512
 513             /*
 514              * In order to really repair the image, we must shrink it.
 515              * That means we have to pass exact=true.
 516              */
 517             ret = bdrv_co_truncate(bs->file, res->image_end_offset, true,
 518                                    PREALLOC_MODE_OFF, 0, &local_err);
 519             if (ret < 0) {
 520                 error_report_err(local_err);
 521                 res->check_errors++;
 522                 return ret;
 523             }
 524             res->leaks_fixed += count;
 525         }
 526     }
 527
 528     return 0;
 529 }
 530
 531 static void parallels_collect_statistics(BlockDriverState *bs,
 532                                          BdrvCheckResult *res,
 533                                          BdrvCheckMode fix)
 534 {
 535     BDRVParallelsState *s = bs->opaque;
 536     int64_t off, prev_off;
 537     uint32_t i;
 538
 539     res->bfi.total_clusters = s->bat_size;
 540     res->bfi.compressed_clusters = 0; /* compression is not supported */
 541
 542     prev_off = 0;
 543     for (i = 0; i < s->bat_size; i++) {
 544         off = bat2sect(s, i) << BDRV_SECTOR_BITS;
 545         /*
 546          * If BDRV_FIX_ERRORS is not set, out-of-image BAT entries were not
 547          * fixed. Skip not allocated and out-of-image BAT entries.
 548          */
 549         if (off == 0 || off + s->cluster_size > res->image_end_offset) {
 550             prev_off = 0;
 551             continue;
 552         }
 553
 554         if (prev_off != 0 && (prev_off + s->cluster_size) != off) {
 555             res->bfi.fragmented_clusters++;
 556         }
 557         prev_off = off;
 558         res->bfi.allocated_clusters++;
 559     }
 560 }
 561
 562 static int coroutine_fn GRAPH_RDLOCK
 563 parallels_co_check(BlockDriverState *bs, BdrvCheckResult *res,
 564                    BdrvCheckMode fix)
 565 {
 566     BDRVParallelsState *s = bs->opaque;
 567     int ret;
 568
 569     WITH_QEMU_LOCK_GUARD(&s->lock) {
 570         parallels_check_unclean(bs, res, fix);
 571
 572         ret = parallels_check_outside_image(bs, res, fix);
 573         if (ret < 0) {
 574             return ret;
 575         }
 576
 577         ret = parallels_check_leak(bs, res, fix);
 578         if (ret < 0) {
 579             return ret;
 580         }
 581
 582         parallels_collect_statistics(bs, res, fix);
 583     }
 584
 585     ret = bdrv_co_flush(bs);
 586     if (ret < 0) {
 587         res->check_errors++;
 588     }
 589
 590     return ret;
 591 }
 592
 593
 594 static int coroutine_fn GRAPH_UNLOCKED
 595 parallels_co_create(BlockdevCreateOptions* opts, Error **errp)
 596 {
 597     BlockdevCreateOptionsParallels *parallels_opts;
 598     BlockDriverState *bs;
 599     BlockBackend *blk;
 600     int64_t total_size, cl_size;
 601     uint32_t bat_entries, bat_sectors;
 602     ParallelsHeader header;
 603     uint8_t tmp[BDRV_SECTOR_SIZE];
 604     int ret;
 605
 606     assert(opts->driver == BLOCKDEV_DRIVER_PARALLELS);
 607     parallels_opts = &opts->u.parallels;
 608
 609     /* Sanity checks */
 610     total_size = parallels_opts->size;
 611
 612     if (parallels_opts->has_cluster_size) {
 613         cl_size = parallels_opts->cluster_size;
 614     } else {
 615         cl_size = DEFAULT_CLUSTER_SIZE;
 616     }
 617
 618     /* XXX What is the real limit here? This is an insanely large maximum. */
 619     if (cl_size >= INT64_MAX / MAX_PARALLELS_IMAGE_FACTOR) {
 620         error_setg(errp, "Cluster size is too large");
 621         return -EINVAL;
 622     }
 623     if (total_size >= MAX_PARALLELS_IMAGE_FACTOR * cl_size) {
 624         error_setg(errp, "Image size is too large for this cluster size");
 625         return -E2BIG;
 626     }
 627
 628     if (!QEMU_IS_ALIGNED(total_size, BDRV_SECTOR_SIZE)) {
 629         error_setg(errp, "Image size must be a multiple of 512 bytes");
 630         return -EINVAL;
 631     }
 632
 633     if (!QEMU_IS_ALIGNED(cl_size, BDRV_SECTOR_SIZE)) {
 634         error_setg(errp, "Cluster size must be a multiple of 512 bytes");
 635         return -EINVAL;
 636     }
 637
 638     /* Create BlockBackend to write to the image */
 639     bs = bdrv_co_open_blockdev_ref(parallels_opts->file, errp);
 640     if (bs == NULL) {
 641         return -EIO;
 642     }
 643
 644     blk = blk_co_new_with_bs(bs, BLK_PERM_WRITE | BLK_PERM_RESIZE, BLK_PERM_ALL,
 645                              errp);
 646     if (!blk) {
 647         ret = -EPERM;
 648         goto out;
 649     }
 650     blk_set_allow_write_beyond_eof(blk, true);
 651
 652     /* Create image format */
 653     bat_entries = DIV_ROUND_UP(total_size, cl_size);
 654     bat_sectors = DIV_ROUND_UP(bat_entry_off(bat_entries), cl_size);
 655     bat_sectors = (bat_sectors *  cl_size) >> BDRV_SECTOR_BITS;
 656
 657     memset(&header, 0, sizeof(header));
 658     memcpy(header.magic, HEADER_MAGIC2, sizeof(header.magic));
 659     header.version = cpu_to_le32(HEADER_VERSION);
 660     /* don't care much about geometry, it is not used on image level */
 661     header.heads = cpu_to_le32(HEADS_NUMBER);
 662     header.cylinders = cpu_to_le32(total_size / BDRV_SECTOR_SIZE
 663                                    / HEADS_NUMBER / SEC_IN_CYL);
 664     header.tracks = cpu_to_le32(cl_size >> BDRV_SECTOR_BITS);
 665     header.bat_entries = cpu_to_le32(bat_entries);
 666     header.nb_sectors = cpu_to_le64(DIV_ROUND_UP(total_size, BDRV_SECTOR_SIZE));
 667     header.data_off = cpu_to_le32(bat_sectors);
 668
 669     /* write all the data */
 670     memset(tmp, 0, sizeof(tmp));
 671     memcpy(tmp, &header, sizeof(header));
 672
 673     ret = blk_co_pwrite(blk, 0, BDRV_SECTOR_SIZE, tmp, 0);
 674     if (ret < 0) {
 675         goto exit;
 676     }
 677     ret = blk_co_pwrite_zeroes(blk, BDRV_SECTOR_SIZE,
 678                                (bat_sectors - 1) << BDRV_SECTOR_BITS, 0);
 679     if (ret < 0) {
 680         goto exit;
 681     }
 682
 683     ret = 0;
 684 out:
 685     blk_co_unref(blk);
 686     bdrv_co_unref(bs);
 687     return ret;
 688
 689 exit:
 690     error_setg_errno(errp, -ret, "Failed to create Parallels image");
 691     goto out;
 692 }
 693
 694 static int coroutine_fn GRAPH_UNLOCKED
 695 parallels_co_create_opts(BlockDriver *drv, const char *filename,
 696                          QemuOpts *opts, Error **errp)
 697 {
 698     BlockdevCreateOptions *create_options = NULL;
 699     BlockDriverState *bs = NULL;
 700     QDict *qdict;
 701     Visitor *v;
 702     int ret;
 703
 704     static const QDictRenames opt_renames[] = {
 705         { BLOCK_OPT_CLUSTER_SIZE,       "cluster-size" },
 706         { NULL, NULL },
 707     };
 708
 709     /* Parse options and convert legacy syntax */
 710     qdict = qemu_opts_to_qdict_filtered(opts, NULL, &parallels_create_opts,
 711                                         true);
 712
 713     if (!qdict_rename_keys(qdict, opt_renames, errp)) {
 714         ret = -EINVAL;
 715         goto done;
 716     }
 717
 718     /* Create and open the file (protocol layer) */
 719     ret = bdrv_co_create_file(filename, opts, errp);
 720     if (ret < 0) {
 721         goto done;
 722     }
 723
 724     bs = bdrv_co_open(filename, NULL, NULL,
 725                       BDRV_O_RDWR | BDRV_O_RESIZE | BDRV_O_PROTOCOL, errp);
 726     if (bs == NULL) {
 727         ret = -EIO;
 728         goto done;
 729     }
 730
 731     /* Now get the QAPI type BlockdevCreateOptions */
 732     qdict_put_str(qdict, "driver", "parallels");
 733     qdict_put_str(qdict, "file", bs->node_name);
 734
 735     v = qobject_input_visitor_new_flat_confused(qdict, errp);
 736     if (!v) {
 737         ret = -EINVAL;
 738         goto done;
 739     }
 740
 741     visit_type_BlockdevCreateOptions(v, NULL, &create_options, errp);
 742     visit_free(v);
 743     if (!create_options) {
 744         ret = -EINVAL;
 745         goto done;
 746     }
 747
 748     /* Silently round up sizes */
 749     create_options->u.parallels.size =
 750         ROUND_UP(create_options->u.parallels.size, BDRV_SECTOR_SIZE);
 751     create_options->u.parallels.cluster_size =
 752         ROUND_UP(create_options->u.parallels.cluster_size, BDRV_SECTOR_SIZE);
 753
 754     /* Create the Parallels image (format layer) */
 755     ret = parallels_co_create(create_options, errp);
 756     if (ret < 0) {
 757         goto done;
 758     }
 759     ret = 0;
 760
 761 done:
 762     qobject_unref(qdict);
 763     bdrv_co_unref(bs);
 764     qapi_free_BlockdevCreateOptions(create_options);
 765     return ret;
 766 }
 767
 768
 769 static int parallels_probe(const uint8_t *buf, int buf_size,
 770                            const char *filename)
 771 {
 772     const ParallelsHeader *ph = (const void *)buf;
 773
 774     if (buf_size < sizeof(ParallelsHeader)) {
 775         return 0;
 776     }
 777
 778     if ((!memcmp(ph->magic, HEADER_MAGIC, 16) ||
 779            !memcmp(ph->magic, HEADER_MAGIC2, 16)) &&
 780            (le32_to_cpu(ph->version) == HEADER_VERSION)) {
 781         return 100;
 782     }
 783
 784     return 0;
 785 }
 786
 787 static int parallels_update_header(BlockDriverState *bs)
 788 {
 789     BDRVParallelsState *s = bs->opaque;
 790     unsigned size = MAX(bdrv_opt_mem_align(bs->file->bs),
 791                         sizeof(ParallelsHeader));
 792
 793     if (size > s->header_size) {
 794         size = s->header_size;
 795     }
 796     return bdrv_pwrite_sync(bs->file, 0, size, s->header, 0);
 797 }
 798
 799 static int parallels_open(BlockDriverState *bs, QDict *options, int flags,
 800                           Error **errp)
 801 {
 802     BDRVParallelsState *s = bs->opaque;
 803     ParallelsHeader ph;
 804     int ret, size, i;
 805     int64_t file_nb_sectors;
 806     QemuOpts *opts = NULL;
 807     Error *local_err = NULL;
 808     char *buf;
 809
 810     ret = bdrv_open_file_child(NULL, options, "file", bs, errp);
 811     if (ret < 0) {
 812         return ret;
 813     }
 814
 815     file_nb_sectors = bdrv_nb_sectors(bs->file->bs);
 816     if (file_nb_sectors < 0) {
 817         return -EINVAL;
 818     }
 819
 820     ret = bdrv_pread(bs->file, 0, sizeof(ph), &ph, 0);
 821     if (ret < 0) {
 822         goto fail;
 823     }
 824
 825     bs->total_sectors = le64_to_cpu(ph.nb_sectors);
 826
 827     if (le32_to_cpu(ph.version) != HEADER_VERSION) {
 828         goto fail_format;
 829     }
 830     if (!memcmp(ph.magic, HEADER_MAGIC, 16)) {
 831         s->off_multiplier = 1;
 832         bs->total_sectors = 0xffffffff & bs->total_sectors;
 833     } else if (!memcmp(ph.magic, HEADER_MAGIC2, 16)) {
 834         s->off_multiplier = le32_to_cpu(ph.tracks);
 835     } else {
 836         goto fail_format;
 837     }
 838
 839     s->tracks = le32_to_cpu(ph.tracks);
 840     if (s->tracks == 0) {
 841         error_setg(errp, "Invalid image: Zero sectors per track");
 842         ret = -EINVAL;
 843         goto fail;
 844     }
 845     if (s->tracks > INT32_MAX/513) {
 846         error_setg(errp, "Invalid image: Too big cluster");
 847         ret = -EFBIG;
 848         goto fail;
 849     }
 850     s->cluster_size = s->tracks << BDRV_SECTOR_BITS;
 851
 852     s->bat_size = le32_to_cpu(ph.bat_entries);
 853     if (s->bat_size > INT_MAX / sizeof(uint32_t)) {
 854         error_setg(errp, "Catalog too large");
 855         ret = -EFBIG;
 856         goto fail;
 857     }
 858
 859     size = bat_entry_off(s->bat_size);
 860     s->header_size = ROUND_UP(size, bdrv_opt_mem_align(bs->file->bs));
 861     s->header = qemu_try_blockalign(bs->file->bs, s->header_size);
 862     if (s->header == NULL) {
 863         ret = -ENOMEM;
 864         goto fail;
 865     }
 866     s->data_end = le32_to_cpu(ph.data_off);
 867     if (s->data_end == 0) {
 868         s->data_end = DIV_ROUND_UP(size, BDRV_SECTOR_SIZE);
 869     }
 870     if (s->data_end < (s->header_size >> BDRV_SECTOR_BITS)) {
 871         /*
 872          * There is not enough unused space to fit to block align between BAT
 873          * and actual data. We can't avoid read-modify-write...
 874          */
 875         s->header_size = size;
 876     }
 877
 878     ret = bdrv_pread(bs->file, 0, s->header_size, s->header, 0);
 879     if (ret < 0) {
 880         goto fail;
 881     }
 882     s->bat_bitmap = (uint32_t *)(s->header + 1);
 883
 884     for (i = 0; i < s->bat_size; i++) {
 885         int64_t off = bat2sect(s, i);
 886         if (off >= file_nb_sectors) {
 887             if (flags & BDRV_O_CHECK) {
 888                 continue;
 889             }
 890             error_setg(errp, "parallels: Offset %" PRIi64 " in BAT[%d] entry "
 891                        "is larger than file size (%" PRIi64 ")",
 892                        off << BDRV_SECTOR_BITS, i,
 893                        file_nb_sectors << BDRV_SECTOR_BITS);
 894             ret = -EINVAL;
 895             goto fail;
 896         }
 897         if (off >= s->data_end) {
 898             s->data_end = off + s->tracks;
 899         }
 900     }
 901
 902     if (le32_to_cpu(ph.inuse) == HEADER_INUSE_MAGIC) {
 903         /* Image was not closed correctly. The check is mandatory */
 904         s->header_unclean = true;
 905         if ((flags & BDRV_O_RDWR) && !(flags & BDRV_O_CHECK)) {
 906             error_setg(errp, "parallels: Image was not closed correctly; "
 907                        "cannot be opened read/write");
 908             ret = -EACCES;
 909             goto fail;
 910         }
 911     }
 912
 913     opts = qemu_opts_create(&parallels_runtime_opts, NULL, 0, errp);
 914     if (!opts) {
 915         goto fail_options;
 916     }
 917
 918     if (!qemu_opts_absorb_qdict(opts, options, errp)) {
 919         goto fail_options;
 920     }
 921
 922     s->prealloc_size =
 923         qemu_opt_get_size_del(opts, PARALLELS_OPT_PREALLOC_SIZE, 0);
 924     s->prealloc_size = MAX(s->tracks, s->prealloc_size >> BDRV_SECTOR_BITS);
 925     buf = qemu_opt_get_del(opts, PARALLELS_OPT_PREALLOC_MODE);
 926     /* prealloc_mode can be downgraded later during allocate_clusters */
 927     s->prealloc_mode = qapi_enum_parse(&prealloc_mode_lookup, buf,
 928                                        PRL_PREALLOC_MODE_FALLOCATE,
 929                                        &local_err);
 930     g_free(buf);
 931     if (local_err != NULL) {
 932         error_propagate(errp, local_err);
 933         goto fail_options;
 934     }
 935
 936     if (ph.ext_off) {
 937         if (flags & BDRV_O_RDWR) {
 938             /*
 939              * It's unsafe to open image RW if there is an extension (as we
 940              * don't support it). But parallels driver in QEMU historically
 941              * ignores the extension, so print warning and don't care.
 942              */
 943             warn_report("Format Extension ignored in RW mode");
 944         } else {
 945             ret = parallels_read_format_extension(
 946                     bs, le64_to_cpu(ph.ext_off) << BDRV_SECTOR_BITS, errp);
 947             if (ret < 0) {
 948                 goto fail;
 949             }
 950         }
 951     }
 952
 953     if ((flags & BDRV_O_RDWR) && !(flags & BDRV_O_INACTIVE)) {
 954         s->header->inuse = cpu_to_le32(HEADER_INUSE_MAGIC);
 955         ret = parallels_update_header(bs);
 956         if (ret < 0) {
 957             goto fail;
 958         }
 959     }
 960
 961     s->bat_dirty_block = 4 * qemu_real_host_page_size();
 962     s->bat_dirty_bmap =
 963         bitmap_new(DIV_ROUND_UP(s->header_size, s->bat_dirty_block));
 964
 965     /* Disable migration until bdrv_activate method is added */
 966     error_setg(&s->migration_blocker, "The Parallels format used by node '%s' "
 967                "does not support live migration",
 968                bdrv_get_device_or_node_name(bs));
 969     ret = migrate_add_blocker(s->migration_blocker, errp);
 970     if (ret < 0) {
 971         error_free(s->migration_blocker);
 972         goto fail;
 973     }
 974     qemu_co_mutex_init(&s->lock);
 975     return 0;
 976
 977 fail_format:
 978     error_setg(errp, "Image not in Parallels format");
 979 fail_options:
 980     ret = -EINVAL;
 981 fail:
 982     qemu_vfree(s->header);
 983     return ret;
 984 }
 985
 986
 987 static void parallels_close(BlockDriverState *bs)
 988 {
 989     BDRVParallelsState *s = bs->opaque;
 990
 991     if ((bs->open_flags & BDRV_O_RDWR) && !(bs->open_flags & BDRV_O_INACTIVE)) {
 992         s->header->inuse = 0;
 993         parallels_update_header(bs);
 994
 995         /* errors are ignored, so we might as well pass exact=true */
 996         bdrv_truncate(bs->file, s->data_end << BDRV_SECTOR_BITS, true,
 997                       PREALLOC_MODE_OFF, 0, NULL);
 998     }
 999
1000     g_free(s->bat_dirty_bmap);
1001     qemu_vfree(s->header);
1002
1003     migrate_del_blocker(s->migration_blocker);
1004     error_free(s->migration_blocker);
1005 }
1006
1007 static BlockDriver bdrv_parallels = {
1008     .format_name        = "parallels",
1009     .instance_size      = sizeof(BDRVParallelsState),
1010     .bdrv_probe         = parallels_probe,
1011     .bdrv_open          = parallels_open,
1012     .bdrv_close         = parallels_close,
1013     .bdrv_child_perm          = bdrv_default_perms,
1014     .bdrv_co_block_status     = parallels_co_block_status,
1015     .bdrv_has_zero_init       = bdrv_has_zero_init_1,
1016     .bdrv_co_flush_to_os      = parallels_co_flush_to_os,
1017     .bdrv_co_readv  = parallels_co_readv,
1018     .bdrv_co_writev = parallels_co_writev,
1019     .is_format      = true,
1020     .supports_backing = true,
1021     .bdrv_co_create      = parallels_co_create,
1022     .bdrv_co_create_opts = parallels_co_create_opts,
1023     .bdrv_co_check  = parallels_co_check,
1024     .create_opts    = &parallels_create_opts,
1025 };
1026
1027 static void bdrv_parallels_init(void)
1028 {
1029     bdrv_register(&bdrv_parallels);
1030 }
1031
1032 block_init(bdrv_parallels_init);